euromail 0.4.0 → 0.4.1

data/lib/euromail.rb

@@ -1,4 +1,5 @@
 module Euromail
+  require 'euromail/sftp_connection'
   require 'euromail/sftp_service'
   require 'euromail/sftp_development'
   require 'euromail/sftp_test'

data/lib/euromail/sftp_connection.rb

@@ -0,0 +1,20 @@
+module Euromail
+  class SFTPConnection
+
+    def initialize service, sftp
+      @service = service
+      @sftp = sftp
+    end
+
+    def upload pdf_data, identifier
+      @sftp.file.open( @service.filename(identifier) , "w") do |f|
+        f.write pdf_data
+      end      
+    end
+
+    def remove identifier
+      @sftp.remove!( @service.filename(identifier) )
+    end
+
+  end
+end

data/lib/euromail/sftp_development.rb

@@ -1,30 +1,27 @@
 module Euromail
-
   module SFTPDevelopment
 
-    def upload pdf_data, identifier
-      raise "Can only be called in a connect block" unless @sftp
+    class SFTPConnection < Euromail::SFTPConnection
+      def upload pdf_data, identifier
+        $stdout.puts "Uploaded #{@service.filename(identifier)}"
+      end
 
-      $stdout.puts "Uploaded #{filename(identifier)}"
+      def remove identifier
+        $stdout.puts "Removed #{@service.filename(identifier)}"
+      end
     end
 
-    def remove identifier
-      raise "Can only be called in a connect block" unless @sftp
-
-      $stdout.puts "Removed #{filename(identifier)}"
-    end
+    module ServiceMethods
+      def connect &block
+        $stdout.puts "Connecting to #{host}"
 
-    def connect &block
-      $stdout.puts "Connecting to #{host}"
+        connection = Euromail::SFTPDevelopment::SFTPConnection.new(self, "SFTP dummy")
+        block.call(connection)
 
-      @sftp = 'Dummy'
-      block.call(self)
-      @sftp = nil
-
-      $stdout.puts "Connection to #{host} closed"
+        $stdout.puts "Connection to #{host} closed"
+      end
     end
 
   end
-
 end
 

data/lib/euromail/sftp_service.rb

@@ -1,7 +1,6 @@
 require 'net/sftp'
 
 module Euromail
-
   class SFTPService
 
     attr_reader :application, :customer, :host, :username, :password
@@ -15,67 +14,43 @@ module Euromail
     end
 
     def test_mode!
-      self.extend(Euromail::SFTPTest)
+      self.extend(Euromail::SFTPTest::ServiceMethods)
     end
 
     def development_mode!
-      self.extend(Euromail::SFTPDevelopment)
-    end
-
-    # Upload pdf data to a file on the remote sftp server. Must be called within a connect block:
-    # euromail.connect do |service|
-    #   service.upload('some-data', '1')
-    # end
-    def upload pdf_data, identifier
-      raise "Can only be called in a connect block" unless @sftp
-      @sftp.file.open( filename(identifier) , "w") do |f|
-        f.write pdf_data
-      end      
+      self.extend(Euromail::SFTPDevelopment::ServiceMethods)
     end
 
     # Attempt to remove the file for the given identifier. If the upload fails or is aborted,
     # this method attempts to remove the incomplete file from the remote server.
     def upload! pdf_data, identifier
       begin
-        connect do |service|
-          service.upload(pdf_data, identifier)
+        connect do |connection|
+          connection.upload(pdf_data, identifier)
         end
       rescue => e
         remove!(identifier)
         raise e
       end
     end
-    
-    # Removes a pdf file on the remote sftp server. Must be called within a connect block:
-    # euromail.connect do |service|
-    #   service.remove('1')
-    # end
-    def remove identifier
-      raise "Can only be called in a connect block" unless @sftp
-      @sftp.remove!( filename(identifier) )
-    end
 
     # Attempt to remove the file for the given identifier. 
     def remove! identifier
-      connect do |service|
-        service.remove( identifier )
+      connect do |connection|
+        connection.remove( identifier )
       end
     end
 
     # Setup a connection to the sftp server. Operations can be defined in the block passed to this method:
-    # euromail.connect do |service|
-    #   service.upload('some data', '1')
-    #   service.upload('more data', '2')
-    #   service.remove('3')
+    # euromail.connect do |connection|
+    #   connection.upload('some data', '1')
+    #   connection.upload('more data', '2')
+    #   connection.remove('3')
     # end
     def connect &block
       Net::SFTP.start(host, username, :password => password) do |sftp|
-        begin
-          @sftp = sftp
-          block.call(self)
-        ensure
-          @sftp = nil
-        end
+        connection = Euromail::SFTPConnection.new(self, sftp)
+        block.call(connection)
       end
     end
 
@@ -87,5 +62,4 @@ module Euromail
     end
 
   end
-
 end

data/lib/euromail/sftp_test.rb

@@ -1,36 +1,34 @@
 module Euromail
   module SFTPTest
 
-    attr_writer :uploaded_files, :removed_files
-
-    def uploaded_files
-      return @uploaded_files || []
-    end
-
-    def removed_files
-      return @removed_files || []
+    class SFTPConnection < Euromail::SFTPConnection
+      def upload pdf_data, identifier
+        @service.uploaded_files = [] if @service.uploaded_files.empty?
+        @service.uploaded_files << @service.filename(identifier)
+      end
+
+      def remove identifier
+        @service.removed_files = [] if @service.removed_files.empty?
+        @service.removed_files << @service.filename(identifier)
+      end
     end
 
-    def upload pdf_data, identifier
-      raise "Can only be called in a connect block" unless @sftp
-      
-      @uploaded_files = [] if @uploaded_files.nil?
-      @uploaded_files << filename(identifier)
-    end
+    module ServiceMethods
+      attr_writer :uploaded_files, :removed_files
 
-    def remove identifier
-      raise "Can only be called in a connect block" unless @sftp
+      def uploaded_files
+        return @uploaded_files || []
+      end
 
-      @removed_files = [] if @removed_files.nil?
-      @removed_files << filename(identifier)
-    end
+      def removed_files
+        return @removed_files || []
+      end
 
-    def connect &block
-      @sftp = 'Dummy'
-      block.call(self)
-      @sftp = nil
+      def connect &block
+        connection = Euromail::SFTPTest::SFTPConnection.new(self, "SFTP dummy")
+        block.call(connection)
+      end
     end
 
   end
-
 end

data/spec/euromail/sftp_connection_spec.rb

@@ -0,0 +1,61 @@
+ require 'spec_helper'
+
+describe Euromail::SFTPConnection do
+  include SFTPMock
+
+  before(:each) do
+    mock_sftp
+  end
+
+  let(:euromail) do
+    Euromail::SFTPService.new('moves', 'nedap', 'some-cheapass-domain.com', "stefan", "super_secret")
+  end
+
+  describe "#upload" do
+    it "use the generated filename" do
+      @net_sftp_session.file.should receive(:open).with( euromail.filename('1'), 'w')
+      euromail.connect do |connection|
+        connection.upload('some-client-code', '1')
+      end
+    end
+
+    it "does not reestablish a connection for each upload" do
+      expect(Net::SFTP).to receive(:start).once
+      euromail.connect do |connection|
+        connection.upload('some-client-code', '1')
+        connection.upload('another-client-code', '2')
+      end
+    end
+
+    it "can upload several pdf files within the same connection" do
+      expect(@net_sftp_session.file).to receive(:open).exactly(2).times
+      @file_hander.should receive(:write).with('some-client-code-1')
+      @file_hander.should receive(:write).with('some-client-code-2')
+
+      euromail.connect do |connection|
+        connection.upload("some-client-code-1", '1')
+        connection.upload("some-client-code-2", '2')
+      end
+    end
+  end
+
+  describe "#remove" do
+    it "removes the file with the generated filename" do
+      @net_sftp_session.should receive(:remove!).with( euromail.filename('1') )
+      euromail.connect do |connection|
+        connection.remove('1')
+      end
+    end
+
+    it "does not reestablish a connection for each remove" do
+      expect(Net::SFTP).to receive(:start).once
+      euromail.connect do |connection|
+        connection.remove('1')
+        connection.remove('2')
+      end
+    end
+
+  end
+
+
+end

data/spec/euromail/sftp_development_spec.rb

@@ -17,39 +17,39 @@ describe Euromail::SFTPService do
     end
 
     describe "#upload" do
-      it "must be called in a connect block" do
-        expect{ euromail.upload('some-client-code', '1')}.to raise_error(RuntimeError)
+      it "does not upload anything" do
+        @file_hander.should_not receive(:write)
       end
 
-      it "only logs uploads" do
+      it "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")
-        euromail.connect do |service|
-          service.upload('come-client-code', '3')
+        euromail.connect do |connection|
+          connection.upload('come-client-code', '3')
         end
       end
     end
 
-    describe "remove" do
-      it "must be called in a connect block" do
-        expect{ euromail.remove('1')}.to raise_error(RuntimeError)
+    describe "#remove" do
+      it "does not remove anything" do
+        @net_sftp_session.should_not receive(:remove!)
       end
 
-      it "only logs deletes" do
+      it "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")
-        euromail.connect do |service|
-          service.remove('3')
+        euromail.connect do |connection|
+          connection.remove('3')
         end
       end
     end
 
-    describe "connect" do
-      it "only logs the connection" do
+    describe "#connect" do
+      it "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")

data/spec/euromail/sftp_service_spec.rb

@@ -26,56 +26,6 @@ describe Euromail::SFTPService do
       Net::SFTP.should receive(:start).with('some-cheapass-domain.com', 'stefan', :password => 'super_secret')
       euromail.connect {}
     end
-    
-    it "unsets the connection if some error occurs" do
-      expect { 
-        euromail.connect do |service|
-          raise 'boem'
-        end
-      }.to raise_error
-
-      # This should raise an error if the internal sftp connection is cleared
-      expect{ euromail.remove('1') }.to raise_error(RuntimeError)
-    end
-    
-  end
-
-  describe "#upload" do
-    it "use the generated filename" do
-      @net_sftp_session.file.should receive(:open).with( euromail.filename('1'), 'w')
-      euromail.connect do |service|
-        service.upload('some-client-code', '1')
-      end
-    end
-
-    it "must be called within a connect block" do
-      expect{ euromail.upload('some-client-code', '1')}.to raise_error(RuntimeError)
-      expect{
-        euromail.connect do |service|
-          service.upload('some-client-code', '1')
-          service.upload('another-client-code', '2')
-        end
-      }.to_not raise_error
-    end
-
-    it "does not reestablish a connection for each upload" do
-      expect(Net::SFTP).to receive(:start).once
-      euromail.connect do |service|
-        service.upload('some-client-code', '1')
-        service.upload('another-client-code', '2')
-      end
-    end
-
-    it "can upload several pdf files within the same connection" do
-      expect(@net_sftp_session.file).to receive(:open).exactly(2).times
-      @file_hander.should receive(:write).with('some-client-code-1')
-      @file_hander.should receive(:write).with('some-client-code-2')
-
-      euromail.connect do |service|
-        service.upload("some-client-code-1", '1')
-        service.upload("some-client-code-2", '2')
-      end
-    end
   end
 
   describe "#upload!" do
@@ -101,19 +51,6 @@ describe Euromail::SFTPService do
     end
   end
 
-  describe "#remove" do
-    it "removes the file with the generated filename" do
-      @net_sftp_session.should receive(:remove!).with( euromail.filename('1') )
-      euromail.connect do |service|
-        service.remove('1')
-      end
-    end
-
-    it "must be called within a connect block" do
-      expect{ euromail.upload('some-client-code', '1')}.to raise_error(RuntimeError)
-    end
-  end
-
   describe "#remove!" do
     it "removes the file from the sftp server" do
       @net_sftp_session.should receive(:remove!).with( euromail.filename('2') )

data/spec/euromail/sftp_test_spec.rb

@@ -17,10 +17,10 @@ describe Euromail::SFTPService do
     end
 
     describe "#upload" do
-      it "must be called in a connect block" do
-        expect{ euromail.upload('some-client-code', '1')}.to raise_error(RuntimeError)
+      it "does not upload anything" do
+        @file_hander.should_not receive(:write)
       end
-
+      
       it "stores uploaded filenames" do
         euromail.uploaded_files.should == []
         euromail.upload!('some-client-code', '1')
@@ -28,11 +28,11 @@ describe Euromail::SFTPService do
       end
     end
 
-    describe "remove" do
-      it "must be called in a connect block" do
-        expect{ euromail.remove('1')}.to raise_error(RuntimeError)
+    describe "#remove" do
+      it "does not remove anything" do
+        @net_sftp_session.should_not receive(:remove!)
       end
-      
+
       it "stores deleted filenames" do
         euromail.removed_files.should == []
         euromail.remove!('2')
@@ -40,7 +40,7 @@ describe Euromail::SFTPService do
       end
     end
 
-    describe "connect" do
+    describe "#connect" do
       it "only calls the block" do
         Net::SFTP.should_not receive(:start)
         $stdout.should_not receive(:puts)

data/spec/sftp_mock.rb

@@ -1,7 +1,7 @@
 module SFTPMock
   def mock_sftp
     @net_sftp_session = double("Net::SFTP::Session")
-    @file_hander = double("SomeFileHandler")
+    @file_hander = double("Net::SFTP::Operations::File")
 
     @file_hander.stub(:write) do |data|
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: euromail
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -33,10 +33,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/euromail/sftp_connection.rb
 - lib/euromail/sftp_development.rb
 - lib/euromail/sftp_service.rb
 - lib/euromail/sftp_test.rb
 - lib/euromail.rb
+- spec/euromail/sftp_connection_spec.rb
 - spec/euromail/sftp_development_spec.rb
 - spec/euromail/sftp_service_spec.rb
 - spec/euromail/sftp_test_spec.rb