imgix-rails 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 306dac4865fab9184761f142d5daf2b9d25997d7
-  data.tar.gz: b92a0db152ef14569cc5740afa68e5fcaef2bf47
+  metadata.gz: 36823acfaa06b6d8dd2ce8bcebfc2cb55f4b97f0
+  data.tar.gz: 27cb575d84e29fa8d76fec5aaf47f81a82d283f3
 SHA512:
-  metadata.gz: 9d6386bd51b1f8bbedea03ca2d397b115b74fea3cc7d8273c114bb3790557011a17526d462e6d2c48d7f71a1575c8a4ad97b02460e187e627a792351ac67994d
-  data.tar.gz: 66ced9282a5136977b30be7ad62dc39e6c492293a4d5b68d43905b5a05237d0c12afcd8e7916015bc3931a063a1175ac9ab560e5a4db1230267847fb46462e44
+  metadata.gz: b3a6719de13260cb1c411f203382ddaf55733f62ee7b6305b85c038636eb20506c47441c72a9318ae790d6f4823d23f9aee9182b9e9052054d5e9857a9631761
+  data.tar.gz: e6e45549cac2f1738c5930936e224673b4786acd402bce23960d7554798ffbbe909361d49dbcd70368da1bb526b569aa56a4a769d4a5cb7c225890e4832935d8

data/README.md

@@ -38,7 +38,7 @@ end
 
 The following configuration flags will be respected:
 
-- `:secure:` toggles the use of HTTPS. Defaults to `true`
+- `:use_https` toggles the use of HTTPS. Defaults to `true`
 - `:source` a String or Array that specifies the imgix Source address. Should be in the form of `"assets.imgix.net"`.
 - `:secure_url_token` a optional secure URL token found in your dashboard (https://webapp.imgix.com) used for signing requests
 - `:hostnames_to_replace` an Array of hostnames to replace with the value(s) specified by `:source`. This is useful if you store full-qualified S3 URLs in your database, but want to serve images through imgix.
@@ -129,6 +129,15 @@ Will generate the following URL:
 https://assets.imgix.net/users/1/avatar.png?w=400&h=300
 ```
 
+Since `ix_image_url` lives inside `UrlHelper`, it can also be used in places other than your views quite easily. This is useful for things such as including imgix URLs in JSON output from a serializer class.
+
+```ruby
+include Imgix::Rails::UrlHelper
+
+puts ix_image_url('/users/1/avatar.png', { w: 400, h: 300 })
+# => https://assets.imgix.net/users/1/avatar.png?w=400&h=300
+```
+
 ### Hostname Removal
 
 You can also configure imgix-rails to disregard given hostnames and only use the path component from given URLs. This is useful if you have [a Web Folder or an Amazon S3 imgix Source configured](https://www.imgix.com/docs/tutorials/creating-sources) but store the fully-qualified URLs for those resources in your database.

data/imgix-rails.gemspec

@@ -6,9 +6,9 @@ require 'imgix/rails/version'
 Gem::Specification.new do |spec|
   spec.name          = "imgix-rails"
   spec.version       = Imgix::Rails::VERSION
-  spec.authors       = ["Kelly Sutton"]
-  spec.email         = ["kelly@imgix.com"]
-  spec.licenses      = ['MIT']
+  spec.authors       = ["Kelly Sutton", "Paul Straw"]
+  spec.email         = ["kelly@imgix.com", "ixemail"]
+  spec.licenses      = ["MIT"]
 
   spec.summary       = %q{Makes integrating imgix into your Rails app easier. It builds on imgix-rb to offer a few Rails-specific interfaces.}
   spec.description   = %q{Makes integrating imgix into your Rails app easier. It builds on imgix-rb to offer a few Rails-specific interfaces. Please see https://github.com/imgix/imgix-rails for more details.}
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "imgix", '~> 0.3', '>= 0.3.5'
+  spec.add_runtime_dependency "imgix", "~> 1.0", ">= 1.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/imgix/rails/url_helper.rb

@@ -0,0 +1,68 @@
+module Imgix
+  module Rails
+    class ConfigurationError < StandardError; end
+
+    module UrlHelper
+      def ix_image_url(source, options={})
+        validate_configuration!
+
+        source = replace_hostname(source)
+
+        client.path(source).to_url(options).html_safe
+      end
+
+      private
+
+      def validate_configuration!
+        imgix = ::Imgix::Rails.config.imgix
+        unless imgix.try(:[], :source)
+          raise ConfigurationError.new("imgix source is not configured. Please set config.imgix[:source].")
+        end
+
+        unless imgix[:source].is_a?(Array) || imgix[:source].is_a?(String)
+          raise ConfigurationError.new("imgix source must be a String or an Array.")
+        end
+      end
+
+      def replace_hostname(source)
+        new_source = source.dup
+
+        # Replace any hostnames configured to trim things down just to their paths.
+        # We use split to remove the protocol in the process.
+        hostnames_to_remove.each do |hostname|
+          splits = source.split(hostname)
+          new_source = splits.last if splits.size > 1
+        end
+
+        new_source
+      end
+
+      def hostnames_to_remove
+        Array(::Imgix::Rails.config.imgix[:hostname_to_replace] || ::Imgix::Rails.config.imgix[:hostnames_to_replace])
+      end
+
+      def client
+        return @imgix_client if @imgix_client
+        imgix = ::Imgix::Rails.config.imgix
+
+        opts = {
+          host: imgix[:source],
+          library_param: "rails",
+          library_version: Imgix::Rails::VERSION,
+          use_https: true,
+          secure_url_token: imgix[:secure_url_token]
+        }
+
+        if imgix.has_key?(:include_library_param)
+          opts[:include_library_param] = imgix[:include_library_param]
+        end
+
+        if imgix.has_key?(:use_https)
+          opts[:use_https] = imgix[:use_https]
+        end
+
+        @imgix_client = ::Imgix::Client.new(opts)
+      end
+    end
+  end
+end

data/lib/imgix/rails/version.rb

@@ -1,5 +1,5 @@
 module Imgix
   module Rails
-    VERSION = "0.3.2"
+    VERSION = "1.0.0"
   end
 end

data/lib/imgix/rails/view_helper.rb

@@ -1,17 +1,10 @@
 require "imgix"
+require "imgix/rails/url_helper"
 
 module Imgix
   module Rails
-    class ConfigurationError < StandardError; end
-
-    module ViewHelper
-      def ix_image_url(source, options={})
-        validate_configuration!
-
-        source = replace_hostname(source)
-
-        client.path(source).to_url(options).html_safe
-      end
+   module ViewHelper
+      include UrlHelper
 
       def ix_image_tag(source, options={})
         source = replace_hostname(source)
@@ -37,56 +30,6 @@ module Imgix
 
     private
 
-      def validate_configuration!
-        imgix = ::Imgix::Rails.config.imgix
-        unless imgix.try(:[], :source)
-          raise ConfigurationError.new("imgix source is not configured. Please set config.imgix[:source].")
-        end
-
-        unless imgix[:source].is_a?(Array) || imgix[:source].is_a?(String)
-          raise ConfigurationError.new("imgix source must be a String or an Array.")
-        end
-      end
-
-      def replace_hostname(source)
-        new_source = source.dup
-
-        # Replace any hostnames configured to trim things down just to their paths.
-        # We use split to remove the protocol in the process.
-        hostnames_to_remove.each do |hostname|
-          splits = source.split(hostname)
-          new_source = splits.last if splits.size > 1
-        end
-
-        new_source
-      end
-
-      def client
-        return @imgix_client if @imgix_client
-        imgix = ::Imgix::Rails.config.imgix
-
-        opts = {
-          host: imgix[:source],
-          library_param: "rails",
-          library_version: Imgix::Rails::VERSION,
-          secure: true
-        }
-
-        if imgix[:secure_url_token].present?
-          opts[:token] = imgix[:secure_url_token]
-        end
-
-        if imgix.has_key?(:include_library_param)
-          opts[:include_library_param] = imgix[:include_library_param]
-        end
-
-        if imgix.has_key?(:secure)
-          opts[:secure] = imgix[:secure]
-        end
-
-        @imgix_client = ::Imgix::Client.new(opts)
-      end
-
       def available_parameters
         @available_parameters ||= parameters.keys
       end
@@ -108,10 +51,6 @@ module Imgix
       def configured_resolutions
         ::Imgix::Rails.config.imgix[:responsive_resolutions] || [1, 2]
       end
-
-      def hostnames_to_remove
-        Array(::Imgix::Rails.config.imgix[:hostname_to_replace] || ::Imgix::Rails.config.imgix[:hostnames_to_replace])
-      end
     end
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: imgix-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Kelly Sutton
+- Paul Straw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imgix
@@ -16,20 +17,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +92,7 @@ description: Makes integrating imgix into your Rails app easier. It builds on im
   for more details.
 email:
 - kelly@imgix.com
+- ixemail
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -105,6 +107,7 @@ files:
 - bin/setup
 - imgix-rails.gemspec
 - lib/imgix/rails.rb
+- lib/imgix/rails/url_helper.rb
 - lib/imgix/rails/version.rb
 - lib/imgix/rails/view_helper.rb
 - lib/imgix/railtie.rb
@@ -130,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Makes integrating imgix into your Rails app easier. It builds on imgix-rb