Add async result; refactor Task param handling

Author: danhorst

lib/convert_api.rb

@@ -5,6 +5,7 @@
 require 'convert_api/errors'
 require 'convert_api/result'
 require 'convert_api/result_file'
+require 'convert_api/async_result'
 require 'convert_api/upload_io'
 require 'convert_api/file_param'
 require 'convert_api/format_detector'

lib/convert_api/async_result.rb

@@ -0,0 +1,13 @@
+module ConvertApi
+  class AsyncResult
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def job_id
+      response['JobId']
+    end
+  end
+end

lib/convert_api/task.rb

@@ -3,33 +3,38 @@ class Task
     def initialize(from_format, to_format, params, conversion_timeout: nil)
       @from_format = from_format
       @to_format = to_format
-      @params = params
       @conversion_timeout = conversion_timeout || config.conversion_timeout
-    end
-
-    def run
-      params = normalize_params(@params).merge(
+      @params = normalize_params(params).merge(
         Timeout: @conversion_timeout,
         StoreFile: true,
       )
+      @async = @params.delete(:Async)
+    end
 
+    def run
       read_timeout = @conversion_timeout + config.conversion_timeout_delta if @conversion_timeout
 
       response = ConvertApi.client.post(
-        request_path(params),
-        params,
+        request_path,
+        @params,
         read_timeout: read_timeout,
       )
 
+      return AsyncResult.new(response) if async?
+
       Result.new(response)
     end
 
     private
 
-    def request_path(params)
-      from_format = @from_format || detect_format(params)
-      converter = params[:converter] ? "/converter/#{params[:converter]}" : ''
-      async = params[:Async] ? 'async/' : ''
+    def async?
+      @async.to_s.downcase == 'true'
+    end
+
+    def request_path
+      from_format = @from_format || detect_format
+      converter = @params[:converter] ? "/converter/#{@params[:converter]}" : ''
+      async = async? ? 'async/' : ''
 
       "#{async}convert/#{from_format}/to/#{@to_format}#{converter}"
     end
@@ -67,10 +72,10 @@ def files_batch(values)
       files
     end
 
-    def detect_format(params)
-      return DEFAULT_URL_FORMAT if params[:Url]
+    def detect_format
+      return DEFAULT_URL_FORMAT if @params[:Url]
 
-      resource = params[:File] || Array(params[:Files]).first
+      resource = @params[:File] || Array(@params[:Files]).first
 
       FormatDetector.new(resource, @to_format).run
     end

spec/convert_api/task_spec.rb

@@ -9,23 +9,51 @@
 
     let(:result) { double }
 
-    it 'executes task and returns result' do
-      expect(ConvertApi.client).to(
-        receive(:post).with('convert/txt/to/pdf', instance_of(Hash), instance_of(Hash)).and_return(result)
-      )
+    shared_examples 'successful task' do
+      it 'executes task and returns result' do
+        expect(ConvertApi.client).to(
+          receive(:post).with('convert/txt/to/pdf', instance_of(Hash), instance_of(Hash)).and_return(result)
+        )
 
-      expect(subject).to be_instance_of(ConvertApi::Result)
+        expect(subject).to be_instance_of(ConvertApi::Result)
+      end
     end
 
+    it_behaves_like 'successful task'
+
     describe 'async' do
-      let(:params) { { Async: true, File: 'https://www.w3.org/TR/2003/REC-PNG-20031110/iso_8859-1.txt' } }
+      shared_examples 'successful async task' do
+        it 'submits an async task and returns result' do
+          expect(ConvertApi.client).to(
+            receive(:post).with('async/convert/txt/to/pdf', instance_of(Hash), instance_of(Hash)).and_return(result)
+          )
 
-      it 'submits an async task and returns result' do
-        expect(ConvertApi.client).to(
-          receive(:post).with('async/convert/txt/to/pdf', instance_of(Hash), instance_of(Hash)).and_return(result)
-        )
+          expect(subject).to be_instance_of(ConvertApi::AsyncResult)
+        end
+      end
 
-        expect(subject).to be_instance_of(ConvertApi::Result)
+      context 'Async: false' do
+        let(:params) { { Async: false, File: 'https://www.w3.org/TR/2003/REC-PNG-20031110/iso_8859-1.txt' } }
+
+        it_behaves_like 'successful task'
+      end
+
+      context 'Async: "false"' do
+        let(:params) { { Async: 'false', File: 'https://www.w3.org/TR/2003/REC-PNG-20031110/iso_8859-1.txt' } }
+
+        it_behaves_like 'successful task'
+      end
+
+      context 'Async: true' do
+        let(:params) { { Async: true, File: 'https://www.w3.org/TR/2003/REC-PNG-20031110/iso_8859-1.txt' } }
+
+        it_behaves_like 'successful async task'
+      end
+
+      context 'Async: "true"' do
+        let(:params) { { Async: "true", File: 'https://www.w3.org/TR/2003/REC-PNG-20031110/iso_8859-1.txt' } }
+
+        it_behaves_like 'successful async task'
       end
     end
   end

spec/convert_api_spec.rb

@@ -112,6 +112,31 @@
         expect { subject }.to raise_error(ConvertApi::FormatError)
       end
     end
+
+    context 'async' do
+      shared_examples 'successful async conversion' do
+        it 'returns result' do
+          expect(subject).to be_instance_of(ConvertApi::AsyncResult)
+          expect(subject.job_id).to be_a_kind_of(String)
+        end
+      end
+
+      context 'with web resource' do
+        let(:from_format) { 'web' }
+        let(:params) { {Async: true, Url: 'http://convertapi.com' } }
+
+        it_behaves_like 'successful async conversion'
+      end
+
+      context 'with multiple files' do
+        let(:to_format) { 'zip' }
+        let(:params) { { Async: true, Files: [file1, file2] } }
+        let(:file1) { 'examples/files/test.pdf' }
+        let(:file2) { ConvertApi::UploadIO.new('examples/files/test.pdf', 'test2.pdf') }
+
+        it_behaves_like 'successful async conversion'
+      end
+    end
   end
 
   describe '.user' do