paperclip_private 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66481098f3f82d89f0bfb3e357804c7603159aef
+  data.tar.gz: 791cde5a10795fb9cd4faa0d3b1d16f843740c57
+SHA512:
+  metadata.gz: 390dfc6fafd5108e6d1e4088fed7db870c1bf44fa482e79d61b4be2f3747270dd1309117860cfd6505411f70e35eeb2d2243a67e2213f220dbb505be42cf7499
+  data.tar.gz: 01c204df3132537a2e1106f14fd6936b43c12b4216ba51c34ab657f567d1a3970a06fc88e95d8529286312ea4bccd2360edafab44376aea97f30e1c8d44b7a99

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in paperclip_private.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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 jose
+
+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,31 @@
++---
++
++Private Attachments
++-------------------
++If you want to place files behind a controller in order to perform validation you can.
++
++In your routes.rb file mount the paperclip engine with any path you'd like. 
++Ex:
++```ruby
++mount PaperclipPrivate::Engine => 'paperclip/'
++```
++
++In your ApplicationController add the method `paperclip_whitelist` which returns an array of the models with attachments you would like to serve privately. 
++Ex:
++```ruby
++def paperclip_whitelist
++  [PrivateAttachment]
++end
++```
++
++Then in your model add `privacy: :private` to the has_attached_file options. Then add the method `can_download_attachment?`. 
++The method `can_download_attachment?` gets passed the controller instance and the params and is expected to return true, false, or raise Paperclip::Errors::AccessDeniedError.
++The controller is passed so that methods like current_user can be run on it to get the user instance for validation puprposes. Duplicated params gets passed to do things like allow anyone if the style is :thumb or to only allow :original to paid users.
++Ex:
++```ruby
++  has_attached_file :file, privacy: :private
++
++  def can_download_attachment?(controller, params)
++    params[:style] == :thumb || (!controller.current_user.nil? && created_by == controller.current_user.id)
++  end
++```

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'PaperclipPrivate'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/paperclip_private/attachment_controller.rb

@@ -0,0 +1,75 @@
+module PaperclipPrivate
+	class AttachmentController < ::ApplicationController
+		before_action :validate_params!
+		before_action :set_attachment
+		before_action :set_path
+		before_action :confirm_attachment_access!
+		rescue_from ActiveRecord::RecordNotFound, with: :handle_not_found!
+		rescue_from ::PaperclipPrivate::Errors::FileDoesNotExistError, with: :handle_not_found!
+		rescue_from ::PaperclipPrivate::Errors::ControllerValidationError, with: :hadle_bad_params!
+		rescue_from ::PaperclipPrivate::Errors::AccessDeniedError, with: :handle_access_denied!
+
+		# Download action
+		def download
+			send_file(@path)
+		end
+
+		protected
+		# Return the private arratcment registry
+		def paperclip_whitelist
+			super if self.class.superclass.instance_methods.include?(:paperclip_whitelist) # Call classes in an array so they appear in the registry.
+			::PaperclipPrivate::AttachmentRegistry.registry 
+		end
+
+		private
+		# Confirm class name is valid and attachment name is valid before calling constantize in set_attachment method.
+		def validate_params!
+			attachments = paperclip_whitelist[params[:class_name]]
+			raise ::PaperclipPrivate::Errors::ControllerValidationError if attachments.nil? || !attachments.keys.map(&:to_s).include?(params[:attachment])
+			@options = attachments[params[:attachment].to_sym]
+		end	
+
+		# Sets object, attachment, and styles
+		def set_attachment
+			klass = params[:class_name].constantize
+			object_id = params[:id]
+			@object = klass.find(object_id)
+			@attachment = @object.send(params[:attachment])
+			@styles = @options[:styles] || {}
+			@styles = @styles.call(@attachment) if @styles.respond_to?(:call)
+		end
+
+		# Sets path and confirms the file exists.
+		def set_path
+			@path = @styles.keys.map(&:to_s).include?(params[:style]) ? @attachment.path(params[:style]) : @attachment.path
+			raise ::PaperclipPrivate::Errors::FileDoesNotExistError unless File.exist?(@path)
+		end
+
+		# Confirms the download is allowed.
+		def confirm_attachment_access!
+			# Passes self and params.dup to object.can_download_attachment? that is expected to return true, false, or raise AccessDeniedError.
+			# self is passed so that methods like current_user can be run. params.dup gets passed to do things like allow anyone if the style is :thumb but
+			# to only allow :original to paid users for example.
+			# Considering refactoring to use config options to specify the get user method and send the result of that method on self to 
+			# object.can_download_attachment? instead of passing controller instance.
+			raise ::PaperclipPrivate::Errors::AccessDeniedError unless @object.respond_to?(:can_download_attachment?) && @object.can_download_attachment?(self, params.dup)
+		end
+
+		# Handles what should happen when the route params do not pass validation.
+		def hadle_bad_params!
+			head 400
+		end
+
+		# Handles what should happen when the record or file is not found.
+		def handle_not_found!
+			head 404
+		end
+
+		# Handles what should happen when the object's can_download_attachment? method does not return true.
+		def handle_access_denied!
+			head 401
+		end
+
+
+	end
+end

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/paperclip_private/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

@@ -0,0 +1,3 @@
+PaperclipPrivate::Engine.routes.draw do
+	get 'private/:class_name/:id/:attachment/:style', controller: Paperclip.options[:controller] || 'paperclip_private/attachment', action: Paperclip.options[:action] || 'download'
+end

data/lib/paperclip_private.rb

@@ -0,0 +1,11 @@
+require 'paperclip'
+require 'paperclip_private/interpolations'
+require 'paperclip_private/attachment'
+require 'paperclip_private/errors'
+require 'paperclip_private/has_attached_file'
+require 'paperclip_private/attachment_registry'
+require 'paperclip_private/engine'
+
+Paperclip::Attachment.include PaperclipPrivate::Attachment
+Paperclip::HasAttachedFile.prepend PaperclipPrivate::HasAttachedFile
+Paperclip::Interpolations.extend PaperclipPrivate::Interpolations

data/lib/paperclip_private/attachment.rb

@@ -0,0 +1,33 @@
+module PaperclipPrivate
+	module Attachment
+
+		def self.included(base)
+			base.extend ClassMethods 
+			base.prepend Initializer
+		end
+
+		module ClassMethods
+
+			def default_options
+				super.merge({privacy: :public})
+			end
+
+		end
+
+		module Initializer
+			def initialize(name, instance, options = {})
+	      defaults = self.class.default_options.dup
+	      if options[:privacy] == :private # change default options if private before merging with options.
+	        defaults[:path] = ":rails_root/:privacy#{defaults[:url]}"
+	        defaults[:url] = "#{Rails.application.routes.url_helpers.paperclip_private_engine_path}/private/:klass/:id/:attachment_singular/:style" 
+	      end
+	      options = defaults.deep_merge(options)
+
+	      super(name, instance, options)
+	    end
+		end
+
+		
+
+	end
+end

data/lib/paperclip_private/attachment_registry.rb

@@ -0,0 +1,13 @@
+module PaperclipPrivate
+	module AttachmentRegistry
+		def self.registry
+			@registry ||= {}
+		end
+
+		def self.register(klass, name, options)
+			class_name = klass.to_s
+			self.registry[class_name] ||= {}
+			self.registry[class_name][name] = options
+		end
+	end
+end

data/lib/paperclip_private/engine.rb

@@ -0,0 +1,4 @@
+module PaperclipPrivate
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/paperclip_private/errors.rb

@@ -0,0 +1,18 @@
+module PaperclipPrivate
+
+  module Errors
+    # Wil be thrown if params validation fails in private controller.
+    class ControllerValidationError < ::Paperclip::Error
+    end
+
+    # Will be thrown if file does not exist on server.
+    class FileDoesNotExistError < ::Paperclip::Error
+    end
+
+    # Will be thrown if true is not returned from an attachment's owner's
+    # can_download_attachment? method.
+    class AccessDeniedError < ::Paperclip::Error
+    end
+
+  end
+end

data/lib/paperclip_private/has_attached_file.rb

@@ -0,0 +1,10 @@
+module PaperclipPrivate
+  module HasAttachedFile
+        
+    def register_new_attachment
+      super
+      PaperclipPrivate::AttachmentRegistry.register(@klass, @name, @options) if @options[:privacy] == :private
+    end
+
+  end
+end

data/lib/paperclip_private/interpolations.rb

@@ -0,0 +1,26 @@
+module PaperclipPrivate
+	module Interpolations
+
+    def self.extended(base)
+      base.instance_eval do
+        ::PaperclipPrivate::Interpolations.instance_methods(false).each { |m| define_method(m, self.method(m)) }
+      end
+    end
+
+    # Returns the style, or the default style if nil is supplied.
+    def privacy(attachment, style_name)
+      attachment.options[:privacy]
+    end
+
+    # Returns the class name without pluarlizing it.
+    def klass(attachment, style_name)
+      attachment.instance.class
+    end
+
+    # Returns the attachment name without pluralizing it
+    def attachment_singular(attachment, style_name)
+      attachment.name
+    end
+
+	end
+end

data/lib/paperclip_private/version.rb

@@ -0,0 +1,3 @@
+module PaperclipPrivate
+  VERSION = '0.0.2'
+end

data/lib/tasks/paperclip_private_tasks.rake

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

data/paperclip_private.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "paperclip_private/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "paperclip_private"
+  s.version     = PaperclipPrivate::VERSION
+  s.authors     = ["jose"]
+  s.email       = ["nextgenappsllc@gmail.com"]
+  s.homepage    = "https://nextgenappsllc.com"
+  s.summary     = "Allows for creation of private attachments with paperclip gem."
+  s.description = "Allows restrcition of access to paperclip attachments with a private option."
+  s.license     = "MIT"
+
+  s.files       = `git ls-files`.split("\n")
+  # s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
+
+  s.add_dependency "rails", "~> 4.0"
+  s.add_dependency "paperclip", "~> 5.0"
+
+  s.add_development_dependency "sqlite3", "~> 1.0"
+end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link paperclip_private_manifest.js

data/test/dummy/app/assets/javascripts/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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/test/dummy/app/assets/stylesheets/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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */