RubyGems - rails_pallet - Versions diffs - 2.0.0 - Mend

rails_pallet 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

checksums.yaml +7 -0
data/.editorconfig +24 -0
data/.gitignore +10 -0
data/.rspec +3 -0
data/CHANGELOG.md +69 -0
data/Gemfile +15 -0
data/Gemfile.lock +213 -0
data/Guardfile +11 -0
data/MIT-LICENSE +20 -0
data/README.md +233 -0
data/Rakefile +36 -0
data/app/assets/images/rails_pallet/.keep +0 -0
data/app/assets/javascripts/rails_pallet/application.js +13 -0
data/app/assets/stylesheets/rails_pallet/application.css +15 -0
data/app/controllers/rails_pallet/application_controller.rb +4 -0
data/app/controllers/rails_pallet/uploads_controller.rb +19 -0
data/app/helpers/rails_pallet/application_helper.rb +4 -0
data/app/models/rails_pallet/upload.rb +61 -0
data/app/responders/rails_pallet_responder.rb +36 -0
data/app/serializers/rails_pallet/upload_serializer.rb +3 -0
data/app/views/layouts/rails_pallet/application.html.erb +14 -0
data/bin/rails +12 -0
data/config/routes.rb +3 -0
data/db/migrate/20150612152328_create_rails_pallet_uploads.rb +7 -0
data/db/migrate/20150612152417_add_attachment_file_to_uploads.rb +11 -0
data/lib/generators/rails_pallet/install/USAGE +5 -0
data/lib/generators/rails_pallet/install/install_generator.rb +21 -0
data/lib/generators/rails_pallet/install/templates/initializer.rb +9 -0
data/lib/generators/rails_pallet/upload_controller/USAGE +8 -0
data/lib/generators/rails_pallet/upload_controller/templates/controller.rb +15 -0
data/lib/generators/rails_pallet/upload_controller/upload_controller_generator.rb +47 -0
data/lib/rails_pallet/active_record_extension.rb +78 -0
data/lib/rails_pallet/engine.rb +5 -0
data/lib/rails_pallet/version.rb +3 -0
data/lib/rails_pallet.rb +26 -0
data/lib/tasks/rails_pallet_tasks.rake +4 -0
data/paperclip_upload.gemspec +34 -0
metadata +343 -0

data/app/controllers/rails_pallet/uploads_controller.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module RailsPallet
+  class UploadsController < ApplicationController
+    self.responder = RailsPalletResponder
+    respond_to :json
+    skip_before_action :verify_authenticity_token
+    def create
+      new_upload = RailsPallet::Upload.create(permitted_params)
+      respond_with new_upload, status: :created
+    end
+    private
+    def permitted_params
+      params.permit(:file)
+    end
+  end
+end

data/app/helpers/rails_pallet/application_helper.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module RailsPallet
+  module ApplicationHelper
+  end
+end

data/app/models/rails_pallet/upload.rb ADDED Viewed

@@ -0,0 +1,61 @@
+# == Schema Information
+#
+# Table name: rails_pallet_uploads
+#
+#  id                :integer          not null, primary key
+#  created_at        :datetime         not null
+#  updated_at        :datetime         not null
+#  file_file_name    :string
+#  file_content_type :string
+#  file_file_size    :integer
+#  file_updated_at   :datetime
+#
+module RailsPallet
+  class Upload < ActiveRecord::Base
+    IDENTIFIER_LENGTH = 8
+    has_attached_file :file,
+      path: ':rails_root/public/uploads/:identifier/:filename',
+      url: "/uploads/:identifier/:basename.:extension"
+    do_not_validate_attachment_file_type :file
+    validates_attachment_presence :file
+    def identifier
+      raise "valid with saved instance only" if id.blank?
+      self.class.hashid.encode(id)
+    end
+    def file_extension
+      return unless file.exists?
+      File.extname(file.original_filename).split('.').last
+    end
+    def file_name
+      return unless file.exists?
+      file_file_name.gsub(".#{file_extension}", "")
+    end
+    def self.find_by_identifier(_identifier)
+      decoded_id = identifier_to_id(_identifier)
+      RailsPallet::Upload.find(decoded_id)
+    end
+    def download_url
+      file.url
+    end
+    def self.hashid
+      Hashids.new(RailsPallet.hash_salt, IDENTIFIER_LENGTH)
+    end
+    def self.identifier_to_id(_identifier)
+      hashid.decode(_identifier).first
+    end
+    Paperclip.interpolates(:identifier) do |attachment, _|
+      attachment.instance.identifier
+    end
+  end
+end

data/app/responders/rails_pallet_responder.rb ADDED Viewed

@@ -0,0 +1,36 @@
+class RailsPalletResponder < ActionController::Responder
+  def respond
+    return display_errors if has_errors?
+    return head :no_content if delete?
+    display resource, status_code: status_code
+  end
+  private
+  def display(_resource, given_options = {})
+    controller.render options.merge(given_options).merge(json: serializer.as_json)
+  end
+  def serializer
+    serializer_class = ActiveModel::Serializer.serializer_for(resource)
+    if serializer_class.present?
+      serializer_class.new(resource, options)
+    else
+      resource
+    end
+  end
+  def status_code
+    return :created if post?
+    :ok
+  end
+  def display_errors
+    controller.render(status: :unprocessable_entity, json: { msg: "invalid_attributes", errors: format_errors })
+  end
+  def format_errors
+    resource.errors.as_json
+  end
+end

data/app/serializers/rails_pallet/upload_serializer.rb ADDED Viewed

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

data/app/views/layouts/rails_pallet/application.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RailsPallet</title>
+  <%= stylesheet_link_tag    "rails_pallet/application", media: "all" %>
+  <%= javascript_include_tag "rails_pallet/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/bin/rails ADDED Viewed

@@ -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/rails_pallet/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 ADDED Viewed

@@ -0,0 +1,3 @@
+RailsPallet::Engine.routes.draw do
+  resources :uploads, only: [:create], defaults: { format: :json }
+end

data/db/migrate/20150612152328_create_rails_pallet_uploads.rb ADDED Viewed

@@ -0,0 +1,7 @@
+class CreateRailsPalletUploads < ActiveRecord::Migration
+  def change
+    create_table :rails_pallet_uploads do |t|
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150612152417_add_attachment_file_to_uploads.rb ADDED Viewed

@@ -0,0 +1,11 @@
+class AddAttachmentFileToUploads < ActiveRecord::Migration
+  def self.up
+    change_table :rails_pallet_uploads do |t|
+      t.attachment :file
+    end
+  end
+  def self.down
+    remove_attachment :rails_pallet_uploads, :file
+  end
+end

data/lib/generators/rails_pallet/install/USAGE ADDED Viewed

@@ -0,0 +1,5 @@
+Description:
+    Install the engine in host app.
+Example:
+    rails generate rails_pallet:install

data/lib/generators/rails_pallet/install/install_generator.rb ADDED Viewed

@@ -0,0 +1,21 @@
+class RailsPallet::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  def create_initializer
+    template "initializer.rb", "config/initializers/rails_pallet.rb"
+  end
+  def mount_routes
+    line = "Rails.application.routes.draw do"
+    gsub_file "config/routes.rb", /(#{Regexp.escape(line)})/mi do |match|
+      <<-HERE.gsub(/^ {9}/, '')
+         #{match}
+           mount RailsPallet::Engine => '/'
+         HERE
+    end
+  end
+  def copy_engine_migrations
+    rake "railties:install:migrations"
+  end
+end

data/lib/generators/rails_pallet/install/templates/initializer.rb ADDED Viewed

@@ -0,0 +1,9 @@
+RailsPallet.setup do |config|
+  # 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.
+  # config.hash_salt = "A new and improved string"
+  # 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.
+  # config.use_prefix = false
+end

data/lib/generators/rails_pallet/upload_controller/USAGE ADDED Viewed

@@ -0,0 +1,8 @@
+Description:
+    Allows you to create a custom controller to handle uploads
+Example:
+    rails generate rails_pallet:upload_controller api/attachments api/base
+    This will create:
+        a controller inside app/controllers/api/attachments_controller.rb inheriting from the existent app/controllers/api/base_controller.rb

data/lib/generators/rails_pallet/upload_controller/templates/controller.rb ADDED Viewed

@@ -0,0 +1,15 @@
+class UploadController < ApplicationController
+  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
+end

data/lib/generators/rails_pallet/upload_controller/upload_controller_generator.rb ADDED Viewed

@@ -0,0 +1,47 @@
+class RailsPallet::UploadControllerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :base_controller, type: :string, default: "application"
+  def generate_controller
+    generate "controller #{resource_path} --no-helper --no-assets --no-view-specs --no-controller-specs"
+  end
+  def replace_controller_with_template
+    copy_file "controller.rb", controller_path, force: true
+  end
+  def customize_controller
+    line = "class UploadController < ApplicationController"
+    gsub_file controller_path, /(#{Regexp.escape(line)})/mi do
+      "class #{controller_class} < #{base_controller_class}"
+    end
+  end
+  def add_routes
+    line = "Rails.application.routes.draw do"
+    gsub_file "config/routes.rb", /(#{Regexp.escape(line)})/mi do |match|
+      <<-HERE.gsub(/^ {9}/, '')
+         #{match}
+           post "#{resource_path}", to: "#{resource_path}#create", defaults: { format: :json }
+         HERE
+    end
+  end
+  private
+  def controller_class
+    "#{name.classify.pluralize}Controller"
+  end
+  def base_controller_class
+    "#{base_controller.classify}Controller"
+  end
+  def controller_path
+    "app/controllers/#{resource_path}_controller.rb"
+  end
+  def resource_path
+    name.tableize
+  end
+end

data/lib/rails_pallet/active_record_extension.rb ADDED Viewed

@@ -0,0 +1,78 @@
+module RailsPallet
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+    class_methods do
+      def has_attached_upload(_paperclip_attr_name, _options = {})
+        load_upload_options(_options)
+        upload_identifier_attr_name = build_upload_attr_name(_paperclip_attr_name, "identifier")
+        upload_attr_name = build_upload_attr_name(_paperclip_attr_name)
+        attr_accessor upload_identifier_attr_name, upload_attr_name
+        before_validation do
+          identifier = send(upload_identifier_attr_name)
+          if identifier
+            found_upload = RailsPallet::Upload.find_by_identifier(identifier)
+            send("#{upload_attr_name}=", found_upload)
+          end
+          upload_object = send(upload_attr_name)
+          if upload_object
+            if !upload_object.is_a?(RailsPallet::Upload)
+              raise "invalid RailsPallet::Upload instance"
+            end
+            send("#{_paperclip_attr_name}=", upload_object.file)
+            upload_object.destroy
+          end
+        end
+        has_attached_file(_paperclip_attr_name, _options)
+      end
+      def allow_encoded_file_for(_paperclip_attr_name)
+        encoded_attr_name = "encoded_#{_paperclip_attr_name}"
+        attr_accessor encoded_attr_name
+        before_validation do
+          encoded_attr = send(encoded_attr_name)
+          if encoded_attr
+            headerless_encoded_file = encoded_attr.split(",").last
+            StringIO.open(Base64.decode64(headerless_encoded_file)) do |data|
+              send("#{_paperclip_attr_name}=", data)
+            end
+          end
+        end
+      end
+      private
+      def build_upload_attr_name(_paperclip_attr_name, _sufix = nil)
+        if !!upload_options.fetch(:use_prefix, RailsPallet.use_prefix)
+          prefix = _paperclip_attr_name
+        end
+        upload_attr_name = [prefix, ["upload", _sufix].compact.join("_")].compact.join("_")
+        if self.method_defined?(upload_attr_name)
+          raise "you are trying to redefine #{upload_attr_name} attribute"
+        end
+        upload_attr_name
+      end
+      def load_upload_options(_options = {})
+        @upload_options = _options.fetch(:upload, {})
+      end
+      def upload_options
+        @upload_options ||= {}
+      end
+    end
+  end
+end
+ActiveRecord::Base.send(:include, RailsPallet::ActiveRecordExtension)

data/lib/rails_pallet/engine.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module RailsPallet
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsPallet
+  end
+end

data/lib/rails_pallet/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module RailsPallet
+  VERSION = "2.0.0"
+end

data/lib/rails_pallet.rb ADDED Viewed

@@ -0,0 +1,26 @@
+require "paperclip"
+require "responders"
+require 'hashids'
+require "active_model_serializers"
+require "rails_pallet/active_record_extension"
+require "rails_pallet/engine"
+module RailsPallet
+  extend self
+  attr_writer :hash_salt, :use_prefix
+  def hash_salt
+    return "default" unless @hash_salt
+    @hash_salt
+  end
+  def use_prefix
+    @use_prefix == true
+  end
+  def setup
+    yield self
+    require "rails_pallet"
+  end
+end

data/lib/tasks/rails_pallet_tasks.rake ADDED Viewed

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_pallet do
+#   # Task goes here
+# end

data/paperclip_upload.gemspec ADDED Viewed

@@ -0,0 +1,34 @@
+$:.push File.expand_path("../lib", __FILE__)
+# Maintain your gem's version:
+require "rails_pallet/version"
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "rails_pallet"
+  s.version     = RailsPallet::VERSION
+  s.authors     = ["Leandro Segovia"]
+  s.email       = ["ldlsegovia@gmail.com"]
+  s.homepage    = "https://github.com/platanus/rails_pallet"
+  s.summary     = "Rails engine to save paperclip attachments asynchronously"
+  s.description = "This gem allows you: 1) perform multiple POST requests to create multiple files. 2) relate those files with a model using identifiers instead the files themselves"
+  s.license     = "MIT"
+  s.files = `git ls-files`.split($/).reject { |fn| fn.start_with? "spec" }
+  s.add_runtime_dependency 'rails', '~> 4.2', '>= 4.2.1'
+  s.add_runtime_dependency 'hashids', '~> 1.0', '>= 1.0.2'
+  s.add_runtime_dependency 'paperclip', '~> 4.2', '>= 4.2.0'
+  s.add_runtime_dependency 'responders', '~> 2.1', '>= 2.1.0'
+  s.add_dependency "active_model_serializers", "~> 0.9.3"
+  s.add_development_dependency 'rspec-rails', '~> 3.2', '>= 3.2.1'
+  s.add_development_dependency "pry-rails", "~> 0.3.3"
+  s.add_development_dependency 'factory_girl_rails', '~> 4.5', '>= 4.5.0'
+  s.add_development_dependency 'shoulda-matchers', '~> 2.8', '>= 2.8.0'
+  s.add_development_dependency 'guard', '~> 2.12', '>= 2.12.5'
+  s.add_development_dependency 'guard-rspec', '~> 4.5', '>= 4.5.0'
+  s.add_development_dependency 'annotate', '~> 2.6', '>= 2.6.6'
+  s.add_development_dependency "sqlite3", '~> 1.3', '>= 1.3.10'
+  s.add_development_dependency "recursive-open-struct", "~> 0.6.4"
+end