rowling 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 459f9ebfd9177eec1e25a4d6d64ca7c87fe6491f
-  data.tar.gz: f2e5ca33081dd88320a390dd4fd40be271487584
+  metadata.gz: 978cc635d4f1adaab009a1c5ec5a692603fb47b4
+  data.tar.gz: 818314298ba15aeca00934a6ac4131cb78a6263a
 SHA512:
-  metadata.gz: 6abd827e5307ca49649a09cfde2e12d7ae4ea23161c37830cf53acd3f1bcb3d123c7f55c58faf1c0a4c220453bc412f50fc166c0083653e548b17be374b1991b
-  data.tar.gz: a47bd8c08307ce0bb56f21de902070ab28ed6d4b999b0b23032688963d639bdb6d748a1cf92f1dcc1ceee411b5890d6831d15c6c3eb90384852c86da66bd7d19
+  metadata.gz: bc998add89f1086f2e78b7ba6c056d7223955db21f2d17e7403637fccf896847ec4f39da52c5b314625bfc207f0097cb469ff768ba82f5a75da91b2ee0bed880
+  data.tar.gz: 0ed29b3964702a83b8f2d7f48885c39cf1dce8be3c4336fce8378a8a61b9e2a092fc8fb790e6b7dcff9a11575cabffdb1eeb0869a75bc0062901bb9d17126421

data/README.md

@@ -1,15 +1,16 @@
 # Rowling
 
-A Ruby wrapper for the USA Today Bestsellers API (work in progress!)
+A Ruby wrapper for the [USA Today Bestsellers API](http://developer.usatoday.com/docs/read/bestselling_books).
 
 # Usage
 
-Set up a client:
+First, you'll need an API key, which you can get [here](http://developer.usatoday.com/member/register). Then, you can set up a client:
 
 ```ruby
 client = Rowling::Client.new(api_key: YOUR_KEY)
 ```
 
+##Books
 Search for books included in bestseller lists:
 
 ```ruby
@@ -18,9 +19,11 @@ search_params = { author: "J.K. Rowling",
                 }
 
 books = client.search_books(search_params)
-
 ```
 
+You can view the search parameters [here]( http://developer.usatoday.com/docs/read/bestselling_books#parameters).
+
+
 This returns an array of Book objects:
 
 ```ruby
@@ -40,8 +43,41 @@ Attributes will include:
 title, title_api_url, author, class, description, book_list_appearances, highest_rank, ranks
 ```
 
-You can also search for book lists by year, month and date. All parameters are optional and without parameters it will retrive the most recent list.
+##Booklists
+You can search for book lists by year, month and date. All parameters are optional and without parameters it will retrive the most recent list.
 
 ```ruby
 client.get_booklists(year: 2015, month: 2)
 ```
+
+##Other Requests
+
+```ruby
+# returns available book classes (fiction vs. nonfiction)
+client.get_classes
+
+# returns available book categories
+client.get_categories
+
+# returns dates that bestseller lists were published on (can be filtered by using 
+# parameters of month and year, without parameters returns all dates since Oct. 1993)
+client.get_dates(year: 2015, month: 3)
+```
+
+##Options
+
+If you don't want the responses parsed for you, set up your client with "raw" set to true. The default is false.
+
+```ruby
+client = Rowling::Client.new(api_key: YOUR_API_KEY, raw: true)
+```
+
+If you would like the client to pause and retry requests when you hit a rate limit, set up your client with "retries" set to the number of times you would like it to retry requests. The default is 0.
+
+```ruby
+client = Rowling::Client.new(api_key: YOUR_API_KEY, retries: 2)
+```
+
+###Why is it called Rowling?
+She holds the record for longest #1 USA Today Bestselling Book, with Harry Potter and Sorcerer's Stone topping the list for 31 weeks in 1999. So that's pretty cool.
+

data/lib/rowling.rb

@@ -4,13 +4,8 @@ require "addressable/template"
 require "date"
 require "ext/string.rb"
 require "rowling/version.rb"
-require "rowling/configuration.rb"
 require "rowling/book.rb"
 require "rowling/rank.rb"
 require "rowling/exceptions.rb"
 require "rowling/book_list.rb"
 require "rowling/client.rb"
-
-module Rowling
-  extend Configuration
-end

data/lib/rowling/client.rb

@@ -1,12 +1,20 @@
 module Rowling
   class Client
 
-    attr_accessor *Configuration::CONFIGURATION_KEYS
+    CONFIGURATION_KEYS = [:api_key, :raw, :retries]
 
     def initialize(args={})
-      Configuration::CONFIGURATION_KEYS.each do |key|
+      CONFIGURATION_KEYS.each do |key|
         send("#{key}=", args[key])
       end
+      set_defaults
+    end
+
+    attr_accessor *CONFIGURATION_KEYS
+
+    def set_defaults
+      @raw ||= false
+      @retries ||= 0
     end
 
     def base_template
@@ -28,10 +36,10 @@ module Rowling
       date_response["Dates"]
     end
 
-    def search_books(args={}, raw=false)
+    def search_books(args={})
       segments = "titles"
       book_response = make_request({segments: segments, query: args})
-      if raw
+      if self.raw
         book_response
       else
         if titles = book_response["Titles"]
@@ -44,27 +52,27 @@ module Rowling
       end
     end
 
-    def find_book_by_isbn(isbn, raw=false)
+    def find_book_by_isbn(isbn)
       segments = ["titles", isbn]
-      if raw
-        make_request({ segments: segments }, true)
+      if self.raw
+        make_request({ segments: segments })
       else
         begin
           book_response = make_request({ segments: segments })
           Rowling::Book.new(book_response["Title"])
-        rescue Rowling::Response503Error => e
+        rescue Rowling::Response503Error, Rowling::Response400Error => e
           return nil
         end
       end
     end
 
-    def get_booklists(args={}, raw=false)
+    def get_booklists(args={})
       date_segments = [:year, :month, :day].map do |segment|
         args.delete(segment)
       end
       segments = ["booklists"].concat(date_segments.compact)
       response = make_request({ segments: segments, args: args})
-      if raw
+      if self.raw
         response
       elsif lists = response["BookLists"]
         lists.map{ |list| BookList.new(list) }
@@ -73,11 +81,11 @@ module Rowling
       end
     end
 
-    def get_detailed_version(book, raw=false)
+    def get_detailed_version(book)
       if book.title_api_url
         segments = book.title_api_url
         book_response = make_request({ segments: segments })
-        if raw
+        if self.raw
           book_response
         else
           Rowling::Book.new(book_response["Title"])
@@ -87,20 +95,20 @@ module Rowling
       end
     end
 
-    def make_request(args={}, raw=false, tries=0)
+    def make_request(args={}, tries=0)
       if self.api_key
         uri = build_uri(args)
         response = HTTParty.get(uri)
-        if raw
+        if self.raw
           response
         else
-          if tries < 2
+          if tries < self.retries
             begin
               check_errors(response)
             rescue Rowling::Response403Error
               tries += 1
-              sleep(2)
-              make_request(args, false, tries)
+              sleep(1)
+              make_request(args, tries)
             end
           else
             check_errors(response)
@@ -120,6 +128,8 @@ module Rowling
     def check_errors(response)
       if response.code == 503
         raise Rowling::Response503Error
+      elsif response.code == 400
+        raise Rowling::Response400Error
       elsif response.code == 403
         raise Rowling::Response403Error
       elsif response.code != 200

data/lib/rowling/exceptions.rb

@@ -5,9 +5,15 @@ module Rowling
     end
   end
 
+  class Response400Error < StandardError
+    def message
+      "Bad request (data not found)."
+    end
+  end
+
   class Response403Error < StandardError
     def message
-      "Exceeded quota per second"
+      "Exceeded quota per second/api rate limit"
     end
   end
 

data/lib/rowling/version.rb

@@ -1,3 +1,3 @@
 module Rowling
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/rowling/client_test.rb

@@ -3,12 +3,16 @@ require 'helper'
 describe Rowling::Client do
 
   before do
-    @client = Rowling::Client.new(api_key: ENV["USATODAY_BESTSELLER_KEY"], format: :json)
+    @client = Rowling::Client.new(api_key: ENV["USATODAY_BESTSELLER_KEY"])
   end
 
-  it "should configure valid configuration keys" do
+  it "should configure an api key" do
     @client.api_key.must_equal ENV["USATODAY_BESTSELLER_KEY"]
-    @client.format.must_equal :json
+  end
+
+  it "should configure default values for other attributes" do
+    @client.retries.must_equal 0
+    @client.raw.must_equal false
   end
 
   it "should raise an error if you try to make a request without an API key" do
@@ -17,6 +21,19 @@ describe Rowling::Client do
   end
 
   describe "requests", :vcr do
+    before do
+      @client.retries = 2
+    end
+    # this is a shitty test but the VCR request it created works for now,
+    # will need to come up with a better one at some point
+    it "should pause and retry when throttled" do
+      retry_client = Rowling::Client.new(api_key: ENV["USATODAY_BESTSELLER_KEY"])
+      3.times do
+        book = @client.find_book_by_isbn("9780758280428")
+        book.must_be_instance_of Rowling::Book
+      end
+    end
+
     it "should get classes" do
       classes = @client.get_classes
       classes.must_equal ["---", "Fiction", "NonFiction"]
@@ -68,22 +85,25 @@ describe Rowling::Client do
     end
 
     describe "when raw is set to true" do
+      before do
+        @client.raw = true
+      end
 
       describe "when searching by ISBN" do
 
         it "should return a raw response" do
-          response = @client.find_book_by_isbn("9780758280428", true)
+          response = @client.find_book_by_isbn("9780758280428")
           response.must_be_instance_of Hash
         end
 
         it "should not raise an error when a book is not found" do
-          response = @client.find_book_by_isbn("9781555976859", true)
-          response.must_be_instance_of String
+          response = @client.find_book_by_isbn("9781555976859")
+          response.must_be_instance_of Hash
         end
       end
 
       it "should return a raw response when searching for a book by parameters" do
-        response = @client.search_books({author: "J.K. Rowling"}, true)
+        response = @client.search_books({author: "J.K. Rowling"})
         response.must_be_instance_of Hash
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rowling
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sonja Peterson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -139,7 +139,6 @@ files:
 - lib/rowling/book.rb
 - lib/rowling/book_list.rb
 - lib/rowling/client.rb
-- lib/rowling/configuration.rb
 - lib/rowling/exceptions.rb
 - lib/rowling/rank.rb
 - lib/rowling/version.rb
@@ -148,7 +147,6 @@ files:
 - test/rowling/book_list_test.rb
 - test/rowling/book_test.rb
 - test/rowling/client_test.rb
-- test/rowling/configuration_test.rb
 - test/rowling/rank_test.rb
 - test/rowling/rowling_test.rb
 homepage: ''
@@ -180,6 +178,5 @@ test_files:
 - test/rowling/book_list_test.rb
 - test/rowling/book_test.rb
 - test/rowling/client_test.rb
-- test/rowling/configuration_test.rb
 - test/rowling/rank_test.rb
 - test/rowling/rowling_test.rb

data/lib/rowling/configuration.rb

@@ -1,21 +0,0 @@
-module Rowling
-  module Configuration
-    DEFAULT_FORMAT = :json
-    CONFIGURATION_KEYS = [:api_key, :format]
-
-    attr_accessor *CONFIGURATION_KEYS
-
-    def self.extended(base)
-      base.reset
-    end
-
-    def reset
-      self.api_key = nil
-      self.format = :json
-    end
-
-    def configure
-      yield self
-    end
-  end
-end

data/test/rowling/configuration_test.rb

@@ -1,23 +0,0 @@
-require 'helper'
-
-describe 'configuration' do
-  after do
-    Rowling.reset
-  end
-
-  it "should set json as the default format" do
-    Rowling.format.must_equal :json
-  end
-
-  it "should set the api key's default value as nil" do
-    Rowling.api_key.must_equal nil
-  end
-
-  it "should allow you to set an api key" do
-    Rowling.configure do |config|
-      config.api_key = "my_secret_key"
-    end
-    Rowling.api_key.must_equal "my_secret_key"
-  end
-end
-