preservation-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95721382a355768cd08ee0280fd57dc9d7e7db65190202babb259c4dce2fe48d
+  data.tar.gz: 198bd4efcd107026bbb864eb6ba5dc3ff058573139628bb90d864d97234700d7
+SHA512:
+  metadata.gz: cdacd347e69f8b5df8ffdebe692a7557e69de103ae2aeed8a9b1de80753f0665bd85123a7d6badaefad975852185223a444685b075f29cb4d07c38feb008f1fe
+  data.tar.gz: ca8eb24ba43070a39e4b5ab625e31f48c07b7078123d5d6b5edf6cd0e908128230ac132ba8b20ccf0bf98b9968fb43cb219aea041a777a9e5fb724d1c13198b5

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+
+.pry_history

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - 'lib/preservation/client/response_error_formatter.rb'
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/preservation/client.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-09-19 17:54:24 -0700 using RuboCop version 0.74.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 24
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 26
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 137

data/.travis.yml

@@ -0,0 +1,26 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=02e8afad8d0b699828dd69b6f45b598e7317b2d9828ea23380c3a97113068a0c
+
+dist: bionic
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+  - 2.6.4
+
+env:
+  - "RAILS_VERSION=5.2.3"
+  - "RAILS_VERSION=6.0.0"
+
+before_install: gem install bundler -v 2.0.2
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'activesupport', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+
+# Specify your gem's dependencies in preservation-client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2019 by The Board of Trustees of the Leland Stanford
+Junior University.  All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License.  You
+may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.  See the License for the specific language governing
+permissions and limitations under the License.

data/README.md

@@ -0,0 +1,65 @@
+[![Gem Version](https://badge.fury.io/rb/preservaton-client.svg)](https://badge.fury.io/rb/preservation-client)
+[![Build Status](https://travis-ci.org/sul-dlss/preservation-client.svg?branch=master)](https://travis-ci.org/sul-dlss/preservation-client)
+[![Maintainability](https://api.codeclimate.com/v1/badges/00d2d8957226777105b3/maintainability)](https://codeclimate.com/github/sul-dlss/preservation-client/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/00d2d8957226777105b3/test_coverage)](https://codeclimate.com/github/sul-dlss/preservation-client/test_coverage)
+
+# Preservation::Client
+
+Preservation::Client is a Ruby gem that acts as a client to the RESTful HTTP APIs provided by [preservation_catalog](https://github.com/sul-dlss/preservation_catalog).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'preservation-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install preservation-client
+
+## Usage
+
+To configure and use the client, here's an example:
+
+```ruby
+require 'preservation/client'
+
+def do_the_thing
+  # This API endpoint returns an integer
+  current_version_as_integer = client.current_version(params: { druid: 'druid:123' })
+end
+
+private
+
+def client
+  @client ||= Preservation::Client.configure(url: Settings.preservation_catalog.url)
+end
+```
+
+Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**.
+
+Note that the preservation service is behind a firewall.
+
+## API Coverage
+
+TBD
+
+## Development
+
+After checking out the repo, run `bundle` 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 `lib/preservation/client/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/sul-dlss/preservation-client
+
+## Copyright
+
+Copyright (c) 2019 Stanford Libraries. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run linter and tests'
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'preservation/client'
+
+# 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(__FILE__)

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/lib/preservation/client/error_faraday_middleware.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Preservation
+  class Client
+    # This wraps any faraday connection errors with preservation-client errors
+    # see https://www.rubydoc.info/gems/faraday/Faraday/ClientError for info on errors
+    class ErrorFaradayMiddleware < Faraday::Response::Middleware
+      def call(env)
+        @app.call(env)
+      rescue Faraday::ConnectionFailed, Faraday::SSLError, Faraday::TimeoutError => e
+        raise ConnectionFailedError, "Unable to reach Preservation Catalog - failed with #{e.class}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/preservation/client/objects.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Preservation
+  class Client
+    # API calls that are about Preserved Objects
+    class Objects < VersionedService
+
+      # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
+      # @return [Integer] the current version of the Preserved Object
+      def current_version(druid)
+        resp_body = get_json("objects/#{druid}.json", druid, 'current_version')
+        resp_body[:current_version]
+      end
+    end
+  end
+end

data/lib/preservation/client/response_error_formatter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Preservation
+  class Client
+    # Format HTTP response-related errors
+    class ResponseErrorFormatter
+      DEFAULT_BODY = 'Response from preservation-catalog did not contain a body. '\
+                     'Check honeybadger for preservation-catalog for backtraces, '\
+                     'and look into adding a `rescue_from` in preservation-catalog '\
+                     'to provide more details to the client in the future.'
+
+      def self.format(response:, object_id: nil, client_method_name: nil)
+        new(response: response, object_id: object_id, client_method_name: client_method_name).format
+      end
+
+      attr_reader :req_url, :status_msg, :status_code, :body, :object_id, :client_method_name
+
+      def initialize(response:, object_id: nil, client_method_name: nil)
+        @req_url = response.env.url
+        @status_msg = response.reason_phrase
+        @status_code = response.status
+        @body = response.body.present? ? response.body : DEFAULT_BODY
+        @object_id = object_id
+        @client_method_name = client_method_name
+      end
+
+      def format
+        status_info = status_msg.blank? ? status_code : "#{status_msg} (#{status_code})"
+        object_id_info = " for #{object_id}" if object_id.present?
+
+        "Preservation::Client.#{client_method_name}#{object_id_info} got #{status_info} from Preservation Catalog at #{req_url}: #{body}"
+      end
+    end
+  end
+end

data/lib/preservation/client/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Preservation
+  class Client
+    VERSION = '0.1.0'
+  end
+end

data/lib/preservation/client/versioned_service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Preservation
+  class Client
+    # @abstract API calls to a versioned endpoint
+    class VersionedService
+      def initialize(connection:, api_version:)
+        @connection = connection
+        @api_version = api_version
+      end
+
+      private
+
+      attr_reader :connection, :api_version
+
+      def get_json(path, object_id, caller_method_name)
+        resp = connection.get do |req|
+          req.url api_version.present? ? "#{api_version}/#{path}" : path
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['Accept'] = 'application/json'
+        end
+        return resp.body if resp.success?
+
+        errmsg = ResponseErrorFormatter
+                 .format(response: resp, object_id: object_id, client_method_name: caller_method_name)
+        raise Preservation::Client::UnexpectedResponseError, errmsg
+      rescue Faraday::ResourceNotFound => e
+        errmsg = "HTTP GET to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
+        raise Preservation::Client::NotFoundError, errmsg
+      rescue Faraday::ParsingError, Faraday::RetriableResponse => e
+        errmsg = "HTTP GET to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
+        raise Preservation::Client::UnexpectedResponseError, errmsg
+      end
+    end
+  end
+end

data/lib/preservation/client.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/object/blank'
+require 'faraday'
+require 'singleton'
+require 'zeitwerk'
+
+class PreservationClientInflector < Zeitwerk::Inflector
+  def camelize(basename, _abspath)
+    case basename
+    when 'version'
+      'VERSION'
+    else
+      super
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.new
+loader.inflector = PreservationClientInflector.new
+loader.push_dir(File.absolute_path("#{__FILE__}/../.."))
+loader.setup
+
+module Preservation
+  class Client
+    class Error < StandardError; end
+
+    # Error that is raised when the remote server returns a 404 Not Found
+    class NotFoundError < Error; end
+
+    # Error that is raised when the remote server returns some unexpected response
+    # e.g. 4xx or 5xx status
+    class UnexpectedResponseError < Error; end
+
+    class ConnectionFailedError < Error; end
+
+    DEFAULT_API_VERSION = '' # should be v1 once PreservationCatalog has versioned API
+
+    include Singleton
+
+    # @return [Preservation::Client::Objects] an instance of the `Client::Objects` class
+    def objects
+      @objects ||= Objects.new(connection: connection, api_version: DEFAULT_API_VERSION)
+    end
+
+    class << self
+      # @param [String] url
+      def configure(url:)
+        instance.url = url
+
+        # Force connection to be re-established when `.configure` is called
+        instance.connection = nil
+
+        self
+      end
+
+      delegate :objects, to: :instance
+    end
+
+    attr_writer :url, :connection
+
+    private
+
+    def url
+      @url || raise(Error, 'url has not yet been configured')
+    end
+
+    def connection
+      @connection ||= Faraday.new(url) do |builder|
+        builder.use ErrorFaradayMiddleware
+        builder.use Faraday::Request::UrlEncoded
+
+        builder.adapter Faraday.default_adapter
+        builder.headers[:user_agent] = user_agent
+      end
+    end
+
+    def user_agent
+      "preservation-client #{Preservation::Client::VERSION}"
+    end
+  end
+end

data/preservation-client.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'preservation/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'preservation-client'
+  spec.version       = Preservation::Client::VERSION
+  spec.authors       = ['Naomi Dushay']
+  spec.email         = ['ndushay@stanford.edu']
+
+  spec.summary       = 'A thin client for getting info from SDR preservation.'
+  spec.description   = 'A Ruby client for the RESTful HTTP APIs provided by the Preservation Catalog API.'
+  spec.homepage      = 'https://github.com/sul-dlss/preservation-client'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/sul-dlss/preservation-client.'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 4.2', '< 7'
+  spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_dependency 'zeitwerk', '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.74.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: preservation-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naomi Dushay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+description: A Ruby client for the RESTful HTTP APIs provided by the Preservation
+  Catalog API.
+email:
+- ndushay@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/preservation/client.rb
+- lib/preservation/client/error_faraday_middleware.rb
+- lib/preservation/client/objects.rb
+- lib/preservation/client/response_error_formatter.rb
+- lib/preservation/client/version.rb
+- lib/preservation/client/versioned_service.rb
+- preservation-client.gemspec
+homepage: https://github.com/sul-dlss/preservation-client
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/sul-dlss/preservation-client
+  source_code_uri: https://github.com/sul-dlss/preservation-client.
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A thin client for getting info from SDR preservation.
+test_files: []