aws-sdk-v1 1.52.0

data/lib/aws/glacier/archive_collection.rb

@@ -0,0 +1,146 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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.
+
+require 'openssl'
+
+module AWS
+  class Glacier
+
+    class ArchiveCollection
+
+      include Core::Model
+
+      # @param [Vault] vault
+      # @param [Hash] options
+      # @option options [String] :account_id
+      def initialize vault, options = {}
+        @vault = vault
+        @account_id = options[:account_id] || '-'
+        super
+      end
+
+      # @return [Vault]
+      attr_reader :vault
+
+      # @return [String]
+      attr_reader :account_id
+
+      # Creates an archive by uploading a file to a vault.
+      # @param [File,Pathname,IO,String] data The data to upload.
+      #   If `data` is a string, this is treated as a path to a file
+      #   on disk.
+      # @param [Hash] options
+      # @option options [String] description
+      # @return [Archive]
+      def create data, options = {}
+
+        data = convert_to_io(data)
+
+        hash, tree_hash = compute_checksums(data)
+
+        upload_options = {}
+        upload_options[:vault_name] = vault.name
+        upload_options[:account_id] = account_id
+        upload_options[:body] = data
+        upload_options[:checksum] = tree_hash
+        upload_options[:content_sha256] = hash
+        upload_options[:archive_description] = options[:description] if
+          options[:description]
+
+        resp = client.upload_archive(upload_options)
+
+        self[resp[:archive_id]]
+
+      end
+
+      # @param [String] archive_id
+      # @return [Archive]
+      def [] archive_id
+        Archive.new(vault, archive_id, :config => config, :account_id => account_id)
+      end
+
+      protected
+
+      def convert_to_io data
+        return Core::ManagedFile.open(data) if
+          data.is_a?(Pathname) or data.is_a?(String)
+
+        return data if io_like?(data)
+
+        msg = "expected data to be IO-like or a file path (String/Pathanme)."
+        raise ArgumentError, msg
+      end
+
+      # @return [Boolean] Returns `tue` if data acts like a file.
+      def io_like? data
+        data.respond_to?(:read) and
+        data.respond_to?(:eof?) and
+        data.respond_to?(:rewind) and
+        data.respond_to?(:size)
+      end
+
+      # Computes two checksums in a single pass of the data:
+      # * a hash of the entire payload
+      # * a tree hash of the entire payload
+      #
+      # The tree hash is required by the streaming operations,
+      # the simple hash is required for generating the signature
+      # (via sigv4).
+      #
+      # The sigv4 module will compute the hash of the payload for us,
+      # but that requires reading the data a 2nd time. :(
+      def compute_checksums data
+
+        digest = OpenSSL::Digest.new('sha256')
+        tree_digest = OpenSSL::Digest.new('sha256')
+        tree_parts = []
+
+        until data.eof?
+
+          chunk = data.read(1024 * 1024) # read 1MB
+          tree_parts << tree_digest.update(chunk).digest
+          tree_digest.reset
+
+          digest.update(chunk)
+
+        end
+
+        data.rewind
+
+        [digest.to_s, compute_tree_hash(tree_parts)]
+
+      end
+
+      def compute_tree_hash hashes
+
+        digest = OpenSSL::Digest.new('sha256')
+
+        until hashes.count == 1
+          hashes = hashes.each_slice(2).map do |h1,h2|
+            digest.reset
+            if h2
+              digest.update(h1)
+              digest.update(h2)
+              digest.digest
+            else
+              h1
+            end
+          end
+        end
+
+        hashes.first.bytes.map{|x| x.to_i.to_s(16).rjust(2,'0')}.join('')
+      end
+
+    end
+  end
+end

data/lib/aws/glacier/client.rb

@@ -0,0 +1,49 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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 AWS
+  class Glacier
+
+    # All operations with Amazon Glacier require your AWS account ID.
+    # You can specify the special value of '-' to specify your
+    # AWS account ID.
+    #
+    #   glacier = AWS::Glacier.new
+    #   resp = glacier.client.list_vaults(:account_id => '-')
+    #
+    class Client < Core::RESTJSONClient
+
+      API_VERSION = '2012-06-01'
+
+      signature_version :Version4, 'glacier'
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[]
+
+      private
+
+      def build_request *args
+        request = super(*args)
+        request.headers['x-amz-glacier-version'] = self.class.const_get(:API_VERSION)
+        request
+      end
+
+    end
+
+    class Client::V20120601 < Client
+
+      define_client_methods('2012-06-01')
+
+    end
+  end
+end

data/lib/aws/glacier/config.rb

@@ -0,0 +1,19 @@
+
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'Glacier', 'glacier', 'glacier'
+
+end

data/lib/aws/glacier/errors.rb

@@ -0,0 +1,22 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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 AWS
+  class Glacier
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/glacier/resource.rb

@@ -0,0 +1,30 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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 AWS
+  class Glacier
+    class Resource < Core::Resource
+
+      # @api private
+      def initialize *args
+        options = args.last.is_a?(Hash) ? args.last : {}
+        @account_id = options[:account_id] || '-'
+        super
+      end
+
+      # @return [String] :account_id
+      attr_reader :account_id
+
+    end
+  end
+end

data/lib/aws/glacier/vault.rb

@@ -0,0 +1,145 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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 AWS
+  class Glacier
+
+    #
+    # @attr_reader [String] arn
+    #
+    # @attr_reader [Integer] size_in_bytes
+    #
+    # @attr_reader [Integer] number_of_archives
+    #
+    # @attr_reader [Time] creation_date
+    #
+    # @attr_reader [Time] last_inventory_date
+    #
+    class Vault < Resource
+
+      # @param [String] name
+      # @param [Hash] options
+      # @option options [String] :account_id
+      def initialize name, options = {}
+        @name = name
+        super
+      end
+
+      # @return [String]
+      attr_reader :name
+
+      attribute :arn, :from => :vault_arn, :static => true
+
+      attribute :size_in_bytes
+
+      attribute :number_of_archives
+
+      attribute :creation_date, :static => true
+
+      attribute :last_inventory_date
+
+      populates_from(:list_vaults) do |resp|
+        resp.request_options[:account_id] == account_id and
+        resp[:vault_list].find {|vault| vault[:vault_name] == name }
+      end
+
+      populates_from(:describe_vault) do |resp|
+        if resp.request_options[:account_id] == account_id and resp[:vault_name] == name
+          resp
+        end
+      end
+
+      # @return [Boolean] Returns `true` if the vault exists.
+      def exists?
+        client.describe_vault(:vault_name => name, :account_id => account_id)
+        true
+      rescue Errors::ResourceNotFoundException
+        false
+      end
+
+      # @return [ArchiveCollection]
+      def archives
+        ArchiveCollection.new(self, :account_id => account_id)
+      end
+
+      # @param [String,SNS::Topic] topic The SNS topic ARN string or an
+      #   SNS::Topic object to send event notifications to.
+      # @param [Array<String>] events An array of one or more events for
+      #   which you want Amazon Glacier to send notifications.
+      #   Valid values include:
+      #   * 'ArchiveRetrievalCompleted'
+      #   * 'InventoryRetrievalCompleted'
+      # @return [VaultNotificationConfiguration]
+      def configure_notifications topic, events
+
+        topic_arn = topic.is_a?(String) ? topic : topic.arn
+
+        cfg = VaultNotificationConfiguration.new
+        cfg.sns_topic = SNS::Topic.new(topic_arn, :config => config)
+        cfg.events = events
+        cfg
+
+        self.notification_configuration = cfg
+
+      end
+
+      # @return [VaultNotificationConfiguration,nil]
+      def notification_configuration
+        resp = client.get_vault_notifications(resource_options)
+        cfg = VaultNotificationConfiguration.new
+        cfg.sns_topic = SNS::Topic.new(resp[:sns_topic], :config => config)
+        cfg.events = resp[:events]
+        cfg
+      rescue Errors::ResourceNotFoundException
+        nil
+      end
+
+      # Sets the notification configuration for this vault.  If you pass
+      # a `nil` value, the notification configuration will be deleted
+      # @param [VaultNotificationConfiguration] cfg
+      def notification_configuration= cfg
+        if cfg
+          opts = {}
+          opts.merge!(resource_options)
+          opts[:vault_notification_config] = {}
+          opts[:vault_notification_config][:sns_topic] = cfg.sns_topic.arn
+          opts[:vault_notification_config][:events] = cfg.events
+          client.set_vault_notifications(opts)
+        else
+          client.delete_vault_notifications(resource_options)
+        end
+      end
+
+      # Deletes the current vault.  You can only delete an empty vault.
+      # @return [nil]
+      def delete
+        client.delete_vault(resource_options)
+        nil
+      end
+
+      protected
+
+      def get_resource attr = nil
+        client.describe_vault(resource_options)
+      end
+
+      def resource_identifiers
+        [
+          [:vault_name, name],
+          [:account_id, account_id],
+        ]
+      end
+
+    end
+  end
+end

data/lib/aws/glacier/vault_collection.rb

@@ -0,0 +1,75 @@
+# 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
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# 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 AWS
+  class Glacier
+
+    class VaultCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      # @param [Hash] options
+      # @option options [String] :account_id
+      def initialize options = {}
+        @account_id = options[:account_id] || '-'
+        super
+      end
+
+      # @return [String]
+      attr_reader :account_id
+
+      # @param [String] name
+      def create name
+
+        options = {}
+        options[:vault_name] = name
+        options[:account_id] = account_id
+        client.create_vault(options)
+
+        self[name]
+
+      end
+
+      # @param [String] name The name of the vault.
+      # @return [Vault] Returns a vault with the given name.
+      def [] name
+        Vault.new(name, :config => config, :account_id => account_id)
+      end
+
+      protected
+
+      def _each_item next_token, limit, options, &block
+
+        options[:limit] = limit if limit
+        options[:marker] = next_token if next_token
+        options[:account_id] = account_id
+
+        resp = client.list_vaults(options)
+        resp[:vault_list].each do |v|
+
+          vault = Vault.new_from(:list_vaults, v,
+            v[:vault_name],
+            :config => config,
+            :account_id => account_id)
+
+          yield(vault)
+
+        end
+
+        resp[:marker]
+
+      end
+
+    end
+  end
+end