libpixel 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 371f5707b83500219bf589fec16a37d1390cd6e6
-  data.tar.gz: 6d1f6141025ec621708552bff558aa49c364c56b
+  metadata.gz: 8920757faf3f137c4b288deaf5dbd740dde38d5b
+  data.tar.gz: ef94228a86b9cde78f6da8c2f3d0a4d4b73fa8e4
 SHA512:
-  metadata.gz: d6f2bc027f67b5c6cd43f3724f48b072c997ac1d76604e4e4b16c668f13efe90097c96c5016336b1bffb5a9760ebb72bac6c645a1e62a87a8f3c6111867af186
-  data.tar.gz: 8f5b3e5ac05bbf2cddc21a627311f6d5655cea7efe48f4117482c6e7e496dbac175b74f7d6c1c3020ab1e3a826ddf238fb10aa1bdf072a6daa376884d3d4aa5d
+  metadata.gz: 28dd2bc72c9f6ba10daefde005cff93130d3bf2d4277a730d4d65db58ab29a3adac3d6987f34e4832463bf2ab32bd05130e8035e682be389b903fd72bd29a1aa
+  data.tar.gz: 7ec30753b454d2dfb4ed97d5b2d66d0fcc3e4917d4f0121f47de1494a76732fc02f5bf4c59dab331351fbb6826439d5a01144d9c09989082ab0eeea22a296143

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+/test/dummy/log/

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.2.0] - 2015-09-19
+### Added
+- Add `libpixel_image_tag` Rails view helper.
+- Add `https` option to `LibPixel::Client.url`.
+- Set host automatically in clients from `LIBPIXEL_HOST` env var.
+- Set secret automatically in clients from `LIBPIXEL_SECRET` env var.
+
+### Changed
+- `LibPixel::Client.url` raises an exception if host is undefined.
+- `LibPixel::Client.sign` raises an exception if secret is undefined.
+
 ## [1.1.0] - 2015-08-12
 ### Changed
 - Make path optional in LibPixel::Client#url [@matiaskorhonen](https://github.com/matiaskorhonen).

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/libpixel/libpixel-ruby.svg?branch=master)](https://travis-ci.org/libpixel/libpixel-ruby)
 
-Ruby library to generate and sign LibPixel URLs.
+Ruby library and Rails plugin to generate and sign LibPixel URLs.
 
 ## Installation
 
@@ -29,9 +29,12 @@ LibPixel.setup do |config|
   config.host = "test.libpx.com" # Your LibPixel domain. Required.
   config.https = true # Generates HTTPS URLs. Optional. Default is false.
   config.secret = "..." # Auth secret for your LibPixel account. Required for signing requests.
+  config.default_source = "us-east-1/source" # optional source to be used, can be overriden
 end
 ```
 
+The configuration for host and secret will be automatically set from the environment variables LIBPIXEL_HOST and LIBPIXEL_SECRET if they are present.
+
 ### Sign URLs
 
 You can sign an existing URL using the `sign` function:
@@ -45,7 +48,7 @@ url = LibPixel.sign("http://test.libpx.com/images/1.jpg?width=400")
 You can also generate and sign URLs at the same time with the `url` function:
 
 ```ruby
-url = LibPixel.url("/images/1.jpg", height: 400, blur: 20, saturation: -80)
+url = LibPixel.url("/us-east-1/images/1.jpg", height: 400, blur: 20, saturation: -80)
 ```
 
 If you're using the `src` parameter, you can skip the path:
@@ -54,6 +57,31 @@ If you're using the `src` parameter, you can skip the path:
 url = LibPixel.url(src: "http://...", width: 300)
 ```
 
+But even simpler, if the library sees a url beginning with http or https it knows what to do:
+
+```ruby
+url = LibPixel.url("http://...", width: 300)
+```
+
+You can specify whether you what an http or https url in your call:
+
+```ruby
+url = LibPixel.url("/us-east-1/images/1.jpg", height: 400, blur: 20, saturation: -80, https: true)
+```
+
+If you are using a default_source, you don't need to specify it in the path:
+
+```ruby
+url = LibPixel.url("1.jpg", height: 400, blur: 20, saturation: -80)
+```
+
+But you can override it with the source parameter:
+
+```ruby
+url = LibPixel.url("1.jpg", height: 400, blur: 20, saturation: -80, source: "us-west-1/source2")
+```
+
+
 ### Multiple clients
 
 It's also possible to have multiple instances of LibPixel clients (e.g. when dealing with multiple accounts):
@@ -64,6 +92,66 @@ client = LibPixel::Client.new(host: "test.libpx.com", https: true, secret: "..."
 
 You may then call the `#url` and `#sign` methods on the client object.
 
+## Ruby on Rails
+
+The LibPixel gem includes a Rails plugin that provides a view helper that you can use in place of normal calls to `image_tag`. The libpixel host and libpixel secret settings should be set in an initializer, or will be automatically picked up from the environment variables `LIBPIXEL_HOST` and `LIBPIXEL_SECRET`.
+
+```ruby
+libpixel_image_tag("eu-west-1/source/foo.jpg")
+=> "<img src=\"http://example.libpx.com/eu-west-1/source/foo.jpg\" alt=\"Foo\" />"
+```
+
+You specify the libpixel processing parameters in a hash within the normal options hash, denoted by the key `:libpixel`.
+
+```ruby
+libpixel_image_tag("eu-west-1/source/foo.jpg", libpixel: {width: 300})
+```
+
+The normal parameters that Rails uses will also work.
+
+```ruby
+libpixel_image_tag("eu-west-1/source/foo.jpg", libpixel: {width: 300, dpr: 2}, size: "300x250")
+```
+
+If all your images are from the same source, it's helpful to configure a `default_source` in an initializer.
+
+```ruby
+LibPixel.default_source = "eu-west-1/source"
+```
+
+Then you can omit the source in your tags.
+
+```ruby
+libpixel_image_tag("foo.jpg", libpixel: {width: 300, dpr: 2}, size: "300x250")
+```
+
+If you need to override the default source, you can do that using the source parameter.
+
+```ruby
+libpixel_image_tag("foo.jpg", libpixel: {width: 300, dpr: 2, source: "eu-west-1/source2"}, size: "300x250")
+```
+
+Referring to an image outside of your configured sources is also possible.
+
+```ruby
+libpixel_image_tag("http://example.com/images/foo.jpg", libpixel: {width: 300, dpr: 2}, size: "300x250")
+```
+
+You can configure your generated image src urls to use https or http in your initializer.
+
+```ruby
+LibPixel.https = true  # default is false
+```
+
+And you can specify it on a per-tag basis.
+
+```ruby
+libpixel_image_tag("us-east-1/source/foo.jpg", libpixel: {https: true})
+=> "<img src=\"https://example.libpx.com/us-east-1/source/foo.jpg\" alt=\"Foo\" />"
+```
+
+
+
 ## License
 
 [MIT](LICENSE)

data/Rakefile

@@ -6,4 +6,3 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default => :test
-

data/lib/libpixel.rb

@@ -9,6 +9,22 @@ module LibPixel
     yield @@default_client
   end
 
+  def self.host=(host)
+    @@default_client.host = host
+  end
+
+  def self.secret=(secret)
+    @@default_client.secret = secret
+  end
+
+  def self.https=(https)
+    @@default_client.https = https
+  end
+
+  def self.default_source=(default_source)
+    @@default_client.default_source = default_source
+  end
+
   def self.sign(uri)
     @@default_client.sign(uri)
   end
@@ -18,3 +34,5 @@ module LibPixel
   end
 
 end
+
+require 'libpixel/railtie' if defined?(Rails)

data/lib/libpixel/client.rb

@@ -3,15 +3,22 @@ require "uri"
 
 module LibPixel
   class Client
-    attr_accessor :host, :secret, :https
+    attr_accessor :host, :secret, :https, :default_source
 
     def initialize(options={})
       options.each do |key, value|
         send("#{key}=", value)
       end
+
+      self.host   ||= ENV["LIBPIXEL_HOST"]
+      self.secret ||= ENV["LIBPIXEL_SECRET"]
     end
 
     def sign(uri)
+      if secret.nil?
+        raise "Your LibPixel secret must be defined (e.g. LibPixel.secret = 'SECRET')"
+      end
+
       uri = URI.parse(uri) unless uri.kind_of?(URI::Generic)
 
       query = uri.query
@@ -30,22 +37,46 @@ module LibPixel
 
     def url(path_or_options, options={})
       path = nil
+      
+      if host.nil?
+        raise "Your LibPixel host name must be defined (e.g. LibPixel.host = 'example.libpx.com')"
+      end
 
       if path_or_options.respond_to? :fetch
         options = path_or_options
-      else
-        path = path_or_options
+      elsif !path_or_options.nil?
+        uri = URI(path_or_options)
+        if uri.scheme == "http" || uri.scheme == "https"
+          options[:src] = path_or_options
+        else
+          path = path_or_options
+        end
       end
 
-      path = "/" if path.nil? || path.empty?
+      source = options.fetch(:source) {default_source}
+      options = options.reject {|k| k == :source}
+      
+      use_https = options.fetch(:https) {https}
+      options = options.reject {|k| k == :https}
+
       query = options.map { |k,v| "#{k}=#{URI.encode_www_form_component(v)}" }.join("&")
 
       if query == ""
         query = nil
       end
+      
+      if !source.nil? && !source.empty?
+        source_clean = source.gsub(/^\//, "").gsub(/\/$/, "")
+        path_clean = (path || "").gsub(/^\//, "")
+        path = "/#{source_clean}/#{path_clean}"
+      else
+        if path.nil? || path !~ /^\//
+          path = "/#{path}"
+        end
+      end
 
       uri = URI::Generic.new(
-        (https ? "https" : "http"), nil, host, nil, nil, path, nil, query, nil
+        (use_https ? "https" : "http"), nil, host, nil, nil, path, nil, query, nil
       )
 
       if secret

data/lib/libpixel/railtie.rb

@@ -0,0 +1,10 @@
+require 'libpixel/view_helpers'
+
+module LibPixel
+  class Railtie < Rails::Railtie
+
+    ActiveSupport.on_load(:action_view) do
+      include LibPixel::ViewHelpers
+    end
+  end
+end

data/lib/libpixel/version.rb

@@ -1,3 +1,3 @@
 module LibPixel
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/libpixel/view_helpers.rb

@@ -0,0 +1,35 @@
+module LibPixel
+  module ViewHelpers
+    #
+    # libpixel_image_tag("http://example.com/image.jpg", :width=>200, :libpixel=>{:width=>200, :dpr=>2, :source=>"images"})
+    # => <img width="200" alt="image" src="http://example.libpx.com/images/?width=200&dpr=2&src=http%3A%2F%2Fexample.com%2Fimage.jpg" />
+    # 
+    # LibPixel.default_source = "source"
+    # libpixel_image_tag("image.jpg", :libpixel=>{:width=>200})
+    # => <img alt="image" src="http://example.libpx.com/source/image.jpg?width=200" />
+    #
+    def libpixel_image_tag(source, options = {})
+      image_tag_options = nil
+      
+      if source.respond_to? :fetch
+        libpixel_url = LibPixel.url(source[:libpixel])
+        image_tag_options = source.reject {|k| k == :libpixel}
+      else
+        source = URI::escape(source)
+        libpixel_url = LibPixel.url(source, options.fetch(:libpixel) {{}})
+        image_tag_options = options.reject {|k| k == :libpixel}
+      end
+
+      uri = URI(libpixel_url)
+      if uri.query
+        query_items = CGI.parse(uri.query)
+        src = query_items["src"].first
+        if src
+          image_tag_options[:alt] = image_tag_options.fetch(:alt) {image_alt(src)}
+        end
+      end
+
+      image_tag(libpixel_url.html_safe, image_tag_options)
+    end
+  end
+end

data/libpixel.gemspec

@@ -6,9 +6,9 @@ require 'libpixel/version'
 Gem::Specification.new do |spec|
   spec.name          = "libpixel"
   spec.version       = LibPixel::VERSION
-  spec.authors       = ["Joao Carlos"]
-  spec.email         = ["joao@libpixel.com"]
-  spec.summary       = %q{Ruby library to generate and sign LibPixel URLs.}
+  spec.authors       = ["Joao Carlos", "Stephen Sykes"]
+  spec.email         = ["support@libpixel.com"]
+  spec.summary       = %q{Ruby library and Rails plugin to generate and sign LibPixel URLs.}
   spec.homepage      = "https://github.com/libpixel/libpixel-ruby"
   spec.license       = "MIT"
 
@@ -19,5 +19,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest", "~> 5.8.0"
+  spec.add_development_dependency "rails", "~> 4.2.3"
 end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end