embeditor-rails 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Southern California Public Radio
+
+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,188 @@
+# Embeditor
+
+Embeditor is a set of client-side adapters for various embed codes. 
+It aims to keep your article bodies clean while still allowing you 
+to have rich embeds within them.
+
+## Installation
+
+It's a Rails engine. Add it to your Gemfile:
+
+```ruby
+gem 'embeditor'
+```
+
+
+## Dependencies
+
+Currently, [`underscore.js`](http://underscorejs.org/) is a required dependency.
+I hope to remove this dependency eventually.
+
+
+## Usage
+
+**Note** Currently Embeditor (the JS library) exists only in this Rails plugin.
+Eventually it will be extracted to a pure-JS library and this gem will be a
+simple wrapper around it.
+
+First, add `embeditor` to your `application.js` manifest file:
+
+```javascript
+//= require embeditor
+```
+
+Next, initialize `Embeditor.Base` on any page where you want the swapping to
+occur, and call its `swap()` function to perform the swapping:
+
+```html
+<script type="text/javascript">
+    embeditor = new Embeditor.Base()
+    embeditor.swap()
+</script>
+```
+
+Embeditor works by replacing `A` tags (eg. `<a href="...">Embed</a>`) with the
+appropriate embed. There are several adapters included with this engine:
+
+* **Embedly** - Covers several services, such as SoundCloud, Spotify,
+  Facebook, Scribd, among others. Unfortunately, Embedly doesn't work perfectly
+  all the time.
+* **Cover It Live**
+* **Document Cloud**
+* **KPCC's Fire Tracker**
+* **Rebel Mouse**
+
+None of these are included automatically. To install just the ones you need,
+add them to your `application.js` :
+
+```javascript
+//= include embeditor/adapters/embedly
+//= include embeditor/adapters/cover_it_live
+```
+
+Or you can add all of them at once:
+
+```javascript
+//= require embeditor/adapters
+```
+
+You can also selectively require templates:
+
+```javascript
+//= require embeditor/templates/cover_it_live
+```
+
+... or require them all at once:
+
+```javascript
+//= require embeditor/templates
+```
+
+### Configuration
+
+Embeditor offers a system of configuration precedence.
+The order of precedence is:
+
+1. `data-attributes` on the placeholder link itself.
+2. Adapter-specific configuration in the `Embeditor.Base` object.
+3. Global configuration on `Embeditor.Base`
+4. Adapter-specific defaults.
+
+#### data-attributes
+
+You may add a `data-attribute` to any placeholder link, which will be used
+in the query or embed code. This method of specifying configuration takes
+precedence over any other configuration. The names of the data-attributes
+get passed directly to the query or embed code (depending on the adapter).
+Only the data-attributes which have to do with the embed will be passed through;
+attributes like `data-service` won't be used.
+
+In the following example, the `maxheight` property will be sent to the oembed
+endpoint:
+
+```html
+<a href="http://projects.scpr.org/firetracker/oembed?url=http://projects.scpr.org/firetracker/rim-fire/" data-maxheight="450" class="embed-placeholder" data-service="firetracker">Rim Fire</a>
+```
+
+#### Adapter-specific configuration
+
+When initializing the global `Embeditor.Base` object, you may specify
+configuration for individual adapters.
+
+The `plugin` object is for configuring the adapter.
+
+The `query` object is for configuring the query parameters, or in the case of
+an adapter which doesn't use a query, it's for configuring the embed properties.
+
+For the most part, everything will be pretty consistent.
+
+```javascript
+new Embeditor.Base({
+    Embedly: {
+        query: {
+            maxheight: 450
+        },
+        plugin: {
+            key: '12345'
+        }
+    },
+    FireTracker: {
+        query: {
+            maxheight: 350
+        }
+    },
+    CoverItLive: {
+        query: {
+            maxheight: 500
+        }
+    }
+})
+```
+
+#### Global configuration
+
+You may also specify global configuration in `Embeditor.Base`, which will be
+used for all adapters:
+
+```javascript
+new Embeditor.Base({
+    maxheight: 450,
+    maxwidth: 200
+})
+```
+
+#### Adapter-specific defaults
+
+Finally, if you're writing an adapter, you should specify a `QueryDefaults`
+object on the adapter, which will be used as a fallback for that adapter's
+parameters:
+
+```coffeescript
+class Embeditor.Adapters.Twitter extends Embeditor.Adapter
+    @QueryDefaults =
+        maxheight: 500
+
+    # ...
+```
+
+
+### Embedly
+
+Embedly requires a key. You can provide it while initializing `Embeditor.Base`:
+
+```javascript
+new Embeditor.Base({
+    Embedly: {
+        plugin: {
+            key: '12345'
+        }
+    }
+})
+```
+
+
+## Extending
+
+You can/should add your own adapters! It's easy, I promise. If you add one
+which you think could be useful to a lot of people, please submit a PR and
+share the wealth!

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Embeditor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/embeditor.js

@@ -0,0 +1,2 @@
+//= require embeditor/embeditor
+//= require embeditor/adapter

data/app/assets/javascripts/embeditor/adapter.js.coffee

@@ -0,0 +1,38 @@
+# Your Adapter should define:
+# * QueryDefaults - an object of defaults to send as query parameters
+
+class Embeditor.Adapter
+    @TemplatePath = "embeditor/templates/"
+
+    constructor: (@element, options={}) ->
+        @href = @element.attr('href')
+
+
+    swap: ->
+        return
+
+
+    _extractData: ->
+        adapter = @constructor.name
+        dataOptions = {}
+
+        for key,val of @element.data()
+            # Make sure we care about this attribute
+            if Embeditor.Adapters[adapter].QueryDefaults?[key]
+                dataOptions[key] = val
+
+        dataOptions
+
+
+    # We're combining a few things (in order of precedence):
+    # 1. The `data-attributes` of the placeholder,
+    # 2. The adapter-specific options specified at Embeditor
+    #    initialization,
+    # 3. The global options specified at Embeditor initialization,
+    # 4. This adapter's default options (fallback options).
+    _buildParams: (dataOptions, options) ->
+        adapter = @constructor.name
+
+        _.defaults(dataOptions,
+            options[adapter]?['query'], options['query']
+            Embeditor.Adapters[adapter].QueryDefaults)

data/app/assets/javascripts/embeditor/adapters.js

@@ -0,0 +1 @@
+//= require_tree ./adapters

data/app/assets/javascripts/embeditor/adapters/cover_it_live.js.coffee

@@ -0,0 +1,24 @@
+class Embeditor.Adapters.CoverItLive extends Embeditor.Adapter
+    @Template = JST[Embeditor.Adapter.TemplatePath + 'cover_it_live']
+
+    @QueryDefaults =
+        maxheight : 550
+        maxwidth  : 620
+
+    @Matcher = new RegExp "/altcast_code=([^/]+)/", "gi"
+
+
+    constructor: (@element, options={}) ->
+        @dataOptions = @_extractData()
+        @queryParams = @_buildParams(@dataOptions, options)
+
+        super
+
+
+    swap: ->
+        event_id = CoverItLive.Matcher.exec(@href)[1]
+
+        @element.after CoverItLive.Template
+            maxheight   : @queryParams.maxheight,
+            maxwidth    : @queryParams.maxwidth,
+            event_id    : @event_id

data/app/assets/javascripts/embeditor/adapters/document_cloud.js.coffee

@@ -0,0 +1 @@
+class Embeditor.Adapters.DocumentCloud extends Embeditor.Adapter

data/app/assets/javascripts/embeditor/adapters/embedly.js.coffee

@@ -0,0 +1,35 @@
+# This doesn't inherit from Adapters.Oembed because the Embedly plugin
+# handles most of that stuff on its own.
+class Embeditor.Adapters.Embedly extends Embeditor.Adapter
+    # This object should hold any keys that we want to
+    # send to the API. Any key not in this object will
+    # be ignored as a data attribute.
+    @QueryDefaults =
+        maxheight   : 450
+
+    @PluginDefaults =
+        method      : "after"
+        className   : Embeditor.DefaultOptions.wrapperClass
+        endpoint    : 'oembed'
+        # Key must be specified
+
+
+    constructor: (@element, options={}) ->
+        pluginOpts = options['Embedly']?['plugin'] or {}
+        @pluginOptions = _.defaults(pluginOpts, Embedly.PluginDefaults)
+
+        super
+
+
+    swap: ->
+        params = @_buildEmbedlyParams()
+        @element.embedly(params)
+
+
+    _buildEmbedlyParams: ->
+        if @embedlyParams
+            return @embedlyParams
+
+        @embedlyParams = _.extend(
+            @pluginOptions,
+            query : @queryParams)

data/app/assets/javascripts/embeditor/adapters/fire_tracker.js.coffee

@@ -0,0 +1,7 @@
+class Embeditor.Adapters.FireTracker extends Embeditor.Adapters.Oembed
+    @Path = "http://projects.scpr.org/firetracker/oembed"
+
+    @QueryDefaults =
+        maxwidth    : 510
+        maxheight   : 374
+        format      : 'json'

data/app/assets/javascripts/embeditor/adapters/oembed.js.coffee

@@ -0,0 +1,17 @@
+class Embeditor.Adapters.Oembed extends Embeditor.Adapter
+    # Override this. Oembed endpoint.
+    @Path = null
+
+    constructor: (@element, options={}) ->
+        @dataOptions = @_extractData()
+        @queryParams = @_buildParams(@dataOptions, options)
+
+        super
+
+
+    swap: ->
+        $.getJSON(
+            Embeditor.Adapters[@constructor.name].Path,
+            _.extend({url: @href}, @queryParams),
+            (data, textStatus, jqXHR) => @element.after(data.html)
+        )

data/app/assets/javascripts/embeditor/adapters/polldaddy.js.coffee

@@ -0,0 +1,7 @@
+class Embeditor.Adapters.Polldaddy extends Embeditor.Adapters.Oembed
+    @Path = "http://polldaddy.com/oembed"
+
+    @QueryDefaults =
+        maxwidth    : 510
+        maxheight   : 374
+        format      : 'json'

data/app/assets/javascripts/embeditor/adapters/rebel_mouse.js.coffee

@@ -0,0 +1 @@
+class Embeditor.Adapters.RebelMouse extends Embeditor.Adapter

data/app/assets/javascripts/embeditor/embeditor.js.coffee

@@ -0,0 +1,70 @@
+window.Embeditor = {
+    Adapters : {}
+
+    DefaultAdapters :
+        'youtube'       : 'Embedly'
+        'vimeo'         : 'Embedly'
+        # 'brightcove'    : 'Embedly'
+        'ustream'       : 'Embedly'
+        'vine'          : 'Embedly'
+        # 'googlemaps'    : 'Embedly'
+        'scribd'        : 'Embedly'
+        # 'documentcloud' : 'DocumentCloud'
+        'polldaddy'     : 'Polldaddy'
+        'facebook'      : 'Embedly'
+        # 'storify'       : 'Embedly'
+        'coveritlive'   : 'CoverItLive'
+        # 'rebelmouse'    : 'RebelMouse'
+        'firetracker'   : 'FireTracker'
+        # 'twitter'       : 'Embedly'
+        'instagram'     : 'Embedly'
+        'soundcloud'    : 'Embedly'
+        'spotify'       : 'Embedly'
+        'other'         : 'Embedly'
+
+    DefaultOptions :
+        defaultAdapter      : 'Embedly' # Adapter that gets used when the service isn't recognized
+        defaultService      : 'other'   # Service that gets used when the `data-service` attribute is missing
+        placeholderClass    : "embed-placeholder" # The class that the embed placeholders have
+        wrapperClass        : "embed-wrapper" # The class the embed's wrapper should be given
+}
+
+
+class Embeditor.Base
+    constructor: (options={}, adapters={}) ->
+        @options    = _.defaults(options, Embeditor.DefaultOptions)
+        @adapters   = _.defaults(adapters, Embeditor.DefaultAdapters)
+
+        @placeholders = []
+        @links = $(@_classify @options.placeholderClass)
+
+        @findEmbeds()
+
+
+    swap: ->
+        placeholder.swap() for placeholder in @placeholders
+
+
+    findEmbeds: ->
+        for link in @links
+            link = $(link)
+
+            # If "service" is blank in the CKEditor dialog, then it will
+            # omit that data-attribute from the tag, and therefore
+            # be undefined. In this scenario, we want to use the default
+            # service as a fallback.
+            #
+            # If "service" is present but has no match in the Adapters object,
+            # then we want to use the default handler as a fallback.
+            service = link.data('service') || @options.defaultService
+            adapterName = @adapters[service] || @options.defaultAdapter
+            adapter = Embeditor.Adapters[adapterName]
+
+            return if not adapter
+
+            placeholder = new adapter(link, @options)
+            @placeholders.push(placeholder)
+
+
+    _classify: (str) ->
+        "." + str

data/app/assets/javascripts/embeditor/templates.js

@@ -0,0 +1 @@
+//= require_tree ./templates

data/app/assets/javascripts/embeditor/templates/cover_it_live.jst.eco

@@ -0,0 +1,4 @@
+<div id='cil-root-<%=@event_id%>' class='cil-root'>
+    <span class='cil-config-data' title='{"altcastCode":"<%=@event_id%>","server":"www.coveritlive.com","geometry":{"width":<%=@maxwidth%>,"height":<%=@maxheight%>},"configuration":{"newEntryLocation":"bottom","pinsGrowSize":"on","titlePage":"on","skinOverride":"2"}}'>&nbsp;</span>
+</div>
+<script type='text/javascript'>window.cilAsyncInit = function() {cilEmbedManager.init()};(function() {var e = document.createElement('script');e.async = true;var domain = (document.location.protocol == 'http:') ? '//cdnsl.coveritlive.com' : '//cdnslssl.coveritlive.com';e.src = document.location.protocol + domain + '/vw.js?v=' + Math.floor(Math.random()*10000000);e.id = 'cilScript-<%=@event_id%>';document.getElementById('cil-root-<%=@event_id%>').appendChild(e);}());</script>

data/lib/embeditor-rails.rb

@@ -0,0 +1,8 @@
+require 'embeditor-rails/version'
+
+module Embeditor
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/embeditor-rails/version.rb

@@ -0,0 +1,5 @@
+module Embeditor
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: embeditor-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bryan Ricker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: eco
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Embeditor is a set of client-side adapters for various embed codes. It
+  aims to keep your article bodies clean while still allowing you to have rich embeds
+  within them. This is a Rails plugin for that library.
+email:
+- bricker@kpcc.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/embeditor/adapter.js.coffee
+- app/assets/javascripts/embeditor/adapters/cover_it_live.js.coffee
+- app/assets/javascripts/embeditor/adapters/document_cloud.js.coffee
+- app/assets/javascripts/embeditor/adapters/embedly.js.coffee
+- app/assets/javascripts/embeditor/adapters/fire_tracker.js.coffee
+- app/assets/javascripts/embeditor/adapters/oembed.js.coffee
+- app/assets/javascripts/embeditor/adapters/polldaddy.js.coffee
+- app/assets/javascripts/embeditor/adapters/rebel_mouse.js.coffee
+- app/assets/javascripts/embeditor/adapters.js
+- app/assets/javascripts/embeditor/embeditor.js.coffee
+- app/assets/javascripts/embeditor/templates/cover_it_live.jst.eco
+- app/assets/javascripts/embeditor/templates.js
+- app/assets/javascripts/embeditor.js
+- lib/embeditor-rails/version.rb
+- lib/embeditor-rails.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/SCPR/embeditor-rails
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Embeditor plugin for Rails.
+test_files: []