DPLibrary 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6166b6bbe53de1f1767df9a4e301023800991ebc
-  data.tar.gz: bfdd4479ec2f7b2417f8c600ca9800edda4f491d
+  metadata.gz: f0727bdb53be1deb64eee19342878b3ce944aa4a
+  data.tar.gz: 7c124cdc650f49a209110360ee42f74bda7e0005
 SHA512:
-  metadata.gz: 09f4b32bccb5d3d194342c55db07fbe3272e8e9e3d491ca82254e386deac016d56c0a2764fb4e77d3eae92784a9fced65254fcfb5654bd8d47006377038abcb2
-  data.tar.gz: bbe92b8c27c1c15a57747e8780a9132670fafcb880c4b1cb22e53ad0303c368976cdd32ee3d9bccce3090fdc8ba6f047ed4c2af832a460c3d6a37adc6beec51d
+  metadata.gz: 4f6b92a0a34d0f766c4d78b796e54a92764075c1839912b6a1b0aeb2151c78c0ec2035fd2ef0245b01e08858f2a6a363e534b4490b209025e78ac2d47ee9c5b5
+  data.tar.gz: ab5cc718d403757caef6ecf768853cca5deea3b04beb37b1bb02d954f75d292c1ae4d2daf6ec2c42738c9a474e16ba56087e333153abeff7311711b3447216e2

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.2.2

data/README.md

@@ -67,8 +67,14 @@ Let's get started!
 
 ## Attributes for documents
 :id, :url, :source, :title, :description, :subject, :language, :format,
-:type, :publisher, :creaetor, :provider, :collection, :score,
-:original_record
+:type, :publisher, :creaetor, :provider, :collection, :intermediate_provider,
+:score, :original_record
+```
+
+You can retrieve multiple records by ID by passing an array for the `:id`
+parameter, like this:
+```
+@documents_collection = DPLibrary::DocumentCollection.new({id: ['id1', 'id2']})
 ```
 
 Now there are many types of parameters you can pass in the
@@ -113,6 +119,7 @@ isShownAt
 object
 provider.@id
 provider.name
+intermediateProvider
 ```
 
 ## ToDo's

data/lib/DPLibrary/document.rb

@@ -13,6 +13,7 @@ module DPLibrary
                     :creator,
                     :provider,
                     :collection,
+                    :intermediate_provider,
                     :original_record,
                     :score
 
@@ -25,6 +26,7 @@ module DPLibrary
       self.id = hash['id']
       self.url = hash['isShownAt']
       self.source = hash['dataProvider']
+      self.intermediate_provider = hash['intermediateProvider']
       self.title = hash['sourceResource']['title']
       self.description = hash['sourceResource']['description']
       self.subject = hash['sourceResource']['subject']

data/lib/DPLibrary/document_collection.rb

@@ -14,8 +14,30 @@ module DPLibrary
     end
 
     private
+
     def find(parameters)
-      get('items', parameters)
+      p = path!(parameters)
+      get(p, parameters)
+    end
+
+    ##
+    # Return the appropriate URI path, which depends upon whether IDs are given
+    #
+    # Remove an `id' parameter from the parameters if it exists, because it
+    # will become part of the path, and should not be included in the
+    # querystring parameters.
+    #
+    # @param [Hash] parameters  Query parameters
+    # @return [String]
+    # @api private
+    #
+    def path!(parameters)
+      if parameters.include? :id
+        id = parameters.delete(:id)
+        "items/#{Array(id).join(',')}"
+      else
+        'items'
+      end
     end
 
     def set_method(values)

data/lib/DPLibrary/version.rb

@@ -1,3 +1,3 @@
 module DPLibrary
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/spec/DPLibrary/document_collection_spec.rb

@@ -1 +1,41 @@
 require 'spec_helper'
+
+describe DPLibrary::DocumentCollection do
+  let (:base_response_json) do
+    { 'count' => 0, 'start' => 1, 'limit' => 1, 'docs' => [] }
+  end
+  let (:response_body) { JSON.dump(base_response_json) }
+
+  describe '#initialize' do
+
+    context 'with a string :id parameter' do
+      it 'results in a request for items/<id>' do
+        expect_any_instance_of(described_class)
+          .to receive(:get)
+          .with('items/1abc', {})
+          .and_return(response_body)
+        dc = described_class.new(id: '1abc')
+      end
+    end
+
+    context 'with an array :id parameter' do
+      it 'results in a request for items/<id>,<id>' do
+        expect_any_instance_of(described_class)
+          .to receive(:get)
+          .with('items/1abc,2def', {})
+          .and_return(response_body)
+        dc = described_class.new(id: ['1abc', '2def'])
+      end
+    end
+
+    context 'with no :id parameter' do
+      it 'results in a request for "items" with querystring params' do
+        expect_any_instance_of(described_class)
+          .to receive(:get)
+          .with('items', {:'sourceResource.title' => 'ducks'})
+          .and_return(response_body)
+        dc = described_class.new(:'sourceResource.title' => 'ducks')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: DPLibrary
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - phereford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A ruby gem that is an API wrapper for the DPLA