cognac 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d86971bb20a88cf6d836ee65efce4386553cf6c0
-  data.tar.gz: c41738a6e82b804746588401eb22afff221a8d86
+  metadata.gz: 69e426ccc7c2a724b60027cf34434b191c1eadc8
+  data.tar.gz: d2a161c47f4b9d9af11dc8aaa02f698a4b3d8a10
 SHA512:
-  metadata.gz: f4640a5c398bd1f4f76b6ce9944aa67cf181e9c1d96b5b21432e3ec14df452fe7b7a2a7112e3ee31a63294f8c662ebdf1c94f13cf33e8076ce71639ae14494cc
-  data.tar.gz: 6d39d5d12e8a0f2fd48274fd7551307d84e3b9814290cd5867bd7997a9a0adb907069015ee791a3ac6a248961fbaf46ece7933142ce9095924b6264eb782cdf0
+  metadata.gz: 2cff56b051bf47e4c84c5d7be25a404dc60801fda1e45d3988ea4fa7c55ae29dd52d3bf716073038d6bb79f8786b89247e34ce9f3394e32b20ed58e0d37d48f9
+  data.tar.gz: 41c06c0c4252e30948b327ac9efbcca69c6765d65b548b4ec0bba05cfd436b5f61b410cda1d62ec506e55b9afabfb5a177cd34a6253cb984f7fb82f1bffdeefb

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.2.3

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+
+== Version 0.1.3 (July 1, 2015)
+
+Old Interface
+
+    file_name = Cognac::CloudFile.generate(params[:filename])   
+    resource_end_point = Cognac::CloudFile.resource_end_point(ENV["AWS_S3_BUCKET"], file_name) 
+   
+New Interface
+
+    file = Cognac::CloudFile.new(params[:filename], bucket)  
+    resource_end_point = file.resource_end_point
+
+== In Progress
+
+Old Interface
+
+    options = Cognac::Signature.generate_options_for_build_s3_upload_url(ENV["AWS_S3_BUCKET"], file_name, params[:content_type])   
+    url = Cognac::Signature.build_s3_upload_url(resource_end_point, ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"], options)
+
+New Interface
+
+    url = Cognac::CloudFile.upload_url(ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"], params[:content_type])
+  
+== Combining the Two
+
+    file = Cognac::CloudFile.new(params[:filename], bucket)  
+    
+    resource_end_point = file.resource_end_point
+    url = file.upload_url(ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"], params[:content_type])
+    
+    render :json => {put_url: url, file_url: resource_end_point}
+    
+
+Separate the configuration values for object properties.

data/README.md

@@ -24,26 +24,37 @@ Or install it yourself as:
 
 ## Dependencies
 
-Ruby 2.2.2
+Ruby 2.2.3
 ActiveSupport 4.2.3
 
 ## Usage
 
+Configure the AWS credentials in config/initializers/aws.rb:
+
+```ruby
+  Cognac.configuration do |config|
+    config.secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+    config.aws_access_key    = ENV['AWS_ACCESS_KEY_ID']
+	config.aws_s3_bucket     = ENV['AWS_S3_BUCKET']
+  end
+```
+
 You can use this gem in your Rails controller like this:
 
 ```ruby
   def generate_signed_s3_url
-    # To avoid file collision, we prepend string to the file_name
-    file_name = Cognac::CloudFile.generate(params[:filename])
-    resource_end_point = Cognac::CloudFile.resource_end_point(ENV["AWS_S3_BUCKET"], file_name)
-   
-    options = Cognac::Signature.generate_options_for_build_s3_upload_url(ENV["AWS_S3_BUCKET"], file_name, params[:content_type])
-    url = Cognac::Signature.build_s3_upload_url(resource_end_point, ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"], options)
+    cloud_file = Cognac::CloudFile.new(params[:filename])
+    resource_end_point = cloud_file.resource_end_point
+	
+    options = Cognac::Signature.generate_options_for_build_s3_upload_url(cloud_file.name, params[:content_type])
+    url = Cognac::Signature.build_s3_upload_url(resource_end_point, options)
     
-    render :json => {:put_url => url, :file_url => resource_end_point}
+    render :json => {put_url: url, file_url: resource_end_point}
   end
 ```
 
+For a sample Rails project that shows how to use this gem, check out: https://github.com/bparanj/s3-cors-upload-rails
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -55,12 +66,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 Run the tests:
 
 ```sh
-$ruby -rminitest/pride test/cognac_test.rb 
+$ruby -rminitest/pride test/cloud_file_test.rb  --verbose
+$ruby -rminitest/pride test/signature_test.rb  --verbose
 ```
 
 Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/bparanj/cognac.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/cognac.gemspec

@@ -19,7 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   
+  spec.required_ruby_version = '>= 2.2.2'
+  
   spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'lyon', "~> 0.1"
   
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/cognac.rb

@@ -1,78 +1,13 @@
+require "cognac/cloud_file"
+require "cognac/signature"
 require "cognac/version"
-require 'active_support/core_ext/numeric/time'
-require "erb"
+require 'lyon'
 
 module Cognac
-  
-  class CloudFile
-    def self.generate(file_name)
-      "#{SecureRandom.hex(4).to_s}_#{file_name}"
-    end
-    
-    def self.resource_end_point(bucket, file_name)
-      "http://#{bucket}.s3.amazonaws.com/#{file_name}"
-    end
-  end
-  
-  # AWS Signature Version 2 : http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
-  class Signature
-    NEW_LINE = "\n"
-    
-    def self.build_string_to_sign(options = {})
-      options = {
-        http_verb:     "PUT",
-        content_md5:   nil,
-        content_type:  nil,
-        date:          an_hour_from_now,
-        amz_headers:   [],
-        resource:      ""
-      }.merge(options)
+  extend Lyon::Configuration
 
-      add_new_line(options[:http_verb]) +
-      add_new_line(options[:content_md5]) +
-      add_new_line(options[:content_type]) +
-      add_new_line(options[:date]) +
-      (options[:amz_headers].any? ? (options[:amz_headers].join(NEW_LINE) + NEW_LINE) : "") +
-      options[:resource]
-   end
-   
-   def self.build_s3_rest_signature(secret_access_key, options = {})
-      s = build_string_to_sign(options).force_encoding("UTF-8")
-      Base64.encode64(OpenSSL::HMAC.digest("sha1", secret_access_key, s)).strip
-   end
-   
-   def self.build_s3_upload_url(end_point, aws_access_key, secret_access_key, signature_options = {})
-     signature = encoded_signature(secret_access_key, signature_options)
-     expires = expiration(signature_options)
-     "#{end_point}?AWSAccessKeyId=#{aws_access_key}&Expires=#{expires}&Signature=#{signature}"     
-   end
-   
-   def self.generate_options_for_build_s3_upload_url(bucket, file_name, content_type)
-      {
-         http_verb:    "PUT", 
-         date:         1.hours.from_now.to_i, 
-         resource:     "/#{bucket}/#{file_name}",
-         content_type: content_type
-      }
-   end
-   
-   private
-   
-   def self.add_new_line(option)
-     option.to_s + NEW_LINE
-   end
-   
-   def self.an_hour_from_now
-     1.hours.from_now.rfc822
-   end
-   
-   def self.encoded_signature(secret_access_key, signature_options)
-     ERB::Util.url_encode(build_s3_rest_signature(secret_access_key, signature_options))
-   end
-   
-   def self.expiration(signature_options)
-     signature_options[:date] || an_hour_from_now
-   end
-   
-  end
+  # Amazon Credentials
+  define_setting :secret_access_key
+  define_setting :aws_access_key
+  define_setting :aws_s3_bucket
 end

data/lib/cognac/cloud_file.rb

@@ -0,0 +1,22 @@
+require 'securerandom'
+
+module Cognac
+  class CloudFile
+    
+    def initialize(file_name)
+      @file_name = file_name
+    end
+    
+    # To avoid file collision, we prepend random string to the file_name
+    def name
+      "#{SecureRandom.hex(4).to_s}_#{@file_name}"
+    end
+    
+    def resource_end_point
+      raise 'AWS_S3_BUCKET Environment variable is not intialized. Refer README.md at https://bitbucket.org/bparanj/cognac' if Cognac.aws_s3_bucket.nil?
+      "http://#{Cognac.aws_s3_bucket}.s3.amazonaws.com/#{name}"
+    end
+    
+  end
+  
+end

data/lib/cognac/signature.rb

@@ -0,0 +1,109 @@
+require 'active_support/core_ext/numeric/time'
+require "erb"
+
+module Cognac
+  
+  # file = Cognac::CloudFile.new(params[:filename], bucket)
+  #
+  # resource_end_point = file.resource_end_point
+  # url = file.upload_url(ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"], params[:content_type])
+  
+  # 1. Create cloudfile
+  # 2. Generate end point
+  # 3. Generate upload url
+    
+  # Input
+  # - file_name
+  # - bucket
+  # - access_key_id
+  # - secret_access_key
+  # - content_type
+  #
+  # Output
+  # - Signed S3 Upload URL
+  
+  # build_s3_upload_url (access_key, secret_access_key)
+  #  - Encode signature
+  #    - build s3 rest signature (secret_access_key)
+  #       - build_string_to_sign (options)
+  #       - base encode hmac digest (string to sign, secret_access_key)
+  #  - End point
+  
+  # AWS Signature Version 2 : http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
+  class Signature
+    NEW_LINE = "\n"
+    SECURE_HASH_ALGORITHM = "sha1"
+    BLANK_STRING = ""
+    UTF8_ENCODING = "UTF-8"
+    HTTP_PUT = "PUT"
+    
+    def initialize(options = {})
+      @secret_access_key = Cognac.secret_access_key
+      @aws_access_key = Cognac.aws_access_key
+      @options = options
+      @default = {
+        http_verb:     HTTP_PUT,
+        content_md5:   nil,
+        content_type:  nil,
+        date:          an_hour_from_now,
+        amz_headers:   [],
+        resource:      BLANK_STRING
+      }
+    end
+ 
+    # This is called in the controller
+    def build_s3_upload_url(end_point)
+      "#{end_point}?AWSAccessKeyId=#{@aws_access_key}&Expires=#{expiration}&Signature=#{encoded_signature}"     
+    end
+    
+    def encoded_signature
+      ERB::Util.url_encode(build_s3_rest_signature)
+    end
+
+    def build_s3_rest_signature
+       string_to_sign = build_string_to_sign(@options).force_encoding(UTF8_ENCODING)
+       base_encoded_hmac_digest(string_to_sign)
+    end
+    
+    def build_string_to_sign(options = {})
+      o = @default.merge(options)
+
+      add_new_line(o[:http_verb]) +
+      add_new_line(o[:content_md5]) +
+      add_new_line(o[:content_type]) +
+      add_new_line(o[:date]) +
+      (o[:amz_headers].any? ? (o[:amz_headers].join(NEW_LINE) + NEW_LINE) : BLANK_STRING) +
+      o[:resource]
+   end
+    
+   def base_encoded_hmac_digest(string_to_sign)
+     Base64.encode64(OpenSSL::HMAC.digest(SECURE_HASH_ALGORITHM, @secret_access_key, string_to_sign)).strip
+   end
+   
+   # This is called in the controller and passed in to the build_s3_upload_url method as a parameter
+   # Hide this method
+   def generate_options_for_build_s3_upload_url(file_name, content_type)
+      {
+         http_verb:    HTTP_PUT, 
+         date:         1.hours.from_now.to_i, 
+         resource:     "/#{Cognac.aws_s3_bucket}/#{file_name}",
+         content_type: content_type
+      }
+   end
+   
+   private
+   
+   def add_new_line(option)
+     option.to_s + NEW_LINE
+   end
+   
+   def an_hour_from_now
+     1.hours.from_now.rfc822
+   end
+   
+   def expiration
+     @options[:date] || an_hour_from_now
+   end
+   
+  end
+end

data/lib/cognac/version.rb

@@ -1,3 +1,3 @@
 module Cognac
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/todo.txt

@@ -0,0 +1,24 @@
+1. Hide methods that are not used in the controller.
+
+2. 
+
+  # file = Cognac::CloudFile.new(params[:filename], bucket)
+  #
+  # resource_end_point = file.resource_end_point
+  # url = file.upload_url(ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"], params[:content_type])
+  
+  # 1. Create cloudfile
+  # 2. Generate end point
+  # 3. Generate upload url
+
+3. Use the latest version of Cognac gem with S3 uploader.
+
+
+
+
+
+
+
+
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cognac
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Bala Paranj
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2015-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: lyon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +93,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,7 +102,10 @@ files:
 - bin/setup
 - cognac.gemspec
 - lib/cognac.rb
+- lib/cognac/cloud_file.rb
+- lib/cognac/signature.rb
 - lib/cognac/version.rb
+- todo.txt
 homepage: http://www.rubyplus.com
 licenses:
 - MIT
@@ -100,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="