reddit-base 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 264ad54f63ddc99d0fba54fc3b13e3739357846c
-  data.tar.gz: 02a53d1639d64497bf6ca4eec5a152d3222fb02c
+  metadata.gz: f3fb4e405bfd23bc1f041840b615db26dadf957c
+  data.tar.gz: 7185a75f8c788884d0fecb1307f8a6fa5e3e1c90
 SHA512:
-  metadata.gz: 243387c7510e4b6974f31131822edc2a239911fc2adcb1364eb8d5e3451391f2f31dbba1d9be6fdd91ec7d9a1ccc2085daa2c3b8fec0c15d60d5d75d7cbf0adf
-  data.tar.gz: e07eb437bef94de7acdd3f915d5f77bd70b0094e7114991a22deb93240d6caddb0fe82c6c9ef205852a18c133588da2812ff03062bd2f4ab52514324e1d63d78
+  metadata.gz: 53c19842b951b856aa5b4ed7b7f5354c715deca5b97dc60a2628ac503e436d28f77a562b34bbb88453d6debdc0ba13a03e45ee1ce21fc1450f613ed805da4de5
+  data.tar.gz: ed6a28235b15a55a88ec24ca935eab60d9a43acbc6493b6e4d4a00b1a08f90a1f5d43696875f41503620200315b0aac7e30539c90518d6c1b5d37f2923bf0e3f

data/.gitignore

@@ -2,7 +2,6 @@
 *.rbc
 .bundle
 .config
-.pryrc
 .yardoc
 Gemfile.lock
 InstalledFiles

data/README.md

@@ -18,39 +18,62 @@ Installation
 
 Via Rubygems:
 
-    gem install reddit-base
+```
+gem install reddit-base
+```
 
 Or in your Gemfile with Bundler:
 
-    gem reddit-base
+```
+gem reddit-base
+```
 
 Basic Usage
 -------------
 
 Retrieve the JSON for a particular endpoint:
 
-    require 'reddit/base'
+```ruby
+require 'reddit/base'
 
-    client = Reddit::Base::Client.new(user: USERNAME, password: PASSWORD)
-    client.get('/r/AskReddit')
+client = Reddit::Base::Client.new(user: USERNAME, password: PASSWORD)
+client.get('/r/AskReddit')
+```
 
 Making a new self post:
 
-    require 'reddit/base'
+```ruby
+require 'reddit/base'
 
-    client = Reddit::Base::Client.new(user: USERNAME, password: PASSWORD)
-    client.get('/r/AskReddit') # Need to make at least one GET request to retrieve a modhash.
-    client.post('/api/submit', kind: 'self', sr: SUBREDDIT, title: 'Hello,', text: 'World!')
+client = Reddit::Base::Client.new(user: USERNAME, password: PASSWORD)
+client.get('/r/AskReddit') # Need to make at least one GET request to retrieve a modhash.
+client.post('/api/submit', kind: 'self', sr: SUBREDDIT, title: 'Hello,', text: 'World!')
+```
 
 `Client#get` and `Client#post` accept a `simplify` option to flatten data and kind attributes
 for easier traversal:
 
-    client.get('/r/AskReddit', simplify: true)
+```ruby
+client.get('/r/AskReddit', simplify: true)
+```
+
+Several forms of authentication are supported:
+
+```ruby
+# Username and password.
+client = Reddit::Base::Client.new(user: USERNAME, password: PASSWORD)
+
+# Cookie.
+client = Reddit::Base::Client.new(cookie: COOKIE)
+
+# OAuth2 access token.
+client = Reddit::Base::Client.new(access_token: ACCESS_TOKEN)
+```
 
 What it Does
 ------------
 
-  * Authentication.
+  * Authentication (user/password, cookie, OAuth2 access token).
   * Rate limiting.
   * Modhash handling (reddit's CSRF protection).
   * JSON coersion.
@@ -61,6 +84,7 @@ What it Does
 What it Doesn't
 ---------------
 
+  * OAuth2 token negotiation.
   * Parsing of Reddit "Things" and "Kinds."
   * Parsing of common attributes like dates and times.
   * HTML entity decoding (beware of "body" and "selftext").

data/lib/reddit/base/version.rb

@@ -1,5 +1,5 @@
 module Reddit
   module Base
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/reddit-base.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
 
-  spec.add_dependency 'faraday_middleware-reddit', '0.2.1'
+  spec.add_dependency 'faraday_middleware-reddit', '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reddit-base
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel O'Brien
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
 description: |-
   A minimal reddit API client for Ruby that
       simplifies concerns such authentication, rate limiting and extracting
@@ -93,8 +93,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A minimal reddit API client for Ruby.
 test_files: []
+has_rdoc: