cloudfront-signer 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a0cf4a0946130dcbaa507daefb6eeee51d8c7b1
-  data.tar.gz: 9f888e920595b5638d8c8848b5c280c0e803d612
+  metadata.gz: 55f3da387ee038729bfee7a3dcc7f1b250dba308
+  data.tar.gz: b514f00d64dc1d5713fe04896a9177cead4e5835
 SHA512:
-  metadata.gz: ce452e3fbb10b51f05a2c1429c7f3796874b8389ea06a76b3f3a21f1499a5fab020f34e0c1a90f3ae9e32200fbe17e03a71af91c4ee72daa46bc7634f1a0ac38
-  data.tar.gz: 11e787dc898b982519f89dbaff55ae46a8e44f2fbebb63e2c2a8f7fa3012b4d53785ca44c6011cf97ae52e7d81275f40a278f65bf902929f00ac78cb7f46522c
+  metadata.gz: d1905499e2278f379ea501f16f860829612b877b50b79835eef25b6a4840668435134bc5775eccfad7049ef123443cf4586472ca17dac23cf02d460fa3750b7d
+  data.tar.gz: 8c5470df9a7cb80dc9a05032ddb63a01ae04e3cce4f03863b45c0b3213b93ddbffa305d861c1d7d892ecf0e4eb66219052006825435dcc3ccf3fc89353c5e42f

data/.codeclimate.yml

@@ -0,0 +1,23 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  markdownlint:
+    enabled: true
+  reek:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.rb"
+exclude_paths:
+- coverage/

data/.rspec

@@ -1,3 +1,2 @@
 --colour
---drb
 --format documentation

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.2

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
 - 2.2.2
 script:
 - bundle exec rspec
+- bundle exec codeclimate-test-reporter
 addons:
   code_climate:
     repo_token: ef3c90e7b5eb13c9242a30d783ed701afa9a8514b6544d5972ca590505d2a12e

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+
+## 3.0.1 / 2017-01-20
+
+* Supports signing frozen strings. Bug reported by [@alexandermayr](https://github.com/alexandermayr).
+
+## 3.0.0 / 2015-03-14
+
+* Renames namespace to `Aws`. Matches used by latest [https://github.com/aws/aws-sdk-ruby](https://github.com/aws/aws-sdk-ruby).
+  Change proposed by [@tennantje](https://github.com/tennantje)
+* Renames `sign` to `build_url` to better communicate method intent.
+
+## 2.2.0 / 2015-04-29
+
+* Accepted merge request from [@leonelgalan](https://github.com/leonelgalan) -
+  `sign_params` method returns raw params to be used in urls or cookies.
+
+## 2.1.2 / 2015-04-16
+
+* Accepted merge request from [@tuvistavie](https://github.com/tuvistavie) -
+  fixing custom policy bug.
+
+## 2.1.1 / 2013-10-31
+
+* Added changelog file
+* Aceppted merge request from [@bullfight](https://github.com/bullfight),
+  Refactored configuration to allow for key to be passed in directly.

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cloudfront-signer.gemspec
 gemspec

data/README.md

@@ -0,0 +1,135 @@
+# cloudfront-signer
+
+[![Build Status](https://travis-ci.org/leonelgalan/cloudfront-signer.svg)](https://travis-ci.org/leonelgalan/cloudfront-signer)
+[![Code Climate](https://codeclimate.com/github/leonelgalan/cloudfront-signer/badges/gpa.svg)](https://codeclimate.com/github/leonelgalan/cloudfront-signer)
+[![Test Coverage](https://codeclimate.com/github/leonelgalan/cloudfront-signer/badges/coverage.svg)](https://codeclimate.com/github/leonelgalan/cloudfront-signer/coverage)
+[![Gem Version](https://badge.fury.io/rb/cloudfront-signer.svg)](http://badge.fury.io/rb/cloudfront-signer)
+[![Dependency Status](https://gemnasium.com/leonelgalan/cloudfront-signer.svg)](https://gemnasium.com/leonelgalan/cloudfront-signer)
+
+See the [CHANGELOG](https://github.com/leonelgalan/cloudfront-signer/blob/master/CHANGELOG.md)
+for details of this release.
+
+See Amazon docs for [Serving Private Content through CloudFront](http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/index.html?PrivateContent.html)
+
+A fork and rewrite started by [Anthony Bouch](https://github.com/58bits) of
+Dylan Vaughn's [aws_cf_signer](https://github.com/dylanvaughn/aws_cf_signer).
+
+This version uses all class methods and a configure method to set options.
+
+Separate helper methods exist for safe signing of urls and stream paths, each of
+which has slightly different requirements. For example, urls must not contain
+any spaces, whereas a stream path might. Also we might not want to html escape a
+url or path if it is being supplied to a JavaScript block or Flash object.
+
+## Installation
+
+This gem has been publised as _cloudfront-signer_. Use `gem install
+cloudfront-signer` to install this gem.
+
+The signing class must be configured - supplying the path to a signing key, or
+supplying the signing key directly as a string along with the `key_pair_id`.
+Create the initializer by running:
+
+```sh
+bundle exec rails generate cloudfront:install
+```
+
+Customize the resulting *config/initializers/cloudfront\_signer.rb* file.
+
+### Generated *cloudfront\_signer.rb*
+
+```ruby
+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'
+  config.default_expires = 3600
+end
+```
+
+## Usage
+
+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'
+```
+
+```ruby
+Aws::CF::Signer.sign_path 'path/to/my/content', expires: Time.now + 600
+```
+
+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.
+
+___
+
+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.signed_params 'path/to/my/content'
+```
+
+### 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',
+                               expires: 'Sat, 14 Nov 2009 22:20:00 GMT',
+                               resource: 'http://d604721fxaaqy9.cloudfront.net/training/*',
+                               ip_range: '145.168.143.0/24'
+```
+
+See Example Custom Policy 2 at above AWS doc link
+
+```ruby
+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://*',
+                         ip_range: '216.98.35.1/32'
+```
+
+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',
+                         policy_file: '/path/to/policy/file.txt'
+```
+
+## Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it.
+* Commit
+* Send me a pull request. Bonus points for topic branches.
+
+## Attributions
+
+Hat tip to [Anthony Bouch](https://github.com/58bits) for contributing to
+Dylan's effort. Only reading both gem's code I was able to figure out the
+signing needed for the newly introduced signed cookies.
+
+> Dylan blazed a trail here - however, after several attempts, I was unable to
+contact Dylan in order to suggest that we combine our efforts to produce a
+single gem - hence the re-write and new gem here. - _Anthony Bouch_
+
+Parts of signing code taken from a question on
+[Stack Overflow](http://stackoverflow.com/questions/2632457/create-signed-urls-for-cloudfront-with-ruby)
+asked by [Ben Wiseley](http://stackoverflow.com/users/315829/ben-wiseley), and
+answered by [Blaz Lipuscek](http://stackoverflow.com/users/267804/blaz-lipuscek)
+and [Manual M](http://stackoverflow.com/users/327914/manuel-m).
+
+## License
+
+_cloudfront-signer_ is distributed under the MIT License, portions copyright ©
+2015 Dylan Vaughn, STL, Anthony Bouch, Leonel Galán

data/cloudfront-signer.gemspec

@@ -17,11 +17,11 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
 
   s.rubyforge_project = 'cloudfront-signer'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'codeclimate-test-reporter'
+  s.add_development_dependency 'rspec', '~> 3.5'
+  s.add_development_dependency 'codeclimate-test-reporter', '>=1.0'
   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 }
+                                         .map { |f| File.basename f }
   s.require_paths = ['lib']
 end

data/lib/cloudfront-signer.rb

@@ -163,7 +163,8 @@ module Aws
       # configuration and policy options
       #
       # Returns a String
-      def self.build_url(subject, configuration_options = {}, policy_options = {})
+      def self.build_url(original_subject, configuration_options = {}, policy_options = {})
+        subject = original_subject.dup
         # 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 CF
-    VERSION = '3.0.0'
+    VERSION = '3.0.1'.freeze
   end
 end

data/lib/generators/cloudfront/install/install_generator.rb

@@ -7,8 +7,8 @@ module Cloudfront
 
     desc 'This generator creates an initializer file at config/initializers'
     def add_initializer
-      template 'cloudfront-signer.rb',
-               'config/initializers/cloudfront-signer.rb'
+      template 'cloudfront_signer.rb',
+               'config/initializers/cloudfront_signer.rb'
     end
   end
 end

data/lib/generators/cloudfront/install/templates/{cloudfront-signer.rb → cloudfront_signer.rb}

@@ -1,6 +1,6 @@
 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'
+  config.key_pair_id = 'XXYYZZ'
   config.default_expires = 3600
 end

data/spec/signer_spec.rb

@@ -1,12 +1,36 @@
 require 'spec_helper'
 
-describe Aws::CF::Signer do
+RSpec.shared_examples 'is configured' do
+  it 'is configured' do
+    expect(Aws::CF::Signer.is_configured?).to be true
+  end
+
+  it 'sets the private_key' do
+    expect(Aws::CF::Signer.send(:private_key)).to(
+      be_an_instance_of(OpenSSL::PKey::RSA)
+    )
+  end
+end
+
+RSpec.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"
   end
   let(:key) { File.readlines(key_path).join '' }
 
+  describe 'defaults' do
+    it 'expire urls and paths in one hour by default' do
+      expect(Aws::CF::Signer.default_expires).to eq 3600
+    end
+
+    it 'expires when specified' do
+      Aws::CF::Signer.default_expires = 600
+      expect(Aws::CF::Signer.default_expires).to eq 600
+      Aws::CF::Signer.default_expires = nil
+    end
+  end
+
   context 'configured with key and key_pair_id' do
     before do
       Aws::CF::Signer.configure do |config|
@@ -15,90 +39,50 @@ describe Aws::CF::Signer do
       end
     end
 
-    it 'should be configured' do
-      expect(Aws::CF::Signer.is_configured?).to be true
-    end
-
-    it 'sets the private_key' do
-      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)
-      expect(get_query_value(result, 'Expires').to_i).to(
-        eq Time.now.to_i + 3600
-      )
-    end
+    include_examples 'is configured'
   end
 
   context 'configured with key_path' do
     before(:each) do
-      Aws::CF::Signer.configure do |config|
-        config.key_path = key_path
-      end
+      Aws::CF::Signer.configure { |config| config.key_path = key_path }
     end
 
     describe 'before default use' do
-      it 'should be configured' do
-        expect(Aws::CF::Signer.is_configured?).to be true
-      end
-
-      it 'sets the private_key' do
-        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
-      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
-      end
+      include_examples 'is configured'
     end
 
     describe 'when signing a url' do
-      it 'should remove spaces from the url' do
+      it "doesn't modifies the passed url" do
+        url = 'http://somedomain.com/sign'.freeze
+        expect(Aws::CF::Signer.sign_url(url)).not_to match(/\s/)
+      end
+
+      it 'removes spaces' do
         url = 'http://somedomain.com/sign me'
         expect(Aws::CF::Signer.sign_url(url)).not_to match(/\s/)
       end
 
-      it 'should not html encode the signed url by default' do
+      it "doesn't 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(/\?|=|&/)
       end
 
-      it 'should optionally html encode the signed url' do
+      it 'HTML encodes the signed url when using sign_url_safe' do
         url = 'http://somedomain.com/someresource?opt1=one&opt2=two'
         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)
-        expect(get_query_value(result, 'Expires').to_i).to(
-          eq Time.now.to_i + 3600
-        )
-      end
-
-      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)
-        expect(get_query_value(result, 'Expires').to_i).to(
-          eq Time.now.to_i + 600
-        )
+      it 'expires when specified inline' do
+        url = 'http://somedomain.com/sign'
+        signed_url = Aws::CF::Signer.sign_url(url, expires: Time.now + 600)
+        expires_value = get_query_value(signed_url, 'Expires').to_i
+        expect(expires_value).to eq(Time.now.to_i + 600)
       end
     end
 
     describe 'when signing a path' do
-      it 'should not remove spaces from the path' do
-        path = '/someprefix/sign me'
+      it "doesn't remove spaces" do
+        path = '/prefix/sign me'
         expect(Aws::CF::Signer.sign_path(path)).to match(/\s/)
       end
     end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -7,14 +7,16 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'cloudfront-signer'
 
-def get_query_value(url, key)
-  query_string = url.slice((url =~ /\?/) + 1..-1)
-  pairs = query_string.split('&')
-  pairs.each do |item|
-    return item.split('=')[1] if item.start_with?(key)
+module URLHelpers
+  def get_query_value(url, key)
+    query_string = url.slice((url =~ /\?/) + 1..-1)
+    pairs = query_string.split('&')
+    pairs.each do |item|
+      return item.split('=')[1] if item.start_with?(key)
+    end
   end
 end
 
-RSpec.configure do |_config|
-
+RSpec.configure do |config|
+  config.include URLHelpers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudfront-signer
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Anthony Bouch
@@ -9,36 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: A gem to sign url and stream paths for Amazon CloudFront private content.
   Includes specific signing methods for both url and streaming paths, including html
   'safe' escaped versions of each.
@@ -49,19 +49,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
-- ChangeLog.markdown
+- CHANGELOG.md
 - Gemfile
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - cloudfront-signer.gemspec
 - lib/cloudfront-signer.rb
 - lib/cloudfront-signer/version.rb
 - lib/generators/cloudfront/install/install_generator.rb
-- lib/generators/cloudfront/install/templates/cloudfront-signer.rb
+- lib/generators/cloudfront/install/templates/cloudfront_signer.rb
 - spec/keys/pk-APKAIKUROOUNR2BAFUUU.pem
 - spec/keys/rsa-APKAIKUROOUNR2BAFUUU.pem
 - spec/signer_spec.rb
@@ -86,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: cloudfront-signer
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A gem to sign url and stream paths for Amazon CloudFront private content.
@@ -95,4 +97,3 @@ test_files:
 - spec/keys/rsa-APKAIKUROOUNR2BAFUUU.pem
 - spec/signer_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/ChangeLog.markdown

@@ -1,13 +0,0 @@
-### 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.
-
-### 2.1.2 / 2015-04-16
-* Accepted merge request from https://github.com/tuvistavie - fixing custom policy bug.
-
-### 2.1.1 / 2013-10-31
-* Added changelog file
-* Aceppted merge request from https://github.com/bullfight, Refactored configuration to allow for key to be passed in directly.

data/README.markdown

@@ -1,107 +0,0 @@
-# cloudfront-signer [![Build Status](https://travis-ci.org/leonelgalan/cloudfront-signer.svg)](https://travis-ci.org/leonelgalan/cloudfront-signer) [![Code Climate](https://codeclimate.com/github/leonelgalan/cloudfront-signer/badges/gpa.svg)](https://codeclimate.com/github/leonelgalan/cloudfront-signer) [![Test Coverage](https://codeclimate.com/github/leonelgalan/cloudfront-signer/badges/coverage.svg)](https://codeclimate.com/github/leonelgalan/cloudfront-signer/coverage) [![Gem Version](https://badge.fury.io/rb/cloudfront-signer.svg)](http://badge.fury.io/rb/cloudfront-signer) [![Dependency Status](https://gemnasium.com/leonelgalan/cloudfront-signer.svg)](https://gemnasium.com/leonelgalan/cloudfront-signer)
-
-See the [ChangeLog](https://github.com/58bits/cloudfront-signer/blob/master/ChangeLog.markdown) for details of this release.
-
-See Amazon docs for [Serving Private Content through CloudFront](http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/index.html?PrivateContent.html)
-
-A fork and rewrite started by [Anthony Bouch](https://github.com/58bits) of Dylan Vaughn's [aws_cf_signer](https://github.com/stlondemand/aws_cf_signer).
-
-This version uses all class methods and a configure method to set options.
-
-Seperate helper methods exist for safe signing of urls and stream paths, each of which has slightly different requirements. For example, urls must not contain any spaces, whereas a stream path can. Also we might not want to html escape a url or path if it is being supplied to a JavaScript block or Flash object.
-
-## Installation
-
-This gem has been publised as `cloudfront-signer`. Use `gem install cloudfront-signer` to install this gem.
-
-Alternatively, place a copy of cloudfront-signer.rb (and the cloundfront-signer sub directory) in your lib directory.
-
-In either case the signing class must be configured - supplying the path to a signing key, or supplying the signing key directly as a string along with the `key_pair_id`. Create the initializer by running:
-
-```sh
-bundle exec rails generate cloudfront:install
-```
-
-and customizing the resulting _config/initializers/cloudfront-signer.rb_ file.
-
-### Generated _cloudfront-signer.rb_
-
-```ruby
-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'
-  config.default_expires = 3600
-end
-```
-
-## Usage
-
-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'
-```
-
-```ruby
-Aws::CF::Signer.sign_path 'path/to/my/content', expires: Time.now + 600
-```
-
-
-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.
-
-___
-
-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.signed_params 'path/to/my/content'
-```
-
-### 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',
-                               expires: 'Sat, 14 Nov 2009 22:20:00 GMT',
-                               resource: 'http://d604721fxaaqy9.cloudfront.net/training/*',
-                               ip_range: '145.168.143.0/24'
-)
-```
-
-See Example Custom Policy 2 at above AWS doc link
-
-```ruby
-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://*',
-                         ip_range: '216.98.35.1/32'
-```
-
-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',
-                         policy_file: '/path/to/policy/file.txt'
-```
-
-## Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it.
-* Commit
-* Send me a pull request. Bonus points for topic branches.
-
-## Attributions
-Hat tip to [Anthony Bouch](https://github.com/58bits) for contributing to Dylan's effort. Only reading both gem's code I was able to figure out the signing needed for the newly introduced signed cookies.
-
-> Dylan blazed a trail here - however, after several attempts, I was unable to contact Dylan in order to suggest that we combine our efforts to produce a single gem - hence the re-write and new gem here. - **Anthony Bouch**
-
-Parts of signing code taken from a question on [Stack Overflow](http://stackoverflow.com/questions/2632457/create-signed-urls-for-cloudfront-with-ruby) asked by [Ben Wiseley](http://stackoverflow.com/users/315829/ben-wiseley), and answered by [Blaz Lipuscek](http://stackoverflow.com/users/267804/blaz-lipuscek) and [Manual M](http://stackoverflow.com/users/327914/manuel-m).
-
-## License
-
-cloudfront-signer is distributed under the MIT License, portions copyright © 2015 Dylan Vaughn, STL, Anthony Bouch, Leonel Galán