desk 0.3.3 → 1.0.0

data/lib/desk/client/interaction.rb

@@ -1,75 +0,0 @@
-module Desk
-  class Client
-    # Defines methods related to interactions
-    module Interaction
-
-      # Returns extended information of up to 100 interactions
-      #
-      #   @option options [Boolean, String, Integer]
-      #   @example Return extended information for 12345
-      #     Desk.interactions(:since_id => 12345)
-      #     Desk.interactions(:since_id => 12345, :count => 5)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/interactions
-      def interactions(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("interactions",options)
-        response
-      end
-
-      def create_interaction(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        if options[:direction].to_s == "outbound"
-          options.delete(:direction)
-          to      = options.delete(:customer_email)
-          subject = options.delete(:interaction_subject)
-          body    = options.delete(:interaction_body)
-
-          create_outbound_interaction(to, subject, body, options)
-        else
-          create_inbound_interaction(options)
-        end
-      end
-
-      # Creates an interaction from a customer
-      #
-      # @format :json
-      # @authenticated true
-      # @rate_limited true
-      # @return [Array] The requested users.
-      # @see http://dev.desk.com/docs/api/interactions/create
-      # @example Create a new interaction
-      #   Desk.create_interaction(:interaction_subject => "this is an api test", :customer_email => "foo@example.com")
-      def create_inbound_interaction(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = post('interactions', options)
-        if response['success']
-          return response['results']
-        else
-          return response
-        end
-      end
-
-      # Create an interaction from an agent
-      #
-      # Desk's API doesn't support creating a new case/interaction initiated by an agent
-      # so we'll use send an email to the customer directly that is BCC'd to the support email address
-      # which will create the ticket
-      #
-      # @see http://support.desk.com/customer/portal/articles/4180
-      # @see http://support.desk.com/customer/portal/articles/6728
-      def create_outbound_interaction(to, subject, body, *args)
-        raise Desk::SupportEmailNotSet if support_email.blank?
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        options.merge!(:to => to, :subject => subject, :body => body, :from => support_email, :bcc => support_email)
-        headers = { "x-assistly-customer-email" => to,
-                    "x-assistly-interaction-direction" => "out",
-                    "x-assistly-case-status" => options[:status]||"open"}
-        headers.merge!(options[:headers]) if options[:headers]
-        options.merge!(:headers => headers)
-        Pony.mail(options)
-      end
-    end
-  end
-end

data/spec/desk/client/interaction_spec.rb

@@ -1,191 +0,0 @@
-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/fixtures/article.json

@@ -1,50 +0,0 @@
-{
-        "article":
-        {
-                "id":13,
-                "subject":"API Tips",
-                "show_in_portal":true,
-                "main_content":"Tips on using our API",
-                "agent_content":null,
-                "email":"Tips on using our API",
-                "chat":"Tips on using our API",
-                "twitter":"Tips on using our API",
-                "question_answer":"Tips on using our API",
-                "phone":"Tips on using our API",
-                "quickcode":null,
-                "created_by":
-                {
-                        "user":
-                        {
-                                "id":1,
-                                "name":"API User",
-                                "name_public":"API User",
-                                "email":"apiuser@yoursite.com",
-                                "created_at":"2011-01-13T22:41:42Z",
-                                "updated_at":"2011-01-19T22:04:33Z",
-                                "user_level":"admin",
-                                "login_count":9,
-                                "time_zone":"Pacific Time (US & Canada)",
-                                "last_login_at":"2011-01-19T18:21:52Z",
-                                "current_login_at":"2011-01-19T22:04:33Z"
-                        }
-                },
-                "updated_by":
-                {
-                        "user":
-                        {
-                                "id":1,
-                                "name":"API User",
-                                "name_public":"API User",
-                                "email":"apiuser@yoursite.com",
-                                "created_at":"2011-01-13T22:41:42Z",
-                                "updated_at":"2011-01-19T22:04:33Z",
-                                "user_level":"admin",
-                                "login_count":9,
-                                "time_zone":"Pacific Time (US & Canada)",
-                                "last_login_at":"2011-01-19T18:21:52Z",
-                                "current_login_at":"2011-01-19T22:04:33Z"
-                        }
-                }
-        }
-}

data/spec/fixtures/article_create.json

@@ -1,54 +0,0 @@
-{
-        "success":true,
-        "results":
-        {
-                "article":
-                {
-                        "id":13,
-                        "subject":"API Tips",
-                        "show_in_portal":true,
-                        "main_content":"Tips on using our API",
-                        "agent_content":null,
-                        "email":"Tips on using our API",
-                        "chat":"Tips on using our API",
-                        "twitter":"Tips on using our API",
-                        "question_answer":"Tips on using our API",
-                        "phone":"Tips on using our API",
-                        "quickcode":null,
-                        "created_by":
-                        {
-                                "user":
-                                {
-                                        "id":1,
-                                        "name":"API User",
-                                        "name_public":"API User",
-                                        "email":"apiuser@yoursite.com",
-                                        "created_at":"2011-01-13T22:41:42Z",
-                                        "updated_at":"2011-01-19T22:04:33Z",
-                                        "user_level":"admin",
-                                        "login_count":9,
-                                        "time_zone":"Pacific Time (US & Canada)",
-                                        "last_login_at":"2011-01-19T18:21:52Z",
-                                        "current_login_at":"2011-01-19T22:04:33Z"
-                                }
-                        },
-                        "updated_by":
-                        {
-                                "user":
-                                {
-                                        "id":1,
-                                        "name":"API User",
-                                        "name_public":"API User",
-                                        "email":"apiuser@yoursite.com",
-                                        "created_at":"2011-01-13T22:41:42Z",
-                                        "updated_at":"2011-01-19T22:04:33Z",
-                                        "user_level":"admin",
-                                        "login_count":9,
-                                        "time_zone":"Pacific Time (US & Canada)",
-                                        "last_login_at":"2011-01-19T18:21:52Z",
-                                        "current_login_at":"2011-01-19T22:04:33Z"
-                                }
-                        }
-                }
-        }
-}

data/spec/fixtures/article_destroy.json

@@ -1,3 +0,0 @@
-{
-        "success":true
-}

data/spec/fixtures/article_update.json

@@ -1,54 +0,0 @@
-{
-        "success":true,
-        "results":
-        {
-                "article":
-                {
-                        "id":13,
-                        "subject":"API Tips",
-                        "show_in_portal":true,
-                        "main_content":"Tips on using our API",
-                        "agent_content":null,
-                        "email":"Tips on using our API",
-                        "chat":"Tips on using our API",
-                        "twitter":"Tips on using our API",
-                        "question_answer":"Tips on using our API",
-                        "phone":"Tips on using our API",
-                        "quickcode":null,
-                        "created_by":
-                        {
-                                "user":
-                                {
-                                        "id":1,
-                                        "name":"API User",
-                                        "name_public":"API User",
-                                        "email":"apiuser@yoursite.com",
-                                        "created_at":"2011-01-13T22:41:42Z",
-                                        "updated_at":"2011-01-19T22:04:33Z",
-                                        "user_level":"admin",
-                                        "login_count":9,
-                                        "time_zone":"Pacific Time (US & Canada)",
-                                        "last_login_at":"2011-01-19T18:21:52Z",
-                                        "current_login_at":"2011-01-19T22:04:33Z"
-                                }
-                        },
-                        "updated_by":
-                        {
-                                "user":
-                                {
-                                        "id":1,
-                                        "name":"API User",
-                                        "name_public":"API User",
-                                        "email":"apiuser@yoursite.com",
-                                        "created_at":"2011-01-13T22:41:42Z",
-                                        "updated_at":"2011-01-19T22:04:33Z",
-                                        "user_level":"admin",
-                                        "login_count":9,
-                                        "time_zone":"Pacific Time (US & Canada)",
-                                        "last_login_at":"2011-01-19T18:21:52Z",
-                                        "current_login_at":"2011-01-19T22:04:33Z"
-                                }
-                        }
-                }
-        }
-}

data/spec/fixtures/articles.json

@@ -1,58 +0,0 @@
-{
-        "results":
-        [
-                {
-                        "article":
-                        {
-                                "id":13,
-                                "subject":"API Tips",
-                                "show_in_portal":true,
-                                "main_content":"Tips on using our API",
-                                "agent_content":null,
-                                "email":"Tips on using our API",
-                                "chat":"Tips on using our API",
-                                "twitter":"Tips on using our API",
-                                "question_answer":"Tips on using our API",
-                                "phone":"Tips on using our API",
-                                "quickcode":null,
-                                "created_by":
-                                {
-                                        "user":
-                                        {
-                                                "id":1,
-                                                "name":"API User",
-                                                "name_public":"API User",
-                                                "email":"apiuser@yoursite.com",
-                                                "created_at":"2011-01-13T22:41:42Z",
-                                                "updated_at":"2011-01-19T22:04:33Z",
-                                                "user_level":"admin",
-                                                "login_count":9,
-                                                "time_zone":"Pacific Time (US & Canada)",
-                                                "last_login_at":"2011-01-19T18:21:52Z",
-                                                "current_login_at":"2011-01-19T22:04:33Z"
-                                        }
-                                },
-                                "updated_by":
-                                {
-                                        "user":
-                                        {
-                                                "id":1,
-                                                "name":"API User",
-                                                "name_public":"API User",
-                                                "email":"apiuser@yoursite.com",
-                                                "created_at":"2011-01-13T22:41:42Z",
-                                                "updated_at":"2011-01-19T22:04:33Z",
-                                                "user_level":"admin",
-                                                "login_count":9,
-                                                "time_zone":"Pacific Time (US & Canada)",
-                                                "last_login_at":"2011-01-19T18:21:52Z",
-                                                "current_login_at":"2011-01-19T22:04:33Z"
-                                        }
-                                }
-                        }
-                }
-        ],
-        "page":1,
-        "count":20,
-        "total":1
-}