carrierwave-ftp 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.rbc
+.bundle
+.config
+tmp
+Gemfile.lock
+.ftp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in carrierwave-mongoid.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Luan Santos
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# CarrierWave FTP storage
+
+This gem adds support for FTP upload to [CarrierWave](https://github.com/jnicklas/carrierwave/)
+
+## Installation
+
+Install the latest release:
+
+    gem install carrierwave-ftp
+
+Require it in your code:
+
+    require 'carrierwave/storage/ftp'
+
+Or, in Rails you can add it to your Gemfile:
+
+    gem 'carrierwave-ftp', :require => 'carrierwave/storage/ftp'
+
+## Getting Started
+
+First configure CarrierWave with your FTP credentials:
+
+```ruby
+CarrierWave.configure do |config|
+  config.ftp_host = "ftp.example.com"
+  config.ftp_port = 21
+  config.ftp_user = "example"
+  config.ftp_passwd = "secret"
+  config.ftp_folder = "/public_html/uploads"
+  config.ftp_url = "http://example.com/uploads"
+end
+```
+
+And then in your uploader, set the storage to `:ftp`:
+
+```ruby
+class AvatarUploader < CarrierWave::Uploader::Base
+  storage :ftp
+end
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  #t.rspec_path = 'bin/rspec'
+  t.rspec_opts = %w[--color]
+end
+
+task :default => :spec

data/carrerwave-ftp.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "carrierwave/storage/ftp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "carrierwave-ftp"
+  s.version     = Carrierwave::Storage::FTP::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Luan Santos"]
+  s.email       = ["luan@luansantos.com"]
+  s.homepage    = "https://github.com/luan/carrierwave-ftp"
+  s.summary     = %q{FTP support for CarrierWave}
+  s.description = %q{Allows file upload using FTP for CarrierWave uploaders.}
+
+  s.rubyforge_project = "carrierwave-mongoid"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "carrierwave", ["~> 0.6.2"]
+  s.add_development_dependency "rspec", ["~> 2.6"]
+  s.add_development_dependency "rake", ["~> 0.9"]
+end

data/lib/carrierwave/storage/ftp.rb

@@ -0,0 +1,104 @@
+require 'carrierwave'
+require 'carrierwave/storage/ftp/ex_ftp'
+
+module CarrierWave
+  module Storage
+    class FTP < Abstract
+      def store!(file)
+        f = CarrierWave::Storage::FTP::File.new(uploader, self, uploader.store_path)
+        f.store(file)
+        f
+      end
+
+      class File
+        attr_reader :path
+
+        def initialize(uploader, base, path)
+          @uploader, @base, @path = uploader, base, path
+        end
+
+        def store(file)
+          connection do |ftp|
+            ftp.mkdir_p(::File.dirname "#{@uploader.ftp_folder}/#{path}")
+            ftp.chdir(::File.dirname "#{@uploader.ftp_folder}/#{path}")
+            ftp.put(file.path, filename)
+          end
+        end
+
+        def url
+          "#{@uploader.ftp_url}/#{path}"
+        end
+
+        def filename(options = {})
+          url.gsub(/.*\/(.*?$)/, '\1')
+        end
+
+        def size
+          size = nil
+
+          connection do |ftp|
+            ftp.chdir(::File.dirname "#{@uploader.ftp_folder}/#{path}")
+            size = ftp.size(filename)
+          end
+
+          size
+        end
+
+        def exists?
+          size ? true : false
+        end
+
+        def read
+          http_get_body(url)
+        end
+
+        def delete
+          connection do |ftp|
+            ftp.chdir(::File.dirname "#{@uploader.ftp_folder}/#{path}")
+            ftp.delete(filename)
+          end
+        end
+
+        private
+
+        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
+          ftp = ExFTP.open(@uploader.ftp_host, @uploader.ftp_user, @uploader.ftp_passwd, @uploader.ftp_port)
+          yield ftp
+          ftp.close
+        end
+      end
+    end
+  end
+end
+
+CarrierWave::Storage.autoload :FTP, 'carrierwave/storage/ftp'
+
+class CarrierWave::Uploader::Base
+  add_config :ftp_host
+  add_config :ftp_port
+  add_config :ftp_user
+  add_config :ftp_passwd
+  add_config :ftp_folder
+  add_config :ftp_url
+
+  configure do |config|
+    config.storage_engines[:ftp] = "CarrierWave::Storage::FTP"
+    config.ftp_host = "localhost"
+    config.ftp_port = 21
+    config.ftp_user = "anonymous"
+    config.ftp_passwd = ""
+    config.ftp_folder = "/"
+    config.ftp_url = "http://localhost"
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'net/ftp'
+
+class ExFTP < Net::FTP
+  def mkdir_p(dir)
+    parts = dir.split("/")
+    if parts.first == "~"
+      growing_path = ""
+    else
+      growing_path = "/"
+    end
+    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)
+        chdir(growing_path)
+      rescue Net::FTPPermError, Net::FTPTempError => e
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Carrierwave
+  module Storage
+    class FTP
+      VERSION = "0.1.0"
+    end
+  end
+end

data/spec/ftp_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'carrierwave/storage/ftp'
+
+class FtpUploader < CarrierWave::Uploader::Base
+  storage :ftp
+end
+
+describe CarrierWave::Storage::FTP do
+  before do
+    CarrierWave.configure do |config|
+      config.reset_config
+      config.ftp_host = 'ftp.testcarrierwave.dev'
+      config.ftp_user = 'test_user'
+      config.ftp_passwd = 'test_passwd'
+      config.ftp_folder = '~/public_html'
+      config.ftp_url = 'http://testcarrierwave.dev'
+    end
+
+    @file = CarrierWave::SanitizedFile.new(file_path('test.jpg'))
+    FtpUploader.stub!(:store_path).and_return('uploads/test.jpg')
+    @storage = CarrierWave::Storage::FTP.new(FtpUploader)
+  end
+
+  it "opens/closes an ftp connection to the given host" do
+    ftp = double(:ftp_connection)
+    ftp_params = [
+      'ftp.testcarrierwave.dev',
+      'test_user',
+      'test_passwd',
+      21
+    ]
+
+    Net::FTP.should_receive(:open).with(*ftp_params).and_return(ftp)
+    ftp.should_receive(:mkdir_p).with('~/public_html/uploads')
+    ftp.should_receive(:chdir).with('~/public_html/uploads')
+    ftp.should_receive(:put).with(@file.path, 'test.jpg')
+    ftp.should_receive(:close)
+    @stored = @storage.store!(@file)
+  end
+
+  describe 'after upload' do
+    before do
+      ftp = double(:ftp_connection)
+      Net::FTP.stub(:open).and_return(ftp)
+      ftp.stub(:mkdir_p)
+      ftp.stub(:chdir)
+      ftp.stub(:put)
+      ftp.stub(:close)
+      @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
+      @ftp = double(:ftp_connection)
+      Net::FTP.stub(:open).and_return(@ftp)
+      @ftp.stub(:mkdir_p)
+      @ftp.stub(:chdir)
+      @ftp.stub(:put)
+      @ftp.stub(:close)
+      @stored = @storage.store!(@file)
+    end
+
+    it "deletes a file" do
+      @ftp.should_receive(:chdir).with('~/public_html/uploads')
+      @ftp.should_receive(:delete).with('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
+      @ftp.should_receive(:size).and_return(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

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'tempfile'
+
+require 'carrierwave'
+
+def file_path( *paths )
+  File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', *paths))
+end
+
+def public_path( *paths )
+  File.expand_path(File.join(File.dirname(__FILE__), 'public', *paths))
+end
+
+CarrierWave.root = public_path
+
+module CarrierWave
+  module Test
+    module MockFiles
+      def stub_file(filename, mime_type=nil, fake_name=nil)
+        f = File.open(file_path(filename))
+        return f
+      end
+
+      def stub_tempfile(filename, mime_type=nil, fake_name=nil)
+        raise "#{path} file does not exist" unless File.exist?(file_path(filename))
+
+        t = Tempfile.new(filename)
+        FileUtils.copy_file(file_path(filename), t.path)
+
+        t.stub!(:local_path => "",
+                :original_filename => filename || fake_name,
+                :content_type => mime_type)
+
+        return t
+      end
+    end
+
+    module I18nHelpers
+      def change_locale_and_store_translations(locale, translations, &block)
+        current_locale = I18n.locale
+        begin
+          I18n.backend.store_translations locale, translations
+          I18n.locale = locale
+          yield
+        ensure
+          I18n.reload!
+          I18n.locale = current_locale
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include CarrierWave::Test::MockFiles
+  config.include CarrierWave::Test::I18nHelpers
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-ftp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Luan Santos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Allows file upload using FTP for CarrierWave uploaders.
+email:
+- luan@luansantos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- carrerwave-ftp.gemspec
+- lib/carrierwave/storage/ftp.rb
+- lib/carrierwave/storage/ftp/ex_ftp.rb
+- lib/carrierwave/storage/ftp/version.rb
+- spec/ftp_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/luan/carrierwave-ftp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3697623012549711169
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3697623012549711169
+requirements: []
+rubyforge_project: carrierwave-mongoid
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: FTP support for CarrierWave
+test_files:
+- spec/ftp_spec.rb
+- spec/spec_helper.rb