paperclipftp 0.1.0 → 0.2.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Damian Caruso
+Copyright (c) 2010 Damian Caruso
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,6 @@
 = PaperclipFTP
 
-Ftp storage support for paperclip file attachment plugin. 
+Ftp storage support for paperclip file attachment plugin.
 Useful for CDNs with ftp access method for file uploading.
 
 == Install
@@ -10,30 +10,61 @@ Useful for CDNs with ftp access method for file uploading.
 
 == Usage
 
-Create the file config/paperclipftp.yml:
+In your model:
 
-  development:
-    host: domain.com
-    username: user
-    password: password
-    
-  test:
-    ...
-    
-  production:
-    ...
+  class User < ActiveRecord::Base
+    has_attached_file :avatar,
+                      :styles => { :medium => "300x300>", :thumb => "100x100>" },
+                      :path => "/path-to-images/:attachment/:id/:style/:filename",
+                      :url => "http://my-cdn-domain.com/:attachment/:id/:style/:filename",
+                      :storage => :ftp,
+                      :ftp_credentials => Rails.root.join('config', 'paperclipftp.yaml')
+  end
 
-In your model:
+or
 
   class User < ActiveRecord::Base
     has_attached_file :avatar,
                       :styles => { :medium => "300x300>", :thumb => "100x100>" },
+                      :path => "/path-to-images/:attachment/:id/:style/:filename",
+                      :url => "http://my-cdn-domain.com/:attachment/:id/:style/:filename",
                       :storage => :ftp,
-                      :path => "/:attachment/:attachment/:id/:style/:filename"
-                      :url => "http://domain.com/:attachment/:attachment/:id/:style/:filename"
+                      :ftp_credentials => { :host => 'ftp.domain.com', :username => 'username', :password => 'password' },
+                      :ftp_passive_mode => false,
+                      :ftp_timeout => 90,
+                      :ftp_verify_size_on_upload => false,
+                      :ftp_debug_mode => false
   end
-  
-You must add in the url option the web access to that file.
+
+Options storage, ftp_credentials, path and url are mandatory.
+
+* +storage+: Should be set to 'ftp' value in order to utilize paperclipftp plugin
+* +ftp_credentials+: Takes a path, a File, or a Hash. The path (or File) must point
+  to a YAML file containing the +host+, +username+, and +password+ to ftp server.
+  You can 'environment-space' this just like you do to your
+  database.yml file, so different environments can use different accounts:
+    development:
+      host: domain.com
+      username: user
+      password: password
+    test:
+      ...
+    production:
+      ...
+  This is not required, however, and the file may simply look like this:
+    host: domain.com
+    username: user
+    password: password
+  In which case, those values will be used in all environments.
+* +path+: This is the templated path to the directory on the ftp server in which the file will be stored.
+* +url+: This is the templated url to the files as accessed from CDN.
+
+Other options are optional.
+
+* +ftp_passive_mode+: True if ftp communication should happen in passive mode
+* +ftp_timeout+: Max amount of time in seconds to allocate to ftp operations of the plugin
+* +ftp_debug_mode+: If true, dumps copy of all ftp commands to stderr
+* +ftp_verify_size_on_upload+: If true, file size will be verified after each upload
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/paperclipftp.rb

@@ -1,91 +1,165 @@
-module Paperclip
-  module Storage
-    module Ftp
-      def self.extended base
-      	require 'net/ftp'
-      	base.instance_eval do
-      	  @ftp_credentials = parse_credentials
-  	    end
-      end
-      
-      def ftp
-      	if @ftp.nil? || @ftp.closed?
-      	  @ftp = Net::FTP.new(@ftp_credentials[:host], @ftp_credentials[:username], @ftp_credentials[:password])
-  	    end
-  	    @ftp
-      end
-      
-      def exists?(style = default_style)
-      	move_to_remote_path(File.dirname(path(style)))
-      	ftp.size(File.basename(path(style))) > 0 ? true : false
-      rescue Net::FTPPermError => e
-      	#File not exists
-      	false
-      rescue Net::FTPReplyError => e
-      	ftp.close
-      	raise e
-      end
-
-      def to_file style = default_style
-      	@queued_for_write[style] || "ftp://#{path(style)}"
-      end
-      alias_method :to_io, :to_file
-
-      def flush_writes
-      	@queued_for_write.each do |style, file|
-          file.close
-          move_to_remote_path(File.dirname(path(style)))
-          log("uploading #{path(style)}")
-          ftp.putbinaryfile(file.path, File.basename(path(style)))
-        end
-        @queued_for_write = {}
-      rescue Net::FTPReplyError => e
-      	raise e
-      rescue Net::FTPPermError => e
-      	raise e
-      ensure
-      	ftp.close
-      end
-
-      def flush_deletes
-      	@queued_for_delete.each do |path|
-          begin
-            move_to_remote_path(File.dirname(path))
-            log("deleting #{path}")
-            ftp.delete(File.basename(path))
-          rescue Net::FTPPermError, Net::FTPReplyError
-          end
-        end
-        @queued_for_delete = []
-      rescue Net::FTPReplyError => e
-      	raise e
-      rescue Net::FTPPermError => e
-      	raise e
-      ensure
-      	ftp.close 
-      end
-      
-      def move_to_remote_path(rpath)
-      	ftp.chdir("/")
-      	rpath.split(File::SEPARATOR).each do |rdir|
-      	  rdir = rdir.strip
-      	  unless rdir.blank?
-      	  	list = ftp.ls.collect { |f| f.split.last }
-      	    unless list.include?(rdir)
-      	     ftp.mkdir(rdir)
-  	  	    end
-  	  	    ftp.chdir(rdir)
-  	  	  end
- 	    end
-      end
-      
-      def parse_credentials
-      	creds = YAML.load_file(File.join(RAILS_ROOT,"config","paperclipftp.yml"))
-      	creds = creds.stringify_keys
-        (creds[RAILS_ENV] || creds).symbolize_keys
-      end
-      private :parse_credentials
-      
-	end
-  end
-end
+module Paperclip
+  module Storage
+    module Ftp
+      class FtpTimeout < Timeout::Error; end
+
+      def self.extended base
+        require 'net/ftp'
+        base.instance_eval do
+          @ftp_credentials = parse_credentials(@options[:ftp_credentials])
+          @passive_mode = !!@options[:ftp_passive_mode]
+          @debug_mode = !!@options[:ftp_debug_mode]
+          @verify_size = !!@options[:ftp_verify_size_on_upload]
+          @timeout = @options[:ftp_timeout] || 3600
+        end
+      end
+
+      def exists?(style = default_style)
+        Timeout::timeout(@timeout, FtpTimeout) do
+          file_size(ftp_path(style)) > 0
+        end
+      end
+
+      def to_file style = default_style
+        return @queued_for_write[style] if @queued_for_write[style]
+        Timeout::timeout(@timeout, FtpTimeout) do
+          file = Tempfile.new(ftp_path(style))
+          ftp.getbinaryfile(ftp_path(style), file.path)
+          file.rewind
+          return file
+        end
+      end
+
+      alias_method :to_io, :to_file
+
+      def flush_writes
+        @queued_for_write.each do |style, file|
+          Timeout::timeout(@timeout, FtpTimeout) do
+            file.close
+            remote_path = ftp_path(style)
+            log("uploading #{remote_path}")
+            first_try = true
+            begin
+              ftp.putbinaryfile(file.path, remote_path)
+            rescue Net::FTPPermError => e
+              if first_try
+                first_try = false
+                create_parent_folder_for(remote_path)
+                retry
+              else
+                raise e
+              end
+            end
+            if @verify_size
+              # avoiding those weird occasional 0 file sizes by not using instance method file.size
+              local_file_size = File.size(file.path)
+              remote_file_size = file_size(remote_path)
+              raise Net::FTPError.new "Uploaded #{remote_file_size} bytes instead of #{local_file_size} bytes" unless remote_file_size == local_file_size
+            end
+          end
+        end
+        @queued_for_write = {}
+      rescue Net::FTPReplyError => e
+        raise e
+      rescue Net::FTPPermError => e
+        raise e
+      ensure
+        close_ftp_connection
+      end
+
+      def flush_deletes
+        @queued_for_delete.each do |path|
+          Timeout::timeout(@timeout, FtpTimeout) do
+            begin
+              log("deleting #{path}")
+              ftp.delete('/' + path)
+            rescue Net::FTPPermError, Net::FTPReplyError
+            end
+          end
+        end
+        @queued_for_delete = []
+      rescue Net::FTPReplyError => e
+        raise e
+      rescue Net::FTPPermError => e
+        raise e
+      ensure
+        close_ftp_connection
+      end
+
+      private
+
+      def ftp
+        if @ftp.nil? || @ftp.closed?
+          Timeout::timeout(@timeout, FtpTimeout) do
+            @ftp = Net::FTP.new(@ftp_credentials[:host], @ftp_credentials[:username], @ftp_credentials[:password])
+            @ftp.debug_mode = @debug_mode
+            @ftp.passive = @passive_mode
+          end
+        end
+        @ftp
+      end
+
+      def close_ftp_connection
+        unless @ftp.nil? || @ftp.closed?
+          @ftp.close
+          @ftp = nil
+        end
+      end
+
+      def create_parent_folder_for(remote_path)
+        dir_path = File.dirname(remote_path)
+        ftp.chdir("/")
+        dir_path.split(File::SEPARATOR).each do |rdir|
+          next if rdir.blank?
+          first_time = true
+          begin
+            ftp.chdir(rdir)
+          rescue Net::FTPPermError => e
+            if first_time
+              ftp.mkdir(rdir)
+              first_time = false
+              retry
+            else
+              raise e
+            end
+          end
+        end
+      end
+
+      def ftp_path(style)
+        path = path(style)
+        path.nil? ? nil : '/' + path
+      end
+
+      def file_size(remote_path)
+        ftp.size(remote_path)
+      rescue Net::FTPPermError => e
+        #File not exists
+        -1
+      rescue Net::FTPReplyError => e
+        close_ftp_connection
+        raise e
+      end
+
+      def parse_credentials creds
+        creds = find_credentials(creds).stringify_keys
+        (creds[Rails.env] || creds).symbolize_keys
+      end
+
+      def find_credentials creds
+        case creds
+        when File
+          YAML::load(ERB.new(File.read(creds.path)).result)
+        when String, Pathname
+          YAML::load(ERB.new(File.read(creds)).result)
+        when Hash
+          creds
+        else
+          raise ArgumentError, "Credentials are not a path, file, or hash."
+        end
+      end
+
+
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: paperclipftp
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Damian Caruso
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-08 00:00:00 -03:00
+date: 2011-05-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: paperclip
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 2
         - 3
@@ -35,9 +38,11 @@ dependencies:
   name: yard
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -65,28 +70,32 @@ homepage: http://github.com/cdamian/paperclipftp
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ftp storage support for paperclip file attachment