mss-sdk 1.0.0

data/lib/mss/s3/object_version_collection.rb

@@ -0,0 +1,88 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  class S3
+
+    # For S3 buckets with versioning enabled, objects will store versions
+    # each time you write to them.
+    #
+    #     object = bucket.objects['myobj']
+    #     object.write('1')
+    #     object.write('2')
+    #     object.write('3')
+    #
+    #     object.versions.collect(&:read)
+    #     #=> ['1', '2', '3']
+    #
+    # To see all the version id for a particular object, access the any particular version,
+    # and see the latest version:
+    #
+    #     object.versions.each do |version| puts version.version_id end
+    #     #=> T2TwAiZ3SmNr7tOfe0QBa4RZnSb3GSLq
+    #     #=> kAEHC_ysT65bT4P3zyYOP1ELA6ajar_6
+    #     #=> itHPX6m8na_sog0cAtkgP3QITEE8v5ij
+    #
+    #     object.versions['itHPX6m8na_sog0cAtkgP3QITEE8v5ij']
+    #     #=> <MSS::S3::ObjectVersion:<<bucket>>:myobj:itHPX6m8na_sog0cAtkgP3QITEE8v5ij>
+    #
+    #     object.versions.latest
+    #     #=> <MSS::S3::ObjectVersion:<<bucket>>:myobj:T2TwAiZ3SmNr7tOfe0QBa4RZnSb3GSLq>
+    #
+    # If you know the id of a particular version you can get that object.
+    #
+    #     bucket.objects['myobj'].version[version_id].delete
+    #
+    class ObjectVersionCollection
+
+      include Core::Model
+      include Enumerable
+
+      # @return [S3Object] The object this collection belongs to.
+      attr_reader :object
+
+      # @param [S3Object] object
+      def initialize object, options = {}
+        @object = object
+        super(options)
+      end
+
+      # Returns an object that represents a single version of the {#object}.
+      # @param [String] version_id
+      # @return [ObjectVersion]
+      def [] version_id
+        ObjectVersion.new(object, version_id)
+      end
+
+      # @note Generally you will just want to grab the object key its key.
+      # @return [ObjectVersion] Returns the latest version of this object.
+      def latest
+        self.find{|version| true }
+      end
+
+      # Yields once for each version of the {#object}.
+      #
+      # @yield [object_version]
+      # @yieldparam [ObectVersion] object_version
+      # @return [nil]
+      def each &block
+        object.bucket.versions.with_prefix(object.key).each do |version|
+          if version.key == object.key
+            yield(version)
+          end
+        end
+        nil
+      end
+
+    end
+  end
+end

data/lib/mss/s3/paginated_collection.rb

@@ -0,0 +1,74 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  class S3
+
+    # @api private
+    module PaginatedCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      protected
+      def _each_item markers, limit, options = {}, &block
+
+        options = list_options(options)
+        options.merge!(markers) unless markers.nil? or markers.empty?
+        options[limit_param] = limit || 1000
+
+        response = list_request(options)
+
+        each_member_in_page(response, &block)
+
+        response.data[:truncated] ? next_markers(response) : nil
+
+      end
+
+      protected
+      def each_member_in_page(page, &block); end
+
+      protected
+      def list_request(options)
+        raise NotImplementedError
+      end
+
+      protected
+      def list_options options
+        opts = {}
+        opts[:bucket_name] = bucket.name if respond_to?(:bucket)
+        opts
+      end
+
+      protected
+      def limit_param
+        raise NotImplementedError
+      end
+
+      protected
+      def pagination_markers
+        [:key_marker]
+      end
+
+      protected
+      def next_markers page
+        pagination_markers.inject({}) do |markers, marker_name|
+          if marker = page.data[:"next_#{marker_name}"]
+            markers[marker_name] = marker if marker
+          end
+          markers
+        end
+      end
+
+    end
+
+  end
+end

data/lib/mss/s3/policy.rb

@@ -0,0 +1,73 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  class S3
+
+    # (see Core::Policy)
+    class Policy < Core::Policy
+
+      class Statement < Core::Policy::Statement
+
+        ACTION_MAPPING = {
+          :list_buckets => "s3:ListAllMyBuckets",
+          :create_bucket => "s3:CreateBucket",
+          :delete_bucket => "s3:DeleteBucket",
+          :list_objects => "s3:ListBucket",
+          :list_object_versions => "s3:ListBucketVersions",
+          :list_multipart_uploads => "s3:ListBucketMultipartUploads",
+          :get_object => "s3:GetObject",
+          :get_object_version => "s3:GetObjectVersion",
+          :put_object => "s3:PutObject",
+          :get_object_acl => "s3:GetObjectAcl",
+          :get_object_version_acl => "s3:GetObjectVersionAcl",
+          :set_object_acl => "s3:PutObjectAcl",
+          :set_object_acl_version => "s3:PutObjectAclVersion",
+          :delete_object => "s3:DeleteObject",
+          :delete_object_version => "s3:DeleteObjectVersion",
+          :list_multipart_upload_parts => "s3:ListMultipartUploadParts",
+          :abort_multipart_upload => "s3:AbortMultipartUpload",
+          :get_bucket_acl => "s3:GetBucketAcl",
+          :set_bucket_acl => "s3:PutBucketAcl",
+          :get_bucket_versioning => "s3:GetBucketVersioning",
+          :set_bucket_versioning => "s3:PutBucketVersioning",
+          :get_bucket_requester_pays => "s3:GetBucketRequesterPays",
+          :set_bucket_requester_pays => "s3:PutBucketRequesterPays",
+          :get_bucket_location => "s3:GetBucketLocation",
+          :get_bucket_policy => "s3:GetBucketPolicy",
+          :set_bucket_policy => "s3:PutBucketPolicy",
+          :get_bucket_notification => "s3:GetBucketNotification",
+          :set_bucket_notification => "s3:PutBucketNotification"
+        }
+
+        protected
+        def resource_arn resource
+          prefix = 'arn:mss:s3:::'
+          case resource
+          when Bucket
+            "#{prefix}#{resource.name}"
+          when S3Object
+            "#{prefix}#{resource.bucket.name}/#{resource.key}"
+          when ObjectCollection
+            "#{prefix}#{resource.bucket.name}/#{resource.prefix}*"
+          when /^arn:/
+            resource
+          else
+            "arn:mss:s3:::#{resource}"
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/mss/s3/prefix_and_delimiter_collection.rb

@@ -0,0 +1,46 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  class S3
+
+    # @api private
+    module PrefixAndDelimiterCollection
+
+      include PrefixedCollection
+
+      # @see Bucket#as_tree
+      def as_tree options = {}
+        Tree.new(self, { :prefix => prefix }.merge(options))
+      end
+
+      # @api private
+      protected
+      def each_member_in_page(page, &block)
+        super
+        page.common_prefixes.each do |p|
+          yield(with_prefix(p[:prefix]))
+        end
+      end
+
+      # @api private
+      protected
+      def list_options(options)
+        opts = super
+        opts[:delimiter] = options[:delimiter] if options.key?(:delimiter)
+        opts
+      end
+
+    end
+
+  end
+end

data/lib/mss/s3/prefixed_collection.rb

@@ -0,0 +1,84 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  class S3
+
+    module PrefixedCollection
+
+      include PaginatedCollection
+
+      # @api private
+      def initialize *args
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        @prefix = options[:prefix]
+        args.push(options)
+        super(*args)
+      end
+
+      # @return [String,nil] The prefix of this collection.
+      attr_reader :prefix
+
+      # Returns a new collection with a different prefix
+      #
+      # @example
+      #
+      #   objects = collection.with_prefix('photos')
+      #   objects.prefix #=> 'photos'
+      #
+      # @example Chaining with_prefix replaces previous prefix
+      #
+      #   objects = collection.with_prefix('photos').with_prefix('videos')
+      #   objects.prefix #=> 'videos'
+      #
+      # @example Chaining with_prefix with :append
+      #
+      #   objects = collection.with_prefix('a/').with_prefix('b/', :append)
+      #   objects.prefix #=> 'a/b/'
+      #
+      # @example Chaining with_prefix with :prepend
+      #
+      #   objects = collection.with_prefix('a/').with_prefix('b/', :prepend)
+      #   objects.prefix #=> 'b/a/'
+      #
+      # @param [String] prefix The prefix condition that limits what objects
+      #   are returned by this collection.
+      # @param [Symbol] mode (:replace) If you chain calls to #with_prefix
+      #   the `mode` affects if the prefix prepends, appends, or replaces.
+      #   Valid modes are:
+      #   * `:replace`
+      #   * `:append`
+      #   * `:prepend`
+      # @return [Collection] Returns a new collection with a modified prefix.
+      def with_prefix prefix, mode = :replace
+        new_prefix = case mode
+        when :replace then prefix
+        when :append  then "#{@prefix}#{prefix}"
+        when :prepend then "#{prefix}#{@prefix}"
+        else
+          raise ArgumentError, "invalid prefix mode `#{mode}`, it must be " +
+            ":replace, :append or :prepend"
+        end
+        self.class.new(bucket, :prefix => new_prefix)
+      end
+
+      # @api private
+      protected
+      def list_options(options)
+        opts = super
+        opts[:prefix] = prefix if prefix
+        opts
+      end
+
+    end
+  end
+end

data/lib/mss/s3/presign_v4.rb

@@ -0,0 +1,135 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module MSS
+  class S3
+
+    # Utility class for building pre-signed URLs for Amazon S3 objects using
+    # signature version 4.
+    class PresignV4
+
+      # @param [S3Object] object
+      def initialize(object)
+        @object = object
+        @client = object.client
+        @signer = object.client.send(:v4_signer)
+      end
+
+      # @return [S3Object]
+      attr_reader :object
+
+      # @return [Client]
+      attr_reader :client
+
+      # @return [Core::Signers::Version4]
+      attr_reader :signer
+
+      # @param (see S3Object#url_for)
+      # @option (see S3Object#url_for)
+      # @return (see S3Object#url_for)
+      def presign(method, options = {})
+
+        now = Time.now.utc
+        one_week = 60 * 60 * 24 * 7
+        if options[:expires] - now.to_i > one_week
+          msg = "presigned URLs using sigv4 may not expire more than one week out"
+          raise ArgumentError, msg
+        end
+
+        now = now.strftime("%Y%m%dT%H%M%SZ")
+
+        request = build_request(method, options)
+
+        request.headers.clear
+        request.headers['host'] = request.host
+        signed_headers = 'Host'
+
+        if options[:acl]
+          request.add_param("x-amz-acl", options[:acl].to_s.gsub(/_/, '-'))
+        end
+
+        # must be sent along with the PUT request headers
+        if options[:content_md5]
+          request.headers['Content-MD5'] = options[:content_md5]
+          signed_headers << ';Content-MD5'
+        end
+
+        request_params = Core::Signers::S3::QUERY_PARAMS.map do |p|
+          param = p.tr("-","_").to_sym
+          if options.key?(param)
+            request.add_param(p, options[param])
+          end
+        end
+
+        token = client.credential_provider.session_token
+
+        request.add_param("X-Amz-Algorithm", "MSS4-HMAC-SHA256")
+        request.add_param("X-Amz-Date", now)
+        request.add_param("X-Amz-SignedHeaders", signed_headers)
+        request.add_param("X-Amz-Expires", seconds_away(options[:expires]))
+        request.add_param('X-Amz-Security-Token', token) if token
+        request.add_param("X-Amz-Credential", signer.credential(now))
+        request.add_param("X-Amz-Signature", signature(request, now))
+
+        build_uri(request, options)
+
+      end
+
+      private
+
+      def build_request(method, options)
+        path_style = object.config.s3_force_path_style
+        params = options.merge(
+          :bucket_name => object.bucket.name,
+          :key => object.key,
+          :data => ''
+        )
+        req = client.send(:build_request, operation_name(method), params)
+        req.force_path_style = options.fetch(:force_path_style, path_style)
+        req
+      end
+
+      def operation_name(method)
+        case method
+        when :get, :read then :get_object
+        when :put, :write then :put_object
+        when :delete then :delete_object
+        when :head then :head_object
+        else
+          msg = "invalid method, expected :get, :put or :delete, got "
+          msg << method.inspect
+          raise ArgumentError msg
+        end
+      end
+
+      def signature(request, datetime)
+        key = signer.derive_key(datetime)
+        signer.signature(request, key, datetime, 'UNSIGNED-PAYLOAD')
+      end
+
+      def build_uri(request, options)
+        uri_class = options[:secure] ? URI::HTTPS : URI::HTTP
+        uri_class.build(
+          :host => request.host,
+          :port => request.port,
+          :path => request.path,
+          :query => request.querystring
+        )
+      end
+
+      def seconds_away(expires)
+        expires - Time.now.to_i
+      end
+
+    end
+  end
+end