livechat_client 0.0.1

data/lib/livechat/rest/reports.rb

@@ -0,0 +1,116 @@
+module LiveChat
+  module REST
+    class Reports < ListResource
+
+      #http://developers.livechatinc.com/rest-api/#get-dashboard-data
+      def dashboard(*arg)
+        params = Hash[*arg]
+        if params.has_key? :agent
+          return dashboard_agent params[:agent]
+
+        elsif params.has_key? :group
+          return dashboard_group params[:group]
+        end
+
+        @client.get "#{@path}/dashboard"
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-dashboard-data-for-agent
+      def dashboard_agent(login)
+        @client.get "#{@path}/dashboard/agent/#{login}"
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-dashboard-data-for-group
+      def dashboard_group(group_id)
+        @client.get "#{@path}/dashboard/group/#{group_id}"
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-chats-report
+      #optional arguments:
+      # date_from - YYYY-MM-DD, defaults to the beginning of time.
+      # date_to - YYYY-MM-DD, defaults to today.
+      # group - id of the group, not set by default, returns statistics for the specified group.
+      # agent - agent's login, not set by default, return statistics for the specified agent.
+      # group_by - defaults to day (or hour when date_from equals date_to), can be set to month or hour.
+      def chats(*args)
+        @client.get "#{@path}/chats", Hash[*args]
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-ratings-report
+      #optional arguments
+      # date_from - YYYY-MM-DD, defaults to the beginning of time.
+      # date_to - YYYY-MM-DD, defaults to today.
+      # group - id of the group, not set by default, returns statistics for the specified group.
+      # agent - agent's login, not set by default, return statistics for the specified agent.
+      # group_by – defaults to day (or hour when date_from equals date_to), can be set to month or hour.
+      def ratings(*args)
+        @client.get "#{@path}/ratings", Hash[*args]
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-ratings-ranking
+      #optional arguments
+      # date_from - YYYY-MM-DD, defaults to the beginning of time.
+      # date_to - YYYY-MM-DD, defaults to today.
+      # group - id of the group, not set by default, returns statistics for the specified group.
+      def ratings_ranking(*args)
+        @client.get "#{@path}/ratings/ranking", Hash[*args]
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-queued-visitors-report
+      #optional arguments
+      # date_from - YYYY-MM-DD, defaults to the beginning of time.
+      # date_to - YYYY-MM-DD, defaults to today.
+      # group - id of the group, not set by default, returns statistics for the specified group.
+      # group_by - defaults to day (or hour when date_from equals date_to), can be set to month or hour.
+      def queued_visitors(*args)
+        @client.get "#{@path}/queued_visitors", Hash[*args]
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-queue-waiting-times-report
+      #optional arguments
+      # date_from - YYYY-MM-DD, defaults to the beginning of time.
+      # date_to - YYYY-MM-DD, defaults to today.
+      # group - id of the group, not set by default, returns statistics for the specified group.
+      # group_by - defaults to day (or hour when date_from equals date_to), can be set to month or hour.
+      def queued_visitors_waiting_times(*args)
+        @client.get "#{@path}/queued_visitors/waiting_times", Hash[*args]
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-availability-report
+      #optional arguments
+      # date_from - YYYY-MM-DD, defaults to the beginning of time.
+      # date_to - YYYY-MM-DD, defaults to today.
+      # group - id of the group, not set by default, returns statistics for the specified group.
+      # agent - agent's login, not set by default, return statistics for the specified agent.
+      def availability(*args)
+        @client.get "#{@path}/availability", Hash[*args]
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-chatting-time-report
+      #optional arguments
+      # date_from - YYYY-MM-DD, defaults to the beginning of time.
+      # date_to - YYYY-MM-DD, defaults to today.
+      # group - id of the group, not set by default, returns statistics for the specified group.
+      # agent - agent's login, not set by default, returns statistics for the specified agent
+      def chatting_time(*args)
+        @client.get "#{@path}/chatting_time", Hash[*args]
+      end
+
+      #http://developers.livechatinc.com/rest-api/#get-goals-report
+      #optional arguments:
+      #  date_from - YYYY-MM-DD, defaults to the beginning of time.
+      #  date_to - YYYY-MM-DD, defaults to today.
+      #  group - id of the group, not set by default, returns statistics for the specified group.
+      #  goal - id of the goal, not set by default.
+      #  agent - agent's login, not set by default, return statistics for the specified agent.
+      #  group_by - defaults to day (or hour when date_from equals date_to), can be set to month or hour.
+      def goals(*args)
+        @client.get "#{@path}/goals", Hash[*args]
+      end
+
+    end
+
+    class Report < InstanceResource
+    end
+  end
+end

data/lib/livechat/rest/status.rb

@@ -0,0 +1,13 @@
+module LiveChat
+  module REST
+    class Status
+      def initialize(path, client)
+        @path, @client = path, client
+      end
+
+      def get(params={})
+        @client.get "#{@path}/#{params[:group]}"
+      end
+    end
+  end
+end

data/lib/livechat/rest/utils.rb

@@ -0,0 +1,25 @@
+module LiveChat
+  module REST
+    module Utils
+
+      def restify(something)
+        if something.is_a? Hash
+          Hash[*something.to_a.map {|a| [restify(a[0]).to_sym, a[1]]}.flatten]
+        else
+          something.to_s.split('_').map do |s|
+            [s[0,1].capitalize, s[1..-1]].join
+          end.join
+        end
+      end
+
+      def unrestify(something)
+        if something.is_a? Hash
+          Hash[*something.to_a.map {|pair| [unrestify(pair[0]).to_sym, pair[1]]}.flatten]
+        else
+          something.to_s.gsub(/[A-Z][a-z]*/) {|s| "_#{s.downcase}"}.gsub(/^_/, '')
+        end
+      end
+
+    end
+  end
+end

data/lib/livechat/rest/visitors.rb

@@ -0,0 +1,17 @@
+module LiveChat
+  module REST
+    class Visitors < ListResource
+      def chatting
+        list
+      end
+    end
+
+    class Visitor < InstanceResource
+      def add_details(params={})
+        yield params if block_given?
+        @client.post(@path, params)
+        self
+      end
+    end
+  end
+end

data/lib/livechat/util.rb

@@ -0,0 +1,7 @@
+module LiveChat
+  module Util
+    def url_encode(hash)
+      hash.to_a.map {|p| p.map {|e| CGI.escape e.to_s}.join '='}.join '&'
+    end
+  end
+end

data/lib/livechat/version.rb

@@ -0,0 +1,3 @@
+module LiveChat
+  VERSION = "0.0.1".freeze
+end

data/livechat_client.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'livechat/version'
+
+Gem::Specification.new do |g|
+  g.name = "livechat_client"
+  g.version = LiveChat::VERSION.dup
+  g.platform = Gem::Platform::RUBY
+  g.authors = ["Alexandre Maia"]
+  g.email = ["alexandre.maia@gmail.com"]
+  g.homepage = "https://github.com/cxz/livechat_client"
+  g.summary = %q|LiveChat REST API Client|
+  g.description = %q|Ruby wrapper for the REST API at http://developers.livechatinc.com/rest-api/|
+  g.license = %q|MIT|
+
+  g.required_ruby_version = ">= 1.8.7"
+  g.required_rubygems_version = ">= 1.3.6"
+
+  g.add_development_dependency "rake"
+  g.add_development_dependency "rspec"
+  g.add_development_dependency "webmock", "~> 1.9.0"
+
+  g.add_runtime_dependency "hashie", ">= 1.2"
+  g.add_runtime_dependency "multi_json"
+
+  g.files = `git ls-files`.split("\n") rescue ''
+  g.require_paths = ["lib"]
+  g.test_files = Dir['spec/**/*.rb']
+  g.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'livechat', '--main', 'README.md']
+
+end

data/spec/fixtures/agent.json

@@ -0,0 +1,30 @@
+{
+    "login": "john.doe@mycompany.com",
+    "name": "John Doe",
+    "login_status": "accepting chats",
+    "permission": "owner",
+    "daily_summary": 1,
+    "job_title": "Support Agent",
+    "avatar": "livechat.s3.amazonaws.com/1011121/all/avatars/bdd8924fcbcdbddbeaf60c19b238b0b0.jpg",
+    "notifications": {
+        "new_visitor": 1,
+        "returning_visitor": 1,
+        "queued_visitor": 1,
+        "visitor_is_typing": 0,
+        "new_goal": 1
+    },
+    "max_chats_count": 6,
+    "groups": [
+        {
+            "id": 1,
+            "name": "Sales"
+        },
+        {
+            "id": 2,
+            "name": "Technical Support"
+        }
+    ],
+    "status": "accepting chats",
+    "last_logout": 1358427204,
+    "api_key": "6ed8580f2cc160ce98d16389a0ede2c0"
+}

data/spec/fixtures/agents.json

@@ -0,0 +1,16 @@
+[
+    {
+        "name": "John Doe",
+        "permission": "owner",
+        "avatar": "livechat.s3.amazonaws.com/1011121/all/avatars/bdd8924fcbcdbddbeaf60c19b238b0b0.jpg",
+        "login": "john.doe@mycompany.com",
+        "status": "accepting chats"
+    },
+    {
+        "name": "Jane Doe",
+        "permission": "normal",
+        "avatar": "livechat.s3.amazonaws.com/1011121/all/avatars/a557c601619878e28343cddb9a1b8445.jpg",
+        "login": "jane.doe@mycompany.com",
+        "status": "offline"
+    }
+]

data/spec/fixtures/canned_response.json

@@ -0,0 +1,12 @@
+{
+    "id": 3181,
+    "group": 0,
+    "text": "Have a great day, goodbye.",
+    "creation_date": 1358866421,
+    "created_by": "john.doe@mycompany.com",
+    "modification_date": 1358866813,
+    "modified_by": "john.doe@mycompany.com",
+    "tags": [
+        "bye"
+    ]
+}

data/spec/fixtures/canned_responses.json

@@ -0,0 +1,37 @@
+[
+    {
+        "id": 3151,
+        "group": 1,
+        "text": "Can I help you with anything else?",
+        "creation_date": 1358257181,
+        "created_by": "john.doe@mycompany.com",
+        "tags": [
+            "help",
+            "else"
+        ]
+    },
+    {
+        "id": 3161,
+        "group": 1,
+        "text": "What product are you interested in?",
+        "creation_date": 1358257229,
+        "created_by": "john.doe@mycompany.com",
+        "modification_date": 1358864338,
+        "modified_by": "jenny.doe@mycompany.com",
+        "tags": [
+            "product",
+            "interest"
+        ]
+    },
+    {
+        "id": 3171,
+        "group": 1,
+        "text": "I will transfer you to the agent responsible for this matter.",
+        "creation_date": 1358864376,
+        "created_by": "jenny.doe@mycompany.com",
+        "tags": [
+            "transfer",
+            "matter"
+        ]
+    }
+]

data/spec/fixtures/chat.json

@@ -0,0 +1,129 @@
+{
+    "type": "chat",
+    "id": "MH022RD0K5",
+    "visitor_name": "Mary Brown",
+    "visitor_id": "S1355415390.49b8940793",
+    "agents": [
+        {
+            "display_name": "John Doe",
+            "email": "john.doe@mycompany.com"
+        }
+    ],
+    "supervisors": [
+        {
+            "display_name": "Jane Doe",
+            "email": "jane.doe@mycompany.com"
+        }
+    ],
+    "rate": "not_rated",
+    "duration": 1456, // in seconds
+    "group": [
+        0
+    ],
+    "started": "Wed, 01/23/13 11:40:53 am",
+    "prechat_survey": [
+        {
+            "key": "Name:",
+            "value": "",
+            "id": "13589376348060238"
+        },
+        {
+            "key": "E-mail:",
+            "value": "",
+            "id": "135893763480606511"
+        }
+    ],
+    "postchat_survey": [
+        {
+            "key": "How would you rate the quality of support?",
+            "value": "Good",
+            "id": "137164167769201638"
+        }
+    ],
+    "custom_variables": [
+        {
+            "key": "customer_login",
+            "value": "mary_brown"
+        }
+    ],
+    "integration_variables": [
+        {
+            "key": "facebook.id",
+            "value": "123456789"
+        },
+        {
+            "key": "facebook.name",
+            "value": "Mary Brown"
+        },
+        {
+            "key": "facebook.first_name",
+            "value": "Mary"
+        },
+        {
+            "key": "facebook.last_name",
+            "value": "Brown"
+        },
+        {
+            "key": "facebook.gender",
+            "value": "female"
+        },
+        {
+            "key": "facebook.locale",
+            "value": "en_US"
+        },
+        {
+            "key": "facebook.link",
+            "value": "http://www.facebook.com/mary.brown"
+        },
+        {
+            "key": "facebook.username",
+            "value": "mary.brown"
+        },
+        {
+            "key": "facebook.email",
+            "value": "mary.brown@email.com"
+        }
+    ],
+    "goals": [
+        {
+            "id": 71,
+            "name": "goal_name"
+        }
+    ],
+    "messages": [
+        {
+            "author_name": "John Doe",
+            "text": "Hello",
+            "date": "Wed, 01/23/13 11:40:53 am",
+            "timestamp": 1358937653,
+            "user_type": "agent",
+            "agent_id": "john.doe@mycompany.com"
+        },
+        {
+            "author_name": "Mary Brown",
+            "text": "How are you?",
+            "date": "Wed, 01/23/13 11:41:01 am",
+            "timestamp": 1358937661,
+            "user_type": "visitor"
+        },
+        {
+            "author_name": "John Doe",
+            "text": "Thanks, fine :)",
+            "date": "Wed, 01/23/13 11:41:05 am",
+            "timestamp": 1358937665,
+            "user_type": "agent",
+            "agent_id": "john.doe@mycompany.com"
+        },
+        {
+            "author_name": "Jane Doe",
+            "text": "Message from supervisor.",
+            "date": "Wed, 01/23/13 11:57:13 am",
+            "timestamp": 1358938633,
+            "user_type": "supervisor",
+            "agent_id": "jane.doe@mycompany.com"
+        }
+    ],
+    "started_timestamp": 1358937653,
+    "ended_timestamp": 1358939109,
+    "ended": "Wed, 01/23/13 12:05:09 pm"
+}