imager 0.0.4 → 0.0.5

data/.gitignore

@@ -1,17 +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
+*.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

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

data/LICENSE.txt

@@ -1,22 +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.
+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

@@ -1,92 +1,104 @@
-# 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.
-
-[![Build Status](https://travis-ci.org/guilherme-otran/Imager.png?branch=master)](https://travis-ci.org/guilherme-otran/Imager)
-[![Dependency Status](https://gemnasium.com/guilherme-otran/Imager.png)](https://gemnasium.com/guilherme-otran/Imager)
-
-## 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", "test/image.png", small: { width: 100 })
-
-### Removing the images
-
-    Imager::ServerInterface.delete("Collection", "Album", "image")
-
-### Using the images
-
-    Imager::LinkHelper.link_for("Collection", "Album", "image", :small)
-    
-Will return:
-    "http://files.myserver.com/images/collection/album/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/image/small.jpg"
-  Just save as:
-    `Imager::ServerInterface.post("product", "1", "test/image.png", small: { width: 100 })`
-
-## Notes about saving and sizes
-  Saving first as `"product", "1", "test/image.png", small: { width: 100 })` and after `"product", "1", "test/otherimage.png", small: { width: 90 })` don't changes the size of 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: :original } # 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: :original
-  ]
-  ```
-  
-### Compression
-  The images always are compressed to 70%. Except for the original size (50%).
+# 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.
+
+[![Build Status](https://travis-ci.org/guilherme-otran/Imager.png?branch=master)](https://travis-ci.org/guilherme-otran/Imager)
+[![Dependency Status](https://gemnasium.com/guilherme-otran/Imager.png)](https://gemnasium.com/guilherme-otran/Imager)
+
+## 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", "test/imageid.png", small: { width: 100 })
+
+  Creates:
+
+    http://files.myserver.com/images/Collection/Album/imageid/small.jpg
+
+  And
+
+    Imager::ServerInterface.post("Collection", "Album", "test/image.png", small: { width: 100 }, "someimageid")
+
+  Creates
+
+    http://files.myserver.com/images/Collection/Album/someimageid/small.jpg
+
+### Removing the images
+
+    Imager::ServerInterface.delete("Collection", "Album", "imageid")
+
+### Using the images
+
+    Imager::LinkHelper.link_for("Collection", "Album", "imageid", :small)
+
+Will return:
+    "http://files.myserver.com/images/collection/album/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/image/small.jpg"
+  Just save as:
+    `Imager::ServerInterface.post("product", "1", "test/image.png", small: { width: 100 })`
+
+## Notes about saving and sizes
+  Saving first as `"product", "1", "test/image.png", small: { width: 100 })` and after `"product", "1", "test/otherimage.png", small: { width: 90 })` don't changes the size of image. Beware!
+
+### Sizes Explain:
+  The server accepts the following combinations:
+
+  ```
+  YourSizeName: :original       # Will save the original size. Don't worry. The server compress to 50% of quality.
+  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
+  ```
+
+  You can have many sizes when posting a image:
+
+  ```
+  sizes = {
+    small:     { width:  100 },
+    gallery:   { height: 300 },
+    mini-home: { width: 50, height: 50 },
+    original:  :original
+  }
+  ```
+
+### Compression
+  The images always are compressed to 70%. Except for the original size (50%).

data/imager.gemspec

@@ -1,29 +1,29 @@
-# 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_development_dependency "rspec"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "turn"
-  spec.add_dependency "httmultiparty", "~> 0.3.10"
-  spec.add_dependency "json"
-end
+# 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_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "turn"
+  spec.add_dependency "httmultiparty", "~> 0.3.10"
+  spec.add_dependency "json"
+end

data/lib/imager.rb

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

data/lib/imager/link_helper.rb

@@ -1,5 +1,9 @@
 module Imager
   class LinkHelper
+    # @param  [String]         Collection for save the image
+    # @param  [String]         Album for save the image
+    # @param  [String]         File id
+    # @param  [Symbol, String] Image Size name.
     def self.link_for(collection, album, image, size)
       size = size.to_s
       "#{Imager.base_uri}/#{Imager.collection_path}/#{collection}/#{album}/#{image}/#{size}.jpg"

data/lib/imager/server_client.rb

@@ -1,7 +1,7 @@
-require 'httmultiparty'
-
-module Imager
-  class ServerClient
-    include HTTMultiParty
-  end
+require 'httmultiparty'
+
+module Imager
+  class ServerClient
+    include HTTMultiParty
+  end
 end

data/lib/imager/server_interface.rb

@@ -1,95 +1,130 @@
-require 'openssl'
-require 'cgi'
-require 'json'
-
-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 }), true)
-    end
-
-    def self.client
-      unless Imager::ServerClient.base_uri
-        Imager::ServerClient.base_uri Imager.base_uri + '/' + Imager.manager_path
-      end
-      Imager::ServerClient
-    end
-
-    private
-
-    def self.parse(response, is_delete = false)
-      case response.code
-      when 204
-        return true
-      when 200..299
-        parsed =  begin
-                    !!JSON.parse(response.body)
-                  rescue
-                    false
-                  end
-
-        return true if parsed
-        # Something is wrong with the server
-        raise ArgumentError, "The server send an invalid response.", caller
-      when 400
-        raise ImagerError, response.body, caller
-      when 404
-        # We are deleting something that doesn't exist
-        if (is_delete && response.body == "Cannot find the file.")
-          raise ImagerError, response.body, caller
-        else
-          raise ArgumentError, "The server return an unexpected 404.", caller
-        end
-      when 401
-        # Authentication with the server failed
-        raise ArgumentError, "Authentication failed: " + response.body, caller
-      else
-        raise ArgumentError, "The server returned an error: " + response.body, caller
-      end
-    end
-
-    def self.auth_token(query, file=nil)
-      query_hash = query.clone
-      if file
-        if !File.file?(file)
-          raise ImagerError, "Invalid image file", caller
-        end
-        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
+require 'openssl'
+require 'cgi'
+require 'json'
+
+module Imager
+  class ServerInterface
+
+    # if file is a class that respond to original_filename (like UploadIO)
+    # the file id will be the original_filename.
+
+    # @param  [String]        Collection for save the image
+    # @param  [String]        Album for save the image
+    # @param  [UploadIO, File, String]  The image file or the path to it
+    # @param  [Hash]          Sizes you want to save. @see https://github.com/guilherme-otran/Imager#sizes-explain
+    # @param  [String]        File id. if passed file_id will be this instead of file.original_filename or File.basename(file).
+    # @return [void]
+    # @raise  [ImagerError]   if some server validation failed.
+    # @raise  [ArgumentError] when something with server comunication is wrong
+    def self.post(collection, album, file, sizes, file_id = nil)
+      raise Imager::ImagerError "File is empty", caller unless file
+
+      if file.is_a?(String)
+        raise Imager::ImagerError, "File is not a file", caller unless File.file?(file)
+        file = File.new(file)
+      end
+
+      query = {}
+      query[:collection] = collection
+      query[:album]      = album
+      query[:sizes]      = sizes
+
+      query[:file_id]    = file_id
+      query[:file_id]  ||= file.original_filename if file.respond_to?(:original_filename)
+      query[:file_id]  ||= File.basename(file)
+
+      # Remove file extension
+      query[:file_id].gsub!(/(\..{3,4})\z/i, '')
+
+      auth = auth_token(query, file)
+      query[:file] = file
+      query[:auth] = auth
+
+      return parse client.post('/post.php', query: query)
+    end
+
+    # @param  [String]        Collection for save the image
+    # @param  [String]        Album for save the image
+    # @param  [String]        File id
+    # @raise  [ImagerError]   if collection or album or file_id is wrong
+    # @raise  [ArgumentError] when something with server comunication is wrong
+    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), true
+    end
+
+    def self.client
+      unless Imager::ServerClient.base_uri
+        Imager::ServerClient.base_uri Imager.base_uri + '/' + Imager.manager_path
+      end
+      Imager::ServerClient
+    end
+
+    private
+
+    def self.parse(response, is_delete = false)
+      case response.code
+      when 204
+        return true
+      when 200..299
+        parsed =  begin
+                    !!JSON.parse(response.body)
+                  rescue
+                    false
+                  end
+
+        return true if parsed
+        # Something is wrong with the server
+        raise ArgumentError, "The server send an invalid response.", caller
+      when 422
+        raise ImagerError, response.body, caller
+      when 404
+        # We are deleting something that doesn't exist
+        if (is_delete && response.body == "Cannot find the file.")
+          raise ImagerError, response.body, caller
+        else
+          raise ArgumentError, "The server return an unexpected 404.", caller
+        end
+      when 401
+        # Authentication with the server failed
+        raise ArgumentError, "Authentication failed: " + response.body, caller
+      else
+        raise ArgumentError, "The server returned an error: " + response.body, caller
+      end
+    end
+
+    def self.auth_token(query, file=nil)
+      query_hash = query.clone
+      if file
+        begin
+          query_hash[:file_md5]   = Digest::MD5.file(file)
+          query_hash[:file_sha1]  = Digest::SHA1.file(file)
+        rescue
+          raise Imager::ImagerError, "Cannot read the file", caller unless file.respond_to?(:read)
+
+          # Fix for rubinius
+          query_hash[:file_md5]  = Digest::MD5.hexdigest(file.read)
+          query_hash[:file_sha1] = Digest::SHA1.hexdigest(file.read)
+        end
+      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