cloudfront-signer 2.0.1 → 2.1.0

data/README.markdown

@@ -1,5 +1,4 @@
-cloudfront-signer
-=================
+# cloudfront-signer
 
 A fork and re-write of Dylan Vaughn's [signing gem](https://github.com/stlondemand/aws_cf_signer). 
 
@@ -9,8 +8,7 @@ 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
-------------
+## Installation
 
 The original gem was published as `aws_cf_signer`. Use `gem install aws_cf_signer` to install that version.
 
@@ -18,23 +16,15 @@ This gem has been publised as `cloudfront-signer`. Use `gem install cloudfront-s
 
 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.
+In either case the signing class must be configured - supplying the path to a signing key. Create the initializer by running:
 
-In a Rails app this can be done by creating an initializer script in the /config/initializers directory.
+```
+bundle exec rails g cloudfront:install
+```
 
-e.g. 
+and customizing the resulting `config/initializers/cloudfront-signer.rb` file.
 
-    require 'cloudfront-signer'
-
-    AWS::CF::Signer.configure do |config|
-      config.key_path = key_path
-      config.key_pair_id  = "XXYYZZ"
-      config.default_expires = 3600
-    end
-
-
-Usage
------
+## Usage
 
 Call the class `sign_url` or `sign_path` method with optional policy settings.
 
@@ -80,8 +70,7 @@ You can also pass in a path to a policy file. This will supersede any other poli
     url = AWS::CF::Signer.sign_url('http://d84l721fxaaqy9.cloudfront.net/downloads/pictures.tgz', :policy_file => '/path/to/policy/file.txt')
 
 
-Patches/Pull Requests 
--------------------------------------------------------------------------
+## Patches/Pull Requests 
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -89,8 +78,7 @@ Patches/Pull Requests
 * Commit
 * Send me a pull request. Bonus points for topic branches.
 
-Attributions
-------------
+## Attributions
 
 Parts of signing code taken from a question on Stack Overflow asked by Ben Wiseley, and answered by Blaz Lipuscek and Manual M:
 
@@ -99,6 +87,9 @@ Parts of signing code taken from a question on Stack Overflow asked by Ben Wisel
 * [http://stackoverflow.com/users/267804/blaz-lipuscek](http://stackoverflow.com/users/267804/blaz-lipuscek)
 * [http://stackoverflow.com/users/327914/manuel-m](http://stackoverflow.com/users/327914/manuel-m)
 
+Note: 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.
+
+
 License
 -------
 

data/lib/cloudfront-signer.rb

@@ -151,7 +151,7 @@ module AWS
       # Returns a String
       def self.sign(subject, configuration_options = {}, policy_options = {})
 
-        raise "Configure using AWS::CF.Signer.configure! before signing." unless self.is_configured?
+        raise "Configure using AWS::CF::Signer.configure before signing." unless self.is_configured?
 
         # 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 = "2.0.1"
+        VERSION = "2.1.0"
     end
 end

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

@@ -0,0 +1,14 @@
+require 'rails'
+require 'rails/generators'
+
+module Cloudfront
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    
+    desc "This generator creates an initializer file at config/initializers"
+    def add_initializer
+      template "cloudfront-signer.rb", "config/initializers/cloudfront-signer.rb"
+    end
+  end
+end
+  

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

@@ -0,0 +1,5 @@
+AWS::CF::Signer.configure do |config|
+  config.key_path = '/path/to/keyfile.pem'
+  config.key_pair_id  = "XXYYZZ"
+  config.default_expires = 3600
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudfront-signer
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2012-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -45,6 +45,8 @@ files:
 - 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
 - spec/keys/pk-APKAIKUROOUNR2BAFUUU.pem
 - spec/keys/rsa-APKAIKUROOUNR2BAFUUU.pem
 - spec/signer_spec.rb
@@ -78,3 +80,4 @@ test_files:
 - spec/keys/rsa-APKAIKUROOUNR2BAFUUU.pem
 - spec/signer_spec.rb
 - spec/spec_helper.rb
+has_rdoc: