rightnow-client 0.0.6

data/lib/rightnow/models/field.rb

@@ -0,0 +1,19 @@
+require 'virtus'
+
+module Rightnow
+  module Models
+    class Field
+      include Virtus
+
+      attribute :id, Integer
+      attribute :value, String
+      attribute :name, String
+      attribute :type, Integer
+
+      def post_type_field= type
+        self.name = type['name']
+        self.type = type['type']
+      end
+    end
+  end
+end

data/lib/rightnow/models/post.rb

@@ -0,0 +1,58 @@
+require 'virtus'
+require 'rightnow/models/user'
+require 'rightnow/models/field'
+
+module Rightnow
+  module Models
+    class Post
+      include Virtus
+
+      # UserGet attributes
+      attribute :uri, String
+      attribute :post_type, Hash[String => String]
+      attribute :created, Integer
+      attribute :created_by, User
+      attribute :last_edited, Integer
+      attribute :last_edited_by, User
+      attribute :event_start, Time
+      attribute :event_end, Time
+      attribute :event_time_zone, String
+      attribute :title, String
+      attribute :status, Integer
+      attribute :comment_count, Integer
+      attribute :view_count, Integer
+      attribute :rating_count, Integer
+      attribute :rating_total, Integer
+      attribute :flag_count, Integer
+      attribute :fields, Array[Field]
+
+      # Search only attributes
+      attribute :id, Integer
+      attribute :hash, String
+      attribute :web_url, String
+      attribute :hive_id, Integer
+      attribute :answer_id, Integer
+      attribute :answer_selected_by_id, Integer
+      attribute :answer_selected, Boolean # ?
+      attribute :last_activity, Integer
+      attribute :preview, String
+
+      def post_type_id= value
+        self.post_type['id'] = value
+      end
+
+      def created_at
+        Time.at(created)
+      end
+
+      def last_edited_at
+        Time.at(last_edited)
+      end
+
+      def last_activity_at
+        Time.at(last_activity)
+      end
+
+    end
+  end
+end

data/lib/rightnow/models/reputation.rb

@@ -0,0 +1,13 @@
+require 'virtus'
+
+module Rightnow
+  module Models
+    class Reputation
+      include Virtus
+
+      attribute :level, String
+      attribute :score, Integer
+      attribute :avatar, String
+    end
+  end
+end

data/lib/rightnow/models/user.rb

@@ -0,0 +1,44 @@
+require 'virtus'
+require 'rightnow/models/reputation'
+
+module Rightnow
+  module Models
+    class User
+      include Virtus
+
+      attribute :guid, String
+      attribute :hash, String, default: lambda { |u,v| u.api_uri.scan(/[0-9a-z]{10}\z/).first }
+      attribute :web_uri, String
+      attribute :api_uri, String
+      attribute :login_id, String
+      attribute :user_id, Integer
+      attribute :name, String
+      attribute :avatar, String
+      attribute :email, String
+      attribute :type, Integer
+      attribute :status, Integer
+      attribute :guid, Integer
+      attribute :created, Integer
+      attribute :last_login, Integer
+      attribute :buddy_count, Integer
+      attribute :group_count, Integer
+      attribute :hive_count, Integer
+      attribute :post_count, Integer
+      attribute :comment_count, Integer
+      attribute :comments_selected_as_best_answer_count, Integer
+      attribute :reputation, Reputation
+
+      def created_at
+        Time.at(created)
+      end
+
+      def last_login_at
+        Time.at(last_login)
+      end
+
+      def uri= value
+        self.api_uri = value
+      end
+    end
+  end
+end

data/lib/rightnow/version.rb

@@ -0,0 +1,3 @@
+module Rightnow
+  VERSION = "0.0.6"
+end

data/rightnow.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rightnow/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rightnow-client"
+  gem.version       = Rightnow::VERSION
+  gem.authors       = ["Adrien Jarthon"]
+  gem.email         = ["adrien.jarthon@dimelo.com"]
+  gem.description   = %q{Rightnow API Ruby wrapper}
+  gem.summary       = %q{Ruby wrapper for the Oracle Rightnow Social API v2}
+  gem.homepage      = "https://github.com/dimelo/rightnow"
+
+  gem.add_dependency 'faraday', '>= 0.8.0'
+  gem.add_dependency 'virtus', '>= 0.5.3'
+  gem.add_dependency 'typhoeus', '>= 0.5.0'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'webmock', '~> 1.8'
+  gem.add_development_dependency 'rake'
+  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{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/client_spec.rb

@@ -0,0 +1,197 @@
+require 'spec_helper'
+
+describe Rightnow::Client do
+  let(:client) { Rightnow::Client.new "http://something", :api_key => "API", :secret_key => "SECRET" }
+
+  describe ".initialize" do
+    it "should store host and default attributes" do
+      client = Rightnow::Client.new "http://community.company.com"
+      client.host.should == "http://community.company.com"
+      client.api_key.should == nil
+      client.secret_key.should == nil
+      client.version.should == '2010-05-15'
+    end
+
+    it "accepts options" do
+      client = Rightnow::Client.new "host", :api_key => "APIKEY", :secret_key => "SECRETKEY", :version => '2042-13-13'
+      client.api_key.should == "APIKEY"
+      client.secret_key.should == "SECRETKEY"
+      client.version.should == '2042-13-13'
+    end
+  end
+
+  describe '#search' do
+    it "compute correct request" do
+      stub_request(:get, "http://something/api/endpoint?Action=Search&ApiKey=API&PermissionedAs=hl.api@hivelive.com&Signature=nwmG/dgt9MLvq1CXWTtSLqcaaaY=&SignatureVersion=2&format=json&limit=20&objects=Posts&sort=az&start=21&term=white&version=2010-05-15").to_return :body => '[]'
+      client.search(:term => 'white', :sort => 'az', :page => 2).should == []
+    end
+
+    it "returns correctly parsed response" do
+      stub_request(:get, /.*/).to_return :body => fixture('search.json')
+      response = client.search
+      response.should have(5).items
+      response.first.should be_instance_of(Rightnow::Models::Post)
+    end
+  end
+
+  describe '#post_get' do
+    it "compute correct request" do
+      stub_request(:get, "http://something/api/endpoint?Action=PostGet&ApiKey=API&PermissionedAs=hl.api@hivelive.com&Signature=bFdCqLpLcCHT3jQEz7nndKrVVk8=&SignatureVersion=2&format=json&postHash=fa8e6cc713&version=2010-05-15").to_return :body => '{}'
+      client.post_get("fa8e6cc713").should be_nil
+    end
+
+    context "with stubbed answer" do
+      before { stub_request(:get, /.*/).to_return :body => fixture('post_get.json') }
+
+      it "returns correctly parsed response" do
+        response = client.post_get "fa8e6cc713"
+        response.should be_instance_of(Rightnow::Models::Post)
+        response.view_count.should == 795
+        response.hash.should == "fa8e6cc713"
+      end
+
+      it "accepts multiple elements" do
+        posts = client.post_get ["fa8e6cc713", "fa8e6cb714"]
+        posts.should have(2).items
+        posts.first.should be_instance_of(Rightnow::Models::Post)
+      end
+
+      it "accepts Rightnow::Post instances" do
+        post = Rightnow::Models::Post.new(:hash => "fa8e6cc713")
+        res = client.post_get post
+        res.should be_instance_of(Rightnow::Models::Post)
+        res.view_count.should == 795
+      end
+
+      it "merges input Rightnow::Post instance with results" do
+        post = Rightnow::Models::Post.new(:hash => "fa8e6cc713")
+        res = client.post_get post
+        res.view_count.should == 795
+        res.hash.should == "fa8e6cc713"
+      end
+    end
+  end
+
+  describe '#comment_list' do
+    it "compute correct request" do
+      stub_request(:get, "http://something/api/endpoint?Action=CommentList&ApiKey=API&PermissionedAs=toto&Signature=0J8ggfqObzTGxydijxgdLSvNzds=&SignatureVersion=2&format=json&postHash=fa8e6cc713&version=2010-05-15").to_return :body => '{"comments": []}'
+      client.comment_list("fa8e6cc713", as: 'toto').should == []
+      # the `as: 'toto'` hack is just here to change the signature,
+      # webmock doesn't like the original one: AEyyp+MpfxT/DlhRqAfzvT1dFCM
+    end
+
+    it "raise error in case of bad return value" do
+      stub_request(:get, /.*/).to_return body: '{}'
+      expect {
+        client.comment_list "fa8e6cc713"
+      }.to raise_error(Rightnow::Error, "Missing `comments` key in CommentList response: {}")
+    end
+
+    context "with stubbed answer" do
+      before { stub_request(:get, /.*/).to_return body: fixture('comment_list.json') }
+
+      it "returns correctly parsed response" do
+        response = client.comment_list "fa8e6cc713"
+        response.should have(3).items
+        response.first.should be_instance_of(Rightnow::Models::Comment)
+      end
+    end
+  end
+
+  describe '#comment_add' do
+    it "compute correct request" do
+      pending "couldn't get this test passing" do
+        stub_request(:post, "http://something/api/endpoint").with(:body => {"Action"=>"CommentAdd", "ApiKey"=>"API", "PermissionedAs"=>"toto", "Signature"=>"kJXXoPZ7xexKxv8duTYmtS519GY=", "SignatureVersion"=>"2", "format"=>"json", "payload"=>"<?xml version='1.0'?><comments><comment><value><![CDATA[test]]></value></comment></comments>", "postHash"=>"fa8e6cc713", "version"=>"2010-05-15"}).to_return :body => ""
+        client.comment_add("fa8e6cc713", 'test', as: 'toto')
+      end
+    end
+
+    it "return comment model" do
+      stub_request(:post, "http://something/api/endpoint").to_return :body => fixture('comment_add.json')
+      client.comment_add("fa8e6cc713", 'test', as: 'toto').should be_instance_of Rightnow::Models::Comment
+    end
+  end
+
+  describe '#comment_update' do
+
+    it "return comment model" do
+      stub_request(:post, "http://something/api/endpoint").to_return :body => fixture('comment_add.json')
+      client.comment_update(777, 'test', as: 'toto').should be_instance_of Rightnow::Models::Comment
+    end
+  end
+
+  describe '#comment_delete' do
+    it "compute correct request" do
+      stub_request(:get, "http://something/api/endpoint?Action=CommentDelete&ApiKey=API&PermissionedAs=hl.api@hivelive.com&Signature=BdDIajOi/eZprayZ8X8eEsH1yb4=&SignatureVersion=2&commentId=777&format=json&version=2010-05-15").to_return body: '{"comment": {"id": 777}}'
+      client.comment_delete(777).should == {'comment' => {'id' => 777}}
+    end
+  end
+
+  describe "#request" do
+    it "compute correct request" do
+      stub_request(:get, "http://something/api/endpoint?Action=UserList&ApiKey=API&PermissionedAs=hl.api@hivelive.com&Signature=wLTpdU5EEyYBlDg%2BMz5AGEAPs98=&SignatureVersion=2&format=json&version=2010-05-15").to_return :body => '{}'
+      client.request('UserList').should == {}
+    end
+
+    it "raise correct exceptions on 401" do
+      stub_request(:get, /.*/).to_return(:status => 401, :body => '{"error":{"message":"invalid parameter","code":42}}')
+      expect {
+        client.request 'UserList'
+      }.to raise_error(Rightnow::Error, "invalid parameter (42)")
+    end
+
+    it "raise correct exceptions on error without details" do
+      stub_request(:get, /.*/).to_return(:status => 401, :body => '{"something":"happened"}')
+      expect {
+        client.request 'UserList'
+      }.to raise_error(Rightnow::Error, 'API returned 401 without explanation: {"something":"happened"}')
+    end
+
+    it "raise correct exceptions on bad JSON" do
+      stub_request(:get, /.*/).to_return(:status => 200, :body => 'bad')
+      expect {
+        client.request 'UserList'
+      }.to raise_error(Rightnow::Error, 'Bad JSON received: "bad"')
+    end
+
+    it "parse JSON response correctly" do
+      stub_request(:get, /.*/).
+        to_return(:status => 200, :body => fixture('search.json'))
+      results = client.request 'Search'
+      results.should have(5).items
+      results.first.should == fixture('post.rb', :ruby)
+    end
+  end
+
+  describe "#comment_xml_paypload" do
+    it "should generate correct XML payload" do
+      client.send(:comment_xml_payload, "test").to_s.should == "<?xml version='1.0'?><comments><comment><value><![CDATA[test]]></value></comment></comments>"
+    end
+  end
+
+  describe "#signed_params" do
+    subject { client.send :signed_params, "Something" }
+
+    it { should include('Action' => 'Something', 'ApiKey' => 'API') }
+    it { should include('version' => '2010-05-15', 'SignatureVersion' => '2') }
+    it { should include('PermissionedAs' => 'hl.api@hivelive.com') }
+    it { should include('Signature' => 'vIONtWGXvdAG/McOTM0KuFD+O2g=') }
+    it { should include('format' => 'json') }
+    its(:size) { should == 7 }
+
+    context "with custom permission" do
+      subject { client.send :signed_params, "Something", :as => 'email@domain.com' }
+
+      it { should include('PermissionedAs' => 'email@domain.com') }
+      it { should include('Signature' => 'i66NBNtwG21kxDHYOVMQpb7bhzk=') }
+      it { should_not include('as') }
+    end
+
+    context "with custom values" do
+      subject { client.send :signed_params, "Something", 'term' => 'white' }
+
+      it { should include('Signature' => 'vIONtWGXvdAG/McOTM0KuFD+O2g=') }
+      it { should include('term' => 'white') }
+    end
+  end
+end

data/spec/fixtures/comment_add.json

@@ -0,0 +1,21 @@
+{"comment":{
+  "id":96082,
+  "uri":"http://community.belgacom.be/api/comments/96082",
+  "created":1357558716, "createdBy":{
+    "hash":"50ed7819d1",
+    "uri":"http://community.belgacom.be/api/users/50ed7819d1",
+    "loginId":"50ed7819d1",
+    "name":"Adrien .",
+    "avatar":"http:\/\/community.belgacom.be\/common\/images\/avatars\/user\/default.jpg" },
+  "lastEdited":1357558716,    "lastEditedBy":{
+    "hash":"50ed7819d1",
+    "uri":"http://community.belgacom.be/api/users/50ed7819d1",
+    "loginId":"50ed7819d1",
+    "name":"Adrien .",
+      "avatar":"http:\/\/community.belgacom.be\/common\/images\/avatars\/user\/default.jpg" },
+  "status":1,
+    "hiveHash":"e93ba3507b",
+    "hiveName":"Autres",
+    "postHash":"e41899881f",
+    "postName":"Site - lenteur",
+    "value":"Oui, et ca dure..."}}

data/spec/fixtures/comment_list.json

@@ -0,0 +1,120 @@
+{
+  "permissionsForRequestingUser":{
+    "admin":0,
+    "tagCreate":0,
+    "tagApplyOwn":0,
+    "tagApplyAll":0,
+    "postCreate":0,
+    "postViewOwn":1,
+    "postViewAll":1,
+    "postEditOwn":0,
+    "postEditAll":0,
+    "commentCreate":0,
+    "commentViewOwn":1,
+    "commentViewAll":1,
+    "commentEditOwn":0,
+    "commentEditAll":0,
+    "flaggingEnabled":1,
+    "ratingEnabled":0
+  },
+  "comments":[{
+    "id":94224,
+    "parentId":null,
+    "uri":"http://communityname.com/api/comments/94224",
+    "status":1,
+    "created":1355765048,
+    "createdBy":{
+      "name":"Francoise .",
+      "guid":"35948",
+      "avatar":"http://communityname.com/common/images/avatars/user/default.jpg",
+      "webUri":"http://communityname.com/people/3e2ce69336",
+      "apiUri":"http://communityname.com/api/users/3e2ce69336"
+    },
+    "lastEdited":1355765048,
+    "lastEditedBy":{
+      "name":"Francoise .",
+      "guid":"35948",
+      "avatar":"http://communityname.com/common/images/avatars/user/default.jpg",
+      "webUri":"http://communityname.com/people/3e2ce69336",
+      "apiUri":"http://communityname.com/api/users/3e2ce69336"
+    },
+    "ratingCount":0,
+    "ratingValueTotal":0,
+    "ratingWeighted":0,
+    "ratedByRequestingUser":{
+      "created":null,
+      "ratingValue":null
+    },
+    "flaggedCount":0,
+    "flaggedByRequestingUser":{
+      "created":null
+    },
+    "value":"<p>\r\n\tEn ce qui me concerne, ce n&#39;est pas le site qui est lent, c&#39;est l&#39;ensemble de ma connexion qui se tra&icirc;ne et impossible d&#39;avoir une r&eacute;ponse quand je demande, depuis 1 an, quand la ligne sera enfin convenable.&nbsp; La fibre optique a &eacute;t&eacute; plac&eacute;e &agrave; environ 150 m&egrave;tres de chez moi mais nul ne sait ni le jour ni l&#39;heure du raccord aux habitations.<\/p>\r\n<p>\r\n\tConclusion : ma facture est de 100 %, ma connexion maximum de 10 %.<\/p>\r\n<p>\r\n\tInsupportable !<\/p>"
+  },{
+    "id":94226,
+    "parentId":null,
+    "uri":"http://communityname.com/api/comments/94226",
+    "status":1,
+    "created":1355766489,
+    "createdBy":{
+      "name":"Max .",
+      "guid":"23325",
+      "avatar":"http://communityname.com/files/3db01561ac/cellulo&#45;armored&#45;tux.png",
+      "webUri":"http://communityname.com/people/a964f9cfd3",
+      "apiUri":"http://communityname.com/api/users/a964f9cfd3"
+    },
+    "lastEdited":1355766489,
+    "lastEditedBy":{
+      "name":"Max .",
+      "guid":"23325",
+      "avatar":"http://communityname.com/files/3db01561ac/cellulo&#45;armored&#45;tux.png",
+      "webUri":"http://communityname.com/people/a964f9cfd3",
+      "apiUri":"http://communityname.com/api/users/a964f9cfd3"
+    },
+    "ratingCount":0,
+    "ratingValueTotal":0,
+    "ratingWeighted":0,
+    "ratedByRequestingUser":{
+      "created":null,
+      "ratingValue":null
+    },
+    "flaggedCount":0,
+    "flaggedByRequestingUser":{
+      "created":null
+    },
+    "value":"<p>\r\n\tD&#39;accord avec vous, mais ce n&#39;est pas l&#39;objet du pr&eacute;sent message...<img alt=\"surprise\" height=\"20\" src=\"http:\/\/communityname.com\/common\/js\/ckeditor\/plugins\/smiley\/images\/omg_smile.gif\" title=\"surprise\" width=\"20\" \/><\/p>"
+  },{
+    "id":94233,
+    "parentId":null,
+    "uri":"http://communityname.com/api/comments/94233",
+    "status":1,
+    "created":1355768533,
+    "createdBy":{
+      "name":"euronamur",
+      "guid":"1204",
+      "avatar":"http://communityname.com/files/6e10df597f/Oeildouble.jpg",
+      "webUri":"http://communityname.com/people/427e63c8db",
+      "apiUri":"http://communityname.com/api/users/427e63c8db"
+    },
+    "lastEdited":1355768533,
+    "lastEditedBy":{
+      "name":"euronamur",
+      "guid":"1204",
+      "avatar":"http://communityname.com/files/6e10df597f/Oeildouble.jpg",
+      "webUri":"http://communityname.com/people/427e63c8db",
+      "apiUri":"http://communityname.com/api/users/427e63c8db"
+    },
+    "ratingCount":0,
+    "ratingValueTotal":0,
+    "ratingWeighted":0,
+    "ratedByRequestingUser":{
+      "created":null,
+      "ratingValue":null
+    },
+    "flaggedCount":0,
+    "flaggedByRequestingUser":{
+      "created":null
+    },
+    "value":"<p>\r\n\tM&ecirc;me probl&egrave;me pour moi Max , sur le forum.<img alt=\"wink\" height=\"20\" src=\"http:\/\/communityname.com\/common\/js\/ckeditor\/plugins\/smiley\/images\/wink_smile.gif\" title=\"wink\" width=\"20\" \/><\/p>\r\n<p>\r\n\t&nbsp;<\/p>\r\n<p>\r\n\t@+Gilbert<img alt=\"cool\" height=\"20\" src=\"http:\/\/communityname.com\/common\/js\/ckeditor\/plugins\/smiley\/images\/shades_smile.gif\" title=\"cool\" width=\"20\" \/><\/p>"
+  }]
+}