libpixel 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0f22ebc9734b9ef50dca3c743461b6df558e065
+  data.tar.gz: 4841c3f1f7a9dc7c6b55537be6b8bce1f18846b8
+SHA512:
+  metadata.gz: 04fd860a31cdd64dea9391343b18c593469747984682e630a29d8e96975777dead7356e7e6fab77794586d215e213d37e0792b481eb1383949f653009f9441e0
+  data.tar.gz: fd81c111aa5f13e2acd13c6eab081e946b104e491e5d6243459776ae6036b9ba34de7466cddf361458270b5de0c14b19d0b7230bd544f00c1897117e352617c9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+  - jruby
+  - rbx

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in libpixel.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 LibPixel Oy
+
+MIT License
+
+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,61 @@
+# LibPixel
+
+Ruby library to generate and sign LibPixel URLs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'libpixel'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install libpixel
+
+## Usage
+
+Configure the LibPixel client:
+
+```ruby
+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.
+end
+```
+
+### Sign URLs
+
+You can sign an existing URL using the `sign` function:
+
+```ruby
+url = LibPixel.sign("http://test.libpx.com/images/1.jpg?width=400")
+```
+
+### Generate URLs
+
+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)
+```
+
+### Multiple clients
+
+It's also possible to have multiple instances of LibPixel clients (e.g. when dealing with multiple accounts):
+
+```ruby
+client = LibPixel::Client.new(host: "test.libpx.com", https: true, secret: "...")
+```
+
+You may then call the `#url` and `#sign` methods on the client object.
+
+## License
+
+[MIT](LICENSE)

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test
+

data/lib/libpixel.rb

@@ -0,0 +1,20 @@
+require "libpixel/version"
+require "libpixel/client"
+
+module LibPixel
+
+  @@default_client = Client.new
+
+  def self.setup
+    yield @@default_client
+  end
+
+  def self.sign(uri)
+    @@default_client.sign(uri)
+  end
+
+  def self.url(path, options={})
+    @@default_client.url(path, options)
+  end
+
+end

data/lib/libpixel/client.rb

@@ -0,0 +1,49 @@
+require "openssl"
+require "uri"
+
+module LibPixel
+  class Client
+    attr_accessor :host, :secret, :https
+
+    def initialize(options={})
+      options.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def sign(uri)
+      uri = URI.parse(uri) unless uri.kind_of?(URI::Generic)
+
+      query = uri.query
+      data = uri.path
+      data += "?#{query}" if query && query != ""
+
+      digest = OpenSSL::Digest.new("sha1")
+      signature = OpenSSL::HMAC.hexdigest(digest, secret, data)
+
+      query += "&" if query && query != ""
+      query = "#{query}signature=#{signature}"
+      uri.query = query
+
+      uri.to_s
+    end
+
+    def url(path, options={})
+      query = options.map { |k,v| "#{k}=#{URI.encode_www_form_component(v)}" }.join("&")
+
+      if query == ""
+        query = nil
+      end
+
+      uri = URI::Generic.new(
+        (https ? "https" : "http"), nil, host, nil, nil, path, nil, query, nil
+      )
+
+      if secret
+        sign(uri)
+      else
+        uri.to_s
+      end
+    end
+  end
+end

data/lib/libpixel/version.rb

@@ -0,0 +1,3 @@
+module LibPixel
+  VERSION = "1.0.0"
+end

data/libpixel.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.homepage      = "http://libpixel.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'libpixel'
+
+require 'minitest/autorun'

data/test/test_client.rb

@@ -0,0 +1,66 @@
+require "minitest_helper"
+
+describe LibPixel::Client do
+
+  before do
+    @client = LibPixel::Client.new({
+      host: "test.libpx.com", https: false, secret: "LibPixel"
+    })
+  end
+
+  describe "#sign" do
+    it "adds the query string with the signature" do
+      url = "http://test.libpx.com/images/1.jpg"
+      signature = "bd5634c055d707c1638eff93eb88ff31277958f0"
+      assert_equal "#{url}?signature=#{signature}", @client.sign(url)
+    end
+
+    it "appends the signature to an existing query string" do
+      url = "http://test.libpx.com/images/2.jpg?width=400"
+      signature = "baa12c05ed279dbc623ffc8b74b183f6044e5998"
+      assert_equal "#{url}&signature=#{signature}", @client.sign(url)
+    end
+
+    it "ignores the '?' separator if there's no query string" do
+      url = "http://test.libpx.com/images/1.jpg"
+      assert_equal @client.sign(url), @client.sign("#{url}?")
+    end
+
+    it "supports URLs with a query string and a fragment" do
+      assert_equal "http://test.libpx.com/images/3.jpg?width=300&height=220&signature=500ad73bdf2d9e77d6bb94f0ca1c72f9c1f495f8#image",
+        @client.sign("http://test.libpx.com/images/3.jpg?width=300&height=220#image")
+    end
+
+    it "supports URLs with a fragment but no query string" do
+      assert_equal "http://test.libpx.com/images/1.jpg?signature=bd5634c055d707c1638eff93eb88ff31277958f0#test",
+        @client.sign("http://test.libpx.com/images/1.jpg#test")
+    end
+  end
+
+  describe "#url" do
+    it "constructs a URL for a given path" do
+      client = LibPixel::Client.new(host: "test.libpx.com")
+      url = "http://test.libpx.com/images/5.jpg"
+      assert_equal url, client.url("/images/5.jpg")
+    end
+
+    it "turns options into a query string" do
+      client = LibPixel::Client.new(host: "test.libpx.com")
+      url = "http://test.libpx.com/images/101.jpg?width=200&height=400"
+      assert_equal url, client.url("/images/101.jpg", width: 200, height: 400)
+    end
+
+    it "uses HTTPS if the https option is set to true" do
+      client = LibPixel::Client.new(host: "test.libpx.com", https: true)
+      url = "https://test.libpx.com/images/1.jpg"
+      assert_equal url, client.url("/images/1.jpg")
+    end
+
+    it "signs the request if a secret is given" do
+      client = LibPixel::Client.new(host: "test.libpx.com", secret: "LibPixel")
+      url = "http://test.libpx.com/images/1.jpg?width=600&signature=dfcaec7b88d53a7a932e8a6a00d10b4f9ff1336b"
+      assert_equal url, client.url("/images/1.jpg", width: 600)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: libpixel
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joao Carlos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: 
+email:
+- joao@libpixel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/libpixel.rb
+- lib/libpixel/client.rb
+- lib/libpixel/version.rb
+- libpixel.gemspec
+- test/minitest_helper.rb
+- test/test_client.rb
+homepage: http://libpixel.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Ruby library to generate and sign LibPixel URLs.
+test_files:
+- test/minitest_helper.rb
+- test/test_client.rb
+has_rdoc: