dpn-client 1.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55ea45ebadcb8d3e8af3c0a8597ec31f8bb49f23
+  data.tar.gz: ad3e2f35e5572ece674d8cb48c3e1adae5a3903c
+SHA512:
+  metadata.gz: df13b7da524edb3e8bf7fd7e1d4b34ac4eef89b7d012b24d59c7b33e889afae7dbcc5e79809a13e94497670545ae3344cf613cef3ee103c5394f51db86d1aee0
+  data.tar.gz: d70510caeb2651423862d6a895b097a7cbc8fcbb312e733cf0b4505030f0d0a8afd5952cc59e3f7f0bc4ea26bf9e6c29b619d52ff7351166cdcc8ff28a0f1f51

data/.gitignore

@@ -0,0 +1,44 @@
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+/tmp
+
+# Rubymine
+/.idea
+
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+# Ignore pow environment settings
+.powenv
+
+# Yard Documentation
+.yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+- 2.2.1
+before_install: gem install bundler -v 1.10.3
+script: bundle exec rspec
+addons:
+  code_climate:
+    repo_token: f22be735856cba5796a856b993f0d38a7655bf2eb75f0329701455327de301d2
+notifications:
+  slack:
+    secure: >
+      TRWr6LiDI3mXdGdecKNtOIw7/znPNFzUbmf8hCy1SZg1/41QkMTmDFOKQJY2q8BexwuUEr1cBnYF/EJtwlqQ3bR6Rytr
+      chjmtgwlCBue90c1Rc/jt6W1FjPXPgWTQ1jki1fZcETLGvAeD2dzUxXTQfX3EJZ1rZ8Bi3TdbBKEM/h7PXHKbuA9Q+p+
+      xzXDP2up31z/nIaMjcOdAGtE2zng9hhEGw7NzYFRNS8eZ8kMUhw/6ED+BeefDXNr8HMyzOyMrBhOQjqogB4KPFS1uaAE
+      8K5QQt/IqNF1bDq3pvatAILC2RWsPQOTjWkKt2uQK2pj0Rbm0uh8rRi9rKCpIjd6BHKKx+lut4Ma5H2Sy80Iltksf/AH
+      UlHI/6ZH4hE7LkQCdw3JmpTx5AHCI4OBo+JBRxSu3i4VfcFhxQrcuLDleib5NEha9KYVlRRM8y3+A9tP+5zrFEGi4DGH
+      oW8X7xUCJFoXh7Jsec/PgndLkdyPdq/bFpG8LPXdbKgWuhNXSqiRxYO/8gRZYRfhcBw2qGgsCyravSZeQIAaClk7RfKw
+      hBWqhrDAvW/tK05YaaLAC8Dt4WlGhx5Xa7TGfPzIsiZlLT8F27JXSIyQpg96I5RGzlmSoCmkcjwWYeum/6gzDDdogMrP
+      4iTKoj18Oo/FyOPxo/aOeF/FfBBAT42jBVYl5g8=

data/Gemfile

@@ -0,0 +1,9 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dpn-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    dpn-client (1.3.1)
+      httpclient (~> 2.6.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    httpclient (2.6.0.1)
+    json (1.8.3)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  codeclimate-test-reporter
+  dpn-client!
+  rake (~> 10.0)
+  rspec
+  webmock
+  yard
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.md

@@ -0,0 +1,27 @@
+Copyright (c) 2015, The Regents of the University of Michigan.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+* Neither the name of the The University of Michigan nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS OF THE UNIVERSITY OF MICHIGAN AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OF THE
+UNIVERSITY OF MICHIGAN BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO,PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,56 @@
+# DPN::Client
+
+[![Build Status](https://travis-ci.org/dpn-admin/dpn-client.svg?branch=master)](https://travis-ci.org/dpn-admin/dpn-client)
+[![Code Climate](https://codeclimate.com/github/dpn-admin/dpn-client/badges/gpa.svg)](https://codeclimate.com/github/dpn-admin/dpn-client)
+[![Test Coverage](https://codeclimate.com/github/dpn-admin/dpn-client/badges/coverage.svg)](https://codeclimate.com/github/dpn-admin/dpn-client/coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dpn-client', :git => 'https://github.com/dpn-admin/dpn-client.git'
+
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+See the
+[yard documentation](http://www.rubydoc.info/github/dpn-admin/dpn-client/master/DPN/Client/Agent)
+for more info, but the basics are thus:
+
+```ruby
+client = DPN::Client.client.configure do |c|
+  c.api_root = "https://hathitrust.org/api_root"
+  c.auth_token = "auth_token_for_hathi"
+end
+
+client.bags(page_size: 25, admin_node: "hathi") do |bag|
+  bag.inspect # this block is optional
+end
+
+resp = client.create_bag(some_bag_hash)
+if resp.success?
+  some_bag_hash[:status] = resp[:status]
+end
+```
+
+Essentially, single-endpoint operations always return a Response object,
+but you can treat this object as just a hash, if you want.  Index operations
+return an array of hashes.
+
+You can pass a block to any operation.  For single-endpoints, the response will
+be passed to the block.  For indexes, each individual result will be passed 
+successively to the block. Using blocks is recommended.
+
+## License
+
+Copyright (c) 2015 The Regents of the University of Michigan.  
+All Rights Reserved.  
+Licensed according to the terms of the Revised BSD License.  
+See LICENSE.md for details.  
+

data/Rakefile

@@ -0,0 +1,11 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/dpn-client.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dpn/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dpn-client"
+  spec.version       = DPN::Client::VERSION
+  spec.authors       = ["Bryan Hockey"]
+  spec.email         = ["bhock@umich.edu"]
+
+  spec.summary       = %q{A client to process the DPN api.}
+  spec.description   = %q{A client to process the DPN api.}
+  spec.homepage      = "https://github.com/dpn-admin/dpn-client"
+
+  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_runtime_dependency "httpclient", "~> 2.6.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/lib/dpn/client/agent/bag.rb

@@ -0,0 +1,84 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+module DPN
+  module Client
+    class Agent
+      module Bag
+
+        # Get the bags index
+        # @param [Hash] options
+        # @option options [Fixnum] :page_size (25) Number of entries per page
+        # @option options [DateTime String] :before (nil) Include only entries last modified
+        #   before this date.
+        # @option options [DateTime String] :after (nil) Include only entries last modified
+        #   after this date.
+        # @option options [String] :admin_node (nil) Namespace of the admin_node of the bag.
+        # @option options [String] :member (nil) The UUID of the member that owns or is vested
+        #   in this bag.
+        # @option options [String] :bag_type (nil) One of 'D', 'R', 'I', for data, rights, and
+        #   interpretive, respectively.
+        # @yield [Response] Optional block to process individual bag.
+        # @return [Array<Hash>] Array of all bag data. Generated and returned
+        #   only if no block is passed.
+        def bags(options = {page_size: 25}, &block)
+          [:after, :before].each do |date_field|
+            if options[date_field].is_a?(DateTime)
+              options[date_field] = options[:date_field].new_offset(0).strftime(DPN::Client.time_format)
+            end
+          end
+
+          return paginate_each "/bag/", options, options[:page_size], &block
+        end
+
+
+        # @overload bag(uuid, &block)
+        #   Get a specific bag
+        #   @param [String] uuid UUID of the bag.
+        #   @yield [Response]
+        #   @return [Response]
+        # @overload bag(options)
+        #   Alias for #bags
+        #   @return [Array<Hash>]
+        #   @see #bags
+        def bag(uuid = nil, options = {page_size: 25}, &block)
+          if uuid
+            get "/bag/#{uuid}/", nil, &block
+          else
+            bags(options, &block)
+          end
+        end
+
+
+        # Create a bag
+        # @param [Hash] bag Body of the bag
+        # @yield [Response]
+        # @return [Response]
+        def create_bag(bag, &block)
+          post "/bag", bag, &block
+        end
+
+
+        # Update a bag
+        # @param [Hash] bag Body of the bag
+        # @yield [Response]
+        # @return [Response]
+        def update_bag(bag, &block)
+          put "/bag/#{bag[:uuid]}/", bag, &block
+        end
+
+
+        # Delete a bag
+        # @param [String] uuid UUID of the bag
+        # @yield [Response]
+        # @return [Response]
+        def delete_bag(uuid, &block)
+          delete "/bag/#{uuid}/", &block
+        end
+
+      end
+    end
+  end
+end

data/lib/dpn/client/agent/configuration.rb

@@ -0,0 +1,80 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+require "logger"
+
+module DPN
+  module Client
+    class Agent
+      module Configuration
+        @@keys = [
+            :api_root, :auth_token,
+            :per_page, :user_agent,
+            :logger
+        ]
+
+        @@defaults = {
+            api_root: nil.freeze,
+            auth_token: nil.freeze,
+            per_page: 25.freeze,
+            user_agent: "dpn-client".freeze
+        }.freeze
+
+        attr_accessor :api_root, :auth_token,
+                      :per_page, :user_agent
+        attr_writer :logger
+
+
+        # Apply the options hash to the configuration
+        def configure(options_hash = {})
+          keys.each do |key|
+            if options_hash[key]
+              instance_variable_set(:"@#{key}", options_hash[key])
+            end
+          end
+          if block_given?
+            yield self
+          end
+          return self
+        end
+
+
+        # Reset to default values
+        def reset
+          keys.each do |key|
+            instance_variable_set(:"@#{key}", defaults[key])
+            self
+          end
+        end
+        alias_method  :setup, :reset
+
+        def base_url
+          File.join(@api_root, "api-v#{DPN::Client.api_version}")
+        end
+
+        def logger
+          @logger ||= NullLogger.new
+        end
+
+        protected
+
+        class NullLogger < Logger
+          def initialize(*args); end
+          def add(*args, &block); end
+        end
+
+        def defaults
+          @@defaults
+        end
+
+        def keys
+          @@keys
+        end
+
+
+      end
+    end
+  end
+end

data/lib/dpn/client/agent/connection.rb

@@ -0,0 +1,183 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+require "uri"
+require "json"
+require "httpclient"
+require "csv" # stringify_nested_arrays!
+require "dpn/client/response"
+
+module DPN
+  module Client
+    class Agent
+      module Connection
+
+        # Make a GET request
+        # @param url [String] The path, relative to base_url
+        # @param query [Hash] Optional query parameters.
+        # @yield [Response] Optional block that takes the
+        #   response object as a parameter.
+        # @return [Response]
+        def get(url, query = nil, &block)
+          request :get, url, query, nil, &block
+        end
+
+
+        # Make a POST request
+        # @param url [String] The path, relative to base_url
+        # @param body [String] The message body.
+        # @yield [Response] Optional block that takes the
+        #   response object as a parameter.
+        # @return [Response]
+        def post(url, body, &block )
+          request :post, url, nil, body, &block
+        end
+
+
+        # Make a PUT request
+        # @param url [String] The path, relative to base_url
+        # @param body [String] The message body.
+        # @yield [Response] Optional block that takes the
+        #   response object as a parameter.
+        # @return [Response]
+        def put(url, body, &block)
+          request :put, url, nil, body, &block
+        end
+
+
+        # Make a DELETE request
+        # @param url [String] The path, relative to base_url
+        # @yield [Response] Optional block that takes the
+        #   response object as a parameter.
+        # @return [Response]
+        def delete(url, &block)
+          request :delete, url, nil, nil, &block
+        end
+
+
+        # Make a one or more GET requests, fetching the next
+        # page of results one page at a time, so long as the
+        # response indicates there is another page.
+        # @param url [String] The path, relative to base_url
+        # @param query [Hash] Optional query parameters.
+        # @param page_size [Fixnum] The number of results to request
+        #   from each page.
+        # @yield [Response] Mandatory block that takes a page
+        #   of results (the response object) as a parameter.
+        #   The results will be available via response[:results].
+        def paginate(url, query, page_size, &block)
+          raise ArgumentError, "Must pass a block" unless block_given?
+
+          query ||= {}
+          query = query.merge({ :page_size => page_size, :page => 1})
+
+          response = get(url, query) # pass an empty block so we can call the block manually on :results
+          yield response
+          while response.success? && response[:next] && response[:results].empty? == false
+            query[:page] += 1
+            query[:page_size] = response[:results].size # in case the server specifies a different page size
+            response = get(url, query) {}
+            yield response
+          end
+        end
+
+
+        # Make a one or more GET requests, fetching the next
+        # page of results one page at a time, so long as the
+        # response indicates there is another page.  This method
+        # yields each individual result, wrapped in a [Response].
+        # @param url [String] The path, relative to base_url
+        # @param query [Hash] Optional query parameters.
+        # @param page_size [Fixnum] The number of results to request
+        #   from each page.
+        # @yield [Response] Mandatory block that takes each individual
+        #   result wrapped in a response object as a parameter.  If a
+        #   request is unsuccessful, the failed response is yielded.
+        def paginate_each(url, query, page_size, &block)
+          raise ArgumentError, "Must pass a block" unless block_given?
+          paginate(url, query, (page_size || 25)) do |response|
+            if response.success?
+              logger.info("Response has #{response[:results].size} results.")
+              response[:results].each do |result|
+                  yield Response.from_data(response.status, result)
+              end
+            else
+              yield response
+            end
+          end
+        end
+
+
+        protected
+
+        def request(method, url, query, body, &block)
+          url, extra_query = parse_url(url)
+          query ||= {}
+          options = {
+              query: stringify_nested_arrays!(query.merge(extra_query)),
+              body: body.to_json,
+              follow_redirect: true
+          }
+
+          logger.info("Sending #{method.upcase}: #{File.join(base_url, fix_url(url))} #{options} ")
+          raw_response = connection.request method, fix_url(url), options
+          logger.debug("Received #{raw_response.inspect}")
+          response = DPN::Client::Response.new(raw_response)
+          logger.info("Received #{response.status}")
+          if block_given?
+            yield response
+          end
+
+          return response
+        end
+
+
+        def parse_url(raw_url)
+          url, query = raw_url.split("?", 2)
+          url = File.join url, ""
+          if query
+            query = URI::decode_www_form(query).to_h
+          else
+            query = {}
+          end
+          return url, query
+        end
+
+
+        def connection
+          @connection ||= ::HTTPClient.new({
+              agent_name: user_agent,
+              base_url: base_url,
+              default_header: {
+                  "Content-Type" => "application/json",
+                  "Authorization" => "Token #{auth_token}"
+              },
+              force_basic_auth: true
+          })
+        end
+
+
+        def fix_url(url)
+          File.join url, "/"
+        end
+
+
+        # Convert array values to csv
+        # Only goes one level deep.
+        # @param [Hash] hash
+        # @return [Hash]
+        def stringify_nested_arrays!(hash)
+          hash.keys.each do |key|
+            if hash[key].kind_of?(Array)
+              hash[key] = hash[key].to_csv.strip
+            end
+          end
+          return hash
+        end
+
+      end
+    end
+  end
+end

data/lib/dpn/client/agent/member.rb

@@ -0,0 +1,88 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+module DPN
+  module Client
+    class Agent
+
+      # Operations on the member resource.
+      module Member
+
+        # Get the members index
+        # @param [Hash] options
+        # @option options [Fixnum] :page_size (25) Number of members per page
+        # @yield [Response] Optional block to process each individual member.
+        # @return [Array<Hash>] Array of all member data. Generated and returned
+        #   only if no block is passed.
+        def members(options = {page_size: 25}, &block)
+          return paginate_each "/member/", options, options[:page_size], &block
+        end
+
+
+        # @overload member(uuid, &block)
+        #   Get a specific member
+        #   @param [String] uuid UUIDv4 of the member.
+        #   @yield [Response] Optional block to process the response.
+        #   @return [Response]
+        # @overload member(options, &block)
+        #   Alias for #members
+        #   @return [Array<Hash>]
+        #   @see #members
+        def member(uuid = nil, options = {page_size: 25}, &block)
+          if uuid
+            get "/member/#{fix_uuid(uuid)}/", nil, &block
+          else
+            members(options, &block)
+          end
+        end
+
+
+        # Create a member
+        # @param [Hash] member Body of the member
+        # @yield [Response]
+        # @return [Response]
+        def create_member(member, &block)
+          post "/member/", member, &block
+        end
+
+
+        # Update a member
+        # @param [Hash] member Body of the member
+        # @yield [Response]
+        # @return [Response]
+        def update_member(member, &block)
+          put "/member/#{fix_uuid(member[:uuid])}/", member, &block
+        end
+
+
+        # Delete a member
+        # @param [String] uuid UUIDv4 of the member.
+        # @yield [Response]
+        # @return [Response]
+        def delete_member(uuid, &block)
+          delete "/member/#{fix_uuid(uuid)}/", &block
+        end
+
+
+        private
+        # Add dashes to a uuid if they are missing
+        def fix_uuid(uuid)
+          if uuid && uuid.size == 32
+            unless uuid.include?("-")
+              uuid.insert(8, "-")   # 9th, 14th, 19th and 24th
+              uuid.insert(13, "-")
+              uuid.insert(18, "-")
+              uuid.insert(23, "-")
+            end
+          end
+          uuid.downcase
+        end
+        
+
+      end
+
+    end
+  end
+end

data/lib/dpn/client/agent/node.rb

@@ -0,0 +1,71 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+module DPN
+  module Client
+    class Agent
+
+      # Operations on the node resource.
+      module Node
+
+        # Get the nodes index
+        # @param [Hash] options
+        # @option options [Fixnum] :page_size (25) Number of nodes per page
+        # @yield [Response] Optional block to process each individual node.
+        # @return [Array<Hash>] Array of all node data. Generated and returned
+        #   only if no block is passed.
+        def nodes(options = {page_size: 25}, &block)
+          return paginate_each "/node/", options, options[:page_size], &block
+        end
+
+
+        # @overload node(namespace, &block)
+        #   Get a specific node
+        #   @param [String] namespace Namespace of the node.
+        #   @yield [Response] Optional block to process the response.
+        #   @return [Response]
+        # @overload node(options, &block)
+        #   Alias for #nodes
+        #   @return [Array<Hash>]
+        #   @see #nodes
+        def node(namespace = nil, options = {page_size: 25}, &block)
+          if namespace
+            get "/node/#{namespace}/", nil, &block
+          else
+            nodes(options, &block)
+          end
+        end
+
+
+        # Create a node
+        # @param [Hash] node Body of the node
+        # @yield [Response]
+        # @return [Response]
+        def create_node(node, &block)
+          post "/node/", node, &block
+        end
+
+
+        # Update a node
+        # @param [Hash] node Body of the node
+        # @yield [Response]
+        # @return [Response]
+        def update_node(node, &block)
+          put "/node/#{node[:namespace]}/", node, &block
+        end
+
+
+        # Delete a node
+        # @param [String] namespace Namespace of the node.
+        # @yield [Response]
+        # @return [Response]
+        def delete_node(namespace, &block)
+          delete "/node/#{namespace}/", &block
+        end
+
+      end
+    end
+  end
+end

data/lib/dpn/client/agent/replicate.rb

@@ -0,0 +1,83 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+module DPN
+  module Client
+    class Agent
+      module Replicate
+
+        # Get the replication request index
+        # @param [Hash] options
+        # @option options [Fixnum] :page_size (25) Number of entries per page
+        # @option options [DateTime,String] :after (nil) Include only entries last modified
+        #   after this date.  Takes a properly formatted string, or a datetime.
+        # @option options [String] uuid (nil) Filter by a specific bag's UUID.
+        # @option options [String] status (nil) Filter by status.
+        # @option options [Boolean] fixity_accept (nil) Filter by the value of fixity_accept.
+        # @option options [Boolean] bag_valid (nil) Filter by the value of bag_valid.
+        # @option options [String] :from_node (nil) Namespace of the from_node of the bag.
+        # @option options [String] :to_node (nil) Namespace of the to_node of the bag.
+        # @option options [String] :order_by (nil) Comma-separated list of strings to order the
+        #   result by.  Accepted values are 'created_at' and 'updated_at'
+        # @yield [Response] Optional block to process each individual replication.
+        # @return [Array<Hash>] Array of all replication data. Generated and returned
+        #   only if no block is passed.
+        def replications(options = {page_size: 25}, &block)
+          if options[:after].is_a?(DateTime)
+            options[:after] = options[:after].new_offset(0).strftime(DPN::Client.time_format)
+          end
+
+          return paginate_each "/replicate/", options, options[:page_size], &block
+        end
+
+
+        # @overload replicate(replication_id, &block)
+        #   Get a specific replication request.
+        #   @param [String] replication_id
+        #   @yield [Response]
+        #   @return [Response]
+        # @overload replicate(options, &block)
+        #   Alias for #replications
+        #   @return [Array<Hash>]
+        #   @see #replications
+        def replicate(replication_id = nil, options = {page_size: 25}, &block)
+          if replication_id
+            get "/replicate/#{replication_id}/", nil, &block
+          else
+            replications(options, &block)
+          end
+        end
+
+
+        # Create a replication request
+        # @param [Hash] request Body of the replication request
+        # @yield [Response]
+        # @return [Response]
+        def create_replication(request, &block)
+          post "/replicate", request, &block
+        end
+
+
+        # Update a replication request
+        # @param [Hash] request Body of the replication request
+        # @yield [Response]
+        # @return [Response]
+        def update_replication(request, &block)
+          put "/replicate/#{request[:replication_id]}/", request, &block
+        end
+
+
+        # Delete a replication request
+        # @param [String] replication_id The replication_id of the replication request
+        # @yield [Response]
+        # @return [Response]
+        def delete_replication(replication_id, &block)
+          delete "/replicate/#{replication_id}/", &block
+        end
+
+      end
+    end
+  end
+end

data/lib/dpn/client/agent.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+require "dpn/client/agent/configuration"
+require "dpn/client/agent/connection"
+require "dpn/client/agent/node"
+require "dpn/client/agent/bag"
+require "dpn/client/agent/replicate"
+require "dpn/client/agent/member"
+
+module DPN
+  module Client
+    class Agent
+      include DPN::Client::Agent::Configuration
+      include DPN::Client::Agent::Connection
+
+      include DPN::Client::Agent::Node
+      include DPN::Client::Agent::Bag
+      include DPN::Client::Agent::Replicate
+      include DPN::Client::Agent::Member
+
+      def initialize(options = {})
+        self.configure(options)
+      end
+
+    end
+  end
+end

data/lib/dpn/client/response.rb

@@ -0,0 +1,86 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+require "httpclient"
+require "json"
+
+module DPN
+  module Client
+    class Response
+
+      attr_reader :status, :body
+
+      def initialize(httpclient_response = nil)
+        if httpclient_response
+          load_from_response!(httpclient_response)
+        end
+      end
+
+
+      # Manually create a response.
+      def self.from_data(status, body)
+        self.new.load_from_data!(status, body)
+      end
+
+      attr_reader :status, :body
+
+
+      def json
+        @cached_json ||= @body.to_json
+      end
+      alias_method :to_json, :json
+      alias_method :to_s, :json
+
+
+      def ok?
+        [ 200, 201, 202, 203, 204, 205, 206, 207, 208, 226].include?(@status)
+      end
+      alias_method :success?, :ok?
+
+
+      def keys
+        @body.keys
+      end
+
+
+      def [](key)
+        @body[key.to_sym]
+      end
+
+
+      def load_from_data!(status, body)
+        @body = body
+        @status = status
+        return self
+      end
+
+      def load_from_response!(httpclient_message_response)
+        raw_body = httpclient_message_response.body
+        @status = httpclient_message_response.header.status_code
+        begin
+          @body = JSON.parse(raw_body, symbolize_names: true)
+          @cached_json = raw_body
+        rescue JSON::ParserError
+          @body = {
+            status: @status,
+            parsed: nil,
+            raw: raw_body
+          }
+          @cached_json = @body.to_json
+          if success? # It wasn't actually successful
+            @status = 999
+          end
+        end
+        return self
+      end
+
+      def ==(other)
+        status == other.status && body == other.body
+      end
+      alias_method :eql?, :==
+
+    end
+  end
+end

data/lib/dpn/client/version.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+module DPN
+  module Client
+    VERSION = "1.3.1"
+  end
+end

data/lib/dpn/client.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2015 The Regents of the University of Michigan.
+# All Rights Reserved.
+# Licensed according to the terms of the Revised BSD License
+# See LICENSE.md for details.
+
+require "dpn/client/agent"
+require "dpn/client/response"
+require "dpn/client/version"
+
+module DPN
+  module Client
+
+    # Get the api version, based on the major version of this library.
+    def self.api_version
+      DPN::Client::VERSION.split(".")[0]
+    end
+
+
+    def self.time_format
+      "%Y-%m-%dT%H:%M:%SZ"
+    end
+
+
+    def self.client(options = {})
+      return ::DPN::Client::Agent.new options
+    end
+
+
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: dpn-client
+version: !ruby/object:Gem::Version
+  version: 1.3.1
+platform: ruby
+authors:
+- Bryan Hockey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: A client to process the DPN api.
+email:
+- bhock@umich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- dpn-client.gemspec
+- lib/dpn/client.rb
+- lib/dpn/client/agent.rb
+- lib/dpn/client/agent/bag.rb
+- lib/dpn/client/agent/configuration.rb
+- lib/dpn/client/agent/connection.rb
+- lib/dpn/client/agent/member.rb
+- lib/dpn/client/agent/node.rb
+- lib/dpn/client/agent/replicate.rb
+- lib/dpn/client/response.rb
+- lib/dpn/client/version.rb
+homepage: https://github.com/dpn-admin/dpn-client
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A client to process the DPN api.
+test_files: []
+has_rdoc: