rightnow-client 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a503192ee12a709f60ed2c9c35d260aa92a12bc8
+  data.tar.gz: 0d308838e94946b71241c6b30bdfec5c1660b9ed
+SHA512:
+  metadata.gz: ca65d6350e1c34e90016a1b224e3e2d8e915d61567c24cc2b5a84642b325877807ef7aca19baf628f849de2c8c3bd401f3bff6b84494a53027a00046303db1a2
+  data.tar.gz: e6915e566815a54b5ff657850b51ae16ee9a113da0a9f0c6bece3387fa4c4c9f0a1dfb6f8414c7a8cb2870ef29e338ac9817a4bbdcf783556b20e1c7d17579dc

data/README.md

@@ -20,13 +20,15 @@ Or install it yourself as:
 
 ## Usage
 
-Instanciate a new client with your community url and API keys:
+Instanciate a new client with your community url, API keys and API default user:
 
 ```ruby
-client = Rightnow::Client.new "http://community.company.com", :api_key => "YOUR_PUBLIC_KEY", :secret_key => "YOUR_PRIVATE_KEY"
+client = Rightnow::Client.new "http://community.company.com", :api_key => "YOUR_PUBLIC_KEY", :secret_key => "YOUR_PRIVATE_KEY", :user => "api@dimelo.com"
 ```
 
-Then you can query the API with:
+The user specified here is a user of the community (usually a superadmin) which must have the permissions for all the actions you want to do with the client.
+
+Then you can query the search API with:
 
 ```ruby
 res = client.search term: 'white', limit: 50
@@ -79,6 +81,14 @@ Or any other generic request:
 client.request 'UserList', :as => 'admin@domain.com'
 ```
 
+## Debug
+
+Instanciate the client with a `:debug => true` option to get debug info:
+
+```ruby
+client = Rightnow::Client.new "http://community.company.com", ..., :debug => true
+```
+
 ## Contributing
 
 1. Fork it

data/lib/rightnow/client.rb

@@ -8,16 +8,18 @@ require 'rexml/document'
 
 module Rightnow
   class Client
-    attr_accessor :host, :api_key, :secret_key, :version
+    attr_accessor :host, :api_key, :secret_key, :version, :user, :debug
 
     def initialize host, opts = {}
       @host = host
       @api_key = opts[:api_key]
       @secret_key = opts[:secret_key]
+      @user = opts[:user] || 'hl.api@hivelive.com'
       @version = opts[:version] || '2010-05-15'
+      @debug = opts[:debug]
 
       @conn = Faraday.new(:url => host) do |faraday|
-        # faraday.response :logger
+        faraday.response :logger if @debug
         faraday.adapter  :typhoeus
       end
     end
@@ -185,10 +187,9 @@ module Rightnow
     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
+      puts response.body if @debug
       parse response
     end
 
@@ -220,7 +221,7 @@ module Rightnow
       params = {
         'Action' => action,
         'ApiKey' => api_key,
-        'PermissionedAs' => opts.delete(:as) || 'hl.api@hivelive.com',
+        'PermissionedAs' => opts.delete(:as) || @user,
         'SignatureVersion' => '2',
         'version' => version
       }

data/lib/rightnow/ext/underscore.rb

@@ -13,4 +13,14 @@ class Hash
   def underscore
     convert_hash_keys(self)
   end
+end
+
+# backport
+require 'active_support'
+class String
+  # http://apidock.com/rails/String/underscore
+  # File activesupport/lib/active_support/core_ext/string/inflections.rb, line 118
+  def underscore
+    ActiveSupport::Inflector.underscore(self)
+  end
 end

data/lib/rightnow/version.rb

@@ -1,3 +1,3 @@
 module Rightnow
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/rightnow.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec', '~> 2.6'
   gem.add_development_dependency 'webmock', '~> 1.8'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'activesupport'
   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)/})

data/spec/client_spec.rb

@@ -10,13 +10,15 @@ describe Rightnow::Client do
       client.api_key.should == nil
       client.secret_key.should == nil
       client.version.should == '2010-05-15'
+      client.user.should == 'hl.api@hivelive.com'
     end
 
     it "accepts options" do
-      client = Rightnow::Client.new "host", :api_key => "APIKEY", :secret_key => "SECRETKEY", :version => '2042-13-13'
+      client = Rightnow::Client.new "host", :api_key => "APIKEY", :secret_key => "SECRETKEY", :version => '2042-13-13', :user => 'api@domain.com'
       client.api_key.should == "APIKEY"
       client.secret_key.should == "SECRETKEY"
       client.version.should == '2042-13-13'
+      client.user.should == 'api@domain.com'
     end
   end
 
@@ -26,10 +28,15 @@ describe Rightnow::Client do
       client.search(:term => 'white', :sort => 'az', :page => 2).should == []
     end
 
+    it "accepts `as` option" do
+      stub_request(:get, "http://something/api/endpoint?Action=Search&ApiKey=API&PermissionedAs=api@domain.com&Signature=MmHBXKKsEfJJPX8EW%2B8ZqMnGEGc=&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, :as => 'api@domain.com').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.size.should == 5
       response.first.should be_instance_of(Rightnow::Models::Post)
     end
   end
@@ -52,7 +59,7 @@ describe Rightnow::Client do
 
       it "accepts multiple elements" do
         posts = client.post_get ["fa8e6cc713", "fa8e6cb714"]
-        posts.should have(2).items
+        posts.size.should == 2
         posts.first.should be_instance_of(Rightnow::Models::Post)
       end
 
@@ -92,7 +99,7 @@ describe Rightnow::Client do
 
       it "returns correctly parsed response" do
         response = client.comment_list "fa8e6cc713"
-        response.should have(3).items
+        response.size.should == 3
         response.first.should be_instance_of(Rightnow::Models::Comment)
       end
     end
@@ -100,10 +107,8 @@ describe Rightnow::Client do
 
   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
+      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 => '{"comment": {}}'
+      client.comment_add("fa8e6cc713", 'test', as: 'toto')
     end
 
     it "return comment model" do
@@ -158,7 +163,7 @@ describe Rightnow::Client do
       stub_request(:get, /.*/).
         to_return(:status => 200, :body => fixture('search.json'))
       results = client.request 'Search'
-      results.should have(5).items
+      results.size.should == 5
       results.first.should == fixture('post.rb', :ruby)
     end
   end
@@ -177,7 +182,7 @@ describe Rightnow::Client do
     it { should include('PermissionedAs' => 'hl.api@hivelive.com') }
     it { should include('Signature' => 'vIONtWGXvdAG/McOTM0KuFD+O2g=') }
     it { should include('format' => 'json') }
-    its(:size) { should == 7 }
+    it { subject.size.should == 7 }
 
     context "with custom permission" do
       subject { client.send :signed_params, "Something", :as => 'email@domain.com' }
@@ -193,5 +198,14 @@ describe Rightnow::Client do
       it { should include('Signature' => 'vIONtWGXvdAG/McOTM0KuFD+O2g=') }
       it { should include('term' => 'white') }
     end
+
+    context "with custom user in client" do
+      before { client.user = 'api@domain.com' }
+
+      it { should include('PermissionedAs' => 'api@domain.com') }
+      it { should include('Signature' => 'tdUCB7FafhflaQ/pCIWK+NQnhMY=') }
+      it { should_not include('as') }
+    end
+
   end
 end

data/spec/models/post_spec.rb

@@ -59,7 +59,7 @@ describe Rightnow::Models::Post do
     end
 
     it "stores fields details" do
-      post.fields.should have(2).items
+      post.fields.size.should == 2
       # Title
       post.fields.first.should be_instance_of(Rightnow::Models::Field)
       post.fields.first.id.should == 40695

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'rightnow'
 require 'webmock/rspec'
 
 RSpec.configure do |config|
-  config.color_enabled = true
+  config.color = true
 end
 
 # Simple helper loading fixture content and applying choosen parser

metadata

@@ -1,112 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: rightnow-client
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrien Jarthon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
-    none: false
-  name: faraday
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-    none: false
-  name: virtus
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
-    none: false
-  name: typhoeus
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-    none: false
-  name: rspec
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    none: false
-  name: webmock
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: rake
   type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: Rightnow API Ruby wrapper
 email:
 - adrien.jarthon@dimelo.com
@@ -114,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -147,27 +148,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/dimelo/rightnow
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby wrapper for the Oracle Rightnow Social API v2
 test_files:
 - spec/client_spec.rb
@@ -182,4 +182,3 @@ test_files:
 - spec/models/post_spec.rb
 - spec/models/user_spec.rb
 - spec/spec_helper.rb
-has_rdoc: