jedlik 0.0.1 → 0.0.4

data/.gitignore

@@ -0,0 +1,3 @@
+.rvmrc
+Gemfile.lock
+*.gem

data/Gemfile

@@ -1 +1,3 @@
+source "http://rubygems.org"
 gemspec
+

data/README.mkd

@@ -23,3 +23,26 @@ request body.
 
     conn.post :GetItem, {:TableName => "table1", :Key => {:S => "foo"}}
     # => Hash
+
+License
+-------
+
+Copyright (C) 2012, Jeremy (Hashmal) Pinat
+
+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.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/jedlik.gemspec

@@ -0,0 +1,21 @@
+# Copyright (c) 2012, Jeremy (Hashmal) Pinat.
+
+Gem::Specification.new do |s|
+  s.name         = 'jedlik'
+  s.version      = '0.0.4'
+  s.summary      = "Communicate with Amazon DynamoDB."
+  s.description  = "Communicate with Amazon DynamoDB. Raw access to the full API without having to handle temporary credentials or HTTP requests by yourself."
+  s.authors      = ["Hashmal", "Brandon Keene"]
+  s.email        = ["jeremypinat@gmail.com", "bkeene@gmail.com"]
+  s.require_path = 'lib'
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.homepage     = 'http://github.com/hashmal/jedlik'
+
+  s.add_runtime_dependency 'typhoeus'
+  s.add_runtime_dependency 'yajl-ruby'
+
+  s.add_development_dependency 'rspec', '2.8.0'
+  s.add_development_dependency 'webmock'
+end

data/lib/jedlik/connection.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2012, Jeremy (Hashmal) Pinat.
+
 module Jedlik
 
   # Establishes a connection to Amazon DynamoDB using credentials.
@@ -17,6 +19,7 @@ module Jedlik
       opts = DEFAULTS.merge opts
       @sts = SecurityTokenService.new access_key_id, secret_access_key
       @endpoint = opts[:endpoint]
+      @debug = opts[:debug]
     end
 
     # Create and send a request to DynamoDB.
@@ -28,47 +31,47 @@ module Jedlik
     # http://docs.amazonwebservices.com/amazondynamodb/latest/developerguide
     #
     def post operation, data={}
-      request = new_request operation, data.to_json
+      request = new_request operation, Yajl::Encoder.encode(data)
       request.sign sts
-      hydra.queue request; hydra.run
+      hydra.queue request
+      hydra.run
       response = request.response
+      puts response.inspect if @debug
 
-      if status_ok? response
-        JSON.parse response.body
+      if response.code == 200
+        Yajl::Parser.parse response.body
+      else
+        raise_error response
       end
     end
 
-  private
+    private
 
     def hydra
       Typhoeus::Hydra.hydra
     end
 
     def new_request operation, body
-      (Typhoeus::Request.new "https://#{@endpoint}/",
-      :method => :post,
-      :headers => {
-        'host' => @endpoint,
-        'content-type' => "application/x-amz-json-1.0",
-        'x-amz-date' => (Time.now.utc.strftime "%a, %d %b %Y %H:%M:%S GMT"),
-        'x-amz-security-token' => sts.session_token,
-        'x-amz-target' => "DynamoDB_20111205.#{operation}",
-        },
-      :body => body)
+      Typhoeus::Request.new "https://#{@endpoint}/",
+        :method   => :post,
+        :body     => body,
+        :headers  => {
+          'host'                  => @endpoint,
+          'content-type'          => "application/x-amz-json-1.0",
+          'x-amz-date'            => (Time.now.utc.strftime "%a, %d %b %Y %H:%M:%S GMT"),
+          'x-amz-security-token'  => sts.session_token,
+          'x-amz-target'          => "DynamoDB_20111205.#{operation}",
+        }
     end
 
-    def status_ok? response
+    def raise_error response
       case response.code
-      when 200
-        true
       when 400..499
-        js = JSON.parse response.body
-        (raise ClientError,
-        "#{js['__type'].match(/#(.+)\Z/)[1]}: #{js["message"]}")
+        raise ClientError, response.body
       when 500..599
-        raise ServerError
+        raise ServerError, response.code
       else
-        false
+        raise Exception, response.body
       end
     end
   end

data/lib/jedlik/security_token_service.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2012, Jeremy (Hashmal) Pinat.
+
 module Jedlik
 
   # SecurityTokenService automatically manages the creation and renewal of
@@ -37,6 +39,19 @@ module Jedlik
       @session_token
     end
 
+    def signature
+      sign string_to_sign
+    end
+
+    def string_to_sign
+      [
+        "GET",
+        "sts.amazonaws.com",
+        "/",
+        "AWSAccessKeyId=#{@_access_key_id}&Action=GetSessionToken&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=#{CGI.escape authorization_params[:Timestamp]}&Version=2011-06-15"
+      ].join("\n")
+    end
+
     private
 
     # Extract the contents of a given tag.
@@ -53,44 +68,41 @@ module Jedlik
     # credentials were previously obtained, no request is made until they
     # expire.
     def obtain_credentials
-      if (not @expiration) or (@expiration <= Time.now.utc)
-        body = (Typhoeus::Request.get request_uri).body
+      if not @expiration or @expiration <= Time.now.utc
+        params = {
+          :AWSAccessKeyId   => @_access_key_id,
+          :SignatureMethod  => 'HmacSHA256',
+          :SignatureVersion => '2',
+          :Signature        => signature,
+        }.merge authorization_params
 
-        @session_token = (get_tag :SessionToken, body)
-        @secret_access_key = (get_tag :SecretAccessKey, body)
-        @expiration = (Time.parse (get_tag :Expiration, body))
-        @access_key_id = (get_tag :AccessKeyId, body)
+        response = (Typhoeus::Request.get "https://sts.amazonaws.com/", :params => params)
+        if response.success?
+          body = response.body
+          @session_token     = get_tag :SessionToken, body
+          @secret_access_key = get_tag :SecretAccessKey, body
+          @expiration        = Time.parse get_tag(:Expiration, body)
+          @access_key_id     = get_tag :AccessKeyId, body
+        else
+          raise "credential errors: #{response.inspect}"
+        end
       end
     end
 
-    # Generate the params to be sent to STS.
-    def request_params
+    def authorization_params
       {
-        :AWSAccessKeyId   => @_access_key_id,
         :Action           => 'GetSessionToken',
-        :DurationSeconds  => '3600',
-        :SignatureMethod  => 'HmacSHA256',
-        :SignatureVersion => '2',
         :Timestamp        => Time.now.utc.iso8601,
         :Version          => '2011-06-15',
       }
     end
 
-    # Generate the URI that should be requested.
-    def request_uri
-      qs = (request_params).map do |key, val|
-        [(CGI.escape key.to_s), (CGI.escape val)].join '='
-      end.join '&'
-
-      "https://sts.amazonaws.com/?#{qs}&Signature=" +
-      (CGI.escape (sign "GET\nsts.amazonaws.com\n/\n#{qs}"))
-    end
-
     # Sign (HMAC-SHA256) a string using the secret key given at
     # initialization.
     def sign string
-      (Base64.encode64 (OpenSSL::HMAC.digest 'sha256',
-      @_secret_access_key, string)).chomp
+      Base64.encode64(
+        OpenSSL::HMAC.digest('sha256', @_secret_access_key, string)
+      ).strip
     end
   end
 end

data/lib/jedlik/typhoeus/request.rb

@@ -1,30 +1,29 @@
+# Copyright (c) 2012, Jeremy (Hashmal) Pinat.
+
 module Typhoeus
   class Request
     def sign sts
-      headers.merge!({'x-amzn-authorization' => [
-        "AWS3 AWSAccessKeyId=#{sts.access_key_id}",
-        "Algorithm=HmacSHA256",
-        "Signature=#{digest sts.secret_access_key}"
-      ].join(',')})
+      headers.merge! 'x-amzn-authorization' => "AWS3 AWSAccessKeyId=#{sts.access_key_id},Algorithm=HmacSHA256,Signature=#{digest sts.secret_access_key}"
     end
 
     private
 
     def digest secret_key
-      (Base64.encode64 (OpenSSL::HMAC.digest 'sha256',
-      secret_key, (Digest::SHA256.digest string_to_sign))).chomp
+      Base64.encode64(
+        OpenSSL::HMAC.digest('sha256', secret_key, Digest::SHA256.digest(string_to_sign))
+      ).strip
     end
 
     def string_to_sign
-      ["POST\n/\n\nhost:#{@parsed_uri.host}", amz_to_sts, body].join "\n"
+      "POST\n/\n\nhost:#{@parsed_uri.host}\n#{amz_to_sts}\n#{body}"
     end
 
     def amz_to_sts
-      get_amz_headers.sort.map{|key, val| ([key, val].join ':') + "\n"}.join
+      get_amz_headers.sort.map {|key, val| [key, val].join(':') + "\n"}.join
     end
 
     def get_amz_headers
-      headers.select{|key, val| key =~ /\Ax-amz-/}
+      headers.select {|key, val| key =~ /\Ax-amz-/}
     end
   end
 end

data/lib/jedlik.rb

@@ -1,16 +1,17 @@
+# Copyright (c) 2012, Jeremy (Hashmal) Pinat.
+
 require 'typhoeus'
 require 'time'
 require 'base64'
 require 'openssl'
 require 'cgi'
-require 'json'
+require 'yajl'
 
 module Jedlik
   class ClientError < Exception; end
   class ServerError < Exception; end
 
   require 'jedlik/typhoeus/request'
-
   require 'jedlik/security_token_service'
   require 'jedlik/connection'
 end

data/spec/jedlik/connection_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'benchmark'
+
+describe Jedlik::Connection do
+  describe "#post" do
+    before do
+      Time.stub!(:now).and_return(Time.at(1332635893)) # Sat Mar 24 20:38:13 -0400 2012
+    end
+
+    it "signs and posts a request" do
+      mock_service = mock(Jedlik::SecurityTokenService,
+        :session_token => "session_token",
+        :access_key_id => "access_key_id",
+        :secret_access_key => "secret_access_key"
+      )
+
+      stub_request(:post, "https://dynamodb.us-east-1.amazonaws.com/").
+        with(
+          :body     => "{}",
+          :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-Amz-Target'          => 'DynamoDB_20111205.ListTables', 
+            'X-Amzn-Authorization'  => 'AWS3 AWSAccessKeyId=access_key_id,Algorithm=HmacSHA256,Signature=2xa6v0WW+980q8Hgt+ym3/7C0D1DlkueGMugi1NWE+o='
+          }
+        ).
+        to_return(
+          :status => 200,
+          :body => '{"TableNames":["example"]}',
+          :headers => {}
+        )
+
+      Jedlik::SecurityTokenService.stub!(:new).and_return(mock_service)
+      connection = Jedlik::Connection.new("key_id", "secret")
+      result = connection.post :ListTables
+      result.should == {"TableNames" => ["example"]}
+    end
+  end
+end

data/spec/jedlik/security_token_service_spec.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2012, Jeremy (Hashmal) Pinat.
+
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 VALID_RESPONSE_BODY = "<GetSessionTokenResponse " +
@@ -5,9 +7,9 @@ VALID_RESPONSE_BODY = "<GetSessionTokenResponse " +
 <GetSessionTokenResult>
 <Credentials>
 <SessionToken>SESSION_TOKEN</SessionToken>
-<SecretAccessKey>SECRET_ACCESS_KEY</SecretAccessKey>
-<Expiration>2036-03-19T01:03:22.276Z</Expiration>
-<AccessKeyId>ACCESS_KEY_ID</AccessKeyId>
+<SecretAccessKey>secret_access_key</SecretAccessKey>
+<Expiration>2012-03-24T23:10:38Z</Expiration>
+<AccessKeyId>access_key_id</AccessKeyId>
 </Credentials>
 </GetSessionTokenResult>
 <ResponseMetadata>
@@ -18,48 +20,71 @@ VALID_RESPONSE_BODY = "<GetSessionTokenResponse " +
 
 module Jedlik
   describe SecurityTokenService do
-    let(:sts){SecurityTokenService.new "access_key_id", "secret_access_key"}
-    let(:response){(Typhoeus::Response.new body: VALID_RESPONSE_BODY)}
-
-    before{Typhoeus::Request.stub(:get).and_return response}
+    let(:sts) { SecurityTokenService.new("access_key_id", "secret_access_key") }
 
-    shared_examples_for 'cached' do |method|
-      it 'sends a request to Amazon STS at first call' do
-        Typhoeus::Request.should_receive(:get).and_return response
-        sts.send method
-      end
+    before do
+      Time.stub(:now).and_return(Time.parse("2012-03-24T22:10:38Z"))
+      stub_request(:get, "https://sts.amazonaws.com/").
+        with(:query => {
+          "AWSAccessKeyId"   => "access_key_id",
+          "Action"           => "GetSessionToken",
+          "Signature"        => "8h1VJkZsuVP3y+BkqwABrFBgTuTCUNHcHPZPARfQHJw=",
+          "SignatureMethod"  => "HmacSHA256",
+          "SignatureVersion" => "2",
+          "Timestamp"        => "2012-03-24T22:10:38Z",
+          "Version"          => "2011-06-15"
+        }).to_return(:status => 200, :body => VALID_RESPONSE_BODY)
+    end
 
-      it 'signs the request'
+    it "computes proper signature" do
+      s = SecurityTokenService.new("access_key_id", "secret_access_key")
+      s.string_to_sign.should == [
+        "GET",
+        "sts.amazonaws.com",
+        "/",
+        "AWSAccessKeyId=access_key_id&Action=GetSessionToken&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-03-24T22%3A10%3A38Z&Version=2011-06-15"
+      ].join("\n")
+      s.signature.should == "8h1VJkZsuVP3y+BkqwABrFBgTuTCUNHcHPZPARfQHJw="
+    end
 
-      it 'caches its value' do
-        Typhoeus::Request.should_receive(:get).and_return response
-        sts.send method
-        sts.send method
-      end
+    it "returns session_token" do
+      sts.session_token.should == "SESSION_TOKEN"
     end
 
-    describe 'access_key_id' do
-      it_behaves_like 'cached', :access_key_id
+    it "returns access_key_id" do
+      sts.access_key_id.should == "access_key_id"
+    end
 
-      it 'returns a value' do
-        sts.access_key_id.should == "ACCESS_KEY_ID"
-      end
+    it "returns secret_access_key" do
+      sts.secret_access_key.should == "secret_access_key"
     end
 
-    describe 'secret_access_key' do
-      it_behaves_like 'cached', :secret_access_key
+    # a memoized timestamp would cause a bug when temporary credentials
+    # expire and new ones are requested.
+    it "updates the timestamp for different requests" do
+      s = SecurityTokenService.new("access_key_id", "secret_access_key")
+      s.string_to_sign.should == [
+        "GET",
+        "sts.amazonaws.com",
+        "/",
+        "AWSAccessKeyId=access_key_id&Action=GetSessionToken&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-03-24T22%3A10%3A38Z&Version=2011-06-15"
+      ].join("\n")
 
-      it 'returns a value' do
-        sts.secret_access_key.should == "SECRET_ACCESS_KEY"
-      end
+      Time.stub(:now).and_return(Time.parse("2012-03-24T23:11:38Z"))
+      s.string_to_sign.should == [
+        "GET",
+        "sts.amazonaws.com",
+        "/",
+        "AWSAccessKeyId=access_key_id&Action=GetSessionToken&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-03-24T23%3A11%3A38Z&Version=2011-06-15"
+      ].join("\n")
     end
 
-    describe 'session_token' do
-      it_behaves_like 'cached', :session_token
-
-      it 'returns a value' do
-        sts.session_token.should == "SESSION_TOKEN"
-      end
+    it "does not update the timestamp for the same request" do
+      Time.stub(:now).and_return(
+        Time.parse("2012-03-24T22:10:38Z"),
+        Time.parse("2012-03-24T22:10:39Z")
+      )
+      sts.session_token
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
+# Copyright (c) 2012, Jeremy (Hashmal) Pinat.
+
 require 'rspec'
+require 'webmock/rspec'
 
-$:.unshift (File.join (File.dirname __FILE__), 'lib')
+$:.unshift File.join(File.dirname __FILE__), 'lib'
 require 'jedlik'
 
 RSpec.configure do |config|
-  config.color = true
-  config.formatter = :documentation
 end

metadata

@@ -1,25 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: jedlik
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
 - Hashmal
+- Brandon Keene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-23 00:00:00.000000000Z
+date: 2012-03-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -28,7 +29,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -43,19 +44,57 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Communicate with Amazon DynamoDB. Raw access to the full API without
   having to handle temporary credentials or HTTP requests by yourself.
-email: jeremypinat@gmail.com
+email:
+- jeremypinat@gmail.com
+- bkeene@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- README.mkd
+- Rakefile
+- jedlik.gemspec
+- lib/jedlik.rb
 - lib/jedlik/connection.rb
 - lib/jedlik/security_token_service.rb
 - lib/jedlik/typhoeus/request.rb
-- lib/jedlik.rb
-- Gemfile
-- README.mkd
+- spec/jedlik/connection_spec.rb
 - spec/jedlik/security_token_service_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/hashmal/jedlik
@@ -82,4 +121,7 @@ rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: Communicate with Amazon DynamoDB.
-test_files: []
+test_files:
+- spec/jedlik/connection_spec.rb
+- spec/jedlik/security_token_service_spec.rb
+- spec/spec_helper.rb