awsnap 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in awsnap.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/awsnap.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "awsnap/version"
+
+Gem::Specification.new do |s|
+  s.name        = "awsnap"
+  s.version     = Awsnap::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Scott Burton"]
+  s.email       = ["scott.burton@chaione.com"]
+  s.homepage    = "http://www.chaione.com"
+  s.summary     = %q{AWSnap signs your AWS requests for you.}
+  s.description = %q{AWSnap signs your AWS requests for you. No request processing, no response handling, no extra nonsense. Works for all AWS endpoints.}
+
+  s.rubyforge_project = "awsnap"
+
+  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.require_paths = ["lib"]
+  
+  s.add_runtime_dependency("activesupport")
+end

data/lib/awsnap.rb

@@ -0,0 +1,11 @@
+require 'active_support/dependencies/autoload'
+require 'active_support/core_ext/numeric/time'
+require 'active_support/core_ext/hash'
+require 'uri'
+require 'hmac-sha2'
+require 'base64'
+
+module Awsnap
+  extend ActiveSupport::Autoload
+  autoload :Request
+end

data/lib/awsnap/request.rb

@@ -0,0 +1,60 @@
+module Awsnap
+  class Request
+    
+    attr_reader :verb, :params, :access_key_id, :secret_access_key
+    
+    def initialize(url, verb = :get, params)
+      @verb   = verb
+      @url = URI.parse(url)
+      @access_key_id = params.delete(:access_key_id)
+      @secret_access_key = params.delete(:secret_access_key)
+      @expires = params.delete(:expires) || params.delete("Expires")
+      @params = params.stringify_keys
+    end
+    
+    def canonicalized_params
+      normalized_params.sort.inject([]) {|params, pair| params.push(pair.map {|i| URI.encode(i, reserved_characters)}); params}
+    end
+    
+    def params_string
+      canonicalized_params.map{|pair| "#{pair[0]}=#{pair[1]}" }.join("&")
+    end
+    
+    def string_to_sign
+      "#{verb.to_s.upcase}\n#{@url.host}\n#{@url.path}\n#{params_with_access_key}"
+    end
+    
+    def hmac_signature
+      HMAC::SHA256.digest(secret_access_key, string_to_sign)
+    end
+    
+    def signature
+      URI.encode(Base64.encode64(hmac_signature).strip, reserved_characters)
+    end
+    
+    def to_s
+      "https://#{@url.host}#{@url.path}?#{params_with_access_key}&Signature=#{signature}"
+    end
+    
+    private
+    
+    def normalized_params
+      params.merge!({"Expires" => expires_iso8601, "SignatureVersion" => "2", "SignatureMethod" => "HmacSHA256"})
+    end
+    
+    def expires_iso8601
+      return @expires.iso8601 if @expires.respond_to?(:iso8601)
+      return @expires if @expires
+      (Time.now + 15.seconds).iso8601
+    end
+    
+    def reserved_characters
+      %r|[^\w\d\-_\.~]+|
+    end
+    
+    def params_with_access_key
+      "AWSAccessKeyId=#{access_key_id}&#{params_string}"
+    end
+    
+  end
+end

data/lib/awsnap/version.rb

@@ -0,0 +1,3 @@
+module Awsnap
+  VERSION = "0.0.2"
+end

data/readme.md

@@ -0,0 +1,40 @@
+AWSnap!
+=======
+Ever felt like AWS libraries do to much? Like they wrap your workflow in lots of request processing, response handling and other gunk? AWSnap cuts to the chase: just give it an AWS API endpoint and some params, and it'll spit out a signed URI. You take it from there.
+
+Ever felt like AWS libraries don't do enough? They make it easy to do S3, Cloudfront, maybe some SQS. But if you wander off the path, you're on your own. AWSnap has your back: integrate any AWS API on your own, and sign requests with AWSnap.
+
+Examples
+--------
+    request = Awsnap::Request.new("https://sqs.us-east-1.amazonaws.com/", 
+                :get, 
+                {"Action" => "ListQueues", 
+                 "Version" => "2009-02-01", 
+                 :access_key_id => <Your-Access-Key-ID>, 
+                 :secret_access_key => <Your-Secret-Access-Key>, 
+                 :expires => 10.minutes.from_now}
+                )
+
+    request.to_s 
+    #=> "https://sqs.us-east-1.amazonaws.com/?AWSAccessKeyId=Your-Access-Key-ID&Action=ListQueues&Expires=2011-06-15T10%3A21%3A27-07%3A00&SignatureMethod=HmacSHA256&SignatureVersion=2&Version=2009-02-01&Signature=CrazySignatureMadnessHere"
+
+Alternatives
+------------
+If you're looking for a library that does a little more, these are great:
+
+* [aws-s3](https://github.com/marcel/aws-s3)
+* [RightAWS](https://github.com/rightscale/right_aws)  
+* [Happening](https://github.com/peritor/happening)
+* [Fog](https://github.com/geemus/fog)
+
+Copyright
+---------
+(The MIT License)
+
+Copyright © 2011 (Scott Burton)
+
+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/spec/request_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+include Awsnap
+
+describe Request do
+  
+  before(:each) do
+    time = Time.utc(2012, 7, 15, 13, 27)
+    Time.stub(:now).and_return(time)
+  end
+  
+  describe "query string parameters" do
+    subject {Request.new("url.example.foo", :get, params)}
+
+    describe "normalizing the expires param" do
+      context "when the expires param is a Ruby Time object" do
+        let(:params) {{:expires => Time.utc(2012, 7, 15, 13, 27), :other => "Params"}}
+        it "converts the date to ISO8601 representation" do
+          subject.send(:expires_iso8601).should eql("2012-07-15T13:27:00Z")
+        end
+      end
+      
+      context "when the expires param is a String" do
+        let(:params) {{:expires => "2012-07-15T13:27:00Z", :other => "Params"}}
+        it "passes the date through" do
+          subject.send(:expires_iso8601).should eql("2012-07-15T13:27:00Z")
+        end
+      end
+      
+      context "when the expires param is missing" do
+        let(:params) {{:other => "Params"}}
+        it "generates an expires param fifteen seconds from now" do
+          subject.send(:expires_iso8601).should eql("2012-07-15T13:27:15Z")
+        end
+      end
+    end
+
+    context "when the params contain unreserved characters" do
+      # These unreserved characters are A-Z, a-z, 0-9, hyphen ( - ), underscore ( _ ), period ( . ), and tilde ( ~ ).
+      let(:params) {{"one-POW" => "two", "Three" => "four.omg~heloooo", "five" => "six~seven~eight"}}
+      
+      its(:canonicalized_params) {
+        should eql [["Expires", "2012-07-15T13%3A27%3A15Z"], ["SignatureMethod", "HmacSHA256"], ["SignatureVersion", "2"], ["Three", "four.omg~heloooo"], ["five", "six~seven~eight"], ["one-POW", "two"]]
+      }
+      
+      its(:params_string) {
+        should eql "Expires=2012-07-15T13%3A27%3A15Z&SignatureMethod=HmacSHA256&SignatureVersion=2&Three=four.omg~heloooo&five=six~seven~eight&one-POW=two"
+      }
+    end
+    
+    context "when the params contain reserved characters" do
+      let(:params) {{"POW!" => "Frazz!!*", "Bam!" => "Bibim bap (Korean pancake)", "Ammount" => "$21.67"}}
+      
+      its(:canonicalized_params) {
+        should eql [["Ammount", "%2421.67"], ["Bam%21", "Bibim%20bap%20%28Korean%20pancake%29"], ["Expires", "2012-07-15T13%3A27%3A15Z"], ["POW%21", "Frazz%21%21%2A"], ["SignatureMethod", "HmacSHA256"], ["SignatureVersion", "2"]]
+      }
+      
+      its(:params_string) {
+        should eql "Ammount=%2421.67&Bam%21=Bibim%20bap%20%28Korean%20pancake%29&Expires=2012-07-15T13%3A27%3A15Z&POW%21=Frazz%21%21%2A&SignatureMethod=HmacSHA256&SignatureVersion=2"
+      }
+    end
+  end
+  
+  describe "AWS credentials" do
+    subject {Request.new("some.example.url", :get, params)}
+    let(:params) {{:access_key_id => "1234567890", :secret_access_key => "123456789012", :some => "other", :params => "here"}}
+    its(:access_key_id) {should eql("1234567890")}
+    its(:secret_access_key) {should eql("123456789012")}
+  end
+  
+  describe "implicit verb" do
+    subject {Request.new("http://some.example.url", {:some => "params"})}
+    its(:verb) {should be :get}
+  end
+  
+  describe "signing" do
+    subject {Request.new(url, verb, params)}
+    let(:verb) {:get}
+    let(:url)  {"https://sqs.us-east-1.amazonaws.com/770098461991/queue2"}
+    let(:params) {{:access_key_id => "1234567890", :secret_access_key => "123456789012", "POW!" => "Frazz!!*", "Bam!" => "Bibim bap (Korean pancake)", "Ammount" => "$21.67"}}
+    
+    its(:string_to_sign) {should eql %Q{GET\nsqs.us-east-1.amazonaws.com\n/770098461991/queue2\nAWSAccessKeyId=1234567890&Ammount=%2421.67&Bam%21=Bibim%20bap%20%28Korean%20pancake%29&Expires=2012-07-15T13%3A27%3A15Z&POW%21=Frazz%21%21%2A&SignatureMethod=HmacSHA256&SignatureVersion=2}}
+    its(:hmac_signature) {should eql %Q{\xFC\x8E%\xA7\x84[\xA8\xC6\xF4M\x91=\xEF\eZ$m\xB9MPu\xD7\x80\xE6\x97\xE5\x87\xE9\xB9\xD9\x95\xD3}}
+    its(:signature)      {should eql %Q{%2FI4lp4RbqMb0TZE97xtaJG25TVB114Dml%2BWH6bnZldM%3D}}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift(".").unshift("../lib")
+require 'rubygems'
+require 'rspec'
+require 'awsnap'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: awsnap
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Scott Burton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: AWSnap signs your AWS requests for you. No request processing, no response handling, no extra nonsense. Works for all AWS endpoints.
+email: 
+- scott.burton@chaione.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- awsnap.gemspec
+- lib/awsnap.rb
+- lib/awsnap/request.rb
+- lib/awsnap/version.rb
+- readme.md
+- spec/request_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.chaione.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: awsnap
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: AWSnap signs your AWS requests for you.
+test_files: 
+- spec/request_spec.rb
+- spec/spec_helper.rb