paperclipdropbox 1.0.8 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3caf3c27aec6a6978cca5c888b76e4127c9379e213b791e9cc49891c8f39e3ae
+  data.tar.gz: 2f3a61df314fa088bff4db64b8a6000fbac58a9f0cc527637034f2f5638c130f
+SHA512:
+  metadata.gz: 4329bff0e3a724751c9ae1499528bfcedd80d882f032e5e075cc79fdb69096cfe36e41ab5bfa9c24bdff3f83be61eac31eaa7487e37f0beacb0f207caafeaf17
+  data.tar.gz: 7f361b0a95e4202145d805d193a4f103bba6cf048962a747f8b9756ee0f9db99194c38a5020551e0625ee842b4b65314aed52d461a3e1076d823a3fdb45e20bd

data/README.rdoc

@@ -1,11 +1,9 @@
 = PaperclipDropboxStorage
 
-Dropbox storage support for paperclip file attachment plugin.
+Dropbox storage support for kt-paperclip file attachment plugin.
 
 == Install
 
-=== Rails 3
-
 You can let bundler install Paperclip Dropbox Plugin by adding this line to your application's Gemfile:
 
   gem 'paperclipdropbox'
@@ -18,9 +16,9 @@ Or install it yourself as:
 
   gem install paperclipdropbox
 
-Then create the paperclipdropbox.yml file and run the authotization rake task
+Then run the authotization task
 
-  rake paperclipdropbox:authorize
+  rails paperclipdropbox:authorize
 
 you'll then be given a url to login to dropbox to authorize this plugin access to your dropbox account.
 
@@ -31,25 +29,35 @@ In your model:
 
   class User < ActiveRecord::Base
     has_attached_file :avatar,
-                      :styles => { :medium => "300x300>", :thumb => "100x100>" },
-                      :storage => :Dropboxstorage,
-                      :path => "/:attachment/:attachment/:id/:style/:filename"
+                      styles: { medium: "300x300>", thumb: "100x100>" }, 
+                      default_url: "/missing.png",
+                      storage: :Dropbox,
+                      path: ":class/:attachment/:style/:id_:filename"
   end
 
+Add a migration script to add the dropbox_share_urls column
+
+  class AddDropboxShareIdsToUsers < ActiveRecord::Migration[7.0]
+    def change
+      add_column :users, :dropbox_share_urls, :string, default: "{}", null: false
+    end
+  end
 
 == Optional
 
-Create the file config/paperclipdropbox.yml:
+=== App Folder
+This is the first folder in your dropbox before the paths take effect
+
+==== Usage
+  app_folder: "Rails_Super_App", # defaults to "Paperclip_Dropbox" if not passed
 
-  development:
-    dropbox_key: user_email
-    dropbox_secret: user_password
-    path: "/:attachment/:attachment/:id/:style/:filename"
+=== Remove Url Redirects
+This is a experimental.. the urls provided by Dropbox are redirecting urls. this adds additional time to the image load to the user.
+this option will follow the redirect url and get the direct url to pass to the browser. 
 
-  test:
-    ...
+However this url will expire in 3-4 hours. The direct url is cached in Rails with a lifetime of 3 hours. at wich point it will retreive a new direct url to use. 
 
-  production:
-    ...
+AGAIN EXPERIMENTAL so this can cause longer page loads when it needs to go and get the new direct url.
 
-You can add the path option to the config/paperclipdropbox.yml file for ease of use.
+==== Usage
+    remove_url_redirects: true, # default is false

data/lib/paperclipdropbox/railtie.rb

@@ -1,5 +1,6 @@
 require 'paperclipdropbox'
 require 'rails'
+
 module Paperclipdropbox
   class Railtie < Rails::Railtie
 

data/lib/paperclipdropbox/version.rb

@@ -1,3 +1,3 @@
 module Paperclipdropbox
-  VERSION = "1.0.8"
+  VERSION = "2.0.0"
 end

data/lib/paperclipdropbox.rb

@@ -2,89 +2,184 @@ module Paperclipdropbox
   require 'paperclipdropbox/railtie' if defined?(Rails)
 end
 
+require 'http'
+require "dropbox_api"
+
 module Paperclip
 	module Storage
-		module Dropboxstorage
-    extend self
+		module Dropbox
     
+			CONFIG_FILE = "/config/paperclipdropbox.yml"
+
 			def self.extended(base)
-				require "dropbox"
 				base.instance_eval do
-					
-					@dropbox_key = '8ti7qntpcysl91j'
-					@dropbox_secret = 'i0tshr4cpd1pa4e'
-					@dropbox_public_url = "http://dl.dropbox.com/u/"
-					@options[:url] ="#{@dropbox_public_url}#{user_id}#{@options[:path]}"
-					@url = @options[:url]
-					@path = @options[:path]
-					log("Starting up DropBox Storage")
+					@options[:escape_url] = false
+					app_folder = @options[:app_folder] || 'Paperclip_Dropbox/'
+          unless @options[:url].to_s.match(/\A:dropdox.com\z/)
+						@options[:path] = app_folder + @options[:path].gsub(/:url/, @options[:url]).gsub(/\A:rails_root\/public\/system\//, "")
+          	@options[:url]  = ":dropbox_file_url"
+          end
 				end
+
+        unless Paperclip::Interpolations.respond_to? :dropbox_file_url
+          Paperclip.interpolates(:dropbox_file_url) do |attachment, style|
+            attachment.public_url(style)
+          end
+        end
 			end
 
 			def exists?(style = default_style)
-				log("exists?  #{style}") if respond_to?(:log)
 				begin
-					dropbox_session.metadata("/Public#{File.dirname(path(style))}")
-					log("true") if respond_to?(:log)
+					dropbox_client.get_metadata("/#{path(style)}")
 					true
 				rescue
-					log("false") if respond_to?(:log)
 					false
 				end
 			end
 
-			def to_file(style=default_style)
-				log("to_file  #{style}") if respond_to?(:log)
-				return @queued_for_write[style] || "#{@dropbox_public_url}#{user_id}/#{path(style)}"
-			end
-
-			def flush_writes #:nodoc:
-				log("[paperclip] Writing files #{@queued_for_write.count}")
+			def flush_writes
+				share_urls = false
+				share_urls = {} unless @queued_for_write.empty?
 				@queued_for_write.each do |style, file|
-					log("[paperclip] Writing files for ") if respond_to?(:log)
-					# Error --> undefined method close for #<Paperclip::
-					# file.close
-					dropbox_session.upload(file.path, "/Public#{File.dirname(path(style))}", :as=> File.basename(path(style)))
+					begin
+						dropbox_client.upload_by_chunks "/#{path(style)}", file
+						public_url(style, file.size)
+					rescue
+					end
 				end
-				@queued_for_write = {}
+        
+        after_flush_writes
+        @queued_for_write = {}
 			end
 
-			def flush_deletes #:nodoc:
+			def flush_deletes
+				path_styles = styles.keys.push(:original).map {|val| val.to_s}
+
 				@queued_for_delete.each do |path|
-					log("[paperclip] Deleting files for #{path}") if respond_to?(:log)
 					begin
-						dropbox_session.rm("/Public/#{path}")
+						
+						dropbox_client.delete("/#{path}")
 					rescue
 					end
 				end
+
+				if has_dropbox_share_urls? && !@queued_for_delete.empty?
+        	new_share_urls = dropbox_share_urls
+
+        	path_styles.each do |style|
+        		Rails.cache.delete("#{@instance.class}_#{@instance.id}_#{name}_#{style}")
+        		new_share_urls.delete("#{name}_#{style}")
+        	end
+
+        	update_dropbox_share_urls(new_share_urls.to_json)if @instance.persisted?
+        end
+
 				@queued_for_delete = []
 			end
 
-			def user_id
-				unless Rails.cache.exist?('DropboxSession:uid')
-					log("get Dropbox Session User_id")
-					Rails.cache.write('DropboxSession:uid', dropbox_session.account.uid)
-					dropbox_session.account.uid
-				else
-					log("read Dropbox User_id") if respond_to?(:log)
-					Rails.cache.read('DropboxSession:uid')
+			def public_url(style = default_style, size = 0)
+				return cached_url(style, size) if can_use_cached_url?("#{name}_#{style}") 
+
+				shared_link = dropbox_shared_link(style, size)
+
+				if has_dropbox_share_urls?
+        	new_share_urls = dropbox_share_urls
+
+		    	new_share_urls["#{name}_#{style}"] = shared_link
+        	update_dropbox_share_urls(new_share_urls.to_json)
+		    end
+				shared_link
+			end
+
+			private
+
+			def dropbox_shared_link(style = default_style, size = 0)
+				begin
+					shared_link = @options[:default_url]
+					shared_link = dropbox_client.list_shared_links(path: "/#{path(style)}").links.first.url.gsub("/s/", "/s/raw/")
+				rescue
+					shared_link = dropbox_client.create_shared_link_with_settings("/#{path(style)}").url.gsub("/s/", "/s/raw/")
+				end
+
+				shared_link
+			end
+
+			def remove_redirects(shared_link)
+				loop do 
+					res = HTTP.get(shared_link)
+
+					break unless res.status == 302
+					shared_link = res['location']
 				end
+				
+				shared_link
+			end
+
+			def dropbox_share_urls
+				begin
+      		@_dropbox_share_urls ||= JSON.parse(@instance.dropbox_share_urls)
+      	rescue
+      		@_dropbox_share_urls ||= {}
+      	end
+			end
+
+			def update_dropbox_share_urls(value)
+				@instance.update_column(:dropbox_share_urls, value)
+			end
+
+			def has_dropbox_share_urls?
+				@instance.has_attribute?(:dropbox_share_urls)
+			end
+
+			def max_size
+				@_max_size ||= @options['max_file_size'] || 1024 * 1024 * 3
 			end
 
-			def dropbox_session
-				unless Rails.cache.exist?('DropboxSession')
-					if @dropboxsession.blank?
-						log("loading session from yaml") if respond_to?(:log)
-						if File.exists?("#{Rails.root}/config/dropboxsession.yml")
-							@dropboxsession = Dropbox::Session.deserialize(File.read("#{Rails.root}/config/dropboxsession.yml"))
+			def cached_url(style = default_style, size = 0)
+				if has_dropbox_share_urls?
+					remove_url_redirects = @options[:remove_url_redirects] || false
+
+					if dropbox_share_urls.has_key?("#{name}_#{style}")
+						return dropbox_share_urls["#{name}_#{style}"] unless remove_url_redirects
+
+						return Rails.cache.fetch("#{@instance.class}_#{@instance.id}_#{name}_#{style}", expires_in: 3.hours) do
+							shared_link = dropbox_share_urls["#{name}_#{style}"]
+							shared_link = remove_redirects(shared_link) if remove_url_redirects && size <= max_size
+
+							shared_link
 						end
 					end
-					@dropboxsession.mode = :dropbox unless @dropboxsession.blank?
-					@dropboxsession
-				else
-					log("reading Dropbox Session") if respond_to?(:log)
-					Rails.cache.read('DropboxSession')
-				end
+        end
+
+        false
+			end
+
+			def can_use_cached_url?(style_key)
+				has_dropbox_share_urls? && dropbox_share_urls.has_key?(style_key)
+			end
+
+			def dropbox_client
+					if @_dropbox_client.blank?
+						if File.exists?("#{Rails.root}#{CONFIG_FILE}")
+							dropbox_config = YAML.load_file("#{Rails.root}#{CONFIG_FILE}")
+							authenticator = DropboxApi::Authenticator.new(dropbox_config[:dropbox_key], dropbox_config[:dropbox_secret])
+							access_token = OAuth2::AccessToken.from_hash(authenticator, dropbox_config[:access_token])
+							@_dropbox_client = DropboxApi::Client.new(
+									access_token: access_token,
+	  							on_token_refreshed: lambda { |new_token_hash|
+	  								dropbox_config = YAML.load_file("#{Rails.root}#{CONFIG_FILE}")
+	  								dropbox_config[:access_token] = new_token_hash
+										File.open("#{Rails.root}#{CONFIG_FILE}",'w') do |h| 
+											h.write dropbox_config.to_yaml
+										end
+	  							}
+  							)
+						else
+							warn("#{CONFIG_FILE} does not exist\nEnsure you have authorised paperclipdropbox")
+						end
+					end
+				
+				@_dropbox_client
 			end
 		end
 	end

data/lib/tasks/paperclipdropbox.rake

@@ -1,64 +1,56 @@
 require "yaml"
-require "dropbox"
+require "dropbox_api"
+require "paperclip"
+require "paperclipdropbox"
 
 namespace :paperclipdropbox do
 
+	desc "Authorize Paperclip link to your Dropbox"
+	task authorize: :environment do
 
-	desc "Create DropBox Authorized Session Yaml"
-	task :authorize => :environment do
-
-		SESSION_FILE = "#{Rails.root}/config/dropboxsession.yml"
-
+		config_file = Paperclip::Storage::Dropbox::CONFIG_FILE
 		puts ""
 		puts ""
 		puts ""
 
-		@dropboxsession = Paperclip::Storage::Dropboxstorage.dropbox_session
-
-		if @dropboxsession.blank?
-			if File.exists?("#{Rails.root}/config/paperclipdropbox.yml")
-				@options = (YAML.load_file("#{Rails.root}/config/paperclipdropbox.yml")[Rails.env].symbolize_keys)
-			end
-
-			@dropbox_key = @options.blank? ? '8ti7qntpcysl91j' : @options[:dropbox_key]
-			@dropbox_secret = @options.blank? ? 'i0tshr4cpd1pa4e' : @options[:dropbox_secret]
+		begin
+			dropbox_key = '8ti7qntpcysl91j'
+			dropbox_secret = 'i0tshr4cpd1pa4e'
 
-			@dropboxsession = Dropbox::Session.new(@dropbox_key, @dropbox_secret)
-			@dropboxsession.mode = :dropbox
+			authenticator = DropboxApi::Authenticator.new(dropbox_key, dropbox_secret)
+			auth_url = authenticator.auth_code.authorize_url(token_access_type: 'offline')
 
-			puts "Visit #{@dropboxsession.authorize_url} to log in to Dropbox. Hit enter when you have done this."
+			puts ""
+			puts "Please go to #{auth_url} and approve the app"
+			puts ""
+			puts "Please enter you access code"
+			access_code = gets.chomp
 
-			STDIN.gets
+			access_token = authenticator.auth_code.get_token(access_code)
 
-		end
+			if File.exists?("#{Rails.root}#{config_file}")
+				config = YAML.load_file("#{Rails.root}#{config_file}") 
+			else
+				config = {}
+			end
+			config[:dropbox_key] = dropbox_key
+			config[:dropbox_secret] = dropbox_secret
+			config[:access_token] = access_token.to_hash
 
-		begin
-			@dropboxsession.authorize
+			File.open("#{Rails.root}#{config_file}",'w') do |h| 
+				h.write config.to_yaml
+			end
+			
 			puts ""
-			puts "Authorized - #{@dropboxsession.authorized?}"
-		rescue
-			begin
-				puts ""
-				puts "Visit #{@dropboxsession.authorize_url} to log in to Dropbox. Hit enter when you have done this."
+			puts "Paperclip is now Authorized"
 
-				STDIN.gets
-				@dropboxsession.authorize
-				puts ""
-				puts "Authorized - #{@dropboxsession.authorized?}"
-			rescue
-				puts ""
-				puts "Already Authorized - #{@dropboxsession.authorized?}" unless @dropboxsession.blank?
-				puts "Failed Authorization. Please try delete /config/dropboxsession.yml and try again." if @dropboxsession.blank?
-			end
+		rescue => error
+			p error
+			puts "Failed Authorization. Please try again."
 		end
 
 		puts ""
 		puts ""
-		unless @dropboxsession.blank?
-			File.open(SESSION_FILE, "w") do |f|
-				f.puts @dropboxsession.serialize
-			end
-		end
 	end
 
 end

data/paperclipdropbox.gemspec

@@ -11,11 +11,11 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/dripster82/paperclipdropbox"
   s.summary     = %q{Dropbox storage support for paperclip file attachment}
   s.description = %q{Adds Dropbox storage support for the Paperclip gem. Dropbox account required.}
+  s.license     = "MIT"
   
-  s.rubyforge_project = "paperclipdropbox"
-  
-  s.add_dependency 'paperclip'
-  s.add_dependency 'dropbox'
+  s.add_dependency 'kt-paperclip', '~> 7.0'
+  s.add_dependency 'dropbox_api', '~> 0.1.21'
+  s.add_dependency 'http', '~> 5.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,50 +1,65 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: paperclipdropbox
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.0.8
+version: !ruby/object:Gem::Version
+  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Paul Ketelle
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2012-04-06 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: paperclip
+date: 2023-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kt-paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: dropbox_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.21
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: dropbox
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.21
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Adds Dropbox storage support for the Paperclip gem. Dropbox account required.
-email: 
+email:
 - paul@ketelle.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - Gemfile
 - README.rdoc
 - Rakefile
@@ -54,31 +69,26 @@ files:
 - lib/tasks/paperclipdropbox.rake
 - paperclipdropbox.gemspec
 homepage: https://github.com/dripster82/paperclipdropbox
-licenses: []
-
-post_install_message: 
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: paperclipdropbox
-rubygems_version: 1.8.8
-signing_key: 
-specification_version: 3
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
 summary: Dropbox storage support for paperclip file attachment
 test_files: []
-