pilbox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12b3de46a2ffae7aab7700e96289f01ae385230b
+  data.tar.gz: 4848979c4b5cfaa7b5428a7637af38253b0b0736
+SHA512:
+  metadata.gz: 5bc4e243951a7bd9f5dfe2b8e8e830ecd6f1b2618e2430660c6efc61143863cd6cea606065db0abdf66b5d8d92dffbf254717ccf9a5fd26a682bf0759dc91ef8
+  data.tar.gz: 4bc452d9cd77f72bf671af18e19c1b84f02f54f74f3680a0e5d1d88b9d83181aa81ab537de49e8ef5d8f69ca4b8d2e887e94fec43f8a0a20556ce904d3fd09c2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/sandbox/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Justin Workman
+
+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.
+
+Note that this software is not affiliated with Pilbox, and Pilbox may come with a
+different license and different authors.

data/README.md

@@ -0,0 +1,75 @@
+Pilbox Ruby Gem
+===============
+
+This is a Ruby utility for generating request URLs for [Pilbox][0], the image resizing service. This library was made for my personal use and is not affiliated with the Pilbox project.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pilbox"
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install pilbox
+```
+
+Usage
+-----
+
+It's quite straightfoward: simply call `Pilbox.thumb_uri(base_uri, params)`, where the `base_uri` is a string or `URI` pointing to the Pilbox server endpoint, and `params` contains the query params to be passed to the Pilbox request.
+
+Basic example, generating a thumbnail with a width of 50:
+
+```ruby
+Pilbox.thumb_uri("https://mypilboxserver.example.com", "url" => "https://example.org/funnykittens.jpg", "w" => 50)
+```
+
+You will get back a URI suitable for generating a thumbnail on Pilbox. For flexibility, the result will be a `URI` object, which you can easily turn into a string by calling `#to_s` on it.
+
+You should always pass at least the `"url"` param. If you pass a `client_key` param to `Pilbox#thumb_uri`, a secure signature (compatible with Pilbox) will be generated and added to the resulting URI. The `client_key` param won't be added to the HTTP request, it will remain secret. All other params will pass through to Pilbox. For more information on available params, refer to the documentation on the [Pilbox][0] project.
+
+The following is a more complete example, which will return a signed URI ready to send as a secure Pilbox request:
+
+```ruby
+base_uri = ENV["PILBOX_HOST"] # e.g. https://mypilboxserver.example.com
+thumb_params = {
+  url: "http://www.example.org/happypanda.png",
+  op: "resize,rotate",
+  w: 150,
+  h: 150,
+  deg: "auto",
+  client_name: ENV["PILBOX_CLIENY_NAME"],
+  client_key: ENV["PILBOX_CLIENT_KEY"]
+}
+puts Pilbox.thumb_uri(base_uri, thumb_params).to_s
+```
+
+If you have an existing URI that already includes Pilbox parameters, and you just want to add the proper signature, you can do that too:
+
+```ruby
+unsigned_url = "http://mypilboxserver.example.org?url=http%3A%2F%2Fwww.example.com%2Fimage.jpg&w=250&h=80"
+signed_url = Pilbox.thumb_uri(unsigned_url, client_name: "...", client_key: "...").to_s
+```
+
+Care has been taken to make this utility as simple to use as possible. If it behaves unexpectedly for you, please report it on the [issue tracker](https://github.com/xtagon/pilbox-ruby/issues).
+
+Author
+------
+
+[Justin Workman](mailto:xtagon@gmail.com)
+
+Happy hacking!
+
+
+[0]: https://github.com/agschwender/pilbox

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pilbox"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start
+
+#require "irb"
+#IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pilbox.rb

@@ -0,0 +1,56 @@
+require "pilbox/version"
+
+require "cgi"
+require "openssl"
+require "uri"
+
+module Pilbox
+  def self.thumb_uri(base_uri, params = {})
+    # Accept a URI, or a string representing what the URI should be. This
+    # can simple be used as the base host URI.
+    uri = base_uri.is_a?(URI) ? base_uri.dup : URI.parse(base_uri)
+
+    if params.empty?
+      return uri
+    end
+
+    params = if params.is_a?(Hash)
+      params.dup
+    else
+      # CGI.parse results in key/value pairs where the value is an *array*
+      # of values, possibly more than one. We only care about the first, if
+      # there is more than one.
+      CGI.parse(params.to_s).reduce({}) do |hash, (key, value)|
+        hash.merge(key => value.first)
+      end
+    end
+
+    # Normalize param keys to strings
+    params = params.reduce({}) do |hash, (key, value)|
+      hash.merge(key.to_s => value)
+    end
+
+    # Client Key is supposed to be a secret...don't let it be merged into
+    # the URI's query params directly.
+    client_key = params.delete("client_key")
+
+    original_params = CGI.parse(uri.query || "")
+    uri.query = URI.encode_www_form(original_params.merge(params))
+
+    if client_key
+      signature = generate_signature(client_key, uri.query)
+      uri.query << "&" << URI.encode_www_form({"sig" => signature})
+    end
+
+    return uri
+  end
+
+  private
+
+  def self.generate_signature(client_key, query_string)
+    OpenSSL::HMAC.hexdigest(
+      OpenSSL::Digest.new("sha1"),
+      client_key, query_string
+    )
+  end
+end

data/lib/pilbox/version.rb

@@ -0,0 +1,3 @@
+module Pilbox
+  VERSION = "0.1.0"
+end

data/pilbox.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pilbox/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pilbox"
+  spec.version       = Pilbox::VERSION
+  spec.authors       = ["Justin Workman"]
+  spec.email         = ["xtagon@gmail.com"]
+
+  spec.summary       = "An URL-signing utility for Pilbox, the image resizing service."
+  #spec.description   = ""
+  #spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # 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'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: pilbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Workman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  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:
+- xtagon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pilbox.rb
+- lib/pilbox/version.rb
+- pilbox.gemspec
+homepage: 
+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: An URL-signing utility for Pilbox, the image resizing service.
+test_files: []
+has_rdoc: