imagery 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+/.rvmrc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Cyril David
+
+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.rdoc

@@ -0,0 +1,17 @@
+= imagery
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Cyril David. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "imagery"
+    gem.summary = %Q{Image resizing without all the bloat}
+    gem.description = %Q{Uses ImageMagick directly underneath. Nuff said.}
+    gem.email = "cyx.ucron@gmail.com"
+    gem.homepage = "http://github.com/sinefunc/imagery"
+    gem.authors = ["Cyril David"]
+    gem.add_dependency "escape", ">= 0"
+    gem.add_development_dependency "contest", ">= 0"
+    gem.add_development_dependency "aws-s3", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "imagery #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/imagery.rb

@@ -0,0 +1,20 @@
+require 'escape'
+require 'fileutils'
+
+module Imagery
+  VERSION = "0.0.1"
+  
+  autoload :Model,  "imagery/model"
+  autoload :Faking, "imagery/faking"
+  autoload :S3,     "imagery/s3"
+
+  def new(*args, &blk)
+    Model.new(*args, &blk)
+  end
+  module_function :new
+  
+  def faked(&blk)
+    Model.faked(&blk)
+  end
+  module_function :faked
+end

data/lib/imagery/faking.rb

@@ -0,0 +1,30 @@
+module Imagery
+  module Faking
+    def self.included(base)
+      base.extend ClassMethods
+    end
+      
+    module ClassMethods
+      def mode=(mode)
+        @mode = mode
+      end
+
+      def mode
+        @mode
+      end
+
+      def faked
+        @omode, @mode = @mode, :fake
+        yield
+      ensure
+        @mode = @omode
+      end
+    end
+
+    def save(io)
+      return true if self.class.mode == :fake
+
+      super
+    end
+  end
+end

data/lib/imagery/model.rb

@@ -0,0 +1,85 @@
+module Imagery
+  class Model 
+    UnknownSize = Class.new(StandardError)
+
+    attr :key
+    attr :namespace
+    attr :default
+    attr :directory
+
+    attr_writer   :root, :sizes
+    
+    def initialize(model, key = model.id, namespace = model.class.name.split('::').last.downcase)
+      @key       = key.to_s
+      @namespace = namespace
+      @default   = { :original => ["1920x1200>"] }
+      @directory = 'public/system'
+      @sizes     = {}
+    end
+    
+    def sizes
+      @sizes.merge(@default)
+    end
+    
+    def file(size = :original)
+      raise UnknownSize, "#{ size } is not defined" unless sizes.has_key?(size)
+
+      root_path(directory, namespace, key, filename(size))
+    end
+
+    def tmp
+      root_path(directory, namespace, key, 'tmp')
+    end
+
+    def url(size = :original)
+      file(size).split('public').last
+    end
+    
+    module Persistence
+      def save(io)
+        FileUtils.mkdir_p(File.dirname(tmp))
+        File.open(tmp, "wb") { |target| target.write(io.read) }
+        sizes.keys.each { |size| convert(size) }
+        FileUtils.rm(tmp)
+        
+        return true
+      end
+
+      def delete
+        FileUtils.rm_rf File.dirname(file)
+        return true
+      end
+    end
+    include Persistence
+
+  private
+    def filename(size)
+      "%s.png" % size
+    end
+    
+    def convert(size, geometry = self.sizes[size][0], extent = self.sizes[size][1])
+      `#{ cmd size }`    
+    end
+
+    def cmd(size, geometry = self.sizes[size][0], extent = self.sizes[size][1])
+      cmd = [].tap do |cmd|
+        cmd.push 'convert', tmp
+        cmd.push '-thumbnail', geometry
+        cmd.push '-gravity', 'center'
+        cmd.push '-extent', extent  if extent
+        cmd.push file(size)
+      end
+
+      Escape.shell_command(cmd)
+    end
+    
+    def root(root = defined?(ROOT_DIR) && ROOT_DIR)
+      @root ||= root if root
+      @root
+    end
+   
+    def root_path(*args)
+      File.join(root, *args)
+    end
+  end
+end

data/lib/imagery/s3.rb

@@ -0,0 +1,74 @@
+require 'aws/s3'
+
+module Imagery
+  module S3
+    def self.included(base)
+      class << base
+        attr_accessor :s3_bucket, :s3_distribution_domain
+      end
+    end
+    
+    S3_HOST = "http://s3.amazonaws.com"
+
+    def url(size = :original)
+      if domain = self.class.s3_distribution_domain
+        [domain, namespace, key, filename(size)].join('/')
+      else
+        [S3_HOST, self.class.s3_bucket, namespace, key, filename(size)].join('/')
+      end
+    end
+
+    def save(io)
+      if super
+        s3_object_keys.each do |key, size|
+          Gateway.store(key,
+            File.open(file(size)),
+            self.class.s3_bucket,
+            :access => :public_read,
+            :content_type => "image/png"
+          )
+        end
+      end
+    end
+
+    def delete
+      super
+      s3_object_keys.each do |key, size|
+        Gateway.delete key, self.class.s3_bucket
+      end
+    end
+
+  protected
+    def s3_object_keys
+      sizes.keys.map do |size|
+        [[namespace, key, filename(size)].join('/'), size]
+      end
+    end
+
+    module Gateway
+      def store(*args)
+        execute(:store, *args)
+      end
+      module_function :store
+      
+      def delete(*args)
+        execute(:delete, *args)
+      end
+      module_function :delete
+    
+    private
+      def execute(command, *args)
+        begin
+          AWS::S3::S3Object.__send__(command, *args)
+        rescue AWS::S3::NoConnectionEstablished
+          AWS::S3::Base.establish_connection!(
+            :access_key_id     => ENV["AMAZON_ACCESS_KEY_ID"],
+            :secret_access_key => ENV["AMAZON_SECRET_ACCESS_KEY"]
+          )
+          retry
+        end
+      end
+      module_function :execute
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'contest'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'imagery'
+
+class Test::Unit::TestCase
+  FIXTURES = File.dirname(__FILE__) + '/fixtures'
+end

data/test/test_imagery.rb

@@ -0,0 +1,152 @@
+require 'helper'
+require 'benchmark'
+
+class Imagery::Model
+  include Imagery::Faking
+end
+
+class TestImagery < Test::Unit::TestCase
+  Photo = Class.new(Struct.new(:id))
+
+  test "namespace" do
+    assert_equal 'photo', Imagery.new(Photo.new(1001)).namespace
+  end
+
+  test "key" do
+    assert_equal '1001', Imagery.new(Photo.new(1001)).key
+  end
+
+  test "root_path when no ROOT_DIR" do
+    imagery = Imagery.new(Photo.new(1001))
+    imagery.root = '/'
+    assert_equal "/public/system/photo/1001/tmp", imagery.tmp
+  end
+
+  test "root_path when ROOT_DIR defined on imagery" do
+    Imagery::ROOT_DIR = '/root/dir'
+
+    imagery = Imagery.new(Photo.new(1001))
+    assert_equal "/root/dir/public/system/photo/1001/tmp", imagery.tmp
+
+    Imagery.send :remove_const, :ROOT_DIR
+  end
+
+  test "root_path when ROOT_DIR defined on object" do
+    Object::ROOT_DIR = '/root/dir'
+
+    imagery = Imagery.new(Photo.new(1001))
+    assert_equal "/root/dir/public/system/photo/1001/tmp", imagery.tmp
+
+    Object.send :remove_const, :ROOT_DIR
+  end
+  
+  describe "file" do
+    setup do
+      @imagery = Imagery.new(Photo.new(1001))
+      @imagery.root = '/r/d'
+      @imagery.sizes = { :thumb => ['10x10'] }
+    end
+
+    test "file by default" do
+      assert_equal "/r/d/public/system/photo/1001/original.png", @imagery.file
+    end
+
+    test "file given a size" do
+      assert_equal "/r/d/public/system/photo/1001/thumb.png", @imagery.file(:thumb)
+    end
+  end
+
+  describe "convert" do
+    setup do
+      @imagery = Imagery.new(Photo.new(1001))
+      @imagery.root = '/r/d'
+      @imagery.sizes = {
+        :thumb => ["56x56^"],
+        :small => ["56x56^", "56x56"]
+      }
+    end
+
+    test "default resize" do
+      expected = 
+        "convert /r/d/public/system/photo/1001/tmp -thumbnail '56x56^' " +
+        "-gravity center /r/d/public/system/photo/1001/thumb.png"
+
+      assert_equal expected, @imagery.send(:cmd, :thumb),
+    end
+
+    test "resize with extent param" do
+      expected = 
+        "convert /r/d/public/system/photo/1001/tmp -thumbnail '56x56^' " +
+        "-gravity center -extent 56x56 /r/d/public/system/photo/1001/small.png"
+
+      assert_equal expected, @imagery.send(:cmd, :small)
+    end
+  end
+
+  describe "saving" do
+    setup do
+      @imagery = Imagery.new(Photo.new(1001))
+      @imagery.root = '/tmp'
+      @imagery.sizes = {
+        :thumb => ["56x56^"],
+        :small => ["100x100^", "100x100"],
+        :large => ["200x200>", "200x200"]
+      }
+    end
+
+    teardown do
+      FileUtils.rm_rf '/tmp/public'
+    end
+    
+    test "writes all the different geometry sizes normally" do
+      assert @imagery.save(File.open(FIXTURES + '/lake.jpg'))
+    
+      assert File.exist?(@imagery.file)
+      assert File.exist?(@imagery.file(:thumb))
+      assert File.exist?(@imagery.file(:small))
+      assert File.exist?(@imagery.file(:large))
+    end
+
+    test "able to delete them" do
+      @imagery.save(File.open(FIXTURES + '/lake.jpg'))
+      @imagery.delete
+
+      assert ! File.exist?(@imagery.file)
+      assert ! File.exist?(@imagery.file(:thumb))
+      assert ! File.exist?(@imagery.file(:small))
+      assert ! File.exist?(@imagery.file(:large))
+    end
+
+    test "when mode == :fake" do
+      time = Benchmark.realtime { 
+        Imagery.faked { 
+          assert @imagery.save(File.open(FIXTURES + '/lake.jpg'))
+        }
+      }
+
+      assert time < 0.01, "Faked context should run in less than 0.01 secs"
+    end
+  end
+
+  describe "url" do
+    setup do
+      @imagery = Imagery.new(Photo.new(1001))
+      @imagery.root = '/tmp'
+      @imagery.sizes = { :small => ["40x40"] }
+    end
+
+    test "original" do
+      assert_equal '/system/photo/1001/original.png', @imagery.url
+    end
+
+    test "small" do
+      assert_equal '/system/photo/1001/small.png', @imagery.url(:small)
+    end
+
+    test "non-existent" do
+      assert_raise Imagery::Model::UnknownSize do
+        @imagery.url(:foo)
+      end
+    end
+  end
+end

data/test/test_with_s3.rb

@@ -0,0 +1,116 @@
+require "helper"
+
+class WithS3Test < Test::Unit::TestCase
+  class WithS3 < Imagery::Model
+    include Imagery::Faking
+    include Imagery::S3
+
+    self.s3_bucket = "tmp-bucket-name"
+  end
+
+  SuperSecretPhoto = Class.new(Struct.new(:id))
+  
+  test "urls" do
+    imagery = WithS3.new(SuperSecretPhoto.new(1001))
+    imagery.root = '/tmp'
+    imagery.sizes = {
+      :thumb => ["56x56^"],
+      :small => ["100x100^", "100x100"],
+      :large => ["200x200>", "200x200"]
+    }
+    
+    s = 'http://s3.amazonaws.com/tmp-bucket-name/supersecretphoto/1001/%s.png'
+
+    assert_equal s % 'original', imagery.url
+    assert_equal s % 'original', imagery.url(:original)
+    assert_equal s % 'thumb', imagery.url(:thumb)
+    assert_equal s % 'small', imagery.url(:small)
+    assert_equal s % 'large', imagery.url(:large)
+  end
+
+  test "urls with a distribution domain" do
+    imagery = WithS3.new(SuperSecretPhoto.new(1001))
+    imagery.root = '/tmp'
+    imagery.sizes = {
+      :thumb => ["56x56^"],
+      :small => ["100x100^", "100x100"],
+      :large => ["200x200>", "200x200"]
+    }
+    
+    s = 'http://assets.site.com/supersecretphoto/1001/%s.png'
+    
+    WithS3.s3_distribution_domain = 'http://assets.site.com'
+
+    assert_equal s % 'original', imagery.url
+    assert_equal s % 'original', imagery.url(:original)
+    assert_equal s % 'thumb', imagery.url(:thumb)
+    assert_equal s % 'small', imagery.url(:small)
+    assert_equal s % 'large', imagery.url(:large)
+
+    WithS3.s3_distribution_domain = nil
+  end
+
+  test "saving and storing" do
+    imagery = WithS3.new(SuperSecretPhoto.new(1001))
+    imagery.root = '/tmp'
+    imagery.sizes = {
+      :thumb => ["56x56^"],
+      :small => ["100x100^", "100x100"],
+      :large => ["200x200>", "200x200"]
+    }
+
+    File.stubs(:open).returns(:contents)
+
+    Imagery::S3::Gateway.expects(:store).with() { |key, io, bucket, hash|
+      key == "supersecretphoto/1001/thumb.png" && bucket == 'tmp-bucket-name' &&
+        hash[:access] == :public_read && hash[:content_type] == 'image/png' &&
+        io == :contents
+    }
+
+    Imagery::S3::Gateway.expects(:store).with() { |key, io, bucket, hash|
+      key == "supersecretphoto/1001/small.png" && bucket == 'tmp-bucket-name' &&
+        hash[:access] == :public_read && hash[:content_type] == 'image/png' &&
+        io == :contents
+    }
+
+    Imagery::S3::Gateway.expects(:store).with() { |key, io, bucket, hash|
+      key == "supersecretphoto/1001/large.png" && bucket == 'tmp-bucket-name' &&
+        hash[:access] == :public_read && hash[:content_type] == 'image/png' &&
+        io == :contents
+    }
+  
+    Imagery::S3::Gateway.expects(:store).with() { |key, io, bucket, hash|
+      key == "supersecretphoto/1001/original.png" && bucket == 'tmp-bucket-name' &&
+        hash[:access] == :public_read && hash[:content_type] == 'image/png' &&
+        io == :contents
+    }
+    
+    WithS3.faked do
+      assert imagery.save(File.open(FIXTURES + '/lake.jpg'))
+    end
+  end
+
+  test "deleting" do
+    imagery = WithS3.new(SuperSecretPhoto.new(1001))
+    imagery.root = '/tmp'
+    imagery.sizes = {
+      :thumb => ["56x56^"],
+      :small => ["100x100^", "100x100"],
+      :large => ["200x200>", "200x200"]
+    }
+
+    Imagery::S3::Gateway.expects(:delete).
+      with('supersecretphoto/1001/thumb.png', 'tmp-bucket-name')
+
+    Imagery::S3::Gateway.expects(:delete).
+      with('supersecretphoto/1001/small.png', 'tmp-bucket-name')
+
+    Imagery::S3::Gateway.expects(:delete).
+      with('supersecretphoto/1001/large.png', 'tmp-bucket-name')
+
+    Imagery::S3::Gateway.expects(:delete).
+      with('supersecretphoto/1001/original.png', 'tmp-bucket-name')
+
+    assert imagery.delete
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: imagery
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Cyril David
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-28 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: escape
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: contest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Uses ImageMagick directly underneath. Nuff said.
+email: cyx.ucron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/imagery.rb
+- lib/imagery/faking.rb
+- lib/imagery/model.rb
+- lib/imagery/s3.rb
+- test/fixtures/lake.jpg
+- test/helper.rb
+- test/test_imagery.rb
+- test/test_with_s3.rb
+has_rdoc: true
+homepage: http://github.com/sinefunc/imagery
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Image resizing without all the bloat
+test_files: 
+- test/helper.rb
+- test/test_imagery.rb
+- test/test_with_s3.rb