imager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56ce5179ec4ee910013a72451b268ee141a7bb07
+  data.tar.gz: 62092eb90e5d9d6ab5e3675ec9aeabcc4de44889
+SHA512:
+  metadata.gz: 26ebfba5221636a4bbb8ea45334d568a441fcd0e85f6aed87354ca8ab838cee7a7e4bcf6173b870101efac83627d141fe471fe226632611919ef5cab02a886e9
+  data.tar.gz: c584666fbacb84d2ba4e39c806bc29f35537cf6261749e0731e3f3859a5a09f71402d053c289b901de0ff3e4405d8e31f74b70cee6f8ecd0573a7b1b3b161eaf

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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,80 @@
+# Imager
+
+Use with [ImagerServer](https://github.com/guilherme-otran/ImagerServer), a storange and resizer server for images.
+Check the test directory for know how the server works.
+ You can save your images in other domain running ImagerServer.
+
+## Please contribute!
+A lot of the features are not implemented yet (except for the server)
+
+1. Fork it
+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 new Pull Request
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'Imager'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Imager
+
+## Usage
+
+    Imager.configure do |c|
+      c.base_uri          = "http://files.myserver.com"
+      c.manager_path      = "manager"
+      c.collections_path  = "images"
+      c.auth_code         = ""
+    end
+
+  c.auth_code is the `$YOUR_AUTH_CODE = '';` you setted in the [server] (https://github.com/guilherme-otran/ImagerServer).
+  This is for post and delete authentication (manager).
+
+### Sending the images
+    Imager::ServerInterface.post("Collection", "Album", File.new("test/test_image.png"), small: { width: 100})
+
+### Removing the images
+  Not yet.
+
+### Using the images
+    Imager::LinkHelper.link_for("Collection", "Album", :small)
+Will return:
+    "http://files.myserver.com/images/collection/album/test_image/small.jpg"
+Since the server ALWAYS save the images as jpg.
+
+You can use Collection as model name(product) and album as id(1) and get the result:
+    "http://files.myserver.com/images/product/1/test_image/small.jpg"
+  Just save as:
+    Imager::ServerInterface.post("product", "1", File.new("test/test_image.png"), small: { width: 100})
+
+## Notes about saving and sizes
+  Saving first as `"product", "1", File.new("test/test_image.png"), small: { width: 100})` and after `"product", "1", File.new("test/other_image.png"), small: { width: 90})` don't changes the size of test_image. Beware!
+
+### Sizes Explain:
+  The server accepts the following combinations:
+  ```
+  YourSizeName: { width:  100 } # Will resize (maintein main aspect) the image for 100px of width
+  YourSizeName: { height: 100 } # Will resize (maintein main aspect) the image for 100px of height
+  YourSizeName: { width:  100, height: 150 } # Will resize to fit in 100x150 px
+  YourSizeName: { original: true } # Will save the original size. Don't worry. The server compress to 50% of quality.
+  ```
+  You can have many sizes when posting a image:
+  ```
+  sizes = [
+    small:     { width:  100 }
+    gallery:   { height: 300 }
+    mini-home: { width: 50, height: 50 }
+    original:  true
+  ]
+  ```
+### Compression
+  The images always are compressed to 70%. Except for the original size (50%).

data/Rakefile

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

data/imager.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imager"
+  spec.version       = Imager::VERSION
+  spec.authors       = ["Guilherme Otranto"]
+  spec.email         = ["guilherme_otran@hotmail.com"]
+  spec.description   = %q{A remote storange and resizer client for images.}
+  spec.summary       = %q{Imager Client API}
+  spec.homepage      = "https://github.com/guilherme-otran/Imager"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "httmultiparty"
+end

data/lib/imager/server_client.rb

@@ -0,0 +1,5 @@
+require 'httmultiparty'
+
+class ServerClient
+  include HTTMultiParty
+end

data/lib/imager/server_interface.rb

@@ -0,0 +1,74 @@
+require 'debugger'
+require 'openssl'
+require 'cgi'
+
+module Imager
+  class ServerInterface
+    def self.post(collection, album, file, sizes)
+      query = {}
+      query[:collection] = collection
+      query[:album]      = album
+      query[:sizes]      = sizes
+
+      auth = auth_token(query, file)
+      query[:file] = File.new(file)
+      query[:auth] = auth
+
+      return parse(client.post('/post.php', { query: query }))
+    end
+
+    def self.delete(collection, album, file_id)
+      query = {}
+      query[:collection] = collection
+      query[:album]      = album
+      query[:file_id]    = file_id
+      query[:auth]       = auth_token(query)
+
+      return parse(client.post('/delete.php', { query: query }))
+    end
+
+    def self.client
+      unless ServerClient.base_uri
+        ServerClient.base_uri Imager.base_uri + '/' + Imager.manager_path
+      end
+      ServerClient
+    end
+
+    private
+
+    def self.parse(response)
+      case response.code
+      when 200..299
+        return true
+      when 400
+        raise ArgumentError, response.body, caller
+      when 401
+        raise Error, "Authentication failed."
+      else
+        raise Error, "The server returned an error."
+      end
+    end
+
+    def self.auth_token(query, file=nil)
+      query_hash = query.clone
+      if file
+        query_hash[:file_md5]   = Digest::MD5.file(file)
+        query_hash[:file_sha1]  = Digest::SHA1.file(file)
+        query_hash[:file_name]  = File.basename(file)
+      end
+
+      query_hash = to_query(query_hash)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('md5'), Imager.auth_code, query_hash)
+    end
+
+    def self.to_query(hash, namespace=false)
+      if(hash.is_a? Hash)
+        hash.collect do |k, v|
+          to_query(v, namespace ? "#{namespace}[#{k}]" : k)
+        end.join '&'
+      else
+        CGI.escape(namespace.to_s) + "=" + CGI.escape(hash.to_s)
+      end
+    end
+  end
+end

data/lib/imager/version.rb

@@ -0,0 +1,3 @@
+module Imager
+  VERSION = "0.0.1"
+end

data/lib/imager.rb

@@ -0,0 +1,15 @@
+require "imager/version"
+require "imager/server_client"
+require "imager/server_interface"
+
+module Imager
+
+  class << self
+    attr_accessor :manager_path, :collection_path, :auth_code, :base_uri
+
+    def configure
+      yield self
+    end
+  end
+
+end

data/test/test_imager.rb

@@ -0,0 +1,104 @@
+require 'test/unit'
+require 'imager'
+
+
+class ImagerTest < Test::Unit::TestCase
+  def your_base_uri;         "http://localhost/projects/imager_server"; end;
+  def your_manager_path;     "manager"; end;
+  def your_collections_path; "images"; end;
+  def your_auth_code;        ""; end;
+
+  def test_configure
+    Imager.configure do |c|
+      assert_equal c, Imager
+    end
+  end
+
+  def test_set_server_uri
+    Imager.configure do |c|
+      c.base_uri = your_base_uri
+    end
+
+    assert_equal your_base_uri, Imager.base_uri
+  end
+
+  def test_set_manager_path
+    Imager.configure do |c|
+      c.manager_path = your_manager_path
+    end
+
+    assert_equal your_manager_path, Imager.manager_path
+  end
+
+  def test_set_collection_path
+    Imager.configure do |c|
+      c.collection_path = your_collections_path
+    end
+
+    assert_equal your_collections_path, Imager.collection_path
+  end
+
+  def test_set_auth_code
+    Imager.configure do |c|
+      c.auth_code = your_auth_code
+    end
+
+    assert_equal your_auth_code, Imager.auth_code
+  end
+
+  def test_valid_post_image
+    Imager.configure do |c|
+      c.base_uri = your_base_uri
+      c.auth_code = your_auth_code
+      c.collection_path = your_collections_path
+      c.manager_path = your_manager_path
+    end
+
+    response = Imager::ServerInterface.post("testcollection", "1", "test/image.jpg", small: { width: 100})
+    assert_equal true, response
+  end
+
+  def test_invalid_post_image
+    response = true
+    begin
+      Imager.configure do |c|
+        c.base_uri = your_base_uri
+        c.auth_code = your_auth_code
+        c.collection_path = your_collections_path
+        c.manager_path = your_manager_path
+      end
+      Imager::ServerInterface.post("", "", File.new("test/test_image.jpg"), small: { width: 100})
+    rescue
+      response = false
+    end
+    assert_equal false, response
+  end
+
+  def test_valid_delete_image
+    Imager.configure do |c|
+      c.base_uri = your_base_uri
+      c.auth_code = your_auth_code
+      c.collection_path = your_collections_path
+      c.manager_path = your_manager_path
+    end
+
+    response = Imager::ServerInterface.delete("testcollection", "1", "image")
+    assert_equal true, response
+  end
+
+  def test_invalid_delete_image
+    response = true
+    begin
+      Imager.configure do |c|
+        c.base_uri = your_base_uri
+        c.auth_code = your_auth_code
+        c.collection_path = your_collections_path
+        c.manager_path = your_manager_path
+      end
+      Imager::ServerInterface.delete("testcollection", "1", "non_existing_image")
+    rescue
+      response = false
+    end
+    assert_equal false, response
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: imager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Guilherme Otranto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A remote storange and resizer client for images.
+email:
+- guilherme_otran@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- imager.gemspec
+- lib/imager.rb
+- lib/imager/server_client.rb
+- lib/imager/server_interface.rb
+- lib/imager/version.rb
+- test/image.jpg
+- test/test_imager.rb
+homepage: https://github.com/guilherme-otran/Imager
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Imager Client API
+test_files:
+- test/image.jpg
+- test/test_imager.rb