cognac 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 6d3bd3977561fc9485489780f4bf6005edfb8993
4
+ data.tar.gz: 1fbfa74e3a3c4e1ebfebcb61855ab6100c052359
5
+ SHA512:
6
+ metadata.gz: d89841d71f41b1a2fa70276e605b380b13674037478e000cf20041960dbcdb1f2572030b834ad92cd62f835242f15d465a2d44a6113ce8569b19996c7eed3ed2
7
+ data.tar.gz: 487649b302363d85348098805a0b4dc212db0ac26433ccac049e748e507d50ff14a8c3ceb8e190f55994a27e741d0e3468d5f6aa0abbd3951cb4d9b08fb8c4d0
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.2
4
+ before_install: gem install bundler -v 1.10.5
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in cognac.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Bala Paranj
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # Cognac
2
+
3
+ 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.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'cognac'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install cognac
20
+
21
+ ## Versions
22
+
23
+ Ruby 2.2.2
24
+ ActiveSupport 4.2.3
25
+
26
+ ## Usage
27
+
28
+ You can use this gem in your Rails controller like this:
29
+
30
+ ```ruby
31
+ def generate_signed_s3_url
32
+ # To avoid file collision, we prepend string to the file_name
33
+ file_name = Cognac::CloudFile.generate(params[:file_name])
34
+ resource_end_point = Cognac::CloudFile.resource_end_point(ENV["AWS_S3_BUCKET"], file_name)
35
+ options = Cognac::Signature.generate_options_for_build_s3_upload_url(ENV["AWS_S3_BUCKET"], file_name, params[:content_type])
36
+ url = AwsHelper.build_s3_upload_url(resource_endpoint, ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"], options)
37
+ render :json => {:put_url => url, :file_url => resource_endpoint}
38
+ end
39
+ ```
40
+
41
+ ## Development
42
+
43
+ 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.
44
+
45
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
46
+
47
+ ## Contributing
48
+
49
+ Run the tests:
50
+
51
+ ```sh
52
+ $ruby -rminitest/pride test/cognac_test.rb
53
+ ```
54
+
55
+ Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/bparanj/cognac.
56
+
57
+ ## License
58
+
59
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
60
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "cognac"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
data/cognac.gemspec ADDED
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'cognac/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "cognac"
8
+ spec.version = Cognac::VERSION
9
+ spec.authors = ["Bala Paranj"]
10
+ spec.email = ["bparanj@gmail.com"]
11
+
12
+ spec.summary = %q{A simple library to implement Amazon S3 upload using CORS.}
13
+ spec.homepage = "http://www.rubyplus.com"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_dependency 'activesupport', '~> 4.2'
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.10"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "minitest", "~> 5.7"
26
+ end
data/lib/cognac.rb ADDED
@@ -0,0 +1,69 @@
1
+ require "cognac/version"
2
+ require 'active_support/core_ext/numeric/time'
3
+ require "erb"
4
+
5
+ module Cognac
6
+
7
+ class CloudFile
8
+ def self.generate(file_name)
9
+ "#{SecureRandom.hex(4).to_s}_#{file_name}"
10
+ end
11
+
12
+ def self.resource_end_point(bucket, file_name)
13
+ "http://#{bucket}.s3.amazonaws.com/#{file_name}"
14
+ end
15
+ end
16
+
17
+ # AWS Signature Version 2 : http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
18
+ class Signature
19
+ NEW_LINE = "\n"
20
+
21
+ def self.build_string_to_sign(options = {})
22
+ options = {
23
+ http_verb: "PUT",
24
+ content_md5: nil,
25
+ content_type: nil,
26
+ date: an_hour_from_now,
27
+ amz_headers: [],
28
+ resource: ""
29
+ }.merge(options)
30
+
31
+ add_new_line(options[:http_verb]) +
32
+ add_new_line(options[:content_md5]) +
33
+ add_new_line(options[:content_type]) +
34
+ add_new_line(options[:date]) +
35
+ (options[:amz_headers].any? ? (options[:amz_headers].join(NEW_LINE) + NEW_LINE) : "") +
36
+ options[:resource]
37
+ end
38
+
39
+ def self.build_s3_rest_signature(secret_access_key, options = {})
40
+ s = build_string_to_sign(options).force_encoding("UTF-8")
41
+ Base64.encode64(OpenSSL::HMAC.digest("sha1", secret_access_key, s)).strip
42
+ end
43
+
44
+ def self.build_s3_upload_url(endpoint, aws_access_key, secret_access_key, signature_options = {})
45
+ signature = ERB::Util.url_encode(build_s3_rest_signature(secret_access_key, signature_options))
46
+ expires = signature_options[:date] || an_hour_from_now
47
+ "#{endpoint}?AWSAccessKeyId=#{aws_access_key}&Expires=#{expires}&Signature=#{signature}"
48
+ end
49
+
50
+ def self.generate_options_for_build_s3_upload_url(bucket, file_name, content_type)
51
+ {
52
+ http_verb: "PUT",
53
+ date: 1.hours.from_now.to_i,
54
+ resource: "/#{bucket}/#{file_name}",
55
+ content_type: content_type
56
+ }
57
+ end
58
+
59
+ private
60
+
61
+ def self.add_new_line(option)
62
+ option.to_s + NEW_LINE
63
+ end
64
+
65
+ def self.an_hour_from_now
66
+ 1.hours.from_now.rfc822
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,3 @@
1
+ module Cognac
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,111 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: cognac
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Bala Paranj
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-07-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activesupport
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '4.2'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '4.2'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.10'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.10'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: minitest
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '5.7'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '5.7'
69
+ description:
70
+ email:
71
+ - bparanj@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".travis.yml"
78
+ - Gemfile
79
+ - LICENSE.txt
80
+ - README.md
81
+ - Rakefile
82
+ - bin/console
83
+ - bin/setup
84
+ - cognac.gemspec
85
+ - lib/cognac.rb
86
+ - lib/cognac/version.rb
87
+ homepage: http://www.rubyplus.com
88
+ licenses:
89
+ - MIT
90
+ metadata: {}
91
+ post_install_message:
92
+ rdoc_options: []
93
+ require_paths:
94
+ - lib
95
+ required_ruby_version: !ruby/object:Gem::Requirement
96
+ requirements:
97
+ - - ">="
98
+ - !ruby/object:Gem::Version
99
+ version: '0'
100
+ required_rubygems_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ requirements: []
106
+ rubyforge_project:
107
+ rubygems_version: 2.4.7
108
+ signing_key:
109
+ specification_version: 4
110
+ summary: A simple library to implement Amazon S3 upload using CORS.
111
+ test_files: []