scholarsphere-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 683f69f3cc0b3710f0b00fd18fbafc05efe11c54f7399a277665403d6b8fb10a
+  data.tar.gz: cccc924aa267339669331de7d92fb45fb1bc446fb29740ebc87c298041ba3b19
+SHA512:
+  metadata.gz: dc35ef489babe5c2d303325b4ae9f7d818a3394eaaffb1574433db957834b88db149ca19c627d666a567f9752c2822d29b67be9a00db680b339cca97262d1b32
+  data.tar.gz: 22d55ab65a3a090b927163fdaa4ad22e4334fcf720ce6a4cd86b02e52088bea64c5c6702d34f6c8ca443164ba2fe5ae5a788dba1d26565c26fd95bc1c78da7bf

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore application configuration
+/config/scholarsphere-client.yml
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_gem:
+    niftany:
+      - niftany_rubocop_rspec.yml
+      - niftany_rubocop_ruby.yml
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'scholarsphere-client.gemspec'

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scholarsphere-client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,23 @@
+# Scholarsphere::Client
+
+Ruby client to update and create content in the Scholarsphere repository.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scholarsphere-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scholarsphere-client
+
+## Usage
+
+This client is in development and currently not supporting any features.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'psych'
+require 'marcel'
+require 'faraday'
+require 'scholarsphere/s3'
+require 'scholarsphere/client/config'
+require 'scholarsphere/client/ingest'
+require 'scholarsphere/client/collection'
+require 'scholarsphere/client/version'
+
+module Scholarsphere
+  module Client
+    class Error < StandardError; end
+
+    Config.load_defaults
+
+    class << self
+      def connection
+        @connection ||= Faraday::Connection.new(
+          url: ENV['SS4_ENDPOINT'],
+          headers: {
+            'Content-Type' => 'application/json',
+            'X-API-KEY' => api_key
+          },
+          ssl: { verify: verify_ssl? }
+        )
+      end
+
+      def verify_ssl?
+        ENV['SS_CLIENT_SSL'] != 'false'
+      end
+
+      def api_key
+        ENV['SS_CLIENT_KEY']
+      end
+    end
+  end
+end

data/lib/scholarsphere/client/collection.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Scholarsphere
+  module Client
+    class Collection
+      attr_reader :metadata, :depositor, :permissions, :work_noids
+
+      # @param [Hash] metadata
+      # @param [String] depositor
+      # @param optional [Hash] permissions
+      # @param optional [Array] work_noids
+      def initialize(metadata:, depositor:, permissions: {}, work_noids: [])
+        @metadata = metadata
+        @depositor = depositor
+        @permissions = permissions
+        @work_noids = work_noids
+      end
+
+      def create
+        connection.post do |req|
+          req.url 'collections'
+          req.body = {
+            metadata: metadata,
+            depositor: depositor,
+            permissions: permissions,
+            work_noids: work_noids
+          }.to_json
+        end
+      end
+
+      private
+
+        def connection
+          Scholarsphere::Client.connection
+        end
+    end
+  end
+end

data/lib/scholarsphere/client/config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Scholarsphere
+  module Client
+    class Config
+      def self.load_defaults
+        new.load_config
+      end
+
+      attr_reader :file
+
+      def initialize(file = Pathname.pwd.join('config', 'scholarsphere-client.yml'))
+        @file = file
+        load_config
+      end
+
+      def load_config
+        return unless file.exist?
+
+        Psych.safe_load(file.read).each do |key, value|
+          ENV[key] ||= value
+        end
+      end
+    end
+  end
+end

data/lib/scholarsphere/client/ingest.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Scholarsphere
+  module Client
+    class Ingest
+      attr_reader :content, :metadata, :depositor, :permissions
+
+      # @param [Hash] metadata
+      # @param [Array<File,IO,Pathnme,Hash>] files as an array of File or IO, or a hash with a :file param
+      # @param [String] depositor
+      # @param optional [Hash] permissions
+      def initialize(metadata:, files:, depositor:, permissions: {})
+        @content = build_content_hash(files)
+        @metadata = metadata
+        @depositor = depositor
+        @permissions = permissions
+      end
+
+      def publish
+        upload_files
+        connection.post do |req|
+          req.url 'ingest'
+          req.body = { metadata: metadata, content: content, depositor: depositor, permissions: permissions }.to_json
+        end
+      end
+
+      private
+
+        def build_content_hash(files)
+          files.map do |file|
+            if file.is_a?(Hash)
+              file.merge(file: S3::UploadedFile.new(file.fetch(:file)))
+            else
+              { file: S3::UploadedFile.new(file) }
+            end
+          end
+        end
+
+        def upload_files
+          content.map do |file_parameters|
+            uploader.upload(file_parameters.fetch(:file))
+            file_parameters[:file] = file_parameters[:file].to_shrine.to_json
+          end
+        end
+
+        def uploader
+          @uploader ||= S3::Uploader.new
+        end
+
+        def connection
+          Scholarsphere::Client.connection
+        end
+    end
+  end
+end

data/lib/scholarsphere/client/version.rb

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

data/lib/scholarsphere/s3.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+
+module Scholarsphere
+  module S3
+    require_relative 's3/uploader'
+    require_relative 's3/uploaded_file'
+  end
+end

data/lib/scholarsphere/s3/uploaded_file.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Scholarsphere
+  module S3
+    class UploadedFile
+      attr_reader :source, :checksum
+
+      # @param [Pathname]
+      # @option option [String] :checksum in md5 format
+      def initialize(source, options = {})
+        @source = source
+        @checksum = options[:checksum]
+      end
+
+      # @return [Hash]
+      # @note this can be passed to a controller for uploading the file to Shrine
+      def to_shrine
+        {
+          id: id,
+          storage: 'cache',
+          metadata: metadata
+        }
+      end
+
+      # @return [String]
+      # @note This is the name of the file that will be stored in S3. It's using the same procedure that the
+      # Uppy::S3Multipart gem is using.
+      def id
+        @id ||= "#{SecureRandom.uuid}#{source.extname}"
+      end
+
+      # @return [String]
+      # @note Path of the file relative to the bucket
+      def key
+        "#{prefix}/#{id}"
+      end
+
+      # @return [String]
+      # @note When sending the md5 checksum to verify the file's integrity, Amazon requires that the value of the
+      # checksum be base64 encoded.
+      # @example The equivalent operation in bash would be:
+      #     openssl dgst -md5 -binary file.jpg | openssl enc -base64
+      def content_md5
+        @content_md5 ||= if checksum
+                           Base64.encode64([checksum].pack('H*')).strip
+                         else
+                           Digest::MD5.base64digest(source.read)
+                         end
+      end
+
+      def size
+        source.size
+      end
+
+      private
+
+        def metadata
+          {
+            size: source.size,
+            filename: source.basename.to_s,
+            mime_type: Marcel::MimeType.for(source)
+          }
+        end
+
+        def prefix
+          ENV['SHRINE_CACHE_PREFIX'] || 'cache'
+        end
+    end
+  end
+end

data/lib/scholarsphere/s3/uploader.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Scholarsphere
+  module S3
+    class Uploader < ::Aws::S3::FileUploader
+      FIFTEEN_MEGABYTES = 15 * 1024 * 1024
+
+      # @param [Hash] options
+      # @option options [Client] :client
+      # @option options [Integer] :multipart_threshold (15728640)
+      def initialize(options = {})
+        @options = options
+        @options[:client] ||= ::Aws::S3::Client.new(client_defaults)
+        @client = options[:client]
+        @multipart_threshold = options[:multipart_threshold] || FIFTEEN_MEGABYTES
+      end
+
+      # @param [UploadedFile]
+      # @param [Hash] of additional options
+      # @options options [String] content_md5 a base64-encoded string representating the md5 checksum
+      # @return [void]
+      # @note The content_md5 hash cannot be used when doing a multipart upload.
+      def upload(uploaded_file, options = {})
+        options[:bucket] = ENV['AWS_BUCKET']
+        options[:key] = uploaded_file.key
+        if uploaded_file.size < multipart_threshold
+          options[:content_md5] = uploaded_file.content_md5
+        end
+        super(uploaded_file.source, options)
+      end
+
+      private
+
+        def client_defaults
+          {
+            endpoint: ENV['S3_ENDPOINT'],
+            access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+            secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'],
+            force_path_style: true,
+            region: ENV['AWS_REGION']
+          }
+        end
+    end
+  end
+end

data/scholarsphere-client.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scholarsphere/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'scholarsphere-client'
+  spec.version       = Scholarsphere::Client::VERSION
+  spec.authors       = ['Adam Wead']
+  spec.email         = ['amsterdamos@gmail.com']
+
+  spec.summary       = 'Client to connect to Scholarpshere'
+  spec.description   = 'Client software to create new content for the Scholarsphere repository at Penn State.'
+  spec.homepage      = 'https://github.com/psu-stewardship/scholarsphere-client'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/psu-stewardship/scholarsphere-client'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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 'aws-sdk-s3', '~> 1.49'
+  spec.add_dependency 'faraday', '> 0.12'
+  spec.add_dependency 'marcel', '~> 0.3'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'niftany', '~> 0.6'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.3'
+  spec.add_development_dependency 'simplecov', '~> 0.18'
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: scholarsphere-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Wead
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.49'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.49'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !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: niftany
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: Client software to create new content for the Scholarsphere repository
+  at Penn State.
+email:
+- amsterdamos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/.gitkeep
+- lib/scholarsphere/client.rb
+- lib/scholarsphere/client/collection.rb
+- lib/scholarsphere/client/config.rb
+- lib/scholarsphere/client/ingest.rb
+- lib/scholarsphere/client/version.rb
+- lib/scholarsphere/s3.rb
+- lib/scholarsphere/s3/uploaded_file.rb
+- lib/scholarsphere/s3/uploader.rb
+- scholarsphere-client.gemspec
+homepage: https://github.com/psu-stewardship/scholarsphere-client
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/psu-stewardship/scholarsphere-client
+  source_code_uri: https://github.com/psu-stewardship/scholarsphere-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.1.2
+signing_key:
+specification_version: 4
+summary: Client to connect to Scholarpshere
+test_files: []