simple_aws 0.0.1a → 0.0.1b

data/lib/aws/signing/version2.rb

@@ -0,0 +1,49 @@
+require 'uri'
+require 'openssl'
+
+module AWS
+  module Signing
+    ##
+    # Implementation of "Signature Version 2" signing
+    ##
+    module Version2
+
+      ##
+      # Build and sign the final request, as per the rules here:
+      # http://docs.amazonwebservices.com/AWSEC2/latest/UserGuide/index.html?using-query-api.html
+      ##
+      def finish_and_sign_request(request)
+        request.params.merge!({
+          "AWSAccessKeyId" => self.access_key,
+          "SignatureMethod" => "HmacSHA256",
+          "SignatureVersion" => "2",
+          "Timestamp" => Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
+          "Version" => self.version
+        })
+
+        request.params["Signature"] = Base64.encode64(sign_request(request)).chomp
+
+        request
+      end
+
+      def sign_request(request)
+        signing_params = request.params.clone
+
+        list = signing_params.map {|k, v| [k, Util.uri_escape(v.to_s)] }
+        list.sort! do |a, b|
+          if a[0] == "AWSAccessKeyId"
+            -1
+          else
+            a[0] <=> b[0]
+          end
+        end
+
+        plain_host = URI.parse(request.host).host
+
+        to_sign = "POST\n#{plain_host}\n#{request.path}\n#{list.map {|p| p.join("=") }.join("&")}"
+        OpenSSL::HMAC.digest("sha256", self.secret_key, to_sign)
+      end
+
+    end
+  end
+end

data/lib/aws/signing/version3.rb

@@ -0,0 +1,38 @@
+require 'openssl'
+
+module AWS
+  module Signing
+    ##
+    # Implementation of "Signature Version 3" signing, the X-Amzn-Authorization header
+    ##
+    module Version3
+
+      ##
+      # Build and sign the final request, as per the rules here:
+      # http://docs.amazonwebservices.com/ses/latest/DeveloperGuide/QueryInterface.Authentication.html
+      ##
+      def finish_and_sign_request(request)
+        timestamp = Time.now.utc
+        request.params.merge!({
+          "AWSAccessKeyId" => self.access_key,
+          "Timestamp" => timestamp.strftime("%Y-%m-%dT%H:%M:%SZ"),
+          "Version" => self.version
+        })
+
+        request.headers["Date"] = timestamp.httpdate
+
+        request.headers["X-Amzn-Authorization"] =
+          "AWS3-HTTPS AWSAccessKeyId=#{self.access_key}, " +
+          "Algorithm=HmacSHA256, " +
+          "Signature=#{Base64.encode64(build_signature_for(timestamp)).chomp}"
+
+        request
+      end
+
+      def build_signature_for(timestamp)
+        OpenSSL::HMAC.digest("sha256", self.secret_key, timestamp.httpdate)
+      end
+
+    end
+  end
+end

data/lib/aws/sns.rb

@@ -0,0 +1,25 @@
+require 'aws/api'
+require 'aws/call_types/action_param'
+require 'aws/signing/version2'
+
+module AWS
+
+  ##
+  # Amazon's Simple Notification Service
+  #
+  # http://docs.amazonwebservices.com/sns/latest/api/Welcome.html
+  #
+  # All requests are POST and always through HTTPS. Use the third parameter to
+  # #initialize if you need to talk to a region other than us-east-1.
+  ##
+  class SNS < API
+    endpoint "sns"
+    use_https true
+    version "2010-03-31"
+    default_region "us-east-1"
+
+    include CallTypes::ActionParam
+    include Signing::Version2
+  end
+
+end

data/lib/aws/sqs.rb

@@ -0,0 +1,56 @@
+require 'aws/api'
+require 'aws/call_types/action_param'
+require 'aws/signing/version2'
+
+module AWS
+
+  ##
+  # Amazon's Simple Queue Service
+  #
+  # http://docs.amazonwebservices.com/AWSSimpleQueueService/latest/APIReference/Welcome.html
+  #
+  # All requests are POST and always through HTTPS. Use the third parameter to
+  # #initialize if you need to talk to a region other than us-east-1.
+  #
+  # For the requests that act on a queue directly, like SendMessage, pass in the QueueURL
+  # as the first parameter to the call:
+  #
+  #   sqs.send_message queue_url, params
+  #
+  # In accordance with the AWS documentation, SimpleAWS does not try to reconstruct
+  # queue urls, use ListQueues or GetQueueUrl to get the correct queue url when needed.
+  ##
+  class SQS < API
+    endpoint "sqs"
+    use_https true
+    version "2011-10-01"
+    default_region "us-east-1"
+
+    include CallTypes::ActionParam
+    include Signing::Version2
+
+    # Special handling here, we need to look for a QueueURL as the first
+    # parameter and update the request URI accordingly
+    def method_missing(name, *args)
+      if args.first.is_a?(String)
+        request_uri = args.first
+        params = args.last
+      else
+        request_uri = self.uri
+        params = args.first
+      end
+
+      uri = URI.parse(request_uri)
+
+      request = AWS::Request.new :post, "#{uri.scheme}://#{uri.host}", uri.path
+      request.params["Action"] = AWS::Util.camelcase(name.to_s)
+
+      if params.is_a?(Hash)
+        insert_params_from request, params
+      end
+
+      send_request request
+    end
+  end
+
+end

data/samples/sqs.rb

@@ -0,0 +1,35 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'aws/sqs'
+
+##
+# Expects your Amazon keys to be in the environment, something like
+#
+# export AWS_KEY="KEY"
+# export AWS_SECRET="SECRET"
+##
+
+sqs = AWS::SQS.new ENV["AWS_KEY"], ENV["AWS_SECRET"]
+
+queue_name = "SimpleAWSTest"
+
+puts "Creating queue #{queue_name}"
+response = sqs.create_queue "QueueName" => queue_name
+queue_url = response.queue_url
+
+puts "Sending message to #{queue_url}"
+sent = sqs.send_message queue_url, "MessageBody" => "This is a new message in the queue"
+
+puts ""
+p sent
+puts ""
+
+puts "Receiving message from #{queue_url}"
+received = sqs.receive_message queue_url
+
+puts ""
+p received
+puts ""
+
+puts "Deleting queue #{queue_url}"
+p sqs.delete_queue queue_url

data/samples/turk.rb

@@ -0,0 +1,14 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'aws/mechanical_turk'
+
+##
+# Expects your Amazon keys to be in the environment, something like
+#
+# export AWS_KEY="KEY"
+# export AWS_SECRET="SECRET"
+##
+
+turk = AWS::MechanicalTurk.new ENV["AWS_KEY"], ENV["AWS_SECRET"], true
+
+p turk.SearchHITs

data/simple_aws.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "simple_aws"
-  s.version  = "0.0.1a"
+  s.version  = "0.0.1b"
   s.platform = Gem::Platform::RUBY
   s.authors  = ["Jason Roelofs"]
   s.email    = ["jameskilton@gmail.com"]

data/test/aws/auto_scaling_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'aws/auto_scaling'
+
+describe AWS::AutoScaling do
+
+  before do
+    @api = AWS::AutoScaling.new "key", "secret"
+  end
+
+  it "points to the endpoint" do
+    @api.uri.must_equal "https://autoscaling.amazonaws.com"
+  end
+
+  it "works with the current version" do
+    @api.version.must_equal "2011-01-01"
+  end
+
+  describe "API calls" do
+
+    it "builds and signs calls with ActionParam rules" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        params = request.params
+        params.wont_be_nil
+
+        params["Action"].must_equal "ExecutePolicy"
+        params["Signature"].wont_be_nil
+
+        true
+      end
+
+      obj = AWS::AutoScaling.new "key", "secret"
+      obj.execute_policy
+    end
+
+  end
+end

data/test/aws/call_types/action_param_test.rb

@@ -10,25 +10,18 @@ describe AWS::CallTypes::ActionParam do
     use_https true
 
     include AWS::CallTypes::ActionParam
+
+    #noop
+    def finish_and_sign_request(request)
+      request
+    end
   end
 
-  it "builds and signs AWS requests on methods it doesn't know about" do
+  it "takes an unknown method call and turns it into a request" do
     AWS::Connection.any_instance.expects(:call).with do |request|
-      request.method.must_equal :post
-      request.uri.must_equal "https://aptest.amazonaws.com/"
-
       params = request.params
-      params.wont_be_nil
-
       params["Action"].must_equal "DescribeInstances"
-      params["Version"].must_equal "2011-01-01"
-      params["AWSAccessKeyId"].must_equal "key"
-      params["SignatureMethod"].must_equal "HmacSHA256"
-      params["SignatureVersion"].must_equal "2"
-
-      params["Signature"].wont_be_nil
 
-      Time.parse(params["Timestamp"]).wont_be_nil
       true
     end.returns
 

data/test/aws/cloud_formation_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'aws/cloud_formation'
+
+describe AWS::CloudFormation do
+
+  before do
+    @api = AWS::CloudFormation.new "key", "secret"
+  end
+
+  it "points to endpoint, default to us-east-1" do
+    @api.uri.must_equal "https://cloudformation.us-east-1.amazonaws.com"
+  end
+
+  it "works with the current version" do
+    @api.version.must_equal "2010-05-15"
+  end
+
+  describe "API calls" do
+
+    it "builds and signs calls with ActionParam rules" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        params = request.params
+        params.wont_be_nil
+
+        params["Action"].must_equal "DescribeStacks"
+        params["Signature"].wont_be_nil
+
+        true
+      end
+
+      obj = AWS::CloudFormation.new "key", "secret"
+      obj.describe_stacks
+    end
+
+  end
+end

data/test/aws/cloud_watch_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'aws/cloud_watch'
+
+describe AWS::CloudWatch do
+
+  before do
+    @api = AWS::CloudWatch.new "key", "secret"
+  end
+
+  it "points to endpoint, default to us-east-1" do
+    @api.uri.must_equal "https://monitoring.us-east-1.amazonaws.com"
+  end
+
+  it "works with the current version" do
+    @api.version.must_equal "2010-08-01"
+  end
+
+  describe "API calls" do
+
+    it "builds and signs calls with ActionParam rules" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        params = request.params
+        params.wont_be_nil
+
+        params["Action"].must_equal "ListMetrics"
+        params["Signature"].wont_be_nil
+
+        true
+      end
+
+      obj = AWS::CloudWatch.new "key", "secret"
+      obj.list_metrics
+    end
+
+  end
+end

data/test/aws/core/connection_test.rb

@@ -44,5 +44,17 @@ describe AWS::Connection do
       @connection.call request
     end
 
+    it "adds any headers from the Request object" do
+      request = AWS::Request.new(:get, "host.com", "/")
+      request.headers["Header"] = "Awesome"
+
+      AWS::HTTP.expects(:get).with {|uri, options|
+        options[:query].wont_be_nil
+        options[:headers].must_equal "Header" => "Awesome"
+      }.returns(@http_response)
+
+      @connection.call request
+    end
+
   end
 end

data/test/aws/core/request_test.rb

@@ -26,6 +26,18 @@ describe AWS::Request do
     @request.params.must_equal "Param1" => "Value1", "Param2" => "Value2"
   end
 
+  it "ensures path is never an empty string" do
+    @request.path = ""
+    @request.path.must_equal "/"
+  end
+
+  describe "headers" do
+    it "allows setting raw request headers" do
+      @request.headers["Date"] = "This is a header"
+      @request.headers["Date"].must_equal "This is a header"
+    end
+  end
+
   describe "hashes" do
     it "converts hash params to AWS param names" do
       @request.params["Filter"] = [
@@ -62,12 +74,12 @@ describe AWS::Request do
       })
     end
 
-    it "wraps a singular hash into a single element array" do
+    it "handles a singular hash properly" do
       @request.params["Filter"] = {"Name" => "filter1", "Value" => "value1"}
 
       @request.params.must_equal({
-        "Filter.1.Name" => "filter1",
-        "Filter.1.Value" => "value1"
+        "Filter.Name" => "filter1",
+        "Filter.Value" => "value1"
       })
     end
   end

data/test/aws/ec2_test.rb

@@ -7,7 +7,7 @@ describe AWS::EC2 do
     @api = AWS::EC2.new "key", "secret"
   end
 
-  it "points to ec2" do
+  it "points to the endpoint" do
     @api.uri.must_equal "https://ec2.amazonaws.com"
   end
 

data/test/aws/elasti_cache_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'aws/elasti_cache'
+
+describe AWS::ElastiCache do
+
+  before do
+    @api = AWS::ElastiCache.new "key", "secret"
+  end
+
+  it "points to the endpoint, default to us-east-1" do
+    @api.uri.must_equal "https://elasticache.us-east-1.amazonaws.com"
+  end
+
+  it "works with the current version" do
+    @api.version.must_equal "2011-07-15"
+  end
+
+  describe "API calls" do
+
+    it "builds and signs calls with ActionParam rules" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        params = request.params
+        params.wont_be_nil
+
+        params["Action"].must_equal "DescribeEvents"
+        params["Signature"].wont_be_nil
+
+        true
+      end
+
+      obj = AWS::ElastiCache.new "key", "secret"
+      obj.describe_events
+    end
+
+  end
+end

data/test/aws/elastic_beanstalk_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'aws/elastic_beanstalk'
+
+describe AWS::ElasticBeanstalk do
+
+  before do
+    @api = AWS::ElasticBeanstalk.new "key", "secret"
+  end
+
+  it "points to endpoint, default to us-east-1" do
+    @api.uri.must_equal "https://elasticbeanstalk.us-east-1.amazonaws.com"
+  end
+
+  it "works with the current version" do
+    @api.version.must_equal "2010-12-01"
+  end
+
+  describe "API calls" do
+
+    it "builds and signs calls with ActionParam rules" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        params = request.params
+        params.wont_be_nil
+
+        params["Action"].must_equal "DescribeApplications"
+        params["Signature"].wont_be_nil
+
+        true
+      end
+
+      obj = AWS::ElasticBeanstalk.new "key", "secret"
+      obj.describe_applications
+    end
+
+  end
+end

data/test/aws/elb_test.rb

@@ -7,7 +7,7 @@ describe AWS::ELB do
     @api = AWS::ELB.new "key", "secret"
   end
 
-  it "points to elb" do
+  it "points to the endpoint" do
     @api.uri.must_equal "https://elasticloadbalancing.amazonaws.com"
   end
 

data/test/aws/iam_test.rb

@@ -7,7 +7,7 @@ describe AWS::IAM do
     @api = AWS::IAM.new "key", "secret"
   end
 
-  it "points to iam" do
+  it "points to the endpoint" do
     @api.uri.must_equal "https://iam.amazonaws.com"
   end
 

data/test/aws/import_export_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+require 'aws/import_export'
+
+describe AWS::ImportExport do
+
+  before do
+    @api = AWS::ImportExport.new "key", "secret"
+  end
+
+  it "does not support region selection" do
+    lambda {
+      AWS::ImportExport.new "key", "secret", "us-east-1"
+    }.must_raise ArgumentError
+  end
+
+  it "points to endpoint" do
+    @api.uri.must_equal "https://importexport.amazonaws.com"
+  end
+
+  it "works with the current version" do
+    @api.version.must_equal "2010-06-03"
+  end
+
+  describe "API calls" do
+
+    it "builds and signs calls with ActionParam rules" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        params = request.params
+        params.wont_be_nil
+
+        params["Action"].must_equal "ListJobs"
+        params["Signature"].wont_be_nil
+
+        true
+      end
+
+      obj = AWS::ImportExport.new "key", "secret"
+      obj.list_jobs
+    end
+
+  end
+end

data/test/aws/map_reduce_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'aws/map_reduce'
+
+describe AWS::MapReduce do
+
+  before do
+    @api = AWS::MapReduce.new "key", "secret"
+  end
+
+  it "points to the endpoint" do
+    @api.uri.must_equal "https://elasticmapreduce.amazonaws.com"
+  end
+
+  it "works with the current version" do
+    @api.version.must_equal "2009-03-31"
+  end
+
+  describe "API calls" do
+
+    it "builds and signs calls with ActionParam rules" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        params = request.params
+        params.wont_be_nil
+
+        params["Action"].must_equal "GetGroup"
+        params["Signature"].wont_be_nil
+
+        true
+      end
+
+      obj = AWS::MapReduce.new "key", "secret"
+      obj.get_group
+    end
+
+  end
+end

data/test/aws/mechanical_turk_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+require 'aws/mechanical_turk'
+
+describe AWS::MechanicalTurk do
+
+  before do
+    @api = AWS::MechanicalTurk.new "key", "secret"
+  end
+
+  it "points to the endpoint" do
+    @api.uri.must_equal "https://mechanicalturk.amazonaws.com"
+  end
+
+  it "works with the current version" do
+    @api.version.must_equal "2011-10-01"
+  end
+
+  it "can be told to work in sandbox mode" do
+    api = AWS::MechanicalTurk.new "key", "secret", true
+    api.uri.must_equal "https://mechanicalturk.sandbox.amazonaws.com"
+  end
+
+  describe "API calls" do
+
+    it "builds and signs calls with Operation and Service" do
+      AWS::Connection.any_instance.expects(:call).with do |request|
+        params = request.params
+        params.wont_be_nil
+
+        params["Operation"].must_equal "SearchHITs"
+        params["Service"].must_equal "AWSMechanicalTurkRequester"
+        params["AWSAccessKeyId"].must_equal "key"
+        params["Version"].must_equal "2011-10-01"
+        params["Signature"].wont_be_nil
+
+        true
+      end
+
+      obj = AWS::MechanicalTurk.new "key", "secret"
+      obj.SearchHITs
+    end
+
+  end
+end