fakerclip 0.0.2 → 0.1.0

data/README.md

@@ -34,6 +34,8 @@ gem 'fakerclip'
 
 That's it!  Now, just omit `: { path: 'is/my/local/path' }` from the example above and expect that your files will appear in `"#{Rails.root}/public/fakerclip/(development|test)/s3-foo-bar-bucket/"` with the same structure as you would expect on S3, e.g. `is/my/s3/path` from above.
 
+You can use either/both the fog and the aws-sdk gems as the client for S3
+
 ### Development
 
 ``` shell

data/lib/fakerclip/reads.rb

@@ -2,6 +2,9 @@ module Fakerclip
 
   class Reads
 
+    SUBDOMAIN_BUCKET_REGEX = %r{https?:\/\/(.+)\.s3\.amazonaws\.com}
+    PATH_BUCKET_REGEX      = %r{https?:\/\/s3\.amazonaws\.com\/([^\/]+)\/}
+
     def self.activate
       Paperclip::Attachment.default_options[:url_generator] = UrlGenerator
     end
@@ -11,9 +14,11 @@ module Fakerclip
       def for(style_name, options)
         uri = URI.parse(super)
 
-        if uri.to_s.match(/\.s3\.amazonaws\.com/)
-          bucket = uri.host.split(/\./, 2).first
-          "/fake_s3_#{Rails.env}/#{bucket}#{uri.request_uri}"
+        case uri.to_s
+        when SUBDOMAIN_BUCKET_REGEX
+          "/fake_s3_#{Rails.env}/#{$1}#{uri.request_uri}"
+        when PATH_BUCKET_REGEX
+          "/fake_s3_#{Rails.env}#{uri.request_uri}"
         else
           uri.to_s
         end

data/lib/fakerclip/version.rb

@@ -1,3 +1,3 @@
 module Fakerclip
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/fakerclip/writes.rb

@@ -1,36 +1,87 @@
 module Fakerclip
 
+  # TODO: * set mocking for Excon to only apply to *some-bucket*.s3.amazonaws.com and only
+  # while paperclip is making the requests, so we don't clobber other legit requests.
   class Writes
 
     def self.activate
-      # stubbing writes to S3
-      ::Excon.stub({ method: "PUT" }) do |params|
+      # fog gem support
+      ::Excon.stub({ method: "PUT" }, FakeS3::ExconResponder.block)
+      ::Excon.defaults[:mock] = true
 
-        # TODO: generate etags for multipart uploads
-        etag            = Digest::MD5.hexdigest(params[:body])
+      # aws-sdk gem support
+      Artifice.activate_with(FakeS3::AWSSDKResponder.new)
+    end
 
-        s3_bucket       = params[:host].split('.').first
-        s3_file_path    = CGI.unescape params[:path]
-        local_s3_path   = Rails.root.join(File.join('public', "fake_s3_#{Rails.env}"))
-        local_file_path = File.join(local_s3_path, s3_bucket, s3_file_path)
+    class S3Request
 
-        # creates the file tree, e.g. public/fake_s3_development/s3-bucket/files/1/
-        FileUtils.mkdir_p File.dirname(local_file_path)
+      attr_accessor :body, :etag, :s3_path, :s3_bucket
 
-        # writes the file to the fake s3
-        File.open(local_file_path, "wb") {|file| file.write(params[:body]) }
-
-        # TODO: generate alternate statuses, e.g. if the file is not found
-        {
-          status: 200,
-          headers: params[:headers].merge("ETag" => etag),
-          body: params[:body]
-        }
+      def initialize(env)
+        self.body      = env['rack.input'] && env['rack.input'].read || env[:body]
+        self.s3_bucket = (env['HTTP_HOST'] || env[:host]).split('.').first
+        self.s3_path   = env['PATH_INFO'] || CGI.unescape(env[:path])
+        self.etag      = Digest::MD5::hexdigest(body)
       end
+    end
 
-      # TODO: set mocking for Excon to apply only to some-bucket.s3.amazonaws.com and only
-      # while paperclip is making the requests, so we don't clobber other legit requests.
-      ::Excon.defaults[:mock] = true
+    class FakeS3
+
+      class AWSSDKResponder
+
+        def call(env)
+          Response.new(env).to_hash.values
+        end
+      end
+
+      class ExconResponder
+
+        def self.block
+          Proc.new { |env| Response.new(env).to_hash }
+        end
+      end
+
+      class Response
+
+        def initialize(env)
+          @request = S3Request.new(env)
+
+          LocalS3Object.new(@request.s3_bucket, @request.s3_path).save(@request.body)
+        end
+
+        def to_hash
+          # TODO: generate etags for multipart uploads
+          {
+            status: 200,
+            headers: { "ETag" => @request.etag },
+            body: ["OK"]
+          }
+        end
+      end
+
+      class LocalS3Object
+
+        def initialize(s3_bucket, s3_file_path)
+          @local_file_path = File.join(path_to_local_s3, s3_bucket, s3_file_path)
+
+          ensure_path_exists
+        end
+
+        # writes the file to the fake s3
+        def save(data)
+          File.open(@local_file_path, "wb") {|file| file.write(data) }
+        end
+
+        private
+
+        def path_to_local_s3
+          Rails.root.join(File.join('public', "fake_s3_#{Rails.env}"))
+        end
+
+        def ensure_path_exists
+          FileUtils.mkdir_p File.dirname(@local_file_path)
+        end
+      end
     end
   end
 end

data/lib/fakerclip.rb

@@ -1,6 +1,8 @@
+# TODO: move these where they are needed
 require 'fileutils'
 require 'paperclip'
 require 'fog'
+require 'artifice'
 
 module Fakerclip
 

data/spec/dummy/app/models/aws_sdk_s3_gem_upload.rb

@@ -0,0 +1,14 @@
+class AwsSdkS3GemUpload < Upload
+
+  has_attached_file :file,
+                    :storage => :s3,
+                    :s3_credentials => {
+                      :access_key_id => "AWSACCESSKEY",
+                      :secret_access_key => "AWSSECRETKEY"
+                    },
+                    :bucket => "some-bucket",
+                    :s3_permissions => :public_read,
+                    :path => ":attachment/:id/:basename.:extension"
+
+  before_post_process :image?
+end

data/spec/dummy/app/models/fog_s3_gem_upload.rb

@@ -0,0 +1,15 @@
+class FogS3GemUpload < Upload
+
+  has_attached_file :file,
+                    :storage => :fog,
+                    :fog_public => true,
+                    :fog_credentials => {
+                      :provider => 'AWS',
+                      :aws_access_key_id => "AWSACCESSKEY",
+                      :aws_secret_access_key => "AWSSECRETKEY"
+                    },
+                    :fog_directory => "some-bucket",
+                    :path => ":attachment/:id/:basename.:extension"
+
+  before_post_process :image?
+end

data/spec/dummy/app/models/upload.rb

@@ -2,18 +2,6 @@ class Upload < ActiveRecord::Base
 
   attr_accessible :file
 
-  has_attached_file :file,
-                    :storage => :fog,
-                    :fog_public => true,
-                    :fog_credentials => {
-                      :provider => 'AWS',
-                      :aws_access_key_id => "AWSACCESSKEY",
-                      :aws_secret_access_key => "AWSSECRETKEY"
-                    },
-                    :fog_directory => "some-bucket",
-                    :path => ":attachment/:id/:basename.:extension"
-
-  before_post_process :image?
   def image?
     false
   end