stockboy 1.2.1 → 1.3.0

data/spec/stockboy/providers/ftp_spec.rb

@@ -42,17 +42,6 @@ module Stockboy
     end
 
     describe "#client" do
-      it "should open connection to host with username and password" do
-        expect_connection
-
-        connection = false
-        provider.client { |f| connection = f }
-
-        expect(connection).to be_a Net::FTP
-        expect(connection.binary).to be true
-        expect(connection.passive).to be true
-      end
-
       it "should return yielded result" do
         expect_connection
 
@@ -67,20 +56,20 @@ module Stockboy
         provider.host = nil
         provider.data
 
-        expect(provider.errors.first).to match /host/
+        expect(provider.errors.first).to include "host"
       end
 
       it "adds an error on missing file_name" do
         provider.file_name = nil
         provider.data
 
-        expect(provider.errors.first).to match /file_name/
+        expect(provider.errors.first).to include "file_name"
       end
 
       it "downloads the last matching file" do
         net_ftp = expect_connection
-        expect(net_ftp).to receive(:nlst).and_return ['20120101.csv', '20120102.csv']
-        expect(net_ftp).to receive(:get).with('20120102.csv', nil).and_return "DATA"
+        expect(net_ftp).to receive(:list_files).and_return ['20120101.csv', '20120102.csv']
+        expect(net_ftp).to receive(:download).with('20120102.csv').and_return "DATA"
         expect(provider).to receive(:validate_file).and_return true
 
         expect(provider.data).to eq "DATA"
@@ -88,12 +77,12 @@ module Stockboy
 
       it "skips old files" do
         net_ftp = expect_connection
-        expect(net_ftp).to receive(:nlst).and_return ['20120101.csv', '20120102.csv']
-        expect(net_ftp).to receive(:mtime).with('20120102.csv').and_return(Time.new(2009,01,01))
-        expect(net_ftp).to_not receive(:get)
+        expect(net_ftp).to receive(:list_files).and_return ['20120101.csv', '20120102.csv']
+        expect(net_ftp).to receive(:modification_time).with('20120102.csv').and_return(Time.new(2009,01,01))
+        expect(net_ftp).to receive(:size).with('20120102.csv').and_return(Time.new(2009,01,01))
+        expect(net_ftp).to_not receive(:download)
 
         provider.file_newer = Time.new(2010,1,1)
-
         expect(provider.data).to be nil
       end
     end
@@ -101,12 +90,12 @@ module Stockboy
     describe "#matching_file" do
       it "does not change until cleared" do
         net_ftp = expect_connection
-        expect(net_ftp).to receive(:nlst).and_return ["1.csv", "2.csv"]
+        expect(net_ftp).to receive(:list_files).and_return ["1.csv", "2.csv"]
 
         expect(provider.matching_file).to eq "2.csv"
 
         net_ftp = expect_connection
-        expect(net_ftp).to receive(:nlst).and_return ["1.csv", "2.csv", "3.csv"]
+        expect(net_ftp).to receive(:list_files).and_return ["1.csv", "2.csv", "3.csv"]
 
         expect(provider.matching_file).to eq "2.csv"
         provider.clear
@@ -116,13 +105,13 @@ module Stockboy
 
     describe "#delete_data" do
       it "should raise an error when called blindly" do
-        expect_any_instance_of(Net::FTP).to_not receive(:delete)
+        expect_any_instance_of(provider.adapter_class).to_not receive(:delete)
         expect { provider.delete_data }.to raise_error Stockboy::OutOfSequence
       end
 
       it "should delete the matching file" do
         net_ftp = expect_connection
-        expect(net_ftp).to receive(:nlst).and_return ["1.csv", "2.csv"]
+        expect(net_ftp).to receive(:list_files).and_return ["1.csv", "2.csv"]
 
         expect(provider.matching_file).to eq "2.csv"
 
@@ -133,10 +122,12 @@ module Stockboy
       end
     end
 
-    def expect_connection(host="localhost.test", user="a", pass="b")
-      net_ftp = Net::FTP.new
-      expect(Net::FTP).to receive(:open).with(host, user, pass).and_yield(net_ftp)
-      net_ftp
+    def expect_connection
+      adapter = instance_double(provider.adapter_class)
+      expect(adapter).to receive(:open).and_yield(adapter)
+
+      expect(provider.adapter_class).to receive(:new).with(provider).and_return adapter
+      adapter
     end
 
   end

data/spec/stockboy/providers/http_spec.rb

@@ -86,21 +86,21 @@ module Stockboy
         provider.uri = "http://example.com"
         provider.method = nil
         expect(provider).not_to be_valid
-        expect(provider.errors.first).to match /method/
+        expect(provider.errors.first).to include "method"
       end
 
       it "should not be valid without a uri" do
         provider.uri = ""
         provider.method = :get
         expect(provider).not_to be_valid
-        expect(provider.errors.first).to match /uri/
+        expect(provider.errors.first).to include "uri"
       end
 
       it "should require a body for post" do
         provider.uri = "http://example.com"
         provider.method = :post
         expect(provider).not_to be_valid
-        expect(provider.errors.first).to match /body/
+        expect(provider.errors.first).to include "body"
       end
     end
 
@@ -120,6 +120,7 @@ module Stockboy
 
     describe "#data" do
       let(:response)   { HTTPI::Response.new(200, {}, '{"success":true}') }
+      let(:not_found)  { HTTPI::Response.new(404, {}, '{"success":false}') }
 
       subject(:provider) do
         Providers::HTTP.new do |s|
@@ -135,6 +136,13 @@ module Stockboy
         expect(provider.data).to eq '{"success":true}'
       end
 
+      it "sets an error on failure" do
+        expect(HTTPI).to receive(:request) { not_found }
+
+        expect(provider.data).to be_nil
+        expect(provider.errors.first).to include "HTTP response error: 404"
+      end
+
       it "should setup basic auth if a username and password are supplied" do
         provider.username = "username"
         provider.password = "password"

data/spec/stockboy/providers/imap_spec.rb

@@ -154,7 +154,7 @@ module Stockboy
 
       it "should call delete on the message key" do
         allow(provider).to receive(:client).and_yield(imap)
-        allow(provider).to receive(:search) { [5] }
+        allow(provider).to receive(:find_messages).and_return([5])
 
         provider.message_key
 
@@ -184,9 +184,9 @@ module Stockboy
       end
 
       it "closes connections when catching exceptions" do
-        net_imap = expect_connection("hhh", "uuu", "ppp", "UNBOX")
+        expect_connection("hhh", "uuu", "ppp", "UNBOX")
         provider.client { |i| raise Net::IMAP::Error }
-        expect(provider.errors.first).to match /IMAP connection error/
+        expect(provider.errors.first).to include "IMAP connection error"
       end
 
     end

data/spec/stockboy/providers/soap_spec.rb

@@ -21,6 +21,22 @@ module Stockboy
       expect(provider.headers).to   eq({key: 'k'})
     end
 
+    describe "logging" do
+      before do
+        provider.wsdl = "http://api.example.com/?wsdl"
+      end
+
+      it "should be active on debug level" do
+        provider.logger.level = Logger::DEBUG
+        expect(provider.client.globals[:log]).to be true
+      end
+
+      it "should not be active on info level" do
+        provider.logger.level = Logger::INFO
+        expect(provider.client.globals[:log]).to be false
+      end
+    end
+
     describe ".new" do
       its(:errors) { should be_empty }
 
@@ -56,7 +72,7 @@ module Stockboy
       context "without a WSDL document" do
         it "has error for blank endpoint & WSDL namespace" do
           provider.valid?
-          expect(provider.errors.first).to match /endpoint/
+          expect(provider.errors.first).to include "endpoint"
         end
       end
     end

data/spec/stockboy/readers/fixed_width_spec.rb

@@ -48,5 +48,13 @@ module Stockboy
       expect(records.last[:age]).to eq '44'
     end
 
+    context "without specified headers" do
+      it "raises an error" do
+        reader = described_class.new
+
+        expect { reader.parse(data) }.to raise_error ArgumentError
+      end
+    end
+
   end
 end

data/spec/stockboy/readers/spreadsheet_spec.rb

@@ -18,13 +18,15 @@ module Stockboy
           format:  :xlsx,
           sheet:   'Sheet 42',
           header_row: 5,
-          headers: %w(X Y Z)
+          headers: %w(X Y Z),
+          options: {packed: :zip}
         )
 
         expect(reader.format).to eq :xlsx
         expect(reader.sheet).to  eq 'Sheet 42'
         expect(reader.header_row).to eq 5
         expect(reader.headers).to eq %w(X Y Z)
+        expect(reader.options).to eq({packed: :zip})
       end
 
       it "configures with a block" do
@@ -33,12 +35,14 @@ module Stockboy
           sheet 'Sheet 42'
           header_row 5
           headers %w(X Y Z)
+          options({packed: :zip})
         end
 
         expect(reader.format).to eq :xlsx
         expect(reader.sheet).to  eq 'Sheet 42'
         expect(reader.header_row).to eq 5
         expect(reader.headers).to eq %w(X Y Z)
+        expect(reader.options).to eq({packed: :zip})
       end
     end
 
@@ -48,12 +52,31 @@ module Stockboy
       context "with an XLS file" do
         let(:fixture_file) { 'spreadsheets/test_data.xls' }
 
-        it "returns an array of hashes" do
+        it "uses line 1 for header names and line 2 for first row by default" do
           reader = described_class.new(format: :xls)
           data = reader.parse(content)
 
-          expect(data).not_to be_empty
-          data.each { |i| expect(i).to be_a Hash }
+          expect(data.first).to eq({"Name" => "Arthur Dent", "Age" => 42})
+          expect(data.last).to eq({"Name" => "Marvin", "Age" => 9999999})
+        end
+
+        it "Uses line 1 for first data row if headers are given" do
+          reader = described_class.new(format: :xls, headers: ["id", "years"])
+          data = reader.parse(content)
+
+          expect(data.first).to eq({"id" => "Name", "years" => "Age"})
+          expect(data.last).to eq({"id" => "Marvin", "years" => 9999999})
+        end
+      end
+
+      context "underlying gem other options" do
+        let(:fixture_file) { 'spreadsheets/test_data.xls.zip' }
+
+        it "are passed to underlying library" do
+          reader = described_class.new(format: :xls, options: {packed: :zip, file_warning: :ignore})
+
+          data = reader.parse(content)
+          expect(data).to be_an Array
         end
       end
 
@@ -81,39 +104,50 @@ module Stockboy
           expect(data.last.values).to eq ["Ford", 40]
         end
       end
-    end
 
-    describe "#sheet", skip: "Hard to test this due to roo. Needs a test case with fixtures" do
-      let(:sheets)      { ['Towels', 'Lemons'] }
-      let(:be_selected) { receive(:default_sheet=) }
-      let(:spreadsheet) { double(:spreadsheet, sheets: sheets) }
-      before { allow(subject).to receive(:with_spreadsheet).and_yield(spreadsheet) }
+      context "with non-first header row" do
+        let(:fixture_file) { 'spreadsheets/test_row_options.xls' }
 
-      context "with :first" do
-        before { expect(spreadsheet).to be_selected.with('Towels') }
+        it "can use a different header_row" do
+          reader = described_class.new(format: :xls, header_row: 4)
+          data = reader.parse(content)
 
-        it "calls on first sheet by name" do
-          subject.sheet = :first
-          subject.parse ""
+          expect(data.first).to eq({"Name" => nil, "Age" => nil})
         end
-      end
 
-      context "with a string" do
-        before { expect(spreadsheet).to be_selected.with('Towels') }
+        it "can set both header_row and first_row" do
+          reader = described_class.new(format: :xls, header_row: 4, first_row: 6)
+          data = reader.parse(content)
 
-        it "passes unchanged" do
-          subject.sheet = 'Towels'
-          subject.parse ""
+          expect(data.first).to eq({"Name" => "Arthur Dent", "Age" => 42})
         end
       end
+    end
 
-      context "with an integer" do
-        before { expect(spreadsheet).to be_selected.with('Towels') }
+    describe "#sheet" do
+      let(:reader) { described_class.new(format: :xls) }
+      let(:fixture_file) { 'spreadsheets/test_data_sheets.xls' }
+      let(:content) { File.read(fixture_path fixture_file) }
 
-        it "gets sheet name" do
-          subject.sheet = 1
-          subject.parse ""
-        end
+      it "can specify :last sheet" do
+        reader = described_class.new(format: :xls, sheet: :last)
+        data = reader.parse content
+
+        expect(data.first.values).to eq(["Earth", "Mostly Harmless"])
+      end
+
+      it "can specify sheet by name" do
+        reader = described_class.new(format: :xls, sheet: 'Planets')
+        data = reader.parse content
+
+        expect(data.first.values).to eq(["Earth", "Mostly Harmless"])
+      end
+
+      it "can specify sheet by number" do
+        reader = described_class.new(format: :xls, sheet: 2)
+        data = reader.parse content
+
+        expect(data.first.values).to eq(["Earth", "Mostly Harmless"])
       end
     end
 

data/stockboy.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "httpi"
   s.add_runtime_dependency "mail"
   s.add_runtime_dependency "activesupport", ">= 3.0"
+  s.add_runtime_dependency "net-sftp"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockboy
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrew Vit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Supports importing data over various transports with key-value remapping
   & normalization
 email:
@@ -173,6 +187,8 @@ files:
 - lib/stockboy/providers.rb
 - lib/stockboy/providers/file.rb
 - lib/stockboy/providers/ftp.rb
+- lib/stockboy/providers/ftp/ftp_adapter.rb
+- lib/stockboy/providers/ftp/sftp_adapter.rb
 - lib/stockboy/providers/http.rb
 - lib/stockboy/providers/imap.rb
 - lib/stockboy/providers/imap/search_options.rb
@@ -215,6 +231,8 @@ files:
 - spec/fixtures/soap/get_list/fault.xml
 - spec/fixtures/soap/get_list/success.xml
 - spec/fixtures/spreadsheets/test_data.xls
+- spec/fixtures/spreadsheets/test_data.xls.zip
+- spec/fixtures/spreadsheets/test_data_sheets.xls
 - spec/fixtures/spreadsheets/test_row_options.xls
 - spec/fixtures/xml/body.xml
 - spec/spec_helper.rb
@@ -284,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: stockboy
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: Multi-source data normalization library
@@ -299,6 +317,8 @@ test_files:
 - spec/fixtures/soap/get_list/fault.xml
 - spec/fixtures/soap/get_list/success.xml
 - spec/fixtures/spreadsheets/test_data.xls
+- spec/fixtures/spreadsheets/test_data.xls.zip
+- spec/fixtures/spreadsheets/test_data_sheets.xls
 - spec/fixtures/spreadsheets/test_row_options.xls
 - spec/fixtures/xml/body.xml
 - spec/spec_helper.rb
@@ -347,4 +367,3 @@ test_files:
 - spec/stockboy/translations/us_date_spec.rb
 - spec/stockboy/translations_spec.rb
 - spec/stockboy/translator_spec.rb
-has_rdoc: false