shrine-transloadit 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 598fedd796007106bdd2326f56bd2d7b1f4e56eb
-  data.tar.gz: 4b81b6377ac2fbe38d1ee87b77632791e2ddad2e
+  metadata.gz: 18fd0d46656fbf432fae2922e916d1e77cd3d9ba
+  data.tar.gz: 34a4619f1dc4b5672a00942a29917c73b5cb0171
 SHA512:
-  metadata.gz: e98531a56617650480632a49553633da208bac6f0a298f7b0106db7f9320c591e30020dfb52cd7dc48c23163d0ac1c7cbdc6303abdc09fc79c47d1e171a5c7e7
-  data.tar.gz: ae68d0319caefad44c01e5d73cb16a78fd7fa3343bca750a765a0ea68d00633ef5b611f65eed866655030517e82dddb77af3579570426d4023989d2be528e903
+  metadata.gz: c4bf1ba126d1b27db9fd2141b646f4189b6be7d2282179f0dae469f79001fc41d48ab6370a8b1e3807dc906099fb5d3d27e59da2a80f6071eb71d97d83d0538f
+  data.tar.gz: a1a579e0ea60d5b19920ad4216c1f94a73ad3d5effffa9fb27bb0c8dbf98acf91534905287353de8ef37475435d9521fc3aa57164494c3cc051112ca76581333

data/README.md

@@ -35,9 +35,11 @@ Shrine.storages = {
   store: Shrine::Storage::S3.new(prefix: "store", **s3_options),
 }
 
-Shrine.plugin :transloadit,
-  auth_key: "your transloadit key",
-  auth_secret: "your transloadit secret"
+class TransloaditUploader < Shrine
+  plugin :transloadit,
+    auth_key: "your transloadit key",
+    auth_secret: "your transloadit secret"
+end
 ```
 
 This setup assumes you're doing direct S3 uploads, but you can also do [direct
@@ -62,12 +64,16 @@ as a good baseline for your own implementation.
 
 ## Usage
 
+We loaded the `transloadit` plugin in a `TransloaditUploader` base uploader
+class, so that any uploaders that you want to do Transloadit processing with
+can just inherit from that class.
+
 Transloadit assemblies are built inside `#transloadit_process` method in your
 uploader, and you can use some convenient helper methods which the plugin
 provides.
 
 ```rb
-class MyUploader < Shrine
+class ImageUploader < TransloaditUploader # inherit from our Transloadit base uploader class
   def transloadit_process(io, context)
     resized = transloadit_file(io)
       .add_step("resize", "/image/resize", width: 800)
@@ -93,7 +99,7 @@ With Transloadit you can create multiple files in a single assembly, and this
 plugin allows you to leverage that in form of a hash of versions.
 
 ```rb
-class MyUploader < Shrine
+class ImageUploader < TransloaditUploader
   plugin :versions
 
   def transloadit_process(io, context)
@@ -114,10 +120,9 @@ Transloadit performs its processing asynchronously, and you can provide a URL
 where you want Transloadit to POST results of processing once it's finished.
 
 ```rb
-class MyUploader < Shrine
+class ImageUploader < TransloaditUploader
   def transloadit_process(io, context)
     # ...
-
     transloadit_assembly(files, notify_url: "http://myapp.com/webhooks/transloadit")
   end
 end
@@ -128,7 +133,8 @@ automatically save the results to the attachment column in Shrine's format.
 
 ```rb
 post "/webhooks/transloadit" do
-  Shrine::Attacher.transloadit_save(params)
+  TransloaditUploader::Attacher.transloadit_save(params)
+  # return 200 status
 end
 ```
 
@@ -142,6 +148,24 @@ on upload, along with a [jQuery plugin] for easy integration. Generally you
 only want to do some light processing on direct uploads, and without any
 exporting, so that you have better control over your Transloadit bandwidth.
 
+```js
+// Using https://github.com/transloadit/jquery-sdk
+$("#upload-form").transloadit({
+  wait: true,
+  params: {
+    auth: {key: "YOUR_TRANSLOADIT_AUTH_KEY"},
+    steps: {
+      extract_thumbnails: {
+        robot:  "/video/thumbs",
+        use:    ":original",
+        count:  8,
+        format: "png",
+      }
+    }
+  }
+});
+```
+
 When direct upload finishes, Transloadit returns information about the uploaded
 file(s), one of which is a temporary URL to the file. You want to save this URL
 as cached attachment, so that you can display it to the user and use it for
@@ -175,6 +199,9 @@ representation, using the URL as the "id":
 }
 ```
 
+If the result of direct upload processing are multiple files (e.g. video
+thumbnails), you need to assign them to individual records.
+
 See the **[demo app]** for a complete implementation of direct uploads.
 
 ### Templates
@@ -186,25 +213,31 @@ Here is an example where the whole processing is defined inside a template,
 and we just set the location of the imported file.
 
 ```rb
-# Your saved template
+# Your Transloadit template saved as "my_template"
 {
   steps: {
-    import: {
-      robot: "/http/import",
-      url: "..."
-    },
     resize: {
       robot: "/image/resize",
-      use: "import",
+      use: "import", # the "import" step will be passed in
       width: 800
+    },
+    export: {
+      robot: "/s3/store",
+      use: "resize",
+      bucket: "YOUR_AWS_BUCKET",
+      key: "YOUR_AWS_KEY",
+      secret: "YOUR_AWS_SECRET",
+      bucket_region: "YOUR_AWS_REGION",
+      path: "videos/${unique_prefix}/${file.url_name}"
     }
   }
 }
 ```
 ```rb
-class MyUploader < Shrine
+class ImageUplaoder < TransloaditUploader
   def transloadit_process(io, context)
-    transloadit_assembly("my_template", steps: {import: {url: io.url}})
+    import = transloadit_import_step("import", io)
+    transloadit_assembly("my_template", steps: [import])
   end
 end
 ```
@@ -212,18 +245,24 @@ end
 ### Backgrounding
 
 Even though submitting a Transloadit assembly doesn't require any uploading, it
-still does two HTTP requests, so you might want to put it into a background job.
-This plugin naturally hooks onto Shrine's backgrounding plugin:
+still does two HTTP requests, so you might want to put them into a background
+job. You can configure that in the `TransloaditUploader` base uploader class:
 
 ```rb
-Shrine::Attacher.promote { |data| TransloaditJob.perform_async(data) }
+class TransloaditUploader < Shrine
+  plugin :transloadit,
+    auth_key: "your transloadit key",
+    auth_secret: "your transloadit secret"
+
+  Attacher.promote { |data| TransloaditJob.perform_async(data) }
+end
 ```
 ```rb
 class TransloaditJob
   include Sidekiq::Worker
 
   def perform(data)
-    Shrine::Attacher.transloadit_process(data)
+    TransloaditUploader::Attacher.transloadit_process(data)
   end
 end
 ```
@@ -324,9 +363,9 @@ your steps, it only requires you to return an instance of
 `Transloadit::Assembly`.
 
 ```rb
-class MyUploader < Shrine
+class MyUploader < TransloaditUploader
   def transloadit_process(io, context)
-    # build options
+    # ...
     transloadit #=> #<Transloadit>
     transloadit.assembly(options)
   end
@@ -337,7 +376,7 @@ The import/export helper methods simply generate a `Transloadit::Step` object,
 and you can pass additional options:
 
 ```rb
-class MyUploader < Shrinee
+class MyUploader < TransloaditUploader
   def transloadit_process(io, context)
     transloadit_import_step("import", io)             #=> #<Transloadit::Step>
     transloadit_export_step("export", path: "mypath") #=> #<Transloadit::Step>
@@ -355,7 +394,7 @@ as an external service cannot access your localhost. In this case you can just
 do polling:
 
 ```rb
-class MyUploader < Shrine
+class MyUploader < TransloaditUploader
   def transloadit_process(io, context)
     # ...
 
@@ -376,15 +415,12 @@ class TransloaditJob
   include Sidekiq::Worker
 
   def perform(data)
-    attacher = Shrine::Attacher.transloadit_process(data)
+    attacher = TransloaditUploader::Attacher.transloadit_process(data)
 
     # Webhooks won't work in development, so we can just use polling.
     unless ENV["RACK_ENV"] == "production"
       response = attacher.get.transloadit_response
-      until response.finished?
-        sleep 1
-        response.reload!
-      end
+      response.reload_until_finished!
       attacher.transloadit_save(response.body)
     end
   end

data/lib/shrine/plugins/transloadit.rb

@@ -81,7 +81,7 @@ class Shrine
           assembly = store.transloadit_process(cached_file, context)
           assembly.options[:fields] ||= {}
           assembly.options[:fields]["attacher"] = self.dump.merge("attachment" => cached_file.to_json)
-          response = assembly.submit!
+          response = assembly.create!
           raise Error, "#{response["error"]}: #{response["message"]}" if response["error"]
           cached_file.metadata["transloadit_response"] = response.body.to_json
           swap(cached_file) or _set(cached_file)

data/shrine-transloadit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-transloadit"
-  gem.version       = "0.4.1"
+  gem.version       = "0.4.2"
 
   gem.required_ruby_version = ">= 2.1"
 
@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_path = "lib"
 
   gem.add_dependency "shrine", "~> 2.2"
-  gem.add_dependency "transloadit", "~> 1.2"
+  gem.add_dependency "transloadit", "~> 2.0"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-transloadit
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-14 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement