reddit-base 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04b8cd781236070038145739f35ad484bbb7c3c1
-  data.tar.gz: ff98d9f539a4fddbe7ccd5b299afae68f266c67a
+  metadata.gz: 4232cd6654bdea59d59a30f9ab7ec08edd20c0b8
+  data.tar.gz: 07d3bfef1b8886603e6b1fabf3ffbd7db59ff311
 SHA512:
-  metadata.gz: 5f61050f2f8dac84d0ae6c7b0cb8513917d2b6d4195646b7ddb116f975df623caa7a949e2a01379abf9b82a06a0d9bc4daff5a425f99ff6edbdfbfd6ea6a8ad8
-  data.tar.gz: d3798e08febb37b6833bb4794d411e335c7430d9472108e23d449bfa9ebe2a3c2c5be236b460d32df998ed7363acb7e727886daa0a266408126428201674f4be
+  metadata.gz: 2c8ec53b4ece9178ade713a2ec316af9e23da7474517c14904f34cd8cccb273b0f9e1f405023576f6fc56e524910d5510eead64fff3c0febe2e87fe3b5ddfea8
+  data.tar.gz: 508f49c87fefbdb5804aab9f01eca73d8029f1ae36163abd29133ee75bc340b6b53687a5e17dee7440bbf4b7c4d139f16011021772a6d8e9a3dffb42a69589af

data/README.md

@@ -3,6 +3,8 @@ Reddit Base
 
 A minimal reddit API client for Ruby.
 
+[![Gem Version](https://badge.fury.io/rb/reddit-base.png)](http://badge.fury.io/rb/reddit-base)
+
 Motivation
 ----------
 
@@ -90,18 +92,39 @@ For example, uploading an image to a subreddit you moderate:
 
 ```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'
+client.post('/api/upload_sr_img.json', r: SUBREDDIT, file: image_upload, header: 0, name: 'example'
+```
+
+### Traversal
+
+`Client` returns a type of `Hashie::Mash` so instead of:
+
+```ruby
+client.get('/r/AskReddit')['data']['children']
 ```
 
-### Helpers
+You can do:
 
-`Client#get` and `Client#post` accept a `simplify` option to flatten data and kind attributes
-for easier traversal:
+```ruby
+client.get('/r/AskReddit').data.children
+```
+
+As a bonus it also forwards any missed methods along to its `data` attribute, so you can take it a step
+further and just do:
 
 ```ruby
-client.get('/r/AskReddit', simplify: true)
+client.get('/r/AskReddit').children
 ```
 
+Frequently Asked Questions
+--------------------------
+
+### Why do some requests 403 the first time but succeed when repeated?
+
+The most common cause is that you're attempting to access something private and your modhash hasn't
+been set yet. Try making a request against a public endpoint (e.g. `client.get('/r/AskReddit')`) at
+the start of each session.
+
 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/mash'
 require 'reddit/base/upload_io'
 
 module Reddit

data/lib/reddit/base/client.rb

@@ -1,3 +1,5 @@
+require 'hashie'
+
 module Reddit
   module Base
     # Client that does everything BasicClient does but also attempts to
@@ -11,17 +13,13 @@ module Reddit
       end
 
       def get(*args, **options)
-        simplify = options.delete(:simplify)
         body = connection.get(*args, **options).body
-        body = Reddit::Base::Helpers.simplify body if simplify
-        body
+        Mash.new body
       end
 
       def post(*args, **options)
-        simplify = options.delete(:simplify)
         body = connection.post(*args, **options).body
-        body = Reddit::Base::Helpers.simplify body if simplify
-        body
+        Mash.new body
       end
     end
   end

data/lib/reddit/base/helpers.rb

@@ -1,22 +1,6 @@
 module Reddit
   module Base
     module Helpers
-      def self.simplify(json)
-        return json unless json.is_a? Hash
-
-        if json['data']
-          json['data']['kind'] = json['kind'] if json['data'].is_a? Hash
-          json = simplify json['data']
-        elsif json['children']
-          json['children'] = json['children'].map { |child| simplify child }
-        else
-          json.keys.each do |key|
-            json[key] = simplify json[key]
-          end
-        end
-
-        json
-      end
     end
   end
 end

data/lib/reddit/base/mash.rb

@@ -0,0 +1,17 @@
+module Reddit
+  module Base
+    class Mash < Hashie::Mash
+      def method_missing(method, *args, &block)
+        if self['data'] && self['data'].has_key?(method)
+          self['data'].send(method, *args, &block)
+        else
+          super(method, *args, &block)
+        end
+      end
+
+      def respond_to?(method)
+        (self.respond_to?(:data) && self.data.respond_to?(method)) || super
+      end
+    end
+  end
+end

data/lib/reddit/base/version.rb

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

data/reddit-base.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
 
   spec.add_dependency 'faraday_middleware-reddit', '0.3.1'
+  spec.add_dependency 'hashie', '~> 2.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reddit-base
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel O'Brien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-26 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
 description: |-
   A minimal reddit API client for Ruby that
       simplifies concerns such as authentication, rate limiting and extracting
@@ -71,6 +85,7 @@ files:
 - lib/reddit/base/basic_client.rb
 - lib/reddit/base/client.rb
 - lib/reddit/base/helpers.rb
+- lib/reddit/base/mash.rb
 - lib/reddit/base/upload_io.rb
 - lib/reddit/base/version.rb
 - reddit-base.gemspec