euromail 0.3.0

data/lib/euromail.rb

@@ -0,0 +1,5 @@
+module Euromail
+  require 'euromail/sftp_service'
+  require 'euromail/sftp_development'
+  require 'euromail/sftp_test'
+end

data/lib/euromail/sftp_development.rb

@@ -0,0 +1,26 @@
+module Euromail
+
+  module SFTPDevelopment
+
+    def upload! pdf_data, identifier
+      connect do 
+        $stdout.puts "Uploaded #{filename(identifier)}"
+      end
+    end
+
+    def remove! identifier
+      connect do
+        $stdout.puts "Removed #{filename(identifier)}"
+      end
+    end
+
+    def connect &block
+      $stdout.puts "Connecting to #{host}"
+      block.call if block
+      $stdout.puts "Connection to #{host} closed"
+    end
+
+  end
+
+end
+

data/lib/euromail/sftp_service.rb

@@ -0,0 +1,58 @@
+require 'net/sftp'
+
+module Euromail
+
+  class SFTPService
+
+    attr_reader :application, :customer, :host, :username, :password
+
+    def initialize application, customer, host, username, password
+      @application = application
+      @customer = customer
+      @host = host
+      @username = username
+      @password = password
+    end
+
+    def test_mode!
+      self.extend(Euromail::SFTPTest)
+    end
+
+    def development_mode!
+      self.extend(Euromail::SFTPDevelopment)
+    end
+
+    def upload! pdf_data, identifier
+      begin
+        connect do |sftp|
+          sftp.file.open( filename(identifier) , "w") do |f|
+            f.write pdf_data
+          end
+        end
+      rescue => e
+        remove!(identifier)
+        raise e
+      end
+    end
+
+    # Attempt to remove the file for the given identifier. 
+    def remove! identifier
+      connect do |sftp|
+        sftp.remove!( filename(identifier) )
+      end
+    end
+    
+    def connect &block
+      Net::SFTP.start(host, username, :password => password, &block)
+    end
+
+    # Generate a filename based on the application, customer and some unique identifier.
+    # The identifier is not allowed to be blank since this risks previous files from being deleted.
+    def filename identifier
+      raise "An identifier is required" if identifier.to_s == ''
+      "./#{application}_#{customer}_#{identifier}.pdf"
+    end
+
+  end
+
+end

data/lib/euromail/sftp_test.rb

@@ -0,0 +1,29 @@
+module Euromail
+  module SFTPTest
+
+    attr_writer :uploaded_files, :removed_files
+
+    def uploaded_files
+      return @uploaded_files || []
+    end
+
+    def removed_files
+      return @removed_files || []
+    end
+
+    def upload! pdf_data, identifier
+      @uploaded_files = [] if @uploaded_files.nil?
+      @uploaded_files << filename(identifier)
+    end
+
+    def remove! identifier
+      @removed_files = [] if @removed_files.nil?
+      @removed_files << filename(identifier)
+    end
+
+    def connect &block
+    end
+
+  end
+
+end

data/spec/euromail/sftp_development_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Euromail::SFTPService do
+  include SFTPMock
+
+  before(:each) do
+    mock_sftp
+  end
+
+  let(:service) do
+    Euromail::SFTPService.new('moves', 'nedap', 'some-cheapass-domain.com', "stefan", "super_secret")
+  end
+
+  context "#development_mode!" do
+    before(:each) do
+      service.development_mode!
+    end
+
+    describe "#upload!" do
+      it "only logs uploads" do
+        Net::SFTP.should_not receive(:start)
+        $stdout.should receive(:puts).with("Connecting to some-cheapass-domain.com")
+        $stdout.should receive(:puts).with("Uploaded ./moves_nedap_3.pdf")
+        $stdout.should receive(:puts).with("Connection to some-cheapass-domain.com closed")
+        service.upload!('come-client-code', '3')
+      end
+    end
+
+    describe "remove!" do
+      it "only logs deletes" do
+        Net::SFTP.should_not receive(:start)
+        $stdout.should receive(:puts).with("Connecting to some-cheapass-domain.com")
+        $stdout.should receive(:puts).with("Removed ./moves_nedap_3.pdf")
+        $stdout.should receive(:puts).with("Connection to some-cheapass-domain.com closed")
+        service.remove!('3')
+      end
+    end
+
+    describe "connect" do
+      it "only logs the connection" do
+        Net::SFTP.should_not receive(:start)
+        $stdout.should receive(:puts).with("Connecting to some-cheapass-domain.com")
+        $stdout.should receive(:puts).with("Connection to some-cheapass-domain.com closed")
+        service.connect
+      end
+    end
+
+  end
+
+end

data/spec/euromail/sftp_service_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Euromail::SFTPService do
+  include SFTPMock
+
+  before(:each) do
+    mock_sftp
+  end
+
+  let(:service) do
+    Euromail::SFTPService.new('moves', 'nedap', 'some-cheapass-domain.com', "stefan", "super_secret")
+  end
+
+  context "when creating" do
+    it "has an application, customer, host, username and password" do
+      service.application.should eql('moves')
+      service.customer.should eql('nedap')
+      service.host.should eql('some-cheapass-domain.com')
+      service.username.should eql('stefan')
+      service.password.should eql('super_secret')
+    end
+  end
+
+  describe "#connect" do
+    it "connects to euromail using the given username and pass" do
+      Net::SFTP.should receive(:start).with('some-cheapass-domain.com', 'stefan', :password => 'super_secret')
+      service.connect {}
+    end
+  end
+
+  describe "#upload!" do
+    it "use the generated filename" do
+      @net_sftp_session.file.should receive(:open).with( service.filename('1'), 'w')
+      service.upload!('some-client-code', '1')
+    end
+
+    it "uploads pdf data" do
+      @file_hander.should receive(:write).with('some-client-code')
+      service.upload!('some-client-code', '1')
+    end
+
+    it "does not remove the remote file after an upload succeeds" do
+      service.should_not receive(:remove!).with('1')
+      service.upload!('some-client-code', '1')
+    end
+
+    it "tries to remove the remote file after an upload fails" do
+      @file_hander.stub(:write).and_raise("Connection dropped")
+      service.should receive(:remove!).with('1')
+      expect{ service.upload!('some-client-code', '1') }.to raise_error
+    end
+
+    it "returns true if it succeeds" do
+      expect{ service.upload!('some-client-code', '2') }.to_not raise_error
+    end
+
+    it "return false if some error occurs" do
+      @net_sftp_session.stub_chain(:file, :open).and_raise("Some error")
+      expect{ service.upload!('some-client-code', '2') }.to raise_error
+    end
+  end
+
+  describe "#remove!" do
+    it "removes the file from the sftp server" do
+      @net_sftp_session.should receive(:remove!).with( service.filename('2') )
+      @net_sftp_session.file.should_not receive(:open)
+      service.remove!('2')
+    end
+
+    it "returns true if it succeeds" do
+      expect{ service.remove!('2') }.to_not raise_error
+    end
+
+    it "return false if some error occurs" do
+      @net_sftp_session.stub(:remove!).and_raise("Some error")
+      expect{ service.remove!('2') }.to raise_error
+    end
+  end
+
+  describe "#filename" do 
+    it "generates a string with application, customer and the given identifier" do
+      service.filename('123').should eql('./moves_nedap_123.pdf')
+    end
+
+    it "requires a non empty identifier" do
+      expect{ service.filename('') }.to raise_error
+      expect{ service.filename(nil) }.to raise_error
+    end
+  end
+
+end

data/spec/euromail/sftp_test_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Euromail::SFTPService do
+  include SFTPMock
+
+  before(:each) do
+    mock_sftp
+  end
+
+  let(:service) do
+    Euromail::SFTPService.new('moves', 'nedap', 'some-cheapass-domain.com', "stefan", "super_secret")
+  end
+
+  context "#test_mode!" do
+    before(:each) do
+      service.test_mode!
+    end
+
+    describe "#upload!" do
+      it "stores uploaded filenames" do
+        service.uploaded_files.should == []
+        service.upload!('some-client-code', '1')
+        service.uploaded_files.should == [service.filename('1')]
+      end
+    end
+
+    describe "remove!" do
+      it "stores deleted filenames" do
+        service.removed_files.should == []
+        service.remove!('2')
+        service.removed_files.should == [service.filename('2')]
+      end
+    end
+
+    describe "connect" do
+      it "does nothing" do
+        Net::SFTP.should_not receive(:start)
+        $stdout.should_not receive(:puts)
+        service.connect
+      end
+    end
+
+  end
+
+end

data/spec/sftp_mock.rb

@@ -0,0 +1,20 @@
+module SFTPMock
+  def mock_sftp
+    @net_sftp_session = double("Net::SFTP::Session")
+    @file_hander = double("SomeFileHandler")
+
+    @file_hander.stub(:write) do |data|
+    end
+
+    @net_sftp_session.stub(:remove!) do |filename|
+    end
+
+    @net_sftp_session.stub_chain(:file, :open) do |filename, method, &block|
+      block.call(@file_hander) if block
+    end
+
+    Net::SFTP.stub(:start) do |host, username, password_hash, &block|
+      block.call(@net_sftp_session) if block
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'euromail'
+require 'sftp_mock'
+require 'simplecov'
+require 'simplecov-rcov'
+
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+
+if ENV["COVERAGE"]
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: euromail
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Stefan Teijgeler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-26 00:00:00.000000000 Z
+dependencies: []
+description: Euromail SFTP service
+email: stefan.teijgeler@nedap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/euromail/sftp_development.rb
+- lib/euromail/sftp_service.rb
+- lib/euromail/sftp_test.rb
+- lib/euromail.rb
+- spec/euromail/sftp_development_spec.rb
+- spec/euromail/sftp_service_spec.rb
+- spec/euromail/sftp_test_spec.rb
+- spec/sftp_mock.rb
+- spec/spec_helper.rb
+homepage: https://github.com/steijgeler/euromail
+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.25
+signing_key: 
+specification_version: 3
+summary: Gem to upload pdf data to an SFTP server
+test_files: []