livefyre 0.1.2 → 1.0.0

data/lib/livefyre/domain.rb

@@ -1,220 +0,0 @@
-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: Search conversations on this domain
-    #
-    # query   - string to query for
-    # options - [Hash] of options
-    # :fields - list of fields to search. Default [:article, :title, :body]
-    # :sort   - Sort order for options. Valid values are [:relevance, :created, :updated, :hotness, :ncomments]. Default is :relevance
-    # :fields - List of fields to return in the result. Valid values are: article_id, site_id, domain_id, title, published, updated, author, url, ncomment, nuser, annotation, nlp, hotness, hottest_value, hottest_time, peak, peak_value, peak_time, comments:5, users:5, comment_state, hit_field, dispurl, relevancy
-    # :max    - Maximum number of fields to return
-    # :since  - [DateTime] Minimum date of results to return
-    # :until  - [DateTime] Maximum date of results to return
-    # :sites  - Array of Sites or site IDs to limit results to. Maximum 5 sites.
-    # :page   - Page of results to fetch. Default 1.
-    #
-    # Returns [Array<Conversation>] An array of matching conversations
-    # Raises [APIException] when response is not valid
-    def search_conversations(query, options = {})
-      query = {}
-      query[:return_fields] = options[:fields] if options[:fields]
-      query[:fields]   = options[:fields] || [:article, :title, :body]
-      query[:order]    = options[:sort] || "relevance"
-      query[:max]      = options[:max].to_i if options[:max]
-      query[:since]    = options[:since].utc.iso8601 if options[:since]
-      query[:until]    = options[:until].utc.iso8601 if options[:until]
-      query[:sites]    = options[:sites].map {|s| s.is_a?(Site) ? s.id : s.to_i }
-      query[:cursor]   = (query[:max] || 10).to_i * options[:page].to_i if options[:page]
-      query[:apitoken] = client.system_token ## TODO: I expect this is wrong; this param seems to expect the old-style API token.
-      response = client.search.get "/api/v1.1/public/search/convs/", query
-      if response.success?
-        JSON.parse(response.body)
-      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.post "/owners/?actor_token=#{CGI.escape client.system_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 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 "/owner/#{user.jid}/?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 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

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

data/lib/livefyre/helpers.rb

@@ -1,57 +0,0 @@
-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],
-          :"post-to-buttons" => Livefyre.config[:postToButtons]
-        }
-      )
-      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

@@ -1,64 +0,0 @@
-module Livefyre
-  module Model
-    extend ActiveSupport::Concern
-
-    # Public: Ping Livefyre to refresh this user's record
-    def refresh_livefyre
-      if _livefyre_callback
-        _livefyre_callback.call( self, self.send(:_livefyre_id) )
-      else
-        Livefyre::User.refresh( self.send(:_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
-            break
-          end
-        end
-      end
-    end
-
-    def _livefyre_options
-      self.class.instance_variable_get("@livefyre_options")
-    end
-
-    def _livefyre_callback
-      self.class.instance_variable_get("@livefyre_update_block")
-    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 = {}, &block)
-        @livefyre_options = options
-        @livefyre_update_block = block
-        after_save :update_livefyre_if_fields_changed
-      end
-    end
-  end
-end

data/lib/livefyre/site.rb

@@ -1,237 +0,0 @@
-module Livefyre
-  # Public: Exception representing a failure to validate a signature
-  class InvalidSignatureException < Exception; end
-
-  # 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: Search conversations on this domain
-    #
-    # query   - string to query for
-    # options - [Hash] of options
-    # :fields - list of fields to search. Default [:article, :title, :body]
-    # :sort   - Sort order for options. Valid values are [:relevance, :created, :updated, :hotness, :ncomments]. Default is :relevance
-    # :fields - List of fields to return in the result. Valid values are: article_id, site_id, domain_id, title, published, updated, author, url, ncomment, nuser, annotation, nlp, hotness, hottest_value, hottest_time, peak, peak_value, peak_time, comments:5, users:5, comment_state, hit_field, dispurl, relevancy
-    # :max    - Maximum number of fields to return
-    # :since  - [DateTime] Minimum date of results to return
-    # :until  - [DateTime] Maximum date of results to return
-    # :page   - Page of results to fetch. Default 1.
-    #
-    # Returns [Array<Conversation>] An array of matching conversations
-    # Raises [APIException] when response is not valid
-    def search_conversations(query, options = {})
-      options[:sites] = [self]
-      Domain.new(@client).search_conversations(query, options)
-    end
-
-    # Public: Get a list of properties for this site
-    #
-    # reload - Force a reload when set
-    #
-    # Returns [Hash] Site properties
-    # Raises [APIException] when response is not valid
-    def properties(reload = false)
-      return @options unless @options.nil? or @options.empty? or reload
-      response = client.get "/site/#{id}/", {:actor_token => client.system_token}
-      if response.success?
-        @options = JSON.parse response.body
-        @secret = options["api_secret"]
-        @options
-      else
-        raise APIException.new(response.body)
-      end
-    end
-
-    # Public: Fetches a feed of the site's latest activity.
-    #
-    # since_id - [Integer] If provided, will return feed items after the given feed item.
-    #
-    # Returns [Array<Activity>] List of feed activities
-    def feed(since_id = nil)
-      reload if secret.nil?
-      timestamp = Time.now.utc.to_i
-      sig = Base64.encode64 HMAC::SHA1.new(Base64.decode64 secret).update("sig_created=%s" % timestamp).digest
-      url = "/%s/" % ["site", id, "sync", since_id].compact.join("/")
-      response = client.get url, {:sig_created => timestamp, :sig => sig}
-      if response.success?
-        payload = JSON.parse(response.body).map {|item| Activity.new(client, item) }
-      else
-        raise APIException.new(response.body)
-      end
-    end
-
-    # Public: Fetches the latest comments from this site
-    #
-    # since_id - [Integer] If provided, will return feed items after the given comment.
-    #
-    # Returns: [Array<Comment>] List of comment
-    def comments(since = nil)
-      feed(since).select(&:comment?).map(&:comment)
-    end
-
-    # Public: Reload this site's properties from Livefyre
-    #
-    # Returns self
-    def reload
-      properties(true)
-      self
-    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?
-        properties(true) rescue APIException nil
-        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)
-      user = User.get_user(user, client)
-      response = client.delete "/site/#{id}/owner/#{user.jid}/?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)
-      user = User.get_user(user, client)
-      response = client.post "/site/#{id}/admins/?actor_token=#{CGI.escape client.system_token}", {:jid => user.jid}
-      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)
-      user = User.get_user(user, client)
-      response = client.delete "/site/#{id}/admin/#{user.jid}/?actor_token=#{CGI.escape client.system_token}"
-      if response.success?
-        true
-      else
-        raise APIException.new(response.body)
-      end
-    end
-
-    # Public: Create a conversation collection on this site
-    #
-    # Returns [Conversation]
-    def create_conversation(article_id, title, link, tags = nil)
-      Conversation.create(client, article_id, title, link, tags)
-    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
-
-    # Public: Validate a signature as passed by the Livefyre postback service
-    #
-    # params      - Hash of request parameters
-    # secret      - Site key to validate signature with
-    # time_window - Enforce that the sig_created is within time_window seconds of the current time.
-    #               Slush is given to account for system time drift. Pass nil or false to disable timestamp checking.
-    #
-    # Returns [Bool]
-    # Raises [InvalidSignatureException] on failure
-    def self.validate_signature(params, secret, time_window = 300)
-      params = params.clone
-      params.delete :controller
-      params.delete :action
-      sig = (params.delete(:sig) || "").strip
-      raise InvalidSignatureException.new "Missing sig" if sig.nil?
-      raise InvalidSignatureException.new "Missing site key" if secret.nil?
-
-      hash_str = params.sort.map {|v| v.join("=") }.join("&")
-
-      if time_window
-        created_at = params[:sig_created]
-        raise InvalidSignatureException.new "Missing sig_created" if created_at.nil?
-        raise InvalidSignatureException.new "Invalid timestamp" if (Time.now.utc - Time.at(created_at.to_i).utc).abs > time_window
-      end
-
-      check = Base64.encode64 HMAC::SHA1.new(Base64.decode64 secret).update(hash_str).digest
-      check = check.strip
-      raise InvalidSignatureException.new "Invalid signature" if check != sig
-      return sig == check
-    end
-  end
-end