mss-sdk 1.0.0

data/lib/mss/s3/bucket_tag_collection.rb

@@ -0,0 +1,110 @@
+# 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
+
+    # Manages tags for a single S3 {Bucket}.
+    #
+    # @example Setting a tag.
+    #
+    #   bucket.tags['key'] = 'value'
+    #
+    # @example Getting a tag.
+    #
+    #   bucket.tags['key']
+    #   #=> 'value'
+    #
+    # @example Getting all tags
+    #
+    #   bucket.tags.to_h
+    #   #=> { 'key' => 'value', ... }
+    #
+    # @example Removing all tags
+    #
+    #   bucket.tags.clear
+    #
+    class BucketTagCollection
+
+      include Core::Model
+
+      # @param [Bucket] bucket
+      # @param [Hash] options
+      def initialize bucket, options = {}
+        @bucket = bucket
+        super
+      end
+
+      # @return [Bucket]
+      attr_reader :bucket
+
+      # @param [String] key
+      # @return [String,nil] Returns the tag for the given key.  If there
+      #    Returns `nil` if the key does not exist.
+      def [] key
+        self.to_h[key]
+      end
+
+      # @param [String] key
+      # @param [String] value
+      def []= key, value
+        self.set(self.to_h.merge(key => value))
+      end
+
+      # @param [Hash<String,String>] tags A hash of tag keys and values.
+      # @return [nil]
+      def set tags
+        if tags.nil? or tags.empty?
+          self.clear
+        else
+          client.put_bucket_tagging(:bucket_name => bucket.name, :tags => tags)
+        end
+        nil
+      end
+
+      # Removes all tags from the bucket.
+      #
+      # @example
+      #
+      #   bucket.tags.clear
+      #   bucket.tags.to_h #=> {}
+      #
+      # @return [nil]
+      def clear
+        client.delete_bucket_tagging(:bucket_name => bucket.name)
+        nil
+      end
+
+      # @return [Hash]
+      def to_h
+        client.get_bucket_tagging(:bucket_name => bucket.name).data[:tags]
+      rescue MSS::S3::Errors::NoSuchTagSet
+        {}
+      end
+      alias_method :to_hash, :to_h
+
+      # @param [Hash] other
+      # @return [Boolean] Returns `true` if the tags for this bucket match
+      #   the passed hash.
+      def eql? other
+        self.to_h == other
+      end
+      alias_method :==, :eql?
+
+      # @api private
+      def inspect
+        self.to_h.inspect
+      end
+
+    end
+  end
+end

data/lib/mss/s3/bucket_version_collection.rb

@@ -0,0 +1,78 @@
+# 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
+
+    # A collection of versioned objects for the entire bucket.
+    #
+    # @see PrefixedCollection
+    class BucketVersionCollection
+
+      include PrefixAndDelimiterCollection
+
+      # @param [Bucket] bucket
+      def initialize bucket, options = {}
+        @bucket = bucket
+        super
+      end
+
+      # @return [Bucket] The bucket this collection belongs to.
+      attr_reader :bucket
+
+      # @return [ObjectVersion] Returns the most recently created object
+      #   version in the entire bucket.
+      def latest
+        first
+        #self.find{|version| true }
+      end
+
+      # Yields once for each version in the bucket.
+      #
+      # @yield [object_version]
+      #
+      # @yieldparam [ObjectVersion] object_version
+      #
+      # @return nil
+      #
+      def each options = {}, █ super; end
+
+      # @api private
+      protected
+      def each_member_in_page(page, &block)
+        super
+        page.versions.each do |version|
+          object_version = ObjectVersion.new(bucket.objects[version.key],
+                                             version.version_id, 
+                                             :delete_marker => version.delete_marker?, 
+                                             :last_modified => version.last_modified)
+          yield(object_version)
+        end
+      end
+
+      # @api private
+      protected
+      def list_request(options)
+        client.list_object_versions(options)
+      end
+
+      # @api private
+      protected
+      def limit_param; :max_keys; end
+
+      # @api private
+      protected
+      def pagination_markers; super + [:version_id_marker]; end
+
+    end
+  end
+end

data/lib/mss/s3/cipher_io.rb

@@ -0,0 +1,119 @@
+# 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
+    class CipherIO
+
+      def initialize cipher, stream, stream_size = nil
+
+        @stream = stream
+        @stream_size = stream_size
+        @orig_cipher = cipher.clone
+
+        reset_cipher
+
+        # add a #rewind method if the original stream can be rewound
+        if @stream.respond_to?(:rewind)
+          Core::MetaUtils.extend_method(self, :rewind) do
+            reset_cipher
+            @stream.rewind
+          end
+        end
+
+        # add a #size method if the stream size is known
+        if stream_size
+          Core::MetaUtils.extend_method(self, :size) do
+            EncryptionUtils.get_encrypted_size(@stream_size)
+          end
+        end
+
+      end
+
+      # @return [String] Returns the requested number of bytes.  If no byte
+      #   amount is given, it will return the entire body of encrypted data
+      def read bytes = nil, output_buffer = nil
+        data = if bytes
+          (@eof) ? nil : read_chunk(bytes)
+        else
+          (@eof) ? ""  : read_all
+        end
+        output_buffer ? output_buffer.replace(data || '') : data
+      end
+
+      # @return [Boolean] Returns `true` when the entire stream has been read.
+      def eof?
+        @eof
+      end
+
+      private
+
+      attr_reader :cipher
+
+      # Sets the CipherIO in a reset state without having to know anything
+      #  about the cipher
+      def reset_cipher
+        @cipher = @orig_cipher.clone
+        @eof    = false
+        @final  = nil
+      end
+
+      # @return [String] Returns an encrytped chunk
+      def read_chunk bytes
+        unless @final
+          # If given a number of bytes, read it out and work out encryption
+          #  issues
+          chunk = @stream.read(bytes)
+
+          # If there is nothing, finish the encryption
+          if chunk and chunk.length > 0
+            handle_finish(bytes, cipher.update(chunk))
+          else
+            @eof = true
+            cipher.final
+          end
+          # Read as much as possible if not given a byte size
+        else
+          @eof = true
+          @final
+        end
+      end
+
+      # @return [String] Returns the entire encrypted data
+      def read_all
+        @eof = true
+        body = @stream.read()
+        data = (body and body.length > 0) ? cipher.update(body) : ""
+        data << cipher.final
+      end
+
+      # Figures out how much of the final block goes into the current chunk
+      #   and adds it.
+      # @return [String] Returns the encrypted chunk with possible padding.
+      def handle_finish(bytes, chunk)
+        free_space = bytes - chunk.size
+
+        if free_space > 0
+          @final = cipher.final
+          chunk << @final[0..free_space-1]
+          @final = @final[free_space..@final.size-1]
+          @eof   = true unless @final and @final.size > 0
+        end
+
+        chunk
+      end
+
+    end
+  end
+end

data/lib/mss/s3/client/xml.rb

@@ -0,0 +1,265 @@
+# 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
+    class Client < Core::Client
+
+      # @api private
+      module XML
+
+        BaseGrammar = Core::XML::Grammar.new({}, :inflect_rename => true)
+
+        ListBuckets = BaseGrammar.customize do
+          element "Buckets" do
+            list "Bucket"
+          end
+        end
+
+        GetBucketAcl = GetObjectAcl = BaseGrammar.customize do
+          element "AccessControlList" do
+            ignore
+            element "Grant" do
+              rename :grants
+              list
+              element "Grantee" do
+                element "ID" do
+                  rename :canonical_user_id
+                end
+              end
+              element "Permission" do
+                symbol_value
+              end
+            end
+          end
+        end
+
+        ListObjects = BaseGrammar.customize do
+
+          element("Name") { rename :bucket_name }
+          element("MaxKeys") { integer_value }
+          element("IsTruncated") { rename :truncated; boolean_value }
+          element("Delimiter") { force }
+
+          element("Contents") do
+            list
+            element("Owner") do
+              element("ID") { }
+              element("DisplayName") { }
+            end
+            element("Key") { }
+            element("Size") { }
+            element("StorageClass") { }
+            element("ETag") { rename :etag }
+
+            element("LastModified") { time_value }
+          end
+
+          element "CommonPrefixes" do
+            collect_values
+          end
+
+        end
+
+        GetBucketLogging = BaseGrammar.customize do
+          element("LoggingEnabled") do
+            element("TargetBucket") { }
+            element("TargetPrefix") { }
+            element("TargetGrants") do
+              list "Grant"
+              element("Grant") do
+                element("Grantee") do
+                  element("EmailAddress") { }
+                  element("ID") { }
+                  element("URI") { }
+                end
+                element("Permission") { }
+              end
+            end
+          end
+        end
+
+        GetBucketVersioning = BaseGrammar.customize do
+          default_value :status, :unversioned
+          element("Status") do
+            symbol_value
+          end
+        end
+
+        ListObjectVersions = BaseGrammar.customize do
+
+          element("MaxKeys") { integer_value }
+          element("IsTruncated") { rename :truncated; boolean_value }
+          element("NextKeyMarker") { force }
+          element("NextVersionIdMarker") { force }
+
+          %w(DeleteMarker Version).each do |element_name|
+            element(element_name) do
+              collect_values
+              rename(:versions)
+              element("IsLatest") { rename :latest; boolean_value }
+              element("LastModified") { datetime_value }
+              element("ETag") { rename :etag }
+              element("Size") { integer_value }
+              element("StorageClass") { symbol_value }
+            end
+          end
+
+          element "DeleteMarker" do
+            default_value(:delete_marker, true)
+            default_value(:version, false)
+          end
+
+          element "Version" do
+            default_value(:delete_marker, false)
+            default_value(:version, true)
+          end
+
+          element "CommonPrefixes" do
+            collect_values
+          end
+
+        end
+
+        InitiateMultipartUpload = BaseGrammar.customize do
+          element("UploadId") { force }
+        end
+
+        ListMultipartUploads = BaseGrammar.customize do
+
+          element("IsTruncated") { rename :truncated; boolean_value }
+          element("MaxUploads") { integer_value }
+          element("NextKeyMarker") { force }
+          element("NextUploadIdMarker") { force }
+          element("Upload") do
+            collect_values
+            rename :uploads
+            element("StorageClass") { symbol_value }
+            element("Initiated") { datetime_value }
+          end
+
+          element "CommonPrefixes" do
+            collect_values
+          end
+
+        end
+
+        DeleteObjects = BaseGrammar.customize do
+          element("Deleted") do
+            element("DeleteMarker") { boolean_value }
+            list
+          end
+          element("Error") { list; rename(:errors) }
+        end
+
+        CompleteMultipartUpload = BaseGrammar.customize
+
+        ListParts = BaseGrammar.customize do
+          element("StorageClass") { symbol_value }
+          element("IsTruncated") { rename :truncated; boolean_value }
+          element("MaxParts") { integer_value }
+          element("PartNumberMarker") { integer_value }
+          element("NextPartNumberMarker") { integer_value }
+          element("Part") do
+            collect_values
+            rename :parts
+            element("PartNumber") { integer_value }
+            element("LastModified") { datetime_value }
+            element("Size") { integer_value }
+          end
+        end
+
+        GetBucketLifecycleConfiguration = BaseGrammar.customize do
+          element("Rule") do
+            list
+            rename(:rules)
+            element("Expiration") do
+              element("Days") { integer_value }
+              element("Date") { datetime_value }
+            end
+            element("Transition") do
+              element("StorageClass") { }
+              element("Days") { integer_value }
+              element("Date") { datetime_value }
+            end
+            element("NoncurrentVersionTransition") do
+              element("NoncurrentDays") { integer_value }
+              element("StorageClass") { string_value }
+            end
+            element("NoncurrentVersionDays") do
+              element("NoncurrentDays") { integer_value }
+            end
+          end
+        end
+
+        GetBucketCors = BaseGrammar.customize do
+          element "CORSRule" do
+            list
+            rename :rules
+            element "AllowedMethod" do
+              list
+              rename :allowed_methods
+            end
+            element "AllowedOrigin" do
+              list
+              rename :allowed_origins
+            end
+            element "AllowedHeader" do
+              list
+              rename :allowed_headers
+            end
+            element "MaxAgeSeconds" do
+              integer
+            end
+            element "ExposeHeader" do
+              list
+              rename :expose_headers
+            end
+          end
+        end
+
+        GetBucketTagging = BaseGrammar.customize do
+          element "TagSet" do
+            ignore
+            element "Tag" do
+              map_entry("Key", "Value")
+              rename :tags
+            end
+          end
+        end
+
+        GetBucketWebsite = BaseGrammar.customize do
+          element "IndexDocument" do
+            element "Suffix"
+          end
+          element "ErrorDocument" do
+            element "Key"
+          end
+          element "RoutingRules" do
+            list("RoutingRule")
+          end
+        end
+
+        CopyPart = BaseGrammar.customize do
+          element "ETag" do
+            rename :etag
+          end
+          element "LastModified" do
+            datetime_value
+            rename :last_modified
+          end
+        end
+
+      end
+    end
+  end
+end