hunting_season 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjBhM2U0NmJlYjNmM2FiNDUxY2U4M2FmZGRiZTZlYTQyNjkxM2NiMg==
-  data.tar.gz: !binary |-
-    ZTEyYzI5ZTlhMTcxMmZhZjcwZTdhMTA5MjNlNDQ0M2VlZWE2ZjhhYQ==
+SHA1:
+  metadata.gz: d5b4c9215d09f4fc84654338062e0b28c3e6147b
+  data.tar.gz: 8f0e9c7c28d45278e28ad041bff6f43ead27e953
 SHA512:
-  metadata.gz: !binary |-
-    MzA0ODZiMDZhOTBhNDgwNWI3NzBhMTUxYzcyOTkzYzU5MmQ4MGYwNTgxNWE1
-    ZTAyZWVmZjJjMDBmZjdjZjJmYTgzMTMwMWVlNDBkMzUwNTExMGEzMDQ0MDY5
-    MGM1NGY5OWIyYTA1YTVmMTU4MDc5MjkxZDZmOTI2ZmMwYjY4MGE=
-  data.tar.gz: !binary |-
-    Y2EzYzQ4MTlhMjAwYzgzN2YwMWJmN2Q5ZmU5Mzk0Zjc2ODM4MWEwZWRjZWM3
-    MTFhOTVkOTRiN2RmNDk2ZTJiNTFiOWFiYTJlMzIyMmFlNDYwYWFlMzRjYTQw
-    ZWI5ZWE4NGM3NDY4NTRhODEwMTcwNTZkZTAwNDNlMWMzMWY1ZjY=
+  metadata.gz: 980dd1edb9894bf269af62688df3994f56e09ec7bed83f5f7b6abfa5022ccd86704bf800bdb8454290f5d8744d1a78c11946fa84e433d226fbbe084df5055b05
+  data.tar.gz: 91ffdf9a711c1f54e5de205bdbbe98c69f5e9b8917ce33197a5be6ed2241f041a19f85075f1f1ef4a129da0abb10c957248a40f16ab4d88a4690461123c884ad

data/README.md

@@ -15,7 +15,7 @@
 
 When you have a valid token, simply instantiate the `ProductHunt::Client` as follows:
 
-```
+```ruby
 client = ProductHunt::Client.new('mytoken')
 ```
 
@@ -25,6 +25,39 @@ client = ProductHunt::Client.new('mytoken')
 `hunting_season` is a work-in-progress, please [contribute](#contributing) if you need additional functionality.
 
 
+### [posts#index - Get the posts of today](https://api.producthunt.com/v1/docs/posts/posts_index_get_the_posts_of_today)
+
+Look up today's posts.
+
+Post attributes are listed in the API docs and accessed like `post["name"]`, `post["id"]`, etc.
+
+Example:
+```ruby
+client = ProductHunt::Client.new('mytoken')
+
+posts = client.posts
+posts.size       # -> 14
+posts[0]["name"] # -> "Content Marketing Stack"
+posts[0]["id"]   # -> 30425
+```
+
+
+### [posts#all - Get all the newest posts](https://api.producthunt.com/v1/docs/posts/posts_all_get_all_the_newest_posts)
+
+Look up all posts.
+
+Post attributes are listed in the API docs and accessed like `post["name"]`, `post["id"]`, etc.
+
+Example:
+```ruby
+client = ProductHunt::Client.new('mytoken')
+
+posts = client.all_posts(per_page: 1, order: 'asc')
+posts[0]["name"] # -> "Ferro"
+posts[0]["id"]   # -> 3
+```
+
+
 ### [posts#show - Get details of a post](https://api.producthunt.com/v1/docs/posts/posts_show_get_details_of_a_post)
 
 Look up a post using a required numeric ID.
@@ -32,7 +65,7 @@ Look up a post using a required numeric ID.
 Post attributes are listed in the API docs and accessed like `post["name"]`, `post["id"]`, etc.
 
 Example:
-```
+```ruby
 client = ProductHunt::Client.new('mytoken')
 
 post = client.post(3372)
@@ -50,7 +83,7 @@ Look up a post's votes, with optional ordering and pagination.
 Post attributes are listed in the API docs and accessed like `vote["user"]`, `vote["id"]`, etc.
 
 Example, look up a post's votes and paginate through them in ascending order:
-```
+```ruby
 client = ProductHunt::Client.new('mytoken')
 post = client.post(3372)
 
@@ -68,6 +101,21 @@ votes_page_2[0]["id"]
 ```
 
 
+### [users#index - Get all users](https://api.producthunt.com/v1/docs/users/users_index_get_all_users)
+
+Get all users using ordering and pagination as noted in the official API docs.
+
+Example:
+```ruby
+client = ProductHunt::Client.new('mytoken')
+
+users = client.users(order: 'asc')
+users.first["name"] # -> "Nathan Bashaw"
+users.first["headline"] # -> "Working on something new :)"
+users.first["id"] # -> 1
+```
+
+
 ### [users#show - Get details of a user](https://api.producthunt.com/v1/docs/users/users_show_get_details_of_a_user)
 
 Look up a user by username or id.
@@ -75,7 +123,7 @@ Look up a user by username or id.
 User attributes are listed in the API docs and accessed like `user["name"]`, `user["headline"]`, etc.
 
 Example:
-```
+```ruby
 client = ProductHunt::Client.new('mytoken')
 user = client.user('rrhoover')
 user["name"]
@@ -90,7 +138,7 @@ user["headline"]
 Look up a post's comments, with optional ordering and pagination.
 
 Example, look up a post's comments and paginate through them in ascending order:
-```
+```ruby
 client = ProductHunt::Client.new('mytoken')
 post = client.post(3372)
 
@@ -115,7 +163,7 @@ For some API responses, an ID reference to or partial details for an associated
 Currently `#post` and `#user` apply when the associated record is present.
 
 Example:
-```
+```ruby
 comment = ProductHunt::Client.new('mytoken').post(3372).comments(order: 'asc').first
 
 user_hash = comment["user"]   # this will access the partial user details embedded in the response to the #comments call above
@@ -137,13 +185,37 @@ post_object["name"]
 # => "namevine"
 ```
 
+
+## ETAG Support
+
+You can retrieve the etag for any call by calling `#etag` against the returned object or collection:
+
+```ruby
+client = ProductHunt::Client.new('mytoken')
+post = client.post(3372)
+etag = post.etag
+```
+
+You then can leverage [Product Hunt's API support](https://api.producthunt.com/v1/docs/example_performance_tips/use_the_e-tag_http_header) to increase performance by passing this etag on subsequent requests. If a record has NOT changed, it will respond to `#modified?` with false.
+
+```ruby
+post = client.post(3372, headers: { 'If-None-Match': etag }) # pass as custom header
+post = client.post(3372, etag: etag)                         # OR explicitly
+
+if post.modified?
+  # do something with the modified post
+else
+  # the post remains unmodified, trying to access any attributes on this object will raise an exception
+end
+```
+
 ## Tests
 
 There are two ways to run tests:
 
-1. `env TOKEN=mytoken bundle exec rake` which stubs out all of the calls to Product Hunt's API to local files.
+1. `bundle exec rake` which stubs out all of the calls to Product Hunt's API to local files.
 
-2. `env TOKEN=mytoken SKIP_CALL_STUBS=true bundle exec rake` which runs tests against live data from the Product Hunt API.
+2. `TOKEN=mytoken USE_LIVE_API=true bundle exec rake` which runs tests against live data from the Product Hunt API using your developer token.
 
 
 ## Contributing

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/hunting_season.rb

@@ -9,4 +9,3 @@ require 'product_hunt/user'
 require 'product_hunt/post'
 require 'product_hunt/vote'
 require 'product_hunt/comment'
-

data/lib/product_hunt/api/posts.rb

@@ -5,20 +5,33 @@ module ProductHunt
       PATH = "/posts"
 
       def posts(options = {})
-        fetch(PATH, options)["posts"].map{ |post| Post.new(post, self) }
+        process(PATH, options) do |response|
+          response["posts"].map{ |post| Post.new(post, self) }
+        end
+      end
+
+      def all_posts(options = {})
+        process(PATH + "/all", options) do |response|
+          response["posts"].map{ |post| Post.new(post, self) }
+        end
       end
 
       def post(id, options = {})
-        post = fetch(PATH + "/#{id}", options)["post"]
-        Post.new(post, self)
+        process(PATH + "/#{id}", options) do |response|
+          Post.new(response["post"], self)
+        end
       end
 
       def comments_for_post(id, options = {})
-        fetch(PATH + "/#{id}/comments", options)["comments"].map{ |c| Comment.new(c, self) }
+        process(PATH + "/#{id}/comments", options) do |response|
+          response["comments"].map{ |c| Comment.new(c, self) }
+        end
       end
 
       def votes_for_post(id, options = {})
-        fetch(PATH + "/#{id}/votes", options)["votes"].map{ |c| Vote.new(c, self) }
+        process(PATH + "/#{id}/votes", options) do |response|
+          response["votes"].map{ |c| Vote.new(c, self) }
+        end
       end
     end
   end

data/lib/product_hunt/api/users.rb

@@ -2,11 +2,25 @@ module ProductHunt
   module API
     module Users
 
-      PATH = "/users"
+      USERS_PATH = "/users"
+      CURRENT_USER_PATH = "/me"
+
+      def users(options = {})
+        process(USERS_PATH, options) do |response|
+          response["users"].map{ |user| User.new(user, self) }
+        end
+      end
 
       def user(id, options = {})
-        user = fetch(PATH + "/#{id}", options)["user"]
-        User.new(user, self)
+        process(USERS_PATH + "/#{id}", options) do |response|
+          User.new(response["user"], self)
+        end
+      end
+
+      def current_user(options = {})
+        process(CURRENT_USER_PATH, options) do |response|
+          User.new(response["user"], self)
+        end
       end
 
     end

data/lib/product_hunt/client.rb

@@ -13,16 +13,53 @@ module ProductHunt
       @config = { headers: { "Authorization" => "Bearer #{token}" } }
     end
 
-    def config
-      @config
-    end
-
     def fetch(path, params)
+      config = @config
+
+      if params.has_key?(:headers)
+        headers = params.delete(:headers)
+        config = config.merge({headers: config[:headers].merge(headers)})
+      end
+
+      if params.has_key?(:etag)
+        etag = params.delete(:etag)
+        config = config.merge({headers: config[:headers].merge({'If-None-Match' => etag})})
+      end
+
       queryopts = if params.is_a?(Enumerable) && params.size > 0
         "?" + URI.encode_www_form(params)
       end
 
-      self.class.get(path + (queryopts || ""), @config)
+      self.class.get(path + (queryopts || ""), config)
     end
+
+    def process(path, params)
+      response = fetch(path, params)
+      processed_response = nil
+
+      fail "Block required to process response" if !block_given?
+
+      if response.code == 200
+        processed_response = yield response
+        processed_response.define_singleton_method(:modified?) { true }
+      elsif response.code == 304
+        processed_response.define_singleton_method(:modified?) { false }
+        processed_response.define_singleton_method(:method_missing) do |symbol, args|
+          raise InvalidAccessToUnmodifiedRecordError.new("Trying to call `#{symbol}`")
+        end
+      else
+        fail "Still need to cover the other response codes and use cases for the API (eg. 304 not modified, error cases)"
+      end
+
+      if response.headers["etag"]
+        fail "Object already defines #etag method" if processed_response.respond_to?(:etag)
+        processed_response.define_singleton_method(:etag) { response.headers["etag"].gsub!(/\A"|"\z/, '') }
+      end
+
+      processed_response
+    end
+  end
+
+  class InvalidAccessToUnmodifiedRecordError < StandardError
   end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: hunting_season
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Mike Jarema
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 description: Ruby gem which interfaces with Product Hunt's official REST API (api.producthunt.com).
@@ -87,7 +87,7 @@ files:
 - lib/product_hunt/post.rb
 - lib/product_hunt/user.rb
 - lib/product_hunt/vote.rb
-homepage: http://rubygems.org/gems/hunting_season
+homepage: https://github.com/mikejarema/hunting_season
 licenses:
 - MIT
 metadata: {}
@@ -97,17 +97,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby interface to producthunt.com's offical REST API.