livechat_client 0.0.1

data/spec/fixtures/chats.json

@@ -0,0 +1,135 @@
+{
+    "chats": [
+        {
+            "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"
+        }
+],
+"total": 1,
+"pages": 1
+}

data/spec/fixtures/goal.json

@@ -0,0 +1,8 @@
+{
+    "id": 1181,
+    "name": "nike shoes variable",
+    "active": 1,
+    "type": "custom_variable",
+    "custom_variable_name": "nike_shoes",
+    "custom_variable_value": "true"
+}

data/spec/fixtures/goals.json

@@ -0,0 +1,12 @@
+[
+    {
+        "id": 1041,
+        "name": "purchase",
+        "active": 1
+    },
+    {
+        "id": 1181,
+        "name": "nike shoes variable",
+        "active": 1
+    }
+]

data/spec/fixtures/group.json

@@ -0,0 +1,10 @@
+{
+    "id": 2,
+    "name": "Sales",
+    "language": "en",
+    "agents": [
+        "john.doe@mycompany.com",
+        "jenny.doe@mycompany.com"
+    ],
+    "status": "accepting chats"
+}

data/spec/fixtures/groups.json

@@ -0,0 +1,32 @@
+[
+    {
+        "id": 0,
+        "name": "All operators",
+        "language": "en"
+    },
+    {
+        "id": 1,
+        "name": "Invoicing",
+        "language": "en",
+        "agents": [
+            "jane.doe@mycompany.com"
+        ]
+    },
+    {
+        "id": 2,
+        "name": "Sales",
+        "language": "en",
+        "agents": [
+            "john.doe@mycompany.com",
+            "jenny.doe@mycompany.com"
+        ]
+    },
+    {
+        "id": 3,
+        "name": "Technical Support",
+        "language": "en",
+        "agents": [
+            "john.doe@mycompany.com"
+        ]
+    }
+]

data/spec/fixtures/visitors.json

@@ -0,0 +1,91 @@
+[
+    {
+        "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleWebKit/536.26.14 (KHTML, like Gecko) Version/6.0.1 Safari/536.26.14",
+        "chat_id": "MH0H3V3XO3",
+        "chat_start_time": "2013-01-31 15:51:03",
+        "city": "Greenville",
+        "country": "United States",
+        "host": "152.27.26.254",
+        "id": "S1355415390.49b8940793",
+        "ip": "152.27.26.254",
+        "language": "en",
+        "last_visit": "2013-01-31 15:43:05",
+        "latitude": "35.6127",
+        "longitude": "-77.3663",
+        "operators": [
+            {
+                "id": "john.doe@mycompany.com",
+                "display_name": "John Doe"
+            }
+        ],
+        "page_current": "http://www.mycompany.com/products/shoes",
+        "page_entered": "2013-01-31 15:49:17",
+        "page_time": "2013-01-31 15:49:17",
+        "prechat_survey": [
+            {
+                "key": "Name:",
+                "value": "Mark"
+            },
+            {
+                "key": "E-mail:",
+                "value": "mark.johnson@example.com"
+            }
+        ],
+        "queue_start_time": "",
+        "referrer": "",
+        "region": "North Carolina",
+        "state": "chatting",
+        "timezone": "America/New_York",
+        "custom_variables": [
+            {
+                "key": "empty_cart",
+                "value": "true"
+            }
+        ],
+        "chats": 27,
+        "group": 0,
+        "greetings_accepted": 9,
+        "greetings_all": 13,
+        "greetings_refused": 4,
+        "visits": 16,
+        "page_views": 59
+    },
+    {
+        "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_5) AppleWebKit/537.11 (KHTML, like Gecko) Chrome/23.0.1271.101 Safari/537.11",
+        "chat_id": "",
+        "chat_start_time": "",
+        "city": "Courbevoie",
+        "country": "France",
+        "host": "def92-2-87-91-13-226.dsl.sta.abo.bbox.fr",
+        "id": "S1359643767.a7904dd2f2",
+        "ip": "87.91.13.226",
+        "language": "en",
+        "last_visit": "2013-01-31 15:49:27",
+        "latitude": "48.897",
+        "longitude": "2.2564",
+        "operators": [
+            {
+                "id": "",
+                "display_name": ""
+            }
+        ],
+        "page_current": "http://www.mycompany.com/",
+        "page_entered": "2013-01-31 15:49:27",
+        "page_time": "2013-01-31 15:49:27",
+        "prechat_survey": [
+
+        ],
+        "queue_start_time": "",
+        "referrer": "",
+        "region": "Ile-de-France",
+        "state": "online",
+        "timezone": "Europe/Paris",
+        "chats": 0,
+        "group": 0,
+        "greetings_accepted": 0,
+        "greetings_all": 0,
+        "greetings_refused": 0,
+        "visits": 1,
+        "page_views": 1
+    }
+]

data/spec/livechat/rest/agents_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+include WebMock::API
+
+
+describe LiveChat::REST::Agents do
+
+  before do
+    @livechat = create_client
+
+    @john_id = 'john.doe@mycompany.com'
+    @jane_id = 'jane.doe@mycompany.com'
+    @alice_id = 'alice@mycompany.com'
+
+    stub_rest 'agents'
+
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+  it "lists all agents" do
+    agents = @livechat.agents.list    
+    expect(agents.length).to be(2)
+  end
+
+  it "gets a single agent details" do
+    agent = @livechat.agents(@john_id)
+    expect(agent.login).to eq(@john_id)
+  end
+
+  it "creates a new agent" do
+    agent = @livechat.agents.create do |a|
+      a[:login] = @alice_id
+      a[:name] = 'Alice'
+    end
+  end
+
+  #all properties are optional
+  it "updates an agent" do
+    @livechat.agents(@jane_id).update do |a|
+      a[:job_title] = 'Tester'
+      a[:status] = 'not accepting chats'
+    end
+  end
+
+  it "resets an API key" do
+    @livechat.agents(@alice_id).reset_api_key
+  end
+
+  it "removes an agent" do
+    @livechat.agents(@alice_id).delete
+  end
+
+end

data/spec/livechat/rest/canned_responses_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+include WebMock::API
+
+
+describe LiveChat::REST::CannedResponses do
+  before do
+    @livechat = create_client
+
+    stub_rest 'canned_responses'
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+  it "lists all canned responses" do
+    @livechat.canned_responses
+  end
+
+  it "gets a single canned response" do
+    @livechat.canned_responses(0)
+  end
+
+  it "creates a new canned response" do
+    canned_response = @livechat.canned_responses.create do |r|
+      r[:text] = 'Have a great day, goodbye.'
+      r[:tags] = ['cu', 'bye']
+    end
+  end
+
+  it "updates a canned response" do
+   @livechat.canned_responses(0).update do |r|
+     r[:tags] = ['bye']
+   end
+  end
+
+  it "removes a canned response" do
+    @livechat.canned_responses(0).delete
+  end
+
+end
+

data/spec/livechat/rest/chats_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+include WebMock::API
+
+
+describe LiveChat::REST::Chats do
+  before do
+    @livechat = create_client
+
+    stub_rest 'chats'
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+
+  it "gets list of chats" do
+    chats = @livechat.chats
+    expect(chats.list.length).to be(1)
+  end
+
+  it "gets single chat" do
+    chat = @livechat.chats('MH022RD0K5')
+    expect(chat.visitor_name).to eq('Mary Brown')
+  end
+
+  it "sends chat transcript to e-mail" do
+    @livechat.chats('MH022RD0K5').send_transcript(:to => 'john.doe@mycompany.com')
+    expect(@livechat.last_request.path).to eq '/chats/MH022RD0K5/send_transcript'
+    expect(@livechat.last_request.method).to eq 'POST'
+    expect(@livechat.last_request.body).to eq 'to=john.doe%40mycompany.com'
+  end
+
+
+end
+

data/spec/livechat/rest/goals_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+include WebMock::API
+
+
+describe LiveChat::REST::Goals do
+  before do
+    @livechat = create_client
+
+    stub_rest 'goals'
+  end
+
+  after do
+    WebMock.reset!
+  end
+
+
+  it "lists all goals" do
+    @livechat.goals
+  end
+
+  it "gets a single goal details" do
+    @livechat.goals(1181)
+  end
+
+  it "marks goal as successful" do
+    @livechat.goals(1181).mark_as_successful(:visitor_id => 1, :order_id => 'AP723HVCA721')
+    expect(@livechat.last_request.body).to eq 'visitor_id=1&order_id=AP723HVCA721'
+
+  end
+
+  it "adds a new goal" do
+    @livechat.goals.create do |goal|
+      goal[:name] = 'new goal'
+      goal[:type] = 'url'
+    end
+  end
+
+  it "updates a goal" do
+    @livechat.goals(2231).update do |goal|
+      goal[:name] = 'updated goal'
+    end
+  end
+
+  it "removes a goal" do
+    @livechat.goals(2231).delete
+  end
+
+end
+