worldcatapi 1.0.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTdhZjEzN2E4YTNlZDNmYmU4YTU0NGNlNzgwZGRiOTkzMjczMzU1OQ==
+    MTk3OTEwOWQwZTAwMDI1ZGY4ODk2Zjg2OTU4ZDdlOTlhNmI1MzJmMQ==
   data.tar.gz: !binary |-
-    OTdjMWVmOGRkNzk1MmNkY2QxOGQyNmE5MGY4MzZjYmI4OGY5MmM3Ng==
+    NTFmNjAyYjk2YWU1YWUyZGU4N2ZhMzJjYmY1ZDU0YmI3ZWE0MzMxNg==
 SHA512:
   metadata.gz: !binary |-
-    OGMyOGJmNDJlZDZmOGI2NGE4Nzk4MTNhYWFiMDcwOTVlZDRiZjUwNDM3NDZk
-    NWU5NGYzOGNmMjQ5YmJlZmM5MTU1NTkwZmYyZjhmNWExNTkwZGZmNmYwMzUy
-    NDE3Y2IwNTAyMWY1OTAwYjcxMjI0Yjk3ODcxMGI5MTM2YWMyN2M=
+    N2MwNGZkMDNiMWU3MzU4OWI5NzQyY2RiZWUxOTIzNWY1NTBlZDZiZmYxZjli
+    Mjc0YzI5YWZjMjhiNWZhYjE5MTQ1NDIyYTBjMmUxMjlkYjQ4NDBiNjI0OThl
+    YTIzMDc2MTA1NzA2YWFjMDE2NjEwNThkYmMyZmUxYmQzMmE2MmI=
   data.tar.gz: !binary |-
-    ODk5OWQ3ZGEwNGQ5ZTRiODdmZmRlZWJiM2E2ZWU5YTBhZDY5ZjRiMDg4MjA1
-    OTRlY2U5YTMzNWRiZjE5Y2QwMWMzYTE4MTA3NWIyYmFhZTNlOTExZmRmMTNi
-    NzZjNWRkMzc3NTVmZTAxZGFmYzMyMmQzZDY0ZTQ0MGQ1MWI3MjQ=
+    YzBhYzg3NTIyMmFlZDdjYTA1NzkxYTYxMWE2MDU0OGE2YjhhNDVmZGYwYTJl
+    Mjk2ZmM1YTViMjI0NmEzNWQ5MzBlZTFjZTJkNGRmMzhjZDVhMDQwZWJkYTA4
+    ODE0NjFjOGNiNzdmYTcyMzI1MDI1NTQ2ZGNhMGQzYjZlMTBjZTE=

data/Gemfile.lock

@@ -2,6 +2,8 @@ PATH
   remote: .
   specs:
     worldcatapi (1.0.0)
+      marc (~> 0.8.1)
+      nokogiri (~> 1.5.7)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +18,7 @@ GEM
     celluloid (0.15.2)
       timers (~> 1.1.0)
     coderay (1.1.0)
+    ensure_valid_encoding (0.5.3)
     ffi (1.9.3)
     formatador (0.2.4)
     guard (2.2.4)
@@ -33,9 +36,13 @@ GEM
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
     lumberjack (1.0.4)
+    marc (0.8.1)
+      ensure_valid_encoding
+      unf
     method_source (0.8.2)
     minitest (4.7.5)
     multi_json (1.8.2)
+    nokogiri (1.5.11)
     pry (0.9.12.4)
       coderay (~> 1.0)
       method_source (~> 0.8)
@@ -57,6 +64,9 @@ GEM
       atomic
     timers (1.1.0)
     tzinfo (0.3.38)
+    unf (0.1.3)
+      unf_ext
+    unf_ext (0.0.6)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,4 +1,4 @@
-worldcat-api
+worldcatapi
 ============
 
 The RUBY API to access WorldCat.org webservices. Inspired by original wcapi implementation
@@ -6,7 +6,7 @@ The RUBY API to access WorldCat.org webservices. Inspired by original wcapi impl
 
 # Worldcatapi
 
-Forked from RubyForge WCAPI project. 
+Forked from RubyForge WCAPI project. It now lives on rubygems.org for easy installation and usage. 
 
 ## Installation
 
@@ -24,7 +24,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Clone this project and look at example.rb file.
+
+It outlines all of the available operations.
+    
+    require 'worldcatapi'
+    
+    client = WORLDCATAPI::Client.new key: YOUR_KEY
+    response = client.OpenSearch(q: 'Ruby Development', format: 'atom', start: 1, count: 20, cformat: "all")
+    
+    puts "Total Results #{response.header["totalResults"]
+    response.records.each do |record| 
+        puts "title: #{record[:title]}\n"
+        puts "url: #{record[:link]}\n"
+        puts "authors: #{record[:author].join(", "}\n"
+        puts "description: #{record[:summary]}\n"
+    end
+
+More examples available in example.rb
 
 ## Contributing
 

data/lib/worldcatapi/get_record_response.rb

@@ -1,3 +1,6 @@
+require 'ostruct'
+require 'marc'
+
 module WORLDCATAPI
   class GetRecordResponse 
 
@@ -20,43 +23,27 @@ module WORLDCATAPI
       _xml = xml
       _rechash = {}
       _x = 0
-
-      doc = Nokogiri::XML(xml)
-      doc.remove_namespaces!
-      nodes = doc.xpath("/record")
-      puts "NODE Count: " + nodes.length.to_s
-      nodes.each { |item |
-	 _title = item.xpath("datafield[@tag='245']/subfield[@code='a'][position()=1]").text
-	 
-         if item.xpath("datafield[@tag='1*']") != nil
-             item.xpath("datafield[@tag='1*']").each {|i|
-	        _author.push(i.xpath("subfield[@code='a']").text)
-             }	
-         end
-
-         if item.xpath("datafield[@tag='7*']") != nil
-	     item.xpath("datafield[@tag='7*']").each {|i|
-	        _author.push(i.xpath("subfield[@code='a']").text)
- 	     }
-   	 end	
-
-	 if item.xpath("controlfield[@tag='001']") != nil
-	    _id = item.xpath("controlfield[@tag='001']").text
-	    _link = 'http://www.worldcat.org/oclc/' + _id.to_s
-	 end	 
- 	
-	 if item.xpath("datafield[@tag='520']") != nil
-	    _summary = item.xpath("datafield[@tag='520']/subfield[@code='a'][position()=1]").text
-	 else
-	    if item.xpath("datafield[@tag='500']") != nil
-	       _summary = item.xpath("datafield[@tag='500']/subfield[@code='a'][position()=1]").text
-	    end
-	 end
+      
+      
+      reader = MARC::XMLReader.new(StringIO.new(xml))
+      
+      for r in reader        
+        @record = OpenStruct.new
+        @record.id = r["001"].value
+        @record.title = r['245']['a']
+        @record.author = Array.new.push r['100']['a']
+        @record.summary = r['500']['a']
+        @record.link = "http://www.worldcat.org/oclc/#{@record.id}"
+        @record.isbn = r['020']['a']
+        @record.publisher = r['260'].value
+        @record.edition = r['250']['a'] if r['250']
+        @record.physical_description = r['300'].value
+        
+      end
+      
+      @record.xml = xml
          
-         _rechash = {:title => _title, :author => _author, :link => _link, :id => _id, :citation => _citation, 
-		     :summary => _summary, :xml => item.to_s}
-      }
-      @record = _rechash
+      @record
    end
 
   end

data/lib/worldcatapi/record.rb

@@ -2,7 +2,7 @@ module WORLDCATAPI
 
   class Record
     
-    attr_accessor :title, :author, :link, :id, :citation, :summary, :xml
+    attr_accessor :title, :author, :link, :id, :citation, :summary, :xml, :isbn
 
     def initialize(pxml)
        #Setup a document

data/lib/worldcatapi/version.rb

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

data/test/lib/get_record_response_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class GetRecordResponseTest  < Test::Unit::TestCase
+  
+  setup do
+    @response_xml = "<record>\n    <leader>00000cam a2200000Ia 4500</leader>\n    <controlfield tag=\"001\">671660984</controlfield>\n    <controlfield tag=\"008\">101025s2008    nz      o     000 d eng d</controlfield>\n    <datafield ind1=\" \" ind2=\" \" tag=\"020\">\n      <subfield code=\"a\">9781775413158 (electronic bk.)</subfield>\n    </datafield>\n    <datafield ind1=\" \" ind2=\" \" tag=\"020\">\n      <subfield code=\"a\">1775413152 (electronic bk.)</subfield>\n    </datafield>\n    <datafield ind1=\"1\" ind2=\" \" tag=\"100\">\n      <subfield code=\"a\">Shakespeare, William,</subfield>\n      <subfield code=\"d\">1564-1616.</subfield>\n    </datafield>\n    <datafield ind1=\"1\" ind2=\"0\" tag=\"245\">\n      <subfield code=\"a\">Julius Caesar</subfield>\n      <subfield code=\"h\">[electronic resource] /</subfield>\n      <subfield code=\"c\">William Shakespeare.</subfield>\n    </datafield>\n    <datafield ind1=\" \" ind2=\" \" tag=\"260\">\n      <subfield code=\"a\">[Waiheke Island] :</subfield>\n      <subfield code=\"b\">Floating Press,</subfield>\n      <subfield code=\"c\">c2008.</subfield>\n    </datafield>\n    <datafield ind1=\" \" ind2=\" \" tag=\"300\">\n      <subfield code=\"a\">1 online resource (182 p.)</subfield>\n    </datafield>\n    <datafield ind1=\" \" ind2=\" \" tag=\"500\">\n      <subfield code=\"a\">Title from PDF title page (viewed Oct. 25, 2010).</subfield>\n    </datafield>\n    <datafield ind1=\"1\" ind2=\"0\" tag=\"600\">\n      <subfield code=\"a\">Caesar, Julius</subfield>\n      <subfield code=\"x\">Assassination</subfield>\n      <subfield code=\"v\">Drama.</subfield>\n    </datafield>\n    <datafield ind1=\"1\" ind2=\"0\" tag=\"600\">\n      <subfield code=\"a\">Brutus, Marcus Junius,</subfield>\n      <subfield code=\"d\">85 B.C.?-42 B.C.</subfield>\n      <subfield code=\"v\">Drama.</subfield>\n    </datafield>\n    <datafield ind1=\" \" ind2=\"0\" tag=\"651\">\n      <subfield code=\"a\">Rome</subfield>\n      <subfield code=\"x\">History</subfield>\n      <subfield code=\"y\">Civil War, 43-31 B.C.</subfield>\n      <subfield code=\"v\">Drama.</subfield>\n    </datafield>\n    <datafield ind1=\" \" ind2=\"0\" tag=\"650\">\n      <subfield code=\"a\">Conspiracies</subfield>\n      <subfield code=\"v\">Drama.</subfield>\n    </datafield>\n    <datafield ind1=\" \" ind2=\"0\" tag=\"650\">\n      <subfield code=\"a\">Assassins</subfield>\n      <subfield code=\"v\">Drama.</subfield>\n    </datafield>\n    <datafield ind1=\" \" ind2=\"4\" tag=\"655\">\n      <subfield code=\"a\">Electronic books.</subfield>\n    </datafield>\n    <datafield ind1=\"4\" ind2=\"0\" tag=\"856\">\n      <subfield code=\"3\">EBSCOhost</subfield>\n      <subfield code=\"u\">http://search.ebscohost.com/login.aspx?direct=true&amp;scope=site&amp;db=nlebk&amp;db=nlabk&amp;AN=313629</subfield>\n    </datafield>\n  </record>"
+  end
+  
+  
+  should "parse the response and put it into a proper record" do
+    response = WORLDCATAPI::GetRecordResponse.new(@response_xml)
+    assert_not_nil response.record, "Record was created"
+    
+    record = response.record
+    assert_equal "Julius Caesar", record.title, "Title must match"
+    assert_equal "671660984", record.id, "Id must match"
+    
+    assert_equal 1, record.author.size, "Only one author"
+    assert_equal "Shakespeare, William,", record.author.first, "Author must match"
+    assert_equal "9781775413158 (electronic bk.)", record.isbn, "ISBN must match"
+    assert_equal "[Waiheke Island] :Floating Press,c2008.", record.publisher, "Publisher must match"
+    assert_equal "1 online resource (182 p.)", record.physical_description, "PhysDesc must match"
+    assert_equal "Title from PDF title page (viewed Oct. 25, 2010).", record.summary, "Summary must match"
+        
+    assert_not_nil record.xml, "Should copy xml"
+  end
+end

data/test/lib/worldcatapi_test.rb

@@ -1,7 +1,7 @@
 require "test_helper"
 
 
-class TestWorldcatApi < Test::Unit::TestCase
+class WorldcatapiTest < Test::Unit::TestCase
   
   should "test worlcatapi settings" do
     assert true, "Something happens"

data/test/test_helper.rb

@@ -1,3 +1,3 @@
-require "WOLDCATAPI"
+require "worldcatapi"
 require "test/unit"
 require "shoulda"

data/worldcatapi.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   
   
   spec.add_runtime_dependency "nokogiri", "~>1.5.7"
+  spec.add_runtime_dependency "marc", "~>0.8.1"
   
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worldcatapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Taras Danylak
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -25,6 +25,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.7
+- !ruby/object:Gem::Dependency
+  name: marc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +91,7 @@ files:
 - lib/worldcatapi/record.rb
 - lib/worldcatapi/sru_search_response.rb
 - lib/worldcatapi/version.rb
+- test/lib/get_record_response_test.rb
 - test/lib/worldcatapi_test.rb
 - test/test_helper.rb
 - worldcatapi.gemspec
@@ -105,5 +120,6 @@ signing_key:
 specification_version: 4
 summary: Ruby API to access WorldCat Open Search webserbice. Based on WCAPI Gem.
 test_files:
+- test/lib/get_record_response_test.rb
 - test/lib/worldcatapi_test.rb
 - test/test_helper.rb