Simpler interface

Move communication to CommunicationHelper class

Author: arnoFleming

lib/we_transfer/communication_helper.rb

@@ -2,49 +2,128 @@ module WeTransfer
   class CommunicationError < StandardError; end
 
   module CommunicationHelper
+    extend Forwardable
+
     API_URL_BASE = "https://dev.wetransfer.com"
     DEFAULT_HEADERS = {
       "User-Agent" => "WetransferRubySdk/#{WeTransfer::VERSION} Ruby #{RUBY_VERSION}",
       "Content-Type" => "application/json"
     }.freeze
 
     class << self
-      attr_accessor :logger, :api_key
+      attr_accessor :logger, :api_key, :bearer_token
     end
 
-    def logger
-      @logger ||= CommunicationHelper.logger
+    def_delegator self, :minimal_faraday_config
+
+    def self.reset_authentication!
+      @api_key = nil
+      @bearer_token = nil
+      @request_as = nil
     end
 
-    def api_key
-      @api_key ||= CommunicationHelper.api_key
+    def self.find_transfer(transfer_id)
+      response = request_as.get("/v2/transfers/%s" % [transfer_id])
+      ensure_ok_status!(response)
+      response_body = remote_transfer_params(response.body)
+      found_transfer = Transfer.new(message: response_body[:message])
+      setup_transfer(
+        transfer: found_transfer,
+        data: response_body
+      )
     end
 
-    def request_as
-      authorize_if_no_bearer_token!
+    def self.upload_url_for_chunk(transfer_id, file_id, chunk)
+      response = request_as.get("/v2/transfers/%s/files/%s/upload-url/%s" % [transfer_id, file_id, chunk])
+      ensure_ok_status!(response)
+
+      JSON.parse(response.body).fetch("url")
+    end
+
+    def self.persist_transfer(transfer)
+      response = request_as.post(
+        "/v2/transfers",
+        transfer.as_request_params.to_json,
+      )
+      ensure_ok_status!(response)
+
+      handle_new_transfer_data(
+        transfer: transfer,
+        data: remote_transfer_params(response.body)
+      )
+    end
+
+    def self.finalize_transfer(transfer)
+      response = request_as.put("/v2/transfers/%s/finalize" % transfer.id)
+      ensure_ok_status!(response)
+      handle_new_transfer_data(
+        transfer: transfer,
+        data: remote_transfer_params(response.body)
+      )
+    end
+
+    def self.remote_transfer_params(response_body)
+      JSON.parse(response_body, symbolize_names: true)
+    end
+
+    def self.upload_chunk(put_url, chunk_contents)
+      @chunk_uploader ||= Faraday.new { |c| minimal_faraday_config(c) }
+
+      @chunk_uploader.put(
+        put_url,
+        chunk_contents.read,
+        'Content-Type' => 'binary/octet-stream',
+        'Content-Length' => chunk_contents.size.to_s
+      )
+    end
+
+    def self.complete_file(transfer_id, file_id, chunks)
+      response = request_as.put(
+        "/v2/transfers/%s/files/%s/upload-complete" % [transfer_id, file_id],
+        { part_numbers: chunks }.to_json
+      )
 
+      ensure_ok_status!(response)
+      remote_transfer_params(response.body)
+    end
+
+    private_class_method def self.request_as
       @request_as ||= Faraday.new(API_URL_BASE) do |c|
         minimal_faraday_config(c)
         c.headers = auth_headers.merge DEFAULT_HEADERS
       end
     end
 
-    def upload_chunk
-      @upload_chunk ||= Faraday.new { |c| minimal_faraday_config(c) }
+    private_class_method def self.setup_transfer(transfer:, data:)
+      data[:files].each do |file_params|
+        transfer.add_file(
+          name: file_params[:name],
+          size: file_params[:size],
+        )
+      end
+
+      handle_new_transfer_data(transfer: transfer, data: data)
     end
 
-    private
+    private_class_method def self.handle_new_transfer_data(transfer:, data:)
+      %i[id state url].each do |i_var|
+        transfer.instance_variable_set "@#{i_var}", data[i_var]
+      end
+
+      RemoteFile.upgrade(files: transfer.files, files_response: data[:files])
+      transfer
+    end
 
-    def auth_headers
+    private_class_method def self.auth_headers
       authorize_if_no_bearer_token!
 
       {
         'X-API-Key' => api_key,
-        'Authorization' => "Bearer #{@bearer_token}",
-      }.freeze
+        'Authorization' => "Bearer #{@bearer_token}"
+      }
     end
 
-    def ensure_ok_status!(response)
+    private_class_method def self.ensure_ok_status!(response)
       case response.status
       when 200..299
         true
@@ -60,7 +139,7 @@ def ensure_ok_status!(response)
       end
     end
 
-    def authorize_if_no_bearer_token!
+    private_class_method def self.authorize_if_no_bearer_token!
       return @bearer_token if @bearer_token
 
       response = Faraday.new(API_URL_BASE) do |c|
@@ -75,7 +154,7 @@ def authorize_if_no_bearer_token!
       @bearer_token = bearer_token
     end
 
-    def minimal_faraday_config(config)
+    private_class_method def self.minimal_faraday_config(config)
       config.response :logger, logger
       config.adapter Faraday.default_adapter
     end

lib/we_transfer/remote_transfer.rb

@@ -3,32 +3,21 @@ class Transfer
     class DuplicateFileNameError < ArgumentError; end
     class NoFilesAddedError < StandardError; end
 
-    include CommunicationHelper
-    extend CommunicationHelper
     extend Forwardable
 
     attr_reader :files, :id, :state, :url
 
+    class << self
+      extend Forwardable
+      def_delegator CommunicationHelper, :find_transfer, :find
+    end
+
     def self.create(message:, &block)
       transfer = new(message: message)
 
       transfer.persist(&block)
     end
 
-    def self.find(transfer_id)
-      response = request_as.get("/v2/transfers/%s" % [transfer_id])
-      ensure_ok_status!(response)
-      response_body = remote_transfer_params(response.body)
-      found_transfer = new(message: response_body[:message])
-      @remote_transfer = RemoteTransfer.setup(
-        transfer: found_transfer, response_body: response_body
-      )
-    end
-
-    def self.remote_transfer_params(response_body)
-      JSON.parse(response_body, symbolize_names: true)
-    end
-
     def initialize(message:)
       @message = message
       @files = []
@@ -39,15 +28,7 @@ def persist
       yield(self) if block_given?
       raise NoFilesAddedError if @unique_file_names.empty?
 
-      response = request_as.post(
-        "/v2/transfers",
-        as_request_params.to_json,
-      )
-      ensure_ok_status!(response)
-
-      response_body = remote_transfer_params(response.body)
-      RemoteTransfer.upgrade(transfer: self, response_body: response_body)
-      # create_remote_transfer
+      CommunicationHelper.persist_transfer(self)
     end
 
     # Add one or more files to a transfer, so a transfer can be created over the
@@ -67,52 +48,40 @@ def add_file(**args)
     def upload_file(name:, io: nil)
       file = find_file_by_name(name)
       put_io = io || file.io
-      raise WeTransfer::RemoteFile::NoIoError, "File with name '#{name}' cannot be uploaded." unless WeTransfer::MiniIO.mini_io_able?(put_io)
 
-      put_io = io || file.io
-      put_io.rewind
+      raise(
+        WeTransfer::RemoteFile::NoIoError,
+        "File with name '#{name}' cannot be uploaded."
+      ) unless WeTransfer::MiniIO.mini_io_able?(put_io)
 
       (1..file.multipart.chunks).each do |chunk|
         put_url = upload_url_for_chunk(name: name, chunk: chunk)
         chunk_contents = StringIO.new(put_io.read(file.multipart.chunk_size))
         chunk_contents.rewind
 
-        upload_chunk.put(
-          put_url,
-          chunk_contents.read,
-          'Content-Type' => 'binary/octet-stream',
-          'Content-Length' => chunk_contents.size.to_s
-        )
+        CommunicationHelper.upload_chunk(put_url, chunk_contents)
       end
     end
 
     def upload_url_for_chunk(name:, chunk:)
       file_id = find_file_by_name(name).id
-      response = request_as.get("/v2/transfers/%s/files/%s/upload-url/%s" % [id, file_id, chunk])
-      ensure_ok_status!(response)
-
-      JSON.parse(response.body).fetch("url")
+      CommunicationHelper.upload_url_for_chunk(id, file_id, chunk)
     end
 
     def complete_file(name:)
       file = find_file_by_name(name)
-      body = { part_numbers: file.multipart.chunks }.to_json
-      response = request_as.put(
-        "/v2/transfers/%s/files/%s/upload-complete" % [id, file.id],
-        body
-      )
-
-      ensure_ok_status!(response)
-      remote_transfer_params(response.body)
+      CommunicationHelper.complete_file(id, file.id, file.multipart.chunks)
     end
 
     def finalize
-      response = request_as.put("/v2/transfers/%s/finalize" % id)
-      ensure_ok_status!(response)
-      RemoteTransfer.upgrade(
-        transfer: self,
-        response_body: remote_transfer_params(response.body)
-      )
+      CommunicationHelper.finalize_transfer(self)
+    end
+
+    def as_request_params
+      {
+        message: @message,
+        files: @files.map(&:as_request_params),
+      }
     end
 
     private
@@ -125,12 +94,5 @@ def find_file_by_name(name)
       end
       @found_files[name]
     end
-
-    def as_request_params
-      {
-        message: @message,
-        files: @files.map(&:as_request_params),
-      }
-    end
   end
 end

lib/we_transfer/transfer.rb

@@ -1,3 +1,3 @@
 module WeTransfer
-  VERSION = '0.10.0.alpha1'
+  VERSION = '0.9.0.beta2'
 end

lib/we_transfer/version.rb

@@ -5,7 +5,7 @@
 require 'json'
 require 'ks'
 
-%w[communication_helper transfer mini_io we_transfer_file remote_transfer remote_file version].each do |file|
+%w[communication_helper transfer mini_io we_transfer_file remote_file version].each do |file|
   require_relative "we_transfer/#{file}"
 end
 
@@ -25,6 +25,7 @@ class Error < StandardError; end
     #
     # @return [WeTransfer::Client]
     def initialize(api_key:, logger: NullLogger)
+      CommunicationHelper.reset_authentication!
       CommunicationHelper.api_key = api_key
       CommunicationHelper.logger = logger
     end

lib/we_transfer_client.rb

@@ -7,7 +7,7 @@
     WebMock.disable_net_connect!
   end
 
-  it "works"   do
+  it "works" do
     client = WeTransfer::Client.new(api_key: ENV.fetch("WT_API_KEY"))
 
     client.create_transfer(message: "test transfer") do |transfer|

spec/features/client_creates_a_transfer_spec.rb

@@ -1,13 +1,10 @@
 require 'spec_helper'
 
-class CommHelper
-  include WeTransfer::CommunicationHelper
-  public :ensure_ok_status!
-end
-
 describe WeTransfer::CommunicationHelper do
-  context "#ensure_ok_status!" do
-    subject { CommHelper.new }
+  context ".ensure_ok_status!" do
+    subject { described_class }
+
+    before { pending }
 
     before(:all) do
       Response = Struct.new(:status, :body)