shrine-fog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9190a56cee70da72f752a7cdb9f0f499b48467bf
+  data.tar.gz: 44f829d6eb84aae145249df2fbaefb747f2df8b3
+SHA512:
+  metadata.gz: 3cff6c69c740f5051afc4e723feb600fb17a7c2f1a69390bcb7ac78d4586797591f5b99dcc06c51018f91bf8e67944b5b635d00f45a40aba0a8e36d29d5b911b
+  data.tar.gz: 41d45e6eb1b5c3a0e7d69ee8696719a89c8316bb4176c06acebb7d086c75cc841f2ac00fe4030fe5141c09050ccc819e87e82f9317e91a558619ba49a5d0e157

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Janko Marohnić
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Shrine::Fog
+
+Provides [Fog] storage for [Shrine].
+
+## Installation
+
+```ruby
+gem "shrine-fog"
+gem "fog-xyz # Fog gem for the storage you want to use
+```
+
+## Usage
+
+Require the appropriate Fog gem, and assign the parameters for initializing
+the storage:
+
+```rb
+require "fog/google"
+
+Shrine.storages[:store] = Shrine::Storage::Fog.new(
+  provider: "Google",                                    #
+  google_storage_access_key_id: "ACCESS_KEY_ID",         # Fog credentials
+  google_storage_secret_access_key: "SECRET_ACCESS_KEY", #
+  directory: "uploads",
+)
+```
+
+You can also assign a Fog storage object as the `:connection`:
+
+```rb
+require "fog/google"
+
+google = Fog::Storage.new(
+  provider: "Google",
+  google_storage_access_key_id: "ACCESS_KEY_ID",
+  google_storage_secret_access_key: "SECRET_ACCESS_KEY",
+)
+
+Shrine.storages[:store] = Shrine::Storage::Fog.new(
+  connection: google,
+  directory: "uploads",
+)
+```
+
+## S3 or Filesystem
+
+If you want to store your files to Amazon S3 or the filesystem, you should use
+the storages that ship with Shrine (instead of [fog-aws] or [fog-local]) as
+they are much more advanced.
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT).
+
+[Fog]: http://fog.io/
+[Shrine]: https://github.com/janko-m/shrine
+[fog-aws]: https://github.com/fog/fog-aws
+[fog-local]: https://github.com/fog/fog-local

data/lib/shrine/storage/fog.rb

@@ -0,0 +1,95 @@
+require "down"
+
+class Shrine
+  module Storage
+    class Fog
+      attr_reader :connection, :directory, :prefix
+
+      def initialize(directory:, prefix: nil, public: true, connection: nil, **options)
+        @connection = connection || ::Fog::Storage.new(options)
+        @directory = @connection.directories.new(key: directory)
+        @prefix = prefix
+        @public = public
+      end
+
+      def upload(io, id, metadata = {})
+        if copyable?(io)
+          copy(io, id, metadata)
+        else
+          put(io, id, metadata)
+        end
+      end
+
+      def download(id)
+        Down.download(url(id))
+      end
+
+      def open(id)
+        download(id)
+      end
+
+      def read(id)
+        get(id).body
+      end
+
+      def exists?(id)
+        !!head(id)
+      end
+
+      def delete(id)
+        head(id).destroy
+      end
+
+      def url(id, **options)
+        head(id).public_url
+      end
+
+      def clear!(confirm = nil)
+        raise Shrine::Confirm unless confirm == :confirm
+        list.each(&:destroy)
+      end
+
+      protected
+
+      def get(id)
+        directory.files.get(path(id))
+      end
+
+      def head(id)
+        directory.files.head(path(id))
+      end
+
+      def provider
+        connection.class
+      end
+
+      private
+
+      def list
+        directory.files.select { |file| file.key.start_with?(prefix.to_s) }
+      end
+
+      def path(id)
+        [*prefix, id].join("/")
+      end
+
+      def put(io, id, metadata = {})
+        options = {key: path(id), body: io, public: @public}
+        options[:content_type] = metadata["mime_type"]
+
+        directory.files.create(options)
+        io.rewind
+      end
+
+      def copy(io, id, metadata = {})
+        io.storage.head(io.id).copy(directory.key, path(id))
+      end
+
+      def copyable?(io)
+        io.respond_to?(:storage) &&
+        io.storage.is_a?(Storage::Fog) &&
+        io.storage.provider == provider
+      end
+    end
+  end
+end

data/shrine-fog.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |gem|
+  gem.name         = "shrine-fog"
+  gem.version      = "0.1.0"
+
+  gem.required_ruby_version = ">= 2.1"
+
+  gem.summary      = "Provides Fog storage for Shrine."
+  gem.description  = "Provides Fog storage for Shrine."
+  gem.homepage     = "https://github.com/janko-m/shrine-fog"
+  gem.authors      = ["Janko Marohnić"]
+  gem.email        = ["janko.marohnic@gmail.com"]
+  gem.license      = "MIT"
+
+  gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine-fog.gemspec"]
+  gem.require_path = "lib"
+
+  gem.add_development_dependency "down", ">= 1.0.3"
+
+  gem.add_development_dependency "fog-aws"
+  gem.add_development_dependency "mime-types"
+  gem.add_development_dependency "dotenv"
+  gem.add_development_dependency "shrine"
+  gem.add_development_dependency "minitest", "~> 5.8"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: shrine-fog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-05 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.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: fog-aws
+  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: 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: shrine
+  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: 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'
+description: Provides Fog storage for Shrine.
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/shrine/storage/fog.rb
+- shrine-fog.gemspec
+homepage: https://github.com/janko-m/shrine-fog
+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: Provides Fog storage for Shrine.
+test_files: []
+has_rdoc: