valkyrie-shrine 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43acefce16f29dafdd2627b82dbb79baa25e11e8b2503f33b1a49b8e4684fa81
-  data.tar.gz: 8cdd2a2fb849326f7945f9a4c20cf064c755d4bb1aac5371119d3a9db90ac9e3
+  metadata.gz: d5d7dc948b6f87906f3d62207c2d9a3642ee52b34ddabebdefbe5dcde3eb47f4
+  data.tar.gz: acc1806a446bfd8e8c4e1f16a9b2e9a475ab3309296f8ba44a0cb6e3b255494c
 SHA512:
-  metadata.gz: f7b3a2a459b419e0e046be241b1e5d32b063de7704e211672a7823430d16c47d22cf72af8f2edc43c6023d14f49b60dff781144486e2d06ef9be637ebc02b557
-  data.tar.gz: 4768279b6f1ef8b1872cefd71e0114397a2a9029d5978dc196ce43acdb97ff4dfdbdda062f5854ed92dbeb553e182564ed91b22ca60af225e7c04a88bd725d4d
+  metadata.gz: 9cf334edc64829d8ae960e8e35037cdce590edcfc08b6f29fcbb0464337571bd015b938d38a7d0e0b7f77d7f2474a695a2f829c22884c91362ecba3be583bff7
+  data.tar.gz: 96b16e3d76a6d670fbe1bd46393b8ba6ad0bdd6b79678c6100f305c5b5347c2a91a02679d21ebe22914e1e3d992094512d7821e142b3d539c78b439719036f98

data/README.md

@@ -21,8 +21,8 @@ Follow the Valkyrie [README](https://github.com/samvera-labs/valkyrie) to get a
   # 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'
+  require 'valkyrie/storage/shrine/checksum/s3'
+  require 'valkyrie/storage/shrine/checksum/file_system'
 
   Shrine.storages = {
     file: Shrine::Storage::FileSystem.new("public", prefix: "uploads"),
@@ -38,6 +38,8 @@ Follow the Valkyrie [README](https://github.com/samvera-labs/valkyrie) to get a
   )
 ```
 
+Then proceed to configure your application following the [Valkyrie documentation](https://github.com/samvera-labs/valkyrie#sample-configuration-configvalkyrieyml) 
+
 ## 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.
@@ -46,4 +48,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/valkyrie-shrine.
+Bug reports and pull requests are welcome on GitHub at https://github.com/samvera-labs/valkyrie-shrine.

data/circle.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.6.1
+      - image: cimg/ruby:2.6.1
         environment:
           BUNDLER_VERSION: 2.0.1
     steps:
@@ -26,4 +26,4 @@ jobs:
           command: bundle exec rubocop
       - run:
           name: Run Specs
-          command: bundle exec rspec spec
+          command: bundle exec rspec spec

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

@@ -16,7 +16,8 @@ module Valkyrie
         end
 
         def calculate_checksum(result)
-          result.io.data[:object].data.etag.delete('"')
+          result.io.data[:object]&.data&.etag&.delete('"') ||
+            checksum_for(result.io)
         end
 
         def checksum_for(io)

data/lib/valkyrie/shrine/version.rb

@@ -2,6 +2,6 @@
 
 module Valkyrie
   module Shrine
-    VERSION = "0.1.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/valkyrie/storage/shrine.rb

@@ -8,10 +8,43 @@ module Valkyrie
     class Shrine
       PROTOCOL = 'shrine://'
 
-      attr_reader :shrine, :verifier
+      attr_reader :shrine, :verifier, :path_generator, :identifier_prefix
 
-      def initialize(shrine_storage, verifier = nil)
+      class IDPathGenerator
+        def initialize(base_path: nil)
+          @base_path = base_path
+        end
+
+        def generate(resource:, file:, original_filename:)
+          resource.id.to_s
+        end
+      end
+
+      class DelayedDownload
+        attr_reader :shrine, :id
+        def initialize(shrine, id)
+          @shrine = shrine
+          @id = id
+        end
+
+        def file
+          @file ||= shrine.open(id)
+        end
+
+        def method_missing(meth_name, *args, &block)
+          return super unless file.respond_to?(meth_name)
+          file.send(meth_name, *args, &block)
+        end
+
+        def respond_to_missing?(meth_name, include_private = false)
+          file.respond_to?(meth_name) || super
+        end
+      end
+
+      def initialize(shrine_storage, verifier = nil, path_generator = IDPathGenerator, identifier_prefix: nil)
+        @path_generator = path_generator.new(base_path: "")
         @shrine = shrine_storage
+        @identifier_prefix = identifier_prefix
         if verifier.nil?
           try_to_find_verifier
         else
@@ -27,9 +60,12 @@ module Valkyrie
       # @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
+        # S3 adapter validates options, so we have to remove this one used in
+        # the shared specs.
+        upload_options.delete(:fake_upload_argument)
+        identifier = path_generator.generate(resource: resource, file: file, original_filename: original_filename).to_s
         shrine.upload(file, identifier, **upload_options)
-        find_by(id: "#{PROTOCOL}#{identifier}").tap do |result|
+        find_by(id: "#{protocol_with_prefix}#{identifier}").tap do |result|
           if verifier
             raise Valkyrie::Shrine::IntegrityError unless verifier.verify_checksum(file, result)
           end
@@ -41,7 +77,8 @@ module Valkyrie
       # @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)))
+        raise Valkyrie::StorageAdapter::FileNotFound unless shrine.exists?(shrine_id_for(id))
+        Valkyrie::StorageAdapter::StreamFile.new(id: Valkyrie::ID.new(id.to_s), io: DelayedDownload.new(shrine, shrine_id_for(id)))
       rescue Aws::S3::Errors::NoSuchKey
         raise Valkyrie::StorageAdapter::FileNotFound
       end
@@ -49,7 +86,7 @@ module Valkyrie
       # @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)
+        id.to_s.start_with?(protocol_with_prefix)
       end
 
       # Delete the file in S3 associated with the given identifier.
@@ -66,7 +103,11 @@ module Valkyrie
         end
 
         def shrine_id_for(id)
-          id.to_s.sub(/^#{PROTOCOL}/, '')
+          id.to_s.sub(/^#{protocol_with_prefix}/, '')
+        end
+
+        def protocol_with_prefix
+          [identifier_prefix, PROTOCOL].compact.join("-")
         end
     end
   end

data/valkyrie-shrine.gemspec

@@ -7,6 +7,7 @@ require 'valkyrie/shrine/version'
 Gem::Specification.new do |spec|
   spec.name          = 'valkyrie-shrine'
   spec.version       = Valkyrie::Shrine::VERSION
+  spec.license       = 'Apache-2.0'
   spec.authors       = ['Brendan Quinn']
   spec.email         = ['brendan-quinn@northwestern.edu']
 
@@ -23,15 +24,16 @@ Gem::Specification.new do |spec|
   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_dependency 'shrine', '>= 2.0', '< 4.0'
+  spec.add_dependency 'valkyrie', '> 1.0'
 
   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 'coveralls', '~> 0.8.3'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'actionpack'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valkyrie-shrine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Brendan Quinn
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -28,30 +28,36 @@ dependencies:
   name: shrine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: valkyrie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 2.0.0.RC3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 2.0.0.RC3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bixby
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +90,16 @@ dependencies:
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +132,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +170,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: []
@@ -190,9 +210,10 @@ files:
 - lib/valkyrie/storage/shrine.rb
 - valkyrie-shrine.gemspec
 homepage: https://github.com/samvera-labs/valkyrie-shrine
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,8 +228,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Shrine storage adapter for Valkyrie
 test_files: []