rightnow-client 0.0.6

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Adrien Jarthon
+
+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,88 @@
+# Rightnow
+
+[![Build Status](https://travis-ci.org/dimelo/rightnow.png?branch=master)](https://travis-ci.org/dimelo/rightnow)
+
+Ruby wrapper for the Oracle Rightnow Social API v2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rightnow-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rightnow-client
+
+## Usage
+
+Instanciate a new client with your community url and API keys:
+
+```ruby
+client = Rightnow::Client.new "http://community.company.com", :api_key => "YOUR_PUBLIC_KEY", :secret_key => "YOUR_PRIVATE_KEY"
+```
+
+Then you can query the API with:
+
+```ruby
+res = client.search term: 'white', limit: 50
+```
+
+Get more details for one or more post:
+
+```ruby
+client.post_get res.first
+client.post_get ["fa8e6cc713", "fa8e6cb714"]
+```
+
+Fetch all comments for a post:
+
+```ruby
+client.comment_list res.first
+client.comment_list "fa8e6cc713"
+```
+
+Add a comment:
+
+```ruby
+client.comment_add res.first, "Hello", as: 'user@email.com'
+client.comment_add "fa8e6cc713", "Hello", as: 'user@email.com'
+```
+
+Edit a comment:
+
+```ruby
+client.comment_update res.first, "Hello 2", as: 'user@email.com'
+client.comment_update "fa8e6cc713", "Hello 2", as: 'user@email.com'
+```
+
+Delete a comment:
+
+```ruby
+client.comment_delete 777, as: 'author@email.com'
+```
+
+Get more details for one or more users:
+
+```ruby
+client.user_get res.first.created_by.hash
+client.user_get ["fa8e6cc713", "fa8e6cb714"]
+```
+
+Or any other generic request:
+
+```ruby
+client.request 'UserList', :as => 'admin@domain.com'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rightnow-client.rb

@@ -0,0 +1 @@
+require 'rightnow'

data/lib/rightnow.rb

@@ -0,0 +1,11 @@
+require 'rightnow/version'
+
+require 'rightnow/ext/underscore'
+
+require 'rightnow/models/reputation'
+require 'rightnow/models/user'
+require 'rightnow/models/post'
+require 'rightnow/models/comment'
+
+require 'rightnow/error'
+require 'rightnow/client'

data/lib/rightnow/client.rb

@@ -0,0 +1,235 @@
+require 'openssl'
+require 'base64'
+require 'faraday'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+require 'json'
+require 'rexml/document'
+
+module Rightnow
+  class Client
+    attr_accessor :host, :api_key, :secret_key, :version
+
+    def initialize host, opts = {}
+      @host = host
+      @api_key = opts[:api_key]
+      @secret_key = opts[:secret_key]
+      @version = opts[:version] || '2010-05-15'
+
+      @conn = Faraday.new(:url => host) do |faraday|
+        # faraday.response :logger
+        faraday.adapter  :typhoeus
+      end
+    end
+
+    # Send a search query, returning an array of Rightnow::Models::Post
+    # results are limited to a few fields
+    #
+    # opts::
+    #   A hash of options accepted by Rightnow's Search method
+    #
+    # returns::
+    #   An array of Rightnow::Models::Post
+    #
+    # example:
+    #   +search :term => 'white', :sort => 'az', :limit => 50, :page => 1+
+    #
+    def search opts = {}
+      opts[:limit] ||= 20
+      opts[:objects] ||= 'Posts'
+      opts[:start] ||= (opts.delete(:page) - 1) * opts[:limit] + 1 if opts[:page]
+      results = request 'Search', opts
+      results.map {|r| Rightnow::Models::Post.new(r.underscore) }
+    end
+
+    # Retrieve full details for one or more posts.
+    # Run multiple queries in parallel.
+    #
+    # posts::
+    #   Either a single element or an array of Rightnow::Models::Post or post hash
+    #
+    # returns::
+    #   A single element or an array of Rightnow::Models::Post
+    #   depending on the argument (single value or array)
+    #
+    # example::
+    #   +post_get ["fa8e6cc713", "fa8e6cb714"]+
+    #
+    def post_get posts
+      responses = nil
+      @conn.in_parallel do
+        responses = [posts].flatten.map do |post|
+          hash = post.is_a?(Models::Post) ? post.hash : post
+          @conn.get 'api/endpoint', signed_params('PostGet', 'postHash' => hash)
+        end
+      end
+      result = responses.zip([posts].flatten).map do |res, post|
+        data = parse(res).underscore['post']
+        if post.is_a? Models::Post
+          post.attributes = data
+          post
+        elsif data.is_a? Hash
+          Rightnow::Models::Post.new(data.merge(:hash => post))
+        else
+          nil
+        end
+      end
+      posts.is_a?(Array) ? result : result.first
+    end
+
+    # Retrieve full details for one or more users.
+    # Run multiple queries in parallel.
+    #
+    # users::
+    #   Either a single element or an array of Rightnow::Models::User or user hash
+    #
+    # returns::
+    #   A single element or an array of Rightnow::Models::User
+    #   depending on the argument (single value or array)
+    #
+    # example::
+    #   +user_get ["fa8e6cc713", "fa8e6cb714"]+
+    #
+    def user_get users
+      responses = nil
+      @conn.in_parallel do
+        responses = [users].flatten.map do |user|
+          hash = user.is_a?(Models::User) ? user.hash : user
+          @conn.get 'api/endpoint', signed_params('UserGet', 'UserHash' => hash)
+        end
+      end
+      result = responses.zip([users].flatten).map do |res, user|
+        data = parse(res).underscore['user']
+        if user.is_a? Models::User
+          user.attributes = data
+          user
+        elsif data.is_a? Hash
+          Rightnow::Models::User.new(data.merge(:hash => user))
+        else
+          nil
+          end
+      end
+      users.is_a?(Array) ? result : result.first
+    end
+
+    # Retrieve comment list for a post.
+    #
+    # post::
+    #   An instance of Rightnow::Models::Post or a post hash (String)
+    #
+    # returns::
+    #   An array of Rightnow::Comment
+    #
+    # example::
+    #   +comment_list "fa8e6cc713"+
+    #
+    def comment_list post, opts = {}
+      hash = post.is_a?(Models::Post) ? post.hash : post
+      results = request 'CommentList', opts.merge('postHash' => hash)
+      raise Rightnow::Error.new("Missing `comments` key in CommentList response: #{results.inspect}") if not results['comments']
+      results.underscore['comments'].map { |r| Rightnow::Models::Comment.new(r) }
+    end
+
+    # Add a comment to a post.
+    #
+    # post::
+    #   An instance of Rightnow::Models::Post or a post hash (String)
+    #
+    # body::
+    #   The body of the comment (String)
+    #
+    # returns::
+    #   The instance of the newly created Rightnow::Comment
+    #
+    # example::
+    #   +comment_add "fa8e6cc713", "+1", :as => 'someone@domain.com'+
+    #
+    def comment_add post, body, opts = {}
+      hash = post.is_a?(Models::Post) ? post.hash : post
+      results = request 'CommentAdd', opts.merge('postHash' => hash, 'payload' => comment_xml_payload(body).to_s, :verb => :post)
+      raise Rightnow::Error.new("Missing `comment` key in CommentAdd response: #{results.inspect}") if not results['comment']
+      Rightnow::Models::Comment.new results['comment'].underscore
+    end
+
+    # Edit a comment.
+    #
+    # comment::
+    #   An instance of Rightnow::Models::Comment or a comment id (Integer)
+    #
+    # comment::
+    #   The updated body of the comment (String)
+    #
+    # returns::
+    #   The instance of the updated Rightnow::Comment
+    #
+    # example::
+    #   +comment_update 94224, "+1", :as => 'someone@domain.com'+
+    #
+    def comment_update comment, body, opts = {}
+      id = comment.is_a?(Models::Comment) ? comment.id : comment
+      results = request 'CommentUpdate', opts.merge('commentId' => id, 'payload' => comment_xml_payload(body, :for => :update).to_s, :verb => :post)
+      raise Rightnow::Error.new("Missing `comment` key in CommentUpdate response: #{results.inspect}") if not results['comment']
+      Rightnow::Models::Comment.new results['comment'].underscore
+    end
+
+    # Delete a comment.
+    #
+    # comment::
+    #   The id of the comment (Integer)
+    #
+    # example::
+    #   +comment_delete 777+
+    #
+    def comment_delete comment, opts = {}
+      request 'CommentDelete', opts.merge('commentId' => comment)
+    end
+
+    def request action, opts = {}
+      debug = opts.delete(:debug)
+      verb = opts.delete(:verb) || :get
+      response = @conn.send(verb, 'api/endpoint', signed_params(action, opts))
+      puts response.body if debug
+      parse response
+    end
+
+  protected
+
+    def parse response
+      body = JSON.parse(response.body || '')
+      if body.is_a?(Hash) and body.size == 1 and body['error'].is_a?(Hash)
+        raise Rightnow::Error.new(body['error']['message'], body['error']['code'])
+      elsif response.status != 200
+        raise Rightnow::Error.new("API returned #{response.status} without explanation: #{response.body}")
+      end
+      body
+    rescue JSON::ParserError
+      raise Rightnow::Error.new("Bad JSON received: #{response.body.inspect}")
+    end
+
+    def comment_xml_payload comment, opts = {}
+      xml = '<?xml version="1.0"?><comments><comment><value></value></comment></comments>'
+      # CommentUpdate action uses a slightly different markup -_-
+      xml.gsub!(/<\/?comments>/, '') if opts[:for] == :update
+      doc = REXML::Document.new xml
+      doc.elements['//value'].add REXML::CData.new comment
+      doc
+    end
+
+    def signed_params action, opts = {}
+      opts ||= {} if not opts.is_a? Hash
+      params = {
+        'Action' => action,
+        'ApiKey' => api_key,
+        'PermissionedAs' => opts.delete(:as) || 'hl.api@hivelive.com',
+        'SignatureVersion' => '2',
+        'version' => version
+      }
+      signstr = params.keys.sort_by(&:downcase).map {|k| "#{k}#{params[k]}" }.join
+      signature = Base64.strict_encode64(OpenSSL::HMAC::digest("sha1", secret_key, signstr))
+      params.merge({
+        'Signature' => signature,
+        'format' => 'json'
+      }).merge(opts)
+    end
+  end
+end

data/lib/rightnow/error.rb

@@ -0,0 +1,12 @@
+module Rightnow
+  class Error < StandardError
+    def initialize msg, code = nil
+      super msg
+      @code = code
+    end
+
+    def to_s
+      super + (@code.nil? ? '' : " (#{@code})")
+    end
+  end
+end

data/lib/rightnow/ext/underscore.rb

@@ -0,0 +1,16 @@
+def convert_hash_keys(value)
+  case value
+    when Array
+      value.map { |v| convert_hash_keys(v) }
+    when Hash
+      Hash[value.map { |k, v| [k.underscore, convert_hash_keys(v)] }]
+    else
+      value
+   end
+end
+
+class Hash
+  def underscore
+    convert_hash_keys(self)
+  end
+end

data/lib/rightnow/models/comment.rb

@@ -0,0 +1,32 @@
+require 'virtus'
+require 'rightnow/models/user'
+
+module Rightnow
+  module Models
+    class Comment
+      include Virtus
+
+      attribute :id, Integer
+      attribute :parent_id, Integer
+      attribute :uri, String
+      attribute :status, Integer
+      attribute :created, Integer
+      attribute :created_by, User
+      attribute :last_edited, Integer
+      attribute :last_edited_by, User
+      attribute :rating_count, Integer
+      attribute :rating_value_total, Integer
+      attribute :rating_weighted, Integer
+      attribute :flagged_count, Integer
+      attribute :value, String
+
+      def created_at
+        Time.at(created)
+      end
+
+      def last_edited_at
+        Time.at(last_edited)
+      end
+    end
+  end
+end