paperclip-sftp 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yury Velikanau
+
+MIT License
+
+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,44 @@
+[![Dependency Status](https://gemnasium.com/spectator/paperclip-sftp.png?travis)](https://gemnasium.com/spectator/paperclip-sftp)
+
+Paperclip SFTP
+==============
+
+Paperclip SFTP is Secure File Transfer Protocol storage for [Paperclip](https://github.com/thoughtbot/paperclip)
+
+Installation
+------------
+
+```ruby
+gem 'paperclip-sftp', '~> 1.0.0'
+```
+
+Usage
+-----
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar,
+    storage: :sftp,
+    sftp_options: {
+      host: "sftp.example.com",
+      user: "user",
+      password: "password"
+    }
+end
+```
+
+You can define these options globally, enable this storage for specific environments, etc. Please see [Paperclip](https://github.com/thoughtbot/paperclip) github page for more details.
+
+Running tests
+-------------
+
+All tests are live so in order to run them you need to setup local (or remote) SFTP server. That will take at most 5 minutes on either MacOS or Linux. Connection is defined in `test/test_helper.rb` if you need to change it.
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs    << "test"
+  t.pattern = "test/*_test.rb"
+end
+
+task default: "test"

data/lib/paperclip-sftp.rb

@@ -0,0 +1,3 @@
+require "paperclip"
+require "paperclip-sftp/version"
+require "paperclip-sftp/storage/sftp"

data/lib/paperclip-sftp/storage/sftp.rb

@@ -0,0 +1,105 @@
+module Paperclip
+  module Storage
+    # SFTP (Secure File Transfer Protocol) storage for Paperclip.
+    #
+    module Sftp
+
+      # SFTP storage expects a hash with following options:
+      # :host, :user, :password.
+      #
+      def self.extended(base)
+        begin
+          require "net/sftp"
+        rescue LoadError => e
+          e.message << "(You may need to install net-sftp gem)"
+          raise e
+        end unless defined?(Net::SFTP)
+
+        base.instance_exec do
+          @sftp_options = options[:sftp_options] || {}
+        end
+      end
+
+      # Make SFTP connection, but use current one if exists.
+      #
+      def sftp
+        @sftp ||= Net::SFTP.start(
+          @sftp_options[:host],
+          @sftp_options[:user],
+          password: @sftp_options[:password]
+        )
+      end
+
+      def exists?(style = default_style)
+        if original_filename
+          files = sftp.dir.entries(File.dirname(path(style))).map(&:name)
+          files.include?(File.basename(path(style)))
+        else
+          false
+        end
+      rescue Net::SFTP::StatusException => e
+        false
+      end
+
+      def copy_to_local_file(style, local_dest_path)
+        log("copying #{path(style)} to local file #{local_dest_path}")
+        sftp.download!(path(style), local_dest_path)
+      rescue Net::SFTP::StatusException => e
+        warn("#{e} - cannot copy #{path(style)} to local file #{local_dest_path}")
+        false
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style, file|
+          mkdir_p(File.dirname(path(style)))
+          log("uploading #{file.path} to #{path(style)}")
+          sftp.upload!(file.path, path(style))
+          sftp.setstat!(path(style), :permissions => 0644)
+        end
+
+        after_flush_writes # allows attachment to clean up temp files
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          begin
+            log("deleting file #{path}")
+            sftp.remove(path).wait
+          rescue Net::SFTP::StatusException => e
+            # ignore file-not-found, let everything else pass
+          end
+
+          begin
+            path = File.dirname(path)
+            while sftp.dir.entries(path).delete_if { |e| e.name =~ /^\./ }.empty?
+              sftp.rmdir(path).wait
+              path = File.dirname(path)
+            end
+          rescue Net::SFTP::StatusException => e
+            # stop trying to remove parent directories
+          end
+        end
+
+        @queued_for_delete = []
+      end
+
+      private
+
+      # Create directory structure.
+      #
+      def mkdir_p(remote_directory)
+        log("mkdir_p for #{remote_directory}")
+        root_directory = '/'
+        remote_directory.split('/').each do |directory|
+          next if directory.blank?
+          unless sftp.dir.entries(root_directory).map(&:name).include?(directory)
+            sftp.mkdir!("#{root_directory}#{directory}")
+          end
+          root_directory += "#{directory}/"
+        end
+      end
+
+    end
+  end
+end

data/lib/paperclip-sftp/version.rb

@@ -0,0 +1,5 @@
+module Paperclip
+  module Sftp
+    VERSION = "1.0.0"
+  end
+end

data/paperclip-sftp.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/paperclip-sftp/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yury Velikanau"]
+  gem.email         = ["yury.velikanau@gmail.com"]
+  gem.description   = %q{SFTP (Secure File Transfer Protocol) storage for Paperclip.}
+  gem.summary       = %q{SFTP (Secure File Transfer Protocol) storage for Paperclip.}
+  gem.homepage      = "https://github.com/spectator/paperclip-sftp"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "paperclip-sftp"
+  gem.require_paths = ["lib"]
+  gem.version       = Paperclip::Sftp::VERSION
+
+  gem.add_dependency "paperclip", "~> 3.1.0"
+  gem.add_dependency "net-sftp",  "~> 2.0.5"
+
+  gem.add_development_dependency "minitest",        "~> 3.3.0"
+  gem.add_development_dependency "minitest_should", "~> 0.3.1"
+  gem.add_development_dependency "sqlite3",         "~> 1.3.3"
+end

data/test/integration_test.rb

@@ -0,0 +1,28 @@
+require "test_helper"
+
+class IntegrationTest < MiniTest::Should::TestCase
+
+  setup do
+    @file = fixture_file("ruby.png")
+  end
+
+  should "create attachment and its files" do
+    dummy = Dummy.create!(avatar: @file)
+
+    assert File.file?(dummy.avatar.path), "File was not uploaded"
+  end
+
+  should "delete attachment and its files" do
+    dummy = Dummy.create!(avatar: @file)
+
+    avatar = dummy.avatar.path
+    dummy.destroy
+    assert !File.file?(avatar), "File was not deleted"
+  end
+
+  teardown do
+    @file.close
+    cleanup
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,45 @@
+require "paperclip-sftp"
+require "minitest/autorun"
+require "minitest/should"
+require "active_record"
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+def define_schema
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :dummies do |t|
+      t.string  :avatar_file_name, :avatar_content_type
+      t.integer :avatar_file_size
+    end
+  end
+end
+
+silence_stream(STDOUT) do
+  define_schema
+end
+
+def fixture_file(file)
+  File.new(File.join(File.dirname(__FILE__), "fixtures", file), 'rb')
+end
+
+def cleanup
+  FileUtils.rm_rf(File.expand_path(File.join(File.dirname(__FILE__), 'tmp')))
+end
+
+Paperclip.options[:log] = false
+Paperclip.interpolates(:work_dir) do |attachment, style|
+  File.expand_path(File.join(File.dirname(__FILE__), 'tmp'))
+end
+
+class Dummy < ActiveRecord::Base
+  include Paperclip::Glue
+
+  has_attached_file :avatar,
+    path: ":work_dir/:class/:attachment/:id_partition/:style/:filename",
+    storage: :sftp,
+    sftp_options: {
+      host: "localhost",
+      user: "spectator",
+      password: "password"
+    }
+end

data/test/unit_test.rb

@@ -0,0 +1,78 @@
+require "test_helper"
+
+class UnitTest < MiniTest::Should::TestCase
+  setup do
+    @file = fixture_file("ruby.png")
+  end
+
+  context "with credentials provided as options" do
+    should "persist credentials" do
+      dummy = Dummy.new(avatar: @file)
+      assert_equal :sftp, dummy.avatar.options[:storage]
+      assert_equal "localhost", dummy.avatar.options[:sftp_options][:host]
+      assert_equal "spectator", dummy.avatar.options[:sftp_options][:user]
+      assert_equal "password", dummy.avatar.options[:sftp_options][:password]
+    end
+  end
+
+  context "#exists?" do
+    setup do
+      @dummy = Dummy.create!(avatar: @file)
+    end
+
+    should "have file" do
+      assert @dummy.avatar.exists?, "File doesn't exist in desired location"
+    end
+
+    should "not have file" do
+      cleanup
+      assert !@dummy.avatar.exists?, "File is still exists, but should not"
+    end
+  end
+
+  context "#copy_to_local_file" do
+    setup do
+      @dummy = Dummy.create!(avatar: @file)
+      @dest = File.expand_path(File.join(File.dirname(__FILE__), 'tmp', 'new_file.png'))
+    end
+
+    should "copy to local file" do
+      @dummy.avatar.copy_to_local_file(:original, @dest)
+      assert File.exist?(@dest), "File was not copied to desired location"
+    end
+
+    should "not copy file if #original_filename is nil" do
+      @dummy.avatar.instance_write(:file_name, nil)
+      assert !@dummy.avatar.exists?, "File shouldn't be found if avatar_file_name is empty"
+    end
+
+    should "not copy to local file if remote file doesn't exist" do
+      @dummy.avatar.copy_to_local_file(:original, @dest)
+      cleanup
+      assert !File.exist?(@dest), "File shouldn't be found"
+    end
+  end
+
+  context "#flush_writes" do
+    should "write files to remote files" do
+      dummy = Dummy.new(avatar: @file)
+      dummy.avatar.flush_writes
+      assert File.file?(dummy.avatar.path), "File was not written down"
+    end
+  end
+
+  context "#flush_deletes" do
+    should "delete files scheduled for deletion" do
+      dummy = Dummy.create!(avatar: @file)
+      avatar = dummy.avatar.path
+      dummy.avatar.send :queue_all_for_delete
+      dummy.avatar.flush_deletes
+      assert !File.file?(avatar), "File was not deleted"
+    end
+  end
+
+  teardown do
+    @file.close
+    cleanup
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-sftp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Yury Velikanau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest_should
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+description: SFTP (Secure File Transfer Protocol) storage for Paperclip.
+email:
+- yury.velikanau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/paperclip-sftp.rb
+- lib/paperclip-sftp/storage/sftp.rb
+- lib/paperclip-sftp/version.rb
+- paperclip-sftp.gemspec
+- test/fixtures/ruby.png
+- test/integration_test.rb
+- test/test_helper.rb
+- test/unit_test.rb
+homepage: https://github.com/spectator/paperclip-sftp
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: SFTP (Secure File Transfer Protocol) storage for Paperclip.
+test_files:
+- test/fixtures/ruby.png
+- test/integration_test.rb
+- test/test_helper.rb
+- test/unit_test.rb