dor-services-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dc4362abaa9eaecac5c6f674648c6d03f9e59cdabcdfa71d5873b109adc4227
-  data.tar.gz: 5d79616a6ee362b38fd4f1a54ab943f5dc69e219e6b59f30147f4835b3c8a5fb
+  metadata.gz: 4cc04584524185c77cc51392ebe2d26cdd52c62811bdefcec67c34823c7f2c77
+  data.tar.gz: 66c0e4f1c3bc51f9e5ac0236a4d08fa7e10b4a5dcec95323a791a8c9556f1dce
 SHA512:
-  metadata.gz: 9d27e2217db14ee5354aa1e91063b36d52f9fbf48f71df75633010b260c0e501998ffaf102b39165e247604ecdf8cede0408ceddb55d4b8892f266671c8bc067
-  data.tar.gz: 4fba8bbce26a2cf3cccb98bc55665adaf51eac079d92f4baf8f75b6c23702e0b6eae40ed6cddb61b3fc98eb7fdc7b2b455efe77861d10c70c0035cec0ab35d38
+  metadata.gz: 552b9071818b8ea4705176e2bcb52feb695d932c836e5e3ea65698a81e9cfc0e42e228de5ab05a115eb29cb1fa72c14a23593ea226365c25bad89305e4aaf750
+  data.tar.gz: 88f1e631dc93a138cd8747fb25c16914011ff89be2d992d44f0660c39cc8989ced643785e4bb49446523ac3dfa57a3e1b41499342366976704a4c5b3ccf65c5a

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from: .rubocop_todo.yml
+AllCops:
+  TargetRubyVersion: 2.3

data/.rubocop_todo.yml

@@ -0,0 +1,26 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-12-18 09:21:53 -0800 using RuboCop version 0.60.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: 3
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 104
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/dor/services/client.rb'
+
+# Offense count: 10
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 115

data/.travis.yml

@@ -1,6 +1,19 @@
----
+
+# single test suite, non-parallel build.
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=47b57fbbf65654b17f33b6ff4a108ce2abed31a86468033f20eb4d4e9e09935a
 language: ruby
 cache: bundler
 rvm:
   - 2.5.3
 before_install: gem install bundler -v 1.17.1
+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
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+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

@@ -1,3 +1,8 @@
+[![Gem Version](https://badge.fury.io/rb/dor-services-client.svg)](https://badge.fury.io/rb/dor-services-client) 
+[![Build Status](https://travis-ci.com/sul-dlss/dor-services-client.svg?branch=master)](https://travis-ci.com/sul-dlss/dor-services-client) 
+[![Code Climate](https://codeclimate.com/github/sul-dlss/dor-services-client/badges/gpa.svg)](https://codeclimate.com/github/sul-dlss/dor-services-client)
+ [![Code Climate Test Coverage](https://codeclimate.com/github/sul-dlss/dor-services-client/badges/coverage.svg)](https://codeclimate.com/github/sul-dlss/dor-services-client/coverage)
+
 # 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.

data/Rakefile

@@ -1,6 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# 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)
 
-task :default => :spec
+desc 'Run linter and tests'
+task default: %i[rubocop spec]

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "dor/services/client"
+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.
@@ -10,5 +11,5 @@ require "dor/services/client"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/dor-services-client.gemspec

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "dor/services/client/version"
+require 'dor/services/client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "dor-services-client"
+  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.authors       = ['Justin Coyne', 'Michael Giarlo']
+  spec.email         = ['jcoyne@justincoyne.com', 'leftwing@alumni.rutgers.edu']
 
-  spec.summary       = %q{A client for dor-services-app}
+  spec.summary       = '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
+  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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "faraday", "~> 0.15"
-  spec.add_dependency "activesupport", "~> 5.0"
+  spec.add_dependency 'activesupport', '~> 5.0'
+  spec.add_dependency 'faraday', '~> 0.15'
 
-  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"
+  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 'rubocop', '~> 0.61.0'
+  spec.add_development_dependency 'webmock'
 end

data/lib/dor/services/client.rb

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
 require 'dor/services/client/version'
 require 'singleton'
 require 'faraday'
 require 'active_support/core_ext/hash/indifferent_access'
+require 'dor/services/client/files'
+require 'dor/services/client/objects'
+require 'dor/services/client/release_tags'
+require 'dor/services/client/workflow'
+require 'dor/services/client/workspace'
 
 module Dor
   module Services
@@ -10,6 +17,25 @@ module Dor
 
       include Singleton
 
+      def objects
+        @objects ||= Objects.new(connection: connection)
+      end
+
+      def files
+        @files ||= Files.new(connection: connection)
+      end
+
+      def workflow
+        @workflow ||= Workflow.new(connection: connection)
+      end
+
+      def workspace
+        @workspace ||= Workspace.new(connection: connection)
+      end
+
+      def release_tags
+        @release_tags ||= ReleaseTags.new(connection: connection)
+      end
 
       def self.configure(url:)
         instance.url = url
@@ -18,60 +44,59 @@ module Dor
       # Creates a new object in DOR
       # @return [HashWithIndifferentAccess] the response, which includes a :pid
       def self.register(params:)
-        instance.register(params: params)
+        instance.objects.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)
+        instance.files.retrieve(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)
+        instance.files.list(object: object)
       end
 
-      attr_writer :url
-
-      def url
-        @url || raise(Error, "url has not yet been configured")
+      # Initializes a new workflow
+      # @param object [String] the pid for the object
+      # @param wf_name [String] the name of the workflow
+      # @raises [Error] if the request is unsuccessful.
+      # @return nil
+      def self.initialize_workflow(object:, wf_name:)
+        instance.workflow.create(object: object, wf_name: wf_name)
       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
+      # Initializes a new workspace
+      # @param object [String] the pid for the object
+      # @param source [String] the path to the object
+      # @raises [Error] if the request is unsuccessful.
+      # @return nil
+      def self.initialize_workspace(object:, source:)
+        instance.workspace.create(object: object, source: source)
       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
+      # Creates a new release tag for the object
+      # @param object [String] the pid for the object
+      # @param release [Boolean]
+      # @param what [String]
+      # @param to [String]
+      # @param who [String]
+      # @return [Boolean] true if successful
+      def self.create_release_tag(object:, release:, what:, to:, who:)
+        instance.release_tags.create(object: object, release: release, what: what, to: to, who: who)
       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
+      attr_writer :url
 
       private
 
+      def url
+        @url || raise(Error, 'url has not yet been configured')
+      end
+
       def connection
         @connection ||= Faraday.new(url)
       end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls relating to files
+      class Files
+        def initialize(connection:)
+          @connection = connection
+        end
+
+        def retrieve(object:, filename:)
+          resp = connection.get do |req|
+            req.url "v1/objects/#{object}/contents/#{filename}"
+          end
+          return unless resp.success?
+
+          resp.body
+        end
+
+        def list(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
+
+        attr_reader :connection
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about a repository object
+      class Objects
+        def initialize(connection:)
+          @connection = connection
+        end
+
+        attr_reader :connection
+
+        # Creates a new object in DOR
+        # @return [HashWithIndifferentAccess] the response, which includes a :pid
+        def register(params:)
+          resp = connection.post do |req|
+            req.url 'v1/objects'
+            req.headers['Content-Type'] = 'application/json'
+            # asking the service to return JSON (else it'll be plain text)
+            req.headers['Accept'] = 'application/json'
+            req.body = params.to_json
+          end
+          raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+
+          JSON.parse(resp.body).with_indifferent_access
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about a repository object
+      class ReleaseTags
+        def initialize(connection:)
+          @connection = connection
+        end
+
+        attr_reader :connection
+
+        # Creates a new release tag for the object
+        # @param object [String] the pid for the object
+        # @param release [Boolean]
+        # @param what [String]
+        # @param to [String]
+        # @param who [String]
+        # @return [Boolean] true if successful
+        # rubocop:disable Metrics/MethodLength
+        def create(object:, release:, what:, to:, who:)
+          params = {
+            to: to,
+            who: who,
+            what: what,
+            release: release
+          }
+          resp = connection.post do |req|
+            req.url "v1/objects/#{object}/release_tags"
+            req.headers['Content-Type'] = 'application/json'
+            req.body = params.to_json
+          end
+          raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+
+          true
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Dor
   module Services
     class Client
-      VERSION = "0.1.0"
+      VERSION = '0.2.0'
     end
   end
 end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about workflow
+      class Workflow
+        def initialize(connection:)
+          @connection = connection
+        end
+
+        attr_reader :connection
+
+        # Begin a new workflow
+        # @param object [String] the pid for the object
+        # @param wf_name [String] the name of the workflow
+        # @raises [Error] if the request is unsuccessful.
+        # @return nil
+        def create(object:, wf_name:)
+          resp = connection.post do |req|
+            req.url "v1/objects/#{object}/apo_workflows/#{wf_name}"
+          end
+          raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about the DOR workspace
+      class Workspace
+        def initialize(connection:)
+          @connection = connection
+        end
+
+        attr_reader :connection
+
+        # Initializes a new workspace
+        # @param object [String] the pid for the object
+        # @param source [String] the path to the object
+        # @raises [Error] if the request is unsuccessful.
+        # @return nil
+        def create(object:, source:)
+          resp = connection.post do |req|
+            req.url "v1/objects/#{object}/initialize_workspace"
+            req.params['source'] = source
+          end
+          raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -12,33 +12,33 @@ cert_chain: []
 date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,20 @@ dependencies:
     - - "~>"
       - !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.61.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.61.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +119,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -113,7 +129,12 @@ files:
 - bin/setup
 - dor-services-client.gemspec
 - lib/dor/services/client.rb
+- lib/dor/services/client/files.rb
+- lib/dor/services/client/objects.rb
+- lib/dor/services/client/release_tags.rb
 - lib/dor/services/client/version.rb
+- lib/dor/services/client/workflow.rb
+- lib/dor/services/client/workspace.rb
 homepage: https://github.com/sul-dlss/dor-services-client
 licenses: []
 metadata: {}