stockboy 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b36c08f870f1306e9c36cb125438bf8e01b3e6dc
-  data.tar.gz: e997f70d91635b9456ed6c0758e981ea7f2e16ed
+  metadata.gz: 05fab717904ef1e81b3395c5e9bd55868304794b
+  data.tar.gz: 65fcee4af9cb07edac6349a5e0c6c11bf22b6013
 SHA512:
-  metadata.gz: 0a129da6b911fa8812706140192419782ce1e09e5ea26bc8a161dcf1006a918ff7ab6cbd94a94e1b6f4c279d9d092146e87386b5dd64a837980a03ba2682e48a
-  data.tar.gz: e5fd24fb0698cfb2d8488f35587ea49b0ac2d7bc0d39422a17fd5218a0974429fb1baf214e5f00f5295ec4ba309dade51e5a9a1d2b9048e5a9b0db6a51e19773
+  metadata.gz: a430d46d3e5e422d723f8b1dd236257e4d61043cdb417e418706d24484260cbd0725e16d72ac20435d9feb1e140fbf9513cf26cc84af57d85080a369a50701df
+  data.tar.gz: caed313e0d31f77265ad1f6823f67309b6e8388cded3473289aa2eee51ef245a6cdecb25b44ce8b63bf98ebf9545ac6f0758fe0b81c9880bd249ae3c39883b3c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.3.1 / 2017-11-07
+
+* [ENHANCEMENT] Expose both raw FTP commands or generic adapter commands
+
 ## 1.3.0 / 2017-10-26
 
 * [FEATURE]     Add `secure` option for FTP to use SFTP

data/lib/stockboy/providers/ftp.rb

@@ -110,21 +110,21 @@ module Stockboy::Providers
       @file_larger  = opts[:file_larger]
       @pick         = opts[:pick] || :last
       DSL.new(self).instance_eval(&block) if block_given?
-      @open_client  = nil
+      @open_adapter  = nil
     end
 
     def adapter_class
       secure ? SFTPAdapter : FTPAdapter
     end
 
-    def client
-      return yield @open_client if @open_client
+    def adapter
+      return yield @open_adapter if @open_adapter
 
       adapter_class.new(self).open do |ftp|
-        @open_client = ftp
+        @open_adapter = ftp
         ftp.chdir file_dir if file_dir
         response = yield ftp
-        @open_client = nil
+        @open_adapter = nil
         response
       end
 
@@ -134,9 +134,13 @@ module Stockboy::Providers
       nil
     end
 
+    def client
+      adapter { |ftp| yield ftp.client }
+    end
+
     def matching_file
       return @matching_file if @matching_file
-      client do |ftp|
+      adapter do |ftp|
         file_listing = ftp.list_files
         @matching_file = pick_from file_listing.select(&file_name_matcher)
       end
@@ -144,7 +148,7 @@ module Stockboy::Providers
 
     def delete_data
       raise Stockboy::OutOfSequence, "must confirm #matching_file or calling #data" unless picked_matching_file?
-      client do |ftp|
+      adapter do |ftp|
         logger.info "FTP deleting file #{host} #{file_dir}/#{matching_file}"
         ftp.delete matching_file
         matching_file
@@ -161,7 +165,7 @@ module Stockboy::Providers
     private
 
     def fetch_data
-      client do |ftp|
+      adapter do |ftp|
         validate_file(matching_file)
         if valid?
           logger.debug "FTP getting file #{inspect_matching_file}"
@@ -199,21 +203,21 @@ module Stockboy::Providers
     end
 
     def validate_file_newer(data_file)
-      @data_time ||= client { |ftp| ftp.modification_time(data_file) }
+      @data_time ||= adapter { |ftp| ftp.modification_time(data_file) }
       if file_newer and @data_time < file_newer
         errors << "No new files since #{file_newer}"
       end
     end
 
     def validate_file_smaller(data_file)
-      @data_size ||= client { |ftp| ftp.size(data_file) }
+      @data_size ||= adapter { |ftp| ftp.size(data_file) }
       if file_smaller and @data_size > file_smaller
         errors << "File size larger than #{file_smaller}"
       end
     end
 
     def validate_file_larger(data_file)
-      @data_size ||= client { |ftp| ftp.size(data_file) }
+      @data_size ||= adapter { |ftp| ftp.size(data_file) }
       if file_larger and @data_size < file_larger
         errors << "File size smaller than #{file_larger}"
       end

data/lib/stockboy/providers/ftp/sftp_adapter.rb

@@ -34,10 +34,6 @@ module Stockboy::Providers
       client.download!(full_path(file_name))
     end
 
-    def full_path(file_name)
-      ::File.join(@file_dir, file_name)
-    end
-
     def modification_time(file_name)
       stat(file_name).mtime
     end
@@ -46,6 +42,12 @@ module Stockboy::Providers
       stat(file_name).size
     end
 
+    private
+
+    def full_path(file_name)
+      ::File.join(@file_dir, file_name)
+    end
+
     def stat(file_name)
       client.file.open(full_path(file_name)).stat
     end

data/lib/stockboy/version.rb

@@ -1,3 +1,3 @@
 module Stockboy
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end

data/spec/stockboy/providers/ftp_spec.rb

@@ -41,9 +41,63 @@ module Stockboy
       end
     end
 
+    describe "#adapter" do
+      it "should return yielded result" do
+        stub_adapter
+
+        result = provider.adapter { |_| "a_file_name.csv" }
+
+        expect(result).to eq "a_file_name.csv"
+      end
+
+      context "with default secure (false)" do
+        it "yields an FTP adapter" do
+          net_ftp = expect_ftp_connection
+
+          provider.adapter do |ftp|
+            expect(ftp.client).to be net_ftp
+          end
+        end
+
+        it "catches FTP errors" do
+          expect_ftp_connection
+
+          provider.adapter do |ftp|
+            raise Net::FTPError, "not really gopher"
+          end
+
+          expect(provider.errors).to include "not really gopher"
+        end
+      end
+
+      context "with secure" do
+        before do
+          provider.secure = true
+        end
+
+        it "yields an SFTP adapter" do
+          net_sftp = expect_sftp_connection
+
+          provider.adapter do |ftp|
+            expect(ftp.client).to be net_sftp
+          end
+        end
+
+        it "catches SFTP errors" do
+          expect_sftp_connection
+
+          provider.adapter do |ftp|
+            raise Net::SFTP::Exception, "still not gopher"
+          end
+
+          expect(provider.errors).to include "still not gopher"
+        end
+      end
+    end
+
     describe "#client" do
       it "should return yielded result" do
-        expect_connection
+        expect_ftp_connection
 
         result = provider.client { |_| "a_file_name.csv" }
 
@@ -67,20 +121,20 @@ module Stockboy
       end
 
       it "downloads the last matching file" do
-        net_ftp = expect_connection
-        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"
+        adapter = stub_adapter
+        expect(adapter).to receive(:list_files).and_return ['20120101.csv', '20120102.csv']
+        expect(adapter).to receive(:download).with('20120102.csv').and_return "DATA"
         expect(provider).to receive(:validate_file).and_return true
 
         expect(provider.data).to eq "DATA"
       end
 
       it "skips old files" do
-        net_ftp = expect_connection
-        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)
+        adapter = stub_adapter
+        expect(adapter).to receive(:list_files).and_return ['20120101.csv', '20120102.csv']
+        expect(adapter).to receive(:modification_time).with('20120102.csv').and_return(Time.new(2009,01,01))
+        expect(adapter).to receive(:size).with('20120102.csv').and_return(Time.new(2009,01,01))
+        expect(adapter).to_not receive(:download)
 
         provider.file_newer = Time.new(2010,1,1)
         expect(provider.data).to be nil
@@ -89,13 +143,13 @@ module Stockboy
 
     describe "#matching_file" do
       it "does not change until cleared" do
-        net_ftp = expect_connection
-        expect(net_ftp).to receive(:list_files).and_return ["1.csv", "2.csv"]
+        adapter = stub_adapter
+        expect(adapter).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(:list_files).and_return ["1.csv", "2.csv", "3.csv"]
+        adapter = stub_adapter
+        expect(adapter).to receive(:list_files).and_return ["1.csv", "2.csv", "3.csv"]
 
         expect(provider.matching_file).to eq "2.csv"
         provider.clear
@@ -110,25 +164,37 @@ module Stockboy
       end
 
       it "should delete the matching file" do
-        net_ftp = expect_connection
-        expect(net_ftp).to receive(:list_files).and_return ["1.csv", "2.csv"]
+        adapter = stub_adapter
+        expect(adapter).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(:delete).with("2.csv")
+        adapter = stub_adapter
+        expect(adapter).to receive(:delete).with("2.csv")
 
         expect(provider.delete_data).to eq "2.csv"
       end
     end
 
-    def expect_connection
-      adapter = instance_double(provider.adapter_class)
+    def stub_adapter
+      adapter = instance_double(provider.adapter_class, client: nil)
       expect(adapter).to receive(:open).and_yield(adapter)
 
       expect(provider.adapter_class).to receive(:new).with(provider).and_return adapter
       adapter
     end
 
+    def expect_ftp_connection
+      connection = instance_double(Net::FTP, "binary=" => nil, "passive=" => nil)
+      expect(Net::FTP).to receive(:open).and_yield(connection)
+      connection
+    end
+
+    def expect_sftp_connection
+      connection = instance_double(Net::SFTP)
+      expect(Net::SFTP).to receive(:start).and_yield(connection)
+      connection
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockboy
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Andrew Vit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake