transloadit 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51844f6de69eb87292ee3a8b34a0121c5b39024b
-  data.tar.gz: e9239659a9091051cdfcb602ba14ec6fea973340
+SHA256:
+  metadata.gz: c0001e9da3cd516d632f1f64b19e3c1a543b3fcb8b3d595ef357b1378be78575
+  data.tar.gz: c835af092c5046f590b6cd57570ee10b12aef5b8679da544f61217f5a349a8c1
 SHA512:
-  metadata.gz: 981c5131b6c960744a952ffcc1a7eebbf867d17ee239adb5edd229676bc1f1ce515e33591c75256de0d918776ebb91add176c4d3d6dd6969d558b7f34030b4d5
-  data.tar.gz: 3b72a678ff9d20769dfc4180fb5c302ef13b5e49c126a8e2a30ce25f427d3a9137d72ffe38fb9600ff7706d35d7d58dd2827b6f17c7203c41a335e3685e4e22a
+  metadata.gz: 179ec53008ed5bd7525a422bd3bdb6fe69ef4b665cb6fdfd1c6490ceb91ce9452c965ee5476a51494e144f1d8f02fda5344121763a0a0ea2bfaf0315b48633b4
+  data.tar.gz: 9b599ab52a8d44016cd4e9dcaf954fd845a4ae881f1c85b4efcb1d1a867e006eb433cd3b09333cbafa8f03f7ef8860ae3cd7668f72ce2415cb3cdb7256a1a3d8

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+on: push
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 3.0
+          - 3.1
+          - 3.2
+          - jruby
+          # - jruby-head
+          - truffleruby
+          # - truffleruby-head
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec standardrb
+      - run: COVERAGE=false bundle exec rake test

data/CHANGELOG.md

@@ -1,89 +1,100 @@
-### 2.0.1 / 2017-01-23 ###
+### 3.0.0 / 2024-01-10
 
-* Use the ssl enabled url as the API base url (@ifedapoolarewaju)
+- BREAKING: Drop support for EOL'd Ruby 2.x
+- Ensure that signature is sent before files [#65](https://github.com/transloadit/ruby-sdk/pull/65) (@Acconut)
+- Send requests via HTTPS by default [#64](https://github.com/transloadit/ruby-sdk/pull/64) (@Acconut)
+- Prevent duplicate assembly steps [#49](https://github.com/transloadit/ruby-sdk/issues/27) (@ifedapoolarewaju)
+- Send "Transloadit-Client" header for every request (@ifedapoolarewaju)
+- Send all requests via HTTPS by default
+- Position signature before any files in requests [#51](https://github.com/transloadit/ruby-sdk/issues/51)
 
-### 2.0.0 / 2016-12-03 ###
+### 2.0.1 / 2017-01-23
 
-* Drop support for EOL'd Ruby 1.9.x and Ruby 2.0, please use version 1.2.0 if you need support for older
+- Use the ssl enabled url as the API base url (@ifedapoolarewaju)
+
+### 2.0.0 / 2016-12-03
+
+- Drop support for EOL'd Ruby 1.9.x and Ruby 2.0, please use version 1.2.0 if you need support for older
   Ruby versions.
-* Fix compatibility to Ruby >=2.1 and Rails 5.
-* Remove bored instance logic (thanks @ifedapoolarewaju for the PR). This shouldn't affect users at all and removes
+- Fix compatibility to Ruby >=2.1 and Rails 5.
+- Remove bored instance logic (thanks @ifedapoolarewaju for the PR). This shouldn't affect users at all and removes
   the need for another HTTP request before the actual HTTP request.
-* We now have the `transloadit.bill` method to retrieve billing reports. (@ifedapoolarewaju)
-* Deprecate `assembly.submit!` method for `assembly.create!`. This shouldn't affect users as the `submit!` method remains
+- We now have the `transloadit.bill` method to retrieve billing reports. (@ifedapoolarewaju)
+- Deprecate `assembly.submit!` method for `assembly.create!`. This shouldn't affect users as the `submit!` method remains
   as an alias for `create!`. (@ifedapoolarewaju)
-* Add support for new `assembly` methods (Thanks @ifedapoolarewaju):
-  * list to get a list of all assemblies.
-  * get to retrieve a particular assembly. Requires assembly id to be passed as argument.
-  * replay to replay a particular assembly. Requires assembly id to be passed as argument.
-  * get_notifications to get a list of all assembly notifications.
-  * replay_notification to replay the notification of a particular assembly. Requires assembly id to be passed as argument.
-* We now have a Template api with the following methods:
-  * create to create a new template.
-  * list to get a list of all templates.
-  * get to retrieve a particular template.
-  * update to update a particular template.
-  * delete to delete a particular template.
-* Add rate limit feature to implicitly retry assembly creation when the rate limit is reached.
-* Add `assembly.reload_until_finished!` which calls `reload!` once per second until assembly is finished (@gbuesing)
-* Added example files with a [small tutorial](examples/README.md) in `examples` (@jasonaibrahim)
+- Add support for new `assembly` methods (Thanks @ifedapoolarewaju):
+  - list to get a list of all assemblies.
+  - get to retrieve a particular assembly. Requires assembly id to be passed as argument.
+  - replay to replay a particular assembly. Requires assembly id to be passed as argument.
+  - get_notifications to get a list of all assembly notifications.
+  - replay_notification to replay the notification of a particular assembly. Requires assembly id to be passed as argument.
+- We now have a Template api with the following methods:
+  - create to create a new template.
+  - list to get a list of all templates.
+  - get to retrieve a particular template.
+  - update to update a particular template.
+  - delete to delete a particular template.
+- Add rate limit feature to implicitly retry assembly creation when the rate limit is reached.
+- Add `assembly.reload_until_finished!` which calls `reload!` once per second until assembly is finished (@gbuesing)
+- Added example files with a [small tutorial](examples/README.md) in `examples` (@jasonaibrahim)
 
-### 1.2.0 / 2015-12-28 ###
+### 1.2.0 / 2015-12-28
 
-* allow custom fields to be passed to Transloadit and received back in the response (thanks @Acconut for the pull request)
+- allow custom fields to be passed to Transloadit and received back in the response (thanks @Acconut for the pull request)
 
-### 1.1.4 / 2015-12-14 ###
+### 1.1.4 / 2015-12-14
 
-* fix Ruby 1.9.x compatibility by explicitly requiring mime-types 2.99
+- fix Ruby 1.9.x compatibility by explicitly requiring mime-types 2.99
 
-### 1.1.3 / 2014-08-21 ###
+### 1.1.3 / 2014-08-21
 
-* Use rest-client < 1.7.0 for Ruby version below 1.9 to stay 1.8 compatible.
+- Use rest-client < 1.7.0 for Ruby version below 1.9 to stay 1.8 compatible.
 
-### 1.1.2 / 2014-06-17 ###
+### 1.1.2 / 2014-06-17
 
-* Fix deprecation warning on Ruby 2.1.0 for OpenSSL::Digest (thanks @pekeler for the patch)
+- Fix deprecation warning on Ruby 2.1.0 for OpenSSL::Digest (thanks @pekeler for the patch)
 
-### 1.1.1 / 2013-06-25 ###
+### 1.1.1 / 2013-06-25
 
-* request.get with secret (thanks @miry for the patch)
+- request.get with secret (thanks @miry for the patch)
 
-### 1.1.0 / 2013-04-22 ###
+### 1.1.0 / 2013-04-22
 
-* We now have more statuses available in the response:
-    * finished? to check if processing is finished
-    * error? to check if processing failed with errors
-    * canceled? to check if processing was canceled
-    * aborted? to check if processing was aborted
-    * executing? to check if processing is still executing
-    * uploading? to check if the upload is still going
-* Please use `finished?` to check if procssing is finished and `completed?` to
+- We now have more statuses available in the response:
+  - finished? to check if processing is finished
+  - error? to check if processing failed with errors
+  - canceled? to check if processing was canceled
+  - aborted? to check if processing was aborted
+  - executing? to check if processing is still executing
+  - uploading? to check if the upload is still going
+- Please use `finished?` to check if procssing is finished and `completed?` to
   check if completed successfully
 
-### 1.0.5 / 2013-03-13 ###
+### 1.0.5 / 2013-03-13
 
-* Use MultiJSON so everyone can use the JSON parser they like. (thanks @kselden for the patch)
-* Switch to Kramdown for RDoc formatting
-* Support jRuby 1.8/1.9 and MRI 2.0.0 too
+- Use MultiJSON so everyone can use the JSON parser they like. (thanks @kselden for the patch)
+- Switch to Kramdown for RDoc formatting
+- Support jRuby 1.8/1.9 and MRI 2.0.0 too
 
-### 1.0.4 / 2013-03-06 ###
+### 1.0.4 / 2013-03-06
 
-* allow symbols as keys for response attributes (thanks @gbuesing for reporting)
+- allow symbols as keys for response attributes (thanks @gbuesing for reporting)
 
-### 1.0.3 / 2012-11-10 ###
+### 1.0.3 / 2012-11-10
 
-* Support max_size option
+- Support max_size option
 
-### 1.0.1 / 2011-02-08 ###
+### 1.0.1 / 2011-02-08
 
 [Full list of changes](https://github.com/transloadit/ruby-sdk/compare/v1.0.0...v1.0.1)
 
-* Enhancements
-  * support custom form fields for Transloadit::Assembly
+- Enhancements
+
+  - support custom form fields for Transloadit::Assembly
 
-* New Maintainers
-  * Robin Mehner <robin@coding-robin.de>
+- New Maintainers
+  - Robin Mehner <robin@coding-robin.de>
 
-### 1.0.0 / 2011-09-06 ###
+### 1.0.0 / 2011-09-06
 
-* Initial release
+- Initial release

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -1,18 +1,17 @@
-[![Build Status](https://travis-ci.org/transloadit/ruby-sdk.png?branch=master)](https://travis-ci.org/transloadit/ruby-sdk)
+[![Build Status](https://github.com/transloadit/ruby-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/transloadit/ruby-sdk/actions/workflows/ci.yml)
 [![Code Climate](https://codeclimate.com/github/transloadit/ruby-sdk.png)](https://codeclimate.com/github/transloadit/ruby-sdk)
-[![Dependency Status](https://gemnasium.com/transloadit/ruby-sdk.png)](https://gemnasium.com/transloadit/ruby-sdk)
 
-# transloadit
+## ruby-sdk
 
-Fantastic file uploading for your web application.
+A **Ruby** Integration for [Transloadit](https://transloadit.com)'s file uploading and encoding service
 
-## Description
+## Intro
 
-This is the official Ruby gem for [Transloadit](http://transloadit.com). It allows
-you to automate uploading files through the Transloadit REST API.
+[Transloadit](https://transloadit.com) is a service that helps you handle file uploads, resize, crop and watermark your images, make GIFs, transcode your videos, extract thumbnails, generate audio waveforms, and so much more. In short, [Transloadit](https://transloadit.com) is the Swiss Army Knife for your files.
 
-If you run Ruby on Rails and are looking to integrate with the browser for file uploads,
-checkout the [rails-sdk](https://github.com/transloadit/rails-sdk).
+This is a **Ruby** SDK to make it easy to talk to the [Transloadit](https://transloadit.com) REST API.
+
+*If you run Ruby on Rails and are looking to integrate with the browser for file uploads, checkout the [rails-sdk](https://github.com/transloadit/rails-sdk).*
 
 ## Install
 
@@ -20,7 +19,7 @@ checkout the [rails-sdk](https://github.com/transloadit/rails-sdk).
 gem install transloadit
 ```
 
-## Getting started
+## Usage
 
 To get started, you need to require the 'transloadit' gem:
 
@@ -30,56 +29,64 @@ $ irb -rubygems
 => true
 ```
 
-Then create a Transloadit instance, which will maintain your authentication
-credentials and allow us to make requests to the API.
+Then create a Transloadit instance, which will maintain your 
+[authentication credentials](https://transloadit.com/accounts/credentials) 
+and allow us to make requests to [the API](https://transloadit.com/docs/api/).
 
 ```ruby
 transloadit = Transloadit.new(
-  :key    => 'transloadit-auth-key',
-  :secret => 'transloadit-auth-secret'
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
 )
 ```
 
 ### 1. Resize and store an image
 
-This example demonstrates how you can create an assembly to resize an image
-and store the result on [Amazon S3](http://aws.amazon.com/s3/).
-
-First, we create two steps: one to resize the image to 320x240, and another to
-store the image in our S3 bucket.
+This example demonstrates how you can create an <dfn>Assembly</dfn> to resize an image
+and store the result on [Amazon S3](https://aws.amazon.com/s3/).
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
+# First, we create two steps: one to resize the image to 320x240, and another to
+# store the image in our S3 bucket.
 resize = transloadit.step 'resize', '/image/resize',
   :width  => 320,
   :height => 240
 
 store  = transloadit.step 'store', '/s3/store',
-  :key    => 'aws-access-key-id',
-  :secret => 'aws-secret-access-key',
-  :bucket => 's3-bucket-name'
-```
-
-Now that we have the steps, we create an assembly (which is just a request to
-process a file or set of files) and let Transloadit do the rest.
+  :key    => 'YOUR_AWS_KEY',
+  :secret => 'YOUR_AWS_SECRET',
+  :bucket => 'YOUR_S3_BUCKET'
 
-```ruby
+# Now that we have the steps, we create an assembly (which is just a request to
+# process a file or set of files) and let Transloadit do the rest.
 assembly = transloadit.assembly(
   :steps => [ resize, store ]
 )
 
-response = assembly.create! open('lolcat.jpg')
+response = assembly.create! open('/PATH/TO/FILE.jpg')
 
 # reloads the response once per second until all processing is finished
 response.reload_until_finished!
 
 if response.error?
- # handle error
+  # handle error
 else
- # handle other cases
+  # handle other cases
+  puts response
 end
 ```
-*(note: the assembly method `submit!` has been deprecated and replaced with `create!`.
-The submit! method remains as an alias of `create!` for backward Compatibility)*
+
+<div class="alert alert-note">
+  <strong>Note:</strong> The <dfn>Assembly</dfn> method <code>submit!</code> has been deprecated and replaced with <code>create!</code>.
+  The <code>submit!</code> method remains as an alias of <code>create!</code> for backward Compatibility.
+</div>
 
 When the `create!` method returns, the file has been uploaded but may not yet
 be done processing. We can use the returned object to check if processing has
@@ -90,7 +97,7 @@ completed, or examine other attributes of the request.
 response[:assembly_id] # => '9bd733a...'
 
 # returns the API URL endpoint for the assembly
-response[:assembly_url] # => 'http://api2.vivian.transloadit.com/assemblies/9bd733a...'
+response[:assembly_ssl_url] # => 'https://api2.vivian.transloadit.com/assemblies/9bd733a...'
 
 # checks how many bytes were expected / received by transloadit
 response[:bytes_expected] # => 92933
@@ -102,7 +109,7 @@ response.finished? # => false
 # cancels further processing on the assembly
 response.cancel! # => true
 
-# checks if processing was succesfully completed
+# checks if processing was successfully completed
 response.completed? # => true
 
 # checks if the processing returned with an error
@@ -111,21 +118,21 @@ response.error? # => false
 
 It's important to note that none of these queries are "live" (with the
 exception of the `cancel!` method). They all check the response given by the
-API at the time the assembly was created. You have to explicitly ask the
-assembly to reload its results from the API.
+API at the time the <dfn>Assembly</dfn> was created. You have to explicitly ask the
+<dfn>Assembly</dfn> to reload its results from the API.
 
 ```ruby
 # reloads the response's contents from the REST API
 response.reload!
 
 # reloads once per second until all processing is finished, up to number of 
-# times specified in :tries option, othewise will raise ReloadLimitReached
+# times specified in :tries option, otherwise will raise ReloadLimitReached
 response.reload_until_finished! tries: 300 # default is 600
 ```
 
 In general, you use hash accessor syntax to query any direct attribute from
-the [response](http://transloadit.com/docs/assemblies#response-format).
-Methods suffixed by a question mark provide a more readable way of quering
+the [response](https://transloadit.com/docs/api/#assembly-status-response).
+Methods suffixed by a question mark provide a more readable way of querying
 state (e.g., `assembly.completed?` vs. checking the result of
 `assembly[:ok]`). Methods suffixed by a bang make a live query against the
 Transloadit HTTP API.
@@ -133,10 +140,17 @@ Transloadit HTTP API.
 ### 2. Uploading multiple files
 
 Multiple files can be given to the `create!` method in order to upload more
-than one file in the same request. You can also pass a single step for the
+than one file in the same request. You can also pass a single <dfn>Step</dfn> for the
 `steps` parameter, without having to wrap it in an Array.
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
 assembly = transloadit.assembly(steps: store)
 
 response = assembly.create!(
@@ -146,7 +160,9 @@ response = assembly.create!(
 )
 ```
 
-You can also pass an array of files to the `create!` method. Just unpack the array using the splat `*` operator.
+You can also pass an array of files to the `create!` method. 
+Just unpack the array using the splat `*` operator.
+
 ```ruby
 files = [open('puppies.jpg'), open('kittens.jpg'), open('ferrets.jpg')]
 response = assembly.create! *files
@@ -155,10 +171,17 @@ response = assembly.create! *files
 ### 3. Parallel Assembly
 
 Transloadit allows you to perform several processing steps in parallel. You
-simply need to `use` other steps. Following
-[their example](http://transloadit.com/docs/assemblies#special-parameters):
+simply need to `use` other <dfn>Steps</dfn>. Following
+[their example](https://transloadit.com/docs/#special-parameters):
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
 encode = transloadit.step 'encode', '/video/encode', { ... }
 thumbs = transloadit.step 'thumbs', '/video/thumbs', { ... }
 export = transloadit.step 'store',  '/s3/store',     { ... }
@@ -167,60 +190,91 @@ export.use [ encode, thumbs ]
 
 transloadit.assembly(
   :steps => [ encode, thumbs, export ]
-).create! open('ninja-cat.mpg')
+).create! open('/PATH/TO/FILE.mpg')
 ```
 
 You can also tell a step to use the original uploaded file by passing the
 Symbol `:original` instead of another step.
 
 Check the YARD documentation for more information on using
-[use](http://rubydoc.info/gems/transloadit/frames/Transloadit/Step#use-instance_method).
+[use](https://rubydoc.info/gems/transloadit/frames/Transloadit/Step#use-instance_method).
 
 ### 4. Creating an Assembly with Templates
 
-Transloadit allows you to use custom [templates](https://github.com/transloadit/ruby-sdk/blob/master/README.md#8-templates)
+Transloadit allows you to use custom [templates](https://github.com/transloadit/ruby-sdk/blob/main/README.md#8-templates)
 for recurring encoding tasks. In order to use these do the following:
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
 transloadit.assembly(
   :template_id => 'YOUR_TEMPLATE_ID'
-).create! open('ninja-cat.mpg')
+).create! open('/PATH/TO/FILE.mpg')
 ```
 
 You can use your steps together with this template and even use variables.
-The [Transloadit documentation](http://transloadit.com/docs/templates#passing-variables-into-a-template) has some nice
-examples for that.
+The [Transloadit documentation](https://transloadit.com/docs/#passing-variables-into-a-template) 
+has some nice examples for that.
 
 ### 5. Using fields
 
 Transloadit allows you to submit form field values that you'll get back in the
-notification. This is quite handy if you want to add additional custom meta data
+notification. This is quite handy if you want to add additional custom metadata
 to the upload itself. You can use fields like the following:
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
 transloadit.assembly(
-  :fields => {:tag => 'ninjacats'}
-).create! open('ninja-cat.mpg')
+  :fields => {
+    :tag => 'some_tag_name',
+    :field_name => 'field_value'
+  }
+).create! open('/PATH/TO/FILE.mpg')
 ```
 
 ### 6. Notify URL
 
 If you want to be notified when the processing is finished you can provide
-a notify url for the assembly.
+a Notify URL for the <dfn>Assembly</dfn>.
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
 transloadit.assembly(
-  :notify_url => 'http://example.com/processing_finished'
-).create! open('ninja-cat.mpg')
+  :notify_url => 'https://example.com/processing_finished'
+).create! open('/PATH/TO/FILE.mpg')
 ```
 
-Read up more on the notifications [on Transloadit's documentation page](http://transloadit.com/docs/notifications-vs-redirect-url)
+Read up more on the <dfn>Notifications</dfn> [on Transloadit's documentation page](https://transloadit.com/docs/#notifications)
 
 ### 7. Other Assembly methods
 
-Transloadit also provides methods to retrieve/replay assemblies and their notifications.
+Transloadit also provides methods to retrieve/replay <dfn>Assemblies</dfn> and their <dfn>Notifications</dfn>.
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
 assembly = transloadit.assembly
 
 # returns a list of all assemblies
@@ -243,10 +297,17 @@ assembly.replay_notification 'YOUR_ASSEMBLY_ID'
 
 ### 8. Templates
 
-Transloadit provides a [templates api](https://transloadit.com/docs/templates)
-for recurring encoding tasks. Here's how you would create a template:
+Transloadit provides a [templates api](https://transloadit.com/docs/#templates)
+for recurring encoding tasks. Here's how you would create a <dfn>Template</dfn>:
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
 template = transloadit.template
 
 # creates a new template
@@ -264,9 +325,18 @@ template.create(
 )
 ```
 
-There are also some other methods to retrieve, update and delete a template.
+There are also some other methods to retrieve, update and delete a <dfn>Template</dfn>.
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
+template = transloadit.template
+
 # returns a list of all templates.
 template.list
 
@@ -293,57 +363,63 @@ template.delete 'YOUR_TEMPLATE_ID'
 
 ### 9. Getting Bill reports
 
-If you want to retrieve your transloadit account billing report for a particular month and year
+If you want to retrieve your Transloadit account billing report for a particular month and year
 you can use the `bill` method passing the required month and year like the following:
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
 # returns bill report for February, 2016.
 transloadit.bill(2, 2016)
 ```
+
 Not specifying the `month` or `year` would default to the current month or year.
 
 ### 10. Rate limits
 
 Transloadit enforces rate limits to guarantee that no customers are adversely affected by the usage
-of any given customer. See [Rate Limiting](https://transloadit.com/docs/api-docs/#rate-limiting).
+of any given customer. See [Rate Limiting](https://transloadit.com/docs/api/#rate-limiting).
 
-While creating an assembly, if a rate limit error is received, by default, 2 more attempts would be made for a succesful
-response. If after these attempts the rate limit error persists, a `RateLimitReached` exception will be raised.
+While creating an <dfn>Assembly</dfn>, if a rate limit error is received, by default, 2 more attempts would be made for a successful response. If after these attempts the rate limit error persists, a `RateLimitReached` exception will be raised.
 
-To change the number of attempts that will be made when creating an assembly, you may pass the `tries` option to your
-assembly like so.
+To change the number of attempts that will be made when creating an <dfn>Assembly</dfn>, you may pass the `tries` option to your <dfn>Assembly</dfn> like so.
 
 ```ruby
+require 'transloadit'
+
+transloadit = Transloadit.new(
+  :key    => 'YOUR_TRANSLOADIT_KEY',
+  :secret => 'YOUR_TRANSLOADIT_SECRET'
+)
+
 # would make one extra attempt after a failed attempt.
-transloadit.assembly(:tries => 2).create! open('ninja-cat.mpg')
+transloadit.assembly(:tries => 2).create! open('/PATH/TO/FILE.mpg')
 
 # Would make no attempt at all. Your request would not be sent.
-transloadit.assembly(:tries => 0).create! open('ninja-cat.mpg')
+transloadit.assembly(:tries => 0).create! open('/PATH/TO/FILE.mpg')
 ```
 
-## Documentation
+## Example
 
-Up-to-date YARD documentation is automatically generated. You can view the
-docs for the [released gem](http://rubydoc.info/gems/transloadit/frames) or
-for the latest [git master](http://rubydoc.info/github/transloadit/ruby-sdk/master/frames).
+A small sample tutorial of using the Transloadit ruby-sdk to optimize an image, encode MP3 audio, add ID3 tags,
+and more can be found [here](https://github.com/transloadit/ruby-sdk/tree/main/examples).
 
-## Examples
+## Documentation
 
-An small sample tutorial of using the Transloadit ruby-sdk to optimize an image, encode MP3 audio, add ID3 tags,
-and more can be found [here](examples/README.md).
+Up-to-date YARD documentation is automatically generated. You can view the
+docs for the <a href="https://rubydoc.info/gems/transloadit/frames" rel="canonical">released gem</a> or
+for the latest [git main](https://rubydoc.info/github/transloadit/ruby-sdk/main/frames).
 
 ## Compatibility
 
-At a minimum, this gem should work on MRI 2.3.0, 2.2.0, 2.1.0, Rubinius,
-and JRuby. It may also work on older ruby versions, but support for those
-Rubies is not guaranteed. If it doesn't work on one of the officially supported Rubies, please file a
-[bug report](https://github.com/transloadit/ruby-sdk/issues). Compatibility patches for other Rubies
-are welcome.
-
-Testing against these versions is performed automatically by
-[Travis CI](https://travis-ci.org/transloadit/ruby-sdk).
+Please see [ci.yml](https://github.com/transloadit/ruby-sdk/tree/main/.github/workflows/ci.yml) for a list of supported ruby versions. It may also work on older Rubies, but support for those is not guaranteed. If it doesn't work on one of the officially supported Rubies, please file a
+[bug report](https://github.com/transloadit/ruby-sdk/issues). Compatibility patches for other Rubies are welcome.
 
-### Ruby 1.9.x & 2.0
+### Ruby 2.x
 
-If you still need support for older versions of Ruby, 1.2.0 is the last version that
-supports those.
+If you still need support for Ruby 2.x, 2.0.1 is the last version that supports it.