livechat_client 0.0.1

data/spec/livechat/rest/groups_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+include WebMock::API
+
+
+describe LiveChat::REST::Groups do
+  before do
+    @livechat = create_client
+
+    stub_rest 'groups'
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+
+  it "lists all groups" do
+    @livechat.groups
+  end
+
+  it "gets a single group details" do
+    @livechat.groups(2)
+  end
+
+  it "creates a new group" do
+    @livechat.groups.create do |group|
+      group[:name] = 'Human Resources'
+      group[:agents] = ['jenny.doe@mycompany.com', 'john.doe@mycompany.com']
+    end
+  end
+
+  it "updates a group" do
+    @livechat.groups(3).update do |group|
+      group[:name] = 'Quality Assurance'
+      group[:agents] = ['jane.doe@mycompany.com']
+    end
+  end
+
+  it "removes a group" do
+    @livechat.groups(4).delete
+  end
+
+end
+

data/spec/livechat/rest/reports_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+include WebMock::API
+
+
+describe LiveChat::REST::Reports do
+  before do
+    @livechat = create_client
+    @reports_base = "#{ENDPOINT}/reports"
+    stub_request(:get, /#{@reports_base}/).to_return(:body => {})
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+  it "gets dashboard data" do
+    @livechat.reports.dashboard
+    expect(@livechat.last_request.path).to eq '/reports/dashboard'
+  end
+
+  it "gets dashboard data for agent" do
+    @livechat.reports.dashboard(:agent => 'john.doe@mycompany.com')
+  end
+
+  it "gets dashboard data for group" do
+    @livechat.reports.dashboard(:group => 1)
+    expect(@livechat.last_request.path).to eq '/reports/dashboard/group/1'
+  end
+
+  it "gets chats report" do
+    @livechat.reports.chats(:date_from => '2013-01-01')
+    expect(@livechat.last_request.path).to eq '/reports/chats?date_from=2013-01-01'
+  end
+
+  it "gets ratings report" do
+    @livechat.reports.ratings(:group => 1)
+    expect(@livechat.last_request.path).to eq '/reports/ratings?group=1'
+  end
+
+  it "gets ratings ranking" do
+    @livechat.reports.ratings_ranking(:group => 1)
+  end
+
+  it "gets queued visitors report" do
+    @livechat.reports.queued_visitors(:date_from => '2013-01-01')
+  end
+
+  it "gets queue waiting times report" do
+    @livechat.reports.queued_visitors_waiting_times(:date_from => '2013-01-01')
+  end
+
+  it "gets availability report" do
+    @livechat.reports.availability
+  end
+
+  it "gets chatting time report" do
+    @livechat.reports.chatting_time
+  end
+
+  it "gets goals report" do
+    @livechat.reports.goals
+    expect(@livechat.last_request.path).to eq '/reports/goals'
+  end
+
+end
+

data/spec/livechat/rest/status_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+include WebMock::API
+
+
+describe LiveChat::REST::Status do
+  before do
+    @livechat = create_client
+
+    stub_request(:any, /.*status/)
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+  it "gets status" do
+    @livechat.status(:group => 0)
+  end
+
+end
+

data/spec/livechat/rest/visitors_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+include WebMock::API
+
+
+describe LiveChat::REST::Visitors do
+  before do
+    @livechat = create_client
+
+    base = "#{ENDPOINT}/visitors"
+    stub_request(:post, /#{base}/)
+    stub_request(:get, "#{base}").to_return(:body => fixture('visitors.json'))
+
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+
+  it "lists all visitors" do
+    visitors = @livechat.visitors
+    expect(visitors.list.length).to be(2)
+
+  end
+
+  it "lists only chatting visitors" do
+    @livechat.visitors.chatting
+  end
+
+  it "adds custom visitor details" do
+    @livechat.visitors('S1352647457.ac951bfe2e').add_details do |detail|
+      detail[:license_id] = '12345'
+      detail[:token] = '26132406c42c96ba61ed42689b70f719'
+      detail[:id] = 'my-app'
+      #todo: need to test array encoding for the fields parameter. example:
+      #curl -H X-API-Version:2 https://api.livechatinc.com/visitors/S1352647457.ac951bfe2e/details -X POST
+      #-d "license_id=12345&token=26132406c42c96ba61ed42689b70f719&id=my-app&fields[0][name]=Age&fields[0][value]=36"
+      detail[:fields] = [{:name => 'Age', :value => 36}]
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'livechat'
+require 'webmock/rspec'
+require 'json'
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + "/" + file).read.to_s
+end
+
+def stub_rest(resource_name)
+  base = "#{ENDPOINT}/#{resource_name}"
+  singular = resource_name.chop #todo inflect
+  stub_request(:delete, /#{base}/)
+  stub_request(:any, /#{base}/).to_return(:body => fixture("#{singular}.json"))
+  stub_request(:get, "#{base}").to_return(:body => fixture("#{resource_name}.json"))
+end
+
+if ENV["LIVE"]
+  LOGIN    = ENV["LIVECHAT_LOGIN"]
+  API_KEY = ENV["LIVECHAT_API_KEY"]
+else
+  LOGIN, API_KEY = "ignored_login", "ignored_api_key"
+  ENDPOINT = "https://#{LOGIN}:#{API_KEY}@ignored:443"
+end
+
+LiveChat::REST::Client::DEFAULTS[:host] = 'ignored'
+
+def create_client
+  LiveChat::REST::Client.new do |config|
+    config[:login] = LOGIN
+    config[:api_key] = API_KEY
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: livechat_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexandre Maia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for the REST API at http://developers.livechatinc.com/rest-api/
+email:
+- alexandre.maia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- conf/cacert.pem
+- lib/livechat.rb
+- lib/livechat/rest/agents.rb
+- lib/livechat/rest/canned_responses.rb
+- lib/livechat/rest/chats.rb
+- lib/livechat/rest/client.rb
+- lib/livechat/rest/errors.rb
+- lib/livechat/rest/goals.rb
+- lib/livechat/rest/groups.rb
+- lib/livechat/rest/instance_resource.rb
+- lib/livechat/rest/list_resource.rb
+- lib/livechat/rest/reports.rb
+- lib/livechat/rest/status.rb
+- lib/livechat/rest/utils.rb
+- lib/livechat/rest/visitors.rb
+- lib/livechat/util.rb
+- lib/livechat/version.rb
+- livechat_client.gemspec
+- spec/fixtures/agent.json
+- spec/fixtures/agents.json
+- spec/fixtures/canned_response.json
+- spec/fixtures/canned_responses.json
+- spec/fixtures/chat.json
+- spec/fixtures/chats.json
+- spec/fixtures/goal.json
+- spec/fixtures/goals.json
+- spec/fixtures/group.json
+- spec/fixtures/groups.json
+- spec/fixtures/visitors.json
+- spec/livechat/rest/agents_spec.rb
+- spec/livechat/rest/canned_responses_spec.rb
+- spec/livechat/rest/chats_spec.rb
+- spec/livechat/rest/goals_spec.rb
+- spec/livechat/rest/groups_spec.rb
+- spec/livechat/rest/reports_spec.rb
+- spec/livechat/rest/status_spec.rb
+- spec/livechat/rest/visitors_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cxz/livechat_client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- livechat
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: LiveChat REST API Client
+test_files:
+- spec/livechat/rest/agents_spec.rb
+- spec/livechat/rest/groups_spec.rb
+- spec/livechat/rest/status_spec.rb
+- spec/livechat/rest/chats_spec.rb
+- spec/livechat/rest/canned_responses_spec.rb
+- spec/livechat/rest/goals_spec.rb
+- spec/livechat/rest/visitors_spec.rb
+- spec/livechat/rest/reports_spec.rb
+- spec/spec_helper.rb
+has_rdoc: