valkyrie-shrine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43acefce16f29dafdd2627b82dbb79baa25e11e8b2503f33b1a49b8e4684fa81
+  data.tar.gz: 8cdd2a2fb849326f7945f9a4c20cf064c755d4bb1aac5371119d3a9db90ac9e3
+SHA512:
+  metadata.gz: f7b3a2a459b419e0e046be241b1e5d32b063de7704e211672a7823430d16c47d22cf72af8f2edc43c6023d14f49b60dff781144486e2d06ef9be637ebc02b557
+  data.tar.gz: 4768279b6f1ef8b1872cefd71e0114397a2a9029d5978dc196ce43acdb97ff4dfdbdda062f5854ed92dbeb553e182564ed91b22ca60af225e7c04a88bd725d4d

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,23 @@
+inherit_gem:
+  bixby: bixby_default.yml
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'bin/*'
+    - 'vendor/**/*'
+RSpec/ScatteredSetup:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'tasks/**/*'
+    - 'db/schema.rb'
+    - 'Rakefile'
+    - '*.gemspec'
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2019 Northwestern University Library
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# 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,49 @@
+# Valkyrie::Shrine
+
+[Shrine](http://shrinerb.com/) storage adapter for [Valkyrie](https://github.com/samvera-labs/valkyrie).
+
+[![CircleCI](https://circleci.com/gh/samvera-labs/valkyrie-shrine.svg?style=svg)](https://circleci.com/gh/samvera-labs/valkyrie-shrine)
+[![Coverage Status](https://coveralls.io/repos/github/samvera-labs/valkyrie-shrine/badge.svg?branch=master)](https://coveralls.io/github/samvera-labs/valkyrie-shrine?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'valkyrie-shrine'
+```
+
+## Usage
+
+Follow the Valkyrie [README](https://github.com/samvera-labs/valkyrie) to get a development or production environment up and running. To enable Shrine support, add the following to your application's config/initializers/valkyrie.rb:
+
+```ruby
+  # config/initializers/valkyrie.rb
+  require 'shrine/storage/s3'
+  require 'shrine/storage/file_system'
+  require 'valkyrie/storage/shrine/s3_checksum'
+  require 'valkyrie/storage/shrine/file_system_checksum'
+
+  Shrine.storages = {
+    file: Shrine::Storage::FileSystem.new("public", prefix: "uploads"),
+    s3: Shrine::Storage::S3.new(bucket: 'donut-uploads', prefix: 'cache')
+  }
+
+  Valkyrie::StorageAdapter.register(
+    Valkyrie::Storage::Shrine.new(Shrine.storages[:s3]), :s3
+  )
+
+  Valkyrie::StorageAdapter.register(
+    Valkyrie::Storage::Shrine.new(Shrine.storages[:file]), :disk
+  )
+```
+
+## 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]/valkyrie-shrine.

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "valkyrie/shrine"
+
+# 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/circle.yml

@@ -0,0 +1,29 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.1
+        environment:
+          BUNDLER_VERSION: 2.0.1
+    steps:
+      - checkout
+      - run:
+          name: Install Bundler 2.0.1
+          command: gem install --no-doc bundler:2.0.1
+      - restore_cache:
+         keys:
+           - bundle-{{ checksum "Gemfile" }}-{{ checksum "valkyrie-shrine.gemspec" }}
+           - bundle- # used if checksum fails
+      - run:
+          name: Install dependencies
+          command: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs 4 --retry 3
+      - save_cache:
+          key: bundle-{{ checksum "Gemfile" }}-{{ checksum "valkyrie-shrine.gemspec" }}
+          paths:
+            - "vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+      - run:
+          name: Run Specs
+          command: bundle exec rspec spec

data/lib/valkyrie/shrine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'valkyrie/shrine/version'
+require 'valkyrie/storage/shrine'
+require 'valkyrie/shrine/checksum/base'
+require 'valkyrie/shrine/checksum/file_system'
+require 'valkyrie/shrine/checksum/s3'
+
+module Valkyrie
+  module Shrine
+    class Valkyrie::Shrine::IntegrityError < StandardError; end
+  end
+end

data/lib/valkyrie/shrine/checksum/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal:true
+
+module Valkyrie
+  module Shrine
+    module Checksum
+      class Base
+        def self.digest_class
+          Digest::SHA256
+        end
+
+        def digest_class
+          self.class.digest_class
+        end
+
+        def verify_checksum(io, result)
+          checksum_for(io) == calculate_checksum(result)
+        end
+
+        def checksum_for(io)
+          simple_digest(io)
+        end
+
+        def simple_digest(io)
+          digest_class.new.tap do |result|
+            io.rewind
+            while (chunk = io.read(16 * 1024))
+              result << chunk
+            end
+          end
+        end
+
+        # Subclass is expected to implement #calculate_checksum
+      end
+    end
+  end
+end

data/lib/valkyrie/shrine/checksum/file_system.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal:true
+
+module Valkyrie
+  module Shrine
+    module Checksum
+      class FileSystem < Base
+        def calculate_checksum(result)
+          checksum_for(result.io)
+        end
+      end
+    end
+  end
+end

data/lib/valkyrie/shrine/checksum/s3.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal:true
+
+module Valkyrie
+  module Shrine
+    module Checksum
+      class S3 < Base
+        attr_reader :threshold, :part_size
+
+        def self.digest_class
+          Digest::MD5
+        end
+
+        def initialize(threshold: 15 * 1024 * 1024, part_size: 5 * 1024 * 1024)
+          @threshold = threshold
+          @part_size = part_size
+        end
+
+        def calculate_checksum(result)
+          result.io.data[:object].data.etag.delete('"')
+        end
+
+        def checksum_for(io)
+          io.rewind
+          io.size < threshold ? simple_digest(io) : multipart_checksum(io)
+        end
+
+        private
+
+          def multipart_checksum(io)
+            parts = 0
+            checksums = []
+            while (chunk = io.read(part_size))
+              parts += 1
+              checksums << digest_class.digest(chunk)
+            end
+            [digest_class.hexdigest(checksums.join('')), parts.to_s].join('-')
+          end
+      end
+    end
+  end
+end

data/lib/valkyrie/shrine/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Valkyrie
+  module Shrine
+    VERSION = "0.1.0"
+  end
+end

data/lib/valkyrie/storage/shrine.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'shrine'
+require 'digest/md5'
+
+module Valkyrie
+  module Storage
+    class Shrine
+      PROTOCOL = 'shrine://'
+
+      attr_reader :shrine, :verifier
+
+      def initialize(shrine_storage, verifier = nil)
+        @shrine = shrine_storage
+        if verifier.nil?
+          try_to_find_verifier
+        else
+          @verifier = verifier
+        end
+      end
+
+      # Upload a file via the Shrine storage upload implementation
+      # @param file [IO]
+      # @param original_filename [String]
+      # @param resource [Valkyrie::Resource]
+      # @return [Valkyrie::StorageAdapter::StreamFile]
+      # @raise Valkyrie::Shrine::IntegrityError if #verify_checksum is defined
+      #   on the shrine object and the file and result digests do not match
+      def upload(file:, original_filename:, resource:, **upload_options)
+        identifier = resource.id.to_s
+        shrine.upload(file, identifier, **upload_options)
+        find_by(id: "#{PROTOCOL}#{identifier}").tap do |result|
+          if verifier
+            raise Valkyrie::Shrine::IntegrityError unless verifier.verify_checksum(file, result)
+          end
+        end
+      end
+
+      # Return the file associated with the given identifier
+      # @param id [Valkyrie::ID]
+      # @return [Valkyrie::StorageAdapter::StreamFile]
+      # @raise Valkyrie::StorageAdapter::FileNotFound if nothing is found
+      def find_by(id:)
+        Valkyrie::StorageAdapter::StreamFile.new(id: Valkyrie::ID.new(id.to_s), io: shrine.open(shrine_id_for(id)))
+      rescue Aws::S3::Errors::NoSuchKey
+        raise Valkyrie::StorageAdapter::FileNotFound
+      end
+
+      # @param id [Valkyrie::ID]
+      # @return [Boolean] true if this adapter can handle this type of identifier
+      def handles?(id:)
+        id.to_s.start_with?(PROTOCOL)
+      end
+
+      # Delete the file in S3 associated with the given identifier.
+      # @param id [Valkyrie::ID]
+      def delete(id:)
+        shrine.delete(shrine_id_for(id))
+      end
+
+      private
+
+        def try_to_find_verifier
+          class_const = shrine.class.name.split(/::/).last.to_sym
+          @verifier = Valkyrie::Shrine::Checksum.const_get(class_const).new if Valkyrie::Shrine::Checksum.const_defined?(class_const)
+        end
+
+        def shrine_id_for(id)
+          id.to_s.sub(/^#{PROTOCOL}/, '')
+        end
+    end
+  end
+end

data/valkyrie-shrine.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'valkyrie/shrine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'valkyrie-shrine'
+  spec.version       = Valkyrie::Shrine::VERSION
+  spec.authors       = ['Brendan Quinn']
+  spec.email         = ['brendan-quinn@northwestern.edu']
+
+  spec.summary       = 'Shrine storage adapter for Valkyrie'
+  spec.homepage      = 'https://github.com/samvera-labs/valkyrie-shrine'
+
+  # 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 'aws-sdk-s3', '~> 1'
+  spec.add_dependency 'shrine', '~> 2.0'
+  spec.add_dependency 'valkyrie', '~> 2.0.0.RC3'
+
+  spec.add_development_dependency 'bixby', '~> 2.0.0.pre.beta1'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: valkyrie-shrine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brendan Quinn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-07 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: valkyrie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.RC3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.RC3
+- !ruby/object:Gem::Dependency
+  name: bixby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre.beta1
+- !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: coveralls
+  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: pry
+  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: 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: 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'
+description: 
+email:
+- brendan-quinn@northwestern.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/valkyrie/shrine.rb
+- lib/valkyrie/shrine/checksum/base.rb
+- lib/valkyrie/shrine/checksum/file_system.rb
+- lib/valkyrie/shrine/checksum/s3.rb
+- lib/valkyrie/shrine/version.rb
+- lib/valkyrie/storage/shrine.rb
+- valkyrie-shrine.gemspec
+homepage: https://github.com/samvera-labs/valkyrie-shrine
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Shrine storage adapter for Valkyrie
+test_files: []