hunting_season 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmM2YmY1YzFkZDlkMDE3MzdlNjFjZjdhOTZlOTY0MjE5OTE4ZGNiNQ==
+    MjBhM2U0NmJlYjNmM2FiNDUxY2U4M2FmZGRiZTZlYTQyNjkxM2NiMg==
   data.tar.gz: !binary |-
-    ZjdmZDY5MzE5ODQ3NWQ5NWQ3YzllOTcwNmYyYTg0ODAwZTI2ZDdlOQ==
+    ZTEyYzI5ZTlhMTcxMmZhZjcwZTdhMTA5MjNlNDQ0M2VlZWE2ZjhhYQ==
 SHA512:
   metadata.gz: !binary |-
-    NDM5ZjNmODIxNDBlMzU2N2I5NjllNTg3MzljMzY5YmQwMjkzNzk0YzRjMzUz
-    Y2FmYzU3MjZiM2M5YzExZTE2NjUwN2VmOWNmMTJiMTk3NDA0MTE2ZDc3OWVj
-    MWQzNGUwM2M2YzczODRjMTc3ZWE3MmY5Zjc1ZGIxYzUwMjZhMDI=
+    MzA0ODZiMDZhOTBhNDgwNWI3NzBhMTUxYzcyOTkzYzU5MmQ4MGYwNTgxNWE1
+    ZTAyZWVmZjJjMDBmZjdjZjJmYTgzMTMwMWVlNDBkMzUwNTExMGEzMDQ0MDY5
+    MGM1NGY5OWIyYTA1YTVmMTU4MDc5MjkxZDZmOTI2ZmMwYjY4MGE=
   data.tar.gz: !binary |-
-    OTc2ZWMyNzAwZDQ5MmZhNmExMzc1ZGFkZTExNmNhYjU5NWVjNGQ0YWI2YmI4
-    N2JhZDA5ODY3N2ZjNzZlNTFlNTJhNTNiZTM1ZTQ0ZDhjYTg2ZjMyM2YzMDZm
-    M2RjYjEyMmE0Y2YzODYzOWNjZDIzMGI3YmJiMDlmMmMzMmExNTE=
+    Y2EzYzQ4MTlhMjAwYzgzN2YwMWJmN2Q5ZmU5Mzk0Zjc2ODM4MWEwZWRjZWM3
+    MTFhOTVkOTRiN2RmNDk2ZTJiNTFiOWFiYTJlMzIyMmFlNDYwYWFlMzRjYTQw
+    ZWI5ZWE4NGM3NDY4NTRhODEwMTcwNTZkZTAwNDNlMWMzMWY1ZjY=

data/README.md

@@ -1,34 +1,167 @@
 # hunting_season [![Build Status](https://secure.travis-ci.org/mikejarema/hunting_season.png)](http://travis-ci.org/mikejarema/hunting_season)
 
-Ruby gem for interacting with the official [Product Hunt API](https://api.producthunt.com/v1/docs).
+`hunting_season` is a ruby gem for interacting with the official [Product Hunt API](https://api.producthunt.com/v1/docs).
 
 
 ## Authentication
 
-Currently only supports a single token, passed to `ProductHunt::API.new(token)`. This mainly supports the use case of using the _Developer Token_ which can be created in the API Dashboard.
+`hunting_season` can use any valid API token. Sources include:
+
+1. A `Developer Token` generated in the [Product Hunt API Dashboard](http://www.producthunt.com/v1/oauth/applications).
+
+2. A client OAuth token as generated by [oauth#token - Ask for client level token](https://api.producthunt.com/v1/docs/oauth_client_only_authentication/oauth_token_ask_for_client_level_token).
+
+3. A user OAuth token as generated by [oauth#authorize - Ask for access grant code on behalf of the user](https://api.producthunt.com/v1/docs/oauth_user_authentication/oauth_authorize_ask_for_access_grant_code_on_behalf_of_the_user). See the [omniauth-producthunt gem](https://github.com/lukaszkorecki/omniauth-producthunt) for an Omniauth strategy that may work (I haven't tested it yet).
+
+When you have a valid token, simply instantiate the `ProductHunt::Client` as follows:
+
+```
+client = ProductHunt::Client.new('mytoken')
+```
 
 
 ## Supported Endpoints
 
-* [posts#show - Get details of a post](https://api.producthunt.com/v1/docs/posts/posts_show_get_details_of_a_post)
-* [votes#index - See all votes for a post](https://api.producthunt.com/v1/docs/postvotes/votes_index_see_all_votes_for_a_post)
-* [users#show - Get details of a user](https://api.producthunt.com/v1/docs/users/users_show_get_details_of_a_user)
+`hunting_season` is a work-in-progress, please [contribute](#contributing) if you need additional functionality.
+
+
+### [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.
+
+Post attributes are listed in the API docs and accessed like `post["name"]`, `post["id"]`, etc.
+
+Example:
+```
+client = ProductHunt::Client.new('mytoken')
+
+post = client.post(3372)
+post["name"]
+# => "namevine"
+post["id"]
+# => 3372
+```
+
+
+### [votes#index - See all votes for a post](https://api.producthunt.com/v1/docs/postvotes/votes_index_see_all_votes_for_a_post)
+
+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:
+```
+client = ProductHunt::Client.new('mytoken')
+post = client.post(3372)
+
+votes = post.votes(per_page: 2, order: 'asc')
+votes[0]["id"]
+# => 46164
+"#{votes[0]["user"]["name"]} #{votes[0]["user"]["headline"]}"
+# => "Jack Smith  Co-Founded Vungle - Advisor to Coin"
+
+votes_page_2 = post.votes(per_page: 2, order: 'asc', newer: votes.last["id"])
+votes_page_2[0]["id"]
+# => 46242
+"#{votes_page_2[0]["user"]["name"]} #{votes_page_2[0]["user"]["headline"]}"
+# => "Helen Crozier Keyboard Karma"
+```
+
+
+### [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.
+
+User attributes are listed in the API docs and accessed like `user["name"]`, `user["headline"]`, etc.
+
+Example:
+```
+client = ProductHunt::Client.new('mytoken')
+user = client.user('rrhoover')
+user["name"]
+# => "Ryan Hoover"
+user["headline"]
+# => "Product Hunt"
+```
+
+
+### [comments#index - Fetch all comments of a post](https://api.producthunt.com/v1/docs/comments/comments_index_fetch_all_comments_of_a_post)
+
+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:
+```
+client = ProductHunt::Client.new('mytoken')
+post = client.post(3372)
+
+comments = post.comments(per_page: 2, order: 'asc')
+comments[0]["id"]
+# => 11378
+"#{comments[0]["user"]["name"]}: #{comments[0]["body"]}"
+# => "Andreas Klinger: fair point but not using thesaurus nor having the ..."
+
+comments_page_2 = post.comments(per_page: 2, order: 'asc', newer: comments.last["id"])
+comments_page_2[0]["id"]
+# => 11558
+"#{comments_page_2[0]["user"]["name"]}: #{comments_page_2[0]["body"]}"
+# => "Mike Jarema: Namevine developer here -- feel free to ask any Qs about ..."
+```
+
+
+### Accessing associated records
+
+For some API responses, an ID reference to or partial details for an associated User or Post are supplied. `hunting_season` provides convenience methods to access the full details of these associated records.
+
+Currently `#post` and `#user` apply when the associated record is present.
+
+Example:
+```
+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
+user_hash.class
+# => Hash
+user_hash["name"]
+# => "Andreas Klinger"
+
+user_object = comment.user    # this will make a separate call to pull the full details of the user who commented
+user_object.class
+# => ProductHunt::User
+user_object["name"]
+# => "Andreas Klinger"
+
+post_object = comment.post    # likewise for the associated post, this will pull full details of the post on which a comment was made via an additional API call
+post_object.class
+# => ProductHunt::Post
+post_object["name"]
+# => "namevine"
+```
+
+## 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.
 
-### In Progress
+2. `env TOKEN=mytoken SKIP_CALL_STUBS=true bundle exec rake` which runs tests against live data from the Product Hunt API.
 
-* [comments#index - Fetch all comments of a post](https://api.producthunt.com/v1/docs/comments/comments_index_fetch_all_comments_of_a_post)
 
+## Contributing
 
-## Examples
+Easy.
 
-For now, see `product_hunt_spec.rb` for examples covering each of the supported endpoints.
+1. [Fork it](https://github.com/mikejarema/hunting_season/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add new functionality, relevant tests and update the README if applicable
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
 
 
 ## Miscellany
 
 Legal: see LICENSE
 
-Quick shout out to [Katchphraze](http://on.rdio.com/1zEb5cA) for unintentionally naming this gem 7 years later :headphones:
+The name is inspired by a rapper buddy of mine: [Katchphraze - Huntin' Season](http://on.rdio.com/1zEb5cA) :headphones:
 
 Copyright (c) 2014 Mike Jarema

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/product_hunt/api.rb

@@ -1,5 +1,3 @@
-# TODO: factor out a base class btw User and Post
-
 module ProductHunt
   module API
     include ProductHunt::API::Posts

data/lib/product_hunt/entity.rb

@@ -10,5 +10,19 @@ module ProductHunt
       @attributes[key]
     end
 
+    [:user, :post].each do |method|
+      eval <<-GENERATED_METHOD
+        def #{method}
+          if @client.is_a?(Client) && @attributes['#{method}'].is_a?(Hash) && @attributes['#{method}']['id']
+            @client.send('#{method}', @attributes['#{method}']['id'])
+          elsif @client.is_a?(Client) && @attributes['#{method}_id']
+            @client.send('#{method}', @attributes['#{method}_id'])
+          else
+            raise NoMethodError.new("undefined method `#{method}' for " + self.inspect)
+          end
+        end
+      GENERATED_METHOD
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hunting_season
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mike Jarema
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty