livefyre 0.0.1 → 0.1.0

data/.gitignore

@@ -7,7 +7,7 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
+doc
 lib/bundler/man
 pkg
 rdoc

data/README.md

@@ -91,16 +91,38 @@ Or you can have the gem do it automatically from the model:
       livefyre_user :update_on => [:email, :display_name]
     end
 
-You can even have the gem do your ping updated asynchronously with Resque
+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], :defer => true
+      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
 
 

data/Rakefile

@@ -3,8 +3,10 @@ require "bundler/gem_tasks"
 begin
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new('spec')
-rescue LoadError => e
+rescue LoadError
   # Pass
 end
 
-task :default => :spec
+task :doc do
+  sh %{yard --plugin yard-tomdoc -o doc}
+end

data/app/assets/javascripts/livefyre.js

@@ -0,0 +1,177 @@
+// Generated by CoffeeScript 1.3.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 head, __loadedScripts;
+    __loadedScripts = [];
+    head = null;
+    return load = function(source, id, content, options) {
+      var js, k, v;
+      if (!content) {
+        content = null;
+      }
+      if (document.getElementById(id)) {
+        return;
+      }
+      if (__loadedScripts[id]) {
+        return;
+      }
+      __loadedScripts[id] = true;
+      if (!head) {
+        head = document.getElementsByTagName('head')[0];
+      }
+      js = document.createElement("script");
+      js.id = id;
+      js.async = true;
+      js.src = source;
+      js.innerHTML = content;
+      if (options) {
+        for (k in options) {
+          v = options[k];
+          js[k] = v;
+        }
+      }
+      head.appendChild(js);
+      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) {
+        var left, popup, top;
+        if (width == null) {
+          width = 600;
+        }
+        if (height == null) {
+          height = 400;
+        }
+        if (callback == null) {
+          callback = null;
+        }
+        left = (screen.width / 2) - (width / 2);
+        top = (screen.height / 2) - (height / 2);
+        popup = window.open(url, name, "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() {
+          _this.tries += 1;
+          return _this.__checkLogin();
+        }, 100);
+      },
+      __checkLogin: function() {
+        var token;
+        token = cookie(options.cookie_name || "livefyre_utoken");
+        if (this.popup) {
+          try {
+            if (this.popup.closed === false && this.tries > 30) {
+              clearInterval(this.timer);
+              this.timer = null;
+              this.popup = null;
+            }
+          } catch (err) {
+
+          }
+        }
+        if (token) {
+          clearInterval(this.timer);
+          this.popup.close();
+          this.popup = null;
+          this.timer = null;
+          if (this.finishCallback) {
+            this.finishCallback();
+          }
+          return window.fyre.conv.login(token);
+        }
+      }
+    };
+  };
+
+  _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"),
+        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)
+        };
+        return fyre.conv.load(opts, [options.config], function(widget) {
+          var token;
+          returnable.widget = widget;
+          token = cookie(options.cookie_name || "livefyre_utoken");
+          if (token) {
+            try {
+              return fyre.conv.login(token);
+            } catch (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, null, {
+          "data-lf-domain": options.network
+        });
+      }
+      return returnable;
+    } else {
+      return null;
+    }
+  };
+
+}).call(this);

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

@@ -1,28 +1,13 @@
 defaultDelegate = (options) ->
   authDelegate = new fyre.conv.RemoteAuthDelegate()
-  authDelegate.login        = (handlers) ->
-    if options.login
-      options.login(handlers)
+  authDelegate[k] = v for k, v of options.auth
+  authDelegate
 
-  authDelegate.logout       = (handlers) ->
-    if options.logout
-      options.logout(handlers)
-  authDelegate.viewProfile  = (handlers, author) ->
-    if options.viewProfile
-      if options.viewProfile(handlers, author)
-        handlers.success()
-
-  authDelegate.editProfile  = (handlers, author) ->
-    if options.editProfile
-      if options.editProfile(handlers, author)
-        handlers.success()
-
-loadScriptAsync = null
+load = null
 (->
   __loadedScripts = []
   fjs = null
-  loadScriptAsync = (source, id, content, options) ->
-    content = null if !content
+  load = (source, id, options) ->
     return if (document.getElementById(id))
     return if __loadedScripts[id]
     __loadedScripts[id] = true
@@ -31,18 +16,57 @@ loadScriptAsync = null
     js.id = id
     js.async = true
     js.src = source
-    js.innerHTML = content
     js[k] = v for k, v of options if options
 
     fjs.parentNode.insertBefore(js, fjs)
     js
 )()
 
-livefyreInitialized = false
+cookie = (token) ->
+  m = document.cookie.match(new RegExp(token + "=([^;]+)"))
+  if m then m[1] else null
+
+utils = (options) ->
+  obj =
+    load: load
+    startLogin: (url, width = 600, height = 400, callback = null) ->
+      left = (screen.width / 2) - (width / 2)
+      top = (screen.height / 2) - (height / 2)
+      popup = window.open url, name, "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(=>
+        @tries += 1
+        @__checkLogin()
+      , 100)
+
+    __checkLogin: ->
+      token = cookie(options.cookie_name || "livefyre_utoken")
+      if @popup
+        try
+          if @popup.closed == false and @tries > 30 # 3 seconds
+             clearInterval(@timer)
+             @timer = null
+             @popup = null
+        catch err
+
+      if token
+        clearInterval(@timer)
+        @popup.close()
+        @popup = null
+        @timer = null
+        @finishCallback() if @finishCallback
+        window.fyre.conv.login(token)
+
+_initialized = false
 @initLivefyre = (options) ->
-  if livefyreInitialized
+  if _initialized and !options.force
     throw "Livefyre has already been initialized"
-  livefyreInitialized = true
+  _initialized = true
   e = document.getElementById(options.element_id || "livefyre_comments")
   if e
     options.config ||=
@@ -56,17 +80,26 @@ livefyreInitialized = false
     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)
 
-      fyre.conv.load opts, [options.config], ->
-        token = $.cookie(options.cookie_name || "livefyre_utoken")
+      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
 
-    element = loadScriptAsync "http://#{options.root}/wjs/v3.0/javascripts/livefyre.js", null, null, {"data-lf-domain": options.network}
+    unless options.manualLoad
+      element = load "http://#{options.root}/wjs/v3.0/javascripts/livefyre.js", null, {"data-lf-domain": options.network}
+    returnable
+
+  else
+    null

data/gem-public_cert.pem

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDNDCCAhygAwIBAgIBADANBgkqhkiG9w0BAQUFADBAMQ8wDQYDVQQDDAZjaGVh
+bGQxGDAWBgoJkiaJk/IsZAEZFghtYXNoYWJsZTETMBEGCgmSJomT8ixkARkWA2Nv
+bTAeFw0xMzAxMzExNzI2NDBaFw0xNDAxMzExNzI2NDBaMEAxDzANBgNVBAMMBmNo
+ZWFsZDEYMBYGCgmSJomT8ixkARkWCG1hc2hhYmxlMRMwEQYKCZImiZPyLGQBGRYD
+Y29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4AMfgtORekddgqRx
+mHdKSRuQ7Pks2LN96uINU9lWhmppM/mrbHUvkW28wdfC27MTtR1cQUZWAzS8eWsH
+Fq0hdm5R5tsrXLM8Y7tUcoKu5qTJEmDyN2TH3lx9hH/fzwhU2rhb/DrIhtOJNBsg
+5AERbX/LA6nmQLEQlbVoVHH5tmIGnAYY96WfCNeJyexLfuOeAn1NFyBJqsU7VhFf
+JBhyHKdMDRY3HkQD6LHVVDidwEOyi+vKb13GlHwproUPutp3qTEG24IhuQGARV+f
+zSwQ1Ay6L7CmMZmznwPaPBd/zOMbe1RGg5ofCvNAgxspbNGQPJvNp+DxRENdY06N
+qeO/GQIDAQABozkwNzAJBgNVHRMEAjAAMB0GA1UdDgQWBBRqk99cHYdBntfkSYOk
+ZfXJcbaTAjALBgNVHQ8EBAMCBLAwDQYJKoZIhvcNAQEFBQADggEBAHaKNSM783Da
+/BGQv6DRjxi3wYmnn4RHJIQK4DiJjR6umtCtlBuMbhQbUBbu8sIFnqtdsKHaC097
+ygk9anqygAOYtYk2+hfn2fBFYZTflvgSuo6/IzMWucOpGrbIWczDMnH8p4biJNp+
+24du/MH+9ODiInly0UwcDyE4TW2chmvOCjLowa7bvJY3LXCDpSUMXjIO/4Cysfwk
+F5adOPFD5KcabVlHmRpprAw2GYYbWwuuV11tA+4Fhkz0ClB25/gEkFZWevs5wsEC
+miAJUwubyGI/SoFFe9MYI4i01qPX/Hqa9wqLbbEaUSCUQfcHNzgK3o2SYjmQe6Nm
+yld6FGg9zOY=
+-----END CERTIFICATE-----

data/lib/livefyre/activity.rb

@@ -0,0 +1,43 @@
+module Livefyre
+  # Public: Proxy object for an item from a Conversation activity feed
+  class Activity
+    attr_accessor :id, :user, :conversation, :body, :state, :created_at
+    def initialize(client, params = {})
+      @client = Livefyre.client
+      @params = params
+      @id = params["activity_id"]
+      @conversation = Conversation.new(@params["lf_conv_id"], @params["article_identifier"])
+      @created_at = Time.at(@params["created"]) - Time.at(0).utc_offset
+    end
+
+    # Public: Cast this activity to a Comment
+    #
+    # Return [Comment]
+    def comment
+      Comment.new(@params["lf_comment_id"], conversation,
+        :body => @params["body_text"],
+        :user => user,
+        :parent_id => @params["lf_parent_comment_id"],
+        :author_ip => @params["author_ip"],
+        :state => @params["state"]
+      )
+    end
+
+    # Public: Fetch the user that created this record
+    #
+    # Returns [User]
+    def user
+      User.new((@params["lf_jid"] || "").split("@", 2).first, @client, @params["author"],
+        :email => @params["author_email"],
+        :url => @params["author_url"]
+      )
+    end
+
+    # Internal: Test if this activity represented a comment
+    #
+    # Returns [Boolean]
+    def comment?
+      @params["activity_type"] == "comment-add"
+    end
+  end
+end

data/lib/livefyre/client.rb

@@ -8,7 +8,7 @@ module Livefyre
     # Public: Valid scopes for #set_user_role
     SCOPES = %w(domain site conv)
 
-    attr_accessor :host, :key, :options, :system_token, :http_client
+    attr_accessor :host, :key, :options, :system_token, :http_client, :site_key, :quill, :stream, :bootstrap, :search
 
     def_delegators :http_client, :get, :post, :delete, :put
 
@@ -23,6 +23,11 @@ module Livefyre
       @host = options.delete(:network) || options.delete(:host)
       raise "Invalid host" if @host.nil?
       @http_client = Faraday.new(:url => "http://#{@host}")
+      @quill = Faraday.new(:url => "http://quill.#{@host}")
+      @stream = Faraday.new(:url => "http://stream.#{@host}")
+      @search = Faraday.new(:url => "http://search.#{@host}")
+      @bootstrap = Faraday.new(:url => "http://bootstrap.#{@host}")
+      @site_key = options[:site_key]
 
       @key = options.delete(:secret) || options.delete(:key) || options.delete(:network_key)
       raise "Invalid secret key" if @key.nil?
@@ -107,11 +112,30 @@ module Livefyre
       "%s@%s" % [id, host]
     end
 
+    # Internal: Identifier to use to uniquely identify this client.
+    #
+    # Returns string ID
+    def identifier
+      @identifier ||= "RubyLib-#{Process.pid}-#{local_ip}-#{object_id}"
+    end
+
     # Internal: Returns a cleaner string representation of this object
     #
     # Returns [String] representation of this class
     def to_s
       "#<#{self.class.name}:0x#{object_id.to_s(16).rjust(14, "0")} host='#{host}' key='#{key}'>"
     end
+
+    private
+
+    def local_ip
+      orig, Socket.do_not_reverse_lookup = Socket.do_not_reverse_lookup, true  # turn off reverse DNS resolution temporarily
+      UDPSocket.open do |s|
+        s.connect '64.233.187.99', 1
+        s.addr.last
+      end
+    ensure
+      Socket.do_not_reverse_lookup = orig
+    end
   end
 end

data/lib/livefyre/comment.rb

@@ -0,0 +1,190 @@
+module Livefyre
+  # Public: Proxy object for a [Comment] on a [Livefyre::Conversation]
+  class Comment
+    private
+    SOURCES       = %w(Livefyre Twitter Twitter Facebook Livefyre Livefyre Facebook Twitter Livefyre)
+    VISIBILITIES  = %w(None Everyone Owner Group)
+    CONTENT_TYPES = %w(Message Opinion)
+    PERMISSIONS   = %w(Global Network Site Collection CollectionRule)
+    REASONS       = %w(disagree spam offensive off-topic)
+
+    public
+
+    attr_accessor :id, :body, :user, :parent_id, :ip, :conversation, :created_at
+    def initialize(id, conversation, options = {})
+      @id           = id
+      @body         = options[:body]
+      @user         = options[:user]
+      @parent_id    = options[:parent_id]
+      @ip           = options[:author_ip]
+      @conversation = conversation
+      @created_at   = options[:created_at]
+      @client       = options[:client] || Livefyre.client
+      @options      = options
+    end
+
+    # Public: Flag a comment
+    #
+    # reason - one of [disagree, spam, offensive, off-topic]
+    # notes  - String containing the reason for the flag
+    # email  - email address of the flagger
+    # user   - [User] If set, will include the user token for validation of the flag
+    def flag(reason, notes, email, user = nil)
+      raise "invalid reason" unless REASONS.include? reason
+      payload = {
+        :message_id => @id,
+        :collection_id => @conversation.id,
+        :flag => reason,
+        :notes => notes,
+        :email => email
+      }
+      payload[:lftoken] = user.token if user
+      response = client.quill.post "/api/v3.0/message/25818122/flag/#{reason}/", payload.to_json
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Delete this comment
+    #
+    # Returns [Boolean] true on success
+    # Raises [APIException] on failure
+    def delete!
+      response = client.quill.post "/api/v3.0/message/#{id}/delete", {:lftoken => @client.system_token}
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Update this comment's content
+    #
+    # Returns [Boolean] true on success
+    # Raises [APIException] on failure
+    def update(body)
+      response = client.quill.post "/api/v3.0/message/#{id}/edit", {:lftoken => @client.system_token, :body => body}
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Get the comment source as a string.
+    #         Currently only populated when created via ::create
+    #
+    # Returns [Enum<SOURCES>]
+    def source
+      source_id ? SOURCES[source_id] : nil
+    end
+
+    # Public: Get the comment source as an integer.
+    #         Currently only populated when created via ::create
+    #
+    # Returns [Integer]
+    def source_id
+      @options[:source]
+    end
+
+    # Public: Get the comment visibility as a string.
+    #         Currently only populated when created via ::create
+    #
+    # Returns [Enum<VISIBILITIES>]
+    def visibility
+      visibility_id ? VISIBILITIES[visibility_id] : nil
+    end
+
+    # Public: Get the comment visibility as an integer.
+    #         Currently only populated when created via ::create
+    #
+    # Returns [Integer]
+    def visibility_id
+      @options[:visibility]
+    end
+
+    # Public: Get the comment content type as a string.
+    #         Currently only populated when created via ::create
+    #
+    # Returns [Enum<CONTENT_TYPES>]
+    def content_type
+      content_type_id ? CONTENT_TYPES[content_type_id] : nil
+    end
+
+    # Public: Get the comment visibility as an integer.
+    #         Currently only populated when created via ::create
+    #
+    # Returns [Integer]
+    def content_type_id
+      @options[:type]
+    end
+
+    # Public: Likes a comment as the passed user
+    #
+    # Returns [Boolean] true on success
+    # Raises [APIException] on failure
+    def like!(user)
+      response = @client.quill.post "/api/v3.0/message/#{id}/like/", {:collection_id => conversation.id, :lftoken => user.token}
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Unlikes a comment as the passed user
+    #
+    # Returns [Boolean] true on success
+    # Raises [APIException] on failure
+    def unlike!(user)
+      response = @client.quill.post "/api/v3.0/message/#{id}/unlike/", {:collection_id => conversation.id, :lftoken => user.token}
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: create a new comment on a conversation
+    #
+    # client       - [Client] representing the site to use when creating the conversation
+    # user         - [User] to create the comment as
+    # conversation - [Conversation] to create
+    # body         - [String] Comment body
+    #
+    # Returns [Comment]
+    # Raises [APIException] when the API call fails
+    def self.create(client, user, conversation, body, reply_to = nil)
+      response = client.quill.post "/api/v3.0/collection/#{conversation.id}/post/", {:lftoken => user.token, :body => body, :_bi => client.identifier, :parent_id => reply_to}
+      if response.success?
+        puts JSON.parse(response.body).inspect
+        data = JSON.parse(response.body)["data"]
+
+        data["messages"].map do |entry|
+          c = entry["content"]
+          Comment.new(c["id"], conversation, {
+            :body         => c["bodyHtml"],
+            :parent_id    => c["parentId"],
+            :user         => User.new(c["authorId"], data["authors"].first.last["displayName"], data["authors"].first.last),
+            :created_at   => Time.at(c["createdAt"]),
+            :source       => entry["source"],
+            :visibility   => entry["vis"],
+            :client       => client,
+            :type         => entry["type"]
+          })
+        end.first
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Internal: Returns a cleaner string representation of this object
+    #
+    # Returns [String] representation of this class
+    def to_s
+      "#<#{self.class.name}:0x#{object_id.to_s(16).rjust(14, "0")} id='#{id}' options=#{@options.inspect}>"
+    end
+  end
+end