Skip to content
This repository has been archived by the owner on Oct 11, 2023. It is now read-only.

Commit

Permalink
Prepared gems for 0.0.1 release
Browse files Browse the repository at this point in the history
Updated docs on initialize, added README, and updated gem spec.
  • Loading branch information
paradox460 committed Jun 22, 2012
1 parent 1affee4 commit 6589631
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 7 deletions.
61 changes: 59 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Snoo

TODO: Write a gem description
Snoo is a *simple* wrapper for the reddit.com api. Its designed to provide an interface as close to the official api as possible, while freeing you from the problems of dealing with json, webserver requests, and session/cookie management.

Unlike other API wrappers, this one doesn't make use of complicated objects or classes, once you instantiate it once, you are good to go.

Since it's designed to be simple, it leaves things like rate limiting up to you. Please follow the [reddit api rules](https://github.com/reddit/reddit/wiki/API) and only send one request every 2 seconds (you can use `sleep 2` between requests).

Also, if you build programs with it, please change the user agent to your specific use case.

## Installation

Expand All @@ -18,12 +24,63 @@ Or install it yourself as:

## Usage

TODO: Write usage instructions here
Here's a simple script that sends a private message:

```ruby
require 'snoo'

# Create a new instance of the client
reddit = Snoo::Client.new

# Log into reddit
reddit.log_in 'Username', 'Password'

# Send a private message to me (Paradox!)
reddit.send_pm 'Paradox', 'Snoo rubygem rocks!', "Hey Paradox, I'm trying your Snoo rubygem out and it rocks. Thanks for providing such an awesome thing!"

# Log back out of reddit
reddit.log_out
```

See the [docs](http://rubydoc.info/github/paradox460/snoo/) for more info.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Test your changes (via `rspec`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## Testing

1. Edit `spec/auth.rb` and fill out all the globals with a test user account and test reddit
2. Run rspec

## License

```
Copyright (c) 2012 Jeff Sandberg
MIT License
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
4 changes: 3 additions & 1 deletion lib/snoo.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ class Client
attr_reader(:modhash, :username, :userid, :cookie)


# Creates a new instance of Snoo
# Creates a new instance of Snoo.
#
# Please change the useragent if you write your own program.
#
# @param url [String] url The base url of reddit.
# @param useragent [String] The User-Agent this bot will use.
Expand Down
8 changes: 4 additions & 4 deletions snoo.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ require File.expand_path('../lib/snoo/version', __FILE__)
Gem::Specification.new do |gem|
gem.authors = ["Jeff Sandberg"]
gem.email = ["paradox460@gmail.com"]
gem.description = %q{Snoo is yet another reddit API wrapper. I wrote it because I tried all the other ones, and they were either too difficult to use, too cumbersome, or obsolete. This is designed to be comprehensive, but if you see something its missing, let me know!}
gem.summary = %q{A simple reddit api wrapper. ALPHA}
gem.homepage = "http://paradox.gd"

gem.description = %q{Snoo is yet another reddit API wrapper. Unlike the other wrappers out there, this one strives to be an almost exact clone of the reddit api, however, it also makes many attempts to be easier to use. You won't be instantiating Snoo::Comment or anything like that. Just one instantiation, and you can do everything from there.}
gem.summary = %q{A simple reddit api wrapper}
gem.homepage = "https://github.com/paradox460/snoo"
gem.files = `git ls-files`.split($\)
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
gem.name = "snoo"
gem.require_paths = ["lib"]
gem.version = Snoo::VERSION
gem.required_ruby_version = '>= 1.9'
gem.license = 'MIT'

['httparty'].each do |dependency|
gem.add_runtime_dependency dependency
Expand Down

0 comments on commit 6589631

Please sign in to comment.