Merge branch 'feature/signed-urls'

# Conflicts:
#	spec/webhook/processor_spec.rb

Author: josiasmontag

README.md

@@ -207,6 +207,26 @@ The `verify`/`verify_request` methods return `true`/`false`, use `verify!` or `v
 You can read the [full list of events](https://cloudconvert.com/api/v2/webhooks) CloudConvert can notify you about in our documentation.
 
 
+Signed URL
+--------
+
+Signed URLs allow converting files on demand only using URL query parameters. The Ruby SDK allows to generate such URLs. Therefore, you need to obtain a signed URL base and a signing secret on the [CloudConvert Dashboard](https://cloudconvert.com/dashboard/api/v2/signed-urls).
+
+```rb
+base = 'https://s.cloudconvert.com/...' # You can find it in your signed URL settings.
+signing_secret = '...' # You can find it in your signed URL settings.
+cache_key = 'cache-key' # Allows caching of the result file for 24h
+
+job = {
+  tasks: {
+    "import-it": { operation: "import/url", filename: "test.file", url: "http://invalid.url" },
+    "convert-it": { input: "import-it", operation: "convert", output_format: "pdf" },
+  }
+}
+
+url = CloudConvert::SignedUrl.sign(base, signing_secret, job, cache_key)
+```
+
 Development
 -----------
 

lib/cloudconvert.rb

@@ -30,6 +30,7 @@
 require "cloudconvert/version"
 require "cloudconvert/webhook"
 require "cloudconvert/webhook/processor"
+require "cloudconvert/signed_url"
 
 module CloudConvert
   API_URL = "https://api.cloudconvert.com".freeze

lib/cloudconvert/signed_url.rb

@@ -0,0 +1,30 @@
+module CloudConvert
+  class SignedUrl
+
+    class << self
+
+      # @param base [String] The base from for your signed URL settings.
+      # @param signing_secret [String] The signing secret from for your signed URL settings.
+      # @param job [Hash] The job to create the signed URL for
+      # @param cache_key [String] Allows caching of the result file for 24h
+      # @return [String] The signed URL
+      def sign(base, signing_secret, job, cache_key = nil)
+
+        url = base
+
+        url += "?job=" + Base64.urlsafe_encode64(job.to_json, :padding => false)
+
+        unless cache_key.nil?
+          url += "&cache_key=" + cache_key
+        end
+
+        url += "&s=" + OpenSSL::HMAC.hexdigest("SHA256", signing_secret, url)
+
+        return url
+
+      end
+
+
+    end
+  end
+end

sig/lib/cloudconvert/signed_url.rbs

@@ -0,0 +1,9 @@
+module CloudConvert
+  class SignedUrl
+    # @param payload [String] The full request body (the JSON string) of our request to the webhook URL.
+    # @param signature [String] The value from the CloudConvert-Signature.
+    # @param secret [String] The signing secret from for your webhook settings.
+    # @return [Boolean]
+    def self.sign: (untyped base, untyped signing_secret, untyped job, ?untyped? cache_key) -> untyped
+  end
+end

spec/signed_url_spec.rb

@@ -0,0 +1,33 @@
+describe CloudConvert::SignedUrl, :unit do
+  payload = fixture("requests/webhook_job_finished_payload.json").read
+  signature = "576b653f726c85265a389532988f483b5c7d7d5f40cede5f5ddf9c3f02934f35"
+  invalid_signature = SecureRandom.alphanumeric(64)
+  secret = "secret"
+
+  describe ".sign" do
+    it "should return a signed url" do
+
+      job = {
+        tasks: {
+          "import-it": { operation: "import/url", filename: "test.file", url: "http://invalid.url" },
+          "convert-it": { input: "import-it", operation: "convert", output_format: "pdf" },
+        }
+      }
+
+      base = "https://s.cloudconvert.com/b3d85428-584e-4639-bc11-76b7dee9c109"
+      signing_secret = "NT8dpJkttEyfSk3qlRgUJtvTkx64vhyX"
+      cache_key = "mykey"
+
+      url = CloudConvert::SignedUrl.sign(base, signing_secret, job, cache_key)
+
+      print url
+
+      expect(url).to start_with base
+      expect(url).to include "?job="
+      expect(url).to include "&cache_key=mykey"
+      expect(url).to include "&s=3fb529168264bccea28ba9a1d02f2a4662d1917029829ee77e753a7748b98904"
+
+    end
+
+  end
+end

spec/webhook/processor_spec.rb

@@ -80,7 +80,7 @@ def webhook_secret(event)
       let(:controller) { ControllerWithoutMethod.new(request) }
 
       it "raises an error" do
-        expect { controller.create }.to raise_error(NoMethodError)
+        expect { controller.create }.to raise_error NoMethodError
       end
     end