transloadit-rails 0.9.0

data/.gitignore

@@ -0,0 +1,11 @@
+.bundle
+.rvmrc
+.yardoc
+
+Gemfile.lock
+
+coverage
+doc
+pkg
+
+test/tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,59 @@
+# transloadit-rails
+
+Fantastic file uploading for your Rails application.
+
+## Description
+
+This is the official Rails gem for [Transloadit](transloadit.com). It allows
+you to automate uploading files through the Transloadit REST API.
+
+## Install
+
+    gem install transloadit
+
+## Getting started
+
+To get started, you need to add the 'transloadit-rails' gem to your Rails
+project's Gemfile.
+
+    gem 'transloadit-rails'
+
+Now update your bundle and run the generator.
+
+    $ bundle install
+    $ rails g transloadit:install
+
+## Configuration
+
+Edit `config/transloadit.yml`. It has an `auth` section for your transloadit
+credentials and a `templates` section to define or refer to existing
+templates.
+
+    auth:
+      key   : '4d2e...'
+      secret: '8ad1...' # optional, but highly recommended
+    
+    templates:
+        # template identified by template_id
+        s3_store: '4d2e...'
+        
+        # template defined inline
+        image_resize:
+          steps:
+            resize:
+              robot : '/image/resize'
+              width : 320
+              height: 200
+
+## Usage
+
+Refer to the templates with the `transloadify` 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`.
+
+    <%= form_for :thing, :html => { :id => 'upload' } do |form| %>
+      <%= form.transloadit :s3_store %>
+      <%= form.file_field :file, 'File to upload' %>
+    <% end %>
+    
+    <%= transloadit_jquerify :upload %>

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+RUBIES = %w{ 1.9.2 1.8.7 1.8.6 rbx-1.2.0 }
+
+GEMSPEC = 'transloadit-rails.gemspec'
+
+spec = eval open(GEMSPEC).read
+Rake::GemPackageTask.new(spec) do |gem|
+  gem.need_tar = true
+end
+
+Rake::TestTask.new do |test|
+  test.libs   << 'test'
+  test.pattern = 'test/**/test_*.rb'
+end
+
+namespace :test do
+  begin
+    `rvm -v` # raise an exception if RVM isn't installed
+    
+    desc 'Run tests against all supported Rubies'
+    task :multiruby do
+      system "rvm #{RUBIES.join(',')} ruby bundle exec rake -s test"
+      
+      # clean up after Rubinius
+      require 'pathname'
+      Pathname.glob('**/*.rbc').each {|path| path.unlink }
+    end
+    
+    namespace :multiruby do
+      desc 'Prepare supported rubiesfor testing'
+      task :setup do
+        warn 'Preparing multiruby. This may take awhile...'
+        
+        # create gemsets, install bundler, bundle
+        RUBIES.each {|ruby| system "rvm #{ruby} gemset create transloadit" }
+        system "rvm #{RUBIES.join(',')} gem install bundler --no-ri --no-rdoc"
+        system "rvm #{RUBIES.join(',')} ruby bundle install"
+      end
+    end
+  rescue Errno::ENOENT
+    desc 'You need `rvm` installed to test against multiple Rubies'
+    task :multiruby
+  end
+end
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  
+  YARD::Rake::YardocTask.new :doc do |yard|
+    yard.options = %w{
+      --title  Transloadit Rails
+      --readme README.md
+      --markup rdoc
+    }
+  end
+rescue
+  desc 'You need the `yard` gem to generate documentation'
+  task :doc
+end

data/app/helpers/transloadit_helper.rb

@@ -0,0 +1,18 @@
+module TransloaditHelper  
+  #
+  # Enables the jQuery integration for Transloadit, and ensures the form is
+  # marked with an encoding type of `multipart/form-data`.
+  #
+  def transloadit_jquerify(id, options = {})
+    javascript_tag %{
+      $(document).ready(function() {
+        var script = '#{javascript_path('jquery.transloadit2.js')}';
+        
+        $.getScript(script, function() {
+          $('##{id}').attr('enctype', 'multipart/form-data');
+          $('##{id}').transloadit(#{options.to_json});
+        });
+      });
+    }
+  end
+end

data/lib/generators/transloadit/install_generator.rb

@@ -0,0 +1,17 @@
+require 'transloadit/rails'
+require 'rails/generators'
+
+class Transloadit::Generators::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../../../templates/transloadit', __FILE__)
+  
+  desc %{Installs the Transloadit jQuery plugin and creates the config file}
+  
+  def copy_configuration
+    template 'transloadit.yml', 'config/transloadit.yml'
+  end
+  
+  def copy_jquery_plugin
+    get 'http://assets.transloadit.com/js/jquery.transloadit2.js',
+      'public/javascripts/jquery.transloadit2.js'
+  end
+end

data/lib/templates/transloadit/transloadit.yml

@@ -0,0 +1,5 @@
+auth:
+  key   :
+  secret:
+
+templates:

data/lib/transloadit-rails.rb

@@ -0,0 +1 @@
+require 'transloadit/rails'

data/lib/transloadit/generators.rb

@@ -0,0 +1,5 @@
+require 'transloadit/rails'
+
+module Transloadit::Generators
+  autoload :InstallGenerator, 'generators/transloadit/install_generator'
+end

data/lib/transloadit/rails.rb

@@ -0,0 +1,56 @@
+require 'transloadit'
+require 'transloadit/generators'
+require 'rails'
+
+class Transloadit::Rails < Rails::Engine
+  autoload :FormHelper, 'transloadit/rails/form_helper'
+  
+  config.to_prepare do
+    # add the two helpers to the view stack
+    ApplicationController.helper TransloaditHelper
+    
+    class ActionView::Helpers::FormBuilder
+      include Transloadit::Rails::FormHelper
+    end
+  end
+  
+  initializer 'transloadit.configure' do |app|
+    # preload the contents of the configuration file.
+    app.root.join('config/transloadit.yml').open do |file|
+      self.class.config = YAML.load(file)
+    end rescue nil
+  end
+  
+  class << self
+    attr_accessor :config
+  end
+  
+  #
+  # Returns the Transloadit authentication object.
+  #
+  def self.transloadit
+    Transloadit.new(
+      :key    => self.config['auth']['key'],
+      :secret => self.config['auth']['secret']
+    )
+  end
+  
+  #
+  # Creates an assembly for the named template.
+  #
+  def self.template(name, options = {})
+    template = self.config['templates'][name.to_s]
+    
+    self.transloadit.assembly case template
+      when String then { :template_id => template }.merge(options)
+      when Hash   then template                    .merge(options)
+    end
+  end
+  
+  #
+  # Signs a request to the Transloadit API.
+  #
+  def self.sign(params)
+    Transloadit::Request.send :_hmac, self.transloadit.secret, params
+  end
+end

data/lib/transloadit/rails/form_helper.rb

@@ -0,0 +1,15 @@
+require 'transloadit/rails'
+
+module Transloadit::Rails::FormHelper
+  #
+  # Inserts hidden fields specifying and signing the template for Transloadit
+  # to process.
+  #
+  def transloadit(template, options = {})
+    params    = Transloadit::Rails.template(template, options).to_json
+    signature = Transloadit::Rails.sign(params)
+    
+    @template.hidden_field_tag(:params,    params,    :id => nil) +
+    @template.hidden_field_tag(:signature, signature, :id => nil)
+  end
+end

data/lib/transloadit/rails/version.rb

@@ -0,0 +1,5 @@
+require 'transloadit/rails'
+
+class Transloadit::Rails
+  VERSION = '0.9.0'
+end

data/test/generators/transloadit/test_install_generator.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests Transloadit::Generators::InstallGenerator
+  destination File.expand_path('../../../tmp', __FILE__)
+  
+  setup do
+    prepare_destination
+  end
+  
+  test 'the jQuery plugin is installed' do
+    run_generator
+    
+    assert_file 'public/javascripts/jquery.transloadit2.js'
+  end
+  
+  test 'the Transloadit config file is installed' do
+    run_generator
+    
+    assert_file 'config/transloadit.yml' do |contents|
+      assert_match /auth/,      contents
+      assert_match /templates/, contents
+    end
+  end
+  
+  test 'the namespace is transloadit:install' do
+    assert_equal 'transloadit:install', generator_class.namespace
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+# require 'simplecov'
+# 
+# SimpleCov.start { add_filter '/test/' }
+
+require 'minitest/autorun'
+require 'transloadit/rails'
+
+require 'rails/test_help'
+require 'rails/generators/test_case'

data/transloadit-rails.gemspec

@@ -0,0 +1,33 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'transloadit/rails/version'
+
+Gem::Specification.new do |gem|
+  gem.name     = 'transloadit-rails'
+  gem.version  = Transloadit::Rails::VERSION
+  gem.platform = Gem::Platform::RUBY
+  
+  gem.authors  = %w{ Stephen Touset }
+  gem.email    = %w{ stephen@touset.org }
+  gem.homepage = 'http://github.com/transloadit/rails-sdk/'
+  
+  gem.summary     = 'Official Rails gem for Transloadit'
+  gem.description = 'The transloadit-rails gem allows you to automate uploading files through the Transloadit REST API'
+  
+  gem.required_rubygems_version = '>= 1.3.6'
+  gem.rubyforge_project         = 'transloadit-rails'
+  
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = %w{ lib }
+  
+  gem.add_dependency 'transloadit'
+  gem.add_dependency 'rails', '~> 3'
+  
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest' # needed for < 1.9.2
+  gem.add_development_dependency 'simplecov'
+  
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'rdiscount' # for YARD rdoc formatting
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: transloadit-rails
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Stephen
+- Touset
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: transloadit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: The transloadit-rails gem allows you to automate uploading files through the Transloadit REST API
+email: 
+- stephen@touset.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- app/helpers/transloadit_helper.rb
+- lib/generators/transloadit/install_generator.rb
+- lib/templates/transloadit/transloadit.yml
+- lib/transloadit-rails.rb
+- lib/transloadit/generators.rb
+- lib/transloadit/rails.rb
+- lib/transloadit/rails/form_helper.rb
+- lib/transloadit/rails/version.rb
+- test/generators/transloadit/test_install_generator.rb
+- test/test_helper.rb
+- transloadit-rails.gemspec
+homepage: http://github.com/transloadit/rails-sdk/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: transloadit-rails
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Official Rails gem for Transloadit
+test_files: 
+- test/generators/transloadit/test_install_generator.rb
+- test/test_helper.rb