right_aws_api 0.1.0

data/lib/cloud/aws/route53/routines/request_signer.rb

@@ -0,0 +1,70 @@
+#--
+# Copyright (c) 2013 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+module RightScale
+  module CloudApi
+    module AWS
+      module Route53
+        
+        # Route 53 request signer
+        class RequestSigner < CloudApi::Routine
+
+          # Route53 RequestSigner Error
+          class Error < CloudApi::Error
+          end
+
+          # Authenticates a Route53 request
+          #
+          # @return [void]
+          #
+          # @example
+          #  # no example
+          #
+          def process
+            # Fix body
+            unless @data[:request][:body]._blank?
+              # Make sure 'content-type' is set if we have a body
+              @data[:request][:headers].set_if_blank('content-type', 'application/xml' )
+              # Fix body if it is a Hash instance
+              if @data[:request][:body].is_a?(Hash)
+                @data[:request][:body] = Utils::contentify_body(@data[:request][:body], @data[:request][:headers]['content-type'])
+              end
+              # Calculate 'content-md5' when possible (some API calls wanna have it set)
+              if @data[:request][:body].is_a?(String)
+                @data[:request][:headers]['content-md5'] = Base64::encode64(Digest::MD5::digest(@data[:request][:body])).strip
+              end
+            end
+            # Set date
+            @data[:request][:headers].set_if_blank('date', Time::now.utc.httpdate)
+            # Sign a request
+            signature = Utils::AWS::sign(@data[:credentials][:aws_secret_access_key], Utils::dearrayify(@data[:request][:headers]['date']))
+            @data[:request][:headers]['x-amzn-authorization'] = "AWS3-HTTPS AWSAccessKeyId=#{@data[:credentials][:aws_access_key_id]},Algorithm=HmacSHA1,Signature=#{signature}"
+            # Set path
+            @data[:request][:path] = Utils::join_urn(@data[:connection][:uri].path, @data[:options][:api_version], @data[:request][:relative_path], @data[:request][:params])
+          end
+          
+        end
+      end
+    end
+  end
+end

data/lib/cloud/aws/route53/wrappers/default.rb

@@ -0,0 +1,132 @@
+#--
+# Copyright (c) 2013 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+module RightScale
+  module CloudApi
+    module AWS
+      module Route53
+
+        # Route 53 wrapper namespace
+        module Wrapper
+
+          # Default wrapper
+          module DEFAULT
+            
+            # Defines QUERY API like methods for the service
+            #
+            # @return [void]
+            #
+            # @example
+            #  # no example
+            #
+            def self.extended(base)
+
+              #-----------------
+              # Hosted Zones
+              #-----------------
+              
+              
+              base.query_api_pattern 'ListHostedZones', :get, 'hostedzone'
+
+              
+              base.query_api_pattern 'GetHostedZone', :get, 'hostedzone/{:HostedZoneId}'
+
+
+              base.query_api_pattern 'CreateHostedZones', :post, 'hostedzone',
+                :body => {
+                  'CreateHostedZoneRequest' => {
+                    'Name'             => :Name,
+                    'CallerReference'  => :CallerReference,
+                    'HostedZoneConfig{!remove-if-blank}' => {
+                      'Comment' => :Comment
+                    }
+                  }
+                },
+                :defaults => {
+                  :Comment => Utils::NONE
+                }
+              
+              
+              base.query_api_pattern 'DeleteHostedZone', :delete, 'hostedzone/{:HostedZoneId}'
+              
+
+              #----------------------
+              # Resource Record Sets
+              #----------------------
+
+              
+              base.query_api_pattern 'ListResourceRecordSets', :get, 'hostedzone/{:HostedZoneId}/rrset'
+              
+
+              base.query_api_pattern 'GetChange', :get, 'change/{:ChangeId}'
+              
+              
+              base.query_api_pattern 'ChangeResourceRecordSets', :post, 'hostedzone/{:HostedZoneId}/rrset',
+                :body => {
+                  'ChangeResourceRecordSetsRequest' => {
+                    '@xmlns'      => 'https://route53.amazonaws.com/doc/2011-05-05/',
+                    'ChangeBatch' => {
+                      'Comment' => :Comment,
+                      'Changes' => {
+                        'Change[{:Change}]' => {
+                          'Action'            => :Action,
+                          'ResourceRecordSet' => {
+                            'Name' => :Name,
+                            'Type' => :Type,
+                            'AliasTarget{!remove-if-blank}' => {
+                              'HostedZoneId' => :HostedZoneId,
+                              'DNSName'      => :DNSName
+                            },
+                            'SetIdentifier' => :SetIdentifier,
+                            'Weight'        => :Weight,
+                            'TTL'           => :TTL,
+                            'ResourceRecords{!remove-if-blank}' => {
+                              'ResourceRecord{!remove-if-blank}' => {
+                                'Value' => :ResourceRecord
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                },
+                :defaults => {
+                  :Comment        => Utils::NONE,
+                  :TTL            => Utils::NONE,
+                  :DNSName        => Utils::NONE,
+                  :HostedZoneId   => Utils::NONE,
+                  :SetIdentifier  => Utils::NONE,
+                  :Weight         => Utils::NONE,
+                  :ResourceRecord => Utils::NONE
+                }
+              
+              
+            end
+            
+          end          
+        end
+      end
+    end
+  end
+end

data/lib/cloud/aws/s3/manager.rb

@@ -0,0 +1,373 @@
+#--
+# Copyright (c) 2013 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require "cloud/aws/base/helpers/utils"
+require "cloud/aws/s3/parsers/response_error"
+require "cloud/aws/s3/wrappers/default"
+require "cloud/aws/s3/routines/request_signer"
+
+module RightScale
+  module CloudApi
+    module AWS
+
+      # Simple Storage Service namespace
+      #
+      # @api public
+      #
+      module S3
+
+        # Amazon Simple Storage Service (S3) compatible manager (thread safe).
+        #
+        # @example
+        #  require "right_aws_api"
+        #
+        #  s3 = RightScale::CloudApi::AWS::S3::Manager.new(key, secret, 'https://s3.amazonaws.com')
+        #
+        # @example
+        #  # -- Using HTTP verb methods --
+        #  
+        #  # List all buckets
+        #  s3.get
+        #
+        #  # List bucket objects
+        #  s3.get('devs-us-east')
+        #
+        #  # Get bucket ACL
+        #  s3.get('devs-us-east', :params => {'acl' => nil} )
+        #
+        #  # Put bucket ACL
+        #  s3.put('devs-us-east',
+        #         :params  => {'acl' => nil},
+        #         :body    => access_control_policy_xml,
+        #         :headers => { 'content-type' => 'application/xml' }
+        #  )
+        #
+        #  # Get bucket Versions
+        #  s3.get('devs-us-east', :params => {'version' => nil} )
+        #
+        #  # Get object
+        #  s3.get('devs-us-east/boot1.jpg')
+        #  # Do not parse response if Amazon reports back XML or JSON content-type
+        #  s3.get('devs-us-east/boot1.xml', :options => { :raw_response => true})
+        #
+        #  # Get object, force set content-type
+        #  s3.get('kd-kd-kd-1/boot1.jpg', :params => { 'response-content-type' => 'image/jpeg'})
+        #
+        #  # Put object
+        #  # Do not forget to provide a proper 'content-type' header because the default
+        #  # one is set to 'application/octet-stream'
+        #  s3.put('devs-us-east/boot1.jpg',
+        #          :body    => 'This is my object DATA. WooHoo!!!',
+        #          :headers => {'content-type' => 'text/plain'})
+        #
+        #
+        # @example
+        #   # A simple example of a multi-thread file download:
+        #   threads    = []
+        #   file_size  = 3257230
+        #   chunks     = 3
+        #   chunk_size = file_size / chunks
+        #   chunks.times do |i|
+        #     from_byte = i * chunk_size
+        #     to_byte   = from_byte + chunk_size - 1
+        #     to_byte  += file_size % chunks if i + 1 == chunks
+        #     threads << Thread::new {
+        #       Thread.current[:my_file] = s3.get('devs-us-east/xxx/boot.jpg', {:headers => {'Range' => "bytes=#{from_byte}-#{to_byte}"}})
+        #     }
+        #   end
+        #   file_body = ''
+        #   threads.each do |thread|
+        #     thread.join
+        #     file_body << thread[:my_file]
+        #   end
+        #   file_body.size #=> 3257230
+        #
+        #
+        # @example
+        #   # Download into IO object
+        #   File.open('/tmp/boot.jpg','w') do |file|
+        #     s3.get('devs-us-east/kd/boot.jpg') do |chunk|
+        #       file.write(chunk)
+        #     end
+        #   end
+        #
+        #
+        # @example
+        #  # -- Using helper methods --
+        #
+        #  # List all buckets
+        #  s3.ListAllMyBuckets
+        #
+        #  # List bucket objects
+        #  s3.ListObjects('Bucket' => 'devs-us-east')
+        #
+        #  # Get bucket ACL
+        #  s3.GetBucketAcl('Bucket' => 'devs-us-east')
+        #
+        #  # Get bucket Versions
+        #  s3.GetBucketVersions('Bucket' => 'devs-us-east')
+        #
+        #  # Get object
+        #  s3.GetObject('Bucket' => 'devs-us-east', 'Object' => 'boot1.jpg')
+        #
+        #  # Get object, force set content-type
+        #  s3.GetObject('Bucket' => 'devs-us-east', 'Object' => 'boot1.jpg',
+        #               :params => { 'response-content-type' => 'image/jpeg'})
+        #
+        #  # Put object
+        #  # P.S. 'content-type' is 'application/octet-stream' by default
+        #  s3.PutObject('Bucket' => 'devs-us-east',
+        #               'Object' => 'boot1.jpg',
+        #               :body    => file_content,
+        #               :headers => {'content-type' => 'image/jpeg'})
+        #
+        # @example
+        #  
+        #  # List all buckets
+        #  s3.ListAllMyBuckets #=>
+        #    {"ListAllMyBucketsResult"=>
+        #      {"Buckets"=>
+        #        {"Bucket"=>
+        #          [{"Name"=>"CI_right_test",
+        #            "CreationDate"=>"2011-05-25T20:46:28.000Z"},
+        #           {"Name"=>"CR_right_test",
+        #            "CreationDate"=>"2011-06-08T20:46:32.000Z"},
+        #           {"Name"=>"DarrylTest", 
+        #            "CreationDate"=>"2011-06-03T03:43:08.000Z"},
+        #           {"Name"=>"RightScalePeter", 
+        #            "CreationDate"=>"2008-10-28T03:59:20.000Z"}]},
+        #       "Owner"=>
+        #        {"DisplayName"=>"fghsfg",
+        #         "ID"=>"16144ab2929314cc309ffe736daa2b264357476c7fea6efb2c3347ac3ab2792a"},
+        #       "@xmlns"=>"http://s3.amazonaws.com/doc/2006-03-01/"}}
+        #
+        #  # List bucket objects
+        #  s3.ListObjects('Bucket' => 'devs-us-east', 'max-keys' => 3, 'prefix' => 'kd') #=>
+        #    {"ListBucketResult"=>
+        #      {"MaxKeys"=>"3",
+        #       "IsTruncated"=>"false",
+        #       "Name"=>"devs-us-east",
+        #       "Marker"=>nil,
+        #       "Contents"=>
+        #        {"LastModified"=>"2010-08-26T12:23:30.000Z",
+        #         "StorageClass"=>"STANDARD",
+        #         "ETag"=>"\"3c9a2717e34efedb6d6ac007b2acb8df\"",
+        #         "Owner"=>
+        #          {"DisplayName"=>"thve",
+        #           "ID"=>
+        #            "16144ab2929314cc309ffe736daa2b264357476c7fea6efb2c3347ac3ab2792a"},
+        #         "Size"=>"3257230",
+        #         "Key"=>"kd/boot.jpg"},
+        #       "@xmlns"=>"http://s3.amazonaws.com/doc/2006-03-01/",
+        #       "Prefix"=>"kd"}}        
+        #
+        #
+        # @example
+        #  # Get
+        #  s3.GetBucketCors('Bucket' => 'my-bucket' ) #=>
+        #    {"CORSConfiguration"=>
+        #        {"@xmlns"=>"http://s3.amazonaws.com/doc/2006-03-01/",
+        #        "CORSRule"=>
+        #          [{"AllowedOrigin"=>"http://www.example.com",
+        #            "AllowedMethod"=>["PUT", "POST"],
+        #            "MaxAgeSeconds"=>"2000",
+        #            "ExposeHeader"=>"x-amz-server-side-encryption"},
+        #          {"AllowedOrigin"=>"*", "AllowedMethod"=>"GET", "MaxAgeSeconds"=>"2001"}]}}
+        #
+        #
+        # @example
+        #  # Put
+        #  cors_rules = [
+        #    {'AllowedOrigin' => 'http://www.example.com',
+        #     'AllowedMethod' => ['PUT', 'POST'],
+        #     'MaxAgeSeconds' => 3000,
+        #     'ExposeHeader'  => 'x-amz-server-side-encryption' },
+        #    {'AllowedOrigin' => '*',
+        #     'AllowedMethod' => 'GET',
+        #     'MaxAgeSeconds' => 3000 } ]
+        #  s3.PutBucketCors('Bucket' => 'kd-ver-test', 'CORSRule' => cors_rules ) #=> ''
+        #
+        #  # .. or
+        #  body = "<CORSConfiguration><CORSRule><AllowedOrigin>http://www.example.com</AllowedOrigin>"+
+        #         "<AllowedMethod>PUT</AllowedMethod><AllowedMethod>POST</AllowedMethod>"+
+        #         "<MaxAgeSeconds>3000</MaxAgeSeconds>..</CORSConfiguration>"
+        #  s3.PutBucketCors('Bucket' => 'my-bucket', :body => body ) #=> ''
+        #
+        #
+        # @example
+        #  # Delete
+        #  s3.DeleteBucketCors('Bucket' => 'my-bucket' ) #=> ''
+        #
+        #
+        # @example
+        #  # Bucket Tagging
+        #  # Get
+        #  s3.GetBucketTagging('Bucket' => 'my-bucket' ) #=>
+        #    {"Tagging"=> {
+        #       "TagSet"=> {
+        #          "Tag"=>[
+        #            {"Key"=>"Project",
+        #              "Value"=>"Project One"},
+        #             {"Key"=>"User",
+        #              "Value"=>"jsmith"}]}}}
+        #
+        #
+        # @example
+        #  # Delete
+        #  s3.DeleteBucketTagging('Bucket' => 'my-bucket' ) #=> ''
+        #
+        #
+        # @example
+        #  # Put
+        #  tagging_rules = [
+        #    {"Key"=>"Project",
+        #     "Value"=>"Project One"},
+        #    {"Key"=>"User",
+        #     "Value"=>"jsmith"} ]
+        #  s3.PutBucketTagging('Bucket' => 'my-bucket', 'TagSet' => tagging_rules ) #=> ''
+        #
+        #
+        # @example
+        #  # Bucket Lifecycle
+        #  # Get
+        #  s3.GetBucketLifecycle('Bucket' => 'my-bucket' ) #=>
+        #    {"LifecycleConfiguration"=> {
+        #       "Rule"=>[{
+        #         "ID" => "30-day-log-deletion-rule",
+        #         "Prefix" => "logs",
+        #         "Status" => "Enabled",
+        #         "Expiration" => { "Days" => 30 }}]}}
+        #
+        #
+        # @example
+        #  # Delete
+        #  s3.DeleteBucketLifecycle('Bucket' => 'my-bucket' ) #=> ''
+        #
+        #
+        # @example
+        #  # Put
+        #  lifecycle_rules = [
+        #    { "ID"         => "30-day-log-deletion-rule",
+        #      "Prefix"     => "logs",
+        #      "Status"     => "Enabled",
+        #      "Expiration" => {"Days" => 30}},
+        #    {"ID"          => "delete-documents-rule",
+        #      "Prefix"     => "documents",
+        #      "Status"     => "Enabled",
+        #      "Expiration" => { "Days" => 365 }}]
+        #  s3.PutBucketLifecycle('Bucket' => 'my-bucket', 'Rule' => lifecycle_rules ) #=> ''
+        #
+        #
+        # @example
+        #  # Get a link to ListAllMyBuckets action
+        #  s3.ListAllMyBuckets(:options=>{:cloud=>{:link=>true}}) #=> 
+        #    {"verb"   => "get",
+        #     "link"   => "https://s3.amazonaws.com/?AWSAccessKeyId=0K4QH...G2&Expires=1426111071&Signature=vLMH...3D",
+        #     "headers"=> {"host"=>["s3.amazonaws.com"]}}
+        #
+        #  # If you need to get a bunch of links you can use with_options helper method:
+        #  opts = {:headers => {'expires' => Time.now + 3600}}
+        #  s3.with_options(:cloud=>{:link => true}) do
+        #    pp s3.GetObject({'Bucket'=>'my-bucket', 'Object'=>'kd/kd0.test', 'versionId'=>"00eYZeb291o4"}, opts)
+        #    pp s3.GetObject({'Bucket'=>'my-bucket', 'Object'=>'kd/kd1.test', 'versionId'=>"fafaf1obp1W4"}, opts)
+        #    pp s3.GetObject({'Bucket'=>'my-bucket', 'Object'=>'kd/kd2.test', 'versionId'=>"00asdTebp1W4"}, opts)
+        #    pp s3.GetObject({'Bucket'=>'my-bucket', 'Object'=>'kd/kd3.test', 'versionId'=>"0lkjreobp1W4"}, opts)
+        #  end
+        #
+        #
+        # @see ApiManager
+        # @see Wrapper::DEFAULT.extended Wrapper::DEFAULT.extended (click [View source])
+        # @see http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html
+        #
+        class Manager < CloudApi::Manager
+        end
+
+
+        # Amazon Simple Storage Service (S3) compatible manager (thread unsafe).
+        #
+        # @see Manager
+        #
+        class  ApiManager < CloudApi::ApiManager
+
+          # S3 Error
+          class Error < CloudApi::Error
+          end
+
+          include Mixin::QueryApiPatterns
+
+          set_routine CloudApi::RetryManager
+          set_routine CloudApi::RequestInitializer
+          set_routine AWS::S3::RequestSigner
+          set_routine CloudApi::RequestGenerator
+          set_routine CloudApi::ConnectionProxy
+          set_routine CloudApi::ResponseAnalyzer
+          set_routine CloudApi::ResponseParser
+          set_routine CloudApi::ResultWrapper
+
+          set :response_error_parser => Parser::AWS::S3::ResponseError
+
+
+          # Constructor
+          #
+          # @param [String] aws_access_key_id
+          # @param [String] aws_secret_access_key
+          # @param [String] endpoint
+          # @param [Hash]   options
+          #
+          # @example
+          #   # see Manager class
+          #
+          # @see Manager
+          #
+          def initialize(aws_access_key_id, aws_secret_access_key, endpoint, options={})
+            credentials = { :aws_access_key_id     => aws_access_key_id,
+                            :aws_secret_access_key => aws_secret_access_key }
+            super(credentials, endpoint, options)
+          end
+
+
+          # Makes an API call to AWS::S3 compatible cloud
+          #
+          # @param [String,Symbol] verb  'get' | 'put' | etc
+          # @param [Objects] args
+          #
+          # @return [Object]
+          #
+          # @example
+          #   api(verb,                  opts={})
+          #   api(verb, 'bucket',        opts={})
+          #   # Where opts may have next keys: :options, :headers, :params, :body
+          #   api(verb, 'bucket/object', opts={})
+          #
+          def api(verb, *args, &block)
+            relative_path = args.first.is_a?(String) ? args.shift : ''
+            opts          = args.shift || {}
+            raise Error::new("Opts must be Hash not #{opts.class.name}") unless opts.is_a?(Hash)
+            process_api_request(verb, relative_path, opts, &block)
+          end
+          
+        end
+      end
+    end
+  end
+end