paperclip-storage-ftp 1.0.0.rc1 → 1.0.0.rc2

data/.gitignore

@@ -17,3 +17,6 @@ test/version_tmp
 tmp
 .rspec
 .rvmrc
+vendor/apache-ftpserver/res/ftpd.pid*
+vendor/apache-ftpserver/res/home/*
+vendor/apache-ftpserver/res/log/*

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+gemfile:
+  - gemfiles/Gemfile.paperclip-2.x
+  - gemfiles/Gemfile.paperclip-3.x
+matrix:
+  exclude:
+  - rvm: 1.8.7
+    gemfile: gemfiles/Gemfile.paperclip-3.x
+  - rvm: jruby-18mode
+    gemfile: gemfiles/Gemfile.paperclip-3.x
+  - rvm: rbx-18mode
+    gemfile: gemfiles/Gemfile.paperclip-3.x

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in paperclip-multistorage.gemspec
 gemspec
+
+group :integration_test do
+  gem "daemon_controller",  :platforms => :ruby
+  gem "activerecord",       :platforms => :ruby
+  gem "sqlite3",            :platforms => :ruby
+end

data/README.md

@@ -3,6 +3,10 @@
 Allow [Paperclip](https://github.com/thoughtbot/paperclip) attachments
 to be stored on FTP servers.
 
+## Build status
+
+[![Build Status](https://secure.travis-ci.org/xing/paperclip-storage-ftp.png)](http://travis-ci.org/xing/paperclip-storage-ftp)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -44,7 +48,8 @@ In your model:
           {
             :host     => "ftp1.example.com",
             :user     => "foo",
-            :password => "bar"
+            :password => "bar",
+            :port     => 21 # optional
           },
           # Add more servers if needed
           {

data/Rakefile

@@ -1,9 +1,9 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = "--color"
+  t.rspec_opts += " --tag ~integration" if RUBY_PLATFORM == "java"
 end
 
 task :default => :spec

data/gemfiles/Gemfile.paperclip-2.x

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gemspec :path => '..'
+
+gem "paperclip", "~>2.0"
+
+group :integration_test do
+  gem "daemon_controller",  :platforms => :ruby
+  gem "activerecord",       :platforms => :ruby
+  gem "sqlite3",            :platforms => :ruby
+end

data/gemfiles/Gemfile.paperclip-3.x

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gemspec :path => '..'
+
+gem "paperclip", "~>3.0"
+
+group :integration_test do
+  gem "daemon_controller",  :platforms => :ruby
+  gem "activerecord",       :platforms => :ruby
+  gem "sqlite3",            :platforms => :ruby
+end

data/lib/paperclip/storage/ftp.rb

@@ -55,6 +55,10 @@ module Paperclip
         @queued_for_delete = []
       end
 
+      def copy_to_local_file(style, destination_path)
+        primary_ftp_server.get_file(path(style), destination_path)
+      end
+
       def ftp_servers
         @ftp_servers ||= begin
           ftp_servers = []
@@ -62,7 +66,8 @@ module Paperclip
             server = Server.new(
               :host     => config[:host],
               :user     => config[:user],
-              :password => config[:password]
+              :password => config[:password],
+              :port     => config[:port]
             )
             ftp_servers << server
           end

data/lib/paperclip/storage/ftp/server.rb

@@ -5,10 +5,18 @@ module Paperclip
   module Storage
     module Ftp
       class Server
-        attr_accessor :host, :user, :password
+
+        attr_accessor :host, :user, :password, :port
         attr_writer   :connection
 
+        def self.default_options
+          {
+            :port => Net::FTP::FTP_PORT
+          }
+        end
+
         def initialize(options = {})
+          options = self.class.default_options.merge(options)
           options.each do |k,v|
             send("#{k}=", v)
           end
@@ -16,7 +24,7 @@ module Paperclip
 
         def file_exists?(path)
           pathname = Pathname.new(path)
-          connection.nlst(pathname.dirname.to_s).include?(pathname.basename.to_s)
+          connection.nlst(pathname.dirname.to_s).map { |f| File.basename f }.include?(pathname.basename.to_s)
         end
 
         def get_file(remote_file_path, local_file_path)
@@ -34,7 +42,12 @@ module Paperclip
         end
 
         def connection
-          @connection ||= Net::FTP.open(host, user, password)
+          @connection ||= begin
+            connection = Net::FTP.new
+            connection.connect(host, port)
+            connection.login(user, password)
+            connection
+          end
         end
 
         def mkdir_p(dirname)

data/paperclip-storage-ftp.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "paperclip-storage-ftp"
   gem.require_paths = ["lib"]
-  gem.version       = "1.0.0.rc1"
+  gem.version       = "1.0.0.rc2"
 
   gem.add_dependency("paperclip")
 

data/spec/integration_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe "Integration", :integration => true do
+  before do
+    require "support/integration/ftp_server"
+    require "support/integration/user"
+    FtpServer.clear
+    FtpServer.start
+  end
+
+  let(:file) { File.new(File.expand_path("../support/integration/avatar.jpg", __FILE__), "rb") }
+
+  it "stores the attachment on the ftp servers" do
+    user = User.new
+    user.avatar = file
+    user.save!
+    file.close
+
+    File.exists?(FtpServer::HOME_PATH + "/#{user.id}/original/avatar.jpg").should be_true
+  end
+
+  it "deletes an attachment from the ftp servers" do
+    user = User.new
+    user.avatar = file
+    user.save!
+    file.close
+
+    user.destroy
+
+    File.exists?(FtpServer::HOME_PATH + "/#{user.id}/original/avatar.jpg").should be_false
+  end
+end

data/spec/paperclip/storage/ftp/server_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../../../../spec_helper", __FILE__)
+require "spec_helper"
 
 describe Paperclip::Storage::Ftp::Server do
   let(:server) { Paperclip::Storage::Ftp::Server.new }
@@ -8,12 +8,19 @@ describe Paperclip::Storage::Ftp::Server do
       options = {
         :host     => "ftp.example.com",
         :user     => "user",
-        :password => "password"
+        :password => "password",
+        :port     => 2121
       }
       server = Paperclip::Storage::Ftp::Server.new(options)
-      server.host.should     == "ftp.example.com"
-      server.user.should     == "user"
-      server.password.should == "password"
+      server.host.should     == options[:host]
+      server.user.should     == options[:user]
+      server.password.should == options[:password]
+      server.port.should     == options[:port]
+    end
+
+    it "sets a default port" do
+      server = Paperclip::Storage::Ftp::Server.new
+      server.port.should == Net::FTP::FTP_PORT
     end
   end
 
@@ -24,6 +31,12 @@ describe Paperclip::Storage::Ftp::Server do
       server.file_exists?("/files/original/foo.jpg").should be_true
     end
 
+    it "recognizes complete file paths correctly" do
+      server.connection = double("connection")
+      server.connection.should_receive(:nlst).with("/files/original").and_return(["/files/original/foo.jpg"])
+      server.file_exists?("/files/original/foo.jpg").should be_true
+    end
+
     it "returns false if the file does not exist on the server" do
       server.connection = double("connection")
       server.connection.should_receive(:nlst).with("/files/original").and_return([])
@@ -62,9 +75,12 @@ describe Paperclip::Storage::Ftp::Server do
       server.user     = "user"
       server.password = "password"
 
-      Net::FTP.should_receive(:open).with(server.host, server.user, server.password).once.and_return(:foo)
+      connection = double("connection")
+      Net::FTP.should_receive(:new).once.and_return(connection)
+      connection.should_receive(:connect).once.with(server.host, server.port)
+      connection.should_receive(:login).once.with(server.user, server.password)
 
-      2.times { server.connection.should == :foo }
+      2.times { server.connection.should == connection }
     end
   end
 

data/spec/paperclip/storage/ftp_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../../../spec_helper", __FILE__)
+require "spec_helper"
 
 describe Paperclip::Storage::Ftp do
   let(:attachment) do
@@ -109,6 +109,18 @@ describe Paperclip::Storage::Ftp do
     end
   end
 
+  context "#copy_to_local_file" do
+    it "returns the file from the primary server and stores it in the path specified" do
+      attachment.primary_ftp_server.should_receive(:get_file).with("/files/original/foo.jpg", "/local/foo").and_return(:foo)
+      attachment.copy_to_local_file(:original, "/local/foo")
+    end
+
+    it "accepts the style parameter to build the correct path" do
+      attachment.primary_ftp_server.should_receive(:get_file).with("/files/thumb/foo.jpg", "/local/thumb/foo").and_return(:foo)
+      attachment.copy_to_local_file(:thumb, "/local/thumb/foo")
+    end
+  end
+
   context "#ftp_servers" do
     it "returns the configured ftp servers" do
       attachment.ftp_servers.first.host.should      == "ftp1.example.com"

data/spec/support/integration/ftp_server.rb

@@ -0,0 +1,27 @@
+require "daemon_controller"
+
+class FtpServer
+
+  INSTALL_PATH = File.expand_path("../../../../vendor/apache-ftpserver", __FILE__)
+  HOME_PATH    = INSTALL_PATH + "/res/home"
+
+  def self.start
+    daemon_controller.start unless daemon_controller.running?
+  end
+
+  def self.clear
+    FileUtils.rm_r(Dir.glob(HOME_PATH + "/*"))
+  end
+
+  private
+
+  def self.daemon_controller
+    @daemon_controller ||= DaemonController.new(
+      :identifier     => "Apache FtpServer",
+      :start_command  => "cd #{INSTALL_PATH}; ./bin/ftpd.sh res/conf/ftpd-typical.xml",
+      :ping_command   => [:tcp, '127.0.0.1', 2121],
+      :pid_file       => INSTALL_PATH + "/res/ftpd.pid",
+      :log_file       => INSTALL_PATH + "/res/log/ftpd.log"
+    )
+  end
+end

data/spec/support/integration/user.rb

@@ -0,0 +1,31 @@
+require "active_record"
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => ":memory:"
+)
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define do
+  create_table :users
+  add_column :users, :avatar_file_name, :string
+  add_column :users, :avatar_content_type, :string
+  add_column :users, :avatar_file_size, :integer
+  add_column :users, :avatar_updated_at, :datetime
+end
+
+class User < ActiveRecord::Base
+  include Paperclip::Glue
+
+  has_attached_file :avatar,
+    :storage  => :ftp,
+    :path     => "/:id/:style/:filename",
+    :ftp_servers => [
+      {
+        :host     => "127.0.0.1",
+        :user     => "admin",
+        :password => "admin",
+        :port     => 2121
+      }
+    ]
+end

data/vendor/apache-ftpserver/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.