azure-signature 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88506245b215c239f08a1c85f3970c1ae0b0aa61
-  data.tar.gz: 9ebc3da7b6ccd44d3004e44dd3e4d49fa8a71a00
+  metadata.gz: d7a1b158412c4274214bec5787766675894710b2
+  data.tar.gz: be496da96d1f71a5f51d458c2a17dff98f0cba2d
 SHA512:
-  metadata.gz: 5fdb546f7a4af2496b7e902aedcdd4ee5b0d6bb069f9eef1b99bd75731158de052fb90374d7d3dd10e5d70a9a66e19b003a9701213b5bec48cf80522e1ec48da
-  data.tar.gz: b76a9ba3cfa945e8932dba42ec3d00854972fe867b9bc5990d9c58be461f631ce2384db1d0b333108b1f4ce2055d2f0b6e4f7f66a0cee0516bdb33e2baa64669
+  metadata.gz: 755801a587abb2d6e700da4efd375da537944aced3638102aeae7c495aa6592a1650ea920a4ce859a0d3bcad2ae05fef6b173c4a42837dbe6cd4917bc5cb4886
+  data.tar.gz: d7bd143b29cdaafa758475a7576c990826049efdcf451ebe24d7692dad7a0adadc31001ff009fdd04e6d02b1a56e78254b9ef2e07c39f5e8604ce8a50b528bc7

data/CHANGES

@@ -1,3 +1,8 @@
+= 0.2.1 - 13-June-2016
+* The signature methods now accept standard header strings as key arguments
+  as well as symbols, e.g. 'auth-type' vs :auth_type.
+* Replaced URI with Addressable::URI since it's more robust.
+
 = 0.2.0 - 13-Oct-2015
 * Added support for other types of signatures (blobs, queues, files).
 * The :auth_string argument no longer returns the word "Authorization".

data/README

@@ -26,7 +26,7 @@
   azure-sdk-for-ruby project.
 
 = Copyright
-   Copyright (c) 2015, Daniel J. Berger.
+   Copyright (c) 2015-2016, Daniel J. Berger.
    All rights reserved.
 
 = License

data/azure-signature.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |gem|
   gem.name      = 'azure-signature'
-  gem.version   = '0.2.0'
+  gem.version   = '0.2.1'
   gem.author    = 'Daniel J. Berger'
   gem.license   = 'Apache 2.0'
   gem.email     = 'djberg96@gmail.com'
@@ -13,6 +13,7 @@ Gem::Specification.new do |gem|
 
   gem.extra_rdoc_files = ['README', 'CHANGES', 'MANIFEST']
    
+  gem.add_dependency('addressable')
   gem.add_development_dependency('test-unit')
 
   gem.description = <<-EOF

data/lib/azure/signature.rb

@@ -1,4 +1,4 @@
-require 'uri'
+require 'addressable'
 require 'openssl'
 require 'base64'
 require 'cgi'
@@ -9,7 +9,7 @@ module Azure
   # The Signature class encapsulates an canonicalized resource string.
   class Signature
     # The version of the azure-signature library.
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
 
     # The resource (URL) passed to the constructor.
     attr_reader :resource
@@ -37,10 +37,10 @@ module Azure
     #
     def initialize(resource, key)
       @resource = resource
-      @uri = URI.parse(resource)
+      @uri = Addressable::URI.parse(resource)
       @account_name = @uri.host.split(".").first.split("-").first
       @key = Base64.strict_decode64(key)
-      @canonical_resource = canonicalize_resource(resource)
+      @canonical_resource = canonicalize_resource(@uri)
     end
 
     # Generate a signature for use with the table service. Use the +options+
@@ -54,16 +54,21 @@ module Azure
     # - :auth_string. If true, prepends the auth_type + account name to the
     #    result and returns a string. The default is false.
     #
+    # You may also use the string forms as keys, e.g. "Auth-Type" instead of
+    # :auth_type, if you prefer.
+    #
     # The result is a digest string that you can use as an authorization header
     # for future http requests to (presumably) Azure storage endpoints.
     #
     def table_signature(options = {})
-      auth_type = options[:auth_type] || 'SharedKey'
-      verb = options[:verb] || 'GET'
-      date = options[:date] || Time.now.httpdate
-      auth_string = options[:auth_string] || false
-      content_md5 = options[:content_md5] || options['Content-MD5']
-      content_type = options[:content_type] || options['Content-Type']
+      options.clone.each{ |k,v| options[k.to_s.downcase.tr('_', '-')] = v }
+
+      auth_type    = options['auth-type'] || 'SharedKey'
+      verb         = options['verb'] || 'GET'
+      date         = options['date'] || Time.now.httpdate
+      auth_string  = options['auth-string'] || false
+      content_md5  = options['content-md5']
+      content_type = options['content-type']
 
       unless ['SharedKey', 'SharedKeyLight'].include?(auth_type)
         raise ArgumentError, "auth type must be SharedKey or SharedKeyLight"
@@ -93,6 +98,9 @@ module Azure
     # - :auth_string. If true, prepends the auth_type + account name to the
     #    result and returns a string. The default is false.
     #
+    # You may also use the string forms as keys, e.g. "Auth-Type" instead of
+    # :auth_type, if you prefer.
+    #
     # The other headers of potential significance are below. Note that you
     # are not required to set any of them.
     #
@@ -131,7 +139,7 @@ module Azure
     #  }
     #
     #  sig = sig.blob_signature(headers)
-    # headers['Authorization'] = sig
+    #  headers['Authorization'] = sig
     #
     #  req = RestClient::Request.new(
     #    :method => 'get',
@@ -139,23 +147,25 @@ module Azure
     #    :headers => headers
     #  )
     #
-    # response = req.execute
-    # p response.body
+    #  response = req.execute
+    #  p response.body
     #
     def blob_signature(headers = {})
-      auth_string = headers.delete(:auth_string) || false
-      auth_type = headers.delete(:auth_type) || 'SharedKey'
-      verb = headers.delete(:verb) || 'GET'
+      headers.clone.each{ |k,v| headers[k.to_s.downcase.tr('_', '-')] = v }
+
+      auth_string = headers.delete('auth-string') || false
+      auth_type   = headers.delete('auth_type') || 'SharedKey'
+      verb        = headers.delete('verb') || 'GET'
 
       unless ['SharedKey', 'SharedKeyLight'].include?(auth_type)
         raise ArgumentError, "auth type must be SharedKey or SharedKeyLight"
       end
 
-      headers['x-ms-date'] ||= headers.delete(:x_ms_date) || Time.now.httpdate
-      headers['x-ms-version'] ||= headers.delete(:x_ms_version) || '2015-02-21'
+      headers['x-ms-date'] ||= Time.now.httpdate
+      headers['x-ms-version'] ||= '2015-02-21'
 
       if auth_type == 'SharedKeyLight'
-        headers['Date'] ||= headers['x-ms-date'] || headers[:date] || Time.now.httpdate
+        headers['date'] ||= headers['x-ms-date'] || Time.now.httpdate
       end
 
       body = generate_string(verb, headers, auth_type).encode('UTF-8')
@@ -187,31 +197,32 @@ module Azure
     private
 
     def generate_string(verb, headers, auth_type)
+      headers.clone.keys.each{ |k| headers[k.to_s.downcase] = headers[k] }
       canonical_headers = canonicalize_headers(headers)
 
       if auth_type == 'SharedKeyLight'
        [
           verb.to_s.upcase,
-          headers['Content-MD5'],
-          headers['Content-Type'],
-          headers['Date'],
+          headers['content-md5'],
+          headers['content-type'],
+          headers['date'],
           canonical_headers,
           canonical_resource
         ].join("\n")
       else
         [
           verb.to_s.upcase,
-          headers['Content-Encoding'],
-          headers['Content-Language'],
-          headers['Content-Length'],
-          headers['Content-MD5'],
-          headers['Content-Type'],
-          headers['Date'],
-          headers['If-Modified-Since'],
-          headers['If-Match'],
-          headers['If-None-Match'],
-          headers['If-Unmodified-Since'],
-          headers['Range'],
+          headers['content-encoding'],
+          headers['content-language'],
+          headers['content-length'],
+          headers['content-md5'],
+          headers['content-type'],
+          headers['date'],
+          headers['if-modified-since'],
+          headers['if-match'],
+          headers['if-none-match'],
+          headers['if-unmodified-since'],
+          headers['range'],
           canonical_headers,
           canonical_resource,
         ].join("\n")
@@ -222,7 +233,7 @@ module Azure
     #--
     # Borrowed from azure-sdk-for-ruby. I had my own, but this was nicer.
     #
-    def canonicalize_resource(url)
+    def canonicalize_resource(uri)
       resource = '/' + account_name + (uri.path.empty? ? '/' : uri.path)
       params = CGI.parse(uri.query.to_s).map { |k,v| [k.downcase, v] }
       params.sort_by! { |k,v| k }
@@ -236,7 +247,7 @@ module Azure
     #
     def canonicalize_headers(headers)
       headers = headers.map { |k,v| [k.to_s.gsub('_', '-').downcase, v] }
-      headers.select! { |k,v| k =~ /^x-ms-/ }
+      headers.select! { |k,v| k =~ /^x-ms-/i }
       headers.sort_by! { |k,v| k }
       headers.map! { |k,v| '%s:%s' % [k, v] }
       headers.map! { |h| h.gsub(/\s+/, ' ') }.join("\n")

data/test/test_signature.rb

@@ -9,7 +9,7 @@ class TC_Azure_Signature < Test::Unit::TestCase
   end
 
   test "version constant is set to expected value" do
-    assert_equal("0.2.0", Azure::Signature::VERSION)
+    assert_equal("0.2.1", Azure::Signature::VERSION)
   end
 
   test "key method basic functionality" do
@@ -34,7 +34,7 @@ class TC_Azure_Signature < Test::Unit::TestCase
 
   test "uri method basic functionality" do
     assert_respond_to(@sig, :uri)
-    assert_kind_of(URI, @sig.uri)
+    assert_kind_of(Addressable::URI, @sig.uri)
   end
 
   test "canonical_resource method basic functionality" do
@@ -95,6 +95,13 @@ class TC_Azure_Signature < Test::Unit::TestCase
     assert_alias_method(@sig, :blob_signature, :queue_signature)
   end
 
+  test "signature with strings or symbols is identical" do
+    date = '2016-01-01'
+    sig_symbol = @sig.signature(:table, :auth_string => true, :date => date, :verb => 'PUT')
+    sig_string = @sig.signature(:table, 'Auth-String' => true, 'Date' => date, 'Verb' => 'PUT')
+    assert_equal(sig_symbol, sig_string)
+  end
+
   def teardown
     @key = nil
     @url = nil

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: azure-signature
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Generate authentication signatures for Azure