olibrary 0.1.0

data/lib/olibrary/request.rb

@@ -0,0 +1,109 @@
+require 'rest-client'
+require 'active_support'
+require 'active_support/core_ext'
+require 'json'
+require 'uri'
+require 'hashie'
+
+module Olibrary
+  module Request
+    API_URL    = 'https://openlibrary.org'
+
+    protected
+
+    HANDLE_REST_CLIENT_RESPONSE = lambda do |response, request, result, &block|
+      case response.code
+      when 200
+        response.return!(&block)
+      when 401
+        raise Olibrary::Unauthorized
+      when 404
+        raise Olibrary::NotFound
+      when 302
+        raise Olibrary::Redirect
+      end
+    end
+
+    # Perform a GET request
+    #
+    # path   - Request path
+    #
+    def request(path, params={})
+      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={})
+      history_url = "#{API_URL}#{object}.json?m=history"
+      perform_get_request(history_url, params)
+    end
+
+    # Perform a query using the Query API
+    #
+    # query - Query path, e.g. "type=/type/edition&isbn_10=XXXXXXXXXX"
+    #
+    def query(query, params={})
+      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"
+      login = { 'username' => username, 'password' => password }.to_json
+
+      resp = RestClient.post(url, login, params) do |response|
+        case response.code
+        when 200
+          session = response.cookies
+          session
+        when 401
+          raise Olibrary::Unauthorized
+        when 404
+          raise Olibrary::NotFound
+        when 302
+          raise Olibrary::Redirect
+        end
+      end
+    end
+
+    # Update an Open Library object
+    #
+    # key     - Object key the Open Library resource
+    # cookie  - Cookie retrieved by the login method
+    # update  - Complete updated Open Library object in JSON format
+    # comment - Comment describing the change(s) to the object
+    #
+    def update(key, cookie, update, comment, params={})
+      cookie_header = { 'Cookie' => cookie }
+      comment_header = {
+        'Opt' => '"http://openlibrary.org/dev/docs/api"; ns=42',
+        '42-comment' => comment
+      }
+      params.merge!(cookie_header)
+      params.merge!(comment_header)
+      params.merge!(content_type: :json, accept: :json)
+      update_url = "#{API_URL}#{key}"
+
+      response = RestClient.put(update_url, update, params, &HANDLE_REST_CLIENT_RESPONSE)
+      parse(response)
+    end
+
+    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/olibrary/version.rb

@@ -0,0 +1,3 @@
+module Olibrary
+  VERSION = "0.1.0"
+end

data/lib/olibrary/view.rb

@@ -0,0 +1,51 @@
+module Olibrary
+
+  class View 
+    attr_accessor :bib_key
+    attr_accessor :info_url
+    attr_accessor :preview
+    attr_accessor :preview_url
+    attr_accessor :thumbnail_url
+
+    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=viewapi"
+      response_data = JSON.parse(response)
+      view = response_data["#{type}:#{key}"]
+
+      if view 
+        view_meta = new  
+
+        view_meta.bib_key = view["bib_key"] 
+        view_meta.info_url = view["info_url"]
+        view_meta.preview = view["preview"]
+        view_meta.preview_url = view["preview_url"]
+        view_meta.thumbnail_url = view["thumbnail_url"]
+        
+        view_meta
+      else
+        nil
+      end    
+    end
+  end
+
+end

data/lib/olibrary.rb

@@ -0,0 +1,21 @@
+require_relative 'olibrary/version'
+require_relative 'olibrary/data'
+require_relative 'olibrary/view'
+require_relative 'olibrary/client'
+require_relative 'olibrary/errors'
+require_relative 'olibrary/request'
+require_relative 'olibrary/details'
+
+module Olibrary
+  # Create a new Olibrary::Client instance
+  # 
+  def self.new(options={})
+    Olibrary::Client.new(options)
+  end
+
+  # Return the openlibrary gem version
+  #
+  def self.version
+    "Olibrary version #{Olibrary::VERSION}"
+  end
+end

data/openlibrary.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "olibrary/version"
+
+Gem::Specification.new do |s|
+  s.name = "olibrary"
+  s.version = Olibrary::VERSION
+  s.authors = ["Yosef Serkez"]
+  s.email = ["yosefserkez@gmail.com"]
+  s.homepage = "https://github.com/4till2/olibrary"
+  s.summary = %q{Ruby Interface for the openlibrary.org API}
+  s.description = %q{openlibrary.org API Interface}
+
+  s.rubyforge_project = "olibrary"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec', '~> 3.11.0'
+  s.add_development_dependency 'webmock', '~> 3.14.0'
+
+  s.add_runtime_dependency 'hashie', '~> 5.0.0'
+  s.add_runtime_dependency 'json', '>= 2.6.1'
+  s.add_runtime_dependency 'rest-client', '~> 2.1.0'
+
+  s.add_runtime_dependency 'activesupport', '~> 7.0.2.3'
+end

data/spec/client_spec.rb

@@ -0,0 +1,256 @@
+require 'spec_helper'
+
+describe 'Client' do
+  let(:client)  { Olibrary::Client.new }
+
+  describe '#new' do
+    it 'requires an argument' do
+      expect { Olibrary::Client.new(nil) }.
+        to raise_error ArgumentError, "Options hash required."
+    end
+
+    it 'requires a hash argument' do
+      expect { Olibrary::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')
+
+      expect(book).to be_a Hashie::Mash
+      expect(book.contributors).to be_a Array
+      expect(book.covers).to be_a       Array
+      expect(book.works).to be_a        Array
+
+      expect(book.title).to eq                    'The Great Gatsby'
+      expect(book.by_statement).to eq             'F. Scott Fitzgerald.'
+      expect(book.number_of_pages).to eq          180
+      expect(book.contributors[0].name).to eq     'Francis Cugat'
+      expect(book.contributors[0].role).to eq     'Cover Art'
+      expect(book.copyright_date).to eq           '1925'
+      expect(book.isbn_10[0]).to eq               '0743273567'
+      expect(book.identifiers.goodreads[0]).to eq '4671'
+      expect(book.identifiers.google[0]).to eq    'iXn5U2IzVH0C'
+      expect(book.physical_format).to eq          'Trade Paperback'
+      expect(book.publishers[0]).to eq            'Scribner'
+      expect(book.subjects[1]).to eq              'First loves -- Fiction'
+      expect(book.subjects[0]).to eq              'Traffic accidents -- Fiction'
+
+      # 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.
+      expect(book.key!).to eq                     '/books/OL23109860M'
+      expect(book.languages[0].key!).to eq           '/languages/eng'
+    end
+  end
+
+  describe '#book_by_isbn' do
+    before do
+      isbn_10 = '046503912X'
+      type = '/type/edition'
+      stub_get("/query.json?type=#{type}&isbn_10=#{isbn_10}",
+               'book_by_isbn.json')
+    end
+    it 'returns array of books' do
+      expect { client.book_by_isbn('046503912X').not_to raise_error }
+      expect { client.book_by_isbn('123').
+        to raise_error ArgumentError, "ISBN must be 10 or 13 characters." }
+
+      books = client.book_by_isbn('046503912X')
+
+      expect(books).to be_a Array
+      expect(books[0]).to be_a Hash
+
+      expect(books[0]['key']).to eq '/books/OL6807502M'
+    end
+  end
+
+  describe '#book_by_lccn' do
+    before do
+      lccn = '00271772'
+      type = '/type/edition'
+      stub_get("/query.json?type=#{type}&lccn=#{lccn}",
+               'book_by_lccn.json')
+    end
+    it 'returns array of books' do
+      expect { client.book_by_lccn('00271772').not_to raise_error }
+
+      books = client.book_by_lccn('00271772')
+
+      expect(books).to be_a Array
+      expect(books[0]).to be_a Hash
+    end
+  end
+
+  describe '#book_by_oclc' do
+    before do
+      oclc = '42860053'
+      type = '/type/edition'
+      stub_get("/query.json?type=#{type}&oclc_numbers=#{42860053}",
+               'book_by_oclc.json')
+    end
+    it 'returns array of books' do
+      expect { client.book_by_oclc('42860053').not_to raise_error }
+
+      books = client.book_by_oclc('42860053')
+
+      expect(books).to be_a Array
+      expect(books[0]).to be_a Hash
+    end
+  end
+
+  describe '#author' do
+    before do
+      key = 'OL1A'
+      stub_get("/authors/#{key}", 'author.json')
+    end
+
+    it 'returns author details' do
+      expect { client.author('OL1A') }.not_to raise_error
+
+      author = client.author('OL1A')
+
+      expect(author).to be_a Hashie::Mash
+      expect(author.name).to eq                'Sachi Rautroy'
+      expect(author.personal_name).to eq       'Sachi Rautroy'
+      expect(author.death_date).to eq          '2004'
+      expect(author.birth_date).to eq          '1916'
+      expect(author.last_modified.type).to eq  '/type/datetime'
+      expect(author.last_modified.value).to eq '2008-11-16T07:25:54.131674'
+      expect(author.id).to eq                  97
+      expect(author.revision).to eq            6
+
+      # 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.
+      expect(author.key!).to eq                '/authors/OL1A'
+    end
+  end
+
+  describe '#rev_history' do
+    before do
+      key = '/books/OL1M'
+      stub_get("#{key}.json?m=history", 'history.json')
+    end
+
+    it 'returns the revision history of an object' do
+      expect { client.rev_history('/books/OL1M') }.not_to raise_error
+
+      history = client.rev_history('/books/OL1M')
+
+      expect(history).to be_a Array
+      expect(history[0]).to be_a Hash
+    end
+  end
+
+  describe '#recent' do
+    before do
+      stub_get("/recentchanges", 'recent.json')
+    end
+
+    it 'returns recent changes to Open Library' do
+      expect { client.recent.not_to raise_error }
+
+      changes = client.recent
+
+      expect(changes).to be_a Array
+      expect(changes[0]).to be_a Hash
+    end
+  end
+
+  describe '#editions' do
+    before do
+      work = 'OL27258W'
+      stub_get("/works/#{work}/editions.json?limit=10&offset=0", 'editions.json')
+    end
+
+    it 'returns the editions of a work' do
+      expect { client.editions('OL27258W') }.not_to raise_error
+
+      editions = client.editions('OL27258W', 10, 0)
+
+      expect(editions).to be_a Hashie::Mash
+      expect(editions.entries).to be_a Array
+
+      expect(editions.size!).to eq      19
+      expect(editions.links.next).to eq '/works/OL27258W/editions.json?limit=10&offset=10'
+      expect(editions.links.self).to eq '/works/OL27258W/editions.json?limit=10&offset=0'
+      expect(editions.links.work).to eq '/works/OL27258W'
+
+      # Failing tests for iteration through entries
+      #
+      # editions.entries[0].should be_a Hashie::Mash
+      # editions.entries[0].number_of_pages.should eq 322
+    end
+  end
+
+  describe '#search' do
+    before do
+      stub_get("/search.json?author=tolkien&title=lord%20of%20the%20rings", 'search.json')
+      stub_get("/search.json?q=capitalism%20and%20freedom", 'free_search.json')
+    end
+
+    it 'returns book search results' do
+      search = {title: "lord of the rings", author: "tolkien"}
+      expect {client.search(search)}.not_to raise_error
+
+      search = client.search(search, 5, 10)
+
+      expect(search.size).to eq         5
+      expect(search[0].key!).to eq   'OL14926051W'
+      expect(search[0].title).to eq  'The Lord of Rings'
+
+      expect {client.search("capitalism and freedom")}.not_to raise_error
+      free_search = client.search("capitalism and freedom")
+
+      expect(free_search.size).to eq                10
+      expect(free_search[0].key!).to eq             'OL2747782W'
+      expect(free_search[0].author_name[0]).to eq   'Milton Friedman'
+    end
+  end
+
+  describe '#login' do
+    before do
+      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
+
+    it 'logs in to Open Library' do
+      expect { client.login('username', 'password') }.not_to raise_error
+
+      cookie = client.login('username', 'password')
+      expect(cookie).to eq "cookie"
+    end
+  end
+
+  describe '#after_save' do
+    before do
+      key = "/books/OL9674499M"
+      comment = 'update weight and number of pages'
+      stub_put(key, 'save_after_change.json', comment)
+    end
+
+    it 'PUTs the updated object, and receives the updated object as a response' do
+      key = "/books/OL9674499M"
+      cookie = 'cookie'
+      update = fixture('save_after_change.json')
+      comment = 'update weight and number of pages'
+
+      expect { client.save(key, cookie, update, comment) }.not_to raise_error
+
+      object = client.save(key, cookie, update, comment)
+
+      expect(object.weight).to eq '1.5 pounds'
+      expect(object.number_of_pages).to eq 1103
+    end
+  end
+end

data/spec/fixtures/author.json

@@ -0,0 +1,12 @@
+{ "birth_date" : "1916",
+  "death_date" : "2004",
+  "id" : 97,
+  "key" : "/authors/OL1A",
+  "last_modified" : { "type" : "/type/datetime",
+      "value" : "2008-11-16T07:25:54.131674"
+    },
+  "name" : "Sachi Rautroy",
+  "personal_name" : "Sachi Rautroy",
+  "revision" : 6,
+  "type" : { "key" : "/type/author" }
+}

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/fixtures/book_by_isbn.json

@@ -0,0 +1 @@
+[{"key": "/books/OL6807502M"}]

data/spec/fixtures/book_by_lccn.json

@@ -0,0 +1 @@
+[{"key": "/books/OL6807502M"}]

data/spec/fixtures/book_by_oclc.json

@@ -0,0 +1 @@
+[{"key": "/books/OL6807502M"}]