s3_cors_fileupload 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.1.2
+
+  - Modified the FormHelper so that view helper method is named `s3_cors_fileupload_form_tag` (instead of `s3_cors_fileupload_form`) to maintain consistency with the rest of ActionView's view helpers.
+  - Improving usage documentation on the README to provide a more detailed explanation of what the gem provides.
+
+## 0.1.1
+
+  - Fixed generator so that the [SourceFile model](https://github.com/fullbridge-batkins/s3_cors_fileupload/blob/master/lib/generators/s3_cors_fileupload/install/templates/source_file.rb) requires the aws-s3 gem properly.

data/Gemfile

@@ -5,7 +5,7 @@ source :rubygems
 group :development do
   gem 'bundler'
   gem 'rdoc', '~> 3.12'
-  gem 'jeweler', '~> 1.8.4'
+  gem 'gem-release', '~> 0.4'
 end
 
 group :test do

data/Gemfile.lock

@@ -5,16 +5,10 @@ GEM
       i18n (~> 0.6)
       multi_json (~> 1.0)
     diff-lcs (1.1.3)
-    git (1.2.5)
+    gem-release (0.4.1)
     i18n (0.6.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
     json (1.7.5)
     multi_json (1.3.6)
-    rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
     rspec (2.11.0)
@@ -33,7 +27,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  jeweler (~> 1.8.4)
+  gem-release (~> 0.4)
   rdoc (~> 3.12)
   rspec (~> 2.11)
   shoulda-matchers

data/README.md

@@ -1,6 +1,6 @@
 # S3CorsFileupload
 
-A gem to allow for uploading of files to directly AWS-S3 via CORS via the
+A gem to allow for uploading of files to directly AWS-S3 via [CORS](http://www.w3.org/TR/cors/) via the
 [jQuery-File-Upload javascript](http://blueimp.github.com/jQuery-File-Upload/) for Rails 3.1 and greater.
 
 ## Installation
@@ -20,9 +20,9 @@ Now run the migration that was just generated:
 
     bundle exec rake db:migrate
 
-As you may have noticed, a config file was generated at `config/amazon_s3.yml`.  Edit this file and fill in
-the fields with your AWS S3 credentials.  You can make the config load from environment variables if you wish
-not to commit your S3 account information to your repository, like so:
+Also, as you may have noticed, a config file was generated at `config/amazon_s3.yml`.  Edit this file and fill in
+the fields with your AWS S3 credentials.  If you don't want to commit your S3 account credentials to your
+repository, you can make the config load from environment variables like so:
 
     secret_access_key: <%= ENV['S3_SECRET_ACCESS_KEY'] %>
 
@@ -62,27 +62,48 @@ line like so:
 
     <AllowedOrigin>*</AllowedOrigin>
 
-Just be sure to change this before you put it into production, otherwise anybody can upload to your bucket from any domain.
+Just be sure to change this value to your server's domain before you put it into production, otherwise anybody
+can upload to your bucket from any domain.
 
 ## Usage
 
 Run your rails server
 
-    bundle exec rails s
+    bundle exec rails server
 
 Then navigate to `http://<server_root>/source_files` to get started.  The files that `s3_cors_fileupload`'s install generator
-provide you with are just a guide to get you started.  I thought this would be helpful to others since it took me a while to
+provide you with are just a guide to get you started.  I thought this would be helpful for others since it took me a while to
 get the [jQuery-File-Upload javascript](http://blueimp.github.com/jQuery-File-Upload/) uploading directly to S3.  I encourage
 you to modify the controller, source files, and javascript as you see fit!
 
+### What the gem provides for your Rails app
+
+S3CorsFileupload will inject the javascripts and CSS (with the exception of [Twitter Bootstrap](http://twitter.github.com/bootstrap/))
+styling necessary to render the UI version of the [jQuery-File-Upload javascript](http://blueimp.github.com/jQuery-File-Upload/)
+into the asset pipeline of your Rails application.  For more details on how Twitter Bootstrap is leveraged, see
+[the Notes section below](#notes).  
+
+The gem also provides a view helper to your Rails app, `s3_cors_fileupload_form_tag`, which will produce a form that renders
+the UI version of the [jQuery-File-Upload javascript](http://blueimp.github.com/jQuery-File-Upload/) when called.
+This view helper accepts the following options:
+
+* `:access_key_id` - The AWS Access Key ID of the owner of the bucket.  Defaults to the `Config.access_key_id` (read from the `config/amazon_s3.yml` config file).
+* `:acl` - One of S3's Canned Access Control Lists, must be one of: 'private', 'public-read', 'public-read-write', 'authenticated-read'.  Defaults to `'public-read'`.
+* `:max_file_size` - The max file size (in bytes) that you wish to allow to be uploaded.  Defaults to `Config.max_file_size` (read from the `config/amazon_s3.yml` config file) or, if no value is set on the `config/amazon_s3.yml` file, defaults to `524288000` (500 MB)
+* `:bucket` - The name of the bucket on S3 you wish for the files to be uploaded to.  Defaults to `Config.bucket` (read from the `config/amazon_s3.yml` config file).
+* Any other key creates standard HTML options for the form tag.
+
+For an example of how to use the helper, see the file located at `app/views/s3_uploads/index.html.erb` that
+the install generator produces.
+
 ## Notes
 
 The UI version of the [jQuery-File-Upload javascript](http://blueimp.github.com/jQuery-File-Upload/)
-javascript uses aspects of [Twitter's Bootstrap](http://twitter.github.com/bootstrap/) for styling purposes.
-In index view file from this gem's generator it is included via a `stylesheet_link_tag` to use a copy of it
-[BootstrapCDN](http://www.bootstrapcdn.com/), but if you plan to use bootstrap in more places throughout
-your application, you may want look into using a gem such as
-`[twitter-bootstrap-rails](https://github.com/seyhunak/twitter-bootstrap-rails)`, which allows you to inject
+javascript uses aspects of the [Twitter Bootstrap](http://twitter.github.com/bootstrap/) CSS for styling purposes.
+In the view file created at `s3_uploads/index.html.erb` by this gem's install generator, a copy of the Bootstrap CSS hosted on
+[BootstrapCDN](http://www.bootstrapcdn.com/) is included via a `stylesheet_link_tag`. If you plan to use bootstrap in more
+places throughout your application, you may want look into using a gem such as
+[twitter-bootstrap-rails](https://github.com/seyhunak/twitter-bootstrap-rails), which allows you to inject
 the stylesheets and javascripts from bootstrap into the asset pipeline.
 
 ## Contributing to S3CorsFileupload

data/Rakefile

@@ -4,33 +4,12 @@ require 'rubygems'
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "s3_cors_fileupload"
-  gem.homepage = "http://github.com/fullbridge-batkins/s3_cors_fileupload"
-  gem.license = "MIT"
-  gem.summary = %q{File uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload javascript}
-  gem.description = %q{File uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload javascript}
-  gem.email = ["benatkins@fullbridge.com"]
-  gem.authors = ["Ben Atkins"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')
 
 # If you want to make this the default task
 task :default => :spec
 
-# require 'rake/testtask'
-# Rake::TestTask.new(:test) do |test|
-#   test.libs << 'lib' << 'test'
-#   test.pattern = 'test/**/test_*.rb'
-#   test.verbose = true
-# end
-# 
 # require 'rcov/rcovtask'
 # Rcov::RcovTask.new do |test|
 #   test.libs << 'test'
@@ -53,6 +32,6 @@ Rake::RDocTask.new do |rdoc|
 end
 
 desc "Open an irb session preloaded with this library"
-task :gem_console do
+task :console do
   sh "irb -I lib -r s3_cors_fileupload.rb"
 end

data/lib/generators/s3_cors_fileupload/install/templates/views/index.html.erb

@@ -2,7 +2,7 @@
 
 <div style="padding: 10px;">
   <h2>Upload file</h2>
-  <%= s3_cors_fileupload_form :id => 'fileupload' %>
+  <%= s3_cors_fileupload_form_tag :id => 'fileupload' %>
 
   <div class="javascript-templates">
     <%= render 'template_upload' %>

data/lib/s3_cors_fileupload/rails/form_helper.rb

@@ -15,7 +15,7 @@ module S3CorsFileupload
     #                   Defaults to `Config.bucket` (read from the yaml config file).
     #
     # Any other key creates standard HTML options for the form tag.
-    def s3_cors_fileupload_form(options = {}, &block)
+    def s3_cors_fileupload_form_tag(options = {}, &block)
       policy_helper = PolicyHelper.new(options)
       # initialize the hidden form fields
       hidden_form_fields = {
@@ -32,6 +32,8 @@ module S3CorsFileupload
       # return the form html
       construct_form_html(hidden_form_fields, policy_helper.options[:bucket], _html_options,  &block)
     end
+
+    alias_method :s3_cors_fileupload_form, :s3_cors_fileupload_form_tag
     
     private
     

data/lib/s3_cors_fileupload/version.rb

@@ -1,5 +1,5 @@
 module S3CorsFileupload
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
   JQUERY_FILEUPLOAD_VERSION = '5.19'
   JQUERY_FILEUPLOAD_UI_VERSION = '6.10'
 end

data/s3_cors_fileupload.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["benatkins@fullbridge.com"]
   s.homepage    = "http://github.com/fullbridge-batkins/s3_cors_fileupload"
   s.summary     = "File uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload script"
-  s.description = "A Ruby gem for providing File uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload script"
+  s.description = "A gem for providing File uploads for Rails ~> 3.1 to AWS-S3 via CORS using the jQuery-File-Upload script"
   s.licenses    = ["MIT"]
   
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
@@ -21,8 +21,6 @@ Gem::Specification.new do |s|
   
   s.add_development_dependency('rake', [">= 0.8.7"])
   s.add_development_dependency('bundler', [">= 0"])
-  s.add_development_dependency('rdoc', ["~> 3.12"])
-  s.add_development_dependency('jeweler', ["~> 1.8.4"])
   
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3_cors_fileupload
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -91,40 +91,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.4
-description: A Ruby gem for providing File uploads for Rails ~> 3.1 to AWS-S3 via
-  CORS using the jQuery-File-Upload script
+description: A gem for providing File uploads for Rails ~> 3.1 to AWS-S3 via CORS
+  using the jQuery-File-Upload script
 email:
 - benatkins@fullbridge.com
 executables: []
@@ -136,6 +104,7 @@ files:
 - .document
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt