dor-services-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0dc4362abaa9eaecac5c6f674648c6d03f9e59cdabcdfa71d5873b109adc4227
+  data.tar.gz: 5d79616a6ee362b38fd4f1a54ab943f5dc69e219e6b59f30147f4835b3c8a5fb
+SHA512:
+  metadata.gz: 9d27e2217db14ee5354aa1e91063b36d52f9fbf48f71df75633010b260c0e501998ffaf102b39165e247604ecdf8cede0408ceddb55d4b8892f266671c8bc067
+  data.tar.gz: 4fba8bbce26a2cf3cccb98bc55665adaf51eac079d92f4baf8f75b6c23702e0b6eae40ed6cddb61b3fc98eb7fdc7b2b455efe77861d10c70c0035cec0ab35d38

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dor-services-client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# Dor::Services::Client
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dor/services/client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dor-services-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dor-services-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/dor-services-client.

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 "dor/services/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/dor-services-client.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dor/services/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dor-services-client"
+  spec.version       = Dor::Services::Client::VERSION
+  spec.authors       = ["Justin Coyne", "Michael Giarlo"]
+  spec.email         = ["jcoyne@justincoyne.com", "leftwing@alumni.rutgers.edu"]
+
+  spec.summary       = %q{A client for dor-services-app}
+  spec.homepage      = 'https://github.com/sul-dlss/dor-services-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('..', __FILE__)) 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 "faraday", "~> 0.15"
+  spec.add_dependency "activesupport", "~> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+end

data/lib/dor/services/client.rb

@@ -0,0 +1,80 @@
+require 'dor/services/client/version'
+require 'singleton'
+require 'faraday'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module Dor
+  module Services
+    class Client
+      class Error < StandardError; end
+
+      include Singleton
+
+
+      def self.configure(url:)
+        instance.url = url
+      end
+
+      # Creates a new object in DOR
+      # @return [HashWithIndifferentAccess] the response, which includes a :pid
+      def self.register(params:)
+        instance.register(params: params)
+      end
+
+      # @param [String] object the identifier for the object
+      # @param [String] filename the name of the file to retrieve
+      # @return [String] the file contents from the workspace
+      def self.retrieve_file(object:, filename:)
+        instance.retrieve_file(object: object, filename: filename)
+      end
+
+      # @param [String] object the identifier for the object
+      # @return [Array<String>] the list of filenames in the workspace
+      def self.list_files(object:)
+        instance.list_files(object: object)
+      end
+
+      attr_writer :url
+
+      def url
+        @url || raise(Error, "url has not yet been configured")
+      end
+
+      def register(params:)
+        resp = connection.post do |req|
+          req.url 'v1/objects'
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['Accept'] = 'application/json' # asking the service to return JSON (else it'll be plain text)
+          req.body = params.to_json
+        end
+        raise "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+        JSON.parse(resp.body).with_indifferent_access
+      end
+
+      def retrieve_file(object:, filename:)
+        resp = connection.get do |req|
+          req.url "v1/objects/#{object}/contents/#{filename}"
+        end
+        return unless resp.success?
+
+        resp.body
+      end
+
+      def list_files(object:)
+        resp = connection.get do |req|
+          req.url "v1/objects/#{object}/contents"
+        end
+        return [] unless resp.success?
+
+        json = JSON.parse(resp.body)
+        json['items'].map { |item| item['name'] }
+      end
+
+      private
+
+      def connection
+        @connection ||= Faraday.new(url)
+      end
+    end
+  end
+end

data/lib/dor/services/client/version.rb

@@ -0,0 +1,7 @@
+module Dor
+  module Services
+    class Client
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: dor-services-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Coyne
+- Michael Giarlo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-18 00:00:00.000000000 Z
+dependencies:
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: 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: 
+email:
+- jcoyne@justincoyne.com
+- leftwing@alumni.rutgers.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dor-services-client.gemspec
+- lib/dor/services/client.rb
+- lib/dor/services/client/version.rb
+homepage: https://github.com/sul-dlss/dor-services-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.7.6
+signing_key: 
+specification_version: 4
+summary: A client for dor-services-app
+test_files: []