upload_juicer 0.9.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Juicer LLC
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,155 @@
+# Welcome!
+
+This is a rather simple gem for working the the [Juicer
+API](http://www.uploadjuicer.com) for resizing images. It's currently pretty
+rough around the edges (no tests! ack!) but it works. :)
+
+# The basics
+
+## Submitting jobs
+
+The Job class provides two class-level methods for you to interact with the
+API. First, the `submit` method takes an API key, a source URL, and a array
+of output hashes. This is POSTed to the API as JSON and a hash is returned to
+you with the results of the API call. You'll get back a job id, the source URL
+and the outputs you defined, and an indication of the status ("queued" or
+"failed").
+
+Here's an example request to create a job:
+
+    UploadJuicer::Job.submit("your api key",
+        "http://farm3.static.flickr.com/2084/2222523486_5e1894e314.jpg",
+        [{"size" => "100x100>"}])
+
+    => {"id" => "a string", "outputs" => [{"size" => "100x100>"}], "status" => "queued"}
+    
+You can specify your own destination URLs as S3 locations:
+
+    UploadJuicer::Job.submit("your api key",
+        "http://farm3.static.flickr.com/2084/2222523486_5e1894e314.jpg",
+        [{"size" => "100x100>", "url" => "s3://mybucket/path/to/destfile.jpg"}])
+
+    => {"id" => "a string", "outputs" => [{"size" => "100x100>", "url" => "s3://mybucket/path/to/destfile.jpg"}], "status" => "queued"}
+    
+When you specify output URLs, those URLs show up in the hash returned when
+queuing the job. For this to work, you'll need to grant access to Juicer to
+write to your bucket. You can find Juicer's S3 ID in the documentation at the
+Juicer site.
+
+Though size is the only required key in the outputs hashes, you can add other
+keys (e.g., a label, or your own ids) to the hashes and they will be passed
+back to you. This could be useful if you aren't specifying output URLs and you
+want to associate some data with the URLs you'll get back.
+
+## Querying jobs
+
+You can use the id that was returned to you as the second argument (after your
+API key) to the `info` method. The return hash would look exactly like the
+hash you got back from `submit`, but hopefully the status will now be
+"finished" rather than "queued" (or "failed").
+
+# Using Juicer with Rails 3
+
+The intended usage is to have your users upload files directly to S3 via
+swfupload, create an UploadJuicer::Upload record via ajax once the upload is
+complete, and then associate that UploadJuicer::Upload record and call the
+Juicer API when the record your using is working with (e.g., a Project or a
+Contact) is created or updated.
+
+A Rails Engine and a generator is included with this gem to make it easy to
+integrate Juicer with your Rails application. The engine provides an
+UploadJuicer::Upload model, an UploadJuicer::Uploads controller, and a helper
+to use in your app. The generator creates a migration, creates a configuration
+file, and copies swfupload in place for you to use in your forms.
+
+To use the generator, either specify your API key that you got from the Juicer
+site with the --api-key option, or you specify that your API key will be
+loaded in your Heroku environment (if you are using Juicer as a Heroku add-on)
+with the --heroku option. After running the generator you'll need to run the
+migration and edit the config/upload\_juicer.yml file to add your S3
+credentials and specify which bucket you want to use for your uploads.
+
+For swfupload to be able to upload to your bucket, you'll need to upload a
+crossdomain.xml to the top-level of your bucket. A sample crossdomain.xml file
+is placed in your public directory by the generator.
+
+## Example 
+
+Once you are all set up, here's an example of how you'd use the gem in a Rails
+view and model:
+
+### app/views/people/new.html.erb
+
+    <%= form_for @person do |p| %>
+      <%= p.hidden_field :image_key, :id => :image_key %>
+      <%= p.hidden_field :image_id, :id => :image_id %>
+
+      <p>
+        <%= p.label :name %>
+        <%= p.text_field :name %>
+      </p>
+
+      <div id="file_container"></div>
+      <p id="upload_placeholder" class="uploadify"></p>
+
+      <p><%= p.submit %></p>
+    <% end %>
+
+    <% content_for :head do %>
+      <%= stylesheet_link_tag('swfupload.css') %>
+    <% end %>
+
+    <% content_for :foot do %>
+      <%= javascript_include_tag('swfupload.js', 'uploader.js') %>
+      <script type="text/javascript">
+        $('#upload_placeholder').uploadify(<%= swfupload_params %>);
+      </script>
+    <% end %>
+
+This view just has two fields, the name and the file that is being uploaded.
+the reference javascripts are copied into your public directory by the
+generator. Once the file is selected, the upload begins (and the form is
+disabled). Once the file is finished uploading, an ajax request is made to the
+UploadJuicer::Uploads controller to create an UploadJuicer::Upload record, the
+form is enabled, and the image\_key and image\_id fields are populated with
+the JSON response from the UploadJuicer::Uploads controller with info about
+the UploadJuicer::Upload model that was just created. This info is used when
+the form is submitted to associated the UploadJuicer::Upload with the Person.
+The Uploads helper provides the `swfupload_params` method, which does all the
+request signing, etc. that S3 requires.
+
+### app/models/person.rb
+
+    class Person < ActiveRecord::Base
+      has_one :image, :class_name => 'UploadJuicer::Upload', :as => :uploadable
+
+      after_save :process_image
+
+      attr_accessor :image_key, :image_id
+
+      def process_image
+        return if @image_key.blank? || @image_id.blank?
+        if self.image = UploadJuicer::Upload.first(:conditions => { :key => @image_key, :id => @image_id, :uploadable_id => nil })
+          image.juice_upload(:avatar => { :size => '40x40>' }, :thumb => { :size => '100x100>' })
+        end
+      end
+    end
+
+This model simply associates the UploadJuicer::Upload that was created via the
+AJAX call, then calls the `juice_upload` method with a hash of labels and size
+info to pass on to the Juicer API. The UploadJuicer::Upload model creates
+partitioned paths for the files in your S3 bucket like so:
+
+    Original: http://s3.amazonaws.com/your_bucket/34j/e8r/9fu/file_name.jpg
+    Avatar:   http://s3.amazonaws.com/your_bucket/34j/e8r/9fu/avatar/file_name.jpg
+    Thumb:    http://s3.amazonaws.com/your_bucket/34j/e8r/9fu/thumb/file_name.jpg
+
+### app/views/person/show.html.erb
+
+    <h1><%= @person.name %></h1>
+    <p>Avatar: <%= image_tag(@person.image.url(:avatar)) %></p>
+    <p>Thumb: <%= image_tag(@person.image.url(:thumb)) %></p>
+    <p>Full image: <%= image_tag(@person.image.url) %></p>
+    
+This view shows how to get the publicly-readable S3 URLs from the
+UploadJuicer::Upload record associated with the Person.

data/app/controllers/upload_juicer/uploads_controller.rb

@@ -0,0 +1,8 @@
+class UploadJuicer::UploadsController < ApplicationController
+  unloadable
+  
+  def create
+    @upload = UploadJuicer::Upload.create(params.slice(:file_name, :size, :key))
+    render :json => @upload
+  end
+end

data/app/helpers/uploads_helper.rb

@@ -0,0 +1,43 @@
+module UploadsHelper
+  def s3_post_params(options = {})
+    acl = options[:acl] || 'public-read'
+    expiration = options[:expiration] || 6.hours.from_now.utc.strftime('%Y-%m-%dT%H:%M:%S.000Z')
+    max_filesize = options[:max_filesize] || 2.gigabyte
+
+    policy = Base64.encode64(
+      { 'expiration' => expiration,
+        'conditions' => [
+          {'bucket' => UploadJuicer::Config.s3['bucket']},
+          ['starts-with', '$key', s3_key],
+          {'acl' => acl},
+          {'success_action_status' => '201'},
+          ['starts-with', '$Filename', ''],
+          ['content-length-range', 0, max_filesize]
+        ]
+      }.to_json)
+
+    signature = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), UploadJuicer::Config.s3['secret_access_key'], policy)).gsub("\n", "")
+
+    {
+      "key" => "#{s3_key}/${filename}",
+      "AWSAccessKeyId" => "#{UploadJuicer::Config.s3['access_key_id']}",
+      "acl" => "#{acl}",
+      "policy" => "#{policy}",
+      "signature" => "#{signature}",
+      "success_action_status" => "201"
+    }
+  end
+  
+  def s3_key
+    @s3_key ||= SecureRandom.hex(8).scan(/..../).join('/')
+  end
+  
+  def s3_upload_url
+    @s3_upload_url ||= "http://#{UploadJuicer::Config.s3['bucket']}.s3.amazonaws.com/"
+  end
+  
+  def swfupload_params
+    { :upload_url => s3_upload_url, :post_params => s3_post_params }.to_json.html_safe
+  end
+  
+end

data/app/models/upload_juicer/upload.rb

@@ -0,0 +1,30 @@
+require 'upload_juicer'
+
+class UploadJuicer::Upload < ActiveRecord::Base
+  set_table_name 'upload_juicer_uploads'
+  
+  belongs_to :uploadable, :polymorphic => :true
+  
+  def url(style = nil)
+    "http://#{UploadJuicer::Config.s3['bucket']}.s3.amazonaws.com/#{s3_path(style)}"
+  end
+  
+  def s3_url(style = nil)
+    "s3://#{UploadJuicer::Config.s3['bucket']}/#{s3_path(style)}"
+  end
+  
+  def s3_path(style = nil)
+    style = style.to_s
+    style << '/' unless style.blank? || style.ends_with?('/')
+    "#{key}/#{style}#{file_name}"
+  end
+  
+  # The outputs var goes from this:
+  #     { :avatar => { :size => '40x40>' } } 
+  #   to this:
+  #     [ { :label => 'avatar', :size => '40x40>', :url => s3_url('avatar') } ]
+  def juice_upload(outputs)
+    output_array = outputs.collect {|style, opts| { :label => style.to_s, :url => s3_url(style) }.merge(opts) }
+    UploadJuicer::Job.submit(UploadJuicer::Config.api_key, s3_url, output_array)
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do |map|
+  namespace :upload_juicer do
+    resources :uploads, :only => [ :create ]
+  end
+end

data/lib/generators/upload_juicer/templates/initializer.rb

@@ -0,0 +1 @@
+UploadJuicer::Config.api_key = <%= api_key_fetcher %>

data/lib/generators/upload_juicer/templates/migration.rb

@@ -0,0 +1,20 @@
+class CreateUploadTables < ActiveRecord::Migration
+  def self.up
+    create_table :upload_juicer_uploads do |t|
+      t.string  :file_name
+      t.string  :key
+      t.integer :size
+      t.integer :uploadable_id
+      t.string  :uploadable_type
+
+      t.timestamps
+    end
+    
+    add_index :upload_juicer_uploads, :key
+    add_index :upload_juicer_uploads, [:uploadable_id, :uploadable_type]
+  end
+
+  def self.down
+    drop_table :upload_juicer_uploads
+  end
+end

data/lib/generators/upload_juicer/upload_juicer_generator.rb

@@ -0,0 +1,40 @@
+class UploadJuicerGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  desc <<-EOD
+    This generator creates a configuration and migration to use the API at 
+    http://uploadjuicer.com in your Rails application.  If you signed up for
+    Juicer via Heroku, use the --heroku option to have the API key loaded
+    from your Heroku environment.  Otherwise, use the --api_key option to
+    supply the API key you received after signing up at the Juicer site.
+
+  EOD
+
+  class_option :api_key, :type => :string, :desc => "Your Juicer API key"
+  class_option :heroku, :type => :boolean, :desc => "Use the Heroku addon to provide your Juicer API key"
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+  
+  def doit
+    if !options[:api_key] && !options[:heroku] && !File.exists?(File.join('config', 'upload_juicer.yml'))
+      puts "Please use --api-key or --heroku or create config/upload_juicer.yml"
+      exit
+    end
+    migration_template 'migration.rb', File.join('db', 'migrate', 'create_upload_tables.rb')
+    template 'config.yml', File.join('config', 'upload_juicer.yml')
+    directory 'public'
+  end
+  
+  private
+  
+    def api_key_fetcher
+      options[:api_key] ? options[:api_key] : "<%= ENV['JUICER_API_KEY'] %>"
+    end
+
+end

data/lib/upload_juicer/engine.rb

@@ -0,0 +1,7 @@
+module UploadJuicer
+  if defined?(::Rails::Engine)
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+  

data/lib/upload_juicer/extensions/string.rb

@@ -0,0 +1,8 @@
+class String
+  # Backward compatibility for Rails 2.x
+  unless self.method_defined? :html_safe
+    def html_safe
+      self
+    end
+  end
+end

data/lib/upload_juicer/railtie.rb

@@ -0,0 +1,16 @@
+module UploadJuicer
+  def self.rails_init
+    YAML::load(ERB.new(File.read(Rails.root.join('config', 'upload_juicer.yml'))).result)[Rails.env].each { |k, v| UploadJuicer::Config.send("#{k}=", v) } rescue nil
+  end
+
+  if defined?(::Rails::Railtie)
+    class Railtie < ::Rails::Railtie
+      config.after_initialize do |app|
+        UploadJuicer.rails_init
+      end
+    end
+  else
+    rails_init
+  end
+
+end

data/lib/upload_juicer.rb

@@ -0,0 +1,29 @@
+require 'json'
+require 'rest_client'
+require 'ostruct'
+
+module UploadJuicer
+  API_URL = 'http://app.uploadjuicer.com/jobs'
+  VERSION = '0.9.1'
+  
+  Config = OpenStruct.new
+  
+  class Job
+    def self.submit(api_key, url, outputs)
+      JSON.parse(RestClient.post("#{UploadJuicer::API_URL}?token=#{api_key}&gem=#{UploadJuicer::VERSION}", 
+        { :url => url, :outputs => outputs }.to_json, { :content_type => :json, :accept => :json }))
+    end
+    
+    def self.info(api_key, id)
+      JSON.parse(RestClient.get("#{UploadJuicer::API_URL}/#{id}?token=#{api_key}&gem=#{UploadJuicer::VERSION}",
+        { :content_type => :json, :accept => :json }))
+    end
+  end
+  
+end
+
+if defined?(Rails)
+  require 'upload_juicer/extensions/string'
+  require 'upload_juicer/railtie'
+  require 'upload_juicer/engine'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: upload_juicer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 1
+  version: 0.9.1
+platform: ruby
+authors: 
+- Benjamin Curtis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: 
+- ben@uploadjuicer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/upload_juicer/templates/initializer.rb
+- lib/generators/upload_juicer/templates/migration.rb
+- lib/generators/upload_juicer/upload_juicer_generator.rb
+- lib/upload_juicer/engine.rb
+- lib/upload_juicer/extensions/string.rb
+- lib/upload_juicer/railtie.rb
+- lib/upload_juicer.rb
+- app/controllers/upload_juicer/uploads_controller.rb
+- app/helpers/uploads_helper.rb
+- app/models/upload_juicer/upload.rb
+- config/routes.rb
+- LICENSE
+- CHANGELOG.md
+- README.md
+has_rdoc: true
+homepage: http://www.uploadjuicer.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: UploadJuicer juices up your images!
+test_files: []
+