picfit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c442064d0c59868a391f192a9763a0a98eabb4fd
+  data.tar.gz: e9278df0364f51f76751aec27669299f1e900014
+SHA512:
+  metadata.gz: e5c528a70d3e552fab005c32ba9d1fb97b4024712a52a4656671ee07abe34e878de296390442f5a10df4a010a3ddacb4328f131805d0f75ef899d4f0dc537504
+  data.tar.gz: 0029a7d6acaceacae49af28b5331c86cd5634e31d0f28089b08212acfa8b4833bda2dda6082dd551ec7b8768de505debaaf592583c165fe0286e25ea148b4567

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+
+before_install:
+  - "gem install bundler" # -v 1.7.14 if a specific version is needed

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Edgar Gonzalez
+
+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,83 @@
+# Picfit [![Build Status](https://travis-ci.org/edgar/picfit-ruby.png?branch=master)](https://travis-ci.org/edgar/picfit-ruby) [![Gem Version](https://badge.fury.io/rb/picfit.svg)](http://badge.fury.io/rb/picfit)
+
+A Ruby library for generating URLs with [picfit](https://github.com/thoas/picfit).
+
+Inspired by [picfit-go](https://github.com/ulule/picfit-go)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'picfit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install picfit
+
+## Usage
+
+```ruby
+# Initialize Picfit with a block
+Picfit.configure do |config|
+  config.base_url = "http://mypicfitserver.com",
+  config.secret_key = "abcdef"
+end
+
+# Or initialize using a Hash
+Picfit.init(base_url: "http://mypicfitserver.com", secret_key: "abcdef")
+
+# Get the image url
+Picfit.image_url(
+  width: 100,
+  height: 100,
+  path: "path/to/file",
+  operation: :resize
+)
+=> "http://mypicfitserver.com/display?path=path%2Fto%2Ffile&op=resize&w=100&h=100&sig=f45506bf02ca3ba84eb34a2a066af7aa315a11c2"
+
+# Get the image path (without base_url)
+Picfit.image_path(
+  width: 100,
+  height: 100,
+  path: "path/to/file",
+  operation: :resize,
+)
+=> "display?path=path%2Fto%2Ffile&op=resize&w=100&h=100&sig=f45506bf02ca3ba84eb34a2a066af7aa315a11c2"
+```
+
+### General parameters
+
+The `Hash` parameter supplied to both `image_path` and `image_url` methods support the following keys (as a `Symbol`:
+
+- **:path** - The filepath to load the image using your source storage
+- **:operation** - The operation to perform, see (Operations)[https://github.com/thoas/picfit#operations]
+- **:secret_key** - Your secret key, see (Security)[https://github.com/thoas/picfit#security]
+- **:method** - The method to perform, see (Methods)[https://github.com/thoas/picfit#methods]
+- **:url** - The url of the image to generate (not required if ``path`` provided)
+- **:width** - The desired width of the image, if ``0`` is provided the service will calculate the ratio with ``height``
+- **:height** - The desired height of the image, if ``0`` is provided the service will calculate the ratio with ``width``
+- **:upscale** - If your image is smaller than your desired dimensions, the service will upscale it by default to fit your dimensions, you can disable this behavior by providing ``0``
+- **format** - The output format to save the image, by default the format will be the source format (a ``GIF`` image source will be saved as ``GIF``),  see Formats_
+- **quality** - The quality to save the image, by default the quality will be the highest possible, it will be only applied on ``JPEG`` format
+- **degree** - The degree (``90``, ``180``, ``270``) to rotate the image
+- **position** - The position to flip the image
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/picfit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "picfit"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# 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/picfit.rb

@@ -0,0 +1,33 @@
+require "picfit/version"
+require "picfit/configuration"
+require "picfit/client"
+
+module Picfit
+  extend Configuration
+
+  def self.init(options={})
+    @client = Picfit::Client.new(options)
+  end
+
+  # Get the common client
+  def self.client
+    @client ||= init
+  end
+
+  # Set the common client
+  def self.client=(client)
+    @client = client
+  end
+
+  # Delegate to Picfit::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Picfit::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+
+end

data/lib/picfit/client.rb

@@ -0,0 +1,78 @@
+require 'openssl'
+
+module Picfit
+  class Client
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    PICFIT_PARAMS_MAP = {
+      path:      :path,
+      operation: :op,
+      url:       :url,
+      width:     :w,
+      height:    :h,
+      upscale:   :upscale,
+      format:    :fmt,
+      quality:   :q,
+      degree:    :deg,
+      position:  :pos
+    }.freeze
+
+    def initialize(options={})
+      options = Picfit.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    #
+    # Return a full image url
+    #
+    def image_url(options = {})
+      base_url = options[:base_url] || self.base_url || Configuration.DEFAULT_BASE_URL
+      base_url << "/" if base_url[-1,1] != "/"
+      base_url << image_path(options)
+    end
+
+    #
+    # Return the image path (not include the host)
+    #
+    def image_path(options = {})
+      path = (options[:method] || self.method).to_s
+      secret_key = options[:secret_key] || self.secret_key
+
+      # lets convert the options to picfit params
+      params = PICFIT_PARAMS_MAP.inject({}) do |result, (key, param_key)|
+        result[param_key] = options[key] if options[key]
+        result
+      end
+      # Create a query string from the params
+      query_string = params.map{|k,v| [CGI.escape(k.to_s), "=", CGI.escape(v.to_s)]}.map(&:join).join("&")
+      if secret_key
+        # lets use << instead of + or interpolation
+        query_string << "&sig="
+        query_string << sign_string(secret_key, query_string)
+      end
+      path << "?"
+      path << query_string
+    end
+
+    def sign_string(secret_key, query_string)
+      hmac = OpenSSL::HMAC.new(secret_key, sha_digest)
+      hmac << query_string
+      hmac.hexdigest
+    end
+
+    def sha_digest
+      @sha_digest ||= OpenSSL::Digest::SHA1.new
+    end
+
+  end
+end

data/lib/picfit/configuration.rb

@@ -0,0 +1,40 @@
+module Picfit
+  module Configuration
+    # An array of valid keys in the options hash
+    VALID_OPTIONS_KEYS = [
+      :base_url,
+      :method,
+      :secret_key,
+    ].freeze
+
+    DEFAULT_METHOD     = :display
+    DEFAULT_BASE_URL   = ""
+    DEFAULT_SECRET_KEY = nil
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.base_url       = DEFAULT_BASE_URL
+      self.method         = DEFAULT_METHOD
+      self.secret_key     = DEFAULT_SECRET_KEY
+    end
+  end
+end

data/lib/picfit/version.rb

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

data/picfit.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'picfit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "picfit"
+  spec.version       = Picfit::VERSION
+  spec.authors       = ["Edgar Gonzalez"]
+  spec.email         = ["edgargonzalez@gmail.com"]
+
+  spec.summary       = %q{A Ruby library for generating URLs with picfit.}
+  spec.description   = %q{A Ruby library for generating URLs with picfit.}
+  spec.homepage      = "http://github.com/edgar/picfit-ruby"
+  spec.license       = "MIT"
+
+  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 = ["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: picfit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edgar Gonzalez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-17 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: A Ruby library for generating URLs with picfit.
+email:
+- edgargonzalez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/picfit.rb
+- lib/picfit/client.rb
+- lib/picfit/configuration.rb
+- lib/picfit/version.rb
+- picfit.gemspec
+homepage: http://github.com/edgar/picfit-ruby
+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.7
+signing_key: 
+specification_version: 4
+summary: A Ruby library for generating URLs with picfit.
+test_files: []