shrine-transloadit 1.0.0.beta → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 379b39a12a74f5b4e3e0c9336c1cc560eaa5ce78596fc55aa8990ea017d632bf
-  data.tar.gz: '04930268d5f2c682dac35cb635fd2e0be617fc6ce1c3bd55b0ee572f771b300f'
+  metadata.gz: 19c66daf493f1fe800d44d3264dcc0a5699f1d177322781ac61b81cd928d8922
+  data.tar.gz: e3a5960f9c9c5db0ed2adfd2299dc7972b23ae635a55951144344135cb1af121
 SHA512:
-  metadata.gz: 0bc371cbec27b5cf8a642eedea74c372e5b1bbef48b82956635a28dd76b02eb1436870a5ba3b18671f26bc897199c77c995df16070704688fecb3d42d11b8f74
-  data.tar.gz: 3da98b2895dd0af05e9f6aac2cc835105b754ef91e0ae0cd528b6cd7ace93a9ac82e8b7dc1ae5dc22b928d24caff89ebb3203b9a97735ac69349e97249ec89b4
+  metadata.gz: 063645f16216fb57eccc422b5fc515ec27c8abc1b47ef75f6dab29db4e017bcce4af08d95cb066aa9cb7632181706243387ddc82eb90bf27b615fe1dfcac0415
+  data.tar.gz: 04bfb71e941d72369aa91b8d473dc24472991c2b6c63fb99090a2125d9d4123542d98b8e6f3785c100419df91a54342fa4cb1c2e7ec53d484b311fdeb57fa495

data/README.md

@@ -10,19 +10,19 @@ generate audio waveforms and more.
 
 * [Installation](#installation)
 * [Setup](#setup)
-  - [Credentials](#credentials)
-* [Usage](#usge)
-  - [Backgrounding](#backgrounding)
+* [Usage](#usage)
 * [Notifications](#notifications)
 * [Direct uploads](#direct-uploads)
 * [Promotion](#promotion)
 * [Skipping exports](#skipping-exports)
 * [API](#api)
-  - [Processing & Saving](#processing-saving)
-  - [Generating steps](#generating-steps)
-  - [Parsing files](#parsing-files)
-  - [Verifying signature](#verifying-signature)
-  - [Transloadit instance](#transloadit-instance)
+  - [Processor](#processor)
+  - [Saver](#saver)
+  - [Step](#step)
+    - [Import step](#import-step)
+    - [Export step](#export-step)
+  - [File](#file)
+* [Instrumentation](#instrumentation)
 
 ## Installation
 
@@ -35,39 +35,30 @@ gem "shrine-transloadit", "~> 1.0"
 
 ## Setup
 
-Load the `transloadit` plugin and configure your Transloadit key and secret:
-
-```rb
-Shrine.plugin :transloadit, auth: {
-  key:    "YOUR_TRANSLOADIT_KEY",
-  secret: "YOUR_TRANSLOADIT_SECRET",
-}
-```
-
-### Credentials
-
-You'll need to create [credentials] for the storage services you want to import
-from and export to. Then you need to map these credentials to Shrine storages:
+You'll first need to create [credentials] for the storage service you want to
+import from and export to. Let's assume you're using S3 and have named the
+credentials `s3_store`. Now you can load the `transloadit` plugin, providing
+Transloadit key & secret, and mapping credentials to Shrine storages:
 
 ```rb
+# example storage configuration
 Shrine.storages = {
   cache: Shrine::Storage::S3.new(prefix: "cache", **options),
   store: Shrine::Storage::S3.new(**options),
 }
 
-Shrine.plugin :transloadit, auth: { ... },
+# transloadit plugin configuration
+Shrine.plugin :transloadit,
+  auth: {
+    key:    "YOUR_TRANSLOADIT_KEY",
+    secret: "YOUR_TRANSLOADIT_SECRET",
+  },
   credentials: {
     cache: :s3_store, # use "s3_store" credentials for :cache storage
     store: :s3_store, # use "s3_store" credentials for :store storage
   }
-```
-
-### Derivatives
 
-The examples will assume you have the [`derivatives`][derivatives] plugin
-loaded:
-
-```rb
+# for storing processed files
 Shrine.plugin :derivatives
 ```
 
@@ -83,7 +74,7 @@ files as derivatives:
 
 ```rb
 class VideoUploader < Shrine
-  Attacher.transloadit_processor :video do
+  Attacher.transloadit_processor do
     import = file.transloadit_import_step
     encode = transloadit_step "encode", "/video/encode", use: import
     thumbs = transloadit_step "thumbs", "/video/thumbs", use: import
@@ -93,23 +84,23 @@ class VideoUploader < Shrine
     assembly.create!
   end
 
-  Attacher.transloadit_saver :video do |response|
-    transcoded = store.transloadit_file(response["results"]["encode"])
-    thumbnails = store.transloadit_files(response["results"]["thumbs"])
+  Attacher.transloadit_saver do |results|
+    transcoded = store.transloadit_file(results["encode"])
+    thumbnails = store.transloadit_files(results["thumbs"])
 
     merge_derivatives(transcoded: transcoded, thumbnails: thumbnails)
   end
 end
 ```
 ```rb
-response = attacher.transloadit_process(:video)
+response = attacher.transloadit_process
 response.reload_until_finished!
 
 if response.error?
   # handle error
 end
 
-attacher.transloadit_save(:video, response)
+attacher.transloadit_save(response["results"])
 attacher.derivatives #=>
 # {
 #   transcoded: #<Shrine::UploadedFile storage_key=:store ...>,
@@ -131,7 +122,7 @@ class PromoteJob
   def perform(record, name, file_data)
     attacher = Shrine::Attacher.retrieve(model: record, name: name, file: file_data)
     attacher.atomic_promote
-    attacher.transloadit_process(:video)
+    attacher.transloadit_process
     # ...
   rescue Shrine::AttachmentChanged, ActiveRecord::RecordNotFound
   end
@@ -144,7 +135,7 @@ When using [assembly notifications], the attacher data can be sent to the
 webhook via `:fields`:
 
 ```rb
-Attacher.transloadit_processor :video do
+Attacher.transloadit_processor do
   # ...
   assembly = transloadit.assembly(
     steps:      [ ... ],
@@ -175,20 +166,17 @@ post "/transloadit/video" do
   record_class, record_id, name, file_data = response["fields"]["attacher"].values
   record_class = Object.const_get(record_class)
 
+  attacher    = record_class.send(:"#{name}_attacher")
+  derivatives = attacher.transloadit_save(response["results"])
+
   begin
     record   = record_class.find(record_id)
     attacher = Shrine::Attacher.retrieve(model: record, name: name, file: file_data)
 
-    attacher.transloadit_save(:video, response)
-
+    attacher.merge_derivatives(derivatives)
     attacher.atomic_persist
   rescue Shrine::AttachmentChanged, ActiveRecord::RecordNotFound
-    unless attacher
-      attacher = record_class.send(:"#{name}_attacher")
-      attacher.transloadit_save(:video, response)
-    end
-
-    attacher.destroy(background: true) # delete orphaned files
+    attacher.destroy_attached # delete orphaned processed files
   end
 
   # return successful response for Transloadit
@@ -229,20 +217,20 @@ storage, you can skip promotion on the Shrine side:
 
 ```rb
 class VideoUploader < Shrine
-  Attacher.transloadit_processor :video do
+  Attacher.transloadit_processor do
     import = file.transloadit_import_step
     encode = transloadit_step "encode", "/video/encode", use: import
     thumbs = transloadit_step "thumbs", "/video/thumbs", use: import
     export = store.transloadit_export_step use: [import, encode, thumbs] # include original
 
-    assembly = transloadit.assembly(use: [import, encode, thumbs, export])
+    assembly = transloadit.assembly(steps: [import, encode, thumbs, export])
     assembly.create!
   end
 
-  Attacher.transloadit_saver :video do |response|
-    stored     = store.transloadit_file(response["results"]["import"])
-    transcoded = store.transloadit_file(response["results"]["encode"])
-    thumbnails = store.transloadit_files(response["results"]["thumbs"])
+  Attacher.transloadit_saver do |results|
+    stored     = store.transloadit_file(results["import"])
+    transcoded = store.transloadit_file(results["encode"])
+    thumbnails = store.transloadit_files(results["thumbs"])
 
     set(stored) # set promoted file
     merge_derivatives(transcoded: transcoded, thumbnails: thumbnails)
@@ -254,20 +242,17 @@ class PromoteJob
   def perform(record, name, file_data)
     attacher = Shrine::Attacher.retrieve(model: record, name: name, file: file_data)
 
-    response = attacher.transloadit_process(:video)
+    response = attacher.transloadit_process
     response.reload_until_finished!
 
     if response.error?
       # handle error
     end
 
-    original_file = attacher.file
-    attacher.transloadit_save(:video, response)
-
-    attacher.atomic_persist(original_file)
+    attacher.transloadit_save(response["results"])
+    attacher.atomic_persist attacher.uploaded_file(file_data)
   rescue Shrine::AttachmentChanged, ActiveRecord::RecordNotFound
-    # delete orphaned processed files (backgrounding plugin is recommended)
-    attacher.destroy(background: true) if attacher
+    attacher&.destroy_attached # delete orphaned processed files
   end
 end
 ```
@@ -297,7 +282,7 @@ the `:url` storage, and then upload them to your permanent storage:
 
 ```rb
 class VideoUploader < Shrine
-  Attacher.transloadit_processor :video do
+  Attacher.transloadit_processor do
     import = file.transloadit_import_step
     encode = transloadit_step "encode", "/video/encode", use: import
     thumbs = transloadit_step "thumbs", "/video/thumbs", use: import
@@ -307,10 +292,10 @@ class VideoUploader < Shrine
     assembly.create!
   end
 
-  Attacher.transloadit_saver :video do |response|
+  Attacher.transloadit_saver do |results|
     url        = shrine_class.new(:url)
-    transcoded = url.transloadit_file(response["results"]["encode"])
-    thumbnails = url.transloadit_files(response["results"]["thumbs"])
+    transcoded = url.transloadit_file(results["encode"])
+    thumbnails = url.transloadit_files(results["thumbs"])
 
     # results are uploaded to Transloadit's temporary storage
     transcoded #=> #<Shrine::UploadedFile @storage_key=:url @id="https://tmp.transloadit.com/..." ...>
@@ -322,14 +307,14 @@ class VideoUploader < Shrine
 end
 ```
 ```rb
-response = attacher.transloadit_process(:video)
+response = attacher.transloadit_process
 response.reload_until_finished!
 
 if response.error?
   # handle error
 end
 
-attacher.transloadit_save(:video, response)
+attacher.transloadit_save(response["results"])
 attacher.derivatives #=>
 # {
 #   transcoded: #<Shrine::UploadedFile storage_key=:store ...>,
@@ -549,10 +534,30 @@ file = uploader.transloadit_file(
   # ...
 )
 
+file #=> #<Shrine::UploadedFile @id="foo" storage_key=:store ...>
+
 file.storage #=> #<Shrine::Storage::S3>
 file.id      #=> "foo"
 ```
 
+You can use the plural `Shrine#transloadit_files` to convert an array of
+results:
+
+```rb
+files = uploader.transloadit_files [
+  { "url" => "https://my-bucket.s3.amazonaws.com/foo", ... },
+  { "url" => "https://my-bucket.s3.amazonaws.com/bar", ... },
+  { "url" => "https://my-bucket.s3.amazonaws.com/baz", ... },
+]
+
+files #=>
+# [
+#   #<Shrine::UploadedFile @id="foo" @storage_key=:store ...>,
+#   #<Shrine::UploadedFile @id="bar" @storage_key=:store ...>,
+#   #<Shrine::UploadedFile @id="baz" @storage_key=:store ...>,
+# ]
+```
+
 It will include basic metadata:
 
 ```rb
@@ -600,6 +605,48 @@ file = uploader.transloadit_file(
 file.id #=> "https://example.com/foo"
 ```
 
+## Instrumentation
+
+If the `instrumentation` plugin has been loaded, the `transloadit` plugin adds
+instrumentation around triggering processing.
+
+```rb
+# instrumentation plugin needs to be loaded *before* transloadit
+plugin :instrumentation
+plugin :transloadit
+```
+
+Calling the processor will trigger a `transloadit.shrine` event with the
+following payload:
+
+| Key          | Description                            |
+| :----        | :----------                            |
+| `:processor` | Name of the processor                  |
+| `:uploader`  | The uploader class that sent the event |
+
+A default log subscriber is added as well which logs these events:
+
+```
+Transloadit (1238ms) – {:processor=>:video, :uploader=>VideoUploader}
+```
+
+You can also use your own log subscriber:
+
+```rb
+plugin :transloadit, log_subscriber: -> (event) {
+  Shrine.logger.info JSON.generate(name: event.name, duration: event.duration, **event.payload)
+}
+```
+```
+{"name":"transloadit","duration":1238,"processor":"video","uploader":"VideoUploader"}
+```
+
+Or disable logging altogether:
+
+```rb
+plugin :transloadit, log_subscriber: nil
+```
+
 ## Contributing
 
 Tests are run with:

data/lib/shrine/plugins/transloadit.rb

@@ -37,7 +37,7 @@ class Shrine
       end
 
       module AttacherClassMethods
-        def transloadit_processor(name, &block)
+        def transloadit_processor(name = :default, &block)
           if block
             shrine_class.opts[:transloadit][:processors][name.to_sym] = block
           else
@@ -46,7 +46,7 @@ class Shrine
           end
         end
 
-        def transloadit_saver(name, &block)
+        def transloadit_saver(name = :default, &block)
           if block
             shrine_class.opts[:transloadit][:savers][name.to_sym] = block
           else
@@ -57,14 +57,19 @@ class Shrine
       end
 
       module AttacherMethods
-        def transloadit_process(name, *args)
+        def transloadit_process(name = :default, *args)
           processor = self.class.transloadit_processor(name)
           instrument_transloadit(name) do
             instance_exec(*args, &processor)
           end
         end
 
-        def transloadit_save(name, *args)
+        def transloadit_save(name = :default, *args)
+          unless name.respond_to?(:to_sym)
+            args.prepend(name)
+            name = :default
+          end
+
           saver = self.class.transloadit_saver(name)
           instance_exec(*args, &saver)
         end
@@ -147,19 +152,14 @@ class Shrine
             fail Error, "storage not supported: #{storage.inspect}"
           end
 
-          metadata = {
-            "filename"  => result.fetch("name"),
-            "size"      => result.fetch("size"),
-            "mime_type" => result.fetch("mime"),
-          }
-
-          # merge transloadit's meatadata, but don't let it override ours
-          metadata.merge!(result.fetch("meta")) { |k, v1, v2| v1 }
-
           self.class::UploadedFile.new(
             id:       id,
             storage:  storage_key,
-            metadata: metadata,
+            metadata: result.fetch("meta").merge(
+              "filename"  => result.fetch("name"),
+              "size"      => result.fetch("size"),
+              "mime_type" => result.fetch("mime"),
+            )
           )
         end
 

data/shrine-transloadit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-transloadit"
-  gem.version       = "1.0.0.beta"
+  gem.version       = "1.0.0"
 
   gem.required_ruby_version = ">= 2.2"
 
@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "*.gemspec"]
   gem.require_path = "lib"
 
-  gem.add_dependency "shrine", ">= 3.0.0.beta2", "< 4"
+  gem.add_dependency "shrine", ">= 3.0.0.beta3", "< 4"
   gem.add_dependency "transloadit", "~> 2.0"
 
   gem.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-transloadit
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta
+  version: 1.0.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0.beta3
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: 3.0.0.beta3
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -140,9 +140,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: