cloudconvert 0.0.5 → 1.0.0

data/lib/cloudconvert/job.rb

@@ -0,0 +1,18 @@
+module CloudConvert
+  class Job < Entity
+    # @return [String]
+    attr_reader :id, :tag
+
+    # @return [Symbol]
+    symbol_attr_reader :status
+
+    # @return [CloudConvert::Collection<CloudConvert::Task>]
+    collection_attr_reader :Task, :tasks
+
+    # @return [OpenStruct]
+    struct_attr_reader :links
+
+    # @return [Time]
+    time_attr_reader :created_at, :started_at, :ended_at
+  end
+end

data/lib/cloudconvert/middleware.rb

@@ -0,0 +1,9 @@
+module CloudConvert
+  module Middleware
+    class ParseJson < FaradayMiddleware::ParseJson
+      define_parser do |body, parser_options|
+        JSON.parse(body, object_class: OpenStruct) unless body.blank?
+      end
+    end
+  end
+end

data/lib/cloudconvert/resource.rb

@@ -0,0 +1,9 @@
+module CloudConvert
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/cloudconvert/resources/jobs.rb

@@ -0,0 +1,54 @@
+module CloudConvert
+  module Resources
+    class Jobs < Resource
+      # @param params [Hash]
+      # @return [Collection<Job>]
+      def all(params = {})
+        Job.collection(client.get("/v2/jobs", params))
+      end
+
+      # @param id [String]
+      # @param params [Hash]
+      # @return [Job]
+      def find(id, params = {})
+        Job.result(client.get("/v2/jobs/#{id}", params))
+      end
+
+      # @param params [Hash]
+      # @return [Job]
+      def create(params)
+        schema = Schemacop::Schema.new do
+          type :hash, allow_obsolete_keys: true do
+            req :tasks, :array, min: 1 do
+              type :hash, allow_obsolete_keys: true do
+                req :operation, :string
+              end
+            end
+          end
+        end
+
+        schema.validate! params
+
+        payload = params.dup
+
+        payload[:tasks] = payload[:tasks].to_h do |task|
+          [task[:name], task.reject { |k| k == :name }]
+        end
+
+        Job.result(client.post("/v2/jobs", payload))
+      end
+
+      # @param id [String]
+      # @return [Job]
+      def wait(id)
+        Job.result(client.get("/v2/jobs/#{id}/wait", {}))
+      end
+
+      # @param id [String]
+      # @return [void]
+      def delete(id)
+        client.delete("/v2/jobs/#{id}")
+      end
+    end
+  end
+end

data/lib/cloudconvert/resources/tasks.rb

@@ -0,0 +1,80 @@
+module CloudConvert
+  module Resources
+    class Tasks < Resource
+      # @param params [Hash]
+      # @return [Collection<Task>]
+      def all(params = {})
+        Task.collection(client.get("/v2/tasks", params))
+      end
+
+      # @param id [String]
+      # @param params [Hash]
+      # @return [Task]
+      def find(id, params = {})
+        Task.result(client.get("/v2/tasks/#{id}", params))
+      end
+
+      # @param operation [String]
+      # @param params [Hash]
+      # @return [Task]
+      def create(params = {})
+        schema = Schemacop::Schema.new do
+          type :hash, allow_obsolete_keys: true do
+            req :operation, :string
+            req :input, :string unless params[:operation].nil? || params[:operation].start_with?("import")
+          end
+        end
+
+        schema.validate! params
+
+        Task.result(client.post("/v2/#{params[:operation]}", params))
+      end
+
+      # @param params [Hash]
+      # @return [Task]
+      def cancel(id)
+        Task.result(client.post("/v2/tasks/#{id}/cancel"))
+      end
+
+      # @param id [String]
+      # @return [void]
+      def delete(id)
+        client.delete("/v2/tasks/#{id}")
+      end
+
+      # @param params [Hash]
+      # @return [Task]
+      def retry(id)
+        Task.result(client.post("/v2/tasks/#{id}/retry"))
+      end
+
+      # @param id [String]
+      # @return [Task]
+      def wait(id)
+        Task.result(client.get("/v2/tasks/#{id}/wait"))
+      end
+
+      # @param file [File, String, IO] Either a String filename to a local file or an open IO object.
+      # @param task [Task] The "import/upload" Task to upload the file to.
+      # @return [void]
+      def upload(file, task)
+        unless task.operation == "import/upload"
+          raise ArgumentError.new("The task operation is not import/upload")
+        end
+
+        unless task.result && task.result.form && task.waiting?
+          raise ArgumentError.new("The task is not ready for uploading")
+        end
+
+        file = File.new(file) unless file.is_a? File
+
+        client.post(task.result.form.url, task.result.form.parameters.to_h.merge(file: file)) do |request|
+          request.headers.delete("Authorization")
+          request.headers["Content-Type"] = "multipart/form-data"
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/cloudconvert/resources/users.rb

@@ -0,0 +1,10 @@
+module CloudConvert
+  module Resources
+    class Users < Resource
+      # @return [User]
+      def me
+        User.result(client.get("/v2/users/me"))
+      end
+    end
+  end
+end

data/lib/cloudconvert/task.rb

@@ -0,0 +1,43 @@
+module CloudConvert
+  class Task < Entity
+    # @return [String]
+    attr_reader :id, :name, :operation, :message, :code,
+                :engine, :engine_version, :host_name, :storage,
+                :job_id, :copy_of_task_id, :retry_of_task_id
+
+    # @return [Symbol]
+    symbol_attr_reader :status
+
+    # @return [Integer]
+    attr_reader :percent, :priority
+
+    # @return [CloudConvert::Collection<CloudConvert::Task>]
+    collection_attr_reader :Task, :depends_on_tasks, :retries
+
+    # @return [OpenStruct]
+    struct_attr_reader :payload, :result, :links
+
+    # @return [Time]
+    time_attr_reader :created_at, :started_at, :ended_at
+
+    # @return [Boolean]
+    def error?
+      status == :error
+    end
+
+    # @return [Boolean]
+    def finished?
+      status == :finished
+    end
+
+    # @return [Boolean]
+    def processing?
+      status == :processing
+    end
+
+    # @return [Boolean]
+    def waiting?
+      status == :waiting
+    end
+  end
+end

data/lib/cloudconvert/user.rb

@@ -0,0 +1,18 @@
+module CloudConvert
+  class User < Entity
+    # @return [Integer]
+    attr_reader :id, :credits
+
+    # @return [String]
+    attr_reader :username, :email
+
+    # @return [Boolean]
+    predicate_attr_reader :paying
+
+    # @return [OpenStruct]
+    struct_attr_reader :links
+
+    # @return [Time]
+    time_attr_reader :created_at
+  end
+end

data/lib/cloudconvert/version.rb

@@ -1,3 +1,3 @@
-module Cloudconvert
-  VERSION = "0.0.5"
+module CloudConvert
+  VERSION = "1.0.0"
 end

data/lib/cloudconvert/webhook.rb

@@ -0,0 +1,54 @@
+module CloudConvert
+  class Webhook
+    # Raised when a webhook is malformed
+    Error = Class.new(CloudConvert::Error)
+
+    # Raised when a webhook does not match the CloudConvert-Signature
+    InvalidSignature = Class.new(Error)
+
+    # Raised when a webhook does not have a CloudConvert-Signature
+    MissingSignature = Class.new(Error)
+
+    class << self
+      # @param payload [String] The full request body (the JSON string) of our request to the webhook URL.
+      # @return [Event]
+      def event(payload)
+        Event.new(JSON.parse(payload, object_class: OpenStruct))
+      end
+
+      # @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 verify(payload, signature, secret)
+        OpenSSL::HMAC.hexdigest("SHA256", secret.to_s, payload.to_s) == signature
+      end
+
+      # @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.
+      # @raise [MissingSignature, InvalidSignature]
+      # @return [Boolean]
+      def verify!(payload, signature, secret)
+        raise MissingSignature.new("Missing webhook signature") if signature.to_s.empty?
+        raise InvalidSignature.new("Invalid webhook signature") unless verify(payload, signature, secret)
+        true
+      end
+
+      # @param request [Request] The request to the webhook URL from CloudConvert.
+      # @param secret [String] The signing secret from for your webhook settings.
+      # @return [Boolean]
+      def verify_request(request, secret)
+        verify request.body.rewind && request.body.read, request.get_header("HTTP_CLOUDCONVERT_SIGNATURE"), secret
+      end
+
+      # @param request [Request] The request to the webhook URL from CloudConvert.
+      # @param secret [String] The signing secret from for your webhook settings.
+      # @raise [MissingSignature, InvalidSignature]
+      # @return [Boolean]
+      def verify_request!(request, secret)
+        verify! request.body.rewind && request.body.read, request.get_header("HTTP_CLOUDCONVERT_SIGNATURE"), secret
+      end
+    end
+  end
+end

data/lib/cloudconvert/webhook/processor.rb

@@ -0,0 +1,29 @@
+module CloudConvert::Webhook::Processor
+  extend ActiveSupport::Concern
+
+  # Raised when the webhook_secret has not been supplied
+  UnspecifiedSecret = Class.new(CloudConvert::Webhook::Error)
+
+  included do
+    before_action :authenticate_cloudconvert_request!, only: :create
+    skip_before_action :verify_authenticity_token, only: :create
+  end
+
+  def create
+    method = event.name.gsub(".", "_")
+    raise NoMethodError.new("#{name}##{method} not implemented") unless respond_to?(method, true)
+    send(method, event)
+    head(:ok)
+  end
+
+  private
+
+  def authenticate_cloudconvert_request!
+    raise UnspecifiedSecret.new unless respond_to?(:webhook_secret, true)
+    head(:bad_request) unless CloudConvert::Webhook.verify_request(request, webhook_secret(event))
+  end
+
+  def event
+    @event ||= CloudConvert::Webhook.event(request.body.read)
+  end
+end

metadata

@@ -1,37 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: cloudconvert
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
-- Pandurang Waghulde
-autorequire: 
+- Josias Montag
+- Steve Lacey
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: down
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '5.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: equalizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -40,6 +55,34 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: forwardable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,28 +109,265 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby wrapper for Cloud Convert
+- !ruby/object:Gem::Dependency
+  name: memoizable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: schemacop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: A Ruby interface to the CloudConvert API v2.
 email:
-- pandurang.plw@gmail.com
+- josias@montag.info
+- steve@steve.ly
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - cloudconvert.gemspec
 - lib/cloudconvert.rb
-- lib/cloudconvert/configuration.rb
-- lib/cloudconvert/conversion.rb
+- lib/cloudconvert/base.rb
+- lib/cloudconvert/client.rb
+- lib/cloudconvert/collection.rb
+- lib/cloudconvert/entity.rb
+- lib/cloudconvert/error.rb
+- lib/cloudconvert/event.rb
+- lib/cloudconvert/file.rb
+- lib/cloudconvert/job.rb
+- lib/cloudconvert/middleware.rb
+- lib/cloudconvert/resource.rb
+- lib/cloudconvert/resources/jobs.rb
+- lib/cloudconvert/resources/tasks.rb
+- lib/cloudconvert/resources/users.rb
+- lib/cloudconvert/task.rb
+- lib/cloudconvert/user.rb
 - lib/cloudconvert/version.rb
-homepage: https://github.com/pandurang90/cloudconvert
+- lib/cloudconvert/webhook.rb
+- lib/cloudconvert/webhook/processor.rb
+homepage: https://cloudconvert.com/api/v2
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,16 +375,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Ruby wrapper for Cloud Convert
+summary: A Ruby interface to the CloudConvert API v2.
 test_files: []