file_transfer_mixin 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@file_transfer_mixin

data/Gemfile

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

data/README

@@ -0,0 +1,35 @@
+== FileTransferMixin ==
+FileTransferMixin is a module that you can include in a library.  It will support various mechanisms long-term, but
+for now is focused on SFTP servers.
+
+- sftp_send(key, remote_location, local_file_path)
+- sftp_fetch(key, remote_path, local_path)
+
+- It expects an ENV variable named FILE_TRANSFER_MIXIN_CONFIG_PATH to be set.
+- It expects a yml configuration file in FILE_TRANSFER_MIXIN_CONFIG_PATH that looks like the following:
+
+sftp:
+  some_key:
+    server: sftp.matrix.com
+    username: neo
+    password: the_one
+
+Then in a class, you would deal with it thusly:
+
+class SomeClass
+  include FileTransferMixin
+
+  # Some method that uploads a file
+  def some_method
+    sftp_send(:some_key, remote_path, local_path)
+  end
+
+  # Some method that fetches a file
+  def fetch_method
+    sftp_fetch(:some_key, remote_path, local_path)
+  end
+end
+
+== Motivation ==
+We have quite a few libraries that interact with remote SFTP servers, and inevitably they share massive swathes of code
+that should be unnecessary.  This intends to be a mixin to make the easy things extremely easy.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/file_transfer_mixin.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "file_transfer_mixin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "file_transfer_mixin"
+  s.version     = FileTransferMixin::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josh Adams"]
+  s.email       = ["josh@isotope11.com"]
+  s.homepage    = ""
+  s.summary     = %q{A mixin to include in various libraries to allow you to easily send/retrieve files from remote servers.}
+
+  s.rubyforge_project = "file_transfer_mixin"
+
+  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 'net-sftp', '~> 2.0.5'
+  s.add_dependency 'enviro', '~> 0.0.4'
+  s.add_development_dependency "bundler", ">= 1.0.0.rc.6"
+  s.add_development_dependency "rspec", "~> 2.4.0"
+  s.add_development_dependency "ruby-debug19"
+end

data/lib/file_transfer_mixin/interfaces/sftp.rb

@@ -0,0 +1,38 @@
+module FileTransferMixin
+  module InstanceMethods
+    extend Forwardable
+
+    def_delegators :file_transfer_mixin_sftp_instance, :sftp_send, :sftp_fetch
+
+    private
+    def file_transfer_mixin_sftp_instance
+      ::FileTransferMixin::Interfaces::SFTP.new
+    end
+  end
+
+  module Interfaces
+    class SFTP
+      def configuration
+        FileTransferMixin.configuration.sftp
+      end
+
+      def sftp_block(key, &block)
+        Net::SFTP.start(configuration[key][:server], configuration[key][:username], :password => configuration[key][:password]) do |sftp|
+          yield(sftp)
+        end
+      end
+
+      def sftp_send(key, remote_path, local_path)
+        sftp_block(key) do |sftp|
+          sftp.upload!(local_path, remote_path)
+        end
+      end
+
+      def sftp_fetch(key, remote_path, local_path)
+        sftp_block(key) do |sftp|
+          sftp.download!(remote_path, local_path)
+        end
+      end
+    end
+  end
+end

data/lib/file_transfer_mixin/interfaces.rb

@@ -0,0 +1,6 @@
+require 'file_transfer_mixin/interfaces/sftp'
+
+module FileTransferMixin
+  module Interfaces
+  end
+end

data/lib/file_transfer_mixin/version.rb

@@ -0,0 +1,3 @@
+module FileTransferMixin
+  VERSION = "0.0.1"
+end

data/lib/file_transfer_mixin.rb

@@ -0,0 +1,17 @@
+require 'enviro'
+require 'net/sftp'
+require 'forwardable'
+
+require 'file_transfer_mixin/interfaces'
+
+module FileTransferMixin
+  include ::Enviro::Environate
+  configuration_path_env :file_transfer_mixin_config_path
+
+  module InstanceMethods
+  end
+
+  def self.included(base)
+    base.send :include, InstanceMethods
+  end
+end

data/spec/lib/file_transfer_mixin_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe FileTransferMixin do
+  before(:each) do
+    Object.send(:remove_const, :TestFileTransferMixin) if defined?(TestFileTransferMixin)
+
+    ENV['FILE_TRANSFER_MIXIN_CONFIG_PATH'] = '/tmp/file_transfer_mixin_enviro_config.yml'
+
+    config = {
+      :development => {
+      },
+      :test => {
+      },
+      :production => {
+      },
+    }
+    File.open(ENV['FILE_TRANSFER_MIXIN_CONFIG_PATH'], 'w') do |f|
+      f.write(YAML.dump(config))
+    end
+
+    class TestFileTransferMixin
+      include FileTransferMixin
+    end
+  end
+
+  it "should be valid" do
+    FileTransferMixin.should be_a(Module)
+  end
+
+  it "should know where to find its configuration file" do
+    FileTransferMixin.configuration_path.should == ENV['FILE_TRANSFER_MIXIN_CONFIG_PATH']
+  end
+end

data/spec/lib/interfaces/sftp_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe ::FileTransferMixin::Interfaces::SFTP do
+  before(:each) do
+    Object.send(:remove_const, :TestFileTransferMixin) if defined?(TestFileTransferMixin)
+    ENV['FILE_TRANSFER_MIXIN_CONFIG_PATH'] = '/tmp/file_transfer_mixin_enviro_config.yml'
+    ENV['ENVY_ENV'] = 'development'
+
+    @config = {
+      :development => {
+        :sftp => {
+          :some_key => {
+            :server => '127.0.0.1',
+            :username => 'user',
+            :password => 'pass',
+          }
+        }
+      },
+      :test => {
+      },
+      :production => {
+      },
+    }
+    File.open(ENV['FILE_TRANSFER_MIXIN_CONFIG_PATH'], 'w') do |f|
+      f.write(YAML.dump(@config))
+    end
+
+    class TestFileTransferMixin
+      include FileTransferMixin
+    end
+
+    sftp_mock = mock('sftp')
+    sftp_mock.stub!(:upload!).and_return(true)
+    sftp_mock.stub!(:download!).and_return(true)
+    Net::SFTP.stub(:start).and_return(sftp_mock)
+  end
+
+  it "should know its parent configuration key" do
+    subject.configuration.should == @config[:development][:sftp]
+  end
+
+  it "should be able to find the server, username, and password for a given key" do
+    subject.configuration[:some_key][:server].should == '127.0.0.1'
+    subject.configuration[:some_key][:username].should == 'user'
+    subject.configuration[:some_key][:password].should == 'pass'
+  end
+
+  it "should respond to sftp_send" do
+    lambda{ TestFileTransferMixin.new.sftp_send(:some_key, 'path', 'file_path') }.should_not raise_error
+  end
+
+  it "should respond to sftp_fetch" do
+    lambda{ TestFileTransferMixin.new.sftp_fetch(:some_key, 'path', 'file_path') }.should_not raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+Bundler.require :default, :test
+
+require "rspec"
+
+RSpec.configure do |config|
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  # == Mock Framework
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: file_transfer_mixin
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Josh Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-04 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-sftp
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 5
+        version: 2.0.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: enviro
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 4
+        version: 0.0.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        - rc
+        - 6
+        version: 1.0.0.rc.6
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: 
+email: 
+- josh@isotope11.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README
+- Rakefile
+- file_transfer_mixin.gemspec
+- lib/file_transfer_mixin.rb
+- lib/file_transfer_mixin/interfaces.rb
+- lib/file_transfer_mixin/interfaces/sftp.rb
+- lib/file_transfer_mixin/version.rb
+- spec/lib/file_transfer_mixin_spec.rb
+- spec/lib/interfaces/sftp_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: file_transfer_mixin
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A mixin to include in various libraries to allow you to easily send/retrieve files from remote servers.
+test_files: []
+