aws_upload 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4ed9e16752353b0364e38bb1f33a7f88b78768c
+  data.tar.gz: 620f6c695c65b5c2ca1c698d7f6a414b82c62019
+SHA512:
+  metadata.gz: b6e9df787666bd36157334fe262233d8b882bad57364f1ec2d6e22bf5ef4708d32c1a872cc70d2bff509270476d5e02c1c46bc6071da5585564a22220552e753
+  data.tar.gz: b24e2ce43c541669a9cf167c9b6676365c60deedd7d89a54f05c6372a0beeaf9fb8fbe6ef7a56b26a8c2614059964f4b6cbecb8a0f8247015d629e92d9f2eeb9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ykmr1224
+
+MIT License
+
+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,69 @@
+# AwsUpload
+
+This gem offers a helper method to build a form HTML to upload directry to Amazon S3 storage by using POST method.
+With this gem, you can easily exclude settings for aws s3 direct upload and generate upload form by calling a single helper method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aws_upload'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aws_upload
+
+## Usage
+
+Make your initialization script to configure uploading parameters.
+
+in config/initializers/aws_uplaod.rb
+```ruby
+  AwsUpload.configure do |config|
+    config.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
+    config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+    config.aws_region = ENV['AWS_REGION']
+
+    config.uploader :image do |u|
+      u.bucket = 'bucket-name'
+      u.key_prefix = 'some-prefix/'
+      u.options[:acl] = "public-read"
+      u.options[:content_length_range] = 0..1024
+      u.options[:success_action_redirect] = "http://url.to/redirected/pass"
+    end
+  end
+```
+
+Call aws_upload_form method from view erb file.
+
+```erb
+  Generate a form to upload a file with the name of "uploaded_file.jpg"
+  <%= aws_upload_form(:image, "uploaded_file.jpg") %>
+
+  Generate a form to upload a file with the uploaded file name
+  <%= aws_upload_form(:image, "${filename}") %>
+
+  You can specify options. It will override the options specified in the configuration.
+  <%= aws_upload_form(:image, "uploaded_file.jpg", acl: "private", metadata: {original-filename: '${filename'}) %>
+
+  You can customize file and submit input by giving a block.
+  <%= aws_upload_form(:image, "uploaded_file.jpg") do %>
+    <input type="file" name="file">
+    <input type="submit" value="Upload">
+  <% end %>
+```
+
+You can find further options in AWS::S3::PresignedPost document, which is internaly used in this gem.
+http://docs.aws.amazon.com/AWSRubySDK/latest/AWS/S3/PresignedPost.html#initialize-instance_method
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aws_upload.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aws_upload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aws_upload"
+  spec.version       = AwsUpload::VERSION
+  spec.authors       = ["ykmr1224"]
+  spec.email         = ["ykmr1224@gmail.com"]
+  spec.description   = %q{This gem offers a helper method to build a form HTML to upload directry to Amazon S3 storage by using POST method.}
+  spec.summary       = %q{This gem offers a helper method to build a form HTML to upload directry to Amazon S3 storage by using POST method.}
+  spec.homepage      = "https://github.com/ykmr1224"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "actionview"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/aws_upload.rb

@@ -0,0 +1,68 @@
+require "aws_upload/version"
+require 'aws_upload/form_helper.rb'
+require 'aws-sdk'
+
+module AwsUpload
+
+  ##
+  # Module method to configure AwsUpload
+  # === Examples
+  # AwsUpload.configure do |config|
+  #   config.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
+  #   config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+  #   config.aws_region = ENV['AWS_REGION']
+  #
+  #   config.uploader :image do |u|
+  #     u.bucket = 'bucket-name'
+  #     u.key_prefix = 'some-prefix/'
+  #     u.options[:acl] = "public-read"
+  #     u.options[:content_length_range] = 0..1024
+  #     u.options[:success_action_redirect] = "http://url.to/redirected/pass"
+  #   end
+  #
+  #   config.uploader :csv do |u|
+  #     u.bucket = 'bucket-name'
+  #     u.key_prefix = 'some-prefix/'
+  #     u.options[:acl] = "private"
+  #     u.options[:content_length_range] = 0..10240
+  #   end
+  # end
+  def self.configure
+    yield self
+  end
+
+  # Access key id for upload
+  mattr_accessor :aws_access_key_id
+  @@aws_access_key_id = nil
+
+  # Secret access key for upload
+  mattr_accessor :aws_secret_access_key
+  @@aws_secret_access_key = nil
+
+  # S3 bucket region
+  mattr_accessor :aws_region
+  @@aws_region = ENV['AWS_REGION']
+
+  @@uploaders = {}
+
+  def self.uploader(*args, &block)
+    if block_given?
+      options = args.extract_options!
+      name = args.first || :default
+      @@uploaders[name] = Uploader.new().tap{ |u| yield(u) }
+    else
+      @@uploaders[args.first || :default]
+    end
+  end
+
+  # Uploader instance will holds upload settings
+  class Uploader
+    attr_accessor :options, :key_prefix, :bucket
+
+    def initialize
+      @options = {}
+      @key_prefx = ""
+      @bucket = nil
+    end
+  end
+end

data/lib/aws_upload/form_helper.rb

@@ -0,0 +1,60 @@
+require 'action_view'
+
+module AwsUpload
+  ##
+  # This module creates aws direct upload form helper
+  # === Examples
+  # Generate a form to upload a file with the name of "uploaded_file.jpg"
+  # <%= aws_upload_form(:image, "uploaded_file.jpg") %>
+  #
+  # Generate a form to upload a file with the uploaded file name
+  # <%= aws_upload_form(:image, "${filename}") %>
+  #
+  # You can specify options. It will override the options specified in the configuration.
+  # <%= aws_upload_form(:image, "uploaded_file.jpg", acl: "private", metadata: {original-filename: '${filename'}) %>
+  #
+  # You can customize file and submit input by giving a block.
+  # <%= aws_upload_form(:image, "uploaded_file.jpg") do %>
+  #   <input type="file" name="file">
+  #   <input type="submit" value="Upload">
+  # <% end %>
+  #
+  module FormHelper
+    extend self
+
+    def aws_upload_form(name, object_key, options={})
+      # Load credentials
+      if AwsUpload.aws_access_key_id
+        creds = Aws::Credentials.new(AwsUpload.aws_access_key_id, AwsUpload.aws_secret_access_key)
+      else
+        # Use shared credentials if aws_access_key_id is not specified
+        creds = Aws::SharedCredentials.new()
+      end
+
+      region = AwsUpload.aws_region
+
+      uploader = AwsUpload.uploader(name)
+      opts = uploader.options.deep_merge(options)
+      opts[:key] = uploader.key_prefix + object_key
+
+      post = Aws::S3::PresignedPost.new(creds, region, uploader.bucket, opts)
+      form = "<form action='#{post.url.to_s}' method='post' enctype='multipart/form-data'>\n"
+      post.fields.each do |key, value|
+        form << "\t<input type='hidden' name='#{key}' value='#{value}'>\n"
+      end
+
+      # render file and submit inputs. yield block if a block is given.
+      if block_given?
+        form << yield
+      else
+        form << "\t<input type='file' name='file'>\n"
+        form << "\t<input type='submit' value='upload'>\n"
+      end
+
+      form << "</form>"
+      form.html_safe
+    end
+  end
+end
+
+ActionView::Base.send :include, AwsUpload::FormHelper

data/lib/aws_upload/version.rb

@@ -0,0 +1,3 @@
+module AwsUpload
+  VERSION = "0.0.1"
+end

data/spec/aws_upload_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe AwsUpload do
+  it 'has a version number' do
+    expect(AwsUpload::VERSION).not_to be_nil
+  end
+
+  before(:all) do
+    AwsUpload::configure do |config|
+      config.aws_access_key_id = "some_key"
+      config.aws_secret_access_key = "some_secret"
+      config.aws_region = "us-west-2"
+
+      #default
+      config.uploader do |u|
+        u.bucket = 'default-bucket'
+        u.key_prefix = 'some-prefix/'
+        u.options[:acl] = "private"
+        u.options[:content_length_range] = 0..10240
+      end
+
+      #named uploader
+      config.uploader :image do |u|
+        u.bucket = 'image-bucket'
+        u.key_prefix = 'img-'
+        u.options[:acl] = "public-read"
+        u.options[:content_length_range] = 0..1024
+        u.options[:success_action_redirect] = "http://url.to/redirected/pass"
+      end
+    end
+  end
+
+  describe "configure" do
+    it 'setup access credentials' do
+      expect(AwsUpload::aws_access_key_id).to eql("some_key")
+      expect(AwsUpload::aws_secret_access_key).to eql("some_secret")
+      expect(AwsUpload::aws_region).to eql("us-west-2")
+    end
+
+    it 'setup default uploader' do
+      expect(AwsUpload::uploader().bucket).to eql("default-bucket")
+      expect(AwsUpload::uploader().key_prefix).to eql("some-prefix/")
+      expect(AwsUpload::uploader().options[:acl]).to eql("private")
+      expect(AwsUpload::uploader().options[:content_length_range]).to eql(0..10240)
+    end
+
+    it 'setup named uploader' do
+      expect(AwsUpload::uploader(:image).bucket).to eql("image-bucket")
+      expect(AwsUpload::uploader(:image).key_prefix).to eql("img-")
+      expect(AwsUpload::uploader(:image).options[:acl]).to eql("public-read")
+      expect(AwsUpload::uploader(:image).options[:content_length_range]).to eql(0..1024)
+      expect(AwsUpload::uploader(:image).options[:success_action_redirect]).to eql("http://url.to/redirected/pass")
+    end
+  end
+
+  describe "form-helper" do
+    it "add aws_upload_form method to ActionView::Base" do
+      expect(ActionView::Base.instance_methods).to include(:aws_upload_form)
+    end
+
+    describe "#aws_upload_form" do
+      it "return generated form" do
+        form_html = AwsUpload::FormHelper.aws_upload_form :image, "objname"
+        expect(form_html).to include("<form action='https://image-bucket.s3-us-west-2.amazonaws.com' method='post' enctype='multipart/form-data'>")
+        expect(form_html).to be_html_safe
+      end
+
+      it "return allows block to specify file input and submit button" do
+        form_html = AwsUpload::FormHelper.aws_upload_form :image, "objname" do
+          "<input type='file' name='file' id='special'><input type='submit' value='GO!'>"
+        end
+        expect(form_html).to include("<input type='file' name='file' id='special'><input type='submit' value='GO!'>")
+        expect(form_html).to be_html_safe
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'aws_upload'

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: aws_upload
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ykmr1224
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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'
+description: This gem offers a helper method to build a form HTML to upload directry
+  to Amazon S3 storage by using POST method.
+email:
+- ykmr1224@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aws_upload.gemspec
+- lib/aws_upload.rb
+- lib/aws_upload/form_helper.rb
+- lib/aws_upload/version.rb
+- spec/aws_upload_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ykmr1224
+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.4.5
+signing_key: 
+specification_version: 4
+summary: This gem offers a helper method to build a form HTML to upload directry to
+  Amazon S3 storage by using POST method.
+test_files:
+- spec/aws_upload_spec.rb
+- spec/spec_helper.rb