shrine 0.9.0

data/lib/shrine/storage/linter.rb

@@ -0,0 +1,94 @@
+require "shrine"
+
+require "forwardable"
+require "stringio"
+require "tempfile"
+
+class Shrine
+  # Error which is thrown when Storage::Linter fails.
+  class LintError < Error
+    attr_reader :errors
+
+    def initialize(errors)
+      @errors = errors
+      super(errors.to_s)
+    end
+  end
+
+  module Storage
+    # Checks if the storage conforms to Shrine's specification. If the check
+    # fails a LintError is raised.
+    class Linter
+      def self.call(storage)
+        new(storage).call
+      end
+
+      def initialize(storage)
+        @storage = storage
+        @errors = []
+      end
+
+      def call
+        fakeio = FakeIO.new("image")
+
+        storage.upload(fakeio, "foo.jpg", {"mime_type" => "image/jpeg"})
+        error! "#upload doesn't rewind the file" if !(fakeio.read == "image")
+
+        file = storage.download("foo.jpg")
+        error! "#download doesn't return a Tempfile" if !file.is_a?(Tempfile)
+        error! "#download doesn't return the uploaded file" if !(file.read == "image")
+
+        if storage.respond_to?(:move)
+          if storage.respond_to?(:movable?)
+            error! "#movable? doesn't accept 2 arguments" if !(storage.method(:movable?).arity == 2)
+            error! "#move doesn't accept 3 arguments" if !(storage.method(:move).arity == -3)
+          else
+            error! "doesn't respond to #movable?" if !storage.respond_to?(:movable?)
+          end
+        end
+
+        begin
+          Shrine.io!(storage.open("foo.jpg"))
+        rescue Shrine::InvalidFile => error
+          error! "#open doesn't return a valid IO object"
+        end
+
+        error! "#read doesn't return content of the uploaded file" if !(storage.read("foo.jpg") == "image")
+        error! "#exists? returns false for a file that was uploaded" if !storage.exists?("foo.jpg")
+        error! "#url doesn't return a string" if !storage.url("foo.jpg", {}).is_a?(String)
+
+        storage.delete("foo.jpg")
+        error! "#exists? returns true for a file that was deleted" if storage.exists?("foo.jpg")
+
+        begin
+          storage.clear!
+          error! "#clear! should raise Shrine::Confirm unless :confirm is passed in"
+        rescue Shrine::Confirm
+        end
+
+        storage.upload(FakeIO.new("image"), "foo.jpg", {"mime_type" => "image/jpeg"})
+        storage.clear!(:confirm)
+        error! "a file still #exists? after #clear! was called" if storage.exists?("foo.jpg")
+
+        raise LintError.new(@errors) if @errors.any?
+      end
+
+      private
+
+      def error!(message)
+        @errors << message
+      end
+
+      attr_reader :storage
+
+      class FakeIO
+        def initialize(content)
+          @io = StringIO.new(content)
+        end
+
+        extend Forwardable
+        delegate Shrine::IO_METHODS.keys => :@io
+      end
+    end
+  end
+end

data/lib/shrine/storage/s3.rb

@@ -0,0 +1,118 @@
+require "aws-sdk"
+require "down"
+
+class Shrine
+  module Storage
+    class S3
+      attr_reader :prefix, :bucket, :s3
+
+      # Example:
+      #
+      #     Shrine::Storage::S3.new(
+      #       access_key_id: "xyz",
+      #       secret_access_key: "abc",
+      #       region: "eu-west-1"
+      #       bucket: "my-app",
+      #       prefix: "cache",
+      #     )
+      #
+      # The above storage will store file into the "my-app" bucket in the
+      # "cache" directory.
+      def initialize(bucket:, prefix: nil, **s3_options)
+        @prefix = prefix
+        @s3 = Aws::S3::Resource.new(s3_options)
+        @bucket = @s3.bucket(bucket)
+      end
+
+      # If the file is an UploadedFile from S3, issues a COPY command, otherwise
+      # uploads the file.
+      #
+      # It assigns the correct "Content-Type" taken from the MIME type, because
+      # by default S3 sets everything to "application/octet-stream".
+      def upload(io, id, metadata = {})
+        options = {content_type: metadata["mime_type"]}
+
+        if copyable?(io)
+          object(id).copy_from(io.storage.object(io.id), **options)
+        else
+          object(id).put(body: io, **options)
+          io.rewind
+        end
+      end
+
+      # Downloads the file from S3, and returns a `Tempfile`.
+      def download(id)
+        Down.download(url(id))
+      end
+
+      # Alias for #download.
+      def open(id)
+        download(id)
+      end
+
+      # Returns the contents of the file as a String.
+      def read(id)
+        object(id).get.body.read
+      end
+
+      # Returns true file exists on S3.
+      def exists?(id)
+        object(id).exists?
+      end
+
+      # Deletes the file from S3.
+      def delete(id)
+        object(id).delete
+      end
+
+      # This is called when multiple files are being deleted at once. Issues
+      # a single MULTI DELETE command.
+      def multi_delete(ids)
+        bucket.delete_objects(delete: {objects: ids.map { |id| {key: id} }})
+      end
+
+      # Returns the presigned URL to the file. If `download: true` is passed,
+      # returns a forced download link.
+      def url(id, download: nil, **options)
+        options[:response_content_disposition] = "attachment" if download
+        object(id).presigned_url(:get, **options)
+      end
+
+      # Deletes all files from the storage (requires confirmation).
+      def clear!(confirm = nil)
+        raise Shrine::Confirm unless confirm == :confirm
+        @bucket.clear!
+      end
+
+      # Returns a signature for direct uploads. Internally it calls
+      # [`Aws::S3::Bucket#presigned_post`], and forwards any additional options
+      # to it.
+      #
+      # [`Aws::S3::Bucket#presigned_post`]: http://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Bucket.html#presigned_post-instance_method
+      def presign(id, **options)
+        @bucket.presigned_post(key: object(id).key, **options)
+      end
+
+      protected
+
+      # Returns the S3 object.
+      def object(id)
+        @bucket.object([*prefix, id].join("/"))
+      end
+
+      # This is used to check whether an S3 file is copyable.
+      def access_key_id
+        @s3.client.config.credentials.access_key_id
+      end
+
+      private
+
+      # The file is copyable if it's on S3 and on the same Amazon account.
+      def copyable?(io)
+        io.respond_to?(:storage) &&
+        io.storage.is_a?(Storage::S3) &&
+        io.storage.access_key_id == access_key_id
+      end
+    end
+  end
+end

data/lib/shrine/version.rb

@@ -0,0 +1,14 @@
+class Shrine
+  def self.version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 9
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/shrine.gemspec

@@ -0,0 +1,46 @@
+require "./lib/shrine/version"
+
+Gem::Specification.new do |gem|
+  gem.name         = "shrine"
+  gem.version      = Shrine.version
+
+  gem.required_ruby_version = ">= 2.1"
+
+  gem.summary      = "Toolkit for file uploads in Ruby"
+  gem.description  = "Toolkit for file uploads in Ruby"
+  gem.homepage     = "https://github.com/janko-m/shrine"
+  gem.authors      = ["Janko Marohnić"]
+  gem.email        = ["janko.marohnic@gmail.com"]
+  gem.license      = "MIT"
+
+  gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine.gemspec", "doc/*.md"]
+  gem.require_path = "lib"
+
+  gem.add_dependency "down", ">= 1.0.2"
+
+  gem.add_development_dependency "minitest", "~> 5.8"
+  gem.add_development_dependency "minitest-hooks", "~> 1.3.0"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "vcr", "~> 2.9"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "rack-test"
+  gem.add_development_dependency "dotenv"
+
+  gem.add_development_dependency "roda"
+  gem.add_development_dependency "ruby-filemagic", "~> 0.7" unless RUBY_ENGINE == "jruby"
+  gem.add_development_dependency "mimemagic"
+  gem.add_development_dependency "mime-types"
+  gem.add_development_dependency "fastimage"
+  gem.add_development_dependency "thread", "~> 0.2"
+  gem.add_development_dependency "aws-sdk", "~> 2.1"
+  gem.add_development_dependency "image_processing", ">= 0.2.4"
+  gem.add_development_dependency "mini_magick", ">= 4.3.5"
+
+  gem.add_development_dependency "sequel"
+  gem.add_development_dependency "activerecord"
+  unless RUBY_ENGINE == "jruby"
+    gem.add_development_dependency "sqlite3"
+  else
+    gem.add_development_dependency "activerecord-jdbcsqlite3-adapter"
+  end
+end

metadata

@@ -0,0 +1,364 @@
+--- !ruby/object:Gem::Specification
+name: shrine
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: rack-test
+  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: dotenv
+  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: roda
+  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: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  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: mime-types
+  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: fastimage
+  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: thread
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.5
+- !ruby/object:Gem::Dependency
+  name: sequel
+  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: activerecord
+  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: sqlite3
+  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: Toolkit for file uploads in Ruby
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- doc/creating_plugins.md
+- doc/creating_storages.md
+- doc/direct_s3.md
+- doc/migrating_storage.md
+- doc/regenerating_versions.md
+- lib/shrine.rb
+- lib/shrine/plugins/activerecord.rb
+- lib/shrine/plugins/background_helpers.rb
+- lib/shrine/plugins/cached_attachment_data.rb
+- lib/shrine/plugins/data_uri.rb
+- lib/shrine/plugins/default_storage.rb
+- lib/shrine/plugins/delete_invalid.rb
+- lib/shrine/plugins/determine_mime_type.rb
+- lib/shrine/plugins/direct_upload.rb
+- lib/shrine/plugins/dynamic_storage.rb
+- lib/shrine/plugins/hooks.rb
+- lib/shrine/plugins/included.rb
+- lib/shrine/plugins/keep_files.rb
+- lib/shrine/plugins/logging.rb
+- lib/shrine/plugins/migration_helpers.rb
+- lib/shrine/plugins/moving.rb
+- lib/shrine/plugins/multi_delete.rb
+- lib/shrine/plugins/parallelize.rb
+- lib/shrine/plugins/pretty_location.rb
+- lib/shrine/plugins/recache.rb
+- lib/shrine/plugins/remote_url.rb
+- lib/shrine/plugins/remove_attachment.rb
+- lib/shrine/plugins/restore_cached.rb
+- lib/shrine/plugins/sequel.rb
+- lib/shrine/plugins/store_dimensions.rb
+- lib/shrine/plugins/validation_helpers.rb
+- lib/shrine/plugins/versions.rb
+- lib/shrine/storage/file_system.rb
+- lib/shrine/storage/linter.rb
+- lib/shrine/storage/s3.rb
+- lib/shrine/version.rb
+- shrine.gemspec
+homepage: https://github.com/janko-m/shrine
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Toolkit for file uploads in Ruby
+test_files: []
+has_rdoc: