directwave 0.0.1 → 0.0.4

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.0.3
+
+* moved out from deprecated InstanceMethods idiom
+
+## v0.0.2
+
+* adding retrieve method to cache version file
+* adding cache_dir to configuration
+
 ## v0.0.1
 
 * initial release

data/README.md

@@ -6,7 +6,7 @@ such as zencoder.com or pandastream.com.
 
 It works well with Rack based web applications, such as Ruby on Rails.
 
-Inspired by [CarrierWave](http://github.com/jnicklas/DirectWave) and used in [radiant.fm](http://radiant.fm)
+Inspired by [CarrierWave](https://github.com/jnicklas/carrierwave) and used in [radiant.fm](http://radiant.fm).
 
 ## Information
 
@@ -15,7 +15,7 @@ Inspired by [CarrierWave](http://github.com/jnicklas/DirectWave) and used in [ra
 
 ## Getting Help
 
-* Please report bugs on the [issue tracker]https://github.com/radiantfm/directwave/issues).
+* Please report bugs on the [issue tracker](https://github.com/radiantfm/directwave/issues).
 
 ## Installation
 
@@ -26,16 +26,16 @@ Install the latest stable release:
 In Rails, add it to your Gemfile:
 
 ``` ruby
-gem 'directwave'
+gem "directwave"
 ```
 
 ## Getting Started
 
-Start off by generating an uploader:
+Start off generating an uploader:
 
 	rails generate directwave Audio
 
-this should give you a file in:
+this should give you the following file:
 
 	app/uploaders/audio_uploader.rb
 
@@ -47,9 +47,9 @@ class AudioUploader < DirectWave::Uploader::Base
 end
 ```
 
-Most of the time you are going to want to use DirectWave together with an ORM.
-It is quite simple to mount uploaders on columns in your model, so you can
-simply assign files and get going:
+Time after time you can use DirectWave together with an ORM. 
+It is quite simple to mount uploaders on columns in your model, 
+so in fact you can assign files and get going:
 
 ## ActiveRecord
 
@@ -67,8 +67,8 @@ class Track < ActiveRecord::Base
 end
 ```
 
-Now you can cache files by assigning them to the attribute, they will
-automatically be stored when the record is saved.
+Now you can cache files by assigning them to the attribute, 
+they will be stored automatically after the record save.
 
 ``` ruby
 u = Track.new(:audio_from_key => params[:key])
@@ -79,7 +79,7 @@ u.audio.url # => '/url/to/file.png'
 ## Rails
 
 You can use different flash uploaders for multiple direct upload, 
-such as [Uploadify](http://sd.r). For example in Rails with CoffeeScript and Nokogiri
+such as [Uploadify](http://www.uploadify.com). For example in Rails with CoffeeScript and Nokogiri
 generate uploader controller at first:
 
 	rails g controller Uploads new create
@@ -103,7 +103,7 @@ class UploadsController < ApplicationController
 end
 ```
 
-when in `assets/javascript/uploads.js.coffe` insert:
+then in `assets/javascript/uploads.js.coffe` insert:
 
 ``` html
 $(document).ready ->
@@ -149,8 +149,8 @@ in `views/uploads/new.html.erb`:
 
 ## Changing the directories
 
-In order to change where uploaded files are stored, just override the `store_dir`
-method:
+In order to change the location where uploaded files are stored, 
+just override the `store_dir` method:
 
 ``` ruby
 class MyUploader < DirectWave::Uploader::Base
@@ -160,12 +160,11 @@ class MyUploader < DirectWave::Uploader::Base
 end
 ```
 
-If you want change where files will be uploaded, override the `upload_dir`
-method:
+If you want to change where files will be uploaded, override the `upload_dir` method:
 
 ``` ruby
 class MyUploader < DirectWave::Uploader::Base
-  def store_dir
+  def upload_dir
     '/my/upload/directory/tmp'
   end
 end
@@ -197,9 +196,7 @@ class Audio < DirectWave::Uploader::Base
               label: "aac",
               url: "s3://#{@uploader.s3_bucket}.s3.amazonaws.com/#{@uploader.versions[:aac].key}",
               format: "aac",
-              notifications: [
-                { url: "http://zencoderfetcher/", format: "json" }
-              ]
+              notifications: [{ url: "http://zencoderfetcher/", format: "json" }]
             } # aac
           ] # outputs
         }
@@ -210,8 +207,8 @@ class Audio < DirectWave::Uploader::Base
 end
 ```
 
-When this uploader is used, a version called aac is then created, which is processed with `process`. 
-The uploader could be used like this:
+When the uploader is used, a version named aac will be created 
+which is processed with `process` method. The uploader could be used like this:
 
 ``` ruby
 uploader.url # => '/url/to/original/file.png'               
@@ -220,7 +217,7 @@ uploader.aac.url # => '/url/to/aac/file.png'
 uploader.url(:aac) # => '/url/to/aac/file.png'   
 ```
 
-You can also override `global_process` method wich called after 
+You can also override `global_process` method which called after 
 all process within versions:
 
 ``` ruby
@@ -239,17 +236,13 @@ class Audio < DirectWave::Uploader::Base
             label: "aac",
             url: "s3://#{s3_bucket}.s3.amazonaws.com/#{versions[:aac].key}",
             format: "aac",
-            notifications: [
-              { url: "http://zencoderfetcher/", format: :json }
-            ]
+            notifications: [{ url: "http://zencoderfetcher/", format: :json }]
           }, # aac
           {
             label: "wav",
             url: "s3://#{s3_bucket}.s3.amazonaws.com/#{versions[:wav].key}",
             format: "wav",
-            notifications: [
-              { url: "http://zencoderfetcher/", format: :json }
-            ]
+            notifications: [{ url: "http://zencoderfetcher/", format: :json }]
           } # wav
 
         ] # outputs

data/lib/directwave/uploader/accreditation.rb

@@ -4,52 +4,50 @@ module DirectWave
     module Accreditation
       extend ActiveSupport::Concern
       
-      module InstanceMethods
-        ##
-        # === Returns
-        #
-        # [String] Amazon S3 acl
-        #
-        def s3_acl
-          @s3_acl ||= s3_access_policy.to_s.gsub("_", "-")
-        end
+      ##
+      # === Returns
+      #
+      # [String] Amazon S3 acl
+      #
+      def s3_acl
+        @s3_acl ||= s3_access_policy.to_s.gsub("_", "-")
+      end
 
-        ##
-        # === Returns
-        #
-        # [Boolean] Amazon S3 policy
-        #
-        def s3_policy
-          @s3_policy ||= Base64.encode64(
-            {
-              "expiration" => expiration_date,
-              "conditions" => [
-                {"bucket" => s3_bucket},
-                ["starts-with", "$key", upload_dir],
-                {"success_action_status" => "201"},
-                ["starts-with", "$filename", ""],
-                ["starts-with", "$folder", ""],
-                {"acl" => s3_acl},
-                ["content-length-range", 1, max_file_size]
-              ]
-            }.to_json
-          ).gsub("\n","")
-        end
-        
-        ##
-        # === Returns
-        #
-        # [Boolean] Amazon S3 signature
-        #
-        def s3_signature
-          @s3_signature ||= Base64.encode64(
-            OpenSSL::HMAC.digest(
-              OpenSSL::Digest::Digest.new("sha1"), 
-              s3_secret_access_key, s3_policy
-            )
-          ).gsub("\n","")
-        end  
-      end # InstanceMethods
+      ##
+      # === Returns
+      #
+      # [Boolean] Amazon S3 policy
+      #
+      def s3_policy
+        @s3_policy ||= Base64.encode64(
+          {
+            "expiration" => expiration_date,
+            "conditions" => [
+              {"bucket" => s3_bucket},
+              ["starts-with", "$key", upload_dir],
+              {"acl" => s3_acl},
+              {"success_action_status" => "201"},
+              ["content-length-range", 0, max_file_size],
+              ["starts-with", "$Filename", ""],
+              ['starts-with', '#{content_type}', '']
+            ]
+          }.to_json
+        ).gsub("\n","")
+      end
+      
+      ##
+      # === Returns
+      #
+      # [Boolean] Amazon S3 signature
+      #
+      def s3_signature
+        @s3_signature ||= Base64.encode64(
+          OpenSSL::HMAC.digest(
+            OpenSSL::Digest::Digest.new("sha1"), 
+            s3_secret_access_key, s3_policy
+          )
+        ).gsub("\n","")
+      end  
       
       private
       

data/lib/directwave/uploader/configuration.rb

@@ -17,6 +17,7 @@ module DirectWave
         
         add_config :store_dir
         add_config :upload_dir
+        add_config :cache_dir
 
         reset_config
       end
@@ -57,8 +58,9 @@ module DirectWave
             config.max_file_size   = 300.megabytes
             config.expiration_date = 6.hours.from_now.utc.iso8601
 
-            config.store_dir = "uploads"
+            config.store_dir  = "uploads"
             config.upload_dir = "uploads/tmp"
+            config.cache_dir  = 'uploads/cache'
           end
         end
       end # ClassMethods

data/lib/directwave/uploader/paths.rb

@@ -4,47 +4,44 @@ module DirectWave
     module Paths
       extend ActiveSupport::Concern
       
-      module InstanceMethods
-        def url(version=:original)
-          versions[version.to_sym].url || default_url
-        end
-        
-        def key(version=:original)
-          versions[version.to_sym].key
-        end
-        
-        def default_url
-          puts "default_url"  
-        end
+      def url(version=:original)
+        versions[version.to_sym].url || default_url
+      end
+      
+      def key(version=:original)
+        versions[version.to_sym].key
+      end
+      
+      def default_url 
+        puts "default_url"
+      end
+      
+      def filename(part=nil)
+        return original_filename unless has_store_key?
         
-        def filename(part=nil)
-          return original_filename unless has_store_key?
-          
-          key_path = store_key.split("/")
-          filename_parts = []
-          filename = filename_parts.unshift(key_path.pop)
-          unique_key = key_path.pop
-          filename_parts.unshift(unique_key) if unique_key
-          filename_parts.join("/")
-        end
-                
-        def original_filename
-          model[mounted_as.to_s] if model.respond_to?(mounted_as)
-        end
+        key_path = store_key.split("/")
+        filename_parts = []
+        filename = filename_parts.unshift(key_path.pop)
+        unique_key = key_path.pop
+        filename_parts.unshift(unique_key) if unique_key
+        filename_parts.join("/")
+      end
               
-        def store_key=(string)
-          @store_key = string
-        end
-          
-        def store_key
-          @store_key ||= "#{upload_dir}/#{guid}/${filename}"
-        end
+      def original_filename
+        model[mounted_as.to_s] if model.respond_to?(mounted_as)
+      end
+            
+      def store_key=(string)
+        @store_key = string
+      end
         
-        def has_store_key?
-          @store_key.present? && !(@store_key =~ /#{Regexp.escape("${filename}")}\z/)
-        end
-      end # InstanceMethods
-       
+      def store_key
+        @store_key ||= "#{upload_dir}/#{guid}/${filename}"
+      end
+      
+      def has_store_key?
+        @store_key.present? && !(@store_key =~ /#{Regexp.escape("${filename}")}\z/)
+      end       
     end # Paths
   end # Uploader
   

data/lib/directwave/uploader/versions.rb

@@ -35,12 +35,27 @@ module DirectWave
           @filename = nil
           @url      = nil
           @key      = nil
+          @date     = nil
         end
         
         def delete
           file.delete if file.exists? 
         end
         
+        def retrieve
+          @data ||= file.read 
+          begin
+            temp_file = Tempfile.new([extract(:basename), extract(:extname)], @uploader.cache_dir)
+            temp_file.binmode
+            temp_file.write(@data)            
+            temp_file.flush
+            yield(temp_file)              
+          ensure
+           # temp_file.close
+            #temp_file.unlink
+          end        
+        end
+        
         private
         
         def extract(part)

data/lib/directwave/version.rb

@@ -1,3 +1,3 @@
 module Directwave
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: directwave
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-16 00:00:00.000000000Z
+date: 2012-04-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70271860063960 !ruby/object:Gem::Requirement
+  requirement: &70104029175840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70271860063960
+  version_requirements: *70104029175840
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &70271860063360 !ruby/object:Gem::Requirement
+  requirement: &70104029172540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70271860063360
+  version_requirements: *70104029172540
 - !ruby/object:Gem::Dependency
   name: aws-sdk
-  requirement: &70271860062320 !ruby/object:Gem::Requirement
+  requirement: &70104029170460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70271860062320
+  version_requirements: *70104029170460
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70271860060580 !ruby/object:Gem::Requirement
+  requirement: &70104029169380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *70271860060580
+  version_requirements: *70104029169380
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70271860056780 !ruby/object:Gem::Requirement
+  requirement: &70104029168580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70271860056780
+  version_requirements: *70104029168580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70271858520620 !ruby/object:Gem::Requirement
+  requirement: &70104029167540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70271858520620
+  version_requirements: *70104029167540
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70271858518980 !ruby/object:Gem::Requirement
+  requirement: &70104029166660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70271858518980
+  version_requirements: *70104029166660
 description: A simple way to direct upload big files to Amazon S3 storage from Ruby
   applications and process it with cloud encoding service.
 email:
@@ -157,7 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2087257516633304039
+      hash: 258924082708884621
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -166,10 +166,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2087257516633304039
+      hash: 258924082708884621
 requirements: []
 rubyforge_project: directwave
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Ruby direct uploader to Amazon S3