manipulator 1.0.0 → 1.1.0

data/README.rdoc

@@ -9,7 +9,7 @@ S3 is great for storing image files, but manipulating images after they've been
 
 After re-implementing this pattern a few times over (and filling up /tmp by forgetting the last step), we decided to roll this into a gem that makes S3 image manipulation as easy as:
 
- m = Manipulator.new
+ m = Manipulator.new(:processor => :gm) # use GraphicsMagick; defaults to ImageMagick
  m.manipulate({:bucket => 'my-bucket', :key => 'some/file.jpg'}) do |img|
    img.rotate(90)
    img.resize_to_fit(75,75)
@@ -19,6 +19,11 @@ The idea is to instantiate a Manipulator and then pass it a bucket name and key
 
 We're using MiniMagick now instead of RMagick to save memory - we found that RMagick was a hog. MiniMagick is a lot more straightforward and has a nice interface for both GraphicsMagick (recommended) and ImageMagick.
 
+Want to do something that MiniMagick doesn't directly support, like removing all profiles from an image with GraphicsMagick (aka ImageMagick's strip method)?
+ m.manipulate('my-bucket', 'my-key' do |img|
+   `gm mogrify +profile '*' #{manipulator.temp_file_path}`
+ end
+
 == Install
 
  $ gem install manipulator

data/lib/manipulator/manipulator.rb

@@ -5,6 +5,9 @@ require 'mini_magick'
 # The connection to S3 is opened using credentials read from AWSCredentials.
 class Manipulator
   attr_accessor :temp_file_path
+  def initialize(options = {})
+    MiniMagick.processor = options[:processor]
+  end
 
   # Establishes a connection to S3 if not already connected
   def connect_to_s3
@@ -39,9 +42,12 @@ class Manipulator
   #    img.rotate(90)
   #    img.resize(100x100)
   #  end
+  # Want to do something that MiniMagick doesn't directly support, like
+  # removing all profiles from an image with GraphicsMagick (aka ImageMagick's strip method)
+  # m.manipulate('my-bucket', 'my-key' do |img|
+  #   `gm mogrify +profile '*' #{manipulator.temp_file_path}`
+  # end
   def manipulate(options, &block)
-    # TODO: make this configurable - use graphics magick
-    MiniMagick.processor = :gm
 
     download(options[:bucket], options[:key])
     begin
@@ -50,7 +56,11 @@ class Manipulator
         yield(i)
       end
       image.write(temp_file_path)
-      upload(options[:bucket], options[:key]) unless options[:keep_local]
+
+      unless options[:keep_local]
+        target_key = options[:target_key] || options[:key]
+        upload(options[:bucket], target_key)
+      end
     rescue Exception => e
       puts e.message
       puts e.backtrace

data/test/test_manipulator.rb

@@ -16,7 +16,7 @@ class TestManipulator < Test::Unit::TestCase
 
   context "#connect_to_s3" do
     setup do
-      @manipulator = Manipulator.new
+      @manipulator = Manipulator.new(:processor => :gm)
     end
     should "use existing connection" do
       AWS::S3::Base.stubs(:connected?).returns(true)
@@ -31,7 +31,7 @@ class TestManipulator < Test::Unit::TestCase
   end
   context "#download" do
     setup do
-      @manipulator = Manipulator.new
+      @manipulator = Manipulator.new(:processor => :gm)
       @manipulator.stubs(:connect_to_s3)
       AWS::S3::S3Object.stubs(:value).returns('123')
     end
@@ -53,16 +53,15 @@ class TestManipulator < Test::Unit::TestCase
 
   context "#manipulate" do
     setup do
-      @manipulator = Manipulator.new
+      @manipulator = Manipulator.new(:processor => :gm)
       @manipulator.stubs(:connect_to_s3)
       @file = stub_everything('fake file')
       @manipulator.stubs(:download).returns(@key)
-      @manipulator.stubs(:upload)
       @manipulator.stubs(:cleanup)
       @manipulator.stubs(:temp_file_path).returns(@temp_file_path)
-      @mocked = mock('fake mini_magick instance')
-      MiniMagick::Image.stubs(:read).returns(@mocked)
-      @mocked.stubs(:write)
+      @manipulator.stubs(:upload)
+      @mocked = stub_everything('fake mini_magick instance')
+      MiniMagick::Image.stubs(:open).with(@temp_file_path).returns(@mocked)
     end
 
     should "download the file" do
@@ -70,7 +69,8 @@ class TestManipulator < Test::Unit::TestCase
       @manipulator.manipulate({:bucket => @bucket, :key => @key}) { |img| img }
     end
     should "create an MiniMagick Image instance and yield it to the block" do
-      MiniMagick::Image.expects(:read).with(@temp_file_path).returns(@mocked)
+      @manipulator.stubs(:upload)
+      MiniMagick::Image.expects(:open).with(@temp_file_path).returns(@mocked)
       @manipulator.manipulate({:bucket => @bucket, :key => @key}) do |img|
         assert_equal @mocked, img
         img
@@ -78,7 +78,7 @@ class TestManipulator < Test::Unit::TestCase
     end
     should "write the returned manipulated image to the temp file" do
       @mocked.expects(:write).with(@temp_file_path)
-      MiniMagick::Image.stubs(:read).with(@temp_file_path).returns(@mocked)
+      @manipulator.stubs(:upload)
       @manipulator.manipulate({:bucket => @bucket, :key => @key}) { |img| img }
     end
     should "upload the file back to s3" do
@@ -103,7 +103,9 @@ class TestManipulator < Test::Unit::TestCase
         @manipulator.manipulate({:bucket => @bucket, :key => @key}) do |img|
           raise "an error"
         end
-      rescue
+      rescue Exception => e
+        puts e.message
+        puts e.backtrace
       end
     end
   end
@@ -111,7 +113,7 @@ class TestManipulator < Test::Unit::TestCase
   context "#upload" do
     setup do
       AWS::S3::S3Object.stubs(:url_for)
-      @manipulator = Manipulator.new
+      @manipulator = Manipulator.new(:processor => :gm)
       @manipulator.stubs(:temp_file_path).returns(@temp_file_path)
       @manipulator.stubs(:connect_to_s3)
     end
@@ -124,7 +126,7 @@ class TestManipulator < Test::Unit::TestCase
 
   context "#cleanup" do
     setup do
-      @manipulator = Manipulator.new
+      @manipulator = Manipulator.new(:processor => :gm)
       @key = File.join(File.dirname(__FILE__), 'data', 'ham.jpg')
       @manipulator.stubs(:temp_file_path).returns(@temp_file_path)
       Manipulator.any_instance.stubs(:download)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: manipulator
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jacqui Maher
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-01 00:00:00 -05:00
+date: 2010-12-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency