dynamodb 0.0.2 → 1.1.1

data/lib/net/http/connection_pool/session.rb

@@ -0,0 +1,126 @@
+# Copyright 2011-2012 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 'net/http'
+require 'net/https'
+require 'openssl'
+
+class Net::HTTP::ConnectionPool
+
+  # Used by Net::HTTP::ConnectionPool to wrap Net::HTTP::Session objects.
+  # Users should never need to interact with these session wrappers.
+  # @private
+  class Session
+
+    # @param [Net::HTTPSession] http_session
+    # @param [String] key
+    def initialize http_session, key
+      @http_session = http_session
+      @key = key
+      @created_at = Time.now
+      @last_used_at = nil
+    end
+
+    # @return [Net::HTTPSession]
+    attr_reader :http_session
+
+    # @return [String]
+    attr_reader :key
+
+    # @return [Time]
+    attr_reader :created_at
+
+    # @return [Time]
+    attr_reader :last_used_at
+
+    # @param [Integer] timeout Number of seconds before Net::HTTP should
+    #   timeout while waiting to read a response.
+    def read_timeout= timeout
+      http_session.read_timeout = timeout
+    end
+
+    # Makes a HTTP request.  See Net::HTTPSession#request documentation
+    # from the Ruby standard library for information about argments.
+    #
+    #   connection.request(Net::HTTP::Get.new('/')) do |response|
+    #     # Parse the response (status, headers and body) here.
+    #     # You should be done with the response by the end of the block.
+    #   end
+    #
+    # @yield [response]
+    # @yieldparam [Net::HTTPResponse] response
+    # @return [nil]
+    def request *args, &block
+      http_session.request(*args, &block)
+      @last_used_at = Time.now
+      nil
+    end
+
+    # Attempts to cleanly close the HTTP session.
+    # @return [nil]
+    def finish
+      begin
+        http_session.finish if http_session.started?
+      rescue IOError
+      end
+      nil
+    end
+
+    class << self
+
+      # Starts a new HTTP session and returns it wrapped in a {Session} object.
+      # @param [Connection] connection
+      # @param [Hash] options
+      # @option options [Integer] :open_timeout (15) The number of seconds to
+      #   wait while trying to open the HTTP session before timeing out.
+      # @option options [Logger] :debug_logger HTTP wire traces are logged
+      #   here when specified.
+      # @return [Session]
+      def start connection, options = {}
+
+        http_args = []
+        http_args << connection.host
+        http_args << connection.port
+        if connection.proxy?
+          http_args << connection.proxy_address
+          http_args << connection.proxy_port
+          http_args << connection.proxy_user
+          http_args << connection.proxy_password
+        end
+
+        http = Net::HTTP.new(*http_args)
+        http.set_debug_output(options[:debug_logger]) if options[:debug_logger]
+        http.open_timeout = options[:open_timeout] || 15
+
+        if connection.ssl?
+          http.use_ssl = true
+          if connection.ssl_verify_peer?
+            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+            http.ca_file = connection.ssl_ca_file if connection.ssl_ca_file
+            http.ca_path = connection.ssl_ca_path if connection.ssl_ca_path
+          else
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+        else
+          http.use_ssl = false
+        end
+
+        http.start
+
+        Session.new(http, connection.key)
+
+      end
+
+    end
+  end
+end

data/spec/dynamodb/connection_spec.rb

@@ -1,131 +1,28 @@
 require 'spec_helper'
-require 'benchmark'
 
 describe DynamoDB::Connection do
-  let(:token_service) {
-    stub(:credentials =>
-      DynamoDB::Credentials.new(
-        "access_key_id",
-        "secret_access_key",
-        "session_token"
-      )
-    )
-  }
-
-  describe "#initialize" do
-    it "can be initialized with a token service" do
-      DynamoDB::Connection.new(:token_service => token_service)
-    end
-
-    it "can be initialized with an access key" do
-      DynamoDB::Connection.new(
-        :access_key_id => "id",
-        :secret_access_key => "secret"
-      )
-    end
-
-    context "no token service was provided" do
-      it "requires an access_key_id and secret_access_key" do
-        lambda {
-          DynamoDB::Connection.new
-        }.should raise_error(ArgumentError)
-      end
-    end
-  end
-
   describe "#post" do
-    let(:connection) { DynamoDB::Connection.new(:token_service => token_service) }
-
-    before do
-      Time.stub(:now => Time.at(1332635893)) # Sat Mar 24 20:38:13 -0400 2012
-
-      @url = "https://dynamodb.us-east-1.amazonaws.com/"
-      @headers = {
-        'Content-Type'          => 'application/x-amz-json-1.0',
-        'Host'                  => 'dynamodb.us-east-1.amazonaws.com',
-        'X-Amz-Date'            => 'Sun, 25 Mar 2012 00:38:13 GMT',
-        'X-Amz-Security-Token'  => 'session_token',
-        'X-Amzn-Authorization'  => 'AWS3 AWSAccessKeyId=access_key_id,Algorithm=HmacSHA256,Signature=2xa6v0WW+980q8Hgt+ym3/7C0D1DlkueGMugi1NWE+o='
-      }
-    end
+    let(:connection) { DynamoDB::Connection.new(:access_key_id => "id", :secret_access_key => "secret") }
 
     it "signs and posts a request" do
-      @headers['X-Amz-Target'] = 'DynamoDB_20111205.ListTables'
-      stub_request(:post, @url).
-        with(
-          :body     => "{}",
-          :headers  => @headers
-        ).
-        to_return(
-          :status => 200,
-          :body => '{"TableNames":["example"]}',
-          :headers => {}
-        )
-
+      stub_request(:post, "https://dynamodb.us-east-1.amazonaws.com/").
+        to_return(status: 200, body: MultiJson.encode({"TableNames" => ["example"]}))
       result = connection.post :ListTables
-      result.should == {"TableNames" => ["example"]}
-    end
-
-    it "type casts response when Query" do
-      stub_request(:post, @url).
-        to_return(
-          :status => 200,
-          :body => "{}",
-          :headers => {}
-        )
-
-      response = connection.post :Query, :TableName => "people", :HashKeyId => {:N => "1"}
-      response.should be_a_kind_of(DynamoDB::Response)
+      result.data.should == {"TableNames" => ["example"]}
     end
 
-    it "type casts response when GetItem" do
-      stub_request(:post, @url).
-        to_return(
-          :status => 200,
-          :body => "{}",
-          :headers => {}
-        )
-
-      response = connection.post :GetItem, :TableName => "people", :Key => {:HashKeyElement => {:N => "1"}, :RangeKeyElement => {:N => 2}}
-      response.should be_a_kind_of(DynamoDB::Response)
-    end
-
-    context "when a failure occurs" do
-      it "raises an error with the response attached" do
-        stub_request(:post, @url).to_return(:status => 500, :body => "Failed for some reason.")
-        error = nil
-        begin
-          connection.post :Query, :TableName => "people", :HashKeyId => {:N => "1"}
-        rescue => e
-          error = e
-        end
-        error.should be_an_instance_of(DynamoDB::ServerError)
-        error.response.code.should == 500
-        error.message.should == "500: Failed for some reason."
-      end
-    end
-
-    context "when the connection fails" do
-      it "raises a server error" do
-        stub_request(:post, @url).to_return(:status => 0, :body => "")
-        error = nil
-        begin
-          connection.post :Query, :TableName => "people", :HashKeyId => {:N => "1"}
-        rescue => e
-          error = e
-        end
-        error.should be_an_instance_of(DynamoDB::ServerError)
-        error.response.code.should == 0
-      end
+    it "creates a SuccessResponse when 200" do
+      stub_request(:post, "https://dynamodb.us-east-1.amazonaws.com/").
+        to_return(status: 200, body: "")
+      result = connection.post :ListTables
+      result.should be_a_kind_of(DynamoDB::SuccessResponse)
     end
 
-    context "when the connection times out" do
-      it "raises a DynamoDB::TimeoutError" do
-        stub_request(:post, @url).to_timeout
-        expect {
-          connection.post :Query, :TableName => "people", :HashKeyId => {:N => "1"}
-        }.to raise_error(DynamoDB::TimeoutError)
-      end
+    it "creates a FailureResponse when 400" do
+      stub_request(:post, "https://dynamodb.us-east-1.amazonaws.com/").
+        to_return(status: 400, body: "")
+      result = connection.post :ListTables
+      result.should be_a_kind_of(DynamoDB::FailureResponse)
     end
   end
 end

data/spec/dynamodb/failure_response_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe DynamoDB::FailureResponse do
+  describe "#error" do
+    it "returns a ClientError if the HTTP response code is between 400 and 499" do
+      http_response = stub("Response", code: "401", message: "Not authorized", body: "Error details")
+      response = DynamoDB::FailureResponse.new(http_response)
+      response.error.should be_an_instance_of(DynamoDB::ClientError)
+      response.error.message.should == "401: Not authorized"
+      response.body.should == "Error details"
+    end
+
+    it "returns a ServerError if the HTTP response code is between 500 and 599" do
+      http_response = stub("Response", code: "500", message: "Internal server error", body: "")
+      response = DynamoDB::FailureResponse.new(http_response)
+      response.error.should be_an_instance_of(DynamoDB::ServerError)
+      response.error.message.should == "500: Internal server error"
+    end
+
+    it "returns a ServerError otherwise" do
+      http_response = stub("Response", code: "0", message: "")
+      response = DynamoDB::FailureResponse.new(http_response)
+      response.error.should be_an_instance_of(DynamoDB::ServerError)
+      response.error.message.should == "0: "
+    end
+  end
+end

data/spec/dynamodb/http_handler_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+describe DynamoDB::HttpHandler do
+  describe "#handle" do
+    let(:http_handler) { DynamoDB::HttpHandler.new }
+    let(:request) {
+      stub(DynamoDB::Request,
+        uri:     URI("https://dynamo.local/"),
+        headers: {},
+        body:    "{}"
+      )
+    }
+
+    it "performs an HTTP request given a DynamoDB::Request" do
+      http_request = stub_request(:post, "https://dynamo.local/").to_return(status: 200)
+      http_handler.handle(request)
+      http_request.should have_been_requested
+    end
+
+    it "returns a DynamoDB::SuccessResponse for successes" do
+      stub_request(:post, "https://dynamo.local/").to_return(status: 200)
+
+      response = http_handler.handle(request)
+      response.should be_an_instance_of(DynamoDB::SuccessResponse)
+      response.should be_success
+    end
+
+    it "returns a DynamoDB::Response for failures" do
+      stub_request(:post, "https://dynamo.local/").to_return(status: 500, body: "Server errors")
+
+      response = http_handler.handle(request)
+      response.should be_an_instance_of(DynamoDB::FailureResponse)
+      response.should_not be_success
+    end
+
+    it "returns a DynamoDB::Response for network errors" do
+      error = Errno::ECONNRESET.new
+      stub_request(:post, "https://dynamo.local/").to_raise(error)
+
+      response = http_handler.handle(request)
+      response.should be_an_instance_of(DynamoDB::FailureResponse)
+      response.should_not be_success
+      response.error.should == error
+      response.body.should be_nil
+    end
+
+    it "respects a custom timeout option (set on initialize)" do
+      stub_request(:post, "https://dynamo.local/").to_return(status: 200)
+      connection = Net::HTTP::ConnectionPool::Connection.any_instance
+      connection.should_receive(:read_timeout=).with(5)
+      http_handler.handle(request)
+    end
+  end
+
+  describe "#build_http_request" do
+    it "converts a DynamoDB::Request into a Net::HTTP::Post" do
+      request = stub(DynamoDB::Request,
+        uri:      URI("https://dynamo.local/"),
+        headers:  {"content-type" => "application/json"},
+        body:     "POST body"
+      )
+
+      http_handler = DynamoDB::HttpHandler.new
+      http_request = http_handler.build_http_request(request)
+      http_request.should be_an_instance_of(Net::HTTP::Post)
+      http_request.path.should == "https://dynamo.local/"
+      http_request["content-type"].should == "application/json"
+      http_request.body.should == "POST body"
+    end
+  end
+end

data/spec/dynamodb/request_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe DynamoDB::Request do
+  let(:uri)         { URI("https://dynamodb.us-east-1.amazonaws.com/") }
+  let(:credentials) { DynamoDB::Credentials.new("access_key_id", "secret_access_key") }
+  let(:data)        { {} }
+  let(:request) {
+    DynamoDB::Request.new(
+      uri:          uri,
+      api_version:  "DynamoDB_20111205",
+      credentials:  credentials,
+      data:         data,
+      operation:    "ListTables",
+    )
+  }
+
+  it "signs the request" do
+    Time.stub(now: Time.parse("20130508T201304Z"))
+
+    request.headers.should == {
+      "content-type"=>"application/x-amz-json-1.0",
+      "x-amz-target"=>"DynamoDB_20111205.ListTables",
+      "content-length"=>2,
+      "user-agent"=>"groupme/dynamodb",
+      "host"=>"dynamodb.us-east-1.amazonaws.com",
+      "x-amz-date"=>"20130508T201304Z",
+      "x-amz-content-sha256"=>"44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a",
+      "authorization"=>"AWS4-HMAC-SHA256 Credential=access_key_id/20130508/us-east-1/dynamodb/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=52fab5c720b35ce247f8388c5c8f66b300074ae88b666985ee26ca70d923be1d"
+    }
+  end
+end

data/spec/dynamodb/success_response_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe DynamoDB::SuccessResponse do
+  describe "#hash_key_element" do
+    it "returns the typecast value of HashKeyElement" do
+      body = {
+        "LastEvaluatedKey" => {
+          "HashKeyElement"  => {"N" => "1"},
+          "RangeKeyElement" => {"N" => "1501"}
+        }
+      }
+      http_response = stub(Net::HTTPResponse, body: MultiJson.dump(body))
+      response = DynamoDB::SuccessResponse.new(http_response)
+      response.hash_key_element.should == 1
+    end
+  end
+
+  describe "#range_key_element" do
+    it "returns the typecast value of RangeKeyElement" do
+      body = {
+        "LastEvaluatedKey" => {
+          "HashKeyElement"  => {"N" => "1"},
+          "RangeKeyElement" => {"N" => "1501"}
+        }
+      }
+      http_response = stub(Net::HTTPResponse, body: MultiJson.dump(body))
+      response = DynamoDB::SuccessResponse.new(http_response)
+      response.range_key_element.should == 1501
+    end
+  end
+
+  describe "#items" do
+    it "returns type-casted entries from the 'Items' key" do
+      body = {
+        "Items" => [
+          {
+            "name"       => {"S" => "John Smith"},
+            "created_at" => {"N" => "1321564309.99428"},
+            "disabled"   => {"N" => "0"},
+            "group_id"   => {"N" => "1"},
+            "person_id"  => {"N" => "1500"}
+          },
+          {
+            "name"       => {"S" => "Jane Smith"},
+            "created_at" => {"N" => "1321564309.99428"},
+            "disabled"   => {"N" => "1"},
+            "group_id"   => {"N" => "1"},
+            "person_id"  => {"N" => "1501"}
+          }
+        ],
+        "Count" => 1,
+        "ConsumedCapacityUnits" => 0.5
+      }
+      http_response = stub(Net::HTTPResponse, body: MultiJson.dump(body))
+
+      response = DynamoDB::SuccessResponse.new(http_response)
+      response.items[0]["name"].should == "John Smith"
+      response.items[0]["created_at"].should == 1321564309.99428
+      response.items[0]["disabled"].should == 0
+      response.items[0]["group_id"].should == 1
+      response.items[0]["person_id"].should == 1500
+
+      response.items[1]["name"].should == "Jane Smith"
+      response.items[1]["created_at"].should == 1321564309.99428
+      response.items[1]["disabled"].should == 1
+      response.items[1]["group_id"].should == 1
+      response.items[1]["person_id"].should == 1501
+    end
+  end
+
+  describe "#item" do
+    it "returns the type-casted 'Item' key" do
+      body = {
+        "Item"=> {
+          "name"       => {"S" => "John Smith"},
+          "created_at" => {"N" => "1321564309.99428"},
+          "disabled"   => {"N" => "0"},
+          "group_id"   => {"N" => "1"},
+          "person_id"  => {"N" => "1500"}
+        },
+        "ConsumedCapacityUnits" => 0.5
+      }
+      http_response = stub(Net::HTTPResponse, body: MultiJson.dump(body))
+
+      response = DynamoDB::SuccessResponse.new(http_response)
+      response.item["name"].should == "John Smith"
+      response.item["created_at"].should == 1321564309.99428
+      response.item["disabled"].should == 0
+      response.item["group_id"].should == 1
+      response.item["person_id"].should == 1500
+    end
+  end
+end