hunting 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 985ecd9b9ff22857ff96540f6682951f184a9f58
+  data.tar.gz: 0afce070647cc90787be5c34ef6056199334e1dc
+SHA512:
+  metadata.gz: d04eb9c9cf14f4529ede74869923d4acef0380e2bebf5aa9c89c5be38dfc6444035628428b8c538c5f59de83d43e644ed229cf01c3cc8c82df492e0bfbf0339c
+  data.tar.gz: f1edb2af2252c180b191c389b6d3bfeacb6ded1a1bb1bf91a6ae1f03fd0b9412850249722bece005c17bdd9b2d9be8acce947a6bf1e3c38e1d6178ad0d4dca3a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,176 @@
+# Hunting
+
+Hunting is a Ruby wrapper for the CONTENTdm API. Quickly 'Scout' for collections and objects in your Repository, 'Hunt' for metadata in your Collections, and 'Trap' individual Digital Objects.
+
+## Installation
+
+__This gem has not yet been published to RubyGems. Please use the Dev Installation instructions below after cloning the repository.__
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hunting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hunting
+
+### Dev Installation
+
+    $ bundle install
+    $ gem build hunting.gemspec
+    $ gem install .\hunting-0.1.0.gem
+
+## Usage
+
+```ruby
+require 'hunting'
+```
+
+### Configuration
+Hunting depends on configuration data, passed as either a hash or a yaml file, for local CONTENTdm system attributes, collections, and metadata fields.
+
+#### With Hash
+```ruby
+Hunting.configure(hash)
+```
+Default config hash
+```ruby
+{
+  :cdm => {
+            'name' => 'Default Repo',
+            'server' => 'repository.address.edu',
+            'port' => 42,
+            'download_dir' => 'path/to/download/dir',
+            'records' => 3000
+          },
+  :progressbar => { 'length' => 60 }
+}
+```
+
+#### With YAML File
+```ruby
+Hunting.configure_with('path\to\config.yml')
+```
+
+Example `config.yml`
+```yaml
+cdm:
+  name:         # short repository name
+  server:       # server address
+  port:         # port number
+  download_dir: # directory path for logs and files
+  records:      # number of records to return for Collection.data
+
+progressbar:
+  length:       # integer width for progress bar (default: 60)
+```
+
+### Repository.scout
+
+Scout the repository for objects in all collections.
+```ruby
+repo = Repository.scout
+```
+
+Print all collection aliases in the repository.
+```ruby
+repo.collections.each do |collection_alias, collection|
+    puts collection_alias
+end
+```
+OR
+```ruby
+repo.collections.each do |collection_alias, collection|
+    puts collection.alias
+end
+```
+
+Scout the repository for objects in some collections.
+```ruby
+repo = Repository.scout(['collection_1_alias','collection_2_alias'])
+```
+
+Print some attributes of Collection 1.
+```ruby
+puts repo.collections['collection_1_alias'].alias
+puts repo.collections['collection_1_alias'].name
+puts repo.collections['collection_1_alias'].size
+```
+
+Print the Title of Object 7 from Collection 1.
+```ruby
+puts repo.collections['collection_1_alias'].records[7][:title]
+```
+
+Store all object pointers from Collection 1 in an array.
+```ruby
+collection_1_pointers = []
+repo.collections['collection_1_alias'].records.each do |pointer, record|
+  collection_1_pointers.push(pointer)
+end
+```
+
+### Collection.hunt
+
+Hunt for all object metadata in Collection 1.
+```ruby
+repo.collections['collection_1_alias'].hunt
+```
+
+Hunt for some object metadata in Collection 1.
+```ruby
+repo.collections['collection_1_alias'].hunt([7,11,42])
+```
+
+Print the Title of Object 7 from Collection 1.
+```ruby
+puts repo.collections['collection_1_alias'].objects[7].metadata['Title']
+```
+
+Print the Title of Item 6 within (Compound) Object 7 from Collection 1.
+```ruby
+puts repo.collections['collection_1_alias'].objects[7].items[6].metadata['Title']
+```
+
+### Collection.trap
+
+Trap Object 7 from Collection 1.
+```ruby
+object_7 = repo.collections['collection_1_alias'].trap(7)
+```
+
+Print some attributes of Object 7.
+```ruby
+puts object_7.metadata['Title']
+puts object_7.type
+puts object_7.pointer
+```
+
+Print all metadata field labels and values for Object 7.
+```ruby
+object_7.metadata.each do |label, value|
+  puts "#{label}: #{value}"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/uhlibraries-digital/hunting.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hunting"
+
+# 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/hunting.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hunting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hunting"
+  spec.version       = Hunting::VERSION
+  spec.authors       = ["Andy Weidner"]
+  spec.email         = ["metaweidner@gmail.com"]
+
+  spec.summary       = %q{Access digital collections through the CONTENTdm API.}
+  spec.description   = %q{Hunting is a Ruby wrapper for the CONTENTdm API. Quickly 'Scout' your Repository, 'Hunt' for metadata in your Collections, and 'Trap' individual Digital Objects.}
+  spec.homepage      = "https://github.com/uhlibraries-digital/hunting"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_dependency 'json', "~> 1.7"
+  spec.add_dependency 'xml-simple', "~> 1.1"
+  spec.add_dependency 'ruby-progressbar', "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/hunting.rb

@@ -0,0 +1,68 @@
+require 'hunting/version'
+require 'hunting/repository'
+require 'hunting/collection'
+require 'hunting/digital_object'
+require 'yaml'
+require 'json'
+require 'xmlsimple'
+require 'open-uri'
+require 'ruby-progressbar'
+
+module Hunting
+  # Configuration defaults
+  @config = {
+              :cdm => {
+                        'name' => 'Default Repo',
+                        'server' => 'repository.address.edu',
+                        'port' => 42,
+                        'records' => 3000
+                      },
+              :progressbar => { 'length' => 60 }
+            }
+
+  @valid_config_keys = @config.keys
+
+  # Configure through hash
+  def self.configure(opts = {})
+    opts.each do |key,value|
+      if @valid_config_keys.include? key.to_sym
+        @config[key.to_sym] = value
+      end
+    end
+    server = @config[:cdm]['server']
+    port = @config[:cdm]['port']
+    @config[:dmwebservices] = "http://#{server}:#{port}/dmwebservices/index.php?q="
+    @config
+  end
+
+  # Configure through yaml file
+  def self.configure_with(path_to_yaml_file)
+    config = YAML::load(IO.read(path_to_yaml_file))
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.progressbar(type, name, total = nil)
+    length = Hunting.config[:progressbar]['length']
+    case type
+    when 'repository'
+      @progressbar = ProgressBar.create(total: total,
+                                        length: length,
+                                        format: "Scouting #{name}: %c |%B|")
+    when 'collection'
+      @progressbar = ProgressBar.create(total: total,
+                                        length: length,
+                                        format: "Hunting #{name}: %c/%C |%B|")
+    else
+      @progressbar = ProgressBar.create(length: length,
+                                        format: "Trapping #{name}")
+    end
+  end
+
+  def self.increment
+    @progressbar.increment
+  end
+end

data/lib/hunting/collection.rb

@@ -0,0 +1,79 @@
+class Collection
+
+  attr_reader :alias,
+              :name,
+              :labels,
+              :size,
+              :records,
+              :objects
+
+  def initialize(collection)
+    @alias = collection[:alias]
+    @name = collection[:name]
+    @labels = map_labels_to_nicks
+    @size = 0
+    @records = scout_cdm
+    @objects = {}
+  end
+
+  def map_labels_to_nicks
+    labels = {}
+    get_field_info = "dmGetCollectionFieldInfo/#{@alias}/json"
+    field_info = JSON.parse(open(Hunting.config[:dmwebservices] + get_field_info).read)
+    field_info.each { |field| labels.store(field['name'], field['nick']) }
+    labels
+  end
+
+  def scout_cdm
+    data = {}
+    records = Hunting.config[:cdm]['records']
+    dm_query = "dmQuery/#{@alias}/0/title/title/#{records}/1/0/0/0/0/0/0/json"
+    raw_data = JSON.parse(open(Hunting.config[:dmwebservices] + dm_query).read)
+    raw_data['records'].each do |record|
+      data.store(record['pointer'], {:filetype => record['filetype'], :title => record['title']})
+      Hunting.increment
+      @size += 1
+    end
+    data
+  end
+
+  def trap(pointer)
+    if @records.has_key?(pointer)
+      @progressbar = Hunting.progressbar('object', "#{@alias}(#{pointer})")
+      digital_object = DigitalObject.new({:pointer => pointer, :type => @records[pointer][:filetype]},
+                                         {:labels => @labels, :alias => @alias, :progress => 'no'})
+      @progressbar.finish
+      digital_object
+    else
+      puts "'#{@alias}' trap #{pointer} failed"
+    end
+  end
+
+  def hunt(pointers = 'all')
+    not_found = []
+    if pointers == 'all'
+      @progressbar = Hunting.progressbar('collection', @alias, @size)
+      @records.each do |pointer, object|
+        @objects.store(pointer, DigitalObject.new({:pointer => pointer, :type => object[:filetype]},
+                                                  {:labels => @labels, :alias => @alias, :progress => 'yes'}))
+      end
+      @progressbar.finish
+    else
+      @progressbar = Hunting.progressbar('collection', @alias, pointers.size)
+      pointers.each do |pointer|
+        if @records.has_key?(pointer)
+          @objects.store(pointer, DigitalObject.new({:pointer => pointer, :type => @records[pointer][:filetype]},
+                                                    {:labels => @labels, :alias => @alias, :progress => 'yes'}))
+        else
+          not_found.push(pointer)
+        end
+      end
+      @progressbar.finish
+      if not_found.size > 0
+        print "'#{@alias}' hunt failed for: "
+        not_found.each {|pointer| print "#{pointer} "}
+        print "(#{not_found.size} of #{pointers.size})\n"
+      end
+    end
+  end
+end

data/lib/hunting/digital_object.rb

@@ -0,0 +1,60 @@
+class DigitalObject
+
+  attr_reader :pointer,
+              :type,
+              :title,
+              :metadata,
+              :items
+
+  def initialize(record, collection)
+    @pointer = record[:pointer]
+    @alias = collection[:alias]
+    @labels = collection[:labels]
+    @metadata = {}
+    @items = {}
+    case record[:type]
+    when 'cpd'
+      @type = 'compound'
+      Hunting.increment if collection[:progress] == 'yes'
+    when 'file'
+      @type = 'file'
+    else
+      @type = 'single'
+      Hunting.increment if collection[:progress] == 'yes'
+    end
+    get_item_info = "dmGetItemInfo/#{@alias}/#{@pointer}/json"
+    raw_metadata = JSON.parse(open(Hunting.config[:dmwebservices] + get_item_info).read)
+    @title = raw_metadata['title']
+    @labels.each do |label, nick|
+      if raw_metadata[nick] == {}
+        @metadata[label] = ''
+      else
+        @metadata[label] = raw_metadata[nick]
+      end
+    end
+    if @type == 'compound'
+      get_c_o_info = "dmGetCompoundObjectInfo/#{@alias}/#{@pointer}/xml"
+      c_o_data = XmlSimple.xml_in(open(Hunting.config[:dmwebservices] + get_c_o_info))
+      if c_o_data['page'] == nil
+        content = open(Hunting.config[:dmwebservices] + get_c_o_info) {|f| f.read}
+        doc = XmlSimple::Document.new content
+        doc.elements.each("cpd/node/*") {|hierarchy| flatten(hierarchy)}
+      else
+        c_o_data['page'].each do |page|
+          @items.store(page['pageptr'][0].to_i, DigitalObject.new({:pointer => page['pageptr'][0].to_i, :type => 'file'},
+                                                                  {:labels => @labels, :alias => @alias}))
+        end
+      end
+    end
+  end
+
+  def flatten(hierarchy)
+    if hierarchy.elements['pageptr'] == nil
+      hierarchy.elements.each {|node| flatten(node)}
+    else
+      pointer = hierarchy.elements['pageptr'].text.to_i
+      @items.store(pointer, DigitalObject.new({:pointer => pointer, :type => 'file'},
+                                              {:labels => @labels, :alias => @alias}))
+    end
+  end
+end

data/lib/hunting/repository.rb

@@ -0,0 +1,55 @@
+class Repository
+
+  attr_reader :collections
+  attr_accessor :size
+
+  def self.scout(aliases = 'all')
+    Repository.new(aliases)
+  end
+
+  def initialize(aliases)
+    @progressbar = Hunting.progressbar('repository', Hunting.config[:cdm]['name'])
+    @size = 0
+    @not_found = []
+    @collections = scout(aliases)
+    @progressbar.finish
+    if @not_found.size > 0
+      print 'Scout failed for: '
+      @not_found.each {|collection| print "#{collection} "}
+      print "\n"
+    end
+  end
+
+  def scout(aliases)
+    collections = {}
+    collection_info = {}
+
+    if Hunting.config[:dmwebservices] == nil
+      @progressbar.finish
+      abort("\nPlease configure Hunting for your CONTENTdm server:
+             \nHunting.configure(config_hash)\nOR\nHunting.configure_with(\"/path/to/config.yml\")\n")
+    else
+      cdm_collection_data = JSON.parse(open(Hunting.config[:dmwebservices] + "dmGetCollectionList/json").read)
+    end
+
+    cdm_collection_data.each do |collection|
+      collection_info.store(collection['secondary_alias'], {:alias => collection['secondary_alias'], :name => collection['name']})
+    end
+
+    if aliases == 'all'
+      collection_info.each do |collection_alias, info|
+        collections.store(collection_alias, Collection.new({:alias => collection_alias, :name => info[:name]}))
+      end
+    else
+      aliases.each do |c_alias|
+        if collection_info[c_alias] == nil
+          @not_found.push(c_alias)
+        else
+          collections.store(c_alias, Collection.new({:alias => c_alias, :name => collection_info[c_alias][:name]}))
+        end
+      end
+    end
+    collections.each {|c_alias, collection| @size += collection.size}
+    collections
+  end
+end

data/lib/hunting/version.rb

@@ -0,0 +1,3 @@
+module Hunting
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: hunting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Weidner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Hunting is a Ruby wrapper for the CONTENTdm API. Quickly 'Scout' your
+  Repository, 'Hunt' for metadata in your Collections, and 'Trap' individual Digital
+  Objects.
+email:
+- metaweidner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hunting.gemspec
+- lib/hunting.rb
+- lib/hunting/collection.rb
+- lib/hunting/digital_object.rb
+- lib/hunting/repository.rb
+- lib/hunting/version.rb
+homepage: https://github.com/uhlibraries-digital/hunting
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Access digital collections through the CONTENTdm API.
+test_files: []