repository-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31d238ba3b91a260a3c264166b7a255a2fed4f3677ce417a869ab6ed90337075
+  data.tar.gz: 1e137b46b387cb03441105c76c208aa03ca990bbdeca733af1b818c869ff976f
+SHA512:
+  metadata.gz: ddbdfb49476f0fe282d5016148298b225a052ffec82ac85add3ae78674e2c113448d32a568c480cbdc61a0ea69b418282e46a4b06191417b6549bdd661d74721
+  data.tar.gz: b7cd55cb9a734db1926a4efacc518c332ec133b078f94bcb8d994052361b4951053c8514cb0627a44c934eb5cf0c5d077b8285aaf5383fbad468a8da5864a890

data/.github/pull_request_template.md

@@ -0,0 +1,5 @@
+## Why was this change made?
+
+
+
+## Was the documentation (README, wiki) updated?

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'bin/console'
+    - 'vendor/**/*'
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,22 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-01-07 23:33:21 -0800 using RuboCop version 0.79.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
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'repository-client.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'repository-client.gemspec'

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.1.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'
+
+# Specify your gem's dependencies in repository-client.gemspec
+gemspec
+
+gem 'byebug'

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2020 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,16 @@
+[![Build Status](https://travis-ci.org/sul-dlss/repository-client.svg?branch=master)](https://travis-ci.org/sul-dlss/repository-client)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b5c93aeca1371e8fee2e/maintainability)](https://codeclimate.com/github/sul-dlss/repository-client/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b5c93aeca1371e8fee2e/test_coverage)](https://codeclimate.com/github/sul-dlss/repository-client/test_coverage)
+(TODO: gem version badge here)
+
+# Repository::Client
+
+This is a CLI for interacting with the Stanford digital repository API.
+The code for the repository API server is at https://github.com/sul-dlss/repository-api
+
+## Usage
+
+Deposit a new object:
+```
+sdr --service-url http://repository-api-server:3000 deposit --label 'hey there' file1.png file2.png
+```

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 'repository/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/exe/sdr

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift 'lib'
+require 'optparse'
+
+options = {}
+global = OptionParser.new do |opts|
+  opts.on('--service-url URL', 'Connect to the host at this URL') do |url|
+    options[:url] = url
+  end
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+global.order!
+command = ARGV.shift
+
+subcommands = {
+  'deposit' => OptionParser.new do |opts|
+    opts.on('--label LABEL', 'The object label') do |label|
+      options[:label] = label
+    end
+    opts.on('-h', '--help', 'Display this screen') do
+      puts opts
+      exit
+    end
+  end
+}
+
+unless subcommands.key?(command)
+  puts "unknown command '#{command}'"
+  exit
+end
+
+subcommands[command].order!
+
+require 'repository_client'
+options[:files] = ARGV unless ARGV.empty?
+RepositoryClient::CLI.start(command, options)

data/lib/repository_client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'repository_client/version'
+require 'repository_client/deposit'
+require 'repository_client/cli'
+require 'faraday'
+
+module RepositoryClient
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/repository_client/cli.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RepositoryClient
+  # The command line interface
+  module CLI
+    def self.start(command, options)
+      case command
+      when 'deposit'
+        RepositoryClient::Deposit.run(options)
+      end
+    end
+  end
+end

data/lib/repository_client/deposit.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RepositoryClient
+  # The namespace for the "deposit" command
+  module Deposit
+    def self.run(label:,
+                 type: 'http://cocina.sul.stanford.edu/models/book.jsonld',
+                 url:, files: [])
+      Process.new(label: label, type: type, url: url, files: files).run
+    end
+  end
+end
+require 'json'
+require 'repository_client/deposit/files/direct_upload_request'
+require 'repository_client/deposit/files/direct_upload_response'
+require 'repository_client/deposit/request'
+require 'repository_client/deposit/process'

data/lib/repository_client/deposit/files/direct_upload_request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module RepositoryClient
+  module Deposit
+    module Files
+      DirectUploadRequest = Struct.new(:checksum, :byte_size, :content_type, :filename, keyword_init: true) do
+        def self.from_file(filename)
+          checksum = Digest::MD5.file(filename).base64digest
+          new(checksum: checksum,
+              byte_size: File.size(filename),
+              content_type: 'text/html',
+              filename: File.basename(filename))
+        end
+
+        def as_json
+          {
+            blob: { filename: filename, byte_size: byte_size, checksum: checksum, content_type: content_type }
+          }
+        end
+
+        def to_json(*_args)
+          JSON.generate(as_json)
+        end
+      end
+    end
+  end
+end

data/lib/repository_client/deposit/files/direct_upload_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RepositoryClient
+  module Deposit
+    module Files
+      DirectUploadResponse = Struct.new(:id, :key, :checksum, :byte_size, :content_type,
+                                        :filename, :metadata, :created_at, :direct_upload,
+                                        :signed_id, keyword_init: true)
+    end
+  end
+end

data/lib/repository_client/deposit/process.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module RepositoryClient
+  module Deposit
+    # The process for doing a deposit
+    class Process
+      BLOB_PATH = '/rails/active_storage/direct_uploads'
+      DRO_PATH = '/v1/resources'
+      def initialize(label:, type:, url:, files: [], logger: Logger.new(STDOUT))
+        @label = label
+        @type = type
+        @files = files
+        @url = url
+        @logger = logger
+      end
+
+      def run
+        check_files_exist
+        file_metadata = collect_file_metadata
+        upload_responses = upload_file_metadata(file_metadata)
+        upload_files(upload_responses)
+        metadata = Request.new(label: label,
+                               type: type,
+                               uploads: upload_responses.values)
+        upload_metadata(metadata.as_json)
+      end
+
+      private
+
+      attr_reader :label, :type, :files, :url, :logger
+
+      def check_files_exist
+        logger.info('checking to see if files exist')
+        files.each do |file_name|
+          raise Errno::ENOENT, file_name unless File.exist?(file_name)
+        end
+      end
+
+      def collect_file_metadata
+        files.each_with_object({}) do |filename, obj|
+          obj[filename] = Files::DirectUploadRequest.from_file(filename)
+        end
+      end
+
+      # @param [Hash<String,Files::DirectUploadRequest>] file_metadata the filenames and their upload request
+      def upload_file_metadata(file_metadata)
+        Hash[file_metadata.map { |filename, metadata| [filename, direct_upload(metadata.to_json)] }]
+      end
+
+      def direct_upload(metadata_json)
+        logger.info("Starting an upload request: #{metadata_json}")
+        response = Faraday.post(url + BLOB_PATH, metadata_json, 'Content-Type' => 'application/json')
+        raise "unexpected response: #{response.inspect}" unless response.status == 200
+
+        logger.info("Response from server: #{response.body}")
+
+        Files::DirectUploadResponse.new(JSON.parse(response.body))
+      end
+
+      # @param [Hash<String,Files::DirectUploadResponse>] upload_responses the filenames and their upload response
+      def upload_files(upload_responses)
+        upload_responses.each do |filename, response|
+          upload_file(filename: filename,
+                      url: response.direct_upload.fetch('url'),
+                      content_type: response.content_type,
+                      content_length: response.byte_size)
+
+          logger.info('Upload complete')
+        end
+      end
+
+      def upload_file(filename:, url:, content_type:, content_length:)
+        logger.info("Uploading `#{filename}' to #{url}")
+        conn = Faraday.new(url) do |builder|
+          builder.adapter :net_http
+        end
+        upload_response = conn.put(url) do |req|
+          req.body = File.open(filename)
+          req.headers['Content-Type'] = content_type
+          req.headers['Content-Length'] = content_length.to_s
+        end
+
+        raise "unexpected response: #{upload_response.inspect}" unless upload_response.status == 204
+      end
+
+      def upload_metadata(metadata)
+        logger.info("Starting upload metadata: #{metadata}")
+        request_json = JSON.generate(metadata)
+        response = Faraday.post(url + DRO_PATH, request_json, 'Content-Type' => 'application/json')
+        raise "unexpected response: #{response.inspect}" unless response.status == 200
+
+        logger.info("Response from server: #{response.body}")
+
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/repository_client/deposit/request.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RepositoryClient
+  module Deposit
+    # This represents the metadata that we send to the server for doing a deposit
+    class Request
+      CONTEXT = 'http://cocina.sul.stanford.edu/contexts/cocina-base.jsonld'
+
+      # @param [String] label the required object label
+      # @param [String] type (http://cocina.sul.stanford.edu/models/object.jsonld) the required object type.
+      # @param [Array<RepositoryClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
+      def initialize(label:,
+                     type: 'http://cocina.sul.stanford.edu/models/object.jsonld',
+                     uploads: [])
+        @label = label
+        @type = type
+        @uploads = uploads
+      end
+
+      def as_json
+        {
+          "@context": CONTEXT,
+          "@type": type,
+          label: label,
+          structural: {
+            hasMember: file_sets_as_json
+          }
+        }
+      end
+
+      private
+
+      attr_reader :label, :uploads, :type
+
+      # In this case there is a 1-1 mapping between Files and FileSets,
+      # but this doesn't always have to be the case.  We could change this in the
+      # future so that we have one FileSet that has an Image and its OCR file.
+      def file_sets_as_json
+        uploads.map do |upload|
+          {
+            "@context": CONTEXT,
+            "@type": 'http://cocina.sul.stanford.edu/models/fileset.jsonld',
+            label: upload.filename,
+            structural: {
+              hasMember: [upload.signed_id]
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/repository_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RepositoryClient
+  VERSION = '0.1.0'
+end

data/repository-client.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'repository_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'repository-client'
+  spec.version       = RepositoryClient::VERSION
+  spec.authors       = ['Justin Coyne']
+  spec.email         = ['jcoyne@justincoyne.com']
+
+  spec.summary       = 'The CLI for https://github.com/sul-dlss/repository-api'
+  spec.description   = 'This provides a way to deposit repository objects into the Stanford Digital Repository'
+  spec.homepage      = 'https://github.com/sul-dlss/repository-client'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/sul-dlss/repository-client'
+  spec.metadata['changelog_uri'] = 'https://github.com/sul-dlss/repository-client/releases'
+
+  # 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 'faraday', '~> 0.17.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.79.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.37.1'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock', '~> 3.7'
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: repository-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Coyne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.1
+- !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: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: This provides a way to deposit repository objects into the Stanford Digital
+  Repository
+email:
+- jcoyne@justincoyne.com
+executables:
+- sdr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/pull_request_template.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sdr
+- lib/repository_client.rb
+- lib/repository_client/cli.rb
+- lib/repository_client/deposit.rb
+- lib/repository_client/deposit/files/direct_upload_request.rb
+- lib/repository_client/deposit/files/direct_upload_response.rb
+- lib/repository_client/deposit/process.rb
+- lib/repository_client/deposit/request.rb
+- lib/repository_client/version.rb
+- repository-client.gemspec
+homepage: https://github.com/sul-dlss/repository-client
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sul-dlss/repository-client
+  source_code_uri: https://github.com/sul-dlss/repository-client
+  changelog_uri: https://github.com/sul-dlss/repository-client/releases
+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.1.2
+signing_key: 
+specification_version: 4
+summary: The CLI for https://github.com/sul-dlss/repository-api
+test_files: []