aws-url 0.1.1 → 0.2.0

data/README.md

@@ -2,18 +2,10 @@
 
 [![travis][status]][travis]
 
-A minimum-viable URL builder for [Amazon Web Services (AWS)][aws].
-
-![bezos][bezos]
-
-[Vacuum][vacuum] and [Peddler][peddler] use AWS URL.
-
-[Fog][fog] doesn't.
+AWS URL is a minimum-viable URL builder for [Amazon Web Services (AWS)][aws]
+API queries. It signs requests with [Signature Version 2][sign].
 
 [status]:  https://secure.travis-ci.org/hakanensari/aws-url.png
 [travis]:  http://travis-ci.org/hakanensari/aws-url
 [aws]:     http://aws.amazon.com/
-[vacuum]:  https://github.com/hakanensari/vacuum
-[peddler]: https://github.com/hakanensari/peddler
-[fog]:     https://github.com/fog/fog
-[bezos]:   http://www.wired.com/images/article/magazine/1605/mf_amazon_f.jpg
+[sign]:    http://docs.amazonwebservices.com/general/latest/gr/signature-version-2.html

data/aws-url.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ['Hakan Ensari']
   gem.email         = ['hakan.ensari@papercavalier.com']
   gem.description   = %q{A minimum-viable URL builder for Amazon Web Services (AWS)}
-  gem.summary       = %q{Builds an Amazon Web Services URL}
+  gem.summary       = %q{Signs an Amazon Web Services URL}
   gem.homepage      = 'https://github.com/hakanensari/aws-url'
 
   gem.files         = `git ls-files`.split($\)
@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = AWS::URL::VERSION
 
-  gem.add_development_dependency 'rake',     '~> 0.9'
-  gem.add_development_dependency 'rspec',    '~> 2.9'
+  gem.add_development_dependency 'rake',  '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.9'
 end

data/lib/aws/url.rb

@@ -1,63 +1,57 @@
+# Standard library dependencies.
 require 'base64'
 require 'openssl'
 require 'time'
 require 'uri'
 
+# Internal dependencies.
+require 'aws/url/signature'
+
 module AWS
   # A Signed Amazon Web Services (AWS) URL.
   #
-  # Currently supports Signature Version 2.
-  #
-  # Note to self: Do not touch this code unless you have a compelling reason.
+  # Supports Signature Version 2.
   class URL
-    # The SHA256 hash algorithm.
-    SHA256 = OpenSSL::Digest::SHA256.new
+    UNRESERVED = /([^\w.~-]+)/
 
     # Initializes a new URL.
     #
     # base_url - The String base URL, including scheme, host and path, of the
     #            AWS endpoint.
+    # action   - The String-like HTTP action.
     # key      - The String AWS access key id.
     # secret   - The String AWS secret key.
-    def initialize(base_url, key, secret)
+    def initialize(base_url, action, key, secret)
       @base_url = URI base_url
+      @action   = action.to_s.upcase
       @key      = key
       @secret   = secret
       @params   = {}
     end
 
-    # Builds a signed URL for specified HTTP method.
-    #
-    # method - A String-like HTTP method.
-    #
-    # Returns a String URL.
-    def build(method)
-      # Build an unsigned query string.
-      query = params.sort.map { |k, v| "#{k}=#{ percent_encode v }" }.join '&'
-
-      # Build the signature.
-      string_to_sign = [
-        method.to_s.upcase,
-        @base_url.host,
-        @base_url.path,
-        query
-      ].join "\n"
-      signature = sign string_to_sign
-
-      "#{@base_url}?#{query}&Signature=#{percent_encode signature}"
-    end
-
     # Returns the Hash AWS parameters.
     def params
       default_params.merge @params
     end
 
+    # Returns the signed query String.
+    def query
+      "#{unsigned_query}&Signature=#{escape signature}"
+    end
+
+    # Returns the signed URL String.
+    def to_s
+      "#{@base_url}?#{query}"
+    end
+
     # Updates the AWS parameters.
     #
     # hash - A Hash.
     #
     # Returns self.
     def update(hash)
+      @unsigned_query = nil
+
       hash.each do |key, val|
         # Syntactic sugar: Camelize symbol keys.
         if key.is_a? Symbol
@@ -71,12 +65,6 @@ module AWS
 
     private
 
-    def percent_encode(value)
-      value.to_s.gsub(/([^\w.~-]+)/) do
-        '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
-      end
-    end
-
     def default_params
       {
         'AWSAccessKeyId'   => @key,
@@ -86,9 +74,28 @@ module AWS
       }
     end
 
-    def sign(message)
-      digest = OpenSSL::HMAC.digest SHA256, @secret, message
-      Base64.encode64(digest).chomp
+    def escape(value)
+      value.to_s.gsub(UNRESERVED) do
+        '%' + $1.unpack('H2' * $1.bytesize).join('%').upcase
+      end
+    end
+
+    def signature
+      Signature.build @secret, string_to_sign
+    end
+
+    def string_to_sign
+      [
+        @action,
+        @base_url.host,
+        @base_url.path,
+        unsigned_query
+      ].join "\n"
+    end
+
+    def unsigned_query
+      @unsigned_query ||=
+        params.map { |k, v| "#{k}=#{ escape v }" }.sort.join '&'
     end
   end
 end

data/lib/aws/url/signature.rb

@@ -0,0 +1,31 @@
+module AWS
+  class URL
+    # Internal: A signature builder.
+    class Signature
+      SHA256 = OpenSSL::Digest::SHA256.new
+
+      # Builds a signature.
+      #
+      # secret  - A String AWS secret key.
+      # message - The String to sign.
+      #
+      # Returns a String signature.
+      def self.build(secret, message)
+        new(secret, message).build
+      end
+
+      def initialize(secret, message)
+        @secret  = secret
+        @message = message
+      end
+
+      def build
+        Base64.encode64(digest).chomp
+      end
+
+      def digest
+        OpenSSL::HMAC.digest SHA256, @secret, @message
+      end
+    end
+  end
+end

data/lib/aws/url/version.rb

@@ -1,5 +1,5 @@
 module AWS
   class URL
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/spec/aws/url_spec.rb

@@ -2,41 +2,48 @@ require 'spec_helper'
 
 module AWS
   describe URL do
-
     before do
       @base_url = 'http://example.com/path'
-      @url = URL.new @base_url, 'key', 'secret'
-    end
-
-    describe '#build' do
-      subject { @url.build :get }
-
-      it 'includes the base URL' do
-        should { include @base_url }
-      end
-
-      it 'is signed' do
-        should { match /Signature=[^&]+$/ }
-      end
+      @url = URL.new @base_url, :get, 'key', 'secret'
     end
 
     describe '#params' do
       subject { @url.params }
 
       it 'includes a key' do
-        should { include 'AWSAccessKeyId' }
+        should include 'AWSAccessKeyId'
       end
 
       it 'includes a signature version' do
-        should { include 'SignatureVersion' }
+        should include 'SignatureVersion'
       end
 
       it 'includes a signature method' do
-        should { include 'SignatureMethod' }
+        should include 'SignatureMethod'
       end
 
       it 'includes a timestamp' do
-        should { include 'Timestamp' }
+        should include 'Timestamp'
+      end
+    end
+
+    describe '#query' do
+      subject { @url.query }
+
+      it 'is signed' do
+        should match /Signature=[^&]+$/
+      end
+    end
+
+    describe '#to_s' do
+      subject { @url.to_s }
+
+      it 'includes the base URL' do
+        should include @base_url
+      end
+
+      it 'includes the signed query' do
+        should include @url.query
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-url
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-23 00:00:00.000000000 Z
+date: 2012-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70339646668100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70339646668100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70339646667600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +37,12 @@ dependencies:
         version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *70339646667600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
 description: A minimum-viable URL builder for Amazon Web Services (AWS)
 email:
 - hakan.ensari@papercavalier.com
@@ -49,6 +59,7 @@ files:
 - aws-url.gemspec
 - lib/aws-url.rb
 - lib/aws/url.rb
+- lib/aws/url/signature.rb
 - lib/aws/url/version.rb
 - spec/aws/url_spec.rb
 - spec/spec_helper.rb
@@ -72,10 +83,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Builds an Amazon Web Services URL
+summary: Signs an Amazon Web Services URL
 test_files:
 - spec/aws/url_spec.rb
 - spec/spec_helper.rb