cloudfront-signer 2.2.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af2fd7402de3304dcebf5c73545b34f34a4bd793
-  data.tar.gz: 1758268e87d18ecaca43588ca03b34a0bd00e7a6
+  metadata.gz: 7a0cf4a0946130dcbaa507daefb6eeee51d8c7b1
+  data.tar.gz: 9f888e920595b5638d8c8848b5c280c0e803d612
 SHA512:
-  metadata.gz: 61d635f44898c5ad71c2dad0a75c475f0307c8dd7f16b7e14e58ee789552c60e312ebe8dbf9e5cfe926db34356fc208ba57b4270b5f106dcdd8e03990e89b0b7
-  data.tar.gz: 779f86267e2e7027a28ce2ff11629349f325cac5d608065b914cc72b9fc42407d8fa99c7ad77414820ccfcfc840d1b2cb254de7691c1677d1c06608eefca40b8
+  metadata.gz: ce452e3fbb10b51f05a2c1429c7f3796874b8389ea06a76b3f3a21f1499a5fab020f34e0c1a90f3ae9e32200fbe17e03a71af91c4ee72daa46bc7634f1a0ac38
+  data.tar.gz: 11e787dc898b982519f89dbaff55ae46a8e44f2fbebb63e2c2a8f7fa3012b4d53785ca44c6011cf97ae52e7d81275f40a278f65bf902929f00ac78cb7f46522c

data/ChangeLog.markdown

@@ -1,5 +1,6 @@
-### 2.2.1 / 2015-04-29
-* Fixes policy generation when specifying an ip_range. See https://github.com/leonelgalan/cloudfront-signer/commit/18b19cc2f833850f360a92f4e244358601bba5ec#commitcomment-11249140 for details.
+### 3.0.0 / 2015-03-14
+* Renames namespace to `Aws`. Matches used by latest _https://github.com/aws/aws-sdk-ruby_. Change proposed by https://github.com/tennantje
+* Renames `sign` to `build_url` to better communicate method intent.
 
 ### 2.2.0 / 2015-04-29
 * Accepted merge request from https://github.com/leonelgalan - `sign_params` method returns raw params to be used in urls or cookies.

data/README.markdown

@@ -27,7 +27,7 @@ and customizing the resulting _config/initializers/cloudfront-signer.rb_ file.
 ### Generated _cloudfront-signer.rb_
 
 ```ruby
-AWS::CF::Signer.configure do |config|
+Aws::CF::Signer.configure do |config|
   config.key_path = '/path/to/keyfile.pem'
   # config.key = ENV.fetch('PRIVATE_KEY') # key_path not required if key supplied directly
   config.key_pair_id  = 'XXYYZZ'
@@ -40,42 +40,30 @@ end
 Call the class `sign_url` or `sign_path` method with optional policy settings.
 
 ```ruby
-AWS::CF::Signer.sign_url 'http://mydomain/path/to/my/content'
+Aws::CF::Signer.sign_url 'http://mydomain/path/to/my/content'
 ```
 
-or
-
 ```ruby
-AWS::CF::Signer.sign_url 'http://mydomain/path/to/my/content', expires: Time.now + 600
+Aws::CF::Signer.sign_path 'path/to/my/content', expires: Time.now + 600
 ```
 
-Streaming paths can be signed with the `sign_path` method.
 
-```ruby
-AWS::CF::Signer.sign_path 'path/to/my/content'
-```
-
-or
+Both `sign_url` and `sign_path` have _safe_ versions that HTML encode the result allowing signed paths or urls to be placed in HTML markup. The 'non'-safe versions can be used for placing signed urls or paths in JavaScript blocks or Flash params.
 
-```ruby
-AWS::CF::Signer.sign_path 'path/to/my/content', expires: Time.now + 600
-```
+___
 
-Raw parameters can be get with the `signed_params` method. See [commit message](https://github.com/leonelgalan/cloudfront-signer/commit/fedcc3182e32133e4bd0ad0b79c0106168896c91) for additional details.
+Call class method `signed_params` to get raw parameters. These values can be used to set signing cookies ([Serving Private Content through CloudFront: Using Signed Cookies](http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-signed-cookies.html)). See [commit message](https://github.com/leonelgalan/cloudfront-signer/commit/fedcc3182e32133e4bd0ad0b79c0106168896c91) for additional details.
 
 ```ruby
-AWS::CF::Signer.sign_params 'path/to/my/content'
+Aws::CF::Signer.signed_params 'path/to/my/content'
 ```
 
-Both `sign_url` and `sign_path` have _safe_ versions that HTML encode the result allowing signed paths or urls to be placed in HTML markup. The 'non'-safe versions can be used for placing signed urls or paths in JavaScript blocks or Flash params.
-
-
 ### Custom Policies
 
 See Example Custom Policy 1 at above AWS doc link
 
 ```ruby
-url = AWS::CF::Signer.sign_url 'http://d604721fxaaqy9.cloudfront.net/training/orientation.avi',
+url = Aws::CF::Signer.sign_url 'http://d604721fxaaqy9.cloudfront.net/training/orientation.avi',
                                expires: 'Sat, 14 Nov 2009 22:20:00 GMT',
                                resource: 'http://d604721fxaaqy9.cloudfront.net/training/*',
                                ip_range: '145.168.143.0/24'
@@ -85,7 +73,7 @@ url = AWS::CF::Signer.sign_url 'http://d604721fxaaqy9.cloudfront.net/training/or
 See Example Custom Policy 2 at above AWS doc link
 
 ```ruby
-AWS::CF::Signer.sign_url 'http://d84l721fxaaqy9.cloudfront.net/downloads/pictures.tgz',
+Aws::CF::Signer.sign_url 'http://d84l721fxaaqy9.cloudfront.net/downloads/pictures.tgz',
                          starting: 'Thu, 30 Apr 2009 06:43:10 GMT',
                          expires: 'Fri, 16 Oct 2009 06:31:56 GMT',
                          resource: 'http://*',
@@ -95,7 +83,7 @@ AWS::CF::Signer.sign_url 'http://d84l721fxaaqy9.cloudfront.net/downloads/picture
 You can also pass in a path to a policy file. This will supersede any other policy options
 
 ```ruby
-AWS::CF::Signer.sign_url 'http://d84l721fxaaqy9.cloudfront.net/downloads/pictures.tgz',
+Aws::CF::Signer.sign_url 'http://d84l721fxaaqy9.cloudfront.net/downloads/pictures.tgz',
                          policy_file: '/path/to/policy/file.txt'
 ```
 

data/cloudfront-signer.gemspec

@@ -4,7 +4,7 @@ require 'cloudfront-signer/version'
 
 Gem::Specification.new do |s|
   s.name = 'cloudfront-signer'
-  s.version = AWS::CF::VERSION
+  s.version = Aws::CF::VERSION
   s.authors = ['Anthony Bouch', 'Leonel Galan']
   s.email = ['tony@58bits.com', 'leonelgalan@gmail.com']
   s.homepage = 'http://github.com/leonelgalan/cloudfront-signer'

data/lib/cloudfront-signer.rb

@@ -6,7 +6,7 @@ require 'base64'
 require 'cloudfront-signer/version'
 require 'json'
 
-module AWS
+module Aws
   module CF
     class Signer
       # Public non-inheritable class accessors
@@ -16,7 +16,7 @@ module AWS
         #
         # Examples
         #
-        #   AWS::CF::Signer.configure do |config|
+        #   Aws::CF::Signer.configure do |config|
         #     config.key_pair_id = "XXYYZZ"
         #   end
         #
@@ -27,7 +27,7 @@ module AWS
         #
         # Examples
         #
-        #   AWS::CF::Signer.configure do |config|
+        #   Aws::CF::Signer.configure do |config|
         #     config.key_path = "/path/to/your/keyfile.pem"
         #   end
         #
@@ -46,7 +46,7 @@ module AWS
         #
         # Examples
         #
-        #   AWS::CF::Signer.configure do |config|
+        #   Aws::CF::Signer.configure do |config|
         #     config.key = ENV.fetch('KEY')
         #   end
         # Returns nothing.
@@ -64,7 +64,7 @@ module AWS
         #
         # Examples
         #
-        #   AWS::CF::Signer.configure do |config|
+        #   Aws::CF::Signer.configure do |config|
         #     config.default_expires = 3600
         #   end
         #
@@ -94,7 +94,7 @@ module AWS
       #
       # Examples
       #
-      #   AWS::CF::Signer.configure do |config|
+      #   Aws::CF::Signer.configure do |config|
       #     config.key_path = "/path/to/yourkeyfile.pem"
       #     config.key_pair_id  = "XXYYZZ"
       #     config.default_expires = 3600
@@ -132,14 +132,14 @@ module AWS
       #
       # Returns a String
       def self.sign_url(subject, policy_options = {})
-        sign subject, { remove_spaces: true }, policy_options
+        build_url subject, { remove_spaces: true }, policy_options
       end
 
       # Public: Sign a url (as above) and HTML encode the result.
       #
       # Returns a String
       def self.sign_url_safe(subject, policy_options = {})
-        sign subject, { remove_spaces: true, html_escape: true }, policy_options
+        build_url subject, { remove_spaces: true, html_escape: true }, policy_options
       end
 
       # Public: Sign a stream path part or filename (spaces are allowed in
@@ -147,23 +147,23 @@ module AWS
       #
       # Returns a String
       def self.sign_path(subject, policy_options = {})
-        sign subject, { remove_spaces: false }, policy_options
+        build_url subject, { remove_spaces: false }, policy_options
       end
 
       # Public: Sign a stream path or filename and HTML encode the result.
       #
       # Returns a String
       def self.sign_path_safe(subject, policy_options = {})
-        sign subject,
-             { remove_spaces: false, html_escape: true },
-             policy_options
+        build_url subject,
+                  { remove_spaces: false, html_escape: true },
+                  policy_options
       end
 
       # Public: Builds a signed url or stream resource name with optional
       # configuration and policy options
       #
       # Returns a String
-      def self.sign(subject, configuration_options = {}, policy_options = {})
+      def self.build_url(subject, configuration_options = {}, policy_options = {})
         # If the url or stream path already has a query string parameter -
         # append to that.
         separator = subject =~ /\?/ ? '&' : '?'

data/lib/cloudfront-signer/version.rb

@@ -1,5 +1,5 @@
-module AWS
+module Aws
   module CF
-    VERSION = '2.2.1'
+    VERSION = '3.0.0'
   end
 end

data/lib/generators/cloudfront/install/templates/cloudfront-signer.rb

@@ -1,4 +1,4 @@
-AWS::CF::Signer.configure do |config|
+Aws::CF::Signer.configure do |config|
   config.key_path = '/path/to/keyfile.pem'
   # or config.key = ENV.fetch('PRIVATE_KEY')
   config.key_pair_id  = 'XXYYZZ'

data/spec/signer_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe AWS::CF::Signer do
+describe Aws::CF::Signer do
   let(:key_pair_id) { 'APKAIKUROOUNR2BAFUUU' }
   let(:key_path) do
     File.expand_path File.dirname(__FILE__) + "/keys/pk-#{key_pair_id}.pem"
@@ -9,25 +9,25 @@ describe AWS::CF::Signer do
 
   context 'configured with key and key_pair_id' do
     before do
-      AWS::CF::Signer.configure do |config|
+      Aws::CF::Signer.configure do |config|
         config.key_pair_id = key_pair_id
         config.key = key
       end
     end
 
     it 'should be configured' do
-      expect(AWS::CF::Signer.is_configured?).to be true
+      expect(Aws::CF::Signer.is_configured?).to be true
     end
 
     it 'sets the private_key' do
-      expect(AWS::CF::Signer.send(:private_key)).to(
+      expect(Aws::CF::Signer.send(:private_key)).to(
         be_an_instance_of OpenSSL::PKey::RSA
       )
     end
 
     it 'should expire in one hour by default' do
       url = 'http://somedomain.com/sign me'
-      result = AWS::CF::Signer.sign_url(url)
+      result = Aws::CF::Signer.sign_url(url)
       expect(get_query_value(result, 'Expires').to_i).to(
         eq Time.now.to_i + 3600
       )
@@ -36,52 +36,52 @@ describe AWS::CF::Signer do
 
   context 'configured with key_path' do
     before(:each) do
-      AWS::CF::Signer.configure do |config|
+      Aws::CF::Signer.configure do |config|
         config.key_path = key_path
       end
     end
 
     describe 'before default use' do
       it 'should be configured' do
-        expect(AWS::CF::Signer.is_configured?).to be true
+        expect(Aws::CF::Signer.is_configured?).to be true
       end
 
       it 'sets the private_key' do
-        expect(AWS::CF::Signer.send(:private_key)).to(
+        expect(Aws::CF::Signer.send(:private_key)).to(
           be_an_instance_of OpenSSL::PKey::RSA
         )
       end
 
       it 'should expire urls and paths in one hour by default' do
-        expect(AWS::CF::Signer.default_expires).to eq 3600
+        expect(Aws::CF::Signer.default_expires).to eq 3600
       end
 
       it 'should optionally be configured to expire urls and paths' do
-        AWS::CF::Signer.default_expires =  600
-        expect(AWS::CF::Signer.default_expires).to eq 600
-        AWS::CF::Signer.default_expires =  nil
+        Aws::CF::Signer.default_expires =  600
+        expect(Aws::CF::Signer.default_expires).to eq 600
+        Aws::CF::Signer.default_expires =  nil
       end
     end
 
     describe 'when signing a url' do
       it 'should remove spaces from the url' do
         url = 'http://somedomain.com/sign me'
-        expect(AWS::CF::Signer.sign_url(url)).not_to match(/\s/)
+        expect(Aws::CF::Signer.sign_url(url)).not_to match(/\s/)
       end
 
       it 'should not html encode the signed url by default' do
         url = 'http://somedomain.com/someresource?opt1=one&opt2=two'
-        expect(AWS::CF::Signer.sign_url(url)).to match(/\?|=|&/)
+        expect(Aws::CF::Signer.sign_url(url)).to match(/\?|=|&/)
       end
 
       it 'should optionally html encode the signed url' do
         url = 'http://somedomain.com/someresource?opt1=one&opt2=two'
-        expect(AWS::CF::Signer.sign_url_safe(url)).not_to match(/\?|=|&/)
+        expect(Aws::CF::Signer.sign_url_safe(url)).not_to match(/\?|=|&/)
       end
 
       it 'should expire in one hour by default' do
         url = 'http://somedomain.com/sign me'
-        result = AWS::CF::Signer.sign_url(url)
+        result = Aws::CF::Signer.sign_url(url)
         expect(get_query_value(result, 'Expires').to_i).to(
           eq Time.now.to_i + 3600
         )
@@ -89,7 +89,7 @@ describe AWS::CF::Signer do
 
       it 'should optionally expire in ten minutes' do
         url = 'http://somedomain.com/sign me'
-        result = AWS::CF::Signer.sign_url(url, expires: Time.now + 600)
+        result = Aws::CF::Signer.sign_url(url, expires: Time.now + 600)
         expect(get_query_value(result, 'Expires').to_i).to(
           eq Time.now.to_i + 600
         )
@@ -99,7 +99,7 @@ describe AWS::CF::Signer do
     describe 'when signing a path' do
       it 'should not remove spaces from the path' do
         path = '/someprefix/sign me'
-        expect(AWS::CF::Signer.sign_path(path)).to match(/\s/)
+        expect(Aws::CF::Signer.sign_path(path)).to match(/\s/)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudfront-signer
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Anthony Bouch