paperclip_upload 1.1.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c58857bb4cdcb6781e2384101c2004c1dbf971c0
-  data.tar.gz: f4d312913f2842833ef777e932b50ad919d038e5
+  metadata.gz: d46199ef410968cd3e3f4f1635023ec9f396b3dd
+  data.tar.gz: 4093c1e4f3c47a4acf99da82ecbe38ce8b46917d
 SHA512:
-  metadata.gz: ecfd08b9f27cef70fbf310eafcc80fae09cabefa1f8cf6a6ef6603f45a364f8e95364b746f9aa29e480273e46bd6cd806e4625632be94e1767931f0baf6ac3f7
-  data.tar.gz: fd189c5faafd25ff5b4ddbc4981fda33f3ccc656228b456ba34e2a6fca19e790b120369015f9edb814df50c6b149e3dfe0fc9d52b5381d9b5ee477ebba7862fb
+  metadata.gz: 5ad84a18310b22af6d51fbb132f8be8a04ff39f3eab9e4dff15d33e11c2914a1ece16ff3052374dcf678b7b9608f1580dc8539bce79943e2d340470ba3114f4d
+  data.tar.gz: 704cb5f3b50e839cb9713d7b591cf486333306a8d2e37873ef742ee72486ea3295061f877dfd2d9515cb1f33af70265b0adb3fb553933054fade2c3e008694c9

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,46 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v1.2.2
+
+##### Fixed
+* Removed tmp and spec files from gemspec definition.
+
+### v1.2.1
+
+##### Change
+* 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 paperclip_upload.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,210 @@
+PATH
+  remote: .
+  specs:
+    paperclip_upload (1.2.2)
+      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.5)
+      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.1)
+    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.2.0)
+      rack (~> 1.0)
+    sprockets-rails (2.3.2)
+      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)
+  paperclip_upload!
+  pry-rails (~> 0.3.3)
+  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)

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/README.md

@@ -0,0 +1,246 @@
+# Paperclip Upload
+
+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 'paperclip_upload'
+```
+
+Run the installer:
+
+```shell
+$ rails generate paperclip_upload: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 = PaperclipUpload::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 = PaperclipUpload::Upload.create(file: params[:avatar])
+    @user.document_upload = PaperclipUpload::Upload.create(file: params[:document])
+    @user.upload = PaperclipUpload::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 paperclip_upload: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 = PaperclipUploadResponder
+  respond_to :json
+
+  def create
+    new_upload = PaperclipUpload::Upload.create(permitted_params)
+    set_download_url(new_upload)
+    respond_with new_upload, status: :created
+  end
+
+  def download
+    send_file(upload.file.path, type: upload.file_content_type, disposition: 'inline')
+  end
+
+  private
+
+  def permitted_params
+    params.permit(:file)
+  end
+
+  def upload
+    @upload ||= PaperclipUpload::Upload.find_by_identifier(params[:identifier])
+  end
+
+  private
+
+  def set_download_url(_upload)
+    _upload.singleton_class.send(:attr_accessor, :download_url)
+    _upload.download_url = download_api_upload_url(identifier: _upload.identifier)
+  end
+end
+```
+
+and the routes...
+
+```ruby
+post "api/uploads", to: "api/uploads#create", defaults: { format: :json }
+get "api/uploads/:identifier/download", to: "api/uploads#download", defaults: { format: :json }, as: :download_api_upload
+```
+
+## Configuration
+
+You can change the engine configuration from `your_app/config/initializers/paperclip_upload.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/paperclip_upload/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+paperclip_upload 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/app/controllers/paperclip_upload/uploads_controller.rb

@@ -4,7 +4,13 @@ module PaperclipUpload
     respond_to :json
 
     def create
-      respond_with PaperclipUpload::Upload.create(permitted_params), status: :created
+      new_upload = PaperclipUpload::Upload.create(permitted_params)
+      set_download_url(new_upload)
+      respond_with new_upload, status: :created
+    end
+
+    def download
+      send_file(upload.file.path, type: upload.file_content_type, disposition: 'inline')
     end
 
     private
@@ -12,5 +18,16 @@ module PaperclipUpload
     def permitted_params
       params.permit(:file)
     end
+
+    def upload
+      @upload ||= PaperclipUpload::Upload.find_by_identifier(params[:identifier])
+    end
+
+    private
+
+    def set_download_url(_upload)
+      _upload.singleton_class.send(:attr_accessor, :download_url)
+      _upload.download_url = download_url(identifier: _upload.identifier)
+    end
   end
 end

data/app/models/paperclip_upload/upload.rb

@@ -25,8 +25,19 @@ module PaperclipUpload
       self.class.hashid.encode(self.id)
     end
 
-    def self.identifier_to_id(_identifier)
-      self.hashid.decode(_identifier).first
+    def file_extension
+      return unless self.file.exists?
+      File.extname(self.file.original_filename).split('.').last
+    end
+
+    def file_name
+      return unless self.file.exists?
+      self.file_file_name.gsub(".#{file_extension}", "")
+    end
+
+    def self.find_by_identifier(_identifier)
+      decoded_id = identifier_to_id(_identifier)
+      PaperclipUpload::Upload.find(decoded_id)
     end
 
     private
@@ -34,5 +45,9 @@ module PaperclipUpload
     def self.hashid
       Hashids.new(PaperclipUpload.hash_salt, IDENTIFIER_LENGTH)
     end
+
+    def self.identifier_to_id(_identifier)
+      self.hashid.decode(_identifier).first
+    end
   end
 end

data/app/serializers/paperclip_upload/upload_serializer.rb

@@ -1,3 +1,3 @@
 class PaperclipUpload::UploadSerializer < ActiveModel::Serializer
-  attributes :identifier
+  attributes :identifier, :file_extension, :file_name, :download_url
 end

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/paperclip_upload/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -1,3 +1,4 @@
 PaperclipUpload::Engine.routes.draw do
   resources :uploads, only: [:create], defaults: { format: :json }
+  get '/uploads/:identifier/download', to: 'uploads#download', as: :download
 end