nytimes-bestsellers 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62ef4d25e237bdc6d28445e742d51e8b80d5c8b8
-  data.tar.gz: ba50cdb4811ecf0083b7cb15090b3a75dca96020
+  metadata.gz: 432218d26fbcf904836f7e7ae5104219db6f4c83
+  data.tar.gz: 2c8a6db6ebd3d8768ae4b13e5a6998569b8c2b65
 SHA512:
-  metadata.gz: 6875cd69164943cbdf426bdcf6b8ee703f323678357c30e0764de2f49a5684ffb008330f820c33092125801c56c285516fd1f872770eee40b536b7594331cc94
-  data.tar.gz: 9aa2f1360be38010167758a6a5e7b9b0ba354c928962978e90730913cd5ea3f80bf99ca21f1fee5959deb401226a72dfdafacebe3986a1791fe68eabade75d70
+  metadata.gz: e5864550aba3422292fe826cf19047cf65f9e377d6f7814011e6a507f951c18578d74031c829be179d9c1a18429ad461a99efd06d0acf6a8fab2543eede95bfa
+  data.tar.gz: 1ffcae12805299a1d75c612d8b3e60816b20b46dcf17dd21ea4aa4d1f764a904f1ec266f8c275bcc5ea459fe0a501bafaa16861ddf0207aad86c6b6ea71f635e

data/README.md

@@ -2,7 +2,7 @@
 
 # New York Times Bestsellers
 
-A Ruby gem for accessing the [New York Times Bestsellers API](http://developer.nytimes.com/docs/best_sellers_api).
+A Ruby gem for accessing the [New York Times Best Sellers API](http://developer.nytimes.com/docs/best_sellers_api) that gathers data from the [Best Sellers List](http://www.nytimes.com/best-sellers-books/).
 
 ## Install
 
@@ -31,7 +31,7 @@ Setup a new instance:
 end
 ```
 
-and do your thing!
+Heads up! If you're not using Rails, note that when requiring the gem in your files you'll need to use `require nytimes_bestsellers` with the underscore rather than a dash.
 
 ## Methods
 
@@ -39,17 +39,17 @@ Six requests are available: get a bestseller list, get an overview of all of the
 
 ### get_list(list_name, o = {})
 
-This method has a required parameter of list name(see lists below or call the find_list_names method to find them for yourself) and takes an optional parameter of date, as a string in YYYY-MM-DD format. It also takes an optional parameter of response format and if none is specified it defaults to json.
+This method has a required parameter of list name(see lists below or call the find_list_names method to find them for yourself) and takes optional parameters of date(as a string in YYYY-MM-DD format), offset, sort_by, and sort_order.
 
 with no optional parameters it gets the most recent list
 `@client.get_list('hardcover-nonfiction')`
 
 it can take optional parameters
-`@client.get_list('hardcover-nonfiction', date: '2012-04-12', response: 'xml')`
+`@client.get_list('hardcover-nonfiction', date: '2012-04-12', offset: 20)`
 
 ### bestseller_lists_overview()
 
-Returns an overview of Times best-seller lists for a single week. Takes an optional parameter of date in YYYY-MM-DD format. If you do not specify a published_date the most recent week's best-seller list will be returned.
+Returns an overview of Times best-seller lists for a single week. Takes an optional parameter of date in YYYY-MM-DD format. If you do not specify a date the most recent week's best-seller list will be returned.
 
 `@client.bestseller_lists_overview`
 `@client.bestseller_lists_overview(date: '2012-04-12')`
@@ -57,13 +57,13 @@ Returns an overview of Times best-seller lists for a single week. Takes an optio
 
 ### search_list(list_name, o = {})
 
-Allows for a filtered search of a specific list. Optional parameters are date, isbn, published_date, rank, rank_last_week, and weeks_on_list.
+Allows for a filtered search of a specific list. Optional parameters are date, isbn, published_date, rank, rank_last_week, and weeks_on_list. Has additional parameters of offset, sort_by, and sort_order.
 
 `@client.search_list('hardcover-nonfiction', published_date: "2013-04-12")`
 
 ### single_history()
 
-Returns up to 20 weeks of history for a bestseller (its rank and number of weeks on the various Times best-seller lists). Takes one or more of the following parameters: , author, contributor, isbn, price, publisher, title, age_group(see below for age group options).
+Returns up to 20 weeks of history for a bestseller (its rank and number of weeks on the various Times best-seller lists). Takes one or more of the following parameters: author, contributor, isbn, price, publisher, title, age_group(see below for age group options). Has additional parameters of sort_by and sort_order.
 
 `@client.single_history(author: 'rachel maddow')`
 

data/lib/nytimes_bestsellers/client.rb

@@ -18,7 +18,7 @@ module Bestsellers
 
     def set_urlparam(url, name, options)
       return unless options[name]
-      url << "&#{name.to_s.gsub('_','-')}=#{options[name]}"
+      url << "&#{name.to_s.gsub('_','-')}=#{options[name].gsub(/ /, '-')}"
      end
 
     def get_list(list_name, o = {})
@@ -29,7 +29,7 @@ module Bestsellers
         url << "/#{date}"
       end
       
-      url << "/#{list_name}?"
+      url << "/#{list_name.gsub(/ /, '-')}?"
 
       [:offset, :sort_by, :sort_order].each do |thing|
         set_urlparam(url, thing, o)
@@ -42,7 +42,7 @@ module Bestsellers
 
     def search_list(list_name, o = {})
 
-      url = BOOKS_URL.clone + "?list-name=#{list_name}"
+      url = BOOKS_URL.clone + "?list-name=#{list_name.gsub(/ /, '-')}"
 
       date = if o[:date]
         Date.parse(o[:date]) 
@@ -51,7 +51,7 @@ module Bestsellers
       end.strftime('%Y-%m-%e')
       url << "&date=#{date}"
 
-      [:isbn, :published_date, :rank, :rank_last_week, :weeks_on_list].each do |thing|
+      [:isbn, :published_date, :rank, :rank_last_week, :weeks_on_list, :offset, :sort_by, :sort_order].each do |thing|
         set_urlparam(url, thing, o)
       end
 
@@ -72,7 +72,7 @@ module Bestsellers
 
       url << "?"
 
-      [:author, :publisher, :title, :age_group, :contributor, :isbn, :price].each do |thing|
+      [:author, :publisher, :title, :age_group, :contributor, :isbn, :price, :sort_by, :sort_order].each do |thing|
         set_urlparam(url, thing, o)
       end
 

data/lib/nytimes_bestsellers/version.rb

@@ -1,3 +1,3 @@
 module Bestsellers
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nytimes-bestsellers
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Emma