desk 0.3.0

data/spec/desk/client/customer_spec.rb

@@ -0,0 +1,158 @@
+require 'helper'
+
+describe Desk::Client do
+  Desk::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Desk::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".customers" do
+
+        context "lookup" do
+
+          before do
+            stub_get("customers.#{format}").
+              to_return(:body => fixture("customers.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.customers
+            a_get("customers.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 customers worth of extended information" do
+            customers = @client.customers
+
+            customers.results.should be_a Array
+            customers.results.first.customer.first_name.should == "Jeremy"
+          end
+
+        end
+      end
+
+      describe ".customer" do
+
+        context "lookup" do
+
+          before do
+            stub_get("customers/1.#{format}").
+              to_return(:body => fixture("customer.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.customer(1)
+            a_get("customers/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 customers worth of extended information" do
+            customer = @client.customer(1)
+
+            customer.first_name.should == "Jeremy"
+            customer.addresses.first.address.city.should == "Commack"
+          end
+
+        end
+      end
+
+      describe ".create_customer" do
+
+        context "create" do
+
+          before do
+            stub_post("customers.#{format}").
+              to_return(:body => fixture("customer_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.create_customer(:name => "Chris Warren", :twitter => "cdwarren")
+            a_post("customers.#{format}").
+              should have_been_made
+          end
+
+          it "should return the information about this user" do
+            customer = @client.create_customer(:name => "John Smith", :twitter => "cdwarren")
+
+            customer.first_name.should == "John"
+            customer.phones.first.phone.phone.should == "123-456-7890"
+          end
+
+        end
+      end
+
+      describe ".update_customer" do
+
+        context "update" do
+
+          before do
+            stub_put("customers/1.#{format}").
+              to_return(:body => fixture("customer_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.update_customer(1, :name => "Chris Warren", :twitter => "cdwarren")
+            a_put("customers/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return the information about this user" do
+            customer = @client.update_customer(1, :name => "Joslyn Esser")
+
+            customer.first_name.should == "Joslyn"
+          end
+
+        end
+      end
+
+      describe ".create_customer_email" do
+
+        context "create" do
+
+          before do
+            stub_post("customers/1/emails.#{format}").
+              to_return(:body => fixture("customer_create_email.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.create_customer_email(1, :email => "foo@example.com")
+            a_post("customers/1/emails.#{format}").
+              should have_been_made
+          end
+
+          it "should return the information about this user" do
+            email = @client.create_customer_email(1, :email => "api@example.com")
+
+            email.email.should == "api@example.com"
+          end
+
+        end
+      end
+
+      describe ".update_customer_email" do
+
+        context "update" do
+
+          before do
+            stub_put("customers/1/emails/2.#{format}").
+              to_return(:body => fixture("customer_update_email.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.update_customer_email(1, 2, :email => "foo@example.com")
+            a_put("customers/1/emails/2.#{format}").
+              should have_been_made
+          end
+
+          it "should return the information about this user" do
+            email = @client.update_customer_email(1, 2, :email => "api@example.com")
+
+            email.email.should == "api@example.com"
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/desk/client/interaction_spec.rb

@@ -0,0 +1,191 @@
+require 'helper'
+
+describe Desk::Client do
+  include EmailSpec::Helpers
+  include EmailSpec::Matchers
+
+  Desk::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Desk::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS', :support_email => "help@example.com")
+      end
+
+      describe ".create_interaction" do
+        context "create a new interaction without specifying direction should default to inbound" do
+          before do
+            stub_post("interactions.#{format}").
+              to_return(:body => fixture("interaction_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.create_interaction(:interaction_subject => "this is an api test", :customer_email => "foo@example.com")
+            a_post("interactions.#{format}").
+              should have_been_made
+          end
+
+          it "should create an interaction" do
+            interaction = @client.create_interaction(:interaction_subject => "this is an api test", :customer_email => "foo@example.com")
+
+            interaction.customer.emails.first.email.email.should == "customer@zencoder.com"
+            interaction.interaction.interactionable.email.subject.should == "this is an api test"
+          end
+        end
+
+        context "create a new interaction and specify inbound" do
+          before do
+            stub_post("interactions.#{format}").
+              to_return(:body => fixture("interaction_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.create_interaction(:interaction_subject => "this is an api test", :customer_email => "foo@example.com", :direction => "in")
+            a_post("interactions.#{format}").
+              should have_been_made
+          end
+
+          it "should create an interaction" do
+            interaction = @client.create_interaction(:interaction_subject => "this is an api test", :customer_email => "foo@example.com", :direction => "in")
+
+            interaction.customer.emails.first.email.email.should == "customer@zencoder.com"
+            interaction.interaction.interactionable.email.subject.should == "this is an api test"
+          end
+        end
+
+        context "create a new interaction and specify outbound" do
+          before do
+            @email = @client.create_interaction(:customer_email => "customer@example.com", :interaction_subject => "Need help?", :interaction_body => "Sorry we missed you in chat today.", :direction => "outbound")
+          end
+
+          it "should deliver the email to the customer" do
+            @email.last.should deliver_to("customer@example.com")
+          end
+
+          it "should be from the support email" do
+            @email.last.should deliver_from(@client.support_email)
+          end
+
+          it "should contain the message in the mail body" do
+            @email.last.should have_body_text(/Sorry we missed you in chat today/)
+          end
+
+          it "should bcc to the support email" do
+            @email.last.should bcc_to(@client.support_email)
+          end
+
+          it "should set the Desk headers" do
+            @email.last.should have_header("x-assistly-customer-email","customer@example.com")
+            @email.last.should have_header("x-assistly-interaction-direction","out")
+            @email.last.should have_header("x-assistly-case-status","open")
+          end
+        end
+      end
+
+      describe ".create_inbound_interaction" do
+        context "create a new interaction" do
+          before do
+            stub_post("interactions.#{format}").
+              to_return(:body => fixture("interaction_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.create_inbound_interaction(:interaction_subject => "this is an api test", :customer_email => "foo@example.com")
+            a_post("interactions.#{format}").
+              should have_been_made
+          end
+
+          it "should create an interaction" do
+            interaction = @client.create_inbound_interaction(:interaction_subject => "this is an api test", :customer_email => "foo@example.com")
+
+            interaction.customer.emails.first.email.email.should == "customer@zencoder.com"
+            interaction.interaction.interactionable.email.subject.should == "this is an api test"
+          end
+        end
+      end
+
+      describe ".create_outbound_interaction" do
+        context "create" do
+
+          before do
+            @email = @client.create_outbound_interaction("customer@example.com", "Need help?", "Sorry we missed you in chat today.")
+          end
+
+          it "should deliver the email to the customer" do
+            @email.last.should deliver_to("customer@example.com")
+          end
+
+          it "should be from the support email" do
+            @email.last.should deliver_from(@client.support_email)
+          end
+
+          it "should contain the message in the mail body" do
+            @email.last.should have_body_text(/Sorry we missed you in chat today/)
+          end
+
+          it "should bcc to the support email" do
+            @email.last.should bcc_to(@client.support_email)
+          end
+
+          it "should set the Assitly headers" do
+            @email.last.should have_header("x-assistly-customer-email","customer@example.com")
+            @email.last.should have_header("x-assistly-interaction-direction","out")
+            @email.last.should have_header("x-assistly-case-status","open")
+          end
+
+        end
+
+        context "without support_email defined" do
+
+          before do
+            @client_without_support_email = Desk::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+          end
+
+          it "should raise an error" do
+            lambda do
+              @client_without_support_email.create_outbound_interaction("customer@example.com", "Need help?", "Sorry we missed you in chat today.")
+            end.should raise_error(Desk::SupportEmailNotSet)
+          end
+
+        end
+
+        context "with customer headers set" do
+          before do
+            @custom_email = @client.create_outbound_interaction("customer@example.com", "Need help?", "Sorry we missed you in chat today.", :headers => { "x-assistly-interaction-user-agent" => "12345"})
+          end
+
+          it "should merge the custom headers" do
+            @custom_email.last.should have_header("x-assistly-interaction-user-agent","12345")
+          end
+
+          it "should preserve the existing headers" do
+            @custom_email.last.should have_header("x-assistly-customer-email","customer@example.com")
+          end
+        end
+      end
+
+      describe ".interactions" do
+
+        context "lookup" do
+
+          before do
+            stub_get("interactions.#{format}").
+              to_return(:body => fixture("interactions.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.interactions
+            a_get("interactions.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 users worth of extended information" do
+            interactions = @client.interactions
+
+            interactions.results.should be_a Array
+            interactions.results.last.interaction.user.name.should == "Agent Jeremy"
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/desk/client/macro_spec.rb

@@ -0,0 +1,204 @@
+require 'helper'
+
+describe Desk::Client do
+  Desk::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Desk::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".macros" do
+
+        context "lookup" do
+
+          before do
+            stub_get("macros.#{format}").
+              to_return(:body => fixture("macros.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.macros
+            a_get("macros.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 macros worth of extended information" do
+            macros = @client.macros
+
+            macros.results.should be_a Array
+            macros.results.first.macro.id.should == 11
+          end
+
+        end
+      end
+
+      describe ".macro" do
+
+        context "lookup" do
+
+          before do
+            stub_get("macros/13.#{format}").
+              to_return(:body => fixture("macro.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.macro(13)
+            a_get("macros/13.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            macro = @client.macro(13)
+
+            macro.id.should == 13
+            macro.name.should == "API Macro"
+          end
+
+        end
+      end
+
+      describe ".create_macro" do
+
+        context "create" do
+
+          before do
+            stub_post("macros.#{format}").
+              to_return(:body => fixture("macro_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.create_macro("API Macro", :description => "Everything belongs here")
+            a_post("macros.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new macro" do
+            macro = @client.create_macro("API Macro", :description => "Everything belongs here")
+
+            macro.id.should == 12
+            macro.name.should == "API Macro"
+          end
+
+        end
+      end
+
+      describe ".update_macro" do
+
+        context "update" do
+
+          before do
+            stub_put("macros/13.#{format}").
+              to_return(:body => fixture("macro_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.update_macro(13, :name => "Updated")
+            a_put("macros/13.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new macro" do
+            macro = @client.update_macro(13, :name => "Updated")
+
+            macro.name.should == "Updated"
+          end
+
+        end
+      end
+
+      describe ".delete_macro" do
+
+        context "delete" do
+
+          before do
+            stub_delete("macros/1.#{format}").
+              to_return(:body => fixture("macro_destroy.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.delete_macro(1)
+            a_delete("macros/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return a successful response" do
+            macro = @client.delete_macro(1)
+            macro.success.should == true
+          end
+
+        end
+      end
+
+      describe ".macro_actions" do
+
+        context "lookup" do
+
+          before do
+            stub_get("macros/1/actions.#{format}").
+              to_return(:body => fixture("macro_actions.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.macro_actions(1)
+            a_get("macros/1/actions.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 macro actions worth of extended information" do
+            macro_actions = @client.macro_actions(1)
+
+            macro_actions.should be_a Array
+            macro_actions.first.action.slug.should == "set-case-description"
+          end
+
+        end
+      end
+
+      describe ".macro_action" do
+
+        context "lookup" do
+
+          before do
+            stub_get("macros/1/actions/set-case-description.#{format}").
+              to_return(:body => fixture("macro_action.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.macro_action(1,"set-case-description")
+            a_get("macros/1/actions/set-case-description.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 macro actions worth of extended information" do
+            macro_action = @client.macro_action(1,"set-case-description")
+            macro_action.slug.should == "set-case-description"
+          end
+
+        end
+      end
+
+      describe ".update_macro_action" do
+
+        context "update" do
+
+          before do
+            stub_put("macros/1/actions/set-case-description.#{format}").
+              to_return(:body => fixture("macro_action_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should post to the correct resource" do
+            @client.update_macro_action(1, "set-case-description", :value => "This is my case description")
+            a_put("macros/1/actions/set-case-description.#{format}").
+              should have_been_made
+          end
+
+          it "should return the new macro" do
+            macro_action = @client.update_macro_action(1, "set-case-description", :value => "This is my case description")
+            macro_action.value.should == "Description to be applied"
+          end
+
+        end
+      end
+    end
+  end
+end