openlibrary 1.0.0 → 1.0.1

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 .rvmrc
 *~
+*.swp

data/README.rdoc

@@ -1,9 +1,9 @@
 == Openlibrary 
 
 
-OPENLIBRARY is a simple wrapper for the Open Library REST-API.
+The openlibrary gem is a simple wrapper for the Open Library REST API.
 
-For more information on the REST calls, you can view the Open Library Books API documentation here[http://openlibrary.org/dev/docs/api/books], or visit the {Open Library Developer Center}[http://openlibrary.org/developers/api].
+For more information on the REST calls, you can view the {Open Library API documentation}[http://openlibrary.org/dev/docs/restful_api]. For more info about Open Library development in general, visit the {Open Library Developer Center}[http://openlibrary.org/developers/api] and {Developer Notes}[http://openlibrary.org/dev].
 
 
 == Installation

data/lib/openlibrary.rb

@@ -1,16 +1,20 @@
 require 'openlibrary/version'
-require 'json'
-require 'rest-client'
-require 'uri'
+require 'openlibrary/data'
+require 'openlibrary/view'
+require 'openlibrary/client'
+require 'openlibrary/errors'
+require 'openlibrary/request'
 
 module Openlibrary
+  # Create a new Openlibrary::Client instance
+  # 
+  def self.new(options={})
+    Openlibrary::Client.new(options)
+  end
 
-  autoload :Data, 'openlibrary/data'
-  autoload :View, 'openlibrary/view'
-
-  def self.version_string
+  # Return the openlibrary gem version
+  #
+  def self.version
     "Openlibrary version #{Openlibrary::VERSION}"
   end
-
-
 end

data/lib/openlibrary/client.rb

@@ -0,0 +1,27 @@
+require 'openlibrary/request'
+require 'openlibrary/client/books'
+
+module Openlibrary
+  class Client
+    include Openlibrary::Request
+    include Openlibrary::Books
+
+    attr_reader :username, :password
+
+    # Initialize an Openlibrary::Client instance
+    #
+    # options[:username]  - Username
+    # options[:password]  - Password
+    #
+    def initialize(options={})
+      unless options.kind_of?(Hash)
+        raise ArgumentError, "Options hash required."
+      end
+
+      # For future versions that include the ability to log in
+      # 
+      #  @username = options[:username] || Openlibrary.configuration[:username]
+      #  @password = options[:password] || Openlibrary.configuration[:password]
+    end
+  end
+end

data/lib/openlibrary/client/books.rb

@@ -0,0 +1,10 @@
+module Openlibrary
+  module Books
+    # Find books in Open Library by ISBN, OLID, LCCN, or OCLC
+    #
+    def book(olid)
+      data = request("/books/#{olid}")
+      Hashie::Mash.new(data)
+    end
+  end
+end

data/lib/openlibrary/errors.rb

@@ -0,0 +1,5 @@
+module Openlibrary
+  class Error         < StandardError; end
+  class Unauthorized  < Error; end
+  class NotFound      < Error; end
+end

data/lib/openlibrary/request.rb

@@ -0,0 +1,43 @@
+require 'rest-client'
+require 'active_support/core_ext'
+require 'json'
+require 'uri'
+require 'hashie'
+
+module Openlibrary
+  module Request
+    API_URL    = 'http://www.openlibrary.org'
+
+    protected
+
+    # Perform an API request
+    #
+    # path   - Request path
+    #
+    def request(path)
+      # This code is for future versions that allow user login.
+      # 
+      # username = username || Openlibrary.configuration[:username]
+      # password = password || Openlibrary.configuration[:password]
+
+      url = "#{API_URL}#{path}"
+
+      resp = RestClient.get(url, { accept: :json }) 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)
+    end
+
+    def parse(resp)
+      object = JSON.parse(resp.body)
+      object
+    end
+  end
+end

data/lib/openlibrary/version.rb

@@ -1,3 +1,3 @@
 module Openlibrary
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/openlibrary.gemspec

@@ -18,8 +18,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  s.add_development_dependency "rspec"
-  s.add_runtime_dependency "json"
-  s.add_runtime_dependency "rest-client"
+  s.add_development_dependency 'rspec',   '~> 2.13'
+  s.add_development_dependency 'webmock', '~> 1.6'
+
+  s.add_runtime_dependency 'json',          '~> 1.7.7'
+  s.add_runtime_dependency 'rest-client',   '~> 1.6'
+  s.add_runtime_dependency 'hashie',        '~> 1.0'
+  s.add_runtime_dependency 'activesupport', '~> 3'
 end

data/spec/client_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe 'Client' do
+  let(:client)  { Openlibrary::Client.new() }
+
+  describe '#new' do
+    it 'requires an argument' do
+      expect { Openlibrary::Client.new(nil) }.
+        to raise_error ArgumentError, "Options hash required."
+    end
+
+    it 'requires a hash argument' do
+      expect { Openlibrary::Client.new('foo') }.
+        to raise_error ArgumentError, "Options hash required."
+    end
+  end
+
+  describe '#book' do
+    before do
+      olid = 'OL23109860M'
+      stub_get("/books/#{olid}", 'book.json')
+    end
+    it 'returns book details' do
+      expect { client.book('OL23109860M') }.not_to raise_error
+
+      book = client.book('OL23109860M')
+
+      book.should be_a Hashie::Mash
+      book.contributors.should be_a        Array
+      book.covers.should be_a              Array
+
+      book.title.should eq                 'The Great Gatsby'
+      book.by_statement.should eq          'F. Scott Fitzgerald.'
+      book.number_of_pages.should eq       180
+      book.contributors[0].name.should eq  'Francis Cugat'
+      book.contributors[0].role.should eq  'Cover Art'
+      book.copyright_date.should eq        '1925'
+    end
+  end
+end

data/spec/fixtures/book.json

@@ -0,0 +1,59 @@
+{ "authors" : [ { "key" : "/authors/OL27349A" } ],
+  "by_statement" : "F. Scott Fitzgerald.",
+  "classifications" : {  },
+  "contributors" : [ { "name" : "Francis Cugat",
+        "role" : "Cover Art"
+      } ],
+  "copyright_date" : "1925",
+  "covers" : [ 6776207,
+      6725316,
+      6390463
+    ],
+  "created" : { "type" : "/type/datetime",
+      "value" : "2009-02-18T18:42:07.162489"
+    },
+  "dewey_decimal_class" : [ "813" ],
+  "genres" : [ "Fiction." ],
+  "ia_box_id" : [ "IA119605" ],
+  "identifiers" : { "goodreads" : [ "4671" ],
+      "google" : [ "iXn5U2IzVH0C" ],
+      "librarything" : [ "2964" ]
+    },
+  "isbn_10" : [ "0743273567" ],
+  "isbn_13" : [ "9780743273565" ],
+  "key" : "/books/OL23109860M",
+  "languages" : [ { "key" : "/languages/eng" } ],
+  "last_modified" : { "type" : "/type/datetime",
+      "value" : "2011-08-12T01:22:25.394416"
+    },
+  "latest_revision" : 12,
+  "lc_classifications" : [ "PS3511.I9 G7 2004" ],
+  "lccn" : [ "25010468" ],
+  "notes" : { "type" : "/type/text",
+      "value" : "* [Publisher's Website for this edition][1]\r\n\r\n\r\n  [1]: http://books.simonandschuster.com/Great-Gatsby/F-Scott-Fitzgerald/9780743273565"
+    },
+  "number_of_pages" : 180,
+  "ocaid" : "greatgat00fitz",
+  "oclc_number" : [ "57215622" ],
+  "oclc_numbers" : [ "57215622" ],
+  "pagination" : "180 p. ;",
+  "physical_format" : "Trade Paperback",
+  "publish_country" : "nyu",
+  "publish_date" : "2004",
+  "publish_places" : [ "New York, New York, USA" ],
+  "publishers" : [ "Scribner" ],
+  "revision" : 12,
+  "source_records" : [ "marc:SanFranPL14/SanFranPL14.out:71962031:12930",
+      "ia:greatgat00fitz"
+    ],
+  "subjects" : [ "Traffic accidents -- Fiction",
+      "First loves -- Fiction",
+      "Rich people -- Fiction",
+      "Mistresses -- Fiction",
+      "Revenge -- Fiction",
+      "Long Island (N.Y.) -- Fiction"
+    ],
+  "title" : "The Great Gatsby",
+  "type" : { "key" : "/type/edition" },
+  "works" : [ { "key" : "/works/OL468431W" } ]
+}

data/spec/openlibrary_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
-describe Openlibrary do
+describe 'Openlibrary' do
   it 'should return correct version string' do
-    Openlibrary.version_string.should == "Openlibrary version #{Openlibrary::VERSION}"
+    Openlibrary.version.should == "Openlibrary version #{Openlibrary::VERSION}"
   end
 end
 
-describe Openlibrary::View do
+describe 'Openlibrary::View' do
 	before do
 		@book_view = Openlibrary::View.new
 	end
@@ -22,7 +22,7 @@ describe Openlibrary::View do
 	it { should respond_to(:thumbnail_url) }
 end
 
-describe Openlibrary::Data do
+describe 'Openlibrary::Data' do
 	before do
 		@book_data = Openlibrary::Data.new
 	end

data/spec/spec_helper.rb

@@ -1,8 +1,35 @@
-require 'rspec'
+$:.unshift File.expand_path("../..", __FILE__)
+
 require 'openlibrary'
+require 'rspec'
 require 'rest-client'
+require 'webmock'
+require 'webmock/rspec'
 
 RSpec.configure do |config|
   config.color_enabled = true
   config.formatter     = 'documentation'
 end
+
+def stub_get(path, fixture_name)
+  stub_request(:get, api_url(path)).
+    with(:headers => {'Accept'=>'application/json'}).
+    to_return(
+      :status => 200, 
+      :body => fixture(fixture_name), 
+      :headers => {}
+    )
+end
+
+def fixture_path(file=nil)
+  path = File.expand_path("../fixtures", __FILE__)
+  file.nil? ? path : File.join(path, file)
+end
+
+def fixture(file)
+  File.read(fixture_path(file))
+end
+
+def api_url(path)
+  "#{Openlibrary::Request::API_URL}#{path}"
+end

metadata

@@ -2,7 +2,7 @@
 name: openlibrary
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Jay Fajardo
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-02 00:00:00 Z
+date: 2013-03-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -18,33 +18,66 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: "2.13"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: webmock
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
-  type: :runtime
+        version: "1.6"
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rest-client
+  name: json
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.7.7
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.6"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3"
+  type: :runtime
+  version_requirements: *id006
 description: Openlibrary.org API Interface
 email: 
 - jmrfajardo@gmail.com
@@ -60,11 +93,17 @@ files:
 - README.rdoc
 - Rakefile
 - lib/openlibrary.rb
+- lib/openlibrary/client.rb
+- lib/openlibrary/client/books.rb
 - lib/openlibrary/data.rb
 - lib/openlibrary/details.rb
+- lib/openlibrary/errors.rb
+- lib/openlibrary/request.rb
 - lib/openlibrary/version.rb
 - lib/openlibrary/view.rb
 - openlibrary.gemspec
+- spec/client_spec.rb
+- spec/fixtures/book.json
 - spec/openlibrary_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.proudcloud.net
@@ -95,5 +134,7 @@ signing_key:
 specification_version: 3
 summary: Ruby Interface for the Openlibrary.org API
 test_files: 
+- spec/client_spec.rb
+- spec/fixtures/book.json
 - spec/openlibrary_spec.rb
 - spec/spec_helper.rb