paperclip_upload 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffea8a1951c55d4cd81aab781355bca818cc572a
-  data.tar.gz: 5e0ca02268e53c4eca741515bc6e41419938bcce
+  metadata.gz: 634b300e660876d996d1f717093f2cd65f4c6aba
+  data.tar.gz: f81e5cb3f748537e0c6d46fd4c8f3faeed23d29c
 SHA512:
-  metadata.gz: 0a972c31c9b3fbf19dfa6d0f191cda2530a36a8af4d9d81dbc64d294401773382b7d4de79420615c900155216f7a59801500113ab076162d220b1e55e946ea65
-  data.tar.gz: 80e73d1bf12564f43659dab0fbebd3c1df832f94901ad962770eacdb8716da0fedb667384bd007683784857342524566dff1e78cc03500b5af90e8dcca89c8ce
+  metadata.gz: ded439b53ccc9ab6a00953f1502476a64fb84fe3351fb6edf79a26db1ba2030079d3aaf5fd4dff4aeb4fb229578d6a1fe474b8d33899acdaabacfb5d673d41db
+  data.tar.gz: 9f0a12b84460e38c29e5d2845716c5913992f1696b27c376165b37438cf335559ad58d45341a55f182470b0acd55308c24dae36a5a6279a0f05a61b39e7287e8

data/app/controllers/paperclip_upload/uploads_controller.rb

@@ -3,10 +3,6 @@ module PaperclipUpload
     self.responder = PaperclipUploadResponder
     respond_to :json
 
-    def show
-      respond_with upload
-    end
-
     def create
       respond_with PaperclipUpload::Upload.create(permitted_params), status: :created
     end
@@ -16,9 +12,5 @@ module PaperclipUpload
     def permitted_params
       params.permit(:file)
     end
-
-    def upload
-      @upload ||= Upload.find(params[:id])
-    end
   end
 end

data/app/models/paperclip_upload/upload.rb

@@ -13,9 +13,26 @@
 
 module PaperclipUpload
   class Upload < ActiveRecord::Base
+    IDENTIFIER_LENGTH = 8
+
     has_attached_file :file, path: ':rails_root/tmp/uploads/:id/:filename'
 
     do_not_validate_attachment_file_type :file
     validates_attachment_presence :file
+
+    def identifier
+      raise "valid with saved instance only" if self.id.blank?
+      self.class.hashid.encode(self.id)
+    end
+
+    def self.identifier_to_id(_identifier)
+      self.hashid.decode(_identifier).first
+    end
+
+    private
+
+    def self.hashid
+      Hashids.new(PaperclipUpload.hash_salt, IDENTIFIER_LENGTH)
+    end
   end
 end

data/app/serializers/paperclip_upload/upload_serializer.rb

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

data/config/routes.rb

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

data/lib/generators/paperclip_upload/{install_generator.rb → install/install_generator.rb}

@@ -1,10 +1,17 @@
 class PaperclipUpload::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
+  def create_initializer
+    template "initializer.rb", "config/initializers/paperclip_upload.rb"
+  end
+
   def mount_routes
     line = "Rails.application.routes.draw do"
     gsub_file "config/routes.rb", /(#{Regexp.escape(line)})/mi do |match|
-      "#{match}\n  mount PaperclipUpload::Engine => '/'\n"
+      <<-HERE.gsub(/^ {9}/, '')
+         #{match}
+           mount PaperclipUpload::Engine => '/'
+         HERE
     end
   end
 

data/lib/generators/paperclip_upload/install/templates/initializer.rb

@@ -0,0 +1,5 @@
+PaperclipUpload.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"
+end

data/lib/generators/paperclip_upload/upload_controller/templates/controller.rb

@@ -0,0 +1,14 @@
+class UploadController < ApplicationController
+  self.responder = PaperclipUploadResponder
+  respond_to :json
+
+  def create
+    respond_with PaperclipUpload::Upload.create(permitted_params), status: :created
+  end
+
+  private
+
+  def permitted_params
+    params.permit(:file)
+  end
+end

data/lib/generators/paperclip_upload/upload_controller/upload_controller_generator.rb

@@ -0,0 +1,29 @@
+class PaperclipUpload::UploadControllerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :base_controller, type: :string, :default => "application"
+
+  def generate_controller
+    generate "controller #{name}"
+  end
+
+  def replace_controller_with_template
+    copy_file "controller.rb", "app/controllers/#{name}_controller.rb", force: true
+  end
+
+  def customize_controller
+    line = "class UploadController < ApplicationController"
+    gsub_file "app/controllers/#{name}_controller.rb", /(#{Regexp.escape(line)})/mi do |match|
+      "class #{name.classify.pluralize}Controller < #{base_controller.classify}Controller"
+    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 "#{name}", to: "#{name}#create", defaults: { format: :json }
+         HERE
+    end
+  end
+end

data/lib/paperclip_upload/active_record_extension.rb

@@ -4,11 +4,14 @@ module PaperclipUpload
 
     class_methods do
       def has_attached_upload(_paperclip_attr_name, _options = {})
-        attr_accessor :upload_id
+        attr_accessor :upload_identifier
         attr_accessor :upload
 
         before_validation do
-          self.upload = PaperclipUpload::Upload.find(self.upload_id) if self.upload_id
+          if self.upload_identifier
+            decoded_id = PaperclipUpload::Upload.identifier_to_id(self.upload_identifier)
+            self.upload = PaperclipUpload::Upload.find(decoded_id)
+          end
 
           if self.upload
             if !self.upload.is_a? PaperclipUpload::Upload

data/lib/paperclip_upload/version.rb

@@ -1,3 +1,3 @@
 module PaperclipUpload
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/paperclip_upload.rb

@@ -1,8 +1,22 @@
 require "paperclip"
 require "responders"
+require 'hashids'
 require "active_model_serializers"
 require "paperclip_upload/active_record_extension"
 require "paperclip_upload/engine"
 
 module PaperclipUpload
+  extend self
+
+  attr_writer :hash_salt
+
+  def hash_salt
+    return "default" unless @hash_salt
+    @hash_salt
+  end
+
+  def setup
+    yield self
+    require "paperclip_upload"
+  end
 end

data/spec/dummy/README.md

@@ -0,0 +1 @@
+# HI! I'm just a dummy app

data/spec/dummy/config/initializers/paperclip_upload.rb

@@ -0,0 +1,5 @@
+PaperclipUpload.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"
+end

data/spec/dummy/config/routes.rb

@@ -1,4 +1,3 @@
 Rails.application.routes.draw do
-
-  mount PaperclipUpload::Engine => "/"
+  mount PaperclipUpload::Engine => '/'
 end

data/spec/dummy/log/development.log

@@ -5106,3 +5106,23 @@ Migrating to AddAttachmentPhotoToPromotions (20150613212609)
    (0.1ms)  begin transaction
   SQL (0.4ms)  INSERT INTO "promotions" ("created_at", "updated_at") VALUES (?, ?)  [["created_at", "2015-06-13 22:09:43.053785"], ["updated_at", "2015-06-13 22:09:43.053785"]]
    (1.6ms)  commit transaction
+  PaperclipUpload::Upload Load (0.6ms)  SELECT  "paperclip_upload_uploads".* FROM "paperclip_upload_uploads" WHERE "paperclip_upload_uploads"."id" = ? LIMIT 1  [["id", 1]]
+  PaperclipUpload::Upload Load (0.1ms)  SELECT  "paperclip_upload_uploads".* FROM "paperclip_upload_uploads" WHERE "paperclip_upload_uploads"."id" = ? LIMIT 1  [["id", 0]]
+  PaperclipUpload::Upload Load (0.1ms)  SELECT  "paperclip_upload_uploads".* FROM "paperclip_upload_uploads" WHERE "paperclip_upload_uploads"."id" = ? LIMIT 1  [["id", 0]]
+  PaperclipUpload::Upload Load (0.2ms)  SELECT "paperclip_upload_uploads".* FROM "paperclip_upload_uploads" WHERE "paperclip_upload_uploads"."id" IN (1, 2)
+  PaperclipUpload::Upload Load (0.2ms)  SELECT "paperclip_upload_uploads".* FROM "paperclip_upload_uploads" WHERE "paperclip_upload_uploads"."id" IN (1, 33)
+
+
+Started GET "/" for ::1 at 2015-06-26 10:03:48 -0300
+  ActiveRecord::SchemaMigration Load (0.5ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Processing by Rails::WelcomeController#index as HTML
+  Rendered /opt/rubies/2.0.0-p645/lib/ruby/gems/2.0.0/gems/railties-4.2.1/lib/rails/templates/rails/welcome/index.html.erb (1.7ms)
+Completed 200 OK in 8ms (Views: 8.1ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/" for ::1 at 2015-06-26 10:13:19 -0300
+Processing by Rails::WelcomeController#index as HTML
+  Rendered /opt/rubies/2.0.0-p645/lib/ruby/gems/2.0.0/gems/railties-4.2.1/lib/rails/templates/rails/welcome/index.html.erb (0.1ms)
+Completed 200 OK in 2ms (Views: 1.6ms | ActiveRecord: 0.0ms)
+DEPRECATION WARNING: Defining a route where `to` is a controller without an action is deprecated. Please change `to: :api/uploads/create` to `controller: :api/uploads/create`. (called from block in <top (required)> at /Users/leandro/src/paperclip_upload/spec/dummy/config/routes.rb:2)
+DEPRECATION WARNING: Defining a route where `to` is a controller without an action is deprecated. Please change `to: :api/uploads/create` to `controller: :api/uploads/create`. (called from block in <top (required)> at /Users/leandro/src/paperclip_upload/spec/dummy/config/routes.rb:2)