transloadit-rails 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e6206349f63f19d1cc57398c83d02453bc4099b
-  data.tar.gz: 89834352b9f3a951cb358b6aa2e057d57a232fbe
+SHA256:
+  metadata.gz: a5465ec8511fb1f87cb094eec15a805b43b2ccf5e3a9bb13d80cab549bf2d6e0
+  data.tar.gz: b0776286a6bcb7957f0f8fc704616f1ce5b143582fd32cb6de41ddafed43fbd7
 SHA512:
-  metadata.gz: 68fa360c648985223dc810eaa36fd228d094673b3160e640e6a9cb064d5d0ddf663d9584328649968604e02dcbe3cf00c8f6ad866dd6882bbd96fe07668a8c00
-  data.tar.gz: 54472e36bf9fd788f69ac436ad86839c3344a30d672f6fd5b46903a06792011af13441d3e2285a530b568eae92032c7502ea9bd0bbf807ba6610759a6a73a178
+  metadata.gz: ea0e365469f83efc42a1de4e9c2a489f80c170b28c2a49a7ed1f8b0cb8a43b637b58b2f2b7803fb485f140f729e5ae5add8dc3c29ffda3d9a41cdddddc1cb6f1
+  data.tar.gz: 0037fc481dc8272cef796a60739ef5d17f7b4a6e80211d7fbcc82f734f1e64300c12e0ae752544b473f5ab0d9ee4149238bd29cfbf0946c14f801a7a22737921

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 3.0.0 / 2021-02-12
+* Update default jQuery version to v3
+
 ### 2.0.0 / 2016-12-03 ###
 
 * Drop support for EOL'd Ruby 1.9.x and Ruby 2.0, please use version 1.2.0 if you need support for older

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2016 Transloadit Ltd.
+Copyright (c) 2021 Transloadit Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -1,17 +1,16 @@
 [![Build Status](https://travis-ci.org/transloadit/rails-sdk.png?branch=master)](https://travis-ci.org/transloadit/rails-sdk)
 
-# transloadit-rails
+## rails-sdk
 
-Fantastic file uploading for your Rails application.
+A **Rails** Integration for [Transloadit](https://transloadit.com)'s file uploading and encoding service
 
-## Description
+## Intro
 
-This is the official Rails gem for [Transloadit](http://transloadit.com). It allows
-you to automate uploading files through the Transloadit REST API.
+[Transloadit](https://transloadit.com) is a service that helps you handle file uploads, resize, crop and watermark your images, make GIFs, transcode your videos, extract thumbnails, generate audio waveforms, and so much more. In short, [Transloadit](https://transloadit.com) is the Swiss Army Knife for your files.
 
-This gem provides browser integration. If you're looking to do video transcoding / image resizing
-initiated from your own serverside Ruby code, please use the [ruby-sdk](https://github.com/transloadit/ruby-sdk)
-instead.
+This is a **Rails** SDK to make it easy to talk to the [Transloadit](https://transloadit.com) REST API.
+
+*This gem provides browser integration. If you're looking to integrate Transloadit from your own serverside Ruby code checkout the [ruby-sdk](https://github.com/transloadit/ruby-sdk).*
 
 ## Install
 
@@ -19,19 +18,16 @@ instead.
 $ gem install transloadit-rails
 ```
 
-## Getting started
-
-To get started, you need to add the 'transloadit-rails' gem to your Rails
-project's Gemfile.
+or add the `transloadit-rails` Gem to your Rails project's `Gemfile` and update your bundle.
 
 ```bash
 $ echo "gem 'transloadit-rails'" >> Gemfile
+$ bundle install
 ```
 
-Now update your bundle and run the generator.
+After installation you need to run the `transloadit:install` generator to complete the setup.
 
 ```bash
-$ bundle install
 $ rails g transloadit:install
 ```
 
@@ -44,13 +40,13 @@ the upload forms.
 
 ```yaml
 auth:
-  key     : '4d2e...'
-  secret  : '8ad1...' # optional, but highly recommended
+  key     : 'TRANSLOADIT_KEY'
+  secret  : 'TRANSLOADIT_SECRET' # optional, but highly recommended
   duration: 1800      # 30 minute validity period for signed upload forms
 
 templates:
   # template identified by template_id
-  s3_store: '4d2e...'
+  s3_store: 'YOUR_TEMPLATE_ID'
 
   # template defined inline
   image_resize:
@@ -73,42 +69,28 @@ exactly in order to be used.
 ```yaml
 development:
   auth:
-    key     : '4d2e...'
+    key     : 'TRANSLOADIT_KEY'
     ...
 
   templates:
-    s3_store: '4d2e...'
+    s3_store: 'YOUR_TEMPLATE_ID'
     ...
 
 production:
   auth:
-    key     : '123a...'
+    key     : 'TRANSLOADIT_KEY'
     ...
 
   templates:
-    s3_store: '789b...'
-    ...
-```
-
-## Support IE6 or jQuery < 1.9
-
-If you have to support IE6 and use a jQuery version below 1.9, you have to change
-the jquery_sdk_version in the config to 'v1.0.0':
-
-```yaml
-production:
-  jquery_sdk_version: 'v1.0.0'
-  auth:
+    s3_store: 'YOUR_TEMPLATE_ID'
     ...
 ```
 
 ## Usage
 
-Refer to the templates with the `transloadit` helper. This requires jQuery,
-and loads the [Transloadit jQuery plugin](https://github.com/transloadit/jquery-sdk).
-It also uses JavaScript to ensure your form is encoded as `multipart/form-data`.
+Refer to the <dfn>Templates</dfn> (which you have set in the [config](https://github.com/transloadit/rails-sdk/#configuration)) with the `transloadit` helper.
 
-```erb
+```html
 <%= form_for :upload, :html => { :id => 'upload' } do |form| %>
   <%= transloadit :s3_store %>
   <%= form.label      :file, 'File to upload' %>
@@ -116,11 +98,16 @@ It also uses JavaScript to ensure your form is encoded as `multipart/form-data`.
   <%= form.submit %>
 <% end %>
 
+<%= javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js' %>
 <%= transloadit_jquerify :upload %>
 ```
 
-If you want to use the automatic transload parameter decoding, you have to include
-the Transloadit::Rails::ParamsDecoder module into your controller
+This requires jQuery, and loads the [Transloadit jQuery plugin](https://github.com/transloadit/jquery-sdk/). Be sure to exclude the `<%= javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js' %>` tag if you already have jQuery loaded.
+
+JavaScript also ensures your form is encoded as `multipart/form-data`.
+
+If you want to use the automatic `transloadit` parameter decoding, you have to include
+the `Transloadit::Rails::ParamsDecoder` module into your controller
 
 ```ruby
 class YourController
@@ -128,7 +115,10 @@ class YourController
 end
 ```
 
-that way the param[:transloadit] is automatically decoded for you, if it exists
+that way the `param[:transloadit]` is automatically decoded for you, if it exists
+
+**Note** Since it's still very young, the Transloadit Rails SDK does not include batteries for it yet, but
+if you're looking for a jQuery-less integration, check out [Uppy](https://transloadit.com/docs/#uppy), our next-gen file uploader for the web.
 
 ## Tutorial
 
@@ -255,6 +245,10 @@ Then go to http://localhost:3000/uploads/new, and upload an image. If you did
 everything right, you should see the uploaded and resized file as soon as the
 upload finishes.
 
+## Example
+
+An example rails application following the [tutorial above](https://github.com/transloadit/rails-sdk/#tutorial) can be found in the [examples](https://github.com/transloadit/rails-sdk/tree/master/examples) directory.
+
 ## Testing
 
 ### RSpec request specs
@@ -301,6 +295,18 @@ if you need support for older Ruby versions.
 
 Testing against these versions is performed automatically by [Travis CI](https://travis-ci.org/transloadit/rails-sdk).
 
+### Support IE6 or jQuery < 1.9
+
+If you have to support IE6 and use a jQuery version below 1.9, you have to change
+the jquery_sdk_version in the config to 'v1.0.0':
+
+```yaml
+production:
+  jquery_sdk_version: 'v1.0.0'
+  auth:
+    ...
+```
+
 ## License
 
 MIT, see [LICENSE](LICENSE)

data/lib/templates/transloadit/transloadit.yml

@@ -3,7 +3,7 @@ development:
   # https://transloadit.com/blog/2013/02/transloadit-javascript-plugin-and-jquery-1-9
   # defaults to latest
   # use "v1.0.0" if you need IE6 support (using jQuery < 1.9)
-  jquery_sdk_version: 'v2-latest'
+  jquery_sdk_version: 'v3-latest'
   auth:
     key     : 'YOUR_KEY'
     secret  : 'YOUR_SECRET' # this is optional, but highly recommended, https://transloadit.com/docs/authentication
@@ -26,7 +26,7 @@ production:
   # https://transloadit.com/blog/2013/02/transloadit-javascript-plugin-and-jquery-1-9
   # defaults to latest
   # use "v1.0.0" if you need IE6 support (using jQuery < 1.9)
-  jquery_sdk_version: 'v2-latest'
+  jquery_sdk_version: 'v3-latest'
   auth:
     key     : 'YOUR_KEY'
     secret  : 'YOUR_SECRET' # this is optional, but highly recommended, https://transloadit.com/docs/authentication

data/lib/transloadit/rails/version.rb

@@ -1,5 +1,5 @@
 class Transloadit
   module Rails
-    VERSION = '2.0.0'
+    VERSION = '3.0.0'
   end
 end

data/lib/transloadit/rspec/request_spec_helper.rb

@@ -16,8 +16,8 @@ class Transloadit
           ActiveSupport::JSON.decode params_json
         )
 
-        controller.any_instance.stub(:transloadit?).and_return(true)
-        controller.any_instance.stub(:transloadit_params).and_return(hash)
+        allow_any_instance_of(controller).to receive(:transloadit?).and_return(true)
+        allow_any_instance_of(controller).to receive(:transloadit_params).and_return(hash)
       end
     end
   end

data/transloadit-rails.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |gem|
 
   gem.required_rubygems_version = '>= 2.1.0'
   gem.required_ruby_version     = '>= 2.1.0'
-  gem.rubyforge_project         = 'transloadit-rails'
 
-  gem.files         = `git ls-files`.split("\n")
+  gem_ignored_files = `git ls-files examples`.split("\n")
+  gem.files         = `git ls-files`.split("\n") - gem_ignored_files
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths = %w{ lib }
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: transloadit-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Stephen Touset
 - Robin Mehner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-03 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: transloadit
@@ -150,7 +150,7 @@ homepage: http://github.com/transloadit/rails-sdk/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,12 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.1.0
 requirements: []
-rubyforge_project: transloadit-rails
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Official Rails gem for Transloadit
-test_files:
-- test/generators/transloadit/test_install_generator.rb
-- test/test_helper.rb
-has_rdoc: 
+test_files: []