cloudconvert 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6dde202d9202295f93e2614fb19358b5c1f97a12679e51da3b837de71c68bcc
-  data.tar.gz: 99ec57ec28509a9a3f1231de3a74b09687185e7b3d4972365b6c655d4c43b243
+  metadata.gz: f05a16c577e0b30ddf30f9e73a087e1b79d40570f11b5a6013d98d9c372494c0
+  data.tar.gz: 7252a59fffb66d0797a04014251a3825a976a3470c8ca0d1adcd10865950512f
 SHA512:
-  metadata.gz: 6fef45ad6dc438ac6e7ac8efb99a3592180d95b01aafc02f1e19ae34029607894c41ffa16325e85a3612a84c361ba5cde0703c4859330b71ae983aaeeaa894af
-  data.tar.gz: 1239105391c68e937fa414c6224dc54ce838725d4108e9ecc2380bddfa90acb881592338a444fa6dde11957fe07523be1170a2886f28bf016f7252f387fae77e
+  metadata.gz: bf3531174c00eb2b7ea64fac80e91a40a497ffdaed32f834fd9edb497b6fadf4514a6a6ada0e50fdd0e1d7e83f763d982408e4e883b9625bfcfcdda1bf2c3ead
+  data.tar.gz: a9a5b932ebf1eee1ada6a1d779bdf73ee6e1572fcaccfb2430496746d2ed8c83b8798e7e38fd61dea16b3a356d9391f05379a8d5137965d7281f5aed23690f3d

data/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
 -----------
 

data/lib/cloudconvert/client.rb

@@ -75,13 +75,18 @@ module CloudConvert
       Down.download(url, *args, **options)
     end
 
-    private
-
     # @return [String]
     def api_host
       @api_host ||= sandbox ? SANDBOX_URL : API_URL
     end
 
+    # @return [String]
+    def api_sync_host
+      @api_sync_host ||= sandbox ? SANDBOX_SYNC_URL : API_SYNC_URL
+    end
+
+    private
+
     # @return [Faraday::Client]
     def connection
       @connection ||= Faraday.new(url: api_host, headers: headers) do |f|

data/lib/cloudconvert/resources/jobs.rb

@@ -41,7 +41,7 @@ module CloudConvert
       # @param id [String]
       # @return [Job]
       def wait(id)
-        Job.result(client.get("/v2/jobs/#{id}/wait", {}))
+        Job.result(client.get(client.api_sync_host + "/v2/jobs/#{id}", {}))
       end
 
       # @param id [String]

data/lib/cloudconvert/resources/tasks.rb

@@ -51,7 +51,7 @@ module CloudConvert
       # @param id [String]
       # @return [Task]
       def wait(id)
-        Task.result(client.get("/v2/tasks/#{id}/wait"))
+        Task.result(client.get(client.api_sync_host + "/v2/tasks/#{id}"))
       end
 
       # @param file [File, String, IO] Either a String filename to a local file or an open IO object.

data/lib/cloudconvert/signed_url.rb

@@ -0,0 +1,24 @@
+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)
+
+        url
+      end
+    end
+  end
+end

data/lib/cloudconvert/version.rb

@@ -1,3 +1,3 @@
 module CloudConvert
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/cloudconvert.rb

@@ -30,9 +30,12 @@ require "cloudconvert/user"
 require "cloudconvert/version"
 require "cloudconvert/webhook"
 require "cloudconvert/webhook/processor"
+require "cloudconvert/signed_url"
 
 module CloudConvert
   API_URL = "https://api.cloudconvert.com".freeze
   SANDBOX_URL = "https://api.sandbox.cloudconvert.com".freeze
+  API_SYNC_URL = "https://sync.api.cloudconvert.com".freeze
+  SANDBOX_SYNC_URL = "https://sync.api.sandbox.cloudconvert.com".freeze
   USER_AGENT = "CloudConvertRubyGem/#{CloudConvert::VERSION}".freeze
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cloudconvert
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Josias Montag
 - Steve Lacey
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -358,6 +358,7 @@ files:
 - lib/cloudconvert/resources/jobs.rb
 - lib/cloudconvert/resources/tasks.rb
 - lib/cloudconvert/resources/users.rb
+- lib/cloudconvert/signed_url.rb
 - lib/cloudconvert/task.rb
 - lib/cloudconvert/user.rb
 - lib/cloudconvert/version.rb
@@ -370,7 +371,7 @@ metadata:
   bug_tracker_uri: https://github.com/cloudconvert/cloudconvert-ruby/issues
   documentation_uri: https://cloudconvert.com/api/v2
   source_code_uri: https://github.com/cloudconvert/cloudconvert-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -385,8 +386,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A Ruby interface to the CloudConvert API v2.
 test_files: []