rails_pallet 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fcaada380ac4657d466ca952c050755c92dcdc0
+  data.tar.gz: d73eae740295f2df2d7488645a5254ceffc5bcee
+SHA512:
+  metadata.gz: 00d141071caff25e6f4d1a8b543fe515cc876526cc8d370c60b7d5a3dfb7efa426c3bcb56964f4cf6f68328d4d68d37d00df0a9182f935c6619f0b4c8aca3fc3
+  data.tar.gz: aad0ec5f6da60775205274ab9a4c63df622337c6b953a4ec950e6b9b79e3ea491e4e073f227411b31704acc485fad9c97400c040aa7d4177abffd8c80d3c7612

data/.editorconfig

@@ -0,0 +1,24 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.js]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+.DS_Store
+tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format=doc

data/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v2.0.0
+
+##### Fixed
+
+* `skip_before_action :verify_authenticity_token` in uploads controller
+
+##### Changed
+
+* gem name from paperclip_upload to rails_pallet
+
+### v1.2.4
+
+##### Fixed
+* Allow `encoded_[file]` accessor to work with base64 headers.
+
+### v1.2.3
+
+##### Fixed
+
+* Removed `uploads#download` endpoint. Use always `file.url` instead of `file.path`. `file.path` does not work with S3 config.
+
+### v1.2.2
+
+##### Fixed
+
+* Removed tmp and spec files from gemspec definition.
+
+### v1.2.1
+
+##### Changed
+
+* A little refactor to controllers generator.
+
+##### Fixed
+* Autogenerated download url uses `identifier` attribute instead `id`.
+
+### v1.2.0
+
+##### Added
+
+* Add file name, extension and download url to json response.
+
+### v1.1.0
+
+##### Added
+
+* Allow multiple paperclip attributes on same host model to work with uploads.
+
+### v1.0.0
+
+##### Changed
+
+* Use hashids gem to pass upload identifier in a more secure way.
+
+##### Added
+
+* Add uploads controller generator.
+
+##### Removed
+
+* Remove `additional_upload_endpoints` configuration option in favor of uploads controller generator.
+
+### v0.1.0
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in rails_pallet.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+

data/Gemfile.lock

@@ -0,0 +1,213 @@
+PATH
+  remote: .
+  specs:
+    rails_pallet (2.0.0)
+      active_model_serializers (~> 0.9.3)
+      hashids (~> 1.0, >= 1.0.2)
+      paperclip (~> 4.2, >= 4.2.0)
+      rails (~> 4.2, >= 4.2.1)
+      responders (~> 2.1, >= 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.1)
+      actionview (= 4.2.1)
+      activesupport (= 4.2.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    active_model_serializers (0.9.3)
+      activemodel (>= 3.2)
+    activejob (4.2.1)
+      activesupport (= 4.2.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    annotate (2.6.8)
+      activerecord (>= 3.2, <= 4.3)
+      rake (~> 10.4)
+    arel (6.0.0)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    climate_control (0.0.3)
+      activesupport (>= 3.0)
+    cocaine (0.5.7)
+      climate_control (>= 0.0.3, < 1.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.5.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    ffi (1.9.8)
+    formatador (0.2.5)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    guard (2.12.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.5.2)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashids (1.0.2)
+    hitimes (1.2.2)
+    i18n (0.7.0)
+    json (1.8.3)
+    listen (2.10.0)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.0.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.6.2)
+    mimemagic (0.3.0)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    nenv (0.2.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    paperclip (4.3.0)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      cocaine (~> 0.5.5)
+      mime-types
+      mimemagic (= 0.3.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-rails (0.3.4)
+      pry (>= 0.9.10)
+    rack (1.6.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.1)
+      actionmailer (= 4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      activemodel (= 4.2.1)
+      activerecord (= 4.2.1)
+      activesupport (= 4.2.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.1)
+      actionpack (= 4.2.1)
+      activesupport (= 4.2.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    recursive-open-struct (0.6.4)
+    responders (2.1.0)
+      railties (>= 4.2.0, < 5)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-rails (3.2.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    shellany (0.0.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    slop (3.6.0)
+    sprockets (3.4.0)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    timers (4.0.1)
+      hitimes
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  annotate (~> 2.6, >= 2.6.6)
+  factory_girl_rails (~> 4.5, >= 4.5.0)
+  guard (~> 2.12, >= 2.12.5)
+  guard-rspec (~> 4.5, >= 4.5.0)
+  pry-rails (~> 0.3.3)
+  rails_pallet!
+  recursive-open-struct (~> 0.6.4)
+  rspec-rails (~> 3.2, >= 3.2.1)
+  shoulda-matchers (~> 2.8, >= 2.8.0)
+  sqlite3 (~> 1.3, >= 1.3.10)
+
+BUNDLED WITH
+   1.10.6

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec, cmd: 'zeus rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/dummy/spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/dummy/spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/dummy/spec/support/(.+)\.rb$})       { "spec" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Leandro Segovia
+
+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,233 @@
+# Rails Pallet
+
+Rails engine to save [paperclip](https://github.com/thoughtbot/paperclip) attachments asynchronously. For example, if you have an `User` model with `avatar` paperclip attribute, you will:
+
+1. Create a new upload instance to hold the avatar file temporarily.
+1. Create a new user passing the upload id or instance as parameter.
+
+## Installation
+
+Add to your Gemfile...
+
+```ruby
+gem 'rails_pallet'
+```
+
+Run the installer:
+
+```shell
+$ rails generate rails_pallet:install
+```
+
+Then, add an attachment, as usually do, using paperclip.
+
+```shell
+$ rails generate paperclip user avatar
+```
+
+Inside `User` model, you need to execute `has_attached_upload` instead the `has_attached_file` paperclip's method:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_upload :avatar, path: ':rails_root/tmp/users/:id/:filename'
+  do_not_validate_attachment_file_type :avatar
+end
+```
+
+## Usage
+
+### Using `upload_identifier`
+
+**First**: you need to save an upload instance.
+The engine creates the `POST /uploads` endpoint to achieve this.
+After perform a `POST` to `/uploads` with a `file` param, you will get this response:
+
+```json
+{
+    "upload": {
+        "identifier": "rW6q2QZM",
+        "file_extension": "jpg",
+        "file_name": "90033441_BLO_20150607",
+        "download_url": "http://my-server.com/uploads/rW6q2QZM/download"
+    }
+}
+```
+
+**Second**: supposing you have an `UsersController`, you need to perform a `POST /users` to create a new user passing the upload identifier you get previously.
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    respond_with User.create(permitted_params)
+  end
+
+  private
+
+  def permitted_params
+    params.require(:user).permit(:upload_identifier)
+  end
+end
+```
+
+### Using `upload`
+
+You can do something like this:
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    @user = User.new
+    @user.upload = RailsPallet::Upload.create(file: params[:file])
+    @user.save!
+    respond_with @user
+  end
+end
+```
+
+### Using prefix
+
+You will need a way to match an upload resource with a specific attribute if you have two or more paperclip attributes on the same model. To do this, you can pass the option `upload: { use_prefix: true }` on `has_attached_upload` like this:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_upload :avatar, path: ':rails_root/tmp/users/:id/:filename', upload: { use_prefix: true }
+  has_attached_upload :document, path: ':rails_root/tmp/users/:id/:filename', upload: { use_prefix: true }
+  has_attached_upload :photo, path: ':rails_root/tmp/users/:id/:filename'
+end
+```
+
+Then, in your controller...
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    respond_with User.create(permitted_params)
+  end
+
+  private
+
+  def permitted_params
+    params.require(:user).permit(:avatar_upload_identifier, :document_upload_identifier, :upload_identifier)
+  end
+end
+```
+
+or using the upload object...
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    @user = User.new
+    @user.avatar_upload = RailsPallet::Upload.create(file: params[:avatar])
+    @user.document_upload = RailsPallet::Upload.create(file: params[:document])
+    @user.upload = RailsPallet::Upload.create(file: params[:photo])
+    @user.save!
+    respond_with @user
+  end
+end
+```
+
+> If you execute `has_attached_upload` method two or more times in same model with `upload: { use_prefix: false }` (false is the default value), you will be obligated to use the `upload: { use_prefix: true }` option. If you don't, an exception will be raised.
+
+### Base64 Encoding
+
+If you want to save base64 encoded attachments, you can execute the `allow_encoded_file_for` method:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_upload :avatar, path: ':rails_root/tmp/users/:id/:filename'
+  allow_encoded_file_for :avatar
+  do_not_validate_attachment_file_type :avatar
+end
+```
+
+And then...
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    respond_with User.create(permitted_params)
+  end
+
+  private
+
+  def permitted_params
+    params.require(:user).permit(:encoded_avatar)
+    # encoded_avatar param must hold the encoded file
+  end
+end
+```
+
+### Creating your own `UploadsController`
+
+You can generate your own `UploadsController` if for example:
+
+* your controllers don't inherit from the `ApplicationController`
+* you want to change the default route for `UploadsController`. (Also you can map the default controller with another route in your `routes.rb`)
+* you want to add extra logic to the default `UploadsController`
+
+Running...
+
+```shell
+$ rails generate rails_pallet:upload_controller api/uploads api/base
+```
+
+You will get in `your_app/app/controllers/api/uploads_controller.rb`
+
+```ruby
+class Api::UploadsController < Api::BaseController
+  self.responder = RailsPalletResponder
+  respond_to :json
+
+  def create
+    new_upload = RailsPallet::Upload.create(permitted_params)
+    respond_with new_upload, status: :created
+  end
+
+  private
+
+  def permitted_params
+    params.permit(:file)
+  end
+
+  def upload
+    @upload ||= RailsPallet::Upload.find_by_identifier(params[:identifier])
+  end
+end
+```
+
+and the route...
+
+```ruby
+post "api/uploads", to: "api/uploads#create", defaults: { format: :json }
+```
+
+## Configuration
+
+You can change the engine configuration from `your_app/config/initializers/rails_pallet.rb`
+
+#### Configuration Options:
+
+* `hash_salt`: The upload module uses a salt string to generate an unique hash for each instance. A salt string can be defined here to replace the default and increase the module's security.
+
+* `use_prefix`: false by default. If true, you will need to pass `[host_model_paperclip_attribute_name]_+upload|upload_identifier` instead just `upload` or `upload_identifier` to the host model to use an upload resource.
+
+## 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
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/rails_pallet/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+rails_pallet is maintained by [platanus](http://platan.us).
+
+## License
+
+Guides is © 2015 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsPallet'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+require 'thor'
+
+task default: :spec
+
+task :run_dummy_app do
+  Dir.chdir("spec/dummy") do
+    exec("bundle exec rails s -p 3000")
+  end
+end
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/rails_pallet/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/rails_pallet/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/rails_pallet/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsPallet
+  class ApplicationController < ActionController::Base
+  end
+end