transloadit 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0001e9da3cd516d632f1f64b19e3c1a543b3fcb8b3d595ef357b1378be78575
-  data.tar.gz: c835af092c5046f590b6cd57570ee10b12aef5b8679da544f61217f5a349a8c1
+  metadata.gz: bbcbc1941ade757af1bd9f57068863464f25062415f2b894715992e905528ac7
+  data.tar.gz: 740dd8bcc2311d47fb133ae5c771f05b36835f77f00843bab4d9808d0c4a23e5
 SHA512:
-  metadata.gz: 179ec53008ed5bd7525a422bd3bdb6fe69ef4b665cb6fdfd1c6490ceb91ce9452c965ee5476a51494e144f1d8f02fda5344121763a0a0ea2bfaf0315b48633b4
-  data.tar.gz: 9b599ab52a8d44016cd4e9dcaf954fd845a4ae881f1c85b4efcb1d1a867e006eb433cd3b09333cbafa8f03f7ef8860ae3cd7668f72ce2415cb3cdb7256a1a3d8
+  metadata.gz: bb2ff7fae5d6e9a0370c07880123e4a88743b13d163800d7a62b2b859f010dac589600b4a9673d0903b633e04af05ce74027c617550aa11bf0274898576a6d60
+  data.tar.gz: 5bebda5ba59fffdd478a82aad4f348bc58feb31b619f58530aebf3fca75313c458c599cf8f435171cd424a9a49185a39ab4d75a77ab0d3502cded2ffe81d0dae

data/.github/workflows/ci.yml

@@ -1,5 +1,9 @@
 name: CI
-on: push
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
 jobs:
   ci:
     runs-on: ubuntu-latest

data/.gitignore

@@ -12,3 +12,4 @@ pkg
 transloadit-*.gem
 
 .DS_Store
+env.sh

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 3.0.2 / 2024-03-01
+
+- Upgrade signature algorithm to more secure SHA-384 [#69](https://github.com/transloadit/ruby-sdk/pull/69) (@aduh95)
+
+### 3.0.1 / 2024-01-10
+
+- Fix `undefined method` errors when handling network exceptions [#67](https://github.com/transloadit/ruby-sdk/pull/67) (@Acconut)
+
 ### 3.0.0 / 2024-01-10
 
 - BREAKING: Drop support for EOL'd Ruby 2.x

data/examples/README.md

@@ -40,8 +40,8 @@ utilizing our credentials that we set in environment variables.
 ### First example
 
 In the [first example](https://github.com/transloadit/ruby-sdk/blob/main/examples/basic/image-transcoder.rb)
-that gets played, we fetch an image from the cat api, optimize it using the Transloadit `/image/optimize` robot, and then optionally
-stores it in s3 if the s3 credentials are set.
+that gets played, we load an image, optimize it using the Transloadit `/image/optimize` robot, and then optionally
+store it in s3 if the s3 credentials are set.
 
 There are only two steps:
 
@@ -65,7 +65,7 @@ begin
 
   steps.push(store)
 rescue KeyError => e
-  p 's3 config not set. Skipping s3 storage...'
+  puts 's3 config not set. Skipping s3 storage...'
 end
 
  ```
@@ -119,7 +119,7 @@ begin
 
   steps.push(store)
 rescue KeyError => e
-  p 's3 config not set. Skipping s3 storage...'
+  puts 's3 config not set. Skipping s3 storage...'
 end
 ```
 
@@ -175,10 +175,10 @@ concat = transloadit_client.step('concat', '/audio/concat', {
 
 Taking a look at the `concat` step, we see a different usage of the `use` parameter
 than we have seen in previous examples. We are effectively able to define the ordering of the
-concatenation by specifying the ```name```,  `as` and `fields` parameters.
+concatenation by specifying the ```name```, `as` and `fields` parameters.
  
 In this example, we have set the name for each to `:original`, specifying that the input
-at index `i` should be the input file defined at index  `i`.
+at index `i` should be the input file defined at index `i`.
  
 It is equally important to specify the `as` parameter. This simple parameter tells the assembly
 the ordering.
@@ -205,7 +205,7 @@ begin
 
   steps.push(store)
 rescue KeyError => e
-  p 's3 config not set. Skipping s3 storage...'
+  puts 's3 config not set. Skipping s3 storage...'
 end
 
 assembly = transloadit_client.assembly(steps: steps)

data/examples/basic/audio-concat-transcoder.rb

@@ -27,7 +27,7 @@ class AudioConcatTranscoder < MediaTranscoder
 
       steps.push(store)
     rescue KeyError
-      p "s3 config not set. Skipping s3 storage..."
+      puts "s3 config not set. Skipping s3 storage..."
     end
 
     assembly = transloadit_client.assembly(steps: steps)

data/examples/basic/audio-transcoder.rb

@@ -30,7 +30,7 @@ class AudioTranscoder < MediaTranscoder
 
       steps.push(store)
     rescue KeyError
-      p "s3 config not set. Skipping s3 storage..."
+      puts "s3 config not set. Skipping s3 storage..."
     end
 
     assembly = transloadit_client.assembly(steps: steps)

data/examples/basic/image-transcoder.rb

@@ -23,7 +23,7 @@ class ImageTranscoder < MediaTranscoder
 
       steps.push(store)
     rescue KeyError
-      p "s3 config not set. Skipping s3 storage..."
+      puts "s3 config not set. Skipping s3 storage..."
     end
 
     assembly = transloadit_client.assembly(steps: steps)

data/examples/basic/main.rb

@@ -1,63 +1,56 @@
-require "open-uri"
 require_relative "media-transcoder"
 require_relative "image-transcoder"
 require_relative "audio-transcoder"
 require_relative "audio-concat-transcoder"
 
-p "starting image transcoding job..."
-p "fetching image from the cat api..."
+puts "starting image transcoding job..."
 
-open("http://thecatapi.com/api/images/get") do |f|
-  p "starting transcoding job..."
+File.open("#{__dir__}/assets/cat.jpg") do |f|
   image_transcoder = ImageTranscoder.new
   response = image_transcoder.transcode!(f)
 
   # if you are using rails one thing you can do would be to start an ActiveJob process that recursively
   # checks on the status of the assembly until it is finished
-  p "checking job status..."
+  puts "checking job status..."
   response.reload_until_finished!
 
-  p response[:message]
-  p response[:results]["image"][0]["url"]
+  puts response[:message]
+  puts response[:results]["image"][0]["ssl_url"]
+  puts "\n"
 end
 
-p "starting audio transcoding job..."
-p "fetching soundbite from nasa..."
-p "\n"
+puts "starting audio transcoding job..."
 
-open("https://www.nasa.gov/640379main_Computers_are_in_Control.m4r") do |f|
-  p "starting transcoding job..."
+File.open("#{__dir__}/assets/Computers_are_in_Control.flac") do |f|
   audio_transcoder = AudioTranscoder.new
   response = audio_transcoder.transcode!(f)
 
   # if you are using rails one thing you can do would be to start an ActiveJob process that recursively
   # checks on the status of the assembly until it is finished
-  p "checking job status..."
+  puts "checking job status..."
   response.reload_until_finished!
 
-  p response[:message]
-  p response[:results]["mp3"][0]["url"]
-  p "\n"
+  puts response[:message]
+  puts response[:results]["mp3"][0]["ssl_url"]
+  puts "\n"
 end
 
-p "starting audio concat transcoding job..."
-p "fetching 3 soundbites from nasa..."
+puts "starting audio concat transcoding job..."
 
 files = [
-  "https://www.nasa.gov/mp3/640148main_APU%20Shutdown.mp3",
-  "https://www.nasa.gov/mp3/640164main_Go%20for%20Deploy.mp3",
-  "https://www.nasa.gov/mp3/640165main_Lookin%20At%20It.mp3"
+  "#{__dir__}/assets/APU_Shutdown.mp3",
+  "#{__dir__}/assets/Go_for_Deploy.mp3",
+  "#{__dir__}/assets/Lookin_At_It.mp3"
 ]
 
-p "starting transcoding job..."
 audio_concat_transcoder = AudioConcatTranscoder.new
 response = audio_concat_transcoder.transcode!(files)
 
 # if you are using rails one thing you can do would be to start an ActiveJob process that recursively
 # checks on the status of the assembly until it is finished
-p "checking job status..."
+puts "checking job status..."
 response.reload_until_finished!
 
-p response[:message]
-p response[:results]["concat"][0]["url"]
-p "\n"
+puts response[:message]
+puts response[:results]["concat"][0]["ssl_url"]
+puts "\n"

data/lib/transloadit/request.rb

@@ -16,7 +16,7 @@ class Transloadit::Request
   API_HEADERS = {"Transloadit-Client" => "ruby-sdk:#{Transloadit::VERSION}"}
 
   # The HMAC algorithm used for calculation request signatures.
-  HMAC_ALGORITHM = OpenSSL::Digest.new("sha1")
+  HMAC_ALGORITHM = OpenSSL::Digest.new("sha384")
 
   # @return [String] the API endpoint for the request
   attr_reader :url
@@ -187,6 +187,11 @@ class Transloadit::Request
   def request!(&request)
     Transloadit::Response.new yield
   rescue RestClient::Exception => e
+    # The response attribute can be nil, for example for RestClient::Exceptions::OpenTimeout exceptions.
+    # Then, we cannot convert them into a Transloadit::Response, so instead we raise them again for
+    # the user to be visible.
+    # See https://github.com/transloadit/ruby-sdk/issues/53
+    raise e if e.response.nil?
     Transloadit::Response.new e.response
   end
 
@@ -198,6 +203,6 @@ class Transloadit::Request
   # @return [String] the HMAC signature for the params
   #
   def signature(params)
-    self.class._hmac(secret, params) if secret.to_s.length > 0
+    "sha384:" + self.class._hmac(secret, params) if secret.to_s.length > 0
   end
 end

data/lib/transloadit/version.rb

@@ -1,3 +1,3 @@
 class Transloadit
-  VERSION = "3.0.0"
+  VERSION = "3.0.2"
 end

data/test/fixtures/cassettes/fetch_root.yml

@@ -72,7 +72,7 @@ http_interactions:
   recorded_at: Fri, 08 Mar 2013 15:13:10 GMT
 - request:
     method: get
-    uri: https://api2.transloadit.com/?params=%7B%22params%22:%7B%22foo%22:%22bar%22%7D%7D&signature=78f291e3038e3eeb82d9f79e11a68fe7b858ee97
+    uri: https://api2.transloadit.com/?params=%7B%22params%22:%7B%22foo%22:%22bar%22%7D%7D&signature=sha384:edccc99aef8cb46e087e17093fbcd6a2316e2fbe31dc0842c4af87a52808d0736d94a3bd5774deca2c215b53804ca572
     body:
       encoding: US-ASCII
       string: ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transloadit
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Stephen Touset
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -183,6 +183,11 @@ files:
 - README.md
 - Rakefile
 - examples/README.md
+- examples/basic/assets/APU_Shutdown.mp3
+- examples/basic/assets/Computers_are_in_Control.flac
+- examples/basic/assets/Go_for_Deploy.mp3
+- examples/basic/assets/Lookin_At_It.mp3
+- examples/basic/assets/cat.jpg
 - examples/basic/audio-concat-transcoder.rb
 - examples/basic/audio-transcoder.rb
 - examples/basic/image-transcoder.rb