manipulator 0.1.0 → 1.0.0

data/README.rdoc

@@ -1,41 +1,34 @@
-= manipulator
+= Manipulator
 
 S3 is great for storing image files, but manipulating images after they've been saved to S3 (rotating, resizing, cropping, etc.) is a bit of a chore.  Usually it goes something like this:
 
 * download file from S3, save to local tmp file
-* run imagemagick over local tmp file
+* run graphics or image magick over local tmp file
 * push modified image back to S3
 * remember to clean up tmp file
 
 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.manipulate('my-bucket','some/file.jpg') do |img|
-   img.rotate(90).resize_to_fit(75,75)
+ m.manipulate({:bucket => 'my-bucket', :key => 'some/file.jpg'}) do |img|
+   img.rotate(90)
+   img.resize_to_fit(75,75)
  end
 
-The idea is to instantiate a Manipulator and then pass it a bucket name and key to manipulate.  Manipulator will download your image to a local tmp file, then yield an RMagick Image wrapping that file.  Call methods on the yielded image to make modifications; as soon as the block returns, the modified image is pushed back to S3 and the tmp file is removed.
-
-== Install
-
-Manipulator is released on gemcutter. If you haven't already set yourself up with that, here's how:
+The idea is to instantiate a Manipulator and then pass it a bucket name and key to manipulate.  Manipulator will download your image to a local tmp file, then yield a MiniMagick::Image wrapping that file.  Call methods on the yielded image to make modifications; as soon as the block returns, the modified image is pushed back to S3 and the tmp file is removed.
 
- $ gem install gemcutter
- $ gem tumble
+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.
 
-Then, to install Manipulator:
+== Install
 
  $ gem install manipulator
 
-You can also just declare the source:
-
- $ gem install manipulator -s http://gemcutter.org
 
 == Dependencies
 
-* AWSCredentials (http://github.com/bkoski/aws_credentials)
-* AWS/S3 (http://gemcutter.org/gems/aws-s3)
+* AWS/S3 (http://rubygems.org/gems/aws-s3)
+* AWSCredentials (http://rubygems.org/gems/aws_credentials)
+* MiniMagick (http://rubygems.org/gems/mini_magick)
 
 == Future
 
@@ -43,4 +36,4 @@ You can also just declare the source:
 
 == Copyright
 
-Copyright (c) 2009 The New York Times Company. See LICENSE for details.
+Copyright (c) 2010 The New York Times Company. See LICENSE for details.

data/lib/manipulator/manipulator.rb

@@ -1,58 +1,59 @@
-# Tries to avoid case-sensitivity issues when requiring RMagick.
-# Borrowed from jnicklas' carrierwave.
-unless defined? Magick
-  begin
-    require 'rmagick'
-  rescue LoadError
-    require 'RMagick'
-  rescue LoadError
-    puts "WARNING: Failed to require rmagick, image processing may fail!"
-  end 
-end
-
+require 'mini_magick'
 
 # Using Manipulator is as simple as creating an instance and calling manipulate.
 #
 # The connection to S3 is opened using credentials read from AWSCredentials.
 class Manipulator
-  
-  # Path to the local temp file used during manipulation
   attr_accessor :temp_file_path
 
-  # Downloads the specified bucket, key from S3 to a local temp file
-  # and sets temp_file_path
+  # Establishes a connection to S3 if not already connected
+  def connect_to_s3
+    unless AWS::S3::Base.connected?
+      AWS::S3::Base.establish_connection!(:access_key_id => AWSCredentials.access_key, :secret_access_key => AWSCredentials.secret_access_key)
+    end
+  end
+
+  # Downloads the specified key from the S3 bucket to a local temp file
   def download(bucket, key)
-    AWS::S3::Base.establish_connection!(:access_key_id => AWSCredentials.access_key, :secret_access_key => AWSCredentials.secret_access_key)
+    connect_to_s3
     @temp_file_path = File.join(Dir.tmpdir, key.gsub('/', '-'))
     File.open(temp_file_path, 'w+') do |f|
       f.puts AWS::S3::S3Object.value(key,bucket)
     end
   end
-  
+
   # Pushes contents of temp file back to specified bucket, key on S3
+  # Returns the url for the file
   def upload(bucket, key)
+    connect_to_s3
     AWS::S3::S3Object.store(key, File.open(temp_file_path, 'r'), bucket, :access => :public_read)
+    AWS::S3::S3Object.url_for(key, bucket, :authenticated => false)
   end
 
   # Specify a S3 key to manipulate (and its bucket).
   #
-  # Block yields a Magick::Image image instance with access to the usual RMagick methods.
-  # Note that RMagick methods should be chained so that block returns image with all manipulations.
+  # Block yields a MiniMagick::Image image instance with access to MiniMagick's methods
+  # Note that you don't have to chain methods to return the image with all manipulations using MiniMagick:
   # For example, use
   #  m.manipulate('my-bucket', 'my-key') do |img|
-  #    img.rotate(90).sepia_tone
+  #    img.rotate(90)
+  #    img.resize(100x100)
   #  end
-  # rather than
-  #  img.rotate(90)
-  #  img.sepia_tone
-  # This last case will only <tt>sepia_tone</tt> the image.
-  def manipulate(bucket, key, &block)
-    download(bucket, key)
+  def manipulate(options, &block)
+    # TODO: make this configurable - use graphics magick
+    MiniMagick.processor = :gm
+
+    download(options[:bucket], options[:key])
     begin
-      image = ::Magick::Image.read(temp_file_path).first
-      new_image = yield(image)
-      new_image.write(temp_file_path)
-      upload(bucket, key)
+      image = MiniMagick::Image.open(temp_file_path)
+      image.combine_options do |i|
+        yield(i)
+      end
+      image.write(temp_file_path)
+      upload(options[:bucket], options[:key]) unless options[:keep_local]
+    rescue Exception => e
+      puts e.message
+      puts e.backtrace
     ensure
       cleanup
     end
@@ -62,5 +63,5 @@ class Manipulator
   def cleanup
     File.delete(temp_file_path)
   end
-  
-end
+
+end

data/test/test_manipulator.rb

@@ -14,13 +14,29 @@ class TestManipulator < Test::Unit::TestCase
     File.stubs(:open).returns(@new_file)
   end
 
+  context "#connect_to_s3" do
+    setup do
+      @manipulator = Manipulator.new
+    end
+    should "use existing connection" do
+      AWS::S3::Base.stubs(:connected?).returns(true)
+      AWS::S3::Base.expects(:establish_connection!).never
+      @manipulator.connect_to_s3
+    end
+    should "establish a new connection if none exists" do
+      AWS::S3::Base.stubs(:connected?).returns(false)
+      AWS::S3::Base.expects(:establish_connection!).with(:access_key_id => @access_key, :secret_access_key => @secret_key)
+      @manipulator.connect_to_s3
+    end
+  end
   context "#download" do
     setup do
       @manipulator = Manipulator.new
+      @manipulator.stubs(:connect_to_s3)
       AWS::S3::S3Object.stubs(:value).returns('123')
     end
-    should "establish connection with credentials from aws_credentials" do
-      AWS::S3::Base.expects(:establish_connection!).with(:access_key_id => @access_key, :secret_access_key => @secret_key)
+    should "connect to s3" do
+      @manipulator.expects(:connect_to_s3)
       @manipulator.download(@bucket, @key)
     end
     should "set temp_file_path, replacing any /s with -s" do
@@ -38,48 +54,53 @@ class TestManipulator < Test::Unit::TestCase
   context "#manipulate" do
     setup do
       @manipulator = Manipulator.new
+      @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 rmagick instance')
-      Magick::Image.stubs(:read).returns([@mocked])
+      @mocked = mock('fake mini_magick instance')
+      MiniMagick::Image.stubs(:read).returns(@mocked)
       @mocked.stubs(:write)
     end
 
     should "download the file" do
       @manipulator.expects(:download).with(@bucket, @key).returns(@key)
-      @manipulator.manipulate(@bucket, @key) { |img| img }
+      @manipulator.manipulate({:bucket => @bucket, :key => @key}) { |img| img }
     end
-    should "create an RMagick Image instance and yield it to the block" do
-      Magick::Image.expects(:read).with(@temp_file_path).returns([@mocked])
-      @manipulator.manipulate(@bucket, @key) do |img|
+    should "create an MiniMagick Image instance and yield it to the block" do
+      MiniMagick::Image.expects(:read).with(@temp_file_path).returns(@mocked)
+      @manipulator.manipulate({:bucket => @bucket, :key => @key}) do |img|
         assert_equal @mocked, img
         img
       end
     end
     should "write the returned manipulated image to the temp file" do
       @mocked.expects(:write).with(@temp_file_path)
-      Magick::Image.stubs(:read).with(@temp_file_path).returns([@mocked])
-      @manipulator.manipulate(@bucket, @key) { |img| img }
+      MiniMagick::Image.stubs(:read).with(@temp_file_path).returns(@mocked)
+      @manipulator.manipulate({:bucket => @bucket, :key => @key}) { |img| img }
     end
     should "upload the file back to s3" do
       @manipulator.expects(:upload).with(@bucket, @key)
-      @manipulator.manipulate(@bucket, @key) { |img| img }
+      @manipulator.manipulate({:bucket => @bucket, :key => @key}) { |img| img }
+    end
+    should "not upload the file back to s3 when the keep_local option is passed" do
+      @manipulator.expects(:upload).never
+      @manipulator.manipulate({:bucket => @bucket, :key => @key, :keep_local => true}) { |img| img }
     end
     should "not run cleanup if download raises an error" do
       @manipulator.stubs(:download).raises('foo')
       @manipulator.expects(:cleanup).never
       begin
-        @manipulator.manipulate(@bucket, @key) { |img| img }
+        @manipulator.manipulate({:bucket => @bucket, :key => @key}) {|img| img }
       rescue
       end
     end
     should "ensure that it calls cleanup if download success" do
       @manipulator.expects(:cleanup)
       begin
-        @manipulator.manipulate(@bucket, @key) do |img|
+        @manipulator.manipulate({:bucket => @bucket, :key => @key}) do |img|
           raise "an error"
         end
       rescue
@@ -89,11 +110,13 @@ class TestManipulator < Test::Unit::TestCase
 
   context "#upload" do
     setup do
+      AWS::S3::S3Object.stubs(:url_for)
       @manipulator = Manipulator.new
       @manipulator.stubs(:temp_file_path).returns(@temp_file_path)
+      @manipulator.stubs(:connect_to_s3)
     end
     should "call S3Object.store with contents of tempfile" do
-      AWS::S3::S3Object.expects(:store).with(@key,@new_file,@bucket, :access => :public_read)
+      AWS::S3::S3Object.expects(:store).with(@key, @new_file, @bucket, :access => :public_read)
       @manipulator.upload(@bucket, @key)
     end
   end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: manipulator
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jacqui Maher
@@ -10,49 +16,65 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-22 00:00:00 -05:00
+date: 2010-12-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mocha
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: aws_credentials
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: aws-s3
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id004
 description: A library to allow photo manipulation on S3 images using RMagick
 email: jacqui@brighter.net
 executables: []
@@ -79,21 +101,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: manipulate your photos on s3