asset_host_core 2.0.0.beta

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.markdown

@@ -0,0 +1,138 @@
+# AssetHost
+
+[![Build Status](https://travis-ci.org/SCPR/AssetHost.png)](https://travis-ci.org/SCPR/AssetHost)
+
+AssetHost is an attempt to create a one-stop-shop for hosting and linking 
+to media assets that are intended for inclusion in news stories.  The goal is 
+to create a hub that multiple frontend CMS systems can hook into, querying 
+images, videos and documents from one source and enabling the easier 
+interchange of data.
+
+# Philosophy
+
+AssetHost is built around the idea that all web media assets need to 
+have a static visual fallback, either to support limited-functionality 
+devices or to support rendering of rich media assets in contexts where 
+a rich implementation isn't desired.
+
+AssetHost is intended to run as two pieces: a backend asset server and 
+lightweight frontend plugins that attach to the CMS system.  The pieces 
+should speak to each other using a secure API.
+
+
+### Backend Engine
+
+This repository provides the AssetHostCore engine, which can be run either 
+on the root of a standalone application (perhaps powering multiple frontend 
+applications) or at a namespace in an existing application.
+
+The backend server provides the primary UI for uploading, managing, and  
+serving assets. It also provides an API endpoint that can be accessed either 
+by the local application (this is how much of the admin works) or by other 
+applications or plugins.
+
+A sample host application can be found at <http://github.com/SCPR/AssetHostApp>
+
+
+### Plugins for Other Applications
+
+AssetHost provides an API and a Chooser UI that can be integrated into 
+your application, allowing you to integrate the system in a minimal amount 
+of code.
+
+_TODO: More documentation on CMS interaction. External Rails example. Django example._
+
+### Integrating with the AssetHost engine
+
+To integrate with a locally-installed AssetHostCore engine, simply make your 
+mapping data model belong to AssetHostCore::Asset.
+
+_TODO: More documentation on creating content/asset models._
+
+
+### Workflow
+
+1. Photographer / Author / Editor goes to AssetHost and uploads or imports 
+a media asset.
+
+2. Author / Editor goes to their frontend CMS and uses the plugin UI to 
+select the asset they want to attach to their content (which might be a 
+story, a blog post, etc).
+
+3. CMS plugin uses API to query AssetHost and retrieve presentation code 
+for the asset.  
+
+4. The CMS should call new AssetHost.Client() to put in place the handler 
+for rich assets.
+
+4. The CMS should display the image asset.  If it contains tags for a 
+rich asset, the Client library will catch it and put in place the 
+appropriate handling.
+
+5. AssetHost will return a 302 Found to the rendered image asset if it 
+exists, or render it on-the-fly if it does not yet exist.
+
+# Rich Media Support
+
+Rich media assets are delivered as specially-tagged img tags, and are 
+replaced on the client-side via an AssetHost.Client plugin.
+
+
+### Brightcove Video
+
+Brightcove videos can be imported as assets and used to place videos into 
+image display contexts. The video is delivered as an img tag, and the 
+AssetHost.Client library will see the tag and call the 
+AssetHost.Client.Brightcove plugin. The plugin will replace the asset with
+the video.
+
+Brightcove assets can be imported via a key in the URL Input field. See
+Importing Help for more.
+
+
+# Setup
+
+TODO: Setup generators for migrations
+
+See `spec/internal/db/schema.rb` for the tables you'll need to setup:
+
+* asset_host_core_outputs
+
+
+# Image Storage
+
+AssetHost intends to support any image storage supported by 
+[Paperclip](https://github.com/thoughtbot/paperclip), the underlying gem 
+responsible for adding image file functionality to our Asset model.
+
+Currently, Paperclip supports local filesystem storage and storage on 
+Amazon's S3.
+
+
+# External Requirements
+
+### Async Workers via Redis
+
+The AssetHost server uses Redis (via the Resque gem) to coordinate async 
+processing of images.  Configure for your Redis setup in config/resque.yml.
+
+### Image Processing via ImageMagick
+
+AssetHost, via Paperclip, does image processing using ImageMagick.  If 
+needed, make sure to specify Paperclip.options[:command_path] in your config.
+
+### Text Search via Sphinx
+
+Searches are done via Sphinx, using the Thinking Sphinx gem.  Set up your 
+configuration in config/sphinx.yml, and make sure you have an external trigger
+for indexing (cron, etc).
+
+
+# Credits
+
+AssetHost is being developed to serve the media asset needs of [KPCC](http://kpcc.org) 
+and Southern California Public Radio, a member-supported public radio network that 
+serves Los Angeles and Orange County on 89.3, the Inland Empire on 89.1, and the 
+Coachella Valley on 90.3.
+
+AssetHost development is led by Eric Richardson (erichardson@kpcc.org).

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+RAKED = true
+
+require 'bundler/setup'
+require 'resque/tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/asset_host_core/admin/assets.js.coffee

@@ -0,0 +1,221 @@
+class window.AssetHostUpload
+    DefaultOptions:
+        {
+            dropEl: "#filedrop",
+            url: "",
+            posturl: "",
+            readyClass: "ready",
+            uploadClass: "uploading",
+            errorClass: "error",
+            pendingClass: "pending",
+            completeClass: "complete",
+            token: '',
+            emptyText: "Drop File(s) Here",
+            afterText: "Go to Metadata Entry",
+            allowMultiple: true
+        }
+
+    #----------
+
+    constructor: (options={}) ->
+        @options = _.defaults options, @DefaultOptions
+
+        @drop = $(@options.dropEl)
+
+        @files = []
+        @_ids = []
+        @_uploading = []
+
+        @fileUL = $ "<ul/>"
+        $(@drop).append @fileUL
+
+        @_emptyEl = $ "<li/>", { class: "help", text: this.options.emptyText }
+        $(@fileUL).append @_emptyEl
+
+        @uploadButton = $ "<p/>", { class: "ahUp_upbutton", text: "Upload File(s)" }
+        $(@drop).append @uploadButton
+        $(@uploadButton).hide()
+        $(@uploadButton).click (evt) => this._uploadFiles(evt)
+
+        $(@drop).bind "dragenter", (evt) => @_dragenter(evt)
+        $(@drop).bind "dragover", (evt) => @_dragover(evt)
+        $(@drop).bind "drop", (evt) => @_drop(evt)
+
+    #----------
+
+    _dragenter: (evt) ->
+        evt.stopPropagation()
+        evt.preventDefault()
+
+        false
+
+    #----------
+
+    _dragover: (evt) ->
+        evt.stopPropagation()
+        evt.preventDefault()
+        false
+
+    #----------
+
+    _drop: (evt) ->
+        evt = evt.originalEvent
+
+        evt.stopPropagation()
+        evt.preventDefault()
+
+        # do something with this info
+        for f in evt.dataTransfer.files
+            @_addFileToList(f)
+
+        false
+
+    #----------
+
+    _addFileToList: (f) ->
+        if !this.options.allowMultiple && this.files.length
+            return false
+
+        if this._uploading.length
+            return false
+
+
+        li = $ "<li/>", { text: "#{f.name} (#{@readableFileSize f.size})" }
+
+        obj = {f:f,li:li,x:null}
+
+        x = $("<span/>", { text: "x" })
+            .bind "click", `_.bind(this._removeFile, this, obj, li)`
+        li.append x
+
+        obj.x = x
+
+        $(@fileUL).append li
+
+        @files.push obj
+
+        @_setFileState obj, this.options.readyClass
+
+        @_updateUploadButton()
+
+        true
+
+    #----------
+
+    _removeFile: (obj,li,evt) ->
+        if @_uploading.length
+            return false
+
+        $(li).detach()
+
+        @files = _(@files).without obj
+
+        @_updateUploadButton()
+
+    #----------
+
+    _updateUploadButton: ->
+        if @files.length then $(@uploadButton).show() else $(@uploadButton).hide()
+
+    #----------
+
+    _uploadFiles: (evt) ->
+        # disable drag/drop UI
+        @uploadButton.hide()
+
+        # upload files
+        for obj in @files
+            @_uploading.push(obj)
+
+            xhr    = new XMLHttpRequest();
+
+            upload = xhr.upload;
+
+            $(upload).bind "progress", `_.bind(this._onUploadProgress,this,obj)`
+            $(upload).bind "load", `_.bind(this._onUploadComplete,this,obj)`
+            $(upload).bind "error", `_.bind(this._onUploadError,this,obj)`
+
+            xhr.onreadystatechange = `_.bind(this._onUploadState,this,xhr,obj)`
+
+            xhr.open('POST',this.options.url, true);
+            xhr.setRequestHeader('X_FILE_NAME', obj.f.fileName)
+            xhr.setRequestHeader('CONTENT_TYPE', obj.f.type)
+            xhr.setRequestHeader('HTTP_X_FILE_UPLOAD','true')
+            xhr.send(obj.f);
+
+            @_setFileState obj, this.options.uploadClass
+
+    #----------
+
+    _onUploadProgress: (obj,evt) ->
+        evt = evt.originalEvent
+
+        if evt.lengthComputable
+            percent = Math.floor( evt.loaded / evt.total * 100 )
+            $(obj.x).text "(#{percent}%)"
+        else
+            $(obj.x).text "(#{evt.loaded}%)"
+
+    #----------
+
+    _onUploadComplete: (obj,evt) ->
+        # turn our li green or something
+        @_setFileState obj, @options.pendingClass
+
+    #----------
+
+    _onUploadError: (obj,evt) ->
+        # turn our li red?
+        @_uploading = _(@_uploading).without obj
+        @_setFileState obj, this.options.errorClass
+
+    #----------
+
+    _onUploadState: (req,obj,evt) ->
+        # look for a response asset ID
+        if req.readyState == 4
+            if req.status == 200
+                @_setFileState obj, @options.completeClass
+                $(obj.li).addClass @options.completeClass
+
+                if req.responseText != "ERROR"
+                    json = $.parseJSON req.responseText
+                    @_ids.push json
+
+                @_uploading = _(@_uploading).without obj
+
+                if !@_uploading.length
+                    @_uploadingComplete()
+            else
+                # error
+
+    #----------
+
+    _uploadingComplete: ->
+        link = $("<li/>").append(
+            $ "<a/>", { href: @options.posturl+"?ids="+_(@_ids).map( (k) -> k.id ).join(","), text: @options.afterText }
+        )
+
+        $(@drop).append link
+
+    #----------
+
+    _setFileState: (obj,classname) ->
+        # remove existing class(es)
+
+        for c in (obj.li.className || "").split(" ")
+            $(obj.li).removeClass(c)
+
+        $(obj.li).addClass classname
+
+    #----------
+
+    readableFileSize: (size) ->
+        units = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
+        i = 0;
+
+        while size >= 1024
+            size /= 1024
+            ++i
+
+        size.toFixed(1) + ' ' + units[i];

data/app/assets/javascripts/asset_host_core/application.js

@@ -0,0 +1,20 @@
+//= require ./assethost
+//= require jquery
+//= require jquery_ujs
+//= require jquery-ui
+//= require underscore.min
+//= require backbone
+//= require exif
+
+//= require backbone.modelbinding
+
+//= require spin.min
+//= require spin.jquery
+
+//= require bootstrap-transition
+//= require bootstrap-tooltip
+//= require bootstrap-modal
+
+//= require_tree ./templates
+
+//= require_tree .

data/app/assets/javascripts/asset_host_core/assetadmin.js.coffee

@@ -0,0 +1,56 @@
+class AssetHost.AssetAdmin
+    DefaultOptions:
+        el:             ""
+        replace:        ''
+        replacePath:    ''
+
+    constructor: (asset,options = {}) ->
+        @options = _.defaults options, @DefaultOptions
+
+        @asset      = new AssetHost.Models.Asset    asset
+        @preview    = new AssetAdmin.PreviewView    model: @asset
+        @form       = new AssetAdmin.FormView       model: @asset
+
+        $( @options.el ).html @preview.el
+
+        if @options.replace
+            # set up replace image uploader
+            @chooser = new AssetHost.ChooserUI
+                dropEl:             @options.replace
+                assets:             false
+                uploads:            true
+                limit:              1
+                uploadPath:         @options.replacePath
+                saveButton:         false
+                afterUploadText:    "Refresh",
+                afterUploadURL:     window.location
+
+    #----------
+
+    class @FormView extends Backbone.View
+        el: "#editform"
+
+    #----------
+
+    class @PreviewView extends Backbone.View
+        template: JST['asset_host_core/templates/asset_preview']
+        events:
+            'click .asset_sizes li': '_sizeClick'
+
+        initialize: ->
+            @size = AssetHost.SIZES.detail
+            @render()
+
+        _sizeClick: (evt) ->
+            size = $(evt.currentTarget).attr("data-size")
+
+            if size != @size
+                @size = size
+                @render()
+
+        render: ->
+            $(@el).html @template
+                asset: @model.toJSON()
+                tag: @size
+
+            @