mss-sdk 1.0.0

data/lib/mss/core/async_handle.rb

@@ -0,0 +1,89 @@
+# 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
+  module Core
+
+    # Mixin that provides a generic callback facility for asynchronous
+    # tasks that can either succeed or fail.
+    module AsyncHandle
+
+      # Called to signal success and fire off the success and complete callbacks.
+      def signal_success
+        __send_signal(:success)
+      end
+
+      # Called to signal failure and fire off the failure and complete callbacks.
+      def signal_failure
+        __send_signal(:failure)
+      end
+
+      # Registers a callback to be called on successful completion of
+      # the task.
+      #
+      #     handle.on_success { puts "It worked!" }
+      #
+      # If this is called when the task has already completed
+      # successfully, it will call the callback immediately.
+      def on_success(&block)
+        if @_async_status == :success
+          block.call
+        else
+          (@_async_callbacks ||= []) << { :success => block }
+        end
+      end
+
+      # Registers a callback to be called when the task fails.
+      #
+      #     handle.on_failure { puts "It didn't work!" }
+      #
+      # If this is called when the task has already failed, it will
+      # call the callback immediately.
+      def on_failure(&block)
+        if @_async_status == :failure
+          block.call
+        else
+          (@_async_callbacks ||= []) << { :failure => block }
+        end
+      end
+
+      # Registers a callback to be called when the task is complete,
+      # regardless of its status.  Yields the status to the block.
+      #
+      #     handle.on_complete do |status|
+      #       puts "It #{status == :success ? 'did' : 'did not'} work!"
+      #     end
+      #
+      # If this is called when the task has already completed, it will
+      # call the callback immediately.
+      def on_complete(&block)
+        if !@_async_status.nil?
+          block.call(@_async_status)
+        else
+          (@_async_callbacks ||= []) << {
+            :failure => lambda { block.call(:failure) },
+            :success => lambda { block.call(:success) }
+          }
+        end
+      end
+
+      private
+      def __send_signal(kind)
+        @_async_status = kind
+        @_async_callbacks.map do |cb|
+          cb[kind]
+        end.compact.each {|block| block.call } if @_async_callbacks
+      end
+
+    end
+  end
+end

data/lib/mss/core/cacheable.rb

@@ -0,0 +1,76 @@
+# 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
+  module Core
+
+    # @api private
+    module Cacheable
+
+      # @api private
+      class NoData < StandardError; end
+
+      def self.included base
+        base.extend Naming unless base.respond_to?(:service_ruby_name)
+      end
+
+      # @api private
+      protected
+      def local_cache_key
+        raise NotImplementedError
+      end
+
+      # @api private
+      protected
+      def cache_key
+        @cache_key ||= begin
+          config.credential_provider.access_key_id + ":" +
+            config.region + ":" +
+            self.class.name + ":" +
+            local_cache_key
+        end
+      end
+
+      # @api private
+      public
+      def retrieve_attribute attr, &block
+
+        if cache = MSS.response_cache
+
+          if cache.resource_cache.cached?(cache_key, attr.name)
+            return cache.resource_cache.get(cache_key, attr.name)
+          end
+
+          cache.select(*attr.request_types).each do |response|
+            if attributes = attributes_from_response(response)
+              cache.resource_cache.store(cache_key, attributes)
+              return attributes[attr.name] if attributes.key?(attr.name)
+            end
+          end
+
+        end
+
+        response = yield
+
+        if attributes = attributes_from_response(response)
+          if cache = MSS.response_cache
+            cache.resource_cache.store(cache_key, attributes)
+          end
+          attributes[attr.name] if attributes.key?(attr.name)
+        else
+          raise NoData.new("no data in #{response.request_type} response")
+        end
+      end
+
+    end
+  end
+end