contentdm_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf2ba5a1ff4e7315d73cbb6e99d105181cbcc277
+  data.tar.gz: 820ed7b399108439c2920caf845ae2a764b221d0
+SHA512:
+  metadata.gz: a8cf5688445b8c8d134f5eda8992c3da0a71f3d5ac4b58fe58412afeb6959bb749a6663f1b07ab1f3d60abe2c6aa0ce8f680aec723533edb22314ffe4779ab01
+  data.tar.gz: 993bc29b0603d6e031e0259a8ed74c7c4ddfd62ceb08c1bb633929899db41cebd1e740988691990eb3349be33892bf9ed6efb60d45c5bc34036be6507d89e987

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at fenne035@umn.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in contentdm_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 University of Minnesota Libraries
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# CONTENTdm API for Ruby
+
+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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'contentdm_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contentdm_api
+
+Include the library in your code:
+
+`require 'contentdm_api'`
+
+
+## Quick Start
+
+
+**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
+```
+
+CompoundItem has been added as a convenience. It is a wrapper around the `CONTENTdmAPI::RequestBatch` feature (see below).
+
+**Call a CONTENTdm API function directoy**
+
+The following shows the default keyword arguments for the Service class. Please refer to the [CONTENTdm API](https://www.oclc.org/support/services/contentdm_api/help/customizing-website-help/other-customizations/contentdm_api-api-reference.en.html) for details on each API function and corresponding parameters. Parameters must be passed as an array in the order specified in the CONTENTdm API instructions.
+
+```
+service = CONTENTdmAPI::Service.new(function: 'wsAPIDescribe', params: [], format: 'json')
+
+response = CONTENTdmAPI::Request.new(base_url: 'https://server16022.contentdm.oclc.org/dmwebservices/index.php', service: service).fetch
+```
+
+**Request multiple CONTENTdm functions/endpoints at once**
+
+```
+service_configs = [{function: 'dmGetItemInfo', params: ['p16022coll39', 446]},
+                   {function: 'dmGetCompoundObjectInfo', params: ['p16022coll39', 446]}]
+
+responses = CONTENTdmAPI::RequestBatch.new(base_url: 'https://server16022.contentdm.oclc.org/dmwebservices/index.php', service_configs: service_configs).fetch
+```
+
+You may also use the Response class to parse and handle API inconsistencies (e.g. calls for non-existent collections result in non-JSON HTML responses):
+
+```
+responses.map { |resp| CONTENTdmAPI::Response.new(raw_data: resp[:value]).parsed }
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/UMNLibraries/contentdm_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "contentdm_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/contentdm_api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contentdm_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contentdm_api"
+  spec.version       = CONTENTdmAPI::VERSION
+  spec.authors       = ["Chad Fennell"]
+  spec.email         = ["fenne035@umn.edu"]
+
+  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)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.0'
+  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  spec.add_development_dependency "yard", "~> 0.9.0"
+end

data/lib/contentdm_api/compound_item.rb

@@ -0,0 +1,61 @@
+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
+
+    # @param [String] base_url URL to the CONTENTdm API
+    #  "http://CdmServer.com:port/dmwebservices/index.php"
+    # @param [String] collection The CONTENTdm API calls this an "alias"
+    # @param [Integer] id The CONTENTdm API calls this a "pointer". It is the
+    #   identifier for a a given CONTENTdm item.
+    # @param [Object] requester A class to make requests of the API.
+    # @param [Object] response A class to parse API responses.
+    #
+    # @return [Void]
+    def initialize(base_url: '',
+                   collection: '',
+                   id: 0,
+                   requester: RequestBatch,
+                   response: Response)
+      @collection = collection
+      @id         = id
+      @requester  = requester
+      @base_url   = base_url
+      @response   = response
+    end
+
+    # A hash of metadata with compound data for a given item
+    #
+    # @return [Hash] Merged responses from the dmGetItemInfo and
+    # dmGetCompoundObjectInfo functions
+    def metadata
+      values.first.merge(values.last).merge('id' => "#{collection}/#{id}")
+    end
+
+    private
+
+    def remove_errors(value)
+      (value['code'] != '-2') ? value : {}
+    end
+
+    def values
+      responses.map { |resp| remove_errors(parse(resp[:value])) }
+    end
+
+    def parse(value)
+      response.new(raw_data: value).parsed
+    end
+
+    def responses
+      requester.new(base_url: base_url, service_configs: service_configs).fetch
+    end
+
+    def service_configs
+      [
+        { function: 'dmGetItemInfo', params: [collection, id] },
+        { function: 'dmGetCompoundObjectInfo', params: [collection, id] }
+      ]
+    end
+  end
+end

data/lib/contentdm_api/request.rb

@@ -0,0 +1,39 @@
+require 'net/http'
+module CONTENTdmAPI
+  # Form requests to the ContentDM API
+  class Request
+    attr_reader :base_url, :client, :service
+    # @param [String] base_url URL to the CONTENTdm API
+    #  "http://CdmServer.com:port/dmwebservices/index.php"
+    # @param [Object] client An HTTP client to make requests of the API
+    # @param [Object] service A class to tell the Request class which function,
+    #  params and format to request of the CONTENTdm API
+    #
+    # @return [Void]
+    def initialize(base_url: '', client: Net::HTTP, service: Service.new)
+      @base_url = base_url
+      @client   = client
+      @service  = service
+    end
+
+    # Fetch data from the CONTENTdm API
+    #
+    # @return [String] either XML or JSON
+    def fetch
+      request
+    end
+
+    # A URL for a given service
+    #
+    # @return [String] a url string
+    def url
+      "#{base_url}?q=#{service.url_params}"
+    end
+
+    private
+
+    def request
+      @response ||= client.get_response(URI(url)).body
+    end
+  end
+end

data/lib/contentdm_api/request_batch.rb

@@ -0,0 +1,53 @@
+module CONTENTdmAPI
+  # Make a batch of requests to the CONTENTdm API and combine them
+  class RequestBatch
+    attr_reader :service, :configs, :base_url, :requester
+    # @param [String] base_url URL to the CONTENTdm API
+    #  "http://CdmServer.com:port/dmwebservices/index.php"
+    # @param [Array] service_configs An array of hash configurations for
+    #   individual services
+    #  "http://CdmServer.com:port/dmwebservices/index.php"
+    # @param [Object] service A Service class to tell the Request class
+    #   which function, params and format to request of the CONTENTdm API
+    # @param [Object] requester A class to form requests to the ContentDM API
+    #
+    # @return [Void]
+    def initialize(base_url: '',
+                   service_configs: [],
+                   service: Service,
+                   requester: Request)
+
+      @service   = service
+      @configs   = service_configs
+      @base_url  = base_url
+      @requester = requester
+    end
+
+    # Fetch data from the CONTENTdm API
+    #
+    # @return [Array] an array of hashes containing Request response data
+    def fetch
+      responses
+    end
+
+    private
+
+    def service_objects
+      configs.map { |s| new_service(s[:function], s.fetch(:params, [])) }
+    end
+
+    def new_service(function, params)
+      service.new(function: function, params: params)
+    end
+
+    def responses
+      service_objects.map do |service|
+        { service: service.function, value: request(service, base_url) }
+      end
+    end
+
+    def request(service, base_url)
+      requester.new(service: service, base_url: base_url).fetch
+    end
+  end
+end

data/lib/contentdm_api/response.rb

@@ -0,0 +1,23 @@
+module CONTENTdmAPI
+  # A class to parse API responses.
+  class Response
+    attr_accessor :raw_data
+    # @param [String] raw_data A string of data received from the CONTENTdm API
+    #
+    # @return [Void]
+    def initialize(raw_data: '')
+      @raw_data = raw_data
+    end
+
+    # A parsed JSON string response that handles cases where the API does not
+    # return valid JSON (Response only supports JSON responses for now).
+    #
+    # @return [Hash] A ruby hash of a CONTENTdm response
+    def parsed
+      JSON.parse(raw_data)
+    rescue => e
+      # The contentdm_api api spits out HTML when it can't find a collection
+      { 'code' => '-2', 'message' => e.to_s }
+    end
+  end
+end

data/lib/contentdm_api/service.rb

@@ -0,0 +1,34 @@
+module CONTENTdmAPI
+  # A class to tell the Request class which function, params and format to
+  # request of the CONTENTdm API
+  class Service
+    attr_reader :format, :function, :params
+
+    # @param [String] function function A CONTENTdm function
+    # @param [Array] params A set of params for a given function. Parameters
+    #   must be passed as an array in the order specified in the CONTENTdm API
+    #   documentation.
+    #  "http://CdmServer.com:port/dmwebservices/index.php"
+    # @param [String] format Either XML or JSON. Defaults to JSON.
+    #
+    # @return [Void]
+    def initialize(function: 'wsAPIDescribe', params: [], format: 'json')
+      @format   = format
+      @function = function
+      @params   = params
+    end
+
+    # URL params for a given service
+    #
+    # @return [String] A CONTENTdm formatted url parameter string
+    def url_params
+      "#{function}/#{all_params.join('/')}"
+    end
+
+    private
+
+    def all_params
+      params.concat([format])
+    end
+  end
+end

data/lib/contentdm_api/version.rb

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

data/lib/contentdm_api.rb

@@ -0,0 +1,10 @@
+require "contentdm_api/version"
+require 'net/http'
+require 'json'
+
+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'
+

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: contentdm_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chad Fennell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: 
+email:
+- fenne035@umn.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- contentdm_api.gemspec
+- lib/contentdm_api.rb
+- lib/contentdm_api/compound_item.rb
+- lib/contentdm_api/request.rb
+- lib/contentdm_api/request_batch.rb
+- lib/contentdm_api/response.rb
+- lib/contentdm_api/service.rb
+- lib/contentdm_api/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the ContentDM API
+test_files: []
+has_rdoc: