shrine-imgix 0.3.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 13821100dcfca77321605576fbcd0e605ad8b00d
-  data.tar.gz: 313318ca99ddec0836d2d67aa5aaa5844178f0bb
+SHA256:
+  metadata.gz: c27d8fee1e632bcdc8e1f062e57f5d77759288eb6f7aa5572f96cb008b8dc54c
+  data.tar.gz: '0862b624a88f39069147eefeacf47d1a1b721f42493bac7ae0d21f34005e6a63'
 SHA512:
-  metadata.gz: c89621b4f825f34ee15daa18804438d5978311bd116a86d20f59b947181531dbe1e4479dabd981531c662e1a3e66907658bcfea0e525a2505e73100b7c0c273c
-  data.tar.gz: ba3d4788f98c2ad94f0280b50944c373fcfbdaee8209109723e86f0f103eb0b9ce6483215d3faafaab8adda7d90e3b530e4d68ca6260fd6eabc29b1769e9d8a3
+  metadata.gz: b6d757e626f7ee32dc62df26e9387aaaf768560af18d9a878bc0195a8138524c011760b4f918248746a77086ccc579438180418393f05346bdb8f548499bdb95
+  data.tar.gz: 732edc00a874b470a71e42e03ca7606c8d1e8925957ba54baaa05893d7ba31085ad495cb5289be500c34381f4a666ac2b1d8f0d2b6631c9ff6198d4437af5e73

data/README.md

@@ -3,7 +3,7 @@
 Provides [Imgix] integration for [Shrine].
 
 Imgix is a service for processing images on the fly, and works with files
-stored on Amazon S3.
+stored on external services such as AWS S3 or Google Cloud Storage.
 
 ## Installation
 
@@ -11,60 +11,81 @@ stored on Amazon S3.
 gem "shrine-imgix"
 ```
 
-## Usage
+## Configuring
 
-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:
+Load the `imgix` plugin with Imgix client settings:
 
 ```rb
-require "shrine/storage/imgix"
-require "shrine/storage/s3"
-
-imgix = Shrine::Storage::Imgix.new(
-  storage:          Shrine::Storage::S3.new(**s3_options),
-  api_key:          "xzy123",
-  host:             "my-subdomain.imgix.net",
-  secure_url_token: "abc123", # optional
+Shrine.plugin :imgix, client: {
+  host:             "your-subdomain.imgix.net",
+  secure_url_token: "abc123",
+}
+```
+
+You can also pass in an `Imgix::Client` object directly:
+
+```rb
+require "imgix"
+
+imgix_client = Imgix::Client.new(
+  host:             "your-subdomain.imgix.net",
+  secure_url_token: "abc123",
 )
 
-Shrine.storages[:store] = imgix
+Shrine.plugin :imgix, client: imgix_client
 ```
 
-All options other than `:storage` are used for instantiating an `Imgix::Client`,
-so see the [imgix] gem for information about all possible options.
+### Path prefix
 
-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`:
+If you've configured a "Path Prefix" on your Imgix source, and you also have
+`:prefix` set on your Shrine storage, you'll need tell the `imgix` plugin to
+exclude the storage prefix from generated URLs:
 
 ```rb
-post.image.url(w: 150, h: 200, fit: "crop")
+Shrine.plugin :imgix, client: ..., prefix: false
+```
+
+## Usage
+
+You can generate an Imgix URL for a `Shrine::UploadedFile` object by calling
+`#imgix_url`:
+
+```rb
+photo.image.imgix_url(w: 150, h: 200, fit: "crop")
 #=> "http://my-subdomain.imgix.net/943kdfs0gkfg.jpg?w=150&h=200&fit=crop"
 ```
 
-See the [Imgix docs](https://www.imgix.com/docs/reference) for all available
-URL options.
+See the [Imgix docs][url reference] for all available URL options.
 
-## Development
+### Rails
 
-The tests for shrine-imgix uses S3, so you'll have to create an `.env` file with
-appropriate credentials:
+If you're using [imgix-rails] and want to use the `ix_*` helpers, you can use
+`#imgix_id` to retrieve the Imgix path:
 
-```sh
-# .env
-IMGIX_API_KEY="..."
-IMGIX_HOST="..."
-IMGIX_SECURE_URL_TOKEN="..." # optional
-S3_ACCESS_KEY_ID="..."
-S3_SECRET_ACCESS_KEY="..."
-S3_REGION="..."
-S3_BUCKET="..."
-S3_PREFIX="..."
+```erb
+<%= ix_image_tag photo.image.imgix_id, url_params: { w: 300, h: 500, fit: "crop" } %>
 ```
 
-Afterwards you can run the tests:
+### Purging
+
+If you want images to be automatically [purged][purging] from Imgix on
+deletion, you can set `:purge` to `true`:
+
+```rb
+Shrine.plugin :imgix, client: ..., purge: true
+```
+
+You can also purge manually with `Shrine::UploadedFile#imgix_purge`:
+
+```rb
+photo.image.imgix_purge
+```
+
+Note that purging requires passing the `:api_key` option to your Imgix client.
+
+## Development
+
+You can run the test suite with:
 
 ```sh
 $ bundle exec rake test
@@ -75,6 +96,8 @@ $ bundle exec rake test
 [MIT](http://opensource.org/licenses/MIT)
 
 [Imgix]: https://www.imgix.com/
-[Shrine]: https://github.com/janko-m/shrine
+[Shrine]: https://github.com/janko/shrine
 [imgix]: https://github.com/imgix/imgix-rb
-[Imgix documentation]: https://www.imgix.com/docs
+[url reference]: https://docs.imgix.com/apis/url
+[imgix-rails]: https://github.com/imgix/imgix-rails
+[purging]: https://docs.imgix.com/setup/purging-images

data/lib/shrine/plugins/imgix.rb

@@ -0,0 +1,61 @@
+require "imgix"
+
+class Shrine
+  module Plugins
+    module Imgix
+      def self.configure(uploader, **opts)
+        opts[:client] = ::Imgix::Client.new(opts[:client]) if opts[:client].is_a?(Hash)
+
+        uploader.opts[:imgix] ||= { prefix: true, purge: false }
+        uploader.opts[:imgix].merge!(**opts)
+
+        fail Error, ":client is required for imgix plugin" unless uploader.imgix_client
+      end
+
+      module ClassMethods
+        def imgix_client
+          opts[:imgix][:client]
+        end
+      end
+
+      module FileMethods
+        def imgix_url(**options)
+          imgix_client.path(imgix_id).to_url(**options)
+        end
+
+        def delete
+          super
+          imgix_purge if imgix_purge?
+        end
+
+        def imgix_purge
+          imgix_client.purge(imgix_id)
+        end
+
+        def imgix_id
+          if imgix_prefix? && storage.respond_to?(:prefix)
+            [*storage.prefix, id].join("/")
+          else
+            id
+          end
+        end
+
+        private
+
+        def imgix_client
+          shrine_class.imgix_client
+        end
+
+        def imgix_prefix?
+          shrine_class.opts[:imgix][:prefix]
+        end
+
+        def imgix_purge?
+          shrine_class.opts[:imgix][:purge]
+        end
+      end
+    end
+
+    register_plugin(:imgix, Imgix)
+  end
+end

data/lib/shrine/storage/imgix.rb

@@ -1,8 +1,9 @@
 require "imgix"
-require "forwardable"
 require "net/http"
 require "uri"
 
+warn "Shrine::Storage::Imgix is deprecated and will be removed in next major version. Use the new :imgix plugin instead."
+
 class Shrine
   module Storage
     class Imgix
@@ -13,33 +14,58 @@ class Shrine
       # We initialize the Imgix client, and save the storage. We additionally
       # save the token as well, because `Imgix::Client` doesn't provide a
       # reader for the token.
-      def initialize(storage:, **options)
+      def initialize(storage:, include_prefix: false, **options)
         @client = ::Imgix::Client.new(options)
         @api_key = options.fetch(:api_key)
         @storage = storage
+        @include_prefix = include_prefix
+
+        instance_eval do
+          # Purges the file from the source storage after moving it.
+          def move(io, id, **options)
+            @storage.move(io, id, **options)
+            io.storage.purge(io.id) if io.storage.is_a?(Storage::Imgix)
+          end if @storage.respond_to?(:move)
+
+          def movable?(io, id)
+            @storage.movable?(io, id)
+          end if @storage.respond_to?(:movable?)
+
+          def download(id)
+            @storage.download(id)
+          end if @storage.respond_to?(:download)
+
+          def presign(*args)
+            @storage.presign(*args)
+          end if @storage.respond_to?(:presign)
+
+          def clear!(*args)
+            @storage.clear!(*args)
+          end if @storage.respond_to?(:clear!)
+        end
       end
 
-      # We delegate all methods that are the same.
-      extend Forwardable
-      delegate [:upload, :download, :open, :read, :exists?, :clear!] => :storage
+      def upload(io, id, **options)
+        @storage.upload(io, id, **options)
+      end
 
-      # Purges the file from the source storage after moving it.
-      def move(io, id, **options)
-        @storage.move(io, id, **options)
-        io.storage.purge(io.id) if io.storage.is_a?(Storage::Imgix)
+      def open(id)
+        @storage.open(id)
       end
 
-      def movable?(io, id)
-        @storage.movable?(io, id) if @storage.respond_to?(:movable?)
+      def exists?(id)
+        @storage.exists?(id)
       end
 
-      def multi_delete(ids)
-        if @storage.respond_to?(:multi_delete)
-          @storage.multi_delete(ids)
-          ids.each { |id| purge(id) }
-        else
-          ids.each { |id| delete(id) }
-        end
+      # Generates an Imgix URL to the file. All options passed in will be
+      # transformed into URL parameters, check out the [reference] for all
+      # available query parameters.
+      #
+      # [reference]: https://www.imgix.com/docs/reference
+      def url(id, **options)
+        id = [*@storage.prefix, id].join("/") if @include_prefix
+
+        client.path(id).to_url(**options)
       end
 
       # Purges the deleted file.
@@ -56,15 +82,6 @@ class Shrine
         post(uri, "url" => url(id))
       end
 
-      # Generates an Imgix URL to the file. All options passed in will be
-      # transformed into URL parameters, check out the [reference] for all
-      # available query parameters.
-      #
-      # [reference]: https://www.imgix.com/docs/reference
-      def url(id, **options)
-        client.path(id).to_url(**options)
-      end
-
       private
 
       def post(uri, params = {})

data/shrine-imgix.gemspec

@@ -1,23 +1,22 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-imgix"
-  gem.version       = "0.3.0"
+  gem.version       = "0.5.2"
 
   gem.required_ruby_version = ">= 2.1"
 
   gem.summary      = "Provides Imgix integration for Shrine."
-  gem.homepage     = "https://github.com/janko-m/shrine-imgix"
+  gem.homepage     = "https://github.com/shrinerb/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.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "*.gemspec"]
   gem.require_path = "lib"
 
-  gem.add_dependency "shrine", "~> 2.0"
-  gem.add_dependency "imgix", "~> 1.0"
+  gem.add_dependency "shrine", ">= 2.0", "< 4"
+  gem.add_dependency "imgix", ">= 1.2", "< 5"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"
-  gem.add_development_dependency "dotenv"
-  gem.add_development_dependency "aws-sdk", "~> 2.1"
+  gem.add_development_dependency "mocha"
 end

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: shrine-imgix
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: imgix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +79,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,20 +92,6 @@ dependencies:
     - - ">="
       - !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'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
 description: 
 email:
 - janko.marohnic@gmail.com
@@ -103,9 +101,10 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- lib/shrine/plugins/imgix.rb
 - lib/shrine/storage/imgix.rb
 - shrine-imgix.gemspec
-homepage: https://github.com/janko-m/shrine-imgix
+homepage: https://github.com/shrinerb/shrine-imgix
 licenses:
 - MIT
 metadata: {}
@@ -124,8 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Provides Imgix integration for Shrine.