jnicklas-carrierwave 0.1.1 → 0.2.0

data/lib/carrierwave/storage/s3.rb

@@ -17,21 +17,20 @@ module CarrierWave
     # Possible values are the 'canned access control policies' provided in the aws/s3 gem,
     # they are:
     #
-    #     :private              No one else has any access rights.
-    #     :public_read          The anonymous principal is granted READ access.
-    #                           If this policy is used on an object, it can be read from a
-    #                           browser with no authentication.
-    #     :public_read_write    The anonymous principal is granted READ and WRITE access.
-    #     :authenticated_read   Any principal authenticated as a registered Amazon S3 user
-    #                           is granted READ access.
+    # [:private]              No one else has any access rights.
+    # [:public_read]          The anonymous principal is granted READ access.
+    #                         If this policy is used on an object, it can be read from a
+    #                         browser with no authentication.
+    # [:public_read_write]    The anonymous principal is granted READ and WRITE access.
+    # [:authenticated_read]   Any principal authenticated as a registered Amazon S3 user
+    #                         is granted READ access.
     #
     # The default is :public_read, it should work in most cases.
     #
     class S3 < Abstract
       
-      def initialize(bucket, store_dir, identifier)
-        @bucket = bucket
-        @store_dir = store_dir
+      def initialize(store_path, identifier)
+        @store_path = store_path
         @identifier = identifier
       end
       
@@ -47,14 +46,18 @@ module CarrierWave
       end
       
       ##
-      # @return [String] the bucket set in the config options
+      # === Returns
+      #
+      # [String] the bucket set in the config options
       # 
       def self.bucket
         CarrierWave.config[:s3][:bucket]
       end
       
       ##
-      # @return [Symbol] the access priviliges the uploaded files should have
+      # === Returns
+      #
+      # [Symbol] the access priviliges the uploaded files should have
       #
       def self.access
         CarrierWave.config[:s3][:access]
@@ -63,14 +66,18 @@ module CarrierWave
       ##
       # Store the file on S3
       #
-      # @param [CarrierWave::Uploader] uploader an uploader object
-      # @param [CarrierWave::SanitizedFile] file the file to store
+      # === Parameters
+      #
+      # [uploader (CarrierWave::Uploader)] an uploader object
+      # [file (CarrierWave::SanitizedFile)] the file to store
       #
-      # @return [#identifier] an object
+      # === Returns
+      #
+      # [CarrierWave::Storage::S3] the stored file
       #
       def self.store!(uploader, file)
-        AWS::S3::S3Object.store(::File.join(uploader.store_dir, uploader.filename), file.read, bucket, :access => access)
-        self.new(bucket, uploader.store_dir, uploader.filename)
+        AWS::S3::S3Object.store(::File.join(uploader.store_path), file.read, bucket, :access => access)
+        self.new(uploader.store_dir, uploader.filename)
       end
       
       # Do something to retrieve the file
@@ -78,28 +85,48 @@ module CarrierWave
       # @param [CarrierWave::Uploader] uploader an uploader object
       # @param [String] identifier uniquely identifies the file
       #
-      # @return [#identifier] an object
+      # [uploader (CarrierWave::Uploader)] an uploader object
+      # [identifier (String)] uniquely identifies the file
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::S3] the stored file
       #
       def self.retrieve!(uploader, identifier)
-        self.new(bucket, uploader.store_dir, identifier)
+        self.new(uploader.store_path(identifier), identifier)
       end
       
       ##
       # Returns the filename on S3
       #
-      # @return [String] path to the file
+      # === Returns
+      #
+      # [String] path to the file
       #
       def identifier
         @identifier
       end
 
+      ##
+      # Reads the contents of the file from S3
+      #
+      # === Returns
+      #
+      # [String] contents of the file
+      #
+      def read
+        S3Object.value @store_path, self.class.bucket
+      end
+
       ##
       # Returns the url on Amazon's S3 service
       #
-      # @return [String] file's url
+      # === Returns
+      #
+      # [String] file's url
       #
       def url
-        ["http://s3.amazonaws.com", self.class.bucket, @store_dir, @identifier].compact.join('/')
+        ["http://s3.amazonaws.com", self.class.bucket, @store_path].compact.join('/')
       end
       
     end # S3

data/lib/carrierwave/test/matchers.rb

@@ -0,0 +1,112 @@
+module CarrierWave
+  module Test
+
+    ##
+    # These are some matchers that can be used in RSpec specs, to simplify the testing
+    # of uploaders.
+    #
+    module Matchers
+
+      class BeIdenticalTo
+        def initialize(expected)
+          @expected = expected
+        end
+        def matches?(actual)
+          @actual = actual
+          FileUtils.identical?(@actual, @expected)
+        end
+        def failure_message
+          "expected #{@actual.inspect} to be identical to #{@expected.inspect}"
+        end
+        def negative_failure_message
+          "expected #{@actual.inspect} to not be identical to #{@expected.inspect}"
+        end
+      end
+
+      def be_identical_to(expected)
+        BeIdenticalTo.new(expected)
+      end
+
+      class HavePermissions
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          (File.stat(@actual.path).mode & 0777) == @expected
+        end
+
+        def failure_message
+          "expected #{@actual.inspect} to have permissions #{@expected.to_s(8)}, but they were #{(File.stat(@actual.path).mode & 0777).to_s(8)}"
+        end
+
+        def negative_failure_message
+          "expected #{@actual.inspect} not to have permissions #{@expected.to_s(8)}, but it did"
+        end
+      end
+
+      def have_permissions(expected)
+        HavePermissions.new(expected)
+      end
+
+      class BeNoLargerThan
+        def initialize(width, height)
+          @width, @height = width, height
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          require 'RMagick'
+          img = ::Magick::Image.read(@actual.path).first
+          @actual_width = img.columns
+          @actual_height = img.rows
+          @actual_width <= @width && @actual_height <= @height
+        end
+
+        def failure_message
+          "expected #{@actual.inspect} to be no larger than #{@width} by #{@height}, but it was #{@actual_height} by #{@actual_width}."
+        end
+
+        def negative_failure_message
+          "expected #{@actual.inspect} to be larger than #{@width} by #{@height}, but it wasn't."
+        end
+      end
+
+      def be_no_larger_than(width, height)
+        BeNoLargerThan.new(width, height)
+      end
+
+      class HaveDimensions
+        def initialize(width, height)
+          @width, @height = width, height
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          require 'RMagick'
+          img = ::Magick::Image.read(@actual.path).first
+          @actual_width = img.columns
+          @actual_height = img.rows
+          @actual_width == @width && @actual_height == @height
+        end
+
+        def failure_message
+          "expected #{@actual.inspect} to have an exact size of #{@width} by #{@height}, but it was #{@actual_height} by #{@actual_width}."
+        end
+
+        def negative_failure_message
+          "expected #{@actual.inspect} not to have an exact size of #{@width} by #{@height}, but it did."
+        end
+      end
+
+      def have_dimensions(width, height)
+        HaveDimensions.new(width, height)
+      end
+      
+    end # SpecHelper
+  end # Test
+end # CarrierWave