livefyre-mashable 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 262d2bc47e4a8f539cb6297c7494d88b8cf813c9
+  data.tar.gz: 3928ce185d823537a59c739caae2af0321d58c91
+SHA512:
+  metadata.gz: 7fc401bf8ed98b28b0f0d75ec273eb925399024b63df1378db795a313ada921f21ecab93b3de57eccd84f36ba529c01dd93994c069adde6a419b48b242bc579b
+  data.tar.gz: 0a994163f12570250ab4010834b94a8e747e77919d5010cb4a74954eb4b96c2f8b145bd22178b0ab133bb09fbdef35a096f4cd2dffe0656b87eb4b9116d88048

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+#ON
$J!�6�|+�l`IK'l�ߤ0��E����T�~
+]�:��ii^�JV4䃊��
+l5���zX�@�

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in livefyre.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mashable, Inc
+
+MIT License
+
+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,169 @@
+# Livefyre
+
+Interface library for Livefyre's API. Currently a mishmash of the v2 and v3 APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'livefyre-mashable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install livefyre-mashable
+
+## Documentation
+
+Full documentation is available [on GitHub](http://mashable.github.com/livefyre/frames.html).
+
+You can generate full documentation yourself from the source tree. Requires the yard-tomdoc plugin.
+
+    yard --plugin yard-tomdoc -o doc
+
+## Usage
+
+You can set a default configuration object for Livefyre, which will prevent you from having to pass a client to
+all your object proxies manually.
+
+    Livefyre.config = {
+      :network      => "foo.fyre.co",
+      :network_key  => "blorgons",
+      :site_id      => 1234,
+      :site_key     => "minerva",
+      :system_token => "your_long_lived_system_token",
+      :domain       => "zor.t123.livefyre.com"
+    }
+
+If you're using this gem from Rails, we recommend doing this from an initializer.
+
+Once that's set, you're ready to start talking to Livefyre.
+
+    domain = Livefyre::Domain.new
+    domain.set_pull_url "http://foo.bar/users/{id}/pull/"
+
+    user = Livefyre::User.new("some_user_id")
+    user.refresh # Invoke ping-to-pull
+
+## Using with Rails
+
+Integration with Rails is straightforward, but does require some setup.
+
+### Controller integration
+
+You need to add a route to your routes file to handle profile pull requests from Livefyre. That'll look something like:
+
+    get "/livefyre/:id/pull", :to => "users#pull"
+
+Of course, you need a matching controller action
+
+    def pull
+      # Checks the validity of the JWT that Livefyre sends with pull requests. Throws an exception if it's no good.
+      validate_livefyre_request!
+
+      user = User.find(params[:id])
+
+      # livefile_profile will attempt to generate valid Livefire profile dump from the passed user record by guessing at field names.
+      # You can pass overides in a hash as the second option, or you can always generate your own data structure.
+      render :json => livefire_profile(user, :image => user.profile_image_url).to_json
+    end
+
+Finally, you'll need to set up a pull URL. Since this is done via the API, you are expected to do it manually. From a Rails console is fine, though
+you may do it any other way you please, too. Livefyre will substitute the string "{id}" for the user ID it wants data for.
+
+    Livefyre::Domain.new.set_pull_url "http://your.domain.com/livefyre/{id}/pull"
+
+You may want to invoke user updates when you save the user record.
+
+    def update
+      # ... user record updates here!
+      Livefyre::User.new( user._id ).refresh
+    end
+
+Or you can have the gem do it automatically from the model:
+
+    class User < ActiveRecord::Base
+      # ...
+
+      livefyre_user :update_on => [:email, :display_name]
+    end
+
+You can provide your own update callback, in case you want to use something like Sidekiq to do the updates:
+
+    class User < ActiveRecord::Base
+      # ...
+
+      livefyre_user :update_on => [:email, :display_name] do |user, livefyre_id|
+        Livefyre::User.delay.refresh livefyre_id
+      end
+    end
+
+This will enqueue a ping-to-pull job in the "livefyre" queue. Make sure you have a worker running that'll handle that queue!
+
+### Handling Postbacks
+
+To handle postbacks, you'll need to set up a postback route:
+
+    match '/livefyre/postback',       to: 'comments#postback'
+
+You'll also need to tell Livefyre about this URL (similar to the ping-to-pull URL, via a console or elsewhere)
+
+    Livefyre::Site.new.set_postback_url "http://foo.com/livefyre/postback"
+
+Finally, the gem provides a helper for validating Livefyre postback requests.
+
+    class CommentsController < ApplicationController
+      validate_postback_signature :only => [:postback], :key => "your_site_key"
+
+      def postback
+        # Handle the postback
+      end
+    end
+
+### View integration
+
+
+In the location that you want to use your comment form, include something like the following:
+
+    <%= livefyre_comments post.id, post.title, post_url(post), post.tags %>
+
+You'll also need to boot Livefyre with Javascript. In your application.js, you'll want to include the Livefyre loader in your manifest:
+
+    //=require livefyre.js
+
+And then somewhere in your application.js, you'll want to actually boot:
+
+    window.initLivefyre({
+      login: function() {
+          // Things to do when the user clicks the "sign in" link. You probably want to
+          // take your user through a login cycle in a popup window, which includes calling
+          // the livefyre_login(user_id, user_name) method.
+          window.location = "/login";
+        },
+      logout: function() {
+          // things to do when the user clicks the "sign out" link. You probably want to take
+          // your user through the logout cycle, including a call to livefyre_logout.
+          window.location = "/logout";
+        },
+      viewProfile: function(handlers, author) {
+          // Handler for when a user's name is clicked in a comment
+          window.location = "/" + author;
+        },
+      editProfile: function(handlers, author) {
+          // Handler for when a user wants to edit their profile from the Livefyre user dropdown.
+          window.location = "/" + author + "/edit";
+        }
+    });
+
+That's it!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new('spec')
+rescue LoadError
+  # Pass
+end
+
+task :doc do
+  sh %{yard --plugin yard-tomdoc -o doc}
+end

data/app/assets/javascripts/livefyre.js

@@ -0,0 +1,180 @@
+// Generated by CoffeeScript 1.6.3
+(function() {
+  var cookie, defaultDelegate, load, utils, _initialized;
+
+  defaultDelegate = function(options) {
+    var authDelegate, k, v, _ref;
+    authDelegate = new fyre.conv.RemoteAuthDelegate();
+    _ref = options.auth;
+    for (k in _ref) {
+      v = _ref[k];
+      authDelegate[k] = v;
+    }
+    return authDelegate;
+  };
+
+  load = null;
+
+  (function() {
+    var fjs, __loadedScripts;
+    __loadedScripts = [];
+    fjs = null;
+    return load = function(source, id, options) {
+      var js, k, v;
+      if (document.getElementById(id)) {
+        return;
+      }
+      if (__loadedScripts[id]) {
+        return;
+      }
+      __loadedScripts[id] = true;
+      if (!fjs) {
+        fjs = document.getElementsByTagName('script')[0];
+      }
+      js = document.createElement("script");
+      js.id = id;
+      js.async = true;
+      js.src = source;
+      if (options) {
+        for (k in options) {
+          v = options[k];
+          js[k] = v;
+        }
+      }
+      fjs.parentNode.insertBefore(js, fjs);
+      return js;
+    };
+  })();
+
+  cookie = function(token) {
+    var m;
+    m = document.cookie.match(new RegExp(token + "=([^;]+)"));
+    if (m) {
+      return m[1];
+    } else {
+      return null;
+    }
+  };
+
+  utils = function(options) {
+    var obj;
+    return obj = {
+      load: load,
+      startLogin: function(url, width, height, callback, windowName) {
+        var left, popup, top;
+        if (width == null) {
+          width = 600;
+        }
+        if (height == null) {
+          height = 400;
+        }
+        if (callback == null) {
+          callback = null;
+        }
+        if (windowName == null) {
+          windowName = null;
+        }
+        left = (screen.width / 2) - (width / 2);
+        top = (screen.height / 2) - (height / 2);
+        popup = window.open(url, windowName, "menubar=no,toolbar=no,status=no,width=" + width + ",height=" + height + ",toolbar=no,left=" + left + ",top=" + top);
+        this.finishCallback = callback;
+        return this.startLoginPopup(popup);
+      },
+      startLoginPopup: function(popup) {
+        var _this = this;
+        this.tries = 0;
+        this.popup = popup;
+        return this.timer = setInterval(function() {
+          return _this.__checkLogin();
+        }, 100);
+      },
+      __checkLogin: function() {
+        var err, token;
+        token = cookie(options.cookie_name || "livefyre_utoken");
+        if (token && this.timer) {
+          clearInterval(this.timer);
+          if (this.popup) {
+            this.popup.close();
+          }
+          this.popup = null;
+          this.timer = null;
+          if (this.finishCallback) {
+            this.finishCallback();
+          }
+          return window.fyre.conv.login(token);
+        } else if (this.popup && this.popup.closed) {
+          try {
+            this.tries += 1;
+            if (this.tries > 30) {
+              clearInterval(this.timer);
+              this.timer = null;
+              return this.popup = null;
+            }
+          } catch (_error) {
+            err = _error;
+          }
+        }
+      }
+    };
+  };
+
+  _initialized = false;
+
+  this.initLivefyre = function(options) {
+    var e, element, returnable;
+    if (_initialized && !options.force) {
+      throw "Livefyre has already been initialized";
+    }
+    _initialized = true;
+    e = document.getElementById(options.element_id || "livefyre_comments");
+    if (e) {
+      options.config || (options.config = {
+        checksum: e.getAttribute("data-checksum"),
+        collectionMeta: e.getAttribute("data-collection-meta"),
+        articleId: e.getAttribute("data-article-id"),
+        siteId: e.getAttribute("data-site-id"),
+        postToButtons: JSON.parse(e.getAttribute("data-post-to-buttons")),
+        el: e.id
+      });
+      options.network || (options.network = e.getAttribute("data-network"));
+      options.domain || (options.domain = e.getAttribute("data-domain"));
+      options.root || (options.root = e.getAttribute("data-root"));
+      returnable = utils(options);
+      this.FYRE_LOADED_CB = function() {
+        var opts;
+        if (options.preLoad) {
+          options.preLoad(fyre);
+        }
+        opts = {
+          network: options.network,
+          authDelegate: options.delegate || defaultDelegate(options)
+        };
+        console.log(options.config);
+        return fyre.conv.load(opts, [options.config], function(widget) {
+          var error, token;
+          returnable.widget = widget;
+          token = cookie(options.cookie_name || "livefyre_utoken");
+          if (token) {
+            try {
+              return fyre.conv.login(token);
+            } catch (_error) {
+              error = _error;
+              if (window.console) {
+                return window.console.log("Error logging in:", e);
+              }
+            }
+          }
+        });
+      };
+      if (!options.manualLoad) {
+        element = load("http://" + options.root + "/wjs/v3.0/javascripts/livefyre.js", null, {
+          "data-lf-domain": options.network
+        });
+      }
+      return returnable;
+    } else {
+      return null;
+    }
+  };
+
+}).call(this);

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

@@ -0,0 +1,109 @@
+defaultDelegate = (options) ->
+  authDelegate = new fyre.conv.RemoteAuthDelegate()
+  authDelegate[k] = v for k, v of options.auth
+  authDelegate
+
+load = null
+(->
+  __loadedScripts = []
+  fjs = null
+  load = (source, id, options) ->
+    return if (document.getElementById(id))
+    return if __loadedScripts[id]
+    __loadedScripts[id] = true
+    fjs = document.getElementsByTagName('script')[0] unless fjs
+    js = document.createElement("script")
+    js.id = id
+    js.async = true
+    js.src = source
+    js[k] = v for k, v of options if options
+
+    fjs.parentNode.insertBefore(js, fjs)
+    js
+)()
+
+cookie = (token) ->
+  m = document.cookie.match(new RegExp(token + "=([^;]+)"))
+  if m then m[1] else null
+
+utils = (options) ->
+  obj =
+    load: load
+    # At some point, callback should move to the last param
+    # keeping this order for backwards compat for now.
+    startLogin: (url, width = 600, height = 400, callback = null, windowName = null) ->
+      left = (screen.width / 2) - (width / 2)
+      top = (screen.height / 2) - (height / 2)
+      popup = window.open url, windowName, "menubar=no,toolbar=no,status=no,width=#{width},height=#{height},toolbar=no,left=#{left},top=#{top}"
+      @finishCallback = callback
+      @startLoginPopup(popup)
+
+    startLoginPopup: (popup) ->
+      @tries = 0
+      @popup = popup
+      @timer = setInterval(=>
+        @__checkLogin()
+      , 100)
+
+    __checkLogin: ->
+      token = cookie(options.cookie_name || "livefyre_utoken")
+
+      if token and @timer
+        clearInterval(@timer)
+        @popup.close() if @popup
+        @popup = null
+        @timer = null
+        @finishCallback() if @finishCallback
+        window.fyre.conv.login(token)
+      else if @popup and @popup.closed
+        try
+          @tries += 1
+          if @tries > 30 # 3 seconds
+             clearInterval(@timer)
+             @timer = null
+             @popup = null
+        catch err
+
+_initialized = false
+@initLivefyre = (options) ->
+  if _initialized and !options.force
+    throw "Livefyre has already been initialized"
+  _initialized = true
+  e = document.getElementById(options.element_id || "livefyre_comments")
+  if e
+    options.config ||=
+      checksum: e.getAttribute("data-checksum")
+      collectionMeta: e.getAttribute("data-collection-meta")
+      articleId: e.getAttribute("data-article-id")
+      siteId: e.getAttribute("data-site-id")
+      postToButtons: JSON.parse(e.getAttribute("data-post-to-buttons"))
+      el: e.id
+
+    options.network ||= e.getAttribute("data-network")
+    options.domain  ||= e.getAttribute("data-domain")
+    options.root    ||= e.getAttribute("data-root")
+
+    returnable = utils(options)
+
+    @FYRE_LOADED_CB = ->
+      options.preLoad(fyre) if options.preLoad
+      opts =
+        network: options.network
+        authDelegate: options.delegate || defaultDelegate(options)
+
+      console.log options.config
+      fyre.conv.load opts, [options.config], (widget) ->
+        returnable.widget = widget
+        token = cookie(options.cookie_name || "livefyre_utoken")
+        if token
+          try
+            fyre.conv.login(token)
+          catch error
+            window.console.log "Error logging in:", e if window.console
+
+    unless options.manualLoad
+      element = load "http://#{options.root}/wjs/v3.0/javascripts/livefyre.js", null, {"data-lf-domain": options.network}
+    returnable
+
+  else
+    null