shrine-transloadit 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f101f3b58938e3d62d0af2ae6dcd3d7e49d3623
-  data.tar.gz: 8314af9c2984e0ddf629bb190a499f8bc7d84280
+  metadata.gz: 4f6c9f75eb5ae136a186f42f8b3e255b37e75922
+  data.tar.gz: e25b2ed74f6e742c82539a86b8f9814497978947
 SHA512:
-  metadata.gz: 9f9ab0417eb5087a1d5c3652f8002781b45e0123053ad47b38856bd05755bb55e32585caf22985bb2b9796fcb1165d3fd00af7c36fcdc65b815a614bcc1a39e9
-  data.tar.gz: 000c35dbf448f1308e4f99f1de673ef71bb9ef6de22bd9b710314277608c10de156c5a74cc94f4bbc5164ea88af84b69dd8afd139d1906484ae95a24629d4b73
+  metadata.gz: f0279efcd3b9de0a223f258e03cb1689490d9f84225ce43fce35b9b7f8e3cd78514577bdcfe09d40e252b50e69a3135cf0be575ec32e2d6a7dd2217933988598
+  data.tar.gz: bb661843d2b3886a66aaca015d98eb6caef0317b1a6171d3581b008c0d2fbec1f5249ec9671d36b6b8c0ce0447ab98e0bf29a0c912e2ded7014a164a41ae34d8

data/README.md

@@ -8,40 +8,41 @@ to various file storage services.
 
 ## Setup
 
-While Transloadit is able to export processed files to [many storage
-services], this plugin currently supports only Amazon S3 (just because there
-are no Shrine integrations written for other services on that list yet).
+While Transloadit is able to export processed files to [many storage services],
+this plugin currently supports only Amazon S3 (just because there are no Shrine
+integrations written for other services on that list yet). You can just add
+shrine-transloadit to your current setup:
 
 ```rb
+gem "shrine"
+gem "aws-sdk" # for Amazon S3
 gem "shrine-transloadit"
-gem "aws-sdk"
 ```
 
 ```rb
 require "shrine"
 require "shrine/storage/s3"
 
-Shrine.plugin :transloadit,
-  auth_key:    "your transloadit key",
-  auth_secret: "your transloadit secret"
-
-Shrine.storages[:store] = Shrine::Storage::S3.new(
-  access_key_id: "xyz",
-  secret_access_key: "abc",
+s3_options = {
+  bucket: "my-bucket",
   region: "my-region",
-  bucket: "my-app",
-)
-```
+  access_key_id: "abc",
+  secret_access_key: "xyz",
+}
 
-```rb
-post "/webhooks/transloadit" do
-  Shrine::Attacher.transloadit_save(params)
-end
+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"
 ```
 
-This setup assumes you want to do [direct uploads](#direct-uploads) to
-Transloadit. This is completely optional, the plugin will work equally well
-with whatever your `:cache` storage is.
+This setup assumes you're doing direct S3 uploads, but you can also do [direct
+uploads to Transloadit], or just use any other `:cache` storage which provides
+URLs for uploaded files.
 
 ## How it works
 
@@ -115,9 +116,22 @@ 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
-file(s). The default `:cache` storage allows you to store Transloadit's
-temporary file URL as an attachment. This means that you can use the following
-JavaScript to convert Transloadit's data hash into Shrine's format:
+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
+further Transloadit processing. You can do that using [shrine-url]:
+
+```rb
+gem "shrine-url"
+```
+
+```rb
+require "shrine/storage/url"
+Shrine.storages[:cache] = Shrine::Storage::Url.new
+```
+
+Now when you obtain results from finished direct uploads on the client-side,
+you need to transform the Transloadit hash into Shrine's uploaded file
+representation, using the URL as the "id":
 
 ```js
 {
@@ -407,3 +421,5 @@ $ bundle exec rake test
 [templates]: https://transloadit.com/docs/#templates
 [jQuery plugin]: https://github.com/transloadit/jquery-sdk
 [demo app]: /demo
+[direct uploads to Transloadit]: #direct-uploads
+[shrine-url]: https://github.com/janko-m/shrine-url

data/lib/shrine/plugins/transloadit.rb

@@ -21,11 +21,6 @@ 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] ||= (
-          require "shrine/storage/url"
-          Shrine::Storage::Url.new
-        )
-
         uploader.opts[:backgrounding_promote] ||= proc { transloadit_process }
       end
 

data/shrine-transloadit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = "shrine-transloadit"
-  gem.version       = "0.3.0"
+  gem.version       = "0.4.0"
 
   gem.required_ruby_version = ">= 2.1"
 
@@ -15,7 +15,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "shrine", "~> 2.1"
   gem.add_dependency "transloadit", "~> 1.2"
-  gem.add_dependency "shrine-url"
 
   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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrine
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: shrine-url
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement