s3-authorize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fee08d6ec40e17f08b28e712bf9be5d6c94d091
+  data.tar.gz: 4ba5c90cca1540f162ddca632daae8b691b797d0
+SHA512:
+  metadata.gz: 7a6e30dc7fed5c5cc52a3c596c233969e5102a09b4fb3a05c53e98bf5b4faed568702c145280c2f56614e1e9a517d582b86f661d19e5d3996a083ba1d7f0ed9c
+  data.tar.gz: 13a0affa6ef1d5518159a48c1fb4633060e34ffba1a8dac7a5af5c37697881fcb367d6a64f36c6574bb9f4e339ecc13a31d7d774cbc1133f607900a7962d096b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.1.0
+  - 2.2.0
+  - 2.2.2
+
+script: bundle exec rspec spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at vinh.nglx@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in s3-authorize.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vinh Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# S3::Authorize
+
+[![Build Status](https://travis-ci.org/vinhnglx/s3-authorize.svg?branch=master)](https://travis-ci.org/vinhnglx/s3-authorize)
+
+S3 accepts uploads via specially-crafted and pre-authorized HTML POST Form (http://aws.amazon.com/articles/1434/). This gem will help you create two values: Signature and Policy.
+
+You guys can use this gem when working with upload file by AngularJS -  (https://github.com/danialfarid/ng-file-upload#s3) or Cordova File Transfer plugin (https://github.com/apache/cordova-plugin-file-transfer) or any front-end stack.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3-authorize'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install s3-authorize
+
+## Usage
+
+
+```ruby
+require 's3/authorize'
+
+s3_authorize = S3::Authorize.new(bucket: 'example', acl: 'public-read', 'secret_key': '356789032')
+
+s3_policy = s3_authorize.policy # eyJleHBpcmF0aW9uIjoiMjAxNi0wNC0yNlQxOTozNjowNFoiLCJjb25 ....
+
+s3-signature = s3_authorize.signature(s3_policy) # VR9hEPY0zvMHOt ....
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vinhnglx/s3-authorize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "s3/authorize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/s3/authorize.rb

@@ -0,0 +1,83 @@
+require 'base64'
+require 'openssl'
+require 'digest/sha1'
+require 'json'
+require 'time'
+require 's3/authorize/version'
+
+module S3
+  class Authorize
+    # Attributes reader
+    attr_reader :bucket, :acl, :secret_key
+
+    # Create constructor for S3Authorize
+    #
+    # args - A hash of parameters.
+    #
+    # Examples
+    #
+    #   S3Authorize.new({bucket: 'example', acl: 'private', secret_key: '123456789'})
+    #
+    # Returns nothing
+    def initialize(args)
+      raise ArgumentError, 'Make sure your parameters exists' unless args_present?(args)
+      @bucket = args[:bucket]
+      @acl = args[:acl]
+      @secret_key = args[:secret_key]
+    end
+
+    # Generate policy
+    # A Base64-encoded policy document that applies rules to file uploads
+    #
+    # Examples
+    #
+    #   s3_authorize = S3Authorize.new({bucket: 'example', acl: 'private', secret_key: '123456789'})
+    #   s3.policy
+    #   # => eyJleHBpcmF0aW9uIjoiMjAxNi0wNC0yNlQxNzoxODowOVoiLCJjb25kaXRpb25zIjpb....
+    #
+    # Returns Base64-encoded
+    def policy
+      Base64.encode64(
+        {
+          "expiration" => (Time.now + 60 * 60).utc.xmlschema,
+          "conditions" => [
+            { "bucket" => bucket },
+            [ "starts-with", "$key", "" ],
+            { "acl" => acl },
+            [ "starts-with", "$Content-Type", "" ],
+            [ "starts-with", "$filename", "" ],
+            [ "content-length-range", 0, 10 * 1024 * 1024 ]
+          ]
+        }.to_json).gsub(/\n/,'')
+    end
+
+    # Generate signature
+    # A Base64-encoded policy document with your AWS Secret Key
+    #
+    # s3_policy - The Base64-encoded policy document
+    #
+    # Examples
+    #
+    #   s3_authorize = S3Authorize.new({bucket: 'example', acl: 'private', secret_key: '123456789'})
+    #   s3_authorize.signature
+    #   # => 1bFFNUyrZ2qLz34bM8a0kNJi6U
+    #
+    # Returns Base64-encoded
+    def signature(s3_policy)
+      Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), secret_key, s3_policy)).gsub("\n","")
+    end
+
+    private
+
+      # Private: Check parameters exists or not
+      #
+      # Examples
+      #
+      #   args_present?
+      #
+      # Returns Boolean
+      def args_present?(args)
+        !(args[:bucket].nil? || args[:acl].nil? || args[:secret_key].nil?)
+      end
+  end
+end

data/lib/s3/authorize/version.rb

@@ -0,0 +1,5 @@
+module S3
+  class Authorize
+    VERSION = "0.1.0"
+  end
+end

data/s3-authorize.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's3/authorize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3-authorize"
+  spec.version       = S3::Authorize::VERSION
+  spec.authors       = ["Vinh Nguyen"]
+  spec.email         = ["vinh.nglx@gmail.com"]
+
+  spec.summary       = %q{Generate Signature and Policy for upload any files to S3.}
+  spec.description   = %q{Gem generates a signature and policy from AWS Secret key.}
+  spec.homepage      = "https://github.com/vinhnglx/s3-authorize"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: s3-authorize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vinh Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Gem generates a signature and policy from AWS Secret key.
+email:
+- vinh.nglx@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/s3/authorize.rb
+- lib/s3/authorize/version.rb
+- s3-authorize.gemspec
+homepage: https://github.com/vinhnglx/s3-authorize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: Generate Signature and Policy for upload any files to S3.
+test_files: []