shrine-imgix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8f5f6f3c73706b3e362d2c8cb015d6bc8a3ae38
+  data.tar.gz: 5c10ec076e3dfe3d17be76f2490255612de1cccd
+SHA512:
+  metadata.gz: 5926511ad322c97686b4bdfea29b1cf950341b3e7ad3bbbe9c56d1550dd0cba023ad0f347558556775a8625ef7ab10aca5e0c8c86e0a49293dc445de5240dcad
+  data.tar.gz: 37d13abbba5afe89a4f2f656cf2e7a02c13eb40ae2985c4b7e612a25c47331a80840919645c12e424778a94df467ba1cadfe570282ffe89e93b58eb6a20224a9

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,72 @@
+# Shrine::Imgix
+
+Provides [Imgix] integration for [Shrine].
+
+## Installation
+
+```ruby
+gem "shrine-imgix"
+```
+
+## Usage
+
+Imgix doesn't upload files directly, but instead it transfers images from
+various sources (S3, Web Folder or Web Proxy), so you first need to set that up
+(see the [Imgix documentation]). After this is set up, the Imgix Shrine
+"storage" is used as a wrapper around the main storage of the source:
+
+```rb
+require "shrine/storage/imgix"
+require "shrine/storage/s3"
+
+s3 = Shrine::Storage::S3.new(**s3_options)
+imgix = Shrine::Storage::Imgix.new(
+  storage: s3,
+  host: "my-subdomain.imgix.net",
+  token: "abc123",
+)
+
+Shrine.storages[:store] = imgix
+```
+
+All options other than `:storage` are used for instantiating an `Imgix::Client`,
+so see the [imgix] gem for information about all possible options.
+
+All storage actions are forwarded to the main storage, and deleted files are
+automatically purged from Imgix. The only method that the Imgix storage
+overrides is, of course, `#url`:
+
+```rb
+post.image.url(w: 150, h: 200, fit: "crop")
+#=> "http://my-subdomain.imgix.net/943kdfs0gkfg.jpg?w=150&h=200&fit=crop"
+```
+
+## Development
+
+The tests for shrine-imgix uses S3, so you'll have to create an `.env` file with
+appropriate credentials:
+
+```sh
+# .env
+IMGIX_API_KEY="..."
+IMGIX_HOST="..."
+S3_ACCESS_KEY_ID="..."
+S3_SECRET_ACCESS_KEY="..."
+S3_REGION="..."
+S3_BUCKET="..."
+```
+
+Afterwards you can run the tests:
+
+```rb
+bundle exec rake test
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)
+
+[Imgix]: https://www.imgix.com/
+[Shrine]: https://github.com/janko-m/shrine
+[imgix]: https://github.com/imgix/imgix-rb
+[Imgix documentation]: https://www.imgix.com/docs

data/lib/shrine/storage/imgix.rb

@@ -0,0 +1,57 @@
+require "imgix"
+require "forwardable"
+require "net/http"
+require "uri"
+
+class Shrine
+  module Storage
+    class Imgix
+      PURGE_URL = "https://api.imgix.com/v2/image/purger"
+
+      attr_reader :client, :storage
+
+      def initialize(storage:, **options)
+        @client = ::Imgix::Client.new(options)
+        @token = options[:token]
+        @storage = storage
+      end
+
+      extend Forwardable
+      delegate [:upload, :download, :open, :read, :exists?, :clear!] => :storage
+
+      def move(io, id, metadata = {})
+        @storage.move(io, id, metadata)
+        purge(io.id)
+      end
+
+      def movable?(io, id)
+        @storage.movable?(io, id) if @storage.respond_to?(:movable?)
+      end
+
+      def delete(id)
+        @storage.delete(id)
+        purge(id)
+      end
+
+      # Imgix-specific method
+      def purge(id)
+        uri = URI.parse(PURGE_URL)
+        uri.user = @token
+
+        post(uri, "url" => url(id))
+      end
+
+      def url(id, **options)
+        client.path(id).to_url(**options)
+      end
+
+      private
+
+      def post(uri, params = {})
+        response = Net::HTTP.post_form(uri, params)
+        response.error! if (400..599).cover?(response.code.to_i)
+        response
+      end
+    end
+  end
+end

data/shrine-imgix.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name          = "shrine-imgix"
+  gem.version       = "0.1.0"
+
+  gem.required_ruby_version = ">= 2.1"
+
+  gem.summary      = "Provides Imgix integration for Shrine."
+  gem.homepage     = "https://github.com/janko-m/shrine-imgix"
+  gem.authors      = ["Janko Marohnić"]
+  gem.email        = ["janko.marohnic@gmail.com"]
+  gem.license      = "MIT"
+
+  gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "shrine-imgix.gemspec"]
+  gem.require_path = "lib"
+
+  gem.add_dependency "imgix"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "shrine"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "dotenv"
+  gem.add_development_dependency "aws-sdk", "~> 2.1.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: shrine-imgix
+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: imgix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '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: '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: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: 
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/shrine/storage/imgix.rb
+- shrine-imgix.gemspec
+homepage: https://github.com/janko-m/shrine-imgix
+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 Imgix integration for Shrine.
+test_files: []
+has_rdoc: