cognac 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d3bd3977561fc9485489780f4bf6005edfb8993
-  data.tar.gz: 1fbfa74e3a3c4e1ebfebcb61855ab6100c052359
+  metadata.gz: 919761511baee7130f501a32e61618926799b652
+  data.tar.gz: 44fbca19631cea02f42324770ea4f60bbfdbce18
 SHA512:
-  metadata.gz: d89841d71f41b1a2fa70276e605b380b13674037478e000cf20041960dbcdb1f2572030b834ad92cd62f835242f15d465a2d44a6113ce8569b19996c7eed3ed2
-  data.tar.gz: 487649b302363d85348098805a0b4dc212db0ac26433ccac049e748e507d50ff14a8c3ceb8e190f55994a27e741d0e3468d5f6aa0abbd3951cb4d9b08fb8c4d0
+  metadata.gz: 1481ceb5cc53846f9db92cbc24a0bf5b3784b09a4c992e815b2d22a7f39bfeadc37119d8141c576e27ab7d67ef7c6b9d149bc063644e2c928ccc7a5cd01ddb3c
+  data.tar.gz: e7b2d39d146e3955effedecd3bc04a24bf413ddbc995e60a0227f63e632336bf5398942aae716340c4138b1a08b566dc24c447babcf1430143c848e115d48760

data/README.md

@@ -1,6 +1,10 @@
 # Cognac
 
-This is a lightweight gem for implementing Amazon S3 upload using CORS support. The dependencies are kept to a minimum for easier maintenance. To experiment with this code, run `bin/console` for an interactive prompt.
+This is a lightweight gem for implementing Amazon S3 upload using CORS support. The dependencies are kept to a minimum for easier maintenance. 
+
+This gem builds the AWS authentication signature as described in http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html. It requires the Amazon keys, as well as options about the request (request type, resource, etc).
+
+To experiment with this code, run `bin/console` for an interactive prompt.
 
 ## Installation
 
@@ -30,11 +34,13 @@ 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[: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 = AwsHelper.build_s3_upload_url(resource_endpoint, ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"], options)
-    render :json => {:put_url => url, :file_url => resource_endpoint}
+    url = Cognac::Signature.build_s3_upload_url(resource_end_point, ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"], options)
+    
+    render :json => {:put_url => url, :file_url => resource_end_point}
   end
 ```
 

data/cognac.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["bparanj@gmail.com"]
 
   spec.summary       = %q{A simple library to implement Amazon S3 upload using CORS.}
+  spec.description       = %q{This gem builds the AWS authentication signature as described in http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html. It requires the Amazon keys, as well as options about the request (request type, resource, etc).}
   spec.homepage      = "http://www.rubyplus.com"
   spec.license       = "MIT"
 

data/lib/cognac/version.rb

@@ -1,3 +1,3 @@
 module Cognac
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cognac
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bala Paranj
@@ -66,7 +66,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.7'
-description: 
+description: This gem builds the AWS authentication signature as described in http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html.
+  It requires the Amazon keys, as well as options about the request (request type,
+  resource, etc).
 email:
 - bparanj@gmail.com
 executables: []