shrine-transloadit 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9ad060395c4432e137702840eba7f23eef980b5
-  data.tar.gz: 983a7aaf98794573d4f946fe14d0014162b02bfd
+  metadata.gz: 103994ecec1d21c32779635c5a44fa5e9c6bdf87
+  data.tar.gz: 2d8a3422d5fbc6905240915ddc75ff0bc7315d9f
 SHA512:
-  metadata.gz: 48003055afa7b725f0f42213daf2dedb6ecf91d03f8c5805921b0ff57953202aa0a8463300a40246cb1b0984eda816972cd8a0af2b99676188ac62bd18e010c0
-  data.tar.gz: a4aec56c9856366f4d8fb87c00ce6d6ff8f91750033ed6c0aba48b241533358c6bc5af7b4930f7bda463ebf06ff35322de5fc948d229597b8e855808439d4bdc
+  metadata.gz: a85785e545c36594dedc6897e89615970f017eba1f2364cc9a9de62909e761c2bab4d752c8fbe9574766ed29f7f65886ce6d28d967c098a3059f95f74be05a0f
+  data.tar.gz: bb0dd002e5156cc62aec52df497655451d5cf3abba75f084a6701a4ac0dfa6f86bec971648c0d904fc481dc923f6cf3447807f68972b86caa03518746edb820f

data/README.md

@@ -21,28 +21,26 @@ gem "aws-sdk"
 require "shrine"
 require "shrine/storage/s3"
 
-s3_options = {
+Shrine.storages[:store] = Shrine::Storage::S3.new(
   access_key_id: "xyz",
   secret_access_key: "abc",
   region: "my-region",
   bucket: "my-app",
-}
-
-Shrine.storages = {
-  cache: Shrine::Storage::S3.new(prefix: "cache", **s3_options),
-  store: Shrine::Storage::S3.new(prefix: "store", **s3_options),
-}
+)
 
 Shrine.plugin :transloadit,
   auth_key:    "your transloadit key",
   auth_secret: "your transloadit secret"
 ```
+
 ```rb
 post "/webhooks/transloadit" do
   Shrine::Attacher.transloadit_save(params)
 end
 ```
 
+With this setup you can do [direct uploads](#direct-uploads) to Transloadit.
+
 ## How it works
 
 Transloadit works in a way that you create an "assembly", which contains all
@@ -56,6 +54,9 @@ a URL to the route in your app where you'd like Transloadit to POST the results
 of processing. Then you can call the plugin again in the route to save the
 results to your attachment column.
 
+The **[demo app]** shows a complete implementation of this flow, and can serve
+as a good baseline for your own implementation.
+
 ## Usage
 
 Transloadit assemblies are built inside `#transloadit_process` method in your
@@ -209,6 +210,36 @@ response.reload!
 response.finished? #=> true
 ```
 
+### Direct uploads
+
+Transloadit supports direct uploads, allowing you to do additional processing
+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.
+
+When direct upload finishes, Transloadit returns information about the uploaded
+files, including a temporary URL and useful metadata. You'll want to store both
+to the database, URL you will need for additional processing after the record
+is saved. This is the JavaScript needed to convert Transloadit's data hash into
+Shrine's format:
+
+```js
+{
+  id: data['url'], // we save the URL
+  storage: 'cache',
+  metadata: {
+    size: data['size'],
+    filename: data['name'],
+    mime_type: data['mime'],
+    width: data['meta'] && data['meta']['width'],
+    height: data['meta'] && data['meta']['height'],
+    transloadit: data['meta'],
+  }
+}
+```
+
+See the **[demo app]** for a complete implementation of direct uploads.
+
 ### Import & Export
 
 Every `TransloaditFile` needs to have an import and an export step. This plugin
@@ -335,7 +366,7 @@ $ bundle exec rake test
 
 ## License
 
-[MIT](LICENSE.txt)
+[MIT](/LICENSE.txt)
 
 [Shrine]: https://github.com/janko-m/shrine
 [Transloadit]: https://transloadit.com/
@@ -343,3 +374,5 @@ $ bundle exec rake test
 [transloadit gem]: https://github.com/transloadit/ruby-sdk
 [robot and arguments]: https://transloadit.com/docs/conversion-robots/
 [templates]: https://transloadit.com/docs/#templates
+[jQuery plugin]: https://github.com/transloadit/jquery-sdk
+[demo app]: /demo

data/lib/shrine/plugins/transloadit.rb

@@ -13,6 +13,7 @@ class Shrine
         raise Error, "The :auth_key is required for transloadit plugin" if uploader.opts[:transloadit_auth_key].nil?
         raise Error, "The :auth_secret is required for transloadit plugin" if uploader.opts[:transloadit_auth_secret].nil?
 
+        uploader.storages[:cache] ||= UrlStorage.new
         uploader.opts[:backgrounding_promote] ||= proc { transloadit_process }
       end
 
@@ -260,6 +261,12 @@ class Shrine
           @steps.any? && @steps.last.robot.end_with?("/store")
         end
       end
+
+      class UrlStorage
+        def url(id, **options)
+          id
+        end
+      end
     end
 
     register_plugin(:transloadit, Transloadit)

data/shrine-transloadit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-transloadit"
-  gem.version       = "0.1.0"
+  gem.version       = "0.1.1"
 
   gem.required_ruby_version = ">= 2.1"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shrine-transloadit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine