DPLibrary 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91e697afe886a3e40c3ce4e85b5c5c61344d11eb
+  data.tar.gz: dff0774a163ab798176f6dc698f4805f652dbfca
+SHA512:
+  metadata.gz: 1f9278ab8144088824001e1874d5ea6741b49cbb840ad737b05adb1068315f1545ef0651355fbe8372963a37fdf09c1d6c88811ea64dc69b14fba3685cec9e80
+  data.tar.gz: fb0731b9864dc2a5124aad3845a5ee3d42b5823a974ccb98d40a36dabe949f057c73e496a4e65feb59bb69124d81ad04a35fd301b2d7591efcb94181a8385f6b

data/.coveralls.yml

@@ -0,0 +1 @@
+service: travis-ci

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/DPLibrary.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'coveralls'
 end

data/README.md

@@ -1,4 +1,6 @@
+[![Build Status](https://travis-ci.org/[phereford]/[DPLibrary].png)](https://travis-ci.org/[phereford]/[DPLibrary])
 [![Code Climate](https://codeclimate.com/github/phereford/DPLibrary.png)](https://codeclimate.com/github/phereford/DPLibrary)
+[![Coverage Status](https://coveralls.io/repos/phereford/DPLibrary/badge.png)](https://coveralls.io/r/phereford/DPLibrary)
 # DPLibrary
 
 A simple ruby API wrapper around the [Digital Public Library of
@@ -43,11 +45,81 @@ the most sense.
 
 ## Usages
 
+After setting your api_key to DPLibrary.api_key, it's time to start
+querying the DPLA!!
+
+For reference, you should glance at the [DPLA API
+Reference](http://dp.la/info/developers).
+
+Let's get started!
+```
+@documents_collection = DPLibrary::DocumentCollection.new({q: 'chicken'})
+@documents_collection.count # => returns the total count of your query.
+@documents_collection.limit # => the limit of documents per query
+@documents_collection.offset # => pagination offset in results
+@documents_collection.documents # => Returns an array of document objects
+```
+
+```
+@document = DPLibrary::DocumentCollection.new({q: 'chicken'}).documents.first
+@document.collection # => returns a collection object
+@document.original_record # => returns an original record object
+
+## Attributes for documents
+:id, :url, :source, :title, :description, :subject, :language, :format,
+:type, :publisher, :creaetor, :provider, :collection, :score,
+:original_record
+```
+
+Now there are many types of parameters you can pass in the
+DocumentCollection initialize method. For a complete list, check out the
+[DPLA API Reference](http://dp.la/info/developers).
+ 
+For the lazy, here is a brief list of what those params can be. It's
+pretty straightforward what the params do.
+
+```
+q # => query string 
+sourceResource.id
+sourceResource.contributor
+sourceResource.date.begin
+sourceResource.date.end
+sourceResource.extent
+sourceResource.language.name
+sourceResource.language.iso639
+sourceResource.format
+sourceResource.stateLocatedIn.name
+sourceResource.stateLocatedIn.iso3166-2
+sourceResource.spatial.name
+sourceResource.spatial.country
+sourceResource.spatial.region
+sourceResource.spatial.county
+sourceResource.spatial.state
+sourceResource.spatial.city
+sourceResource.spatial.iso3166-2
+sourceResource.spatial.coordinates
+sourceResource.subject.@id
+sourceResource.subject.type
+sourceResource.subject.name
+sourceResource.temporal.begin
+sourceResource.temporal.end
+sourceResource.title
+sourceResource.type
+hasView.@id
+hasView.format
+isPartOf.@id
+isPartOf.name
+isShownAt
+object
+provider.@id
+provider.name
+```
+
 ## ToDo's
 * Write Tests
 * Create fixtures for tests
-* Write up usage documentation
 * Dry up lib files
+* Write up collection.find method for querying collections
 
 ## Contributing
 

data/lib/DPLibrary/collection.rb

@@ -1,17 +1,23 @@
 module DPLibrary
   class Collection
-    attr_accessor :id,
-                  :title,
-                  :name
+    attr_accessor :collection_items
 
-    def initialize(hash)
-      set_values(hash)
+    def initialize(collection_response)
+      set_values(collection_response)
     end
 
-    def set_values(collection_hash)
-      self.id = collection_hash['id']
-      self.title = collection_hash['title']
-      self.name = collection_hash['name']
+    def set_values(collection_response)
+      @collection_items = []
+      if (collection_response.is_a?(Array))
+        @collection_items = collection_response.map {|h| create_collection_item(h)}
+      else
+        @collection_items << CollectionItem.new(collection_response)
+      end
+      @collection_items
+    end
+
+    def create_collection_item(collection_item_hash)
+      CollectionItem.new(collection_item_hash)
     end
   end
 end

data/lib/DPLibrary/collection_item.rb

@@ -0,0 +1,17 @@
+module DPLibrary
+  class CollectionItem
+    attr_accessor :id,
+                  :title,
+                  :name
+
+    def initialize(collection_hash)
+      set_values(collection_hash)
+    end
+
+    def set_values(collection_hash)
+      self.id = collection_hash['id']
+      self.title = collection_hash['title']
+      self.name = collection_hash['name']
+    end
+  end
+end

data/lib/DPLibrary/document.rb

@@ -48,8 +48,8 @@ module DPLibrary
       OriginalRecord.new(original_record_hash)
     end
 
-    def create_collection(collection_hash)
-      Collection.new(collection_hash)
+    def create_collection(collection_response)
+      Collection.new(collection_response)
     end
   end
 end

data/lib/DPLibrary/version.rb

@@ -1,3 +1,3 @@
 module DPLibrary
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

data/lib/DPLibrary.rb

@@ -8,6 +8,7 @@ module DPLibrary
   autoload :Base, 'DPLibrary/base'
   autoload :DocumentCollection, 'DPLibrary/document_collection'
   autoload :Collection, 'DPLibrary/collection'
+  autoload :CollectionItem, 'DPLibrary/collection_item'
   autoload :Document, 'DPLibrary/document'
   autoload :Provider, 'DPLibrary/provider'
   autoload :OriginalRecord, 'DPLibrary/original_record'

data/spec/DPLibrary/collection_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/DPLibrary/document_collection_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/DPLibrary/document_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe DPLibrary::Document do
+  subject { DPLibrary::Document.new( YAML.load_file( './spec/fixtures/document.yml' ) ) }
+
+  context 'initialize' do
+    its(:id) { should eql '8ce4474d8b1eefffaa5ce4ce34369c43' }
+    its(:url) { should eql 'http://www.biodiversitylibrary.org/item/79580' }
+    its(:source) { should eql 'Library of Congress' }
+    its(:title) { should eql 'The chicken cholera preventive and exterminator, a treatise giving the cause, symptoms, prevention, and extermination of chicken cholera' }
+    its(:description) { should eql 'Test' }
+    its(:subject) { should eql [{'name'=>"Chicken cholera"}] }
+    its(:language) { should eql [{'iso639_3'=>'eng', 'name'=>'English'}] }
+    its(:format) { should eql 'Book' }
+    its(:type) { should eql 'text' }
+    its(:publisher) { should eql 'Wooster [Ohio]Republican steam press print,1875' }
+    its(:creator) { should eql 'Hill, A. J' }
+    its(:provider) { should be_kind_of DPLibrary::Provider }
+    its(:collection) { should be_kind_of DPLibrary::Collection }
+    its(:original_record) { should be_kind_of DPLibrary::OriginalRecord }
+    its(:score) { should eql 1.9722701 }
+  end
+end

data/spec/DPLibrary/original_record_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe DPLibrary::OriginalRecord do
+  subject { DPLibrary::OriginalRecord.new( YAML.load_file( './spec/fixtures/original_record.yml' ) ) }
+
+  context 'initialize' do
+    its(:id) { should eql 'oai:biodiversitylibrary.org:item/79580' }
+    its(:title) { should eql 'The chicken cholera preventive and exterminator, a treatise giving the cause, symptoms, prevention, and extermination of chicken cholera;' }
+    its(:url) { should eql 'http://www.biodiversitylibrary.org/item/79580' }
+    its(:description) { should eql 'Test' }
+    its(:source) { should eql 'Library of Congress' }
+    its(:date) { should eql '2012-06-22T02:33:26Z' }
+    its(:label) { should eql 'The chicken cholera preventive and exterminator, a treatise giving the cause, symptoms, prevention, and extermination of chicken cholera;' }
+    its(:language) { should eql 'English' }
+    its(:type) { should eql ['text', 'Book'] }
+    its(:creator) { should eql 'Hill, A. J.' }
+    its(:publisher) { should eql 'Wooster [Ohio]Republican steam press print,1875.' }
+  end
+end

data/spec/DPLibrary/provider_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'yaml'
+
+describe DPLibrary::Provider do
+  subject { DPLibrary::Provider.new( YAML.load_file( './spec/fixtures/provider.yml' ) ) }
+
+  context 'initialize' do
+    its(:name) { should eql 'Biodiversity Heritage Library' }
+    its(:id) { should eql 'http://dp.la/api/contributor/bhl' }
+  end
+end

data/spec/fixtures/document.yml

@@ -0,0 +1,37 @@
+'id': 8ce4474d8b1eefffaa5ce4ce34369c43
+'isShownAt': http://www.biodiversitylibrary.org/item/79580
+'dataProvider': Library of Congress
+'score': 1.9722701
+sourceResource:
+  collection:
+    'id': 24087df2c58f149a8167a9589cffd830
+    'title': Volumes
+  'name': Library of Congress
+  'title': The chicken cholera preventive and exterminator, a treatise giving the cause, symptoms, prevention, and extermination of chicken cholera
+  'description': Test
+  'subject': 
+    - 'name': 'Chicken cholera'
+  'language':
+    - 
+      'iso639_3': 'eng'
+      'name': 'English'
+  'format': Book
+  'type': text
+  'publisher': Wooster [Ohio]Republican steam press print,1875
+  'creator': Hill, A. J
+provider:
+  '@id': http://dp.la/api/contributor/bhl
+  'name': Biodiversity Heritage Library
+originalRecord:
+  'id': oai:biodiversitylibrary.org:item/79580
+  'title': The chicken cholera preventive and exterminator, a treatise giving the cause, symptoms, prevention, and extermination of chicken cholera;
+  'handle': http://www.biodiversitylibrary.org/item/79580
+  'description': Test
+  'contributor': Library of Congress
+  'subject': Chicken cholera
+  'datestamp': '2012-06-22T02:33:26Z'
+  'label': The chicken cholera preventive and exterminator, a treatise giving the cause, symptoms, prevention, and extermination of chicken cholera;
+  'language': English
+  'type': ["text", "Book"]
+  'creator': Hill, A. J.
+'publisher': Wooster [Ohio]Republican steam press print,1875.

data/spec/fixtures/original_record.yml

@@ -0,0 +1,12 @@
+'id': oai:biodiversitylibrary.org:item/79580
+'title': The chicken cholera preventive and exterminator, a treatise giving the cause, symptoms, prevention, and extermination of chicken cholera;
+'handle': http://www.biodiversitylibrary.org/item/79580
+'description': Test
+'contributor': Library of Congress
+'subject': Chicken cholera
+'datestamp': '2012-06-22T02:33:26Z'
+'label': The chicken cholera preventive and exterminator, a treatise giving the cause, symptoms, prevention, and extermination of chicken cholera;
+'language': English
+'type': ["text", "Book"]
+'creator': Hill, A. J.
+'publisher': Wooster [Ohio]Republican steam press print,1875.

data/spec/fixtures/provider.yml

@@ -0,0 +1,2 @@
+'@id':  http://dp.la/api/contributor/bhl
+'name': Biodiversity Heritage Library

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require 'DPLibrary'
 require 'rspec'
 require 'vcr'
+require 'coveralls'
+
+Coveralls.wear!
 
 VCR.configure do |config|
   config.configure_rspec_metadata!

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: DPLibrary
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - phereford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-05 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,23 +83,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,17 +111,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby API wrapper for the Digital Public Library of America API
@@ -146,7 +143,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
+- .travis.yml
 - DPLibrary.gemspec
 - Gemfile
 - LICENSE.txt
@@ -155,6 +154,7 @@ files:
 - lib/DPLibrary.rb
 - lib/DPLibrary/base.rb
 - lib/DPLibrary/collection.rb
+- lib/DPLibrary/collection_item.rb
 - lib/DPLibrary/configuration.rb
 - lib/DPLibrary/connection.rb
 - lib/DPLibrary/document.rb
@@ -163,41 +163,48 @@ files:
 - lib/DPLibrary/provider.rb
 - lib/DPLibrary/request.rb
 - lib/DPLibrary/version.rb
-- spec/DPLibrary/item_spec.rb
+- spec/DPLibrary/collection_spec.rb
+- spec/DPLibrary/document_collection_spec.rb
+- spec/DPLibrary/document_spec.rb
+- spec/DPLibrary/original_record_spec.rb
+- spec/DPLibrary/provider_spec.rb
 - spec/cassettes/DPLibrary_Item/_new/.yml
+- spec/fixtures/document.yml
+- spec/fixtures/original_record.yml
+- spec/fixtures/provider.yml
 - spec/spec_helper.rb
 homepage: http://github.com/phereford/DPLibrary
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1346765738714870131
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1346765738714870131
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A ruby gem that is an API wrapper for the DPLA
 test_files:
-- spec/DPLibrary/item_spec.rb
+- spec/DPLibrary/collection_spec.rb
+- spec/DPLibrary/document_collection_spec.rb
+- spec/DPLibrary/document_spec.rb
+- spec/DPLibrary/original_record_spec.rb
+- spec/DPLibrary/provider_spec.rb
 - spec/cassettes/DPLibrary_Item/_new/.yml
+- spec/fixtures/document.yml
+- spec/fixtures/original_record.yml
+- spec/fixtures/provider.yml
 - spec/spec_helper.rb

data/spec/DPLibrary/item_spec.rb

@@ -1,16 +0,0 @@
-require 'spec_helper'
-
-describe DPLibrary::DocumentCollection do
-  subject do
-    DPLibrary.stub(:api_key).and_return('bb9ec047f463cd046c8a26c4237a3349')
-    DPLibrary::DocumentCollection.new({q: 'chicken'})
-  end
-
-  context '.new', :vcr do
-    it { should_not be nil }
-  end
-
-  context '#set_method' do
-    its(:count) { should be_kind_of(Integer) }
-  end
-end