livefyre 0.0.1

data/lib/livefyre/domain.rb

@@ -0,0 +1,186 @@
+module Livefyre
+  # Public: Proxy for a Livefyre domain resource
+  class Domain
+    attr_accessor :client
+
+    def initialize(client = nil)
+      @client = client || Livefyre.client
+    end
+
+    # Public: Get a list of sites for this domain
+    #
+    # Returns [Array<Site>] An array of {Site sites}
+    # Raises [APIException] when response is not valid
+    def sites
+      response = client.get "/sites/?actor_token=#{CGI.escape client.system_token}"
+      if response.success?
+        JSON.parse(response.body).map do |site|
+          Site.new(site["id"], client, site)
+        end
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Get a list of users on this domain
+    #
+    # Returns [Array<User>] An array of {User users}
+    # Raises [APIException] when response is not valid
+    def users
+      response = client.get "/profiles/?actor_token=#{CGI.escape client.system_token}"
+      if response.success?
+        JSON.parse(response.body).map do |site|
+          User.new(site["id"], client, site["display_name"])
+        end
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Push a user profile to this domain
+    #
+    # profile - [Hash] Hash of user data to publish per the Livefyre profile schema
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] when response is not valid
+    def add_user(profile)
+      raise "Invalid ID" if profile["id"].nil?
+      response = client.post "/profiles/?actor_token=#{CGI.escape client.system_token}&id=#{CGI.escape profile["id"]}", profile
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Create a new site on this domain
+    #
+    # Returns [Site] A new {Site site}.
+    # Raises [APIException] when response is not valid
+    def create_site(url)
+      response = client.post "/sites/?actor_token=#{CGI.escape client.system_token}&url=#{CGI.escape url}"
+      if response.success?
+        opts = JSON.parse response.body
+        Site.new(opts["id"], client, opts)
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Retrieve a list of owners associated with this domain
+    #
+    # Returns [Array<User>] An array of {User users}
+    # Raises [APIException] when response is not valid
+    def owners
+      response = client.get "/owners/", {:actor_token => client.system_token}
+      if response.success?
+        JSON.parse(response.body).map do |u|
+          client.user u.split("@", 2).first
+        end
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Adds a user to the list of owners for this domain
+    #
+    # user - [String, User, Integer] User or user ID to add as an owner
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] when response is not valid
+    def add_owner(user)
+      user = User.get_user(user, client)
+      response = client.put "/owners/?actor_token=#{CGI.escape user.token}"
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Removes a user from the list of owners for this domain
+    #
+    # user - [String, User, Integer] User or user ID to remove as an owner
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] when response is not valid
+    def remove_owner(user)
+      user = User.get_user(user, client)
+      response = client.delete "/owners/?actor_token=#{CGI.escape user.token}"
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Retrieve a list of owners associated with this domain
+    #
+    # Returns [Array<User>] An array of {User users}
+    # Raises [APIException] when response is not valid
+    def admins
+      response = client.get "/admins/", {:actor_token => client.system_token}
+      if response.success?
+        JSON.parse(response.body).map do |u|
+          client.user u.split("@", 2).first
+        end
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Adds a user to the list of owners for this domain
+    #
+    # user - [String, User, Integer] User or user ID to add as an admin
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] when response is not valid
+    def add_admin(user)
+      user = User.get_user(user, client)
+      response = client.post "/admins/?actor_token=#{CGI.escape user.token}", {:jid => user.jid}
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Removes a user from the list of owners for this domain
+    #
+    # user - [String, User, Integer] User or user ID to remove as an admin
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] when response is not valid
+    def remove_admin(user)
+      user = User.get_user(user, client)
+      response = client.delete "/admin/#{user.jid}/?actor_token=#{CGI.escape client.system_token}"
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Sets the profile pull URL for the entire network.
+    #
+    # url - A URL template that includes the string "{{id}}" in it somewhere
+    #
+    # Returns [Bool] true on success
+    # Raises APIException if the request failed
+    def set_pull_url(url)
+      result = client.post "/", {:pull_profile_url => url, :actor_token => client.system_token}
+      if result.success?
+        return true
+      else
+        raise APIException.new(result.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")} host='#{client.host}'>"
+    end
+  end
+end

data/lib/livefyre/engine.rb

@@ -0,0 +1,6 @@
+module Livefyre
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/livefyre/helpers.rb

@@ -0,0 +1,56 @@
+module Livefyre
+  # Public: View helpers for Livefyre
+  module Helpers
+
+    # Public: Add a Livefyre comment form to this page.
+    #
+    # id      - [String, Integer] identifier to use for this conversation. Likely a post ID.
+    # title   - [String] Title of this post or conversation
+    # link    - [String] Link to this post or conversation
+    # tags    - [Array, String] Optional array or comma-delimited list of tags on this conversation.
+    # options - [Hash] Additional options to pass to the created div tag.
+    #
+    # Returns [String] div element for insertion into your view
+    def livefyre_comments(id, title, link, tags = nil, options = {})
+      meta = livefyre_conversation_metadata(id, title, link, tags)
+      options.merge!(
+        :id => "livefyre_comments",
+        :data => {
+          :checksum => meta[:checksum],
+          :"collection-meta" => meta[:collectionMeta],
+          :"site-id" => meta[:siteId],
+          :"article-id" => meta[:articleId],
+          :network => Livefyre.client.host,
+          :root => Livefyre.config[:domain]
+        }
+      )
+      content_tag(:div, "", options)
+    end
+
+    private
+
+    # Internal: Generate a metadata hash from the given attributes.
+    #
+    # Returns [Hash]
+    def livefyre_conversation_metadata(id, title, link, tags)
+      tags = tags.join(",") if tags.is_a? Array
+
+      metadata = {
+        :title => title,
+        :url   => link,
+        :tags  => tags
+      }
+      metadata[:checksum] = Digest::MD5.hexdigest(metadata.to_json)
+      metadata[:articleId] = id
+      post_meta = JWT.encode(metadata, Livefyre.config[:site_key])
+
+      {
+        :el => "livefyre_comments",
+        :checksum => metadata[:checksum],
+        :collectionMeta => post_meta,
+        :siteId => Livefyre.config[:site_id],
+        :articleId => id.to_s
+      }
+    end
+  end
+end

data/lib/livefyre/model_extensions.rb

@@ -0,0 +1,76 @@
+module Livefyre
+  module Model
+    extend ActiveSupport::Concern
+
+    # Resque worker for updating Livefyre users via ping-to-pull
+    class RequestPull
+      @queue = :livefyre
+
+      # Public: Pings Livefyre, requesting that the user identified by the passed ID is refreshed.
+      def self.perform(id)
+        Livefyre::User.new( id ).refresh
+      end
+    end
+
+    # Public: Ping Livefyre to refresh this user's record
+    #
+    # defer - If true, will use Resque to process the update
+    def refresh_livefyre(defer = false)
+      livefyre_id = self._livefyre_id
+      if defer
+        if defined?(Resque)
+          Resque.enqueue Livefyre::Model::RequestPull, livefyre_id
+        else
+          raise ":defer was passed, but Resque was not found"
+        end
+      else
+        Livefyre::Model::RequestPull.perform livefyre_id
+      end
+    end
+
+    protected
+
+    def update_livefyre_if_fields_changed
+      if updates = _livefyre_options[:update_on]
+        updates.each do |field|
+          if send("#{field}_changed?")
+            refresh_livefyre _livefyre_options[:defer]
+            break
+          end
+        end
+      end
+    end
+
+    def _livefyre_options
+      self.class.instance_variable_get("@livefyre_options")
+    end
+
+    def _livefyre_id
+      livefyre_id = self.id
+      if _livefyre_options[:id]
+        livefyre_id = self.send(_livefyre_options[:id])
+      end
+      livefyre_id
+    end
+
+    public
+
+    module ClassMethods
+      # Public: Adds callback handlers and additional methods for treating this record as a user record.
+      #
+      # options    - [Hash] of options to initialize behavior with
+      # :update_on - [Array<Symbol>] List of fields which should trigger a Livefyre update when they're updated.
+      # :id        - [Symbol] Name of the method to use for determining this record's livefyre ID. If not given, #id is used.
+      #
+      # Examples
+      #
+      #    livefyre_user :update_on => [:email, :first_name, :last_name, :username, :picture_url], :id => :custom_livefyre_id
+      #
+      # Returns [nil]
+      def livefyre_user(options = {})
+        @livefyre_options = options
+        after_save :update_livefyre_if_fields_changed
+      end
+    end
+  end
+end

data/lib/livefyre/site.rb

@@ -0,0 +1,138 @@
+module Livefyre
+  # Public: An object representing a Livefyre site belonging to a Livefyre domain
+  class Site
+    attr_accessor :client, :secret, :options, :id
+
+    # Public: Create a new Site
+    def initialize(id, client = nil, options = {})
+      @id = id
+      @client = client || Livefyre.client
+      @options = options
+      @secret = options["api_secret"]
+    end
+
+    # Public: Get a list of properties for this site
+    #
+    # Returns [Hash] Site properties
+    # Raises [APIException] when response is not valid
+    def properties
+      return @options unless @options.nil? or @options.empty?
+      response = client.get "/site/#{id}/", {:actor_token => client.system_token}
+      if response.success?
+        @options = JSON.parse response.body if @options.nil? or @options.empty?
+        @secret = options["api_secret"]
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Set the postback URL for actions on this site
+    #         See: https://github.com/Livefyre/livefyre-docs/wiki/Accessing-Site-Comment-Data
+    #
+    # url - [String] URL to use as the postback URL for actions
+    #
+    # Returns [Bool] true on success
+    # Raises: [APIException] when response is not valid
+    def set_postback_url(url)
+      response = client.post "/site/#{id}/", {:actor_token => client.system_token, :postback_url => url}
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Retrieve a list of owners associated with this site
+    #
+    # Returns [Array<Livefyre::User>] A list of {Livefyre::User users}
+    # Raises: APIException when response is not valid
+    def owners
+      response = client.get "/site/#{id}/owners/", {:actor_token => client.system_token}
+      if response.success?
+        JSON.parse(response.body).map do |u|
+          client.user u.split("@", 2).first
+        end
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Adds a user to the list of owners for this site
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] when response is not valid
+    def add_owner(user)
+      uid = User.get_user_id(user)
+      response = client.post "/site/#{id}/owners/?actor_token=#{CGI.escape client.system_token}", {:jid => client.jid(uid)}
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Removes a user from the list of owners for this site
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] when response is not valid
+    def remove_owner(user)
+      uid = User.get_user_id(user)
+      response = client.delete "/site/#{id}/owner/#{client.jid uid}?actor_token=#{CGI.escape client.system_token}"
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Retrieve a list of owners associated with this site
+    #
+    # Returns [Array<Livefyre::User>] A list of {Livefyre::User users}
+    # Raises: [APIException] when response is not valid
+    def admins
+      response = client.get "/site/#{id}/admins/", {:actor_token => client.system_token}
+      if response.success?
+        JSON.parse(response.body).map do |u|
+          client.user u.split("@", 2).first
+        end
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Adds a user to the list of admins for this site
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] when response is not valid
+    def add_admin(user)
+      uid = User.get_user_id(user)
+      response = client.post "/site/#{id}/admins/?actor_token=#{CGI.escape client.system_token}", {:jid => client.jid(uid)}
+      if response.success?
+        true
+      else
+        raise APIException.new(response.body)
+      end
+    end
+
+    # Public: Removes a user from the list of admins for this site
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] when response is not valid
+    def remove_admin(user)
+      uid = User.get_user_id(user)
+      response = client.delete "/site/#{id}/admin/#{client.jid uid}?actor_token=#{CGI.escape client.system_token}"
+      if response.success?
+        true
+      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}' secret='#{secret}' options=#{options.inspect}>"
+    end
+  end
+end

data/lib/livefyre/user.rb

@@ -0,0 +1,110 @@
+module Livefyre
+  # Public: Interface for dealing with Livefyre users by User ID.
+  class User
+    attr_accessor :id, :client, :display_name
+
+    # Public: Create a new Livefyre User proxy.
+    #
+    # id           - [String] ID of the user to proxy
+    # client       - [Livefyre::Client] an instance of Livefyre::Client. If nil, the default client is used.
+    # display_name - [String] The display name for this user (optional)
+    def initialize(id, client = nil, display_name = nil)
+      @id = id
+      @client = client || Livefyre.client
+      @display_name = display_name
+    end
+
+    # Internal - Fetch an internal Jabber-style ID for this user
+    #
+    # Returns [String] representation of this user
+    def jid
+      "#{id}@#{client.host}"
+    end
+
+    # Public: Creates a signed JWT token for this user
+    #
+    # max_age - [Integer] Expiry time for this token in seconds (default: 86400)
+    #
+    # Returns [String] token
+    def token(max_age = 86400)
+      data = {
+        :domain => client.host,
+        :user_id => id,
+        :expires => Time.now.to_i + max_age
+      }.tap do |opts|
+        opts[:display_name] = @display_name unless @display_name.nil?
+      end
+      JWT.encode(data, client.key)
+    end
+
+    # Public: Update this user's profile on Livefyre
+    #
+    # data - [Hash] A hash of user data as defined by the Livefyre user profile schema
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] if the request failed
+    def push(data)
+      result = client.post "/profiles/?actor_token=#{CGI.escape client.system_token}&id=#{id}", {:data => data.to_json}
+      if result.success?
+        true
+      else
+        raise APIException.new(result.body)
+      end
+    end
+
+    # Public: Invoke Livefyre ping-to-pull to refresh this user's data
+    #
+    # Returns [Bool] true on success
+    # Raises [APIException] if the request failed
+    def refresh
+      result = client.post "/api/v3_0/user/#{id}/refresh", {:lftoken => client.system_token}
+      if result.success?
+        true
+      else
+        raise APIException.new(result.body)
+      end
+    end
+
+    # Public: Coerce a string or [User] into a user ID
+    #
+    # userish - [String/User/Int]A [User] or user ID
+    #
+    # Returns [String] User ID
+    # Raises Exception when value can't be coerced
+    def self.get_user_id(userish)
+      case userish
+      when String
+        userish.split("@", 2).first
+      when Fixnum
+        userish
+      when User
+        userish.id
+      else
+        raise "Invalid user ID"
+      end
+    end
+
+    # Public: Fetch a Livefyre::User from a user record or ID
+    #
+    # userish - [String/User/Int] A User or user ID
+    # client  - [Livefyre::Client] Client to bind to the User record
+    #
+    # Returns [User]
+    def self.get_user(userish, client)
+      case userish
+      when User
+        userish.client = client
+        userish
+      else
+        new get_user_id(userish), client
+      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}' display_name='#{display_name}'>"
+    end
+  end
+end

data/lib/livefyre/version.rb

@@ -0,0 +1,3 @@
+module Livefyre
+  VERSION = "0.0.1"
+end

data/lib/livefyre.rb

@@ -0,0 +1,50 @@
+require 'jwt'
+require 'faraday'
+require 'forwardable'
+
+# Public: Toplevel Livefyre namespace
+module Livefyre
+  # Public: Exception thrown when the Livefyre API does not return a success value
+  #         #message will be the response body from the Livefyre API.
+  class APIException < ::Exception; end
+
+  # Public: Set the default configuration object for Livefyre clients
+  #
+  # Returns [nil]
+  def self.config=(config)
+    config.keys.each do |key|
+      config[(key.to_sym rescue key) || key] = config.delete(key)
+    end if config.is_a? Hash
+    @@config = config
+    @@client = nil
+  end
+
+  # Public: Get the configuration object for default clients
+  #
+  # Returns [Hash] configuration hash
+  def self.config
+    @@config
+  end
+
+  # Public: Retreive a singleton instance of the Livefyre client
+  #
+  # Returns [Livefyre::Client] instance configured with the default settings
+  # Raises Exception if #config is nil
+  def self.client
+    raise "Invalid configuration" if @@config.nil?
+    @@client ||= Livefyre::Client.new(@@config)
+  end
+end
+
+require File.expand_path("livefyre/client", File.dirname(__FILE__))
+require File.expand_path("livefyre/user", File.dirname(__FILE__))
+require File.expand_path("livefyre/domain", File.dirname(__FILE__))
+require File.expand_path("livefyre/site", File.dirname(__FILE__))
+
+if defined?(Rails)
+  require File.expand_path("livefyre/controller_extensions", File.dirname(__FILE__))
+  require File.expand_path("livefyre/helpers", File.dirname(__FILE__))
+  require File.expand_path("livefyre/model_extensions", File.dirname(__FILE__))
+  require File.expand_path("../railties/railtie", File.dirname(__FILE__))
+  require File.expand_path("livefyre/engine", File.dirname(__FILE__))
+end

data/livefyre.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/livefyre/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mashable"]
+  gem.email         = ["cheald@mashable.com"]
+  gem.description   = %q{Interface library for Livefyre's comment API with Rails helpers}
+  gem.summary       = %q{Interface library for Livefyre's comment API with Rails helpers}
+  gem.homepage      = "http://github.com/mashable/livefyre"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.name          = "livefyre"
+  gem.require_paths = ["lib"]
+  gem.version       = Livefyre::VERSION
+
+  gem.add_dependency "faraday"
+  gem.add_dependency "jwt"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov-rcov"
+  gem.add_development_dependency "rails"
+  gem.add_development_dependency "resque"
+end

data/railties/railtie.rb

@@ -0,0 +1,9 @@
+module Livefyre
+  class Railtie < Rails::Railtie
+    initializer "livefyre.initializer" do
+      ActionController::Base.send :include, Livefyre::Controller
+      ActionView::Base.send :include, Livefyre::Helpers
+      ActiveRecord::Base.send :include, Livefyre::Model if defined?(ActiveRecord)
+    end
+  end
+end