openlibrary 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f578f43980200e2e5124b4abcdc0b516dd0c2a2
-  data.tar.gz: ef2dc76ccf9cf3f8e530b3369784ff0a2a3f9d24
+  metadata.gz: f339172bc4d24e372b7413f8ce04f2fcc96a3dff
+  data.tar.gz: 821e0818118023cf063562060b82bba2417f7e24
 SHA512:
-  metadata.gz: 44db922fb27831d196913dd53151389f90e43d15a849e0a233712a5d95ed66cd96077cceeff7d492ecef6088c2bfcc8c1578bf343f4c23c24b4154a5e4d2f6b0
-  data.tar.gz: 4fd2b5adf5f82e08058e69f8132975ebb24c76fcddcd563179efab2a3e38f287a9d91037c06ae3ec49181740400fbf0e91cfd9d0067ee919817b49eb7b47c082
+  metadata.gz: 291516ab8c9c71e98e1d645e7ccc8eb5b4fba7231a73e683169570c2da373597b6e653728531ff3c6e4df80aa92ebd382c917b1a2998cc3d6a03d52f5099141d
+  data.tar.gz: 3761380fe93b763c17d105c9c439cae8f03208bb6ae9b90d6f7cc16c75853595f238b832609a18002221da86e9ef76eb0e3f75b6f4fe5d5d58d016df783d3425

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 .rvmrc
 *~
 *.swp
+.rbenv-version

data/README.rdoc

@@ -146,7 +146,7 @@ NOTICE: Before you can actually save changes to Open Library, you need to regist
 
 == Books Client
 
-There are two classes in the openlibrary gem you can use to access the {Books API}[http://openlibrary.org/dev/docs/api/books]. Use Openlibrary::View to look up Open Library listing information, and Openlibrary::Data to get a book's full metadata details.
+There are three classes in the openlibrary gem you can use to access the {Books API}[http://openlibrary.org/dev/docs/api/books]. Use Openlibrary::View to look up Open Library listing information, Openlibrary::Data to get a book's full metadata details, and Openlibrary::Details to get book details in addition to what the Openlibrary::View class provides.
 
 === Openlibrary::View
 
@@ -183,16 +183,35 @@ Instantiate the class:
 
 Look up a book by its ISBN-10 or ISBN-13:
 
-  book_details = data.find_by_isbn("0451526538")
+  book_data = data.find_by_isbn("0451526538")
 
-  book_details.title    # book's title
-  book_details.authors  # array of authors
+  book_data.title    # book's title
+  book_data.authors  # array of authors
 
 Other built-in finder methods:
 
-  view.find_by_lccn   # Library of Congress catalog number
-  view.find_by_oclc   # Worldcat Control Number
-  view.find_by_olid   # Open Library ID
+  data.find_by_lccn   # Library of Congress catalog number
+  data.find_by_oclc   # Worldcat Control Number
+  data.find_by_olid   # Open Library ID
+
+=== Openlibrary::Details
+
+Instantiate the class:
+  
+  details = Openlibrary::Details
+
+Look up a book by its ISBN-10 or ISBN-13:
+
+  book_details = details.find_by_isbn("0451526538")
+
+  book_details.info_url    # book's URL on Open Library
+  book_details.details     # additional details, such as description
+
+Other built-in finder methods:
+
+  details.find_by_lccn   # Library of Congress catalog number
+  details.find_by_oclc   # Worldcat Control Number
+  details.find_by_olid   # Open Library ID
 
 == CONTRIBUTORS
 
@@ -204,6 +223,8 @@ Other built-in finder methods:
 * Alex Grant https://github.com/grantovich
 * Bryan L. Fordham https://github.com/bfordham
 * Kyle Corbitt https://github.com/kcorbitt
+* Matt Dressel https://github.com/dresselm
+* Scott Lesser https://github.com/okcscott
 
 == LICENSE
 

data/lib/openlibrary.rb

@@ -4,6 +4,7 @@ require_relative 'openlibrary/view'
 require_relative 'openlibrary/client'
 require_relative 'openlibrary/errors'
 require_relative 'openlibrary/request'
+require_relative 'openlibrary/details'
 
 module Openlibrary
   # Create a new Openlibrary::Client instance

data/lib/openlibrary/details.rb

@@ -0,0 +1,53 @@
+module Openlibrary
+
+  class Details 
+    attr_accessor :info_url
+    attr_accessor :bib_key
+    attr_accessor :preview_url
+    attr_accessor :thumbnail_url
+    attr_accessor :details
+
+    def self.find_by_isbn(key)
+      find("ISBN",key)
+    end
+
+    def self.find_by_lccn(key)
+      find("LCCN",key)
+    end
+
+    def self.find_by_oclc(key)
+      find("OCLC",key)
+    end
+
+    def self.find_by_olid(key)
+      find("OLID",key)
+    end
+
+    def self.find(type,key)
+      type_for_uri = URI.encode_www_form_component(type)
+      key_for_uri = URI.encode_www_form_component(key)
+
+      response = RestClient.get "http://openlibrary.org/api/books" +
+        "?bibkeys=#{type_for_uri}:#{key_for_uri}&format=json&jscmd=data"
+      response_data = JSON.parse(response)
+      book = response_data["#{type}:#{key}"]
+
+      if book 
+        book_meta = new  
+
+        book_meta.info_url = book["info_url"]
+        book_meta.bib_key = book["bib_key"]
+        book_meta.preview_url = book["preview_url"]
+        book_meta.thumbnail_url = book["thumbnail_url"]
+        book_meta.details = book["details"]
+        
+        book_meta
+      else
+        nil
+      end    
+    end
+  end
+
+
+end
+

data/lib/openlibrary/errors.rb

@@ -2,4 +2,5 @@ module Openlibrary
   class Error         < StandardError; end
   class Unauthorized  < Error; end
   class NotFound      < Error; end
+  class Redirect      < Error; end
 end

data/lib/openlibrary/request.rb

@@ -6,51 +6,40 @@ require 'hashie'
 
 module Openlibrary
   module Request
-    API_URL    = 'http://openlibrary.org'
+    API_URL    = 'https://openlibrary.org'
 
     protected
 
+    HANDLE_REST_CLIENT_RESPONSE = lambda do |response, request, result, &block|
+      case response.code
+      when 200
+        response.return!(request, result, &block)
+      when 401
+        raise Openlibrary::Unauthorized
+      when 404
+        raise Openlibrary::NotFound
+      when 302
+        raise Openlibrary::Redirect
+      end
+    end
+
     # Perform a GET request
     #
     # path   - Request path
     #
     def request(path, params={})
-      params.merge!(accept: :json)
-      url = "#{API_URL}#{path}"
-
-      resp = RestClient.get(url, params) do |response, request, result, &block|
-        case response.code
-        when 200
-          response.return!(request, result, &block)
-        when 401
-          raise Openlibrary::Unauthorized
-        when 404
-          raise Openlibrary::NotFound
-        end
-      end
-      parse(resp)
+      request_url = "#{API_URL}#{path}"
+      perform_get_request(request_url, params)
     end
 
 
     # Get the history of an object in Open Library
-    # 
+    #
     # object   - Object key, e.g., '/books/OL1M'
     #
     def history(object, params={})
-      params.merge!(accept: :json)
-      url = "#{API_URL}#{object}.json?m=history"
-
-      resp = RestClient.get(url, params) do |response, request, result, &block|
-        case response.code
-        when 200
-          response.return!(request, result, &block)
-        when 401
-          raise Openlibrary::Unauthorized
-        when 404
-          raise Openlibrary::NotFound
-        end
-      end
-      parse(resp)
+      history_url = "#{API_URL}#{object}.json?m=history"
+      perform_get_request(history_url, params)
     end
 
     # Perform a query using the Query API
@@ -58,24 +47,13 @@ module Openlibrary
     # query - Query path, e.g. "type=/type/edition&isbn_10=XXXXXXXXXX"
     #
     def query(query, params={})
-      params.merge!(accept: :json)
-      url = "#{API_URL}/query.json?#{query}"
-      resp = RestClient.get(url, params) do |response, request, result, &block|
-        case response.code
-        when 200
-          response.return!(request, result, &block)
-        when 401
-          raise Openlibrary::Unauthorized
-        when 404
-          raise Openlibrary::NotFound
-        end
-      end
-      parse(resp)
+      query_url = "#{API_URL}/query.json?#{query}"
+      perform_get_request(query_url, params)
     end
 
     def protected_login(username, password, params={})
       params.merge!(content_type: :json, accept: :json)
-      url = "#{API_URL}/account/login"
+      url   = "#{API_URL}/account/login"
       login = { 'username' => username, 'password' => password }.to_json
 
       resp = RestClient.post(url, login, params) do |response|
@@ -87,11 +65,13 @@ module Openlibrary
           raise Openlibrary::Unauthorized
         when 404
           raise Openlibrary::NotFound
+        when 302
+          raise Openlibrary::Redirect
         end
       end
     end
 
-    # Update an Open Library object 
+    # Update an Open Library object
     #
     # key     - Object key the Open Library resource
     # cookie  - Cookie retrieved by the login method
@@ -100,31 +80,29 @@ module Openlibrary
     #
     def update(key, cookie, update, comment, params={})
       cookie_header = { 'Cookie' => cookie }
-      comment_header = { 
+      comment_header = {
         'Opt' => '"http://openlibrary.org/dev/docs/api"; ns=42',
-        '42-comment' => comment 
+        '42-comment' => comment
       }
       params.merge!(cookie_header)
       params.merge!(comment_header)
       params.merge!(content_type: :json, accept: :json)
-      url = "#{API_URL}#{key}"
+      update_url = "#{API_URL}#{key}"
 
-      resp = RestClient.put(url, update, params) do |response, request, result, &block|
-        case response.code
-        when 200
-          response.return!(request, result, &block)
-        when 401
-          raise Openlibrary::Unauthorized
-        when 404
-          raise Openlibrary::NotFound
-        end
-      end
-      parse(resp)
+      response = RestClient.put(update_url, update, params, &HANDLE_REST_CLIENT_RESPONSE)
+      parse(response)
     end
 
-    def parse(resp)
-      object = JSON.parse(resp.body)
-      object
+    def parse(response)
+      JSON.parse(response.body)
+    end
+    private :parse
+
+    def perform_get_request(url, params)
+      params.merge!(accept: :json)
+      response = RestClient.get(url, params, &HANDLE_REST_CLIENT_RESPONSE)
+      parse(response)
     end
+    private :perform_get_request
   end
 end

data/lib/openlibrary/version.rb

@@ -1,3 +1,3 @@
 module Openlibrary
-  VERSION = "2.1.2"
+  VERSION = "2.1.3"
 end

data/spec/client_spec.rb

@@ -44,8 +44,8 @@ describe 'Client' do
       book.subjects[1].should eq              'First loves -- Fiction'
       book.subjects[0].should eq              'Traffic accidents -- Fiction'
 
-      # Because of a conflict with the internal `key?` method of 
-      # Hashie::Mash, any key actually named 'key' must be referenced 
+      # Because of a conflict with the internal `key?` method of
+      # Hashie::Mash, any key actually named 'key' must be referenced
       # with a bang (!) to get the value.
       book.key!.should eq                     '/books/OL23109860M'
       book.languages[0].key!.should eq           '/languages/eng'
@@ -56,7 +56,7 @@ describe 'Client' do
     before do
       isbn_10 = '046503912X'
       type = '/type/edition'
-      stub_get("/query.json?type=#{type}&isbn_10=#{isbn_10}", 
+      stub_get("/query.json?type=#{type}&isbn_10=#{isbn_10}",
                'book_by_isbn.json')
     end
     it 'returns array of books' do
@@ -66,7 +66,7 @@ describe 'Client' do
 
       books = client.book_by_isbn('046503912X')
 
-      books.should be_a Array 
+      books.should be_a Array
       books[0].should be_a Hash
 
       books[0]['key'].should eq '/books/OL6807502M'
@@ -115,7 +115,7 @@ describe 'Client' do
 
     it 'returns author details' do
       expect { client.author('OL1A') }.not_to raise_error
-      
+
       author = client.author('OL1A')
 
       author.should be_a Hashie::Mash
@@ -128,8 +128,8 @@ describe 'Client' do
       author.id.should eq                  97
       author.revision.should eq            6
 
-      # Because of a conflict with the internal `key?` method of 
-      # Hashie::Mash, any key actually named 'key' must be referenced 
+      # Because of a conflict with the internal `key?` method of
+      # Hashie::Mash, any key actually named 'key' must be referenced
       # with a bang (!) to get the value.
       author.key!.should eq                '/authors/OL1A'
     end
@@ -219,7 +219,7 @@ describe 'Client' do
 
   describe '#login' do
     before do
-      stub_http_request(:post, "openlibrary.org/account/login").
+      stub_http_request(:post, "https://openlibrary.org/account/login").
         with( body: "{\"username\":\"username\",\"password\":\"password\"}" ).
         to_return( status: 200, headers: {'Set-Cookie' => 'session=cookie'} )
     end

data/spec/openlibrary_spec.rb

@@ -51,3 +51,19 @@ describe 'Openlibrary::Data' do
 	it { should respond_to(:pages) }
 	it { should respond_to(:weight) }
 end
+
+describe 'Openlibrary::Details' do
+	before do
+		@book_details = Openlibrary::Details.new
+	end
+
+	subject { @book_details }
+	
+	it { should_not respond_to(:some_random_thing) }
+
+	it { should respond_to(:info_url) }
+	it { should respond_to(:bib_key) }
+	it { should respond_to(:preview_url) }
+	it { should respond_to(:thumbnail_url) }
+	it { should respond_to(:details) }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openlibrary
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Jay Fajardo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2014-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: openlibrary
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby Interface for the Openlibrary.org API