imagery 0.0.6 → 0.2.0

data/test/s3.rb

@@ -0,0 +1,109 @@
+require File.expand_path("helper", File.dirname(__FILE__))
+
+test "autloads" do
+  e = nil
+
+  begin
+    Imagery::S3
+  rescue Exception => ex
+    e = ex
+  end
+
+  assert e.nil?
+end
+
+class Imagery
+  include S3
+
+  s3_bucket "cdn.site.com"
+end
+
+test "changes url to an S3 hosted one" do
+  i = Imagery.new(:avatar)
+  
+  expect = "http://s3.amazonaws.com/cdn.site.com/missing/avatar/original.jpg"
+  assert_equal expect, i.url
+end
+
+test "allows an s3_host override" do
+  begin
+    Imagery.s3_host "https://foo.com"
+
+    i = Imagery.new(:avatar)
+    
+    expect = "https://foo.com/cdn.site.com/missing/avatar/original.jpg"
+    assert_equal expect, i.url
+  ensure
+    Imagery.s3_host "http://s3.amazonaws.com"
+  end
+end
+
+test "allows a distribution domain for cloudfront hosted buckets" do
+  begin
+    Imagery.s3_distribution_domain "https://cdn.site.com"
+    
+    i = Imagery.new(:avatar)
+    expect = "https://cdn.site.com/missing/avatar/original.jpg"
+    assert_equal expect, i.url
+
+    i = Imagery.new(:avatar, "1001")
+    expect = "https://cdn.site.com/avatar/1001/original.jpg"
+    assert_equal expect, i.url
+
+  ensure
+    Imagery.instance_variable_set(:@s3_distribution_domain, nil)
+  end
+end
+
+# persisting in sandboxed Gateway
+scope do
+  setup do
+    Imagery.s3_bucket "buck"
+
+    im = Imagery.new(:avatar, "1001", small: ["100x100"], medium: ["200x200"])
+    io = File.open(fixture("r8.jpg"), "rb")
+
+    [im, io]
+  end
+
+  test "saves all sizes to S3" do |im, io|
+    im.save(io)
+  
+    cmds = Imagery::S3::Gateway.commands
+
+    assert_equal [:store, "avatar/1001/original.jpg", "buck"], cmds.shift
+    assert_equal [:store, "avatar/1001/small.jpg", "buck"], cmds.shift
+    assert_equal [:store, "avatar/1001/medium.jpg", "buck"], cmds.shift
+
+    assert cmds.empty?
+  end
+
+  test "doesn't delete when passing same key" do |im, io|
+    im.save(io, "1001")
+  
+    cmds = Imagery::S3::Gateway.commands
+
+    assert_equal [:store, "avatar/1001/original.jpg", "buck"], cmds.shift
+    assert_equal [:store, "avatar/1001/small.jpg", "buck"], cmds.shift
+    assert_equal [:store, "avatar/1001/medium.jpg", "buck"], cmds.shift
+
+    assert cmds.empty?
+  end
+
+  test "deletes when passing a different key" do |im, io|
+    im.save(io, "1002")
+  
+    cmds = Imagery::S3::Gateway.commands
+
+    assert_equal [:delete, "avatar/1001/original.jpg", "buck"], cmds.shift
+    assert_equal [:delete, "avatar/1001/small.jpg", "buck"], cmds.shift
+    assert_equal [:delete, "avatar/1001/medium.jpg", "buck"], cmds.shift
+
+
+    assert_equal [:store, "avatar/1002/original.jpg", "buck"], cmds.shift
+    assert_equal [:store, "avatar/1002/small.jpg", "buck"], cmds.shift
+    assert_equal [:store, "avatar/1002/medium.jpg", "buck"], cmds.shift
+
+    assert cmds.empty?
+  end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: imagery
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors: 
 - Cyril David
@@ -14,96 +10,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-06 00:00:00 +08:00
+date: 2011-06-23 00:00:00 +08:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: escape
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    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 
-    none: false
-    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 
-    none: false
-    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 
-    none: false
-    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
+dependencies: []
+
+description: Provide a clean and light interface around GraphicsMagick.
+email: 
+- me@cyrildavid.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- .document
-- .gitignore
 - LICENSE
 - README.markdown
-- Rakefile
-- VERSION
-- imagery.gemspec
-- lib/imagery.rb
 - lib/imagery/faking.rb
-- lib/imagery/missing.rb
-- lib/imagery/model.rb
 - lib/imagery/s3.rb
 - lib/imagery/test.rb
-- test/fixtures/lake.jpg
+- lib/imagery.rb
+- imagery.gemspec
+- test/faking.rb
 - test/helper.rb
-- test/test_imagery.rb
-- test/test_missing.rb
-- test/test_with_s3.rb
+- test/imagery.rb
+- test/s3.rb
 has_rdoc: true
-homepage: http://github.com/sinefunc/imagery
+homepage: http://github.com/cyx/imagery
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -111,26 +49,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Image resizing without all the bloat
-test_files: 
-- test/helper.rb
-- test/test_imagery.rb
-- test/test_missing.rb
-- test/test_with_s3.rb
+summary: POROS + GraphicsMagick.
+test_files: []
+

data/.document

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

data/.gitignore

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

data/Rakefile

@@ -1,56 +0,0 @@
-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

@@ -1 +0,0 @@
-0.0.6

data/lib/imagery/missing.rb

@@ -1,30 +0,0 @@
-module Imagery
-  module Missing
-    # Allows you to set the current filename of your photo.
-    # Much of Imagery::Missing is hinged on this.
-    #
-    # @example
-    #
-    #   Photo = Class.new(Struct.new(:id))
-    #   i = Imagery::Model.new(Photo.new(1001))
-    #   i.extend Imagery::Missing
-    #   i.url == "/photo/1001/original.png"
-    #   # => true
-    #
-    #   i.existing = "Filename"
-    #   i.url == "/missing/photo/original.png"
-    #   # => true
-    #
-    # @see Imagery::Missing#url
-    #
-    attr_accessor :existing
-
-    def url(size = self.default_size)
-      if existing.to_s.empty?
-        return ['', 'missing', namespace, filename(size)].join('/')
-      else
-        super
-      end
-    end
-  end
-end

data/lib/imagery/model.rb

@@ -1,217 +0,0 @@
-module Imagery
-  class Model 
-    UnknownSize   = Class.new(StandardError)
-    UndefinedRoot = Class.new(StandardError)
-  
-    @@directory = 'public/system'
-    @@default   = { :original => ["1920x1200>"] }
-
-    # This is typically the database ID, you may also use something 
-    # like a GUID for it, the sky's the limit.
-    attr :key
-  
-    # Used as a grouping scheme, if you name this as `photos` for example,
-    # you will have public/system/photos as the path.
-    attr :namespace
-  
-    # Returns a single key => value pair hash, defaulting to @@default.
-    attr :default
-
-    # Returns the directory used which defaults to public/system.
-    attr :directory
-    
-    # Defaulting to :original, the value used here will be the default 
-    # size used when calling Imagery::Model#url and Imagery::Model#file.
-    attr_accessor :default_size
-
-    # Allows you to define the root of your application, all other paths
-    # are determined relative to this.
-    attr_writer :root
-
-    # Allows you to define the different sizes you want as a hash of 
-    # :style => [geometry] pairs.
-    attr_writer :sizes
-    
-    # @param [#id] model any ruby object
-    # @param [#to_s] key typically the database ID of a model. But you may also 
-    #                use anything here just as long as its unique across the
-    #                namespace.
-    # @param [#to_s] namespace used as a grouping mechanism for your images.
-    def initialize(model, key = model.id, namespace = namespace_for(model.class))
-      @key          = key.to_s
-      @namespace    = namespace.to_s
-      @default      = @@default
-      @directory    = @@directory
-      @sizes        = {}
-      @default_size = :original
-    end
-    
-    # Returns all the sizes defined including the default size.
-    #
-    # @example
-    #   Photo = Class.new(Struct.new(:id))
-    #   i = Imagery::Model.new(Photo.new(1001))
-    #   i.sizes == { :original => ["1920x1280"] }
-    #   # => true
-    #
-    #   i.sizes = { :thumb => ["48x48"] }
-    #   i.sizes == { :thumb => ["48x48"], :original => ["1920x1280"] }
-    #   # => true
-    #
-    # @return [Hash] size => [dimension] pairs.
-    def sizes
-      @sizes.merge(default)
-    end
-    
-    # Gives the absolute file for a specified size.
-    #
-    # @example
-    #
-    #   Photo = Class.new(Struct.new(:id))
-    #   i = Imagery.new(Photo.new(1001))
-    #   i.root = '/tmp'
-    #   i.file(:original) == '/tmp/public/system/photo/1001/original.png
-    #   # => true
-    #
-    #   i.file(:thumb)
-    #   # raise Imagery::Model::UnknownSize
-    #
-    #   i.sizes = { :thumb => ["100x100"] }
-    #   i.file(:thumb) == '/tmp/public/system/photo/1001/thumb.png
-    #   # => true
-    #
-    # @param [Symbol] size the size specific filename.
-    # @raise [UnknownSize] if the size is not found in 
-    #                      Imagery::Model#sizes.
-    # @return [String] the absolute path of the size specific filename e.g.
-    #                  /u/apps/reddit/current/public/system/photo/1/thumb.png
-    #                  where photo is the namespace and 1 is the key.
-    def file(size = self.default_size)
-      raise UnknownSize, "#{ size } is not defined" unless sizes.has_key?(size)
-
-      root_path(directory, namespace, key, filename(size))
-    end
- 
-    # The Web module is basically here to let plugins override
-    # the url as they see fit.
-    #
-    # @example
-    #   module FunkyUrls
-    #     def url(size = default_size)
-    #       super.gsub('/system', '/funky')
-    #     end
-    #   end
-    #
-    #   class Imagery::Model
-    #     include FunkyUrls
-    #   end
-    module Web
-      # Gives the absolute URI path for use in a web context.
-      #
-      #   Photo = Class.new(Struct.new(:id))
-      #   i = Imagery.new(Photo.new(1001))
-      #   i.url(:original) == '/system/photo/1001/original.png
-      #   # => true
-      #
-      #   i.file(:thumb)
-      #   # raise Imagery::Model::UnknownSize
-      #
-      #   i.sizes = { :thumb => ["100x100"] }
-      #   i.file(:thumb) == '/system/photo/1001/thumb.png
-      #   # => true
-      #
-      # @param [Symbol] size the size specific url.
-      # @raise [UnknownSize] if the size is not found in 
-      #                      Imagery::Model#sizes.
-      # @return [String] the absolute URI path of the size specific url e.g.
-      #                  /system/photo/1/thumb.png
-      #                  where photo is the namespace and 1 is the key.
-      def url(size = self.default_size)
-        file(size).split('public').last
-      end
-    end
-    include Web
-      
-    # This module is basically here so that plugins like Imagery::S3
-    # can override #save and #delete and call super.
-    module Persistence
-      # Writes the data in `io` and resizes them according to the different
-      # geometry strings.
-      #
-      # @example
-      #
-      #   Photo = Class.new(Struct.new(:id))
-      #   i = Imagery.new(Photo.new(1001))
-      #   i.root = '/tmp'
-      #   i.size = { :thumb => ["48x48"] }
-      #   i.save(File.open('/path/to/file.jpg'))
-      #
-      #   File.exist?("/tmp/public/system/photo/1001/thumb.png")
-      #   # => true
-      #
-      #   File.exist?("/tmp/public/system/photo/1001/original.png")
-      #   # => true
-      #
-      # @param [#read] io any object responding to read. Typically
-      #                a Rack filehandle is passed here from a 
-      #                controller in rails or a Sinatra handler.
-      #                You may also use File.open to provide a proper
-      #                IO handle.
-      # @return [true] returns when all other file operations are done.
-      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
-      
-      # Deletes all of the files related to this Imagery::Model instance.
-      # @return [true] when successfully deleted.
-      def delete
-        FileUtils.rm_rf File.dirname(file)
-        return true
-      end
-    end
-    include Persistence
-
-  private
-    def tmp
-      root_path(directory, namespace, key, 'tmp')
-    end
-
-    def namespace_for(klass)
-      klass.name.split('::').last.downcase
-    end
-
-    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 || raise(UndefinedRoot, "You must define Imagery::Model#root or have a ROOT_DIR constant present")
-    end
-   
-    def root_path(*args)
-      File.join(root, *args)
-    end
-  end
-end