reddit-base 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3fb4e405bfd23bc1f041840b615db26dadf957c
-  data.tar.gz: 7185a75f8c788884d0fecb1307f8a6fa5e3e1c90
+  metadata.gz: 04b8cd781236070038145739f35ad484bbb7c3c1
+  data.tar.gz: ff98d9f539a4fddbe7ccd5b299afae68f266c67a
 SHA512:
-  metadata.gz: 53c19842b951b856aa5b4ed7b7f5354c715deca5b97dc60a2628ac503e436d28f77a562b34bbb88453d6debdc0ba13a03e45ee1ce21fc1450f613ed805da4de5
-  data.tar.gz: ed6a28235b15a55a88ec24ca935eab60d9a43acbc6493b6e4d4a00b1a08f90a1f5d43696875f41503620200315b0aac7e30539c90518d6c1b5d37f2923bf0e3f
+  metadata.gz: 5f61050f2f8dac84d0ae6c7b0cb8513917d2b6d4195646b7ddb116f975df623caa7a949e2a01379abf9b82a06a0d9bc4daff5a425f99ff6edbdfbfd6ea6a8ad8
+  data.tar.gz: d3798e08febb37b6833bb4794d411e335c7430d9472108e23d449bfa9ebe2a3c2c5be236b460d32df998ed7363acb7e727886daa0a266408126428201674f4be

data/README.md

@@ -28,8 +28,27 @@ Or in your Gemfile with Bundler:
 gem reddit-base
 ```
 
-Basic Usage
--------------
+What it Does
+------------
+
+  * Authentication (user/password, cookie, OAuth2 access token).
+  * Rate limiting.
+  * Modhash handling (reddit's CSRF protection).
+  * JSON coersion.
+  * Forwarding..
+  * Multipart POST.
+  * Reddit error wrapping.
+
+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").
+
+Usage
+-----
 
 Retrieve the JSON for a particular endpoint:
 
@@ -50,14 +69,9 @@ client.get('/r/AskReddit') # Need to make at least one GET request to retrieve a
 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:
-
-```ruby
-client.get('/r/AskReddit', simplify: true)
-```
+### Authentication
 
-Several forms of authentication are supported:
+Examples:
 
 ```ruby
 # Username and password.
@@ -70,24 +84,23 @@ client = Reddit::Base::Client.new(cookie: COOKIE)
 client = Reddit::Base::Client.new(access_token: ACCESS_TOKEN)
 ```
 
-What it Does
-------------
+### File Uploads
 
-  * Authentication (user/password, cookie, OAuth2 access token).
-  * Rate limiting.
-  * Modhash handling (reddit's CSRF protection).
-  * JSON coersion.
-  * Forwarding..
-  * Multipart POST.
-  * Reddit error wrapping.
+For example, uploading an image to a subreddit you moderate:
 
-What it Doesn't
----------------
+```ruby
+image_upload = Reddit::Base::UploadIO.new('/path/to/your/image.png', 'image/png')
+reddit.post('/api/upload_sr_img.json', r: SUBREDDIT, file: image_upload, header: 0, name: 'example'
+```
 
-  * 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").
+### Helpers
+
+`Client#get` and `Client#post` accept a `simplify` option to flatten data and kind attributes
+for easier traversal:
+
+```ruby
+client.get('/r/AskReddit', simplify: true)
+```
 
 Recommended Reading
 -------------------

data/lib/reddit/base.rb

@@ -7,6 +7,7 @@ require 'reddit/base/version'
 require 'reddit/base/basic_client'
 require 'reddit/base/client'
 require 'reddit/base/helpers'
+require 'reddit/base/upload_io'
 
 module Reddit
   module Base

data/lib/reddit/base/basic_client.rb

@@ -8,9 +8,13 @@ module Reddit
     class BasicClient
       extend Forwardable
 
+      DEFAULT_URL        = 'http://www.reddit.com'.freeze
+      DEFAULT_URL_SECURE = 'https://ssl.reddit.com'.freeze
+
       DEFAULT_OPTIONS = {
-        url: 'http://www.reddit.com',
-        headers: {'User-Agent' => "reddit-base, a reddit client for ruby by /u/dobs (v#{VERSION})"}
+        headers: {'User-Agent' => "reddit-base, a reddit client for ruby by /u/dobs (v#{VERSION})"},
+        rem: true,
+        url: DEFAULT_URL
       }.freeze
 
       attr_reader :connection, :options
@@ -18,7 +22,10 @@ module Reddit
       def_delegators :connection, :get, :post, :params, :headers
 
       def initialize(options)
+        @secure = options.delete(:secure)
+
         @options = DEFAULT_OPTIONS.merge(options)
+        @options[:url] = DEFAULT_URL_SECURE if @secure
         @connection = Faraday.new(url: @options[:url], headers: @options[:headers]) do |builder|
           builder.request :multipart
           builder.request  :url_encoded

data/lib/reddit/base/client.rb

@@ -11,14 +11,16 @@ module Reddit
       end
 
       def get(*args, **options)
+        simplify = options.delete(:simplify)
         body = connection.get(*args, **options).body
-        body = Reddit::Base::Helpers.simplify body if options[:simplify]
+        body = Reddit::Base::Helpers.simplify body if simplify
         body
       end
 
       def post(*args, **options)
+        simplify = options.delete(:simplify)
         body = connection.post(*args, **options).body
-        body = Reddit::Base::Helpers.simplify body if options[:simplify]
+        body = Reddit::Base::Helpers.simplify body if simplify
         body
       end
     end

data/lib/reddit/base/upload_io.rb

@@ -0,0 +1,5 @@
+module Reddit
+  module Base
+    UploadIO = ::Faraday::UploadIO
+  end
+end

data/lib/reddit/base/version.rb

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

data/reddit-base.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["dan@dobs.org"]
   spec.summary       = %q{A minimal reddit API client for Ruby.}
   spec.description   = %q{A minimal reddit API client for Ruby that
-    simplifies concerns such authentication, rate limiting and extracting
+    simplifies concerns such as authentication, rate limiting and extracting
     JSON.}
   spec.homepage      = ""
   spec.license       = "MIT"
@@ -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.3.0'
+  spec.add_dependency 'faraday_middleware-reddit', '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reddit-base
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel O'Brien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,17 +44,17 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.1
 description: |-
   A minimal reddit API client for Ruby that
-      simplifies concerns such authentication, rate limiting and extracting
+      simplifies concerns such as authentication, rate limiting and extracting
       JSON.
 email:
 - dan@dobs.org
@@ -71,6 +71,7 @@ files:
 - lib/reddit/base/basic_client.rb
 - lib/reddit/base/client.rb
 - lib/reddit/base/helpers.rb
+- lib/reddit/base/upload_io.rb
 - lib/reddit/base/version.rb
 - reddit-base.gemspec
 homepage: ''
@@ -93,9 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A minimal reddit API client for Ruby.
 test_files: []
-has_rdoc: