paperclip-storage-ftp 1.0.0.rc3 → 1.0.0

data/README.md

@@ -9,9 +9,11 @@ to be stored on FTP servers.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
-    gem 'paperclip-storage-ftp'
+```ruby
+gem "paperclip-storage-ftp"
+```
 
 And then execute:
 
@@ -25,40 +27,45 @@ Or install it yourself as:
 
 Somewhere in your code:
 
-    require "paperclip/storage/ftp"
+```ruby
+require "paperclip/storage/ftp"
+```
 
 In your model:
 
-    class User < ActiveRecord::Base
-      has_attached_file :avatar,
-
-        # Choose the FTP storage backend
-        :storage => :ftp,
-
-        # Set where to store the file on the FTP server(s).
-        # This supports Paperclip::Interpolations.
-        :path => "/path_on_ftp_server/:attachment/:id/:style/:filename"
-
-        # The full URL of where the attachment is publicly accessible.
-        # This supports Paperclip::Interpolations.
-        :url => "/url_prefix/:attachment/:id/:style/:filename"
-
-        # The list of FTP servers to use
-        :ftp_servers => [
-          {
-            :host     => "ftp1.example.com",
-            :user     => "foo",
-            :password => "bar",
-            :port     => 21 # optional
-          },
-          # Add more servers if needed
-          {
-            :host     => "ftp2.example.com",
-            :user     => "foo",
-            :password => "bar"
-          }
-        ]
-    end
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar,
+
+    # Choose the FTP storage backend
+    :storage => :ftp,
+
+    # Set where to store the file on the FTP server(s).
+    # This supports Paperclip::Interpolations.
+    :path => "/path_on_ftp_server/:attachment/:id/:style/:filename",
+
+    # The full URL of where the attachment is publicly accessible.
+    # This supports Paperclip::Interpolations.
+    :url => "/url_prefix/:attachment/:id/:style/:filename",
+
+    # The list of FTP servers to use
+    :ftp_servers => [
+      {
+        :host     => "ftp1.example.com",
+        :user     => "foo",
+        :password => "bar",
+        :port     => 21, # optional
+      },
+      # Add more servers if needed
+      {
+        :host     => "ftp2.example.com",
+        :user     => "foo",
+        :password => "bar",
+        :port     => 2121
+      }
+    ]
+end
+```
 
 ## Contributing
 
@@ -67,3 +74,15 @@ In your model:
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Authors
+
+* [Sebastian Röbke](https://github.com/boosty)
+* and other friendly [contributors](https://github.com/xing/paperclip-storage-ftp/graphs/contributors)
+
+You can find out more about our work on our [dev blog](http://devblog.xing.com).
+
+Copyright (c) 2012 [XING AG](http://www.xing.com)
+
+Released under the MIT license. For full details see [LICENSE](https://github.com/xing/paperclip-storage-ftp/blob/master/LICENSE)
+included in this distribution.

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

@@ -6,8 +6,14 @@ module Paperclip
     module Ftp
       class Server
 
+        @@connections = {}
+
+        def self.clear_connections
+          @@connections.clear
+        end
+
         attr_accessor :host, :user, :password
-        attr_writer   :connection, :port
+        attr_writer   :port
 
         def initialize(options = {})
           options.each do |k,v|
@@ -35,12 +41,19 @@ module Paperclip
         end
 
         def connection
-          @connection ||= begin
-            connection = Net::FTP.new
+          connection = @@connections["#{host}:#{port}"] ||= build_connection
+          if connection.closed?
             connection.connect(host, port)
             connection.login(user, password)
-            connection
           end
+          connection
+        end
+
+        def build_connection
+          connection = Net::FTP.new
+          connection.connect(host, port)
+          connection.login(user, password)
+          connection
         end
 
         def port

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.rc3"
+  gem.version       = "1.0.0"
 
   gem.add_dependency("paperclip")
 

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

@@ -1,6 +1,10 @@
 require "spec_helper"
 
 describe Paperclip::Storage::Ftp::Server do
+  before(:each) do
+    Paperclip::Storage::Ftp::Server.clear_connections
+  end
+
   let(:server) { Paperclip::Storage::Ftp::Server.new }
 
   context "initialize" do
@@ -25,36 +29,43 @@ describe Paperclip::Storage::Ftp::Server do
   end
 
   context "#file_exists?" do
+    before do
+      server.stub(:connection).and_return(double("connection"))
+    end
+
     it "returns true if the file exists on the server" do
-      server.connection = double("connection")
       server.connection.should_receive(:nlst).with("/files/original").and_return(["foo.jpg"])
       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([])
       server.file_exists?("/files/original/foo.jpg").should be_false
     end
   end
 
   context "#get_file" do
+    before do
+      server.stub(:connection).and_return(double("connection"))
+    end
+
     it "returns the file object" do
-      server.connection = double("connection")
       server.connection.should_receive(:getbinaryfile).with("/files/original.jpg", "/tmp/original.jpg")
       server.get_file("/files/original.jpg", "/tmp/original.jpg")
     end
   end
 
   context "#put_file" do
+    before do
+      server.stub(:connection).and_return(double("connection"))
+    end
+
     it "stores the file on the server" do
-      server.connection = double("connection")
       server.should_receive(:mkdir_p).with("/files")
       server.connection.should_receive(:putbinaryfile).with("/tmp/original.jpg", "/files/original.jpg")
       server.put_file("/tmp/original.jpg", "/files/original.jpg")
@@ -62,31 +73,78 @@ describe Paperclip::Storage::Ftp::Server do
   end
 
   context "#delete_file" do
+    before do
+      server.stub(:connection).and_return(double("connection"))
+    end
+
     it "deletes the file on the server" do
-      server.connection = double("connection")
       server.connection.should_receive(:delete).with("/files/original.jpg")
       server.delete_file("/files/original.jpg")
     end
   end
 
-  context "#connection" do
-    it "returns a memoized ftp connection to the given server" do
+  context "#build_connection" do
+    it "returns the ftp connection for the given server" do
       server.host     = "ftp.example.com"
       server.user     = "user"
       server.password = "password"
 
-      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)
+      ftp = double("ftp")
+      Net::FTP.should_receive(:new).and_return(ftp)
+      ftp.should_receive(:connect).with(server.host, server.port)
+      ftp.should_receive(:login).with(server.user, server.password)
+      server.build_connection.should == ftp
+    end
+  end
+
+  context "#connection" do
+    it "returns the memoized ftp connection for the given server" do
+      connection = double("connection", :closed? => false)
+      server.should_receive(:build_connection).once.and_return(connection)
+      server.connection.should == connection
+
+      # same host, same port => memoize
+      same_server = Paperclip::Storage::Ftp::Server.new(
+        :host => server.host,
+        :port => server.port
+      )
+      same_server.should_receive(:build_connection).never
+      same_server.connection.should == connection
 
-      2.times { server.connection.should == connection }
+      # different host => do not memoize
+      other_host_connection = double("other_host_connection", :closed? => false)
+      other_host_server = Paperclip::Storage::Ftp::Server.new(
+        :host => "other.#{server.host}",
+        :port => server.port
+      )
+      other_host_server.should_receive(:build_connection).once.and_return(other_host_connection)
+      other_host_server.connection.should == other_host_connection
+
+      # different port => do not memoize
+      other_port_connection = double("other_port_connection", :closed? => false)
+      other_port_server = Paperclip::Storage::Ftp::Server.new(
+        :host => server.host,
+        :port => server.port + 1
+      )
+      other_port_server.should_receive(:build_connection).once.and_return(other_port_connection)
+      other_port_server.connection.should == other_port_connection
+    end
+
+    it "reconnects if the connection is closed" do
+      connection = double("connection", :closed? => true)
+      server.stub(:build_connection) { connection }
+      connection.should_receive(:connect).with(server.host, server.port)
+      connection.should_receive(:login).with(server.user, server.password)
+      server.connection.should == connection
     end
   end
 
   context "mkdir_p" do
+    before do
+      server.stub(:connection).and_return(double("connection"))
+    end
+
     it "creates the directory and all its parent directories" do
-      server.connection = double("connection")
       server.connection.should_receive(:mkdir).with("/").ordered
       server.connection.should_receive(:mkdir).with("/files").ordered
       server.connection.should_receive(:mkdir).with("/files/foo").ordered
@@ -95,7 +153,6 @@ describe Paperclip::Storage::Ftp::Server do
     end
 
     it "does not stop on Net::FTPPermError" do
-      server.connection = double("connection")
       server.connection.should_receive(:mkdir).with("/").and_raise(Net::FTPPermError)
       server.connection.should_receive(:mkdir).with("/files")
       server.mkdir_p("/files")

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-storage-ftp
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Sebastian Röbke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2012-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip
@@ -126,15 +126,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -504637831743076511
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24