cloudconvert 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fbd33992f2bb0eb736b817259e26ff729b3f3066
-  data.tar.gz: b3452c6677786aba313a97c260eb13e8d83c306a
+SHA256:
+  metadata.gz: 89b916bcf6d9efb3b86d1def064e3b6bb50970466db82b7fdcd3342050c639d8
+  data.tar.gz: 68d95fcc22a697704661bb8aa0926b36afabcf1edb41620d1c71c7fc8412959e
 SHA512:
-  metadata.gz: 2904f73386d4f1110fa1f95b9f239270bb223b492f0d86f2a71ae7cbfc53b009c2c65ec0125a1c537560f0c042c53806a163d1a1815003ec3a6ca9c784099dc8
-  data.tar.gz: 97550957b2be2e493e131359d90aaf16c22e0444a190a0a6bda8a0040011a7a60ea1e3cc79807d983ca683a007f310c86db62db7dac44827901126a55fecd870
+  metadata.gz: df53fc7aff33f2d745a1ff53d840fa4c8ada45e8ea77bce1a10b3b4cd18de594f777b5c77f5dd43e13efd9754abe3ac4cdb5332ccd247ff918fd6822da0ef5bd
+  data.tar.gz: 2fbed2d93cf5c8ed525ebbabc4950e9139fefd7513fadd256b33c6f607505820b2c44009cf9c01b92c1baab69e636c2cb825dc7b40a7a2bbb421fcb8322a29f5

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2013 Pandurang
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2020 Josias Montag <josias@montag.info>
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,64 +1,259 @@
-# Cloudconvert
+cloudconvert-ruby
+=================
 
-Ruby wrapper for CloudConvert [CloudConvert ](https://cloudconvert.org/page/api)
+> This is the official Ruby SDK for the [CloudConvert](https://cloudconvert.com/api/v2) API v2.
 
-## Installation
+[![Build Status](https://github.com/cloudconvert/cloudconvert-ruby/workflows/Tests/badge.svg)](https://github.com/cloudconvert/cloudconvert-ruby/actions?query=workflow%3ATests)
+[![Latest Stable Version](https://img.shields.io/gem/v/cloudconvert?label=stable)](https://rubygems.org/gems/cloudconvert)
+[![Total Downloads](https://img.shields.io/gem/dt/cloudconvert)](https://rubygems.org/gems/cloudconvert)
+[![License](https://img.shields.io/github/license/cloudconvert/cloudconvert-ruby)](https://rubygems.org/gems/cloudconvert)
+
+Installation
+------------
 
 Add this line to your application's Gemfile:
 
-    gem 'cloudconvert'
+```rb
+gem "cloudconvert"
+```
 
 And then execute:
 
-    $ bundle
+```sh
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install cloudconvert
+```sh
+gem install cloudconvert
+```
+
+
+Creating API Client
+-------------------
+
+```rb
+cloudconvert = CloudConvert::Client.new(api_key: "API_KEY", sandbox: false)
+```
+
+Or set the environment variables `CLOUDCONVERT_API_KEY` and `CLOUDCONVERT_SANDBOX` and use:
+
+```rb
+cloudconvert = CloudConvert::Client.new
+```
+
+
+Creating Jobs
+-------------
+
+```rb
+cloudconvert.jobs.create({
+  tasks: [
+    {
+      name: "import-my-file",
+      operation: "import/url",
+      url: "https://my-url"
+    },
+    {
+      name: "convert-my-file",
+      operation: "convert",
+      input: "import-my-file",
+      output_format: "pdf",
+      some_other_option: "value"
+    },
+    {
+      name: "export-my-file",
+      operation: "export/url",
+      input: "convert-my-file"
+    },
+  ]
+})
+```
+
+
+Downloading Files
+-----------------
+
+CloudConvert can generate public URLs for using `export/url` tasks.
+
+You can use these URLs to download output files:
+
+```rb
+exported_url_task_id = "84e872fc-d823-4363-baab-eade2e05ee54"
+task = cloudconvert.tasks.wait(exported_url_task_id) # Wait for job completion
+file = task.result.files.first
+export = cloudconvert.download(file.url)
+```
+
+By default the remote file will be downloaded into a temporary location and returned as a `Tempfile`.
+If you would like the file to be downloaded to a specific location on disk, you can specify the `:destination` option:
+
+```rb
+export = cloudconvert.download(file.url, destination: "/path/to/destination")
+```
+
+The `download` method is powered by the [Down gem](https://github.com/janko/down),
+for the full list of arguments see the [the down docs](https://github.com/janko/down#down).
+
+
+Uploading Files
+---------------
+
+Uploads to CloudConvert are done via `import/upload` tasks (see the [docs](https://cloudconvert.com/api/v2/import#import-upload-tasks)):
+
+```rb
+job = cloudconvert.jobs.create({
+    tasks: [
+        {
+            name: "upload-my-file",
+            operation: "import/upload",
+        }
+    ]
+})
+```
+
+After you've created a `import/upload` task, you can upload a file:
+
+```rb
+upload_task = job.tasks.where(operation: "import/upload").first
+
+response = cloudconvert.tasks.upload("/path/to/sample.pdf", upload_task)
+
+updated_task = cloudconvert.tasks.find(upload_task.id)
+```
+
+Alternatively, instead of a path, you can pass in an open `IO` object:
+
+```rb
+file = File.open("/path/to/sample.pdf")
+response = cloudconvert.tasks.upload(file, upload_task)
+```
+
+If you need to manually specify a `mimetype` or `filename` use our file wrapper:
+
+```rb
+file = CloudConvert::File.new("/path/to/sample.pdf", "video/mp4", "sample.mp4")
+response = cloudconvert.tasks.upload(file, upload_task)
+```
+
+
+Webhooks
+--------
+
+Webhooks can be created on the [CloudConvert Dashboard](https://cloudconvert.com/dashboard/api/v2/webhooks),
+where you can also find the signing secret.
+
+If you're using Rails, you'll want to configure a route to receive the CloudConvert webhook POST requests:
+
+```rb
+# config/routes.rb
+resource :cloudconvert_webhooks, controller: :cloud_convert_webhooks, only: :create
+```
+
+Then create a new controller that uses our processor concern:
+
+```rb
+# app/controllers/cloudconvert_webhooks_controller.rb
+class CloudConvertWebhooksController < ActionController::Base
+  include CloudConvert::Webhook::Processor
+
+  # Handle job.created event
+  def job_created(event)
+    # TODO: handle job.created webhook
+  end
+
+  # Handle job.finished event
+  def job_finished(event)
+    # TODO: handle job.finished webhook
+  end
+
+  # Handle job.failed event
+  def job_failed(event)
+    # TODO: handle job.failed webhook
+  end
+
+  private
+
+  def webhook_secret(event)
+    ENV['CLOUDCONVERT_WEBHOOK_SECRET']
+  end
+end
+```
+
+Alternatively, you can verify the payload yourself:
+
+```rb
+payload = request.body.read
+signature = request.headers["CloudConvert-Signature"]
+secret = "..." # You can find it in your webhook settings
+
+if CloudConvert::Webhook::verify(payload, signature, secret)
+  event = CloudConvert::Webhook::event(payload)
+  event.name == "job.finished"
+  puts event.job.id
+  puts event.job.tasks.count
+end
+```
+
+Or by passing in a request:
+
+```rb
+CloudConvert::Webhook::verify_request(request, secret)
+```
+
+The `verify`/`verify_request` methods return `true`/`false`, use `verify!` or `verify_request!` if you'd rather raise a `CloudConvert::Webhook::Error`.
+
+You can read the [full list of events](https://cloudconvert.com/api/v2/webhooks) CloudConvert can notify you about in our documentation.
+
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cloudconvert/cloudconvert-ruby.
 
-## Usage
 
-This is a Ruby wrapper for Cloud Convert where you can convert files from one format to another format.
-	
-Configure CloudConvert
-	
-	Cloudconvert.configure do |config|
-		config.api_key  = your_api_key
-		config.callback = callback_url
-	end
+Unit Tests
+----------
 
-In this if you specify callback_url then you will be notified on file conversion completion
+```sh
+rspec --tag unit
+```
 
-Start a Conversion on Cloud convert
 
-	conversion = Cloudconvert::Conversion.new
+Integration Tests
+-----------------
 
-	# to start file conversion (options & callback_url parameters are optional)
-	conversion.convert(inputformat, outputformat, file_path, callback_url, options)
+```sh
+rspec --tag integration
+```
 
-	# options parameter is Conversion type specific options , which you can get from, 
-	conversion.converter_options(inputformat, outputformat)
-	#it will return all possible conversion types and possible options(inputformat and outputformat are optional)
+By default, this runs the integration tests against [VCR recordings](https://github.com/vcr/vcr) of the Sandbox API with an official CloudConvert account.
+If you would like to use your own account, you can set your API key using the `CLOUDCONVERT_API_KEY` environment variable and disable VCR with `VCR=off` or by using the `rake spec:sandbox` task.
+In this case you need to whitelist the following MD5 hashes for Sandbox API (using the CloudConvert dashboard).
 
-	# to list all conversions
-	conversion.list_conversions
+```
+53d6fe6b688c31c565907c81de625046  input.pdf
+99d4c165f77af02015aa647770286cf9  input.png
+```
 
-	# to cancel conversion 											  
-	conversion.cancel_conversion 	
 
-	# to delete conversion										  
-	conversion.delete_conversion
+License
+-------
 
-	# to get download link of completed conversion
-	conversion.download_link 												  
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-	# to get current status of conversion
-	conversion.status 													      
 
-## Contributing
+Resources
+---------
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* [API v2 Documentation](https://cloudconvert.com/api/v2)
+* [CloudConvert Blog](https://cloudconvert.com/blog)

data/cloudconvert.gemspec

@@ -1,26 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cloudconvert/version'
+require_relative "lib/cloudconvert/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "cloudconvert"
-  spec.version       = Cloudconvert::VERSION
-  spec.authors       = ["Pandurang Waghulde"]
-  spec.email         = ["pandurang.plw@gmail.com"]
-  spec.description   = "Ruby wrapper for Cloud Convert"
-  spec.summary       = "Ruby wrapper for Cloud Convert"
-  spec.homepage      = "https://github.com/pandurang90/cloudconvert"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-
-  spec.add_dependency "faraday" 
+  spec.name = "cloudconvert"
+  spec.version = CloudConvert::VERSION
+  spec.authors = ["Josias Montag", "Steve Lacey"]
+  spec.email = %w[josias@montag.info steve@steve.ly]
+  spec.description = "A Ruby interface to the CloudConvert API v2."
+  spec.summary = spec.description
+  spec.homepage = "https://cloudconvert.com/api/v2"
+  spec.files = %w[cloudconvert.gemspec LICENSE.txt README.md] + Dir["lib/**/*.rb"]
+  spec.license = "MIT"
+  spec.require_paths = %w[lib]
+  spec.required_ruby_version = ">= 2.7"
+  spec.add_dependency "activesupport", ">= 4.0"
+  spec.add_dependency "down", "~> 5.0"
+  spec.add_dependency "equalizer"
+  spec.add_dependency "faraday", "~> 1.0"
+  spec.add_dependency "faraday_middleware", "~> 1.0"
+  spec.add_dependency "forwardable"
   spec.add_dependency "json"
+  spec.add_dependency "memoizable", "~> 0.4"
+  spec.add_dependency "mimemagic", "~> 0.3.5"
+  spec.add_dependency "openssl"
+  spec.add_dependency "ostruct"
+  spec.add_dependency "schemacop", "~> 2.4"
+  spec.add_development_dependency "dotenv", "~> 2.7"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack", "~> 2.2"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.5"
+  spec.add_development_dependency "securerandom"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr", "~> 6.0"
 end

data/lib/cloudconvert.rb

@@ -1,15 +1,38 @@
-require "cloudconvert/version"
-require "cloudconvert/configuration"
-require "cloudconvert/conversion"
-
+require "active_support/concern"
+require "active_support/core_ext/hash/reverse_merge"
+require "down"
+require "equalizer"
 require "faraday"
+require "faraday_middleware"
+require "forwardable"
 require "json"
+require "memoizable"
+require "mimemagic"
+require "openssl"
+require "ostruct"
+require "schemacop"
 
-module Cloudconvert
-  # Your code goes here...
-  CONVERSION_URL = "https://api.cloudconvert.org/"
-
-  API_KEY_ERROR = "API Key cant be blank!"
-  Cloudconvert.configure
+require "cloudconvert/base"
+require "cloudconvert/client"
+require "cloudconvert/collection"
+require "cloudconvert/entity"
+require "cloudconvert/error"
+require "cloudconvert/event"
+require "cloudconvert/file"
+require "cloudconvert/job"
+require "cloudconvert/middleware"
+require "cloudconvert/resource"
+require "cloudconvert/resources/jobs"
+require "cloudconvert/resources/tasks"
+require "cloudconvert/resources/users"
+require "cloudconvert/task"
+require "cloudconvert/user"
+require "cloudconvert/version"
+require "cloudconvert/webhook"
+require "cloudconvert/webhook/processor"
 
+module CloudConvert
+  API_URL = "https://api.cloudconvert.com".freeze
+  SANDBOX_URL = "https://api.sandbox.cloudconvert.com".freeze
+  USER_AGENT = "CloudConvertRubyGem/#{CloudConvert::VERSION}".freeze
 end