ruby-thumbor 0.3.0 → 0.4.0

data/README.rdoc

@@ -6,20 +6,59 @@
 
 ruby-thumbor is the client to the thumbor imaging service (http://github.com/globocom/thumbor).
 
-== FEATURES/PROBLEMS:
+== FEATURES:
 
 * Generate thumbor encrypted URLs
 * Obtain metadata from image operations in thumbor
 
-== SYNOPSIS:
+== DEPENDENCIES
 
-crypto => new CryptoUrl key => 'my-security-key'
-url = crypyo.generate width => 200, height => 300, image => 'http://my.server.com/path/to/image.jpg'
+No dependencies required for regular usage.
+
+* thumbor (http://github.com/globocom/thumbor) for running ruby-thumbor tests.
+
+== USAGE:
+
+    crypto = CryptoURL.new :key => 'my-security-key'
+
+    url = crypto.generate :width => 200, :height => 300, :image => 'my.server.com/path/to/image.jpg'
+
+    # url will contain something like:
+    # /2913921in321n3k2nj32hjhj3h22/my.server.com/path/to/image.jpg
+
+Available arguments to the generate method:
+
+    :meta => bool - flag that indicates that thumbor should return only meta-data on the operations it would
+                    otherwise perform;
+
+    :crop => [<int>, <int>, <int>, <int>] - Coordinates for manual cropping. The first item is the two arguments are
+                                            the coordinates for the left, top point and the last two are the coordinates
+                                            for the right, bottom point (thus forming the square to crop);
+
+    :width => <int> - the width for the thumbnail;
+
+    :height => <int> - the height for the thumbnail;
+
+    :flip => <bool> - flag that indicates that thumbor should flip horizontally (on the vertical axis) the image;
+
+    :flop => <bool> - flag that indicates that thumbor should flip vertically (on the horizontal axis) the image;
+
+    :halign => :left, :center or :right - horizontal alignment that thumbor should use for cropping;
+
+    :valign => :top, :middle or :bottom - horizontal alignment that thumbor should use for cropping;
+
+    :smart => <bool> - flag that indicates that thumbor should use smart cropping;
+
+If you need more info on what each option does, check thumbor's documentation at https://github.com/globocom/thumbor/wiki.
 
 == INSTALL:
 
 * sudo gem install ruby-thumbor
 
+== CONTRIBUTIONS:
+
+* Hugo Lopes (hugobr) - Fixes in the usage readme part of the docs.
+
 == LICENSE:
 
 (The MIT License)

data/lib/ruby-thumbor.rb

@@ -6,13 +6,13 @@ require 'base64'
 require 'digest/md5'
 
 module Thumbor
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
 
     class CryptoURL
         attr_accessor :key
 
         def initialize(key)
-            @key = (key * 16)[0..16]
+            @key = (key * 16)[0..15]
         end
 
         def pad(s)
@@ -78,11 +78,11 @@ module Thumbor
 
             calculate_width_and_height(url_parts, options)
 
-            if options[:halign] and options[:halign] != 'center'
+            if options[:halign] and options[:halign] != :center
                 url_parts.push(options[:halign])
             end
 
-            if options[:valign] and options[:valign] != 'middle'
+            if options[:valign] and options[:valign] != :middle
                 url_parts.push(options[:valign])
             end
 

data/spec/ruby-thumbor_spec.rb

@@ -17,7 +17,7 @@ describe Thumbor::CryptoURL, "#new" do
 
     it "should create a new instance passing key and keep it" do
         crypto = Thumbor::CryptoURL.new key
-        crypto.key.should == 'my-security-keymy'
+        crypto.key.should == 'my-security-keym'
     end
 
 end
@@ -101,7 +101,7 @@ describe Thumbor::CryptoURL, "#url_for" do
         url.should == '-300x0/' << image_md5
     end
 
-    it "should return proper flip url if width" do
+    it "should return proper flop url if height" do
         crypto = Thumbor::CryptoURL.new key
 
         url = crypto.url_for :image => image_url, :height => 300, :flop => true
@@ -112,7 +112,7 @@ describe Thumbor::CryptoURL, "#url_for" do
     it "should return horizontal align" do
         crypto = Thumbor::CryptoURL.new key
 
-        url = crypto.url_for :image => image_url, :halign => 'left'
+        url = crypto.url_for :image => image_url, :halign => :left
 
         url.should == 'left/' << image_md5
     end
@@ -120,7 +120,7 @@ describe Thumbor::CryptoURL, "#url_for" do
     it "should not return horizontal align if it is center" do
         crypto = Thumbor::CryptoURL.new key
 
-        url = crypto.url_for :image => image_url, :halign => 'center'
+        url = crypto.url_for :image => image_url, :halign => :center
 
         url.should == image_md5
     end
@@ -128,7 +128,7 @@ describe Thumbor::CryptoURL, "#url_for" do
     it "should return vertical align" do
         crypto = Thumbor::CryptoURL.new key
 
-        url = crypto.url_for :image => image_url, :valign => 'top'
+        url = crypto.url_for :image => image_url, :valign => :top
 
         url.should == 'top/' << image_md5
     end
@@ -136,7 +136,7 @@ describe Thumbor::CryptoURL, "#url_for" do
     it "should not return vertical align if it is middle" do
         crypto = Thumbor::CryptoURL.new key
 
-        url = crypto.url_for :image => image_url, :valign => 'middle'
+        url = crypto.url_for :image => image_url, :valign => :middle
 
         url.should == image_md5
     end
@@ -144,7 +144,7 @@ describe Thumbor::CryptoURL, "#url_for" do
     it "should return halign and valign properly" do
         crypto = Thumbor::CryptoURL.new key
 
-        url = crypto.url_for :image => image_url, :halign => 'left', :valign => 'top'
+        url = crypto.url_for :image => image_url, :halign => :left, :valign => :top
 
         url.should == 'left/top/' << image_md5
     end
@@ -176,7 +176,7 @@ describe Thumbor::CryptoURL, "#url_for" do
     it "should have smart after halign and valign" do
         crypto = Thumbor::CryptoURL.new key
 
-        url = crypto.url_for :image => image_url, :halign => 'left', :valign => 'top', :smart => true
+        url = crypto.url_for :image => image_url, :halign => :left, :valign => :top, :smart => true
 
         url.should == 'left/top/smart/' << image_md5
     end
@@ -292,7 +292,7 @@ describe Thumbor::CryptoURL, "#generate" do
         crypto = Thumbor::CryptoURL.new key
 
         url = crypto.generate :width => 300, :height => 200, :meta => true, :image => image_url, :smart => true, :flip => true, :flop => true,
-                              :halign => 'left'
+                              :halign => :left
 
         encrypted = url.split('/')[1]
 
@@ -313,7 +313,7 @@ describe Thumbor::CryptoURL, "#generate" do
         crypto = Thumbor::CryptoURL.new key
 
         url = crypto.generate :width => 300, :height => 200, :meta => true, :image => image_url, :smart => true, :flip => true, :flop => true,
-                              :halign => 'left', :valign => 'top'
+                              :halign => :left, :valign => :top
 
         encrypted = url.split('/')[1]
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-thumbor
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Bernardo Heynemann
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-03 00:00:00 -03:00
+date: 2011-04-04 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency