attached 0.0.9 → 0.1.0

data/Gemfile

@@ -4,4 +4,6 @@ gem 'rails'
 
 gem 'guid'
 
-gem 'aws-s3', :require => 'aws/s3'
+gem 'aws-s3', :require => 'aws/s3'
+
+gem 'rmagick'

data/README.rdoc

@@ -1,6 +1,6 @@
 = Attached
 
-Attached is a Ruby on Rails file attachment tool that lets users upload to the cloud, then process in the cloud. The tool supports Amazon S3 by default. It surpasses Paperclip by providing built-in support for direct uploads to the cloud and by allowing integration with cloud based processing tools. However, in almost every other way Paperclip is better. The source code inspired (and copied) from Paperclip. If you aren't working in the cloud exclusively then this isn't for you!
+Attached is a Ruby on Rails file attachment tool that lets users upload to the cloud, then process in the cloud. The tool supports Amazon S3 by default. It surpasses Paperclip by providing built-in support for direct uploads to the cloud and by allowing integration with cloud based processing tools. However, in almost every other way Paperclip is better. The source code is inspired (and copied) from Paperclip. If you aren't working in the cloud exclusively then this isn't for you!
 
 == Installation
 
@@ -13,9 +13,9 @@ Migration:
   class CreateVideo < ActiveRecord::Migration
     def self.up
       create_table :videos do |t|
-        t.string :video_identifier
-        t.string :video_extension
-        t.integer :video_size
+        t.string :encoding_identifier
+        t.string :encoding_extension
+        t.integer :encoding_size
 
         t.timestamps
       end
@@ -28,27 +28,52 @@ Migration:
 
 Model:
   
-  has_attached :video, :styles => { 
-    :mp4_720p => { :extension => 'mp4' },
-    :mp4_480p => { :extension => 'mp4' },
-    :ogv_720p => { :extension => 'ogv' },
-    :ogv_480p => { :extension => 'ogv' },
+  has_attached :encoding, :styles => { 
+    :mp4_720p => { :extension => '.mp4' },
+    :mp4_480p => { :extension => '.mp4' },
+    :ogg_720p => { :extension => '.ogv' },
+    :ogg_480p => { :extension => '.ogv' },
   }
   
+  after_save do
+    remote.encode(self.encoding.url)
+  end
+  
 Form:
 
   <%= form_for @video, :html => { :multipart => true } do |form| %>
-    <%= form.file_field :video %>
-    <p class="errors"><%= @video.errors[:video] %></p>
+    <%= form.file_field :encoding %>
+    <p class="errors"><%= @video.errors[:encoding] %></p>
   <% end %>
   
 View:
 
   <video>
-    <source src="<%= @video.video.url(:mp4_480p) %>" />
-    <source src="<%= @video.video.url(:ogv_480p) %>" />
+    <source src="<%= @video.encoding.url(:mp4_480p) %>" />
+    <source src="<%= @video.encoding.url(:ogg_480p) %>" />
   </video>
   
+== Advanced
+
+=== Storage
+  
+  has_attached :avatar, :provider => :amazon, :credentials => {
+    :secret_access_key => "*****",
+    :access_key_id     => "*****",
+  }
+  
+  has_attached :avatar, :provider => :google, :credentials => {
+    :secret_access_key => "*****",
+    :access_key_id     => "*****",
+  }
+  
+=== Processor
+
+  has_attached :avatar, :processor => :resize, :styles => {
+    :small => { :size => "200x200#" }
+    :large => { :size => "200x200#" }
+  }
+  
 == Copyright
 
 Copyright (c) 2010 Kevin Sylvestre. See LICENSE for details.

data/lib/attached.rb

@@ -31,8 +31,9 @@ module Attached
     #
     # Options:
     #
-    # * :styles  - 
-    # * :storage - 
+    # * :styles    - 
+    # * :storage   - 
+    # * :processor -
     #
     # Usage:
     #
@@ -118,8 +119,8 @@ module Attached
        
       range = minimum..maximum
       
-      message.gsub!(/:minimum/, number_to_human_size(minimum)) unless minimum == zero
-      message.gsub!(/:maximum/, number_to_human_size(maximum)) unless maximum == infi
+      message.gsub!(/:minimum/, number_to_size(minimum)) unless minimum == zero
+      message.gsub!(/:maximum/, number_to_size(maximum)) unless maximum == infi
       
       validates_inclusion_of :"#{name}_size", :in => range, :message => message, 
         :if => options[:if], :unless => options[:unless]
@@ -151,21 +152,29 @@ module Attached
   private
   
   
-    SINGULAR = 1
+    # Convert a number to a human readable size.
+    #
+    # Usage:
+    #
+    #   number_to_size(1) # 1 byte
+    #   number_to_size(2) # 2 bytes
+    #   number_to_size(1024) # 1 kilobyte
+    #   number_to_size(2048) # 2 kilobytes
     
-    def number_to_human_size(number, options = {})
+    def number_to_size(number, options = {})
       return if number == 0.0 / 1.0
       return if number == 1.0 / 0.0
       
-      base  = 1024
-      units = ["byte", "kilobyte", "megabyte", "gigabyte", "terabyte", "petabyte"]
+      singular = options['singular'] || 1
+      base     = options['base']     || 1024
+      units    = options['units']    || ["byte", "kilobyte", "megabyte", "gigabyte", "terabyte", "petabyte"]
       
       exponent = (Math.log(number) / Math.log(base)).floor
       
       number /= base ** exponent
       unit = units[exponent]
       
-      number == SINGULAR ?  unit.gsub!(/s$/, '') : unit.gsub!(/$/, 's')
+      number == singular ?  unit.gsub!(/s$/, '') : unit.gsub!(/$/, 's')
       
       "#{number} #{unit}"
     end

data/lib/attached/attachment.rb

@@ -1,6 +1,8 @@
 require 'guid'
 
 require 'attached/storage'
+require 'attached/processor'
+require 'attached/image'
 
 module Attached
   
@@ -11,13 +13,28 @@ module Attached
     attr_reader :name
     attr_reader :instance
     attr_reader :options
+    attr_reader :queue
+    attr_reader :path
+    attr_reader :styles
+    attr_reader :default
+    attr_reader :medium
+    attr_reader :credentials
+    attr_reader :processors
+    attr_reader :processor
     
     
+    # A default set of options that can be extended to customize the path, storage or credentials.
+    #
+    # Usage:
+    #
+    #   Attached::Attachment.options = { :storage => :fs, :path => "/:name/:style/:identifier:extension" }
+    
     def self.options
       @options ||= {
-        :storage  => :s3,
-        :path     => "/:name/:style/:identifier:extension",
-        :styles   => {},
+        :path       => "/:name/:style/:identifier:extension",
+        :default    => :original,
+        :styles     => {},
+        :processors => [],
       }
     end
     
@@ -34,16 +51,28 @@ module Attached
     # * :path        - The location where the attachment is stored
     # * :storage     - The storage medium represented as a symbol such as ':s3'
     # * :credentials - A file, hash, or path used to authenticate with the specified storage medium
+    # * :styles      - A hash containing optional parameters including extension and identifier
     
     def initialize(name, instance, options = {})
-      @name       = name
-      @instance   = instance
+      @name        = name
+      @instance    = instance
+      @options     = self.class.options.merge(options)
+      
+      @queue       = {}
+      
+      @path        = @options[:path]
+      @styles      = @options[:styles]
+      @default     = @options[:default]
+      @medium      = @options[:medium]
+      @credentials = @options[:credentials]
+      @processors  = @options[:processors]
+      @processor   = @options[:processor]
       
-      @options    = self.class.options.merge(options)
+      @processors << @processor if @processor
     end
     
     
-    # 
+    # Check if an attachment has been modified.
     #
     # Usage:
     #
@@ -54,6 +83,8 @@ module Attached
     end
     
     
+    # Assign an attachment to a file.
+    #
     # Usage:
     #
     #   @object.avatar.assign(...)
@@ -62,34 +93,47 @@ module Attached
       @file = file.tempfile
       
       extension = File.extname(file.original_filename)
-      
+       
       instance_set :size, file.size
       instance_set :extension, extension
       instance_set :identifier, identifier
+      
+      self.queue[self.default] = self.file
+      
+      process
     end
     
     
+    # Save an attachment.
+    #
     # Usage:
     #
     #   @object.avatar.save
     
     def save
-      @storage ||= Attached::Storage.medium(options[:storage], options[:credentials])
+      @storage ||= Attached::Storage.storage(self.medium, self.credentials)
+      
+      @queue.each do |style, file|
+        @storage.save(file, self.path(style)) if file and self.path(style)
+      end
       
-      @storage.save(self.file, self.path) if self.file and self.path
+      @queue = {}
     end
     
     
+    # Destroy an attachment.
+    #
     # Usage:
     #
     #   @object.avatar.destroy
     
     def destroy
-      @storage ||= Attached::Storage.medium(options[:storage], options[:credentials])
+      @storage ||= Attached::Storage.storage(self.medium, self.credentials)
       
       @storage.destroy(self.path) if self.path
     end
     
+    
     # Acesss the URL for an attachment.
     #
     # Usage:
@@ -98,8 +142,8 @@ module Attached
     #   @object.avatar.url(:small)
     #   @object.avatar.url(:large)
     
-    def url(style = :original)
-      @storage ||= Attached::Storage.medium(options[:storage], options[:credentials])
+    def url(style = self.default)
+      @storage ||= Attached::Storage.storage(self.medium, self.credentials)
       
       return "#{@storage.host}#{path(style)}"
     end
@@ -113,8 +157,8 @@ module Attached
     #   @object.avatar.url(:small)
     #   @object.avatar.url(:large)
     
-    def path(style = :original)
-      path = options[:path].clone
+    def path(style = self.default)
+      path = @path.clone
       
       path.gsub!(/:name/, name.to_s)
       path.gsub!(/:style/, style.to_s)
@@ -124,6 +168,7 @@ module Attached
       return path
     end
     
+    
     # Access the size for an attachment.
     #
     # Usage:
@@ -144,12 +189,13 @@ module Attached
     
     def extension(style = nil)
       style and
-      options[:styles] and 
-      options[:styles][style] and 
-      options[:styles][style][:extension] or 
+      self.styles and 
+      self.styles[style] and 
+      self.styles[style][:extension] or 
       instance_get(:extension)
     end
     
+    
     # Access the identifier for an attachment. It will first check the styles 
     # to see if one is specified before checking the instance.
     #
@@ -159,9 +205,9 @@ module Attached
     
     def identifier(style = nil)
       style and
-      options[:styles] and 
-      options[:styles][style] and 
-      options[:styles][style][:identifier] or 
+      self.styles and 
+      self.styles[style] and 
+      self.styles[style][:identifier] or 
       instance_get(:identifier)
     end
     
@@ -191,6 +237,22 @@ module Attached
     
   private
   
+    # Helper function for calling processors.
+    #
+    # Usage:
+    #
+    #   self.process
+    
+    def process
+      @processors.each do |processor|
+        self.styles.each do |style, options|
+          case processor
+          when :image then self.queue[style] = Attached::Image.process(self.queue[style] || self.file, options, self)
+          end
+        end
+      end
+    end
+  
   
     # Helper function for setting instance variables.
     # 
@@ -200,7 +262,7 @@ module Attached
   
     def instance_set(attribute, value)
       setter = :"#{self.name}_#{attribute}="
-      self.instance.send(setter, value)
+      self.instance.send(setter, value) if instance.respond_to?(setter)
     end
     
     
@@ -212,7 +274,7 @@ module Attached
     
     def instance_get(attribute)
       getter = :"#{self.name}_#{attribute}"
-      self.instance.send(getter)
+      self.instance.send(getter) if instance.respond_to?(getter)
     end
 
     

data/lib/attached/image.rb

@@ -0,0 +1,68 @@
+require 'attached/processor'
+
+require 'rmagick'
+
+module Attached
+  
+  class Image < Processor
+    
+    
+    attr_reader :path
+    attr_reader :extname
+
+    # Create a processor.
+    #
+    # Parameters:
+    # 
+    # * file       - The file to be processed.
+    # * options    - The options to be applied to the processing.
+    # * attachment - The attachment the processor is being run for.
+    
+    def initialize(file, options = {}, attachment = nil)
+      super
+        
+      @path     = @file.path
+      @extname  = File.extname(@file.path)
+    end
+    
+    
+    # Helper function for calling processors.
+    #
+    # Usage:
+    #
+    #   self.process
+    
+    def process
+      result = Tempfile.new(["", options['extension'] || self.extname])
+      result.binmode
+        
+      image = ::Magick::Image.read(self.path)
+      image_list  = ::Magick::ImageList.new
+      
+      width, height, operation = self.options[:size].match(/\b(\d*)x?(\d*)\b([\#\<\>])?/)[1..3] if self.options[:size]
+      
+      width     ||= self.options[:width]
+      height    ||= self.options[:height]
+      operation ||= self.options[:operation]
+      
+      width  = width.to_i
+      height = height.to_i
+      
+      image.each do |frame|
+        case operation
+          when /!/ then puts "hi"
+          when /#/ then image_list << frame.resize_to_fill(width, height)
+          when /</ then image_list << frame.resize_to_fit(width, height)
+          when />/ then image_list << frame.resize_to_fit(width, height)
+          else image_list << frame.resize(width, height)
+        end
+      end
+      
+      image_list.write(result.path)
+      
+      return result
+    end
+    
+    
+  end
+end

data/lib/attached/processor.rb

@@ -0,0 +1,48 @@
+module Attached
+
+  class Processor
+    
+    
+    attr_accessor :file
+    attr_accessor :options
+    attr_accessor :attachment
+    
+    
+    # Create and run a processor.
+    #
+    # Parameters:
+    # 
+    # * file       - The file to be processed.
+    # * options    - The options to be applied to the processing.
+    # * attachment - The attachment the processor is being run for.
+
+    def self.process(file, options = {}, attachment = nil)
+      new(file, options, attachment).process
+    end
+    
+    
+    # Create a processor.
+    #
+    # Parameters:
+    # 
+    # * file       - The file to be processed.
+    # * options    - The options to be applied to the processing.
+    # * attachment - The attachment the processor is being run for.
+
+    def initialize(file, options = {}, attachment = nil)
+      @file = file
+      @options = options
+      @attachment = attachment
+    end
+    
+    
+    # Run the processor. 
+
+    def process
+      raise NotImplementedError.new   
+    end
+    
+    
+  end
+
+end

data/lib/attached/storage.rb

@@ -9,9 +9,9 @@ module Attached
     #
     #   Attached::Storage.medium(s3)
     
-    def self.medium(storage = :s3, credentials = nil)
+    def self.storage(medium = :s3, credentials = nil)
       
-      case storage
+      case medium
       when :s3 then return Attached::Storage::S3.new(credentials)
       end
       

data/lib/attached/storage/s3.rb

@@ -50,7 +50,7 @@ module Attached
       def save(file, path)
         connect()
         begin
-          AWS::S3::S3Object.store(path, file, bucket, :access => :authenticated_read)
+          AWS::S3::S3Object.store(path, file, bucket, :access => :public_read)
         rescue AWS::S3::NoSuchBucket => e
   			  AWS::S3::Bucket.create(bucket)
           retry

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kevin Sylvestre
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-08 00:00:00 -05:00
+date: 2010-12-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,19 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: Attached is a Ruby on Rails cloud attachment and processor library inspired by Paperclip. Attached lets users push files to the cloud, then perform remote processing on the files.
 email: 
 - kevin@ksylvest.com
@@ -54,6 +67,8 @@ extra_rdoc_files: []
 
 files: 
 - lib/attached/attachment.rb
+- lib/attached/image.rb
+- lib/attached/processor.rb
 - lib/attached/railtie.rb
 - lib/attached/storage/base.rb
 - lib/attached/storage/s3.rb