contentdm_api 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf2ba5a1ff4e7315d73cbb6e99d105181cbcc277
-  data.tar.gz: 820ed7b399108439c2920caf845ae2a764b221d0
+  metadata.gz: 7a6a33fcbb1e545ed9c15fc211ef732c61c3d8b6
+  data.tar.gz: 8d7d3675d3703a126b0bae9316d55b0fc21bb383
 SHA512:
-  metadata.gz: a8cf5688445b8c8d134f5eda8992c3da0a71f3d5ac4b58fe58412afeb6959bb749a6663f1b07ab1f3d60abe2c6aa0ce8f680aec723533edb22314ffe4779ab01
-  data.tar.gz: 993bc29b0603d6e031e0259a8ed74c7c4ddfd62ceb08c1bb633929899db41cebd1e740988691990eb3349be33892bf9ed6efb60d45c5bc34036be6507d89e987
+  metadata.gz: 6433e76f1b4bdd7694941b52e70528bd0c6dc9ede4ddb17d58489032807398405f0da0dbb84dcd66510cc4d7f49b2b0e23d072dd1b5df6ecaccc92ca7e3c20f1
+  data.tar.gz: 69864f2865c29bc0646a070ded4acf1e6995146e141009f51e9d534ed0720cb4ad98e153cb70ade1dcb0125f1d6fa8db2a8f7c8057ddd80bd0ab20fb33cdb399

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+cache: bundler
 rvm:
   - 2.2.3
+  - 2.3.1
 before_install: gem install bundler -v 1.11.2

data/CHANGELOG.txt

@@ -0,0 +1,2 @@
+version 0.1.0 Initial release
+version 0.2.0 Switch from a CompoundItem to Item with a :with_compound flag convenience method

data/README.md

@@ -1,5 +1,7 @@
 # CONTENTdm API for Ruby
 
+[![Build Status](https://travis-ci.org/UMNLibraries/contentdm_api.svg?branch=master)](https://travis-ci.org/UMNLibraries/contentdm_api)
+
 Ruby bindings for the [CONTENTdm API](https://www.oclc.org/support/services/contentdm_api/help/customizing-website-help/other-customizations/contentdm_api-api-reference.en.html).
 
 ## Installation
@@ -29,10 +31,10 @@ Include the library in your code:
 **Retrieve Item Metadata Along With Its Compound Object Info (If it Exists)**
 
 ```
-CONTENTdmAPI::CompoundItem.new(base_url: 'https://server16022.contentdm.oclc.org/dmwebservices/index.php', collection: 'p16022coll39', id: 446).metadata
+CONTENTdmAPI::Item.new(base_url: 'https://server16022.contentdm.oclc.org/dmwebservices/index.php', collection: 'p16022coll39', id: 446).metadata
 ```
 
-CompoundItem has been added as a convenience. It is a wrapper around the `CONTENTdmAPI::RequestBatch` feature (see below).
+Item has been added as a convenience. It is a wrapper around the `CONTENTdmAPI::RequestBatch` feature (see below). Set `with_compound: false` to avoid attempting the dmGetCompoundObjectInfo lookup call.
 
 **Call a CONTENTdm API function directoy**
 
@@ -59,6 +61,8 @@ You may also use the Response class to parse and handle API inconsistencies (e.g
 responses.map { |resp| CONTENTdmAPI::Response.new(raw_data: resp[:value]).parsed }
 ```
 
+## [API Documentation](http://www.rubydoc.info/gems/contentdm_api)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :spec
+task :default => :test

data/contentdm_api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Chad Fennell"]
   spec.email         = ["fenne035@umn.edu"]
 
-  spec.summary       = %q{Ruby bindings for the ContentDM API}
+  spec.summary       = %q{Ruby bindings for the CONTENTdm API}
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/contentdm_api/{compound_item.rb → item.rb}

@@ -1,8 +1,8 @@
 module CONTENTdmAPI
   # A convenience method to retrive a Ruby hash of Item data from the CONTENTdm
   # API
-  class CompoundItem
-    attr_reader :collection, :id, :requester, :base_url, :response
+  class Item
+    attr_reader :collection, :id, :requester, :base_url, :response, :with_compound
 
     # @param [String] base_url URL to the CONTENTdm API
     #  "http://CdmServer.com:port/dmwebservices/index.php"
@@ -16,16 +16,18 @@ module CONTENTdmAPI
     def initialize(base_url: '',
                    collection: '',
                    id: 0,
+                   with_compound: true,
                    requester: RequestBatch,
                    response: Response)
-      @collection = collection
-      @id         = id
-      @requester  = requester
-      @base_url   = base_url
-      @response   = response
+      @collection    = collection
+      @id            = id
+      @with_compound = with_compound
+      @requester     = requester
+      @base_url      = base_url
+      @response      = response
     end
 
-    # A hash of metadata with compound data for a given item
+    # A hash of item metadata with optional compound data for the given item
     #
     # @return [Hash] Merged responses from the dmGetItemInfo and
     # dmGetCompoundObjectInfo functions
@@ -52,10 +54,15 @@ module CONTENTdmAPI
     end
 
     def service_configs
-      [
-        { function: 'dmGetItemInfo', params: [collection, id] },
-        { function: 'dmGetCompoundObjectInfo', params: [collection, id] }
-      ]
+      (with_compound) ? item_config.concat(compound_config) : item_config
+    end
+
+    def item_config
+      [{ function: 'dmGetItemInfo', params: [collection, id] }]
+    end
+
+    def compound_config
+      [{ function: 'dmGetCompoundObjectInfo', params: [collection, id] }]
     end
   end
 end

data/lib/contentdm_api/version.rb

@@ -1,3 +1,3 @@
 module CONTENTdmAPI
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/lib/contentdm_api.rb

@@ -6,5 +6,5 @@ require_relative './contentdm_api/request'
 require_relative './contentdm_api/request_batch'
 require_relative './contentdm_api/service'
 require_relative './contentdm_api/response'
-require_relative './contentdm_api/compound_item'
+require_relative './contentdm_api/item'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentdm_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Chad Fennell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.txt
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -124,7 +125,7 @@ files:
 - bin/setup
 - contentdm_api.gemspec
 - lib/contentdm_api.rb
-- lib/contentdm_api/compound_item.rb
+- lib/contentdm_api/item.rb
 - lib/contentdm_api/request.rb
 - lib/contentdm_api/request_batch.rb
 - lib/contentdm_api/response.rb
@@ -153,6 +154,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Ruby bindings for the ContentDM API
+summary: Ruby bindings for the CONTENTdm API
 test_files: []
 has_rdoc: