directwave 0.0.1

data/lib/directwave/uploader/connection.rb

@@ -0,0 +1,36 @@
+module DirectWave
+  
+  module Uploader
+    module Connection
+      extend ActiveSupport::Concern
+      included do
+        class_attribute :_s3_connection, :_s3_directory, :instance_reader => false, :instance_writer => false
+      end
+      
+      module ClassMethods
+        # If no argument is given, it will simply return the currently used storage engine.
+        #
+        # === Parameters
+        #
+        # [storage (Symbol, Class)] The storage engine to use for this uploader
+        #
+        # === Returns
+        #
+        # [Class] the storage engine to be used with this uploader
+        def s3_connection
+          self._s3_connection ||= AWS::S3.new(
+            access_key_id: self.s3_access_key_id,
+            secret_access_key: self.s3_secret_access_key,
+            s3_endpoint: "s3-#{self.s3_region}.amazonaws.com"
+          )
+        end
+        
+        def s3_directory
+          self._s3_directory ||= s3_connection.buckets[self.s3_bucket]
+        end
+      end # ClassMethods   
+      
+    end
+  end
+  
+end

data/lib/directwave/uploader/paths.rb

@@ -0,0 +1,51 @@
+module DirectWave
+  
+  module Uploader
+    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 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
+              
+        def store_key=(string)
+          @store_key = string
+        end
+          
+        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 # InstanceMethods
+       
+    end # Paths
+  end # Uploader
+  
+end

data/lib/directwave/uploader/uploader.rb

@@ -0,0 +1,54 @@
+module DirectWave
+  module Uploader
+    
+    class Base
+      include DirectWave::Uploader::Configuration
+      include DirectWave::Uploader::Accreditation
+      include DirectWave::Uploader::Paths
+      include DirectWave::Uploader::Versions
+      include DirectWave::Uploader::Connection
+      
+      attr_reader :model, :mounted_as
+      
+      def initialize(model=nil, mounted_as=nil)
+        @model      = model
+        @mounted_as = mounted_as
+      end
+      
+      def save
+        if has_store_key?
+          # at first remove previous files
+          versions.each { |name, version| version.delete } unless model[mounted_as].blank?
+ 
+          # at second process new files
+          model[mounted_as] = filename
+          versions.each { |name, version| version.process }
+          global_process
+        end
+      end
+      
+      def destroy
+        versions.each { |name, version| version.delete }
+      end
+      
+      def global_process; end
+      
+      version :original do
+        def filename
+          @filename ||= [extract(:guid), extract(:basename) << extract(:extname)].join("/")
+        end
+        
+        def process
+          super
+          
+          source_file      = @uploader.class.s3_directory.objects[@uploader.store_key]
+          destination_file = AWS::S3::S3Object.new(@uploader.class.s3_directory, key)
+          
+          source_file.copy_to(destination_file, { acl: @uploader.s3_acl })
+          source_file.delete
+        end
+      end      
+    end # Base
+    
+  end # Uploader
+end # DirectWave

data/lib/directwave/uploader/versions.rb

@@ -0,0 +1,149 @@
+module DirectWave
+  
+  module Uploader    
+    module Versions
+      class Version
+        def initialize(uploader, name)
+          @uploader = uploader
+          @name     = name
+        end
+        
+        def filename
+          @filename ||= [extract(:guid), [extract(:basename), @name].join("-") << extract(:extname)].join("/")
+        end
+
+        def url
+          @url ||= begin
+            if @uploader.s3_access_policy != :public_read
+              file.url_for(:get, { expires: @uploader.s3_authentication_timeout }).to_s
+            else
+              file.public_url.to_s
+            end
+          end
+        end
+        
+        def key
+          @key ||= File.join([@uploader.store_dir, filename].compact)
+        end
+        
+        def file
+          @file ||= @uploader.class.s3_directory.objects[key]
+        end
+        
+        def process
+          @file     = nil
+          @filename = nil
+          @url      = nil
+          @key      = nil
+        end
+        
+        def delete
+          file.delete if file.exists? 
+        end
+        
+        private
+        
+        def extract(part)
+          part     = part.to_sym
+          key_path = @uploader.original_filename.split("/")
+          filename = key_path.pop
+          guid     = key_path.pop
+          
+          case part
+          when :guid
+            guid
+          when :basename
+            File.basename(filename, ".*")
+          when :extname
+            File.extname(filename)
+          else
+            filename
+          end           
+        end
+        
+      end # Version
+      
+      extend ActiveSupport::Concern
+      
+      included do
+        if respond_to?(:class_inheritable_accessor)
+          ActiveSupport::Deprecation.silence do
+            class_inheritable_accessor :versions, :instance_reader => false, :instance_writer => false
+          end
+        else
+          class_attribute :versions, :instance_reader => false, :instance_writer => false
+        end
+        
+        self.versions = {}
+      end
+           
+      module ClassMethods
+        
+        ##
+        # Adds a new version to this uploader
+        #
+        # === Parameters
+        #
+        # [name (#to_sym)] name of the version
+        # [&block (Proc)] a block to eval on this version of the uploader
+        #
+        # === Examples
+        #
+        #     class Video < DirectWave::Uploader::Base
+        #
+        #       version :iphone do
+        #         def filename
+        #           @filename ||= [extract(:guid), "iphone-video" << extract(:extname)].join("/")
+        #         end
+        #         
+        #         def process
+        #           super
+        #
+        #           # processing version here with zencoder.com or another encoding cloud service
+        #         end
+        #       end
+        #
+        #     end
+        #
+        def version(name, &block)
+          name = name.to_sym
+          unless versions[name]
+            version = Class.new(Version)
+
+            # Add the current version hash to class attribute :versions
+            current_version = {}
+            current_version[name] = version
+            self.versions = versions.merge(current_version)
+
+            class_eval <<-RUBY
+              def #{name}
+                versions[:#{name}]
+              end
+            RUBY
+          end
+          versions[name].class_eval(&block) if block
+          versions[name]
+        end
+        
+      end # ClassMethods
+
+      ##
+      # Returns a hash mapping the name of each version of the Version to an instance of it
+      #
+      # === Returns
+      #
+      # [Hash{Symbol => DirectWave::Versions::Version}] a list of version instances
+      #
+      def versions
+        return @versions if @versions
+        @versions = {}
+        self.class.versions.each do |name, version|
+          @versions[name] = version.new(self, name)
+        end
+        @versions
+      end
+      
+    end # Versions    
+  end # Uploader
+  
+end# DirectWave

data/lib/directwave/version.rb

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

data/lib/directwave.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require "active_support/core_ext"
+require "active_support/concern"
+require "uuid"
+require "aws-sdk"
+require "base64" 
+
+module DirectWave
+  class << self
+    def configure(&block)
+      DirectWave::Uploader::Base.configure(&block)
+    end
+  end
+    
+  autoload :Mounter, "directwave/mounter"
+  autoload :VERSION, "directwave/version"
+
+  module Uploader
+    autoload :Base, "directwave/uploader/uploader"
+    autoload :Configuration, "directwave/uploader/configuration"
+    autoload :Accreditation, "directwave/uploader/accreditation"
+    autoload :Paths, "directwave/uploader/paths"
+    autoload :Versions, "directwave/uploader/versions"
+    autoload :Connection, "directwave/uploader/connection"
+  end
+end
+
+require "directwave/railtie" if defined?(Rails) 

data/lib/generators/directwave_generator.rb

@@ -0,0 +1,8 @@
+class DirectwaveGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+
+  def create_uploader_file
+    template "directwave.rb", "app/uploaders/#{file_name}_uploader.rb"
+  end
+end
+

data/lib/generators/templates/directwave.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+class <%= class_name %>Uploader < DirectWave::Uploader::Base
+  # Override the directory where uploaded files will be stored.
+  def store_dir
+    "uploads/#{model.class.to_s.underscore.pluralize}/#{mounted_as}"
+  end
+  
+  # Override the directory where files will be uploaded.
+  def upload_dir
+    "uploads/tmp/#{Time.new.to_date.to_s}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # asset_path("fallback/default.ext")
+  #
+  #   "fallback/default.ext"
+  # end
+  # Create different versions of your uploaded files:
+  # version :audio do
+  #   def filename
+  #     @filename ||= [extract(:guid), [extract(:basename), @name].join("-") << extract(:extname)].join("/")
+  #   end
+  #   
+  #   def process
+  #     super
+  #
+  #     # processing code goes here
+  #   end
+  # end
+end

data/spec/directwave/fixtures/Uppercase.jpg

@@ -0,0 +1 @@
+this is stuff

data/spec/directwave/fixtures/bork.ttxt

@@ -0,0 +1 @@
+bork bork bork Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/spec/directwave/fixtures/bork.txt

@@ -0,0 +1 @@
+bork bork bork Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/spec/directwave/fixtures/bork.txtt

@@ -0,0 +1 @@
+bork bork bork Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/spec/directwave/fixtures/case.JPG

@@ -0,0 +1 @@
+this is stuff

data/spec/directwave/fixtures/new.jpeg

@@ -0,0 +1 @@
+this is stuff

data/spec/directwave/fixtures/new.txt

@@ -0,0 +1 @@
+bork bork bork Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/spec/directwave/fixtures/old.jpeg

@@ -0,0 +1 @@
+this is stuff

data/spec/directwave/fixtures/old.txt

@@ -0,0 +1 @@
+bork bork bork Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/spec/directwave/fixtures/sponsored.doc

@@ -0,0 +1 @@
+Hi there

data/spec/directwave/fixtures/test.jpeg

@@ -0,0 +1 @@
+this is stuff

data/spec/directwave/fixtures/test.jpg

@@ -0,0 +1 @@
+this is stuff

data/spec/directwave/orm/active_record_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+require "directwave/orm/activerecord"
+
+describe DirectWave::ActiveRecord do
+  describe "activerecord" do
+    it "needs testing with rspec" 
+  end
+end

data/spec/directwave/uploader/accreditation_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe DirectWave::Uploader::Accreditation do
+  before do
+    @model = mock("model")
+    @uploader_class = Class.new(DirectWave::Uploader::Base)
+    @uploader = @uploader_class.new(@model, "foo")
+  end
+  
+  describe "#acl" do
+    it "should return the sanitized s3 access policy" do
+      @uploader.s3_acl.should == @uploader.s3_access_policy.to_s.gsub("_", "-")
+    end
+  end
+
+  describe "#policy" do
+    let(:decoded_s3_policy) { JSON.parse(Base64.decode64(@uploader.s3_policy)) }
+
+    it "should return Base64-encoded JSON" do
+      decoded_s3_policy.should be_a(Hash)
+    end
+
+    it "should not contain any new lines" do
+      @uploader.s3_policy.should_not include("\n")
+    end
+    
+    it "should be tested by parts"
+  end
+  
+  describe "#signature" do
+    it "should not contain any new lines" do
+      @uploader.s3_signature.should_not include("\n")
+    end
+
+    it "should return a base64 encoded 'sha1' hash of the secret key and policy document" do
+      Base64.decode64(@uploader.s3_signature).should == OpenSSL::HMAC.digest(
+        OpenSSL::Digest::Digest.new('sha1'),
+        @uploader.s3_secret_access_key, @uploader.s3_policy
+      )
+    end
+  end
+end

data/spec/directwave/uploader/configuration_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe DirectWave do
+  before do
+    @uploader_class = Class.new(DirectWave::Uploader::Base)
+  end
+
+  describe '.configure' do
+    it "should proxy to Uploader configuration" do
+      DirectWave::Uploader::Base.add_config :test_config
+      DirectWave.configure do |config|
+        config.test_config = "foo"
+      end
+      DirectWave::Uploader::Base.test_config.should == 'foo'
+    end
+  end
+end
+
+describe DirectWave::Uploader::Base do
+  before do
+    @uploader_class = Class.new(DirectWave::Uploader::Base)
+  end
+
+  describe ".configure" do
+    it "should set a configuration parameter" do
+      @uploader_class.add_config :foo_bar
+      @uploader_class.configure do |config|
+        config.foo_bar = "monkey"
+      end
+      @uploader_class.foo_bar.should == "monkey"
+    end
+  end
+  
+  describe ".add_config" do
+    it "should add a class level accessor" do
+      @uploader_class.add_config :foo_bar
+      @uploader_class.foo_bar = "foo"
+      @uploader_class.foo_bar.should == "foo"
+    end
+  
+    ["foo", :foo, 45, ["foo", :bar]].each do |val|
+      it "should be inheritable for a #{val.class}" do
+        @uploader_class.add_config :foo_bar
+        @child_class = Class.new(@uploader_class)
+  
+        @uploader_class.foo_bar = val
+        @uploader_class.foo_bar.should == val
+        @child_class.foo_bar.should == val
+  
+        @child_class.foo_bar = "bar"
+        @child_class.foo_bar.should == "bar"
+  
+        @uploader_class.foo_bar.should == val
+      end
+    end 
+  
+    it "should add an instance level accessor" do
+      @uploader_class.add_config :foo_bar
+      @uploader_class.foo_bar = "foo"
+      @uploader_class.new.foo_bar.should == "foo"
+    end
+  
+    it "should add a convenient in-class setter" do
+      @uploader_class.add_config :foo_bar
+      @uploader_class.foo_bar "monkey"
+      @uploader_class.foo_bar.should == "monkey"
+    end
+  end # describe ".add_config"
+end

data/spec/directwave/uploader/connection_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe DirectWave::Uploader::Connection do
+  describe ".s3_connection" do
+    it "not tested yet!"
+  end
+
+  describe ".s3_directory" do
+    it "not tested yet!"
+  end
+end

data/spec/directwave/uploader/paths_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe DirectWave::Uploader::Paths do
+  before do
+    @model = mock("a model object")
+    @uploader_class = Class.new(DirectWave::Uploader::Base)
+    @uploader = @uploader_class.new(@model, "foo")
+  end
+  
+  describe '#original_filename' do
+    it "should return 'foo/bar.aac'" # @uploader.original_filename.should == "foo/bar.aac"
+  end
+  
+  describe "#filename" do
+    context "store key is autogenerated" do
+      it "should return 'foo'" do
+        @uploader.filename.should be_nil
+      end
+    end
+
+    context "store key is key 's3/key/to/foo/bar.aac' of s3" do
+      before { @uploader.store_key = "s3/key/to/foo/bar.aac" }
+      
+      it "should return 'foo/bar.aac'" do
+        @uploader.filename.should == "foo/bar.aac"
+      end
+    end
+  end
+  
+  describe "#store_key=" do
+    before { @uploader.store_key = "foo" }
+
+    it "should set the store key" do
+      @uploader.store_key.should == "foo"
+    end
+  end
+
+  describe "#store_key" do
+    context "where the store key is not set and #upload_dir returns 'foo'" do
+      before do
+        @uploader.stub(:upload_dir).and_return("foo")
+        @uploader.stub(:guid).and_return("guid")
+        @uploader.store_key = nil
+      end
+
+      it "should return 'foo/guid/${filename}'" do
+        @uploader.store_key.should =~ /foo\/guid\/\$\{filename\}$/
+      end
+    end
+  end
+
+  describe "#has_store_key?" do
+    context "a store_key has not been set" do
+
+      it "should return false" do
+        @uploader.should_not have_store_key
+      end
+    end
+
+    context "the store_key has been autogenerated" do
+      before { @uploader.store_key }
+
+      it "should return false" do
+        @uploader.should_not have_store_key
+      end
+    end
+
+    context "the store_key has been set" do
+      before { @uploader.store_key = "foo" }
+
+      it "should return true" do
+        @uploader.should have_store_key
+      end
+    end
+  end
+end

data/spec/directwave/uploader/uploader_spec.rb

@@ -0,0 +1,33 @@
+describe DirectWave::Uploader do
+  before do
+    @model = mock('a model object')
+    @uploader_class = Class.new(DirectWave::Uploader::Base)
+    @uploader = @uploader_class.new(@model, :foo)
+  end
+
+  describe '#model' do
+    it "should be remembered from initialization" do
+      puts @uploader.store_key
+      @uploader.model.should == @model
+    end
+  end
+
+  describe '#mounted_as' do
+    it "should be remembered from initialization" do
+      @uploader.model.should == @model
+      @uploader.mounted_as.should == :foo
+    end
+  end
+  
+  describe "#save" do
+    it "not tested yer and not finished"
+  end
+
+  describe "#destroy" do
+    it "not tested yer and not finished"
+  end
+  
+  describe "#original version" do
+    it "not tested yer and not finished"
+  end  
+end