goodreads 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e1c4bc2ac3e141e0c1b7774c1a80507a236946d
-  data.tar.gz: 2d335ac55485c8ec4259a1296df9ae68095e94ab
+  metadata.gz: 0bf2079b03cdc4a3630504bab0adf6fceb39116d
+  data.tar.gz: 41ffa08e6b041c58d284a94489a55926d8be22aa
 SHA512:
-  metadata.gz: 497e314c0b4596b2117cdd3402d01602d33abcabce9653abcb6cd9bc112dee643ba970f7e0cdda1462fa8ea1c439248e3400562160fcd5b8b7c57fea80a9b706
-  data.tar.gz: 43aea244b93abe77c875cf894aa229c3d2062e6ed78e094ba9d1dcac4c46fffac46cc968d263536d45cdbbcd18c808b13b53db4f220ea8efa3644a1a445d2362
+  metadata.gz: 76523d2373dc284161ba63dd8b914028a17bbbc09bb943984f4b8610e766d2f2e9fec30be23c76fae2b633e452d389d523e34fbaa9b0d18b44020a1b4d83a91d
+  data.tar.gz: be44f0721b36dcb13f97dba807dc34b81de66612179a82b878aa9f143f05bb9aefba5a0e7b174e74c3e7cd212e2e83e5486be86cd9aeb0fa0ac06460f4dcd736

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 120
+Documentation:
+  Enabled: false
+StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -1,10 +1,10 @@
 sudo: false
 
 rvm:
-  - 1.9.3
-  - 2.0
   - 2.1
   - 2.2
+  - 2.3
+  - 2.4
 
 script:
   - bundle exec rake test

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gemspec
+gemspec

data/README.md

@@ -27,8 +27,8 @@ Before using Goodreads API you must create a new application. Visit [signup form
 Setup client:
 
 ``` ruby
-client = Goodreads::Client.new(:api_key => 'KEY', :api_secret => 'SECRET')
-client = Goodreads.new(:api_key => 'KEY') # short version
+client = Goodreads::Client.new(api_key: "KEY", api_secret: "SECRET")
+client = Goodreads.new(api_key: "KEY") # short version
 ```
 
 ### Global configuration
@@ -38,15 +38,15 @@ You can define client credentials on global level. Just create an initializer fi
 
 ``` ruby
 Goodreads.configure(
-  :api_key => 'KEY',
-  :api_secret => 'SECRET'
+  api_key: "KEY",
+  api_secret: "SECRET"
 )
 ```
 
 Get global configuration:
 
 ``` ruby
-Goodreads.configuration # => {:api_key => 'YOUR_KEY'}
+Goodreads.configuration # => { api_key: "YOUR_KEY" }
 ```
 
 In case you need to reset options:
@@ -62,15 +62,15 @@ Goodreads.reset_configuration
 You can lookup a book by ISBN, ID or Title:
 
 ```ruby
-client.book('id')
-client.book_by_isbn('ISBN')
-client.book_by_title('Book title')
+client.book("id")
+client.book_by_isbn("ISBN")
+client.book_by_title("Book title")
 ```
 
 Search for books (by title, isbn, genre):
 
 ```ruby
-search = client.search_books('The Lord Of The Rings')
+search = client.search_books("The Lord Of The Rings")
 
 search.results.work.each do |book|
   book.id        # => book id
@@ -79,11 +79,11 @@ end
 ```
 
 ### Authors
- 
+
 Look up an author by their Goodreads Author ID:
 
 ```ruby
-author = client.author('id')
+author = client.author("id")
 
 author.id              # => author id
 author.name            # => author's name
@@ -103,7 +103,7 @@ author.died_at         # => date of author's death
 Look up an author by name:
 
 ```ruby
-author = client.author_by_name('Author Name')
+author = client.author_by_name("Author Name")
 
 author.id     # => author id
 author.name   # => author name
@@ -126,7 +126,7 @@ end
 Get review details:
 
 ```ruby
-review = client.review('id')
+review = client.review("id")
 
 review.id         # => review id
 review.user       # => user information
@@ -152,7 +152,7 @@ shelf.total  # total number of books on this shelf
 Get group details:
 
 ```ruby
-group = client.group('id')
+group = client.group("id")
 
 group.id                 # => group id
 group.title              # => group title
@@ -164,7 +164,7 @@ group.group_users_count  # => number of users in the group
 List the groups a given user is a member of:
 
 ```ruby
-group_list = client.group_list('user_id', 'sort')
+group_list = client.group_list("user_id", "sort")
 
 group_list.total         # => total number of groups
 group_list.group.count  # => number of groups returned in the request
@@ -181,12 +181,12 @@ group_list.group.each do |g|
 end
 ```
 
-The `sort` parameter is optional, and defaults to `my_activity`. 
+The `sort` parameter is optional, and defaults to `my_activity`.
 For other sorting options, [see here](http://www.goodreads.com/api#group.list).
 
 ### OAuth
 
-For API calls requiring permission, such as write operations or browsing friends, 
+For API calls requiring permission, such as write operations or browsing friends,
 see our [OAuth tutorial](examples/oauth.md).
 
 ## Testing
@@ -210,4 +210,4 @@ You're welcome to submit patches and new features.
 
 The MIT License (MIT)
 
-Copyright (c) 2011-2015 Dan Sosedoff, <dan.sosedoff@gmail.com>
+Copyright (c) 2011-2015 Dan Sosedoff, <dan.sosedoff@gmail.com>

data/Rakefile

@@ -1,10 +1,10 @@
-require 'bundler'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:test) do |t|
-  t.pattern = 'spec/*_spec.rb'
+  t.pattern = "spec/*_spec.rb"
   t.verbose = false
 end
 
-task :default => :test
+task default: :test

data/examples/oauth.md

@@ -10,7 +10,7 @@ First, get an OAuth *request* token:
 request_token = OAuth::Consumer.new(
   Goodreads.configuration[:api_key],
   Goodreads.configuration[:api_secret],
-  :site => 'http://www.goodreads.com'
+  site: "http://www.goodreads.com"
 ).get_request_token
 ```
 
@@ -29,7 +29,7 @@ access_token = request_token.get_access_token
 Finally, initialize a Goodreads client with it:
 
 ```ruby
-goodreads_client = Goodreads.new :oauth_token => access_token
+goodreads_client = Goodreads.new(oauth_token: access_token)
 ```
 
 For more info, see the [Goodreads documentation](http://www.goodreads.com/api/oauth_example).
@@ -54,4 +54,4 @@ Get a list of their names:
 
 ```ruby
 friends_hash.user.map{ |u| u.name }
-```
+```

data/goodreads.gemspec

@@ -1,4 +1,4 @@
-require File.expand_path('../lib/goodreads/version', __FILE__)
+require File.expand_path("../lib/goodreads/version", __FILE__)
 
 Gem::Specification.new do |spec|
   spec.name        = "goodreads"
@@ -9,21 +9,21 @@ Gem::Specification.new do |spec|
   spec.authors     = ["Dan Sosedoff"]
   spec.email       = ["dan.sosedoff@gmail.com"]
   spec.license     = "MIT"
-  
-  spec.add_development_dependency 'webmock',   '~> 1.11'
-  spec.add_development_dependency 'rake',      '~> 10'
-  spec.add_development_dependency 'rspec',     '~> 2.12'
-  spec.add_development_dependency 'simplecov', '~> 0.7'
-  spec.add_development_dependency 'yard',      '~> 0.6'
-  
-  spec.add_runtime_dependency 'rest-client',   '~> 1.6'
-  spec.add_runtime_dependency 'hashie',        '~> 2.0'
-  spec.add_runtime_dependency 'activesupport', '>= 3.0'
-  spec.add_runtime_dependency 'i18n',          '~> 0.5'
-  spec.add_runtime_dependency 'oauth',         '~> 0.4'
+
+  spec.add_development_dependency "webmock",   "~> 2.0"
+  spec.add_development_dependency "rake",      "~> 10"
+  spec.add_development_dependency "rspec",     "~> 2.12"
+  spec.add_development_dependency "simplecov", "~> 0.7"
+  spec.add_development_dependency "yard",      "~> 0.6"
+
+  spec.add_runtime_dependency "rest-client",   "~> 2.0"
+  spec.add_runtime_dependency "hashie",        "~> 2.0"
+  spec.add_runtime_dependency "activesupport", ">= 3.0"
+  spec.add_runtime_dependency "i18n",          "~> 0.5"
+  spec.add_runtime_dependency "oauth",         "~> 0.4"
 
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  spec.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 end

data/lib/goodreads.rb

@@ -1,41 +1,42 @@
-require 'goodreads/version'
-require 'goodreads/errors'
-require 'goodreads/request'
-require 'goodreads/client'
+require "goodreads/version"
+require "goodreads/errors"
+require "goodreads/request"
+require "goodreads/client"
 
 module Goodreads
-  @@options = {}
-  
+  class << self
+    attr_accessor :options
+  end
+  self.options = {}
+
   # Create a new Goodreads::Client instance
   #
-  def self.new(options={})
-    Goodreads::Client.new(options)
+  def self.new(params = {})
+    Goodreads::Client.new(params)
   end
-  
+
   # Define a global configuration
   #
   # options[:api_key]    - Account API key
   # options[:api_secret] - Account API secret
   #
-  def self.configure(options={})
-    unless options.kind_of?(Hash)
-      raise ArgumentError, "Options hash required."
-    end
-    
-    @@options[:api_key]    = options[:api_key]
-    @@options[:api_secret] = options[:api_secret]
-    @@options
+  def self.configure(params = {})
+    fail(ArgumentError, "Options hash required.") unless params.is_a?(Hash)
+
+    options[:api_key]    = params[:api_key]
+    options[:api_secret] = params[:api_secret]
+    options
   end
-  
+
   # Returns global configuration hash
   #
   def self.configuration
-    @@options
+    options
   end
-  
+
   # Resets the global configuration
   #
   def self.reset_configuration
-    @@options = {}
+    self.options = {}
   end
 end

data/lib/goodreads/client.rb

@@ -1,12 +1,12 @@
-require 'goodreads/client'
-require 'goodreads/client/books'
-require 'goodreads/client/reviews'
-require 'goodreads/client/authors'
-require 'goodreads/client/users'
-require 'goodreads/client/shelves'
-require 'goodreads/client/authorized'
-require 'goodreads/client/groups'
-require 'goodreads/client/friends'
+require "goodreads/client"
+require "goodreads/client/books"
+require "goodreads/client/reviews"
+require "goodreads/client/authors"
+require "goodreads/client/users"
+require "goodreads/client/shelves"
+require "goodreads/client/authorized"
+require "goodreads/client/groups"
+require "goodreads/client/friends"
 
 module Goodreads
   class Client
@@ -28,10 +28,8 @@ module Goodreads
     # options[:api_secret]  - Account API secret
     # options[:oauth_token] - OAuth access token (optional, required for some calls)
     #
-    def initialize(options={})
-      unless options.kind_of?(Hash)
-        raise ArgumentError, "Options hash required."
-      end
+    def initialize(options = {})
+      fail(ArgumentError, "Options hash required.") unless options.is_a?(Hash)
 
       @api_key    = options[:api_key] || Goodreads.configuration[:api_key]
       @api_secret = options[:api_secret] || Goodreads.configuration[:api_secret]

data/lib/goodreads/client/authorized.rb

@@ -1,9 +1,7 @@
 module Goodreads
   module Authorized
-
     def user_id
-      oauth_request('/api/auth_user')['user']['id']
+      oauth_request("/api/auth_user")["user"]["id"]
     end
-
   end
 end

data/lib/goodreads/client/authors.rb

@@ -2,19 +2,19 @@ module Goodreads
   module Authors
     # Get author details
     #
-    def author(id, params={})
+    def author(id, params = {})
       params[:id] = id
-      data = request('/author/show', params)
-      Hashie::Mash.new(data['author'])
+      data = request("/author/show", params)
+      Hashie::Mash.new(data["author"])
     end
 
     # Search for an author by name
     #
-    def author_by_name(name, params={})
+    def author_by_name(name, params = {})
       params[:id] = name
       name_encoded = URI.encode(name)
       data = request("/api/author_url/#{name_encoded}", params)
-      Hashie::Mash.new(data['author'])
+      Hashie::Mash.new(data["author"])
     end
   end
 end

data/lib/goodreads/client/books.rb

@@ -8,28 +8,28 @@ module Goodreads
     # options[:page] - Which page to returns (default: 1)
     # options[:field] - Search field. One of: title, author, or genre (default is all)
     #
-    def search_books(query, params={})
+    def search_books(query, params = {})
       params[:q] = query.to_s.strip
-      data = request('/search/index', params)
-      Hashie::Mash.new(data['search'])
+      data = request("/search/index", params)
+      Hashie::Mash.new(data["search"])
     end
-    
+
     # Get book details by Goodreads book ID
     #
     def book(id)
-      Hashie::Mash.new(request('/book/show', :id => id)['book'])
+      Hashie::Mash.new(request("/book/show", id: id)["book"])
     end
-    
+
     # Get book details by book ISBN
     #
     def book_by_isbn(isbn)
-      Hashie::Mash.new(request('/book/isbn', :isbn => isbn)['book'])
+      Hashie::Mash.new(request("/book/isbn", isbn: isbn)["book"])
     end
-    
+
     # Get book details by book title
     #
     def book_by_title(title)
-      Hashie::Mash.new(request('/book/title', :title => title)['book'])
+      Hashie::Mash.new(request("/book/title", title: title)["book"])
     end
   end
 end

data/lib/goodreads/client/friends.rb

@@ -6,7 +6,7 @@ module Goodreads
     #
     def friends(user_id)
       data = oauth_request("/friend/user/#{user_id}")
-      Hashie::Mash.new(data['friends'])
+      Hashie::Mash.new(data["friends"])
     end
   end
-end
+end

data/lib/goodreads/client/groups.rb

@@ -2,14 +2,14 @@ module Goodreads
   module Groups
     # Get group details
     def group(group_id)
-      data = request('/group/show', :id => group_id)
-      Hashie::Mash.new(data['group'])
+      data = request("/group/show", id: group_id)
+      Hashie::Mash.new(data["group"])
     end
 
     # Get list of groups a given user is a member of
-    def group_list(user_id, sort='my_activity')
-      data = request('/group/list', :id => user_id, :sort => sort)
-      Hashie::Mash.new(data['groups']['list'])
+    def group_list(user_id, sort = "my_activity")
+      data = request("/group/list", id: user_id, sort: sort)
+      Hashie::Mash.new(data["groups"]["list"])
     end
   end
 end

data/lib/goodreads/client/reviews.rb

@@ -4,28 +4,27 @@ module Goodreads
     #
     # params[:skip_cropped] - Select only non-cropped reviews
     #
-    def recent_reviews(params={})
+    def recent_reviews(params = {})
       skip_cropped = params.delete(:skip_cropped) || false
-      data = request('/review/recent_reviews', params)
-      if data['reviews'] && data['reviews'].key?('review')
-        reviews = data['reviews']['review'].map { |r| Hashie::Mash.new(r) }
-        reviews = reviews.select { |r| !r.body.include?(r.url) } if skip_cropped
-        reviews
-      end
+      data = request("/review/recent_reviews", params)
+      return unless data["reviews"] && data["reviews"].key?("review")
+      reviews = data["reviews"]["review"].map { |r| Hashie::Mash.new(r) }
+      reviews = reviews.select { |r| !r.body.include?(r.url) } if skip_cropped
+      reviews
     end
-    
+
     # Get review details
     #
     def review(id)
-      data = request('/review/show', :id => id)
-      Hashie::Mash.new(data['review'])
+      data = request("/review/show", id: id)
+      Hashie::Mash.new(data["review"])
     end
 
     # Get list of reviews
     #
-    def reviews(params={})
-      data = request('/review/list', params.merge(:v => '2'))
-      reviews = data['reviews']['review']
+    def reviews(params = {})
+      data = request("/review/list", params.merge(v: "2"))
+      reviews = data["reviews"]["review"]
       if reviews.present?
         reviews.map { |review| Hashie::Mash.new(review) }
       else