Spec files', multiparts' #to_h and transfers' #to_h and #to_json

Author: arnoFleming

lib/we_transfer/remote_file.rb

@@ -3,13 +3,7 @@ module RemoteFile
     class FileMismatchError < StandardError; end
     class NoIoError < StandardError; end
 
-    class Multipart < ::Ks.strict(:chunks, :chunk_size)
-      def to_h
-        %i[chunks chunk_size].each_with_object({}) do |prop, memo|
-          memo[prop] = send(prop)
-        end
-      end
-    end
+    class Multipart < ::Ks.strict(:chunks, :chunk_size); end
 
     def self.upgrade(files_response:, transfer:)
       files_response.each do |file_response|

spec/we_transfer/communication_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe WeTransfer::Communication do
+  before { described_class.logger = Logger.new(nil) }
+
+  # In this test we use the call to #find_transfer. This is NOT exemplary, it serves only
+  # the purpose of doing a request/response cycle to handle specific status codes (2xx, 4xx, 50x)
+  context ".ensure_ok_status!" do
+
+    let!(:authentication_stub) {
+      stub_request(:post, "#{WeTransfer::Communication::API_URL_BASE}/v2/authorize")
+      .to_return(status: 200, body: {token: "fake-test-token"}.to_json, headers: {})
+    }
+
+    context "on a successful request" do
+      let!(:find_transfer_stub) do
+        stub_request(:get, "#{WeTransfer::Communication::API_URL_BASE}/v2/transfers/fake-transfer-id").
+        to_return(
+          status: 200,
+          body: {
+            id: "24cd3f4ccf15232e5660052a3688c03f20190221200022",
+            state: "uploading",
+            message: "test transfer",
+            url: nil,
+            files: [
+              {
+                id: "fake_file_id",
+                name: "test file",
+                size: 8,
+                multipart: {
+                  part_numbers: 1,
+                  chunk_size: 8
+                },
+                type: "file",
+              }
+            ],
+            expires_at: "2019-02-28T20:00:22Z",
+          }.to_json,
+          headers: {},
+        )
+      end
+
+      it "does not raise a CommunicationError" do
+        expect { described_class.find_transfer('fake-transfer-id') }
+        .to_not raise_error(WeTransfer::CommunicationError)
+      end
+    end
+
+    context "on a client error" do
+      let!(:find_transfer_stub) do
+        stub_request(:get, "#{WeTransfer::Communication::API_URL_BASE}/v2/transfers/fake-transfer-id").
+        to_return(
+          status: 405,
+          body: '{
+            "success":false,
+            "message":"fake message"
+          }',
+          headers: {},
+        )
+      end
+
+      it "raises a CommunicationError" do
+        expect { described_class.find_transfer('fake-transfer-id') }
+        .to raise_error(WeTransfer::CommunicationError)
+      end
+
+      it "showing the error from the API to the user" do
+        expect { described_class.find_transfer('fake-transfer-id') }
+        .to raise_error('fake message')
+      end
+    end
+
+    context "on a server error" do
+      let!(:find_transfer_stub) do
+        stub_request(:get, "#{WeTransfer::Communication::API_URL_BASE}/v2/transfers/fake-transfer-id").
+        to_return(
+          status: 501,
+          body: '',
+          headers: {},
+        )
+      end
+
+      it "raises a CommunicationError" do
+        expect { described_class.find_transfer('fake-transfer-id') }
+        .to raise_error(WeTransfer::CommunicationError)
+      end
+
+      it "is telling we can try again" do
+        expect { described_class.find_transfer('fake-transfer-id') }
+          .to raise_error(%r|had a 501 code.*could retry|)
+      end
+
+      context "everything else" do
+        let(:find_transfer_stub) do
+          stub_request(:get, "#{WeTransfer::Communication::API_URL_BASE}/v2/transfers/fake-transfer-id").
+          to_return(
+            status: 302,
+            body: '',
+            headers: {},
+          )
+        end
+
+        it "raises a CommunicationError" do
+          expect { described_class.find_transfer('fake-transfer-id') }
+            .to raise_error(WeTransfer::CommunicationError)
+        end
+
+        it "includes the error code in the message" do
+          expect { described_class.find_transfer('fake-transfer-id') }
+            .to raise_error(%r|had a 302 code|)
+        end
+
+        it "informs the user we have no way how to continue" do
+          expect { described_class.find_transfer('fake-transfer-id') }
+            .to raise_error(%r|no idea what to do with that|)
+        end
+      end
+    end
+  end
+end

spec/we_transfer/transfer_spec.rb

@@ -492,4 +492,73 @@
 
     it "url?"
   end
+
+  describe "#to_h" do
+    let(:transfer) { described_class.new(message: 'test transfer') }
+    let(:file_stub_1) { [instance_double(WeTransfer::WeTransferFile, name: 'foo', size: 8)] }
+
+    it "has keys and values for id, state, url, message and files" do
+      allow(file_stub_1)
+        .to receive(:to_h)
+        .and_return('fake-file-to_h')
+
+      allow(transfer)
+        .to receive(:files)
+        .and_return([file_stub_1])
+
+      allow(transfer)
+        .to receive(:id)
+        .and_return('fake-id')
+
+      allow(transfer)
+        .to receive(:state)
+        .and_return('fake-state')
+
+      allow(transfer)
+        .to receive(:url)
+        .and_return('fake-url')
+
+      expected = {
+        id: "fake-id",
+        state: "fake-state",
+        url: "fake-url",
+        message: "test transfer",
+        files: ["fake-file-to_h"]
+      }
+
+      expect(transfer.to_h)
+        .to match(expected)
+    end
+
+    it "calls :to_h on all files" do
+      file_stub_2 = instance_double(WeTransfer::WeTransferFile, name: 'bar', size: 8)
+
+      allow(transfer)
+        .to receive(:files)
+        .and_return([file_stub_1, file_stub_2])
+
+      expect(file_stub_1)
+        .to receive(:to_h)
+
+      expect(file_stub_2)
+        .to receive(:to_h)
+
+      transfer.to_h
+    end
+  end
+
+  describe "#to_json" do
+    it "converts the results of #to_h" do
+      transfer = described_class.new(message: 'test transfer')
+
+      transfer_hash = { "foo" => "bar" }
+
+      allow(transfer)
+        .to receive(:to_h)
+        .and_return(transfer_hash)
+
+      expect(JSON.parse(transfer.to_json))
+        .to eq(transfer_hash)
+    end
+  end
 end

spec/we_transfer/we_transfer_file_spec.rb

@@ -59,4 +59,45 @@
         .to eq %|{"name":"test file","size":8}|
     end
   end
+
+  describe "#to_h" do
+    let(:file) { described_class.new(name: 'foo', size: 8) }
+    let(:multipart_stub) { instance_double(WeTransfer::RemoteFile::Multipart) }
+
+    it "has keys and values for id, name, size and multipart" do
+      allow(file)
+        .to receive(:multipart)
+        .and_return(multipart_stub)
+
+      allow(file)
+        .to receive(:id)
+        .and_return('fake-id')
+
+      allow(multipart_stub)
+        .to receive(:to_h)
+        .and_return('fake-multipart')
+
+      expected = {
+        id: 'fake-id',
+        multipart: 'fake-multipart',
+        size: 8,
+        name: 'foo'
+
+      }
+
+      expect(file.to_h)
+        .to match(expected)
+    end
+
+    it "calls :to_h on multipart" do
+      allow(file)
+        .to receive(:multipart)
+        .and_return(multipart_stub)
+
+      expect(multipart_stub)
+        .to receive(:to_h)
+
+      file.to_h
+    end
+  end
 end