Merge pull request #1 from Interfolio/webhooks_and_polling

Add webhook support.  Add polling support

Author: danhorst

lib/convert_api.rb

@@ -28,6 +28,13 @@ def convert(to_format, params, from_format: nil, conversion_timeout: nil)
     Task.new(from_format, to_format, params, conversion_timeout: conversion_timeout).run
   end
 
+  # Poll ConvertAPI for job status
+  # Raises ClientError with status code 202 if the job is not complete yet
+  # Raises ClientError with status code 404 if the job is not found
+  def poll(job_id)
+    Result.new(client.get("async/job/#{job_id}"))
+  end
+
   def user
     client.get('user')
   end

lib/convert_api/client.rb

@@ -28,6 +28,12 @@ class Client
       'Accept' => 'application/json'
     }
 
+    # Parameters that are always on the URL, even for POST
+    POST_URL_PARAMS = [
+      :WebHook,
+      :JobId
+    ].freeze
+
     def get(path, params = {}, options = {})
       handle_response do
         request = Net::HTTP::Get.new(request_uri(path, params), DEFAULT_HEADERS)
@@ -38,7 +44,7 @@ def get(path, params = {}, options = {})
 
     def post(path, params, options = {})
       handle_response do
-        request = Net::HTTP::Post.new(request_uri(path), DEFAULT_HEADERS)
+        request = Net::HTTP::Post.new(request_uri(path, post_url_params(params)), DEFAULT_HEADERS)
         request.form_data = build_form_data(params)
 
         http(options).request(request)
@@ -113,16 +119,22 @@ def build_form_data(params)
       data = {}
 
       params.each do |key, value|
-        if value.is_a?(Array)
-          value.each_with_index { |v, i| data["#{key}[#{i}]"] = v }
-        else
-          data[key] = value
+        unless POST_URL_PARAMS.include?(key)
+          if value.is_a?(Array)
+            value.each_with_index { |v, i| data["#{key}[#{i}]"] = v }
+          else
+            data[key] = value
+          end
         end
       end
 
       data
     end
 
+    def post_url_params(params)
+      params.select { |k, v| POST_URL_PARAMS.include?(k) }
+    end
+
     def base_uri
       config.base_uri
     end

spec/convert_api/client_spec.rb

@@ -10,4 +10,36 @@
       expect(subject['FileId']).to be_instance_of(String)
     end
   end
+
+  describe '#post' do
+    let(:file) { 'https://www.w3.org/TR/2003/REC-PNG-20031110/iso_8859-1.txt' }
+    let(:path) { 'convert/txt/to/pdf/converter/openoffice' }
+    let(:options) { {} }
+    let(:mock_response) { OpenStruct.new(code: 200, body: '{}') }
+
+    subject{ client.post(path, params, options) }
+
+    context 'with normal parameters' do
+      let(:params) { { File: file } }
+      let(:uri_with_secret) { "/#{path}?Secret=#{ConvertApi.config.api_secret}" }
+
+      it 'makes a post request with no extra URL parameters' do
+        expect(Net::HTTP::Post).to(receive(:new).with(uri_with_secret, described_class::DEFAULT_HEADERS).and_call_original)
+        expect_any_instance_of(Net::HTTP).to(receive(:request).and_return(mock_response))
+        expect(subject).to be_an_instance_of(Hash)
+      end
+    end
+
+    context 'with parameters that MUST be passed via URL' do
+      let(:webhook) { 'https://www.convertapi.com/fake-webhook' }
+      let(:params) { { File: file, WebHook: webhook } }
+      let(:uri_with_selected_params) { "/#{path}?#{URI.encode_www_form({ WebHook: webhook, Secret: ConvertApi.config.api_secret})}" }
+
+      it 'makes a post request that passes the required parameters via URL' do
+        expect(Net::HTTP::Post).to(receive(:new).with(uri_with_selected_params, described_class::DEFAULT_HEADERS).and_call_original)
+        expect_any_instance_of(Net::HTTP).to(receive(:request).and_return(mock_response))
+        expect(subject).to be_an_instance_of(Hash)
+      end
+    end
+  end
 end