nytimes-bestsellers 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62ef4d25e237bdc6d28445e742d51e8b80d5c8b8
+  data.tar.gz: ba50cdb4811ecf0083b7cb15090b3a75dca96020
+SHA512:
+  metadata.gz: 6875cd69164943cbdf426bdcf6b8ee703f323678357c30e0764de2f49a5684ffb008330f820c33092125801c56c285516fd1f872770eee40b536b7594331cc94
+  data.tar.gz: 9aa2f1360be38010167758a6a5e7b9b0ba354c928962978e90730913cd5ea3f80bf99ca21f1fee5959deb401226a72dfdafacebe3986a1791fe68eabade75d70

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+gem 'httparty'
+gem 'dotenv'
+gem 'rake'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "pry"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "simplecov"
+end
+
+group :test do
+  gem 'rspec'
+  gem 'shoulda-matchers'
+  gem 'webmock'
+  gem 'simplecov'
+  gem 'coveralls', require: false
+end

data/README.md

@@ -0,0 +1,108 @@
+[![Build Status](https://travis-ci.org/enspencer/nytimes-bestsellers.png?branch=master)](https://travis-ci.org/enspencer/nytimes-bestsellers) [![Coverage Status](https://coveralls.io/repos/enspencer/nytimes-bestsellers/badge.png)](https://coveralls.io/r/enspencer/nytimes-bestsellers)
+
+# New York Times Bestsellers
+
+A Ruby gem for accessing the [New York Times Bestsellers API](http://developer.nytimes.com/docs/best_sellers_api).
+
+## Install
+
+Add this line to your application's Gemfile:
+
+    gem 'nytimes-bestsellers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nytimes-bestsellers
+
+## Getting Started
+
+You'll want to sign up for an [API key](http://developer.nytimes.com/apps/register) to start.
+
+Setup a new instance:
+
+```ruby
+@client = Bestsellers.new
+@client.configure do |config|  
+  config.api_key = "YOUR_API_KEY"
+end
+```
+
+and do your thing!
+
+## Methods
+
+Six requests are available: get a bestseller list, get an overview of all of the best-seller lists for a given week, search a bestseller list, get the history of a single bestseller, get the names of all Times best-seller lists, and get the age group options that can be used as a parameter in the `single history` method.
+
+### 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.
+
+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')`
+
+### 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.
+
+`@client.bestseller_lists_overview`
+`@client.bestseller_lists_overview(date: '2012-04-12')`
+
+
+### 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.
+
+`@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).
+
+`@client.single_history(author: 'rachel maddow')`
+
+
+### find_list_names
+
+This method takes no parameters and returns all available list names which you can use to query the get_list method. These names can be used as the required list_name parameter for get_list and single_history.
+
+`@client.find_list_names`
+
+### age_groups
+
+This method takes no parameters and returns all available age groups which you can use to query the single_history method. In most cases the age group will be null, so it's not a great search method on the data. I've listen the age groups below but you can see these available age groups for yourself using the `age_groups` method.
+
+`@client.age_groups`
+
+
+## Lists
+
+The list names to search from are:
+
+Combined Print and E-Book Fiction, Combined Print and E-Book Nonfiction, Hardcover Fiction, Hardcover Nonfiction, Trade Fiction Paperback, Mass Market Paperback, Paperback Nonfiction, E-Book Fiction, E-Book Nonfiction, Hardcover Advice, Paperback Advice, Advice How-To and Miscellaneous, Picture Books, Chapter Books, Childrens Middle Grade, Young Adult, Paperback Books, Series Books, Hardcover Graphic Books, Paperback Graphic Books, Manga, Combined Print Fiction, Combined Print Nonfiction, Hardcover Business Books, Paperback Business Books, Business Books, Hardcover Political Books, Science Times, Dining
+
+You can pass these names with spaces or replace spaces with hyphens, either works. The parameter is not case sensitive.
+
+## Age Groups
+
+The age group parameter can be used as an optional parameter in the `single_history` method. In most cases the age group will be null, so it's not a great search method on the data. But you can use the age groups below to search, or see these available age groups for yourself using the `age_groups` method.
+
+Valid age groups: "Ages 1 to 5", "Ages 10 and up", "Ages 10 to 13", "Ages 10 to 14", "Ages 10 to 15", "Ages 10 to 18", "Ages 11 and up", "Ages 11 to 14", "Ages 11 to 15", "Ages 12 and  up", "Ages 12 and up", "Ages 12 to 14", "Ages 12 to 17", "Ages 12 to 18", "Ages 13 and up", "Ages 13 to 16", "Ages 13 to 17", "Ages 13 to 18", "Ages 14 and up", "Ages 14 to 17", "Ages 14 to 18", "Ages 15 and up", "Ages 15 to 17", "Ages 15 to 18", "Ages 16 and up", "Ages 17 and up", "Ages 18 and up", "Ages 2 and up", "Ages 2 to 5", "Ages 2 to 6", "Ages 2 to 7", "Ages 3 and up", "Ages 3 to 5", "Ages 3 to 6", "Ages 3 to 7", "Ages 3 to 8, "Ages 4 and up", "Ages 4 to 7", "Ages 4 to 8", "Ages 5 and up", "Ages 5 to 10"}, "Ages 5 to 7", "Ages 5 to 8", "Ages 5 to 9", "Ages 6 and up", "Ages 6 to 10"}, "Ages 6 to 12"}, "Ages 6 to 14", "Ages 6 to 8", "Ages 6 to 9", "Ages 7 and up", "Ages 7 to 10", "Ages 7 to 12", "Ages 7 to 17", "Ages 7 to 9", "Ages 8 and up", "Ages 8 to 12", "Ages 8 to 14", "Ages 9 and up", "Ages 9 to 11", "Ages 9 to 12", "Ages 9 to 13", "All ages"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature`)
+3. Commit your changes (`git commit -m 'Add this feature'`)
+4. Push to the branch (`git push origin feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright © 2013 Emma Spencer. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+task default: :spec

data/lib/nytimes_bestsellers.rb

@@ -0,0 +1,19 @@
+require 'nytimes_bestsellers/client'
+
+module Bestsellers
+  class << self
+
+    def new
+      @list ||= Bestsellers::List.new
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/nytimes_bestsellers/client.rb

@@ -0,0 +1,93 @@
+require 'json'
+require 'httparty'
+require 'nytimes_bestsellers/configuration'
+
+module Bestsellers
+
+  class List
+    
+    include Bestsellers::Configuration
+    include HTTParty
+
+    BOOKS_URL = "http://api.nytimes.com/svc/books/v2/lists"
+    BOOKS_URL
+
+    def initialize
+      reset
+    end
+
+    def set_urlparam(url, name, options)
+      return unless options[name]
+      url << "&#{name.to_s.gsub('_','-')}=#{options[name]}"
+     end
+
+    def get_list(list_name, o = {})
+      url = BOOKS_URL.clone
+
+      if o[:date]
+        date = o[:date]
+        url << "/#{date}"
+      end
+      
+      url << "/#{list_name}?"
+
+      [:offset, :sort_by, :sort_order].each do |thing|
+        set_urlparam(url, thing, o)
+      end
+
+      url << "&api-key=#{api_key}"
+
+      HTTParty.get(url)
+    end
+
+    def search_list(list_name, o = {})
+
+      url = BOOKS_URL.clone + "?list-name=#{list_name}"
+
+      date = if o[:date]
+        Date.parse(o[:date]) 
+      else
+        Date.today
+      end.strftime('%Y-%m-%e')
+      url << "&date=#{date}"
+
+      [:isbn, :published_date, :rank, :rank_last_week, :weeks_on_list].each do |thing|
+        set_urlparam(url, thing, o)
+      end
+
+      url << "&api-key=#{api_key}"
+
+     HTTParty.get(url)
+    end
+
+    def bestseller_lists_overview(o = {})
+      date = (Date.parse o[:date] || Date.today).strftime('%Y-%m-%e')
+
+      HTTParty.get(BOOKS_URL + "/overview?published_date=#{date}&api-key=#{api_key}")
+    end
+
+    def single_history(o = {})
+
+      url = BOOKS_URL.clone + "/best-sellers/history"
+
+      url << "?"
+
+      [:author, :publisher, :title, :age_group, :contributor, :isbn, :price].each do |thing|
+        set_urlparam(url, thing, o)
+      end
+
+      url << "&api-key=#{api_key}"
+
+      HTTParty.get(url)
+    end
+
+    def find_list_names
+      HTTParty.get(BOOKS_URL + "/names?api-key=#{api_key}")
+    end
+
+    def age_groups
+      HTTParty.get(BOOKS_URL + "/age-groups?api-key=#{api_key}")
+    end
+
+  end
+end

data/lib/nytimes_bestsellers/configuration.rb

@@ -0,0 +1,15 @@
+module Bestsellers
+  module Configuration
+    
+    attr_accessor :api_key
+
+    def configure
+      yield self
+    end
+
+    def reset
+      self.api_key = nil
+      self
+    end
+  end
+end

data/lib/nytimes_bestsellers/version.rb

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

data/spec/nytimes_bestsellers_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Bestsellers do
+  describe '.new' do
+    it "returns a Bestsellers::List" do
+      expect(Bestsellers.new).to be_a Bestsellers::List
+    end
+  end
+
+  describe ".configure" do
+    it "sets api_key" do
+      Bestsellers.configure do |config|
+        config.api_key = "secret"
+      end
+
+      expect(Bestsellers.api_key).to eq "secret"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'nytimes_bestsellers'
+require 'rspec'
+require 'webmock/rspec'
+require 'json'
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+Coveralls.wear!

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: nytimes-bestsellers
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Emma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies: []
+description: Gem for accessing the NYTimes Bestsellers API
+email: emma.n.spencer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Gemfile
+- Rakefile
+- spec/nytimes_bestsellers_spec.rb
+- spec/spec_helper.rb
+- lib/nytimes_bestsellers/client.rb
+- lib/nytimes_bestsellers/configuration.rb
+- lib/nytimes_bestsellers/version.rb
+- lib/nytimes_bestsellers.rb
+homepage: http://github.com/enspencer/nytimes-bestsellers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Gem for accessing the NYTimes Bestsellers API
+test_files: []