carrierwave-ftp 0.1.2 → 0.2.0

data/README.md

@@ -14,9 +14,11 @@ Require it in your code:
 
 Or, in Rails you can add it to your Gemfile:
 
-    gem 'carrierwave-ftp', :require => 'carrierwave/storage/ftp'
+    gem 'carrierwave-ftp', :require => 'carrierwave/storage/all' # both FTP/SFTP
+    gem 'carrierwave-ftp', :require => 'carrierwave/storage/ftp' # FTP only
+    gem 'carrierwave-ftp', :require => 'carrierwave/storage/sftp' # SFTP only
 
-## Getting Started
+## Getting Started (FTP)
 
 First configure CarrierWave with your FTP credentials:
 
@@ -38,3 +40,28 @@ class AvatarUploader < CarrierWave::Uploader::Base
   storage :ftp
 end
 ```
+
+## Getting Started (SFTP)
+
+First configure CarrierWave with your SFTP credentials:
+
+```ruby
+CarrierWave.configure do |config|
+  config.sftp_host = "example.com"
+  config.sftp_user = "example"
+  config.sftp_folder = "public_html/uploads"
+  config.sftp_url = "http://example.com/uploads"
+  config.sftp_options = {
+    :password => "secret",
+    :port     => 22
+  }
+end
+```
+
+And then in your uploader, set the storage to `:sftp`:
+
+```ruby
+class AvatarUploader < CarrierWave::Uploader::Base
+  storage :sftp
+end
+```

data/carrerwave-ftp.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{FTP support for CarrierWave}
   s.description = %q{Allows file upload using FTP for CarrierWave uploaders.}
 
-  s.rubyforge_project = "carrierwave-mongoid"
+  s.rubyforge_project = "carrierwave-ftp"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "carrierwave", ["~> 0.6.2"]
+  s.add_dependency "net-sftp", ["~> 2.0.5"]
   s.add_development_dependency "rspec", ["~> 2.6"]
   s.add_development_dependency "rake", ["~> 0.9"]
 end

data/lib/carrierwave/storage/ftp/all.rb

@@ -0,0 +1,2 @@
+require 'carrierwave/storage/ftp'
+require 'carrierwave/storage/sftp'

data/lib/carrierwave/storage/ftp/ex_sftp.rb

@@ -0,0 +1,20 @@
+require 'net/sftp'
+
+class Net::SFTP::Session
+  def mkdir_p!(dir)
+    parts = dir.split("/")
+    growing_path = ""
+    for part in parts
+      next if part == ""
+      if growing_path == ""
+        growing_path = part
+      else
+        growing_path = File.join(growing_path, part)
+      end
+      begin
+        mkdir!(growing_path)
+      rescue
+      end
+    end
+  end
+end

data/lib/carrierwave/storage/ftp/version.rb

@@ -1,7 +1,7 @@
 module Carrierwave
   module Storage
     class FTP
-      VERSION = "0.1.2"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/carrierwave/storage/sftp.rb

@@ -0,0 +1,107 @@
+require 'carrierwave'
+require 'carrierwave/storage/ftp/ex_sftp'
+
+module CarrierWave
+  module Storage
+    class SFTP < Abstract
+      def store!(file)
+        f = CarrierWave::Storage::SFTP::File.new(uploader, self, uploader.store_path)
+        f.store(file)
+        f
+      end
+
+      def retrieve!(identifier)
+        CarrierWave::Storage::SFTP::File.new(uploader, self, uploader.store_path(identifier))
+      end
+
+      class File
+        attr_reader :path
+
+        def initialize(uploader, base, path)
+          @uploader, @base, @path = uploader, base, path
+        end
+
+        def store(file)
+          connection do |sftp|
+            sftp.mkdir_p!(::File.dirname full_path)
+            sftp.upload!(file.path, full_path)
+          end
+        end
+
+        def url
+          "#{@uploader.sftp_url}/#{path}"
+        end
+
+        def filename(options = {})
+          url.gsub(/.*\/(.*?$)/, '\1')
+        end
+
+        def size
+          size = nil
+
+          connection do |sftp|
+            size = sftp.stat!(full_path).size
+          end
+
+          size
+        end
+
+        def exists?
+          size ? true : false
+        end
+
+        def read
+          http_get_body(url)
+        end
+
+        def delete
+          connection do |sftp|
+            sftp.remove!(full_path)
+          end
+        end
+
+        private
+
+        def full_path
+          "#{@uploader.sftp_folder}/#{path}"
+        end
+
+        def http_get_body(url)
+          require 'net/http'
+          url = URI.parse(url)
+          req = Net::HTTP::Get.new(url.path)
+          res = Net::HTTP.start(url.host, url.port) do |http|
+            http.request(req)
+          end
+
+          res.body
+        end
+
+        def connection
+          sftp = Net::SFTP.start(@uploader.sftp_host, @uploader.sftp_user, @uploader.sftp_options)
+          yield sftp
+          sftp.close_channel
+        end
+      end
+    end
+  end
+end
+
+CarrierWave::Storage.autoload :SFTP, 'carrierwave/storage/sftp'
+
+class CarrierWave::Uploader::Base
+  add_config :sftp_host
+  add_config :sftp_user
+  add_config :sftp_options
+  add_config :sftp_folder
+  add_config :sftp_url
+
+  configure do |config|
+    config.storage_engines[:sftp] = "CarrierWave::Storage::SFTP"
+    config.sftp_host = "localhost"
+    config.sftp_user = "anonymous"
+    config.sftp_options = {}
+    config.sftp_folder = ""
+    config.sftp_url = "http://localhost"
+  end
+end

data/spec/sftp_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'carrierwave/storage/sftp'
+
+class SftpUploader < CarrierWave::Uploader::Base
+  storage :sftp
+end
+
+describe CarrierWave::Storage::SFTP do
+  before do
+    CarrierWave.configure do |config|
+      config.reset_config
+      config.sftp_host = 'testcarrierwave.dev'
+      config.sftp_user = 'test_user'
+      config.sftp_folder = '/home/test_user/public_html'
+      config.sftp_url = 'http://testcarrierwave.dev'
+      config.sftp_options = {
+        :password => 'test_passwd',
+        :port     => 22
+      }
+    end
+
+    @file = CarrierWave::SanitizedFile.new(file_path('test.jpg'))
+    SftpUploader.stub!(:store_path).and_return('uploads/test.jpg')
+    @storage = CarrierWave::Storage::SFTP.new(SftpUploader)
+  end
+
+  it "opens/closes an ftp connection to the given host" do
+    sftp = double(:sftp_connection)
+    sftp_params = [
+      'testcarrierwave.dev',
+      'test_user',
+      {
+        :password => 'test_passwd',
+        :port     => 22
+      }
+    ]
+
+    Net::SFTP.should_receive(:start).with(*sftp_params).and_return(sftp)
+    sftp.should_receive(:mkdir_p!).with('/home/test_user/public_html/uploads')
+    sftp.should_receive(:upload!).with(@file.path, '/home/test_user/public_html/uploads/test.jpg')
+    sftp.should_receive(:close_channel)
+    @stored = @storage.store!(@file)
+  end
+
+  describe 'after upload' do
+    before do
+      sftp = double(:sftp_connection)
+      Net::SFTP.stub(:start).and_return(sftp)
+      sftp.stub(:mkdir_p!)
+      sftp.stub(:upload!)
+      sftp.stub(:close_channel)
+      @stored = @storage.store!(@file)
+    end
+
+    it "returns a url based on directory" do
+      @stored.url.should == 'http://testcarrierwave.dev/uploads/test.jpg'
+    end
+
+    it "returns a path based on directory" do
+      @stored.path.should == 'uploads/test.jpg'
+    end
+  end
+
+  describe 'other operations' do
+    before do
+      @sftp = double(:sftp_connection)
+      Net::SFTP.stub(:start).and_return(@sftp)
+      @sftp.stub(:mkdir_p!)
+      @sftp.stub(:upload!)
+      @sftp.stub(:close_channel)
+      @stored = @storage.store!(@file)
+    end
+
+    it "deletes a file" do
+      @sftp.should_receive(:remove!).with('/home/test_user/public_html/uploads/test.jpg')
+      @stored.delete
+    end
+
+    it "checks whether a file exists" do
+      @stored.should_receive(:size).and_return(10)
+      @stored.exists?.should == true
+    end
+
+    it "returns the size of the file" do
+      @sftp.should_receive(:stat!).with('/home/test_user/public_html/uploads/test.jpg')
+          .and_return(Struct.new(:size).new(14))
+      @stored.size.should == 14
+    end
+
+    it "returns the content of the file" do
+      @stored.should_receive(:http_get_body).with(@stored.url).and_return('some content')
+      @stored.read.should == 'some content'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-ftp
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -73,9 +89,13 @@ files:
 - Rakefile
 - carrerwave-ftp.gemspec
 - lib/carrierwave/storage/ftp.rb
+- lib/carrierwave/storage/ftp/all.rb
 - lib/carrierwave/storage/ftp/ex_ftp.rb
+- lib/carrierwave/storage/ftp/ex_sftp.rb
 - lib/carrierwave/storage/ftp/version.rb
+- lib/carrierwave/storage/sftp.rb
 - spec/ftp_spec.rb
+- spec/sftp_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/luan/carrierwave-ftp
 licenses: []
@@ -91,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 518558825603707499
+      hash: 290347820507570724
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -100,13 +120,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 518558825603707499
+      hash: 290347820507570724
 requirements: []
-rubyforge_project: carrierwave-mongoid
+rubyforge_project: carrierwave-ftp
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: FTP support for CarrierWave
 test_files:
 - spec/ftp_spec.rb
+- spec/sftp_spec.rb
 - spec/spec_helper.rb