aws-signature-v4 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01b2caa6ec91431a8e02a25b5888e97e66698ded
-  data.tar.gz: 16b5463b54621416c7337c477e7a39d76ece029e
+  metadata.gz: ae3c1b489700dd2933f7f16c5a318dd9f98bd150
+  data.tar.gz: 41b9997c128e0ad30b69faef4b993cae5e9c5f3c
 SHA512:
-  metadata.gz: 75fc4b0d62ae7c05512d1526649a68df401ecdb140de942921b540ea871f7d51bac7e37e291615d0cc0cdfa754375f457be66c4d2d8e4e131ef6609795d2ca62
-  data.tar.gz: 5238c0bc18112f0236e3edd9bb778de16ecd9f2e48d9fe4c04dcb1055a38ae550fa2e0d1e9019539edcf234b40c6c4e17b7413a1f060931dcb6ea5081efdc56b
+  metadata.gz: 209e05eba460940b734f3261fa7f03f34257149a3d8910f7c4e6cfa5ca5515eb3521ce77614aaade3a411a3579d59a801d1abf2820896cbf450f033a398b7f83
+  data.tar.gz: adacbb3ebdb9ac25d6c1da132239f891744d800480d0f6f9ddb29d442e71a510fa555c56879046ec85dc30a4f55c4d3576f457151230ab3c714d9a5b53e351ea

data/README.md

@@ -1,8 +1,8 @@
 # Aws::Signature::V4
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aws/signature/v4`. To experiment with that code, run `bin/console` for an interactive prompt.
+Executes AWS Signature Version 4 Signing Process as explained at http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html. 
 
-TODO: Delete this and the text above, and describe your gem
+The gem calculates AWS signature token and provides HTTP headers ready with authentication data.
 
 ## Installation
 
@@ -22,7 +22,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This example shows how to generate signature for DynamoDB Query API call:
+
+```
+payload = {
+    :TableName => 'my_table',
+    :IndexName => 'role-created_at-index',
+    :select => 'ALL_ATTRIBUTES',
+    'KeyConditionExpression': '#user_role = :user_role',
+    'ExpressionAttributeValues': {
+        ':user_role': {'S': 'ADMIN'}
+    },
+    :ExpressionAttributeNames => { '#user_role' => 'role'},
+    :scan_index_forward => true,
+    :ReturnConsumedCapacity => 'TOTAL'
+}
+
+aws_region = 'ap-southeast-1'
+aws_access_key_id = 'AKIAJVB3LAMUASP5JTUQ'
+aws_secret_access_key = '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'
+aws_dynamodb_endpoint = 'https://dynamodb.ap-southeast-1.amazonaws.com'
+
+# generate AWS Authorization header values
+aws_signature = Aws::Signature::V4::Signature.new(aws_region, aws_access_key_id, aws_secret_access_key)
+# parameters: service_name, amz_target, http_method, payload, host, uri
+aws_signature.generate_signature('dynamodb', 'DynamoDB_20120810.Query', 'POST', payload, aws_dynamodb_endpoint, '/')
+# Create HTTP object
+uri = URI.parse(aws_dynamodb_endpoint)
+http = Net::HTTP.new(uri.host, uri.port)
+http.use_ssl = true
+# Alternatively use aws_signature.signature to get signature token value and construct headers yourself
+request = Net::HTTP::Post.new(uri.request_uri, aws_signature.headers)
+request.body = payload.to_json
+# Send the request
+res = http.request(request)
+```
 
 ## Development
 

data/aws-signature-v4.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['khaled@supahands.com']
 
   spec.summary       = 'Executes AWS Signature Version 4 Signing Process to add authentication information to AWS requests.'
-  spec.description   = 'Executes AWS Signature Version 4 Signing Process as explained at http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html.<br>It calculates the signature token and provides HTTP headers with authentication header.'
+  spec.description   = 'Executes AWS Signature Version 4 Signing Process as explained at http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html. It calculates the signature token and provides HTTP headers with authentication data.'
   spec.homepage      = 'https://github.com/Supahands/aws-signature-v4.git'
   spec.license       = 'MIT'
 
@@ -19,18 +19,18 @@ Gem::Specification.new do |spec|
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
 end

data/lib/aws/signature/v4.rb

@@ -7,6 +7,8 @@ module Aws
       class Signature
 
         require 'json'
+        require 'digest/md5'
+        require 'openssl'
 
         # Your code goes here...
 
@@ -15,9 +17,9 @@ module Aws
         # @param [String] region  AWS region
         # @param [String] key_id  AWS user key id
         # @param [String] secret_key  AWS user secret key
-        def initialize (region, key_id, secret_key, algorithm = 'AWS4-HMAC-SHA256', content_type = 'application/x-amz-json-1.0', content_type_sign_header = 'application/x-amz-json-1.0,application/x-www-form-urlencoded')
+        def initialize (region, key_id, secret_key, algorithm: 'AWS4-HMAC-SHA256', content_type: 'application/x-amz-json-1.0', content_type_sign_header: 'application/x-amz-json-1.0,application/x-www-form-urlencoded', t: nil)
           # calculate date and time
-          @t = Time.now.utc
+          @t = t || Time.now.utc
           @date = @t.strftime('%Y%m%d')
           @time = @t.strftime('%Y%m%dT%H%M%SZ')
           # mandatory fields

data/lib/aws/signature/v4/version.rb

@@ -1,7 +1,7 @@
 module Aws
   module Signature
     module V4
-      VERSION = '0.1.0'
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-signature-v4
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - khaled83
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Executes AWS Signature Version 4 Signing Process as explained at http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html.<br>It
-  calculates the signature token and provides HTTP headers with authentication header.
+description: Executes AWS Signature Version 4 Signing Process as explained at http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html.
+  It calculates the signature token and provides HTTP headers with authentication
+  data.
 email:
 - khaled@supahands.com
 executables: []
@@ -72,6 +73,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- aws-signature-v4-0.1.0.gem
 - aws-signature-v4.gemspec
 - bin/console
 - bin/setup