desk 0.3.3 → 1.0.0

data/spec/desk/client/job_spec.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+describe Desk::Client do
+  context "Job" do
+
+    let(:endpoint) { "job" }
+    let(:id) { 1 }
+    let(:check_key) { "type" }
+    let(:check_value) { "bulk_case_update" }
+
+    include_context "basic configuration"
+
+    it_behaves_like "a list endpoint"
+
+    it_behaves_like "a show endpoint"
+
+    it_behaves_like "a create endpoint", {
+      :type => "bulk_case_update",
+      :case => {
+        :priority => 5,
+        :_links => {
+          :assigned_user => {
+            :href => "/api/v2/users/1",
+            :class => "user"
+          }
+        }
+      },
+      :case_ids => [ 1, 2, 3 ]
+    }
+
+  end
+end

data/spec/desk/client/label_spec.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+describe Desk::Client do
+  context "Label" do
+
+    let(:endpoint) { "label" }
+    let(:id) { 1 }
+    let(:check_key) { "name" }
+    let(:check_value) { "MyLabel" }
+
+    include_context "basic configuration"
+
+    it_behaves_like "a list endpoint"
+
+    it_behaves_like "a show endpoint"
+
+    it_behaves_like "a create endpoint", {
+      :name => "MyLabel",
+      :description => "A Test Label",
+      :types => [ "case", "macro" ],
+      :color => "blue"
+    }
+
+    it_behaves_like "an update endpoint", { :name => "Label 5" } do
+      let(:check_value) { "Label 5" }
+    end
+
+    it_behaves_like "a delete endpoint"
+
+  end
+end

data/spec/desk/client/macro_spec.rb

@@ -1,204 +1,41 @@
 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
+  context "Macro" do
 
-      describe ".macros" do
+    let(:endpoint) { "macro" }
+    let(:id) { 1 }
+    let(:check_key) { "name" }
+    let(:check_value) { "Macro Macro" }
 
-        context "lookup" do
+    include_context "basic configuration"
 
-          before do
-            stub_get("macros.#{format}").
-              to_return(:body => fixture("macros.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
+    it_behaves_like "a list endpoint"
 
-          it "should get the correct resource" do
-            @client.macros
-            a_get("macros.#{format}").
-              should have_been_made
-          end
+    it_behaves_like "a show endpoint"
 
-          it "should return up to 100 macros worth of extended information" do
-            macros = @client.macros
+    it_behaves_like "a create endpoint", {
+      :name => "Macro Macro",
+      :description => "It's raining fire!"
+    }
 
-            macros.results.should be_a Array
-            macros.results.first.macro.id.should == 11
-          end
+    it_behaves_like "an update endpoint", { :description => "On repeat" }
 
-        end
-      end
+    it_behaves_like "a delete endpoint"
 
-      describe ".macro" do
+    context "Action" do
 
-        context "lookup" do
+      let(:sub_endpoint) { "action" }
+      let(:sub_id) { 1 }
+      let(:check_key) { "value" }
+      let(:check_value) { "From a VIP Customer" }
 
-          before do
-            stub_get("macros/13.#{format}").
-              to_return(:body => fixture("macro.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
+      it_behaves_like "a sub list endpoint"
 
-          it "should get the correct resource" do
-            @client.macro(13)
-            a_get("macros/13.#{format}").
-              should have_been_made
-          end
+      it_behaves_like "a sub show endpoint"
 
-          it "should return up to 100 cases worth of extended information" do
-            macro = @client.macro(13)
+      it_behaves_like "a sub update endpoint", { :enabled => false }
 
-            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

data/spec/desk/client/rule_spec.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+describe Desk::Client do
+  context "Rule" do
+
+    let(:endpoint) { "rule" }
+    let(:id) { 1 }
+    let(:check_key) { "name" }
+    let(:check_value) { "Assign to Support" }
+
+    include_context "basic configuration"
+
+    it_behaves_like "a list endpoint"
+
+    it_behaves_like "a show endpoint"
+
+  end
+end

data/spec/desk/client/site_setting_spec.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+describe Desk::Client do
+  context "Site Setting" do
+
+    let(:endpoint) { "site_setting" }
+    let(:id) { 1 }
+    let(:check_key) { "name" }
+    let(:check_value) { "company_name" }
+
+    include_context "basic configuration"
+
+    it_behaves_like "a list endpoint"
+
+    it_behaves_like "a show endpoint"
+
+  end
+end

data/spec/desk/client/system_message_spec.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+describe Desk::Client do
+  context "System Message" do
+
+    let(:endpoint) { "system_message" }
+    let(:id) { nil }
+    let(:check_key) { "updated_at" }
+    let(:check_value) { "2013-11-22T22:49:20Z" }
+
+    include_context "basic configuration"
+
+    context "the current message" do
+
+      include_context "plural endpoint"
+
+      subject { client.send("show_#{endpoint}") }
+
+      before do
+        stub_get("#{endpoint}").to_return(:body => fixture(endpoint))
+      end
+
+      it "gets the correct resource" do
+        subject
+        expect(a_get("#{endpoint}")).to have_been_made
+      end
+
+      it { expect(subject).to be_a Hashie::Deash }
+
+      it "has a valid entry" do
+        expect(subject.id).to eq(id)
+        expect(subject.send(check_key)).to eq(check_value)
+      end
+
+      it "allows raw access" do
+        expect(subject.raw).to be_a Hashie::Deash
+      end
+
+    end
+
+  end
+end

data/spec/desk/client/topic_spec.rb

@@ -1,135 +1,54 @@
 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 ".topics" do
-
-        context "lookup" do
-
-          before do
-            stub_get("topics.#{format}").
-              to_return(:body => fixture("topics.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
-
-          it "should get the correct resource" do
-            @client.topics
-            a_get("topics.#{format}").
-              should have_been_made
-          end
-
-          it "should return up to 100 topics worth of extended information" do
-            topics = @client.topics
+  context "Topic" do
 
-            topics.results.should be_a Array
-            topics.results.first.topic.id.should == 1
-          end
+    let(:endpoint) { "topic" }
+    let(:id) { 1 }
+    let(:check_key) { "name" }
+    let(:check_value) { "Customer Support" }
 
-        end
-      end
-
-      describe ".topic" do
-
-        context "lookup" do
+    include_context "basic configuration"
 
-          before do
-            stub_get("topics/1.#{format}").
-              to_return(:body => fixture("topic.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
+    it_behaves_like "a list endpoint"
 
-          it "should get the correct resource" do
-            @client.topic(1)
-            a_get("topics/1.#{format}").
-              should have_been_made
-          end
+    it_behaves_like "a show endpoint"
 
-          it "should return up to 100 cases worth of extended information" do
-            topic = @client.topic(1)
-
-            topic.id.should == 1
-            topic.name.should == "General"
-          end
-
-        end
-      end
+    it_behaves_like "a create endpoint", { :name => "Social Media" }
 
-      describe ".create_topic" do
+    it_behaves_like "an update endpoint", { :name => "New Name" } do
+      let(:check_value) { "New Name" }
+    end
 
-        context "create" do
+    it_behaves_like "a delete endpoint"
 
-          before do
-            stub_post("topics.#{format}").
-              to_return(:body => fixture("topic_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
+    context "Translation" do
 
-          it "should post to the correct resource" do
-            @client.create_topic("General", :description => "Everything belongs here")
-            a_post("topics.#{format}").
-              should have_been_made
-          end
+      let(:sub_endpoint) { "translation" }
+      let(:sub_id) { "en_us" }
+      let(:check_key) { "name" }
+      let(:check_value) { "Customer Support" }
 
-          it "should return the new topic" do
-            topic = @client.create_topic("General", :description => "Everything belongs here")
+      it_behaves_like "a sub list endpoint"
 
-            topic.id.should == 9
-            topic.name.should == "General"
-            topic.description.should == "Everything belongs here"
-          end
+      it_behaves_like "a sub show endpoint"
 
-        end
+      it_behaves_like "a sub create endpoint", {
+        :name => "Japanese",
+        :locale => "ja"
+      } do
+        let(:check_value) { "Japanese" }
       end
 
-      describe ".update_topic" do
-
-        context "update" do
-
-          before do
-            stub_put("topics/1.#{format}").
-              to_return(:body => fixture("topic_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
-
-          it "should post to the correct resource" do
-            @client.update_topic(1, :name => "Updated", :description => "Updated Description")
-            a_put("topics/1.#{format}").
-              should have_been_made
-          end
-
-          it "should return the new topic" do
-            topic = @client.update_topic(1, :name => "Updated", :description => "Updated Description")
-
-            topic.name.should == "Updated"
-            topic.description.should == "Updated Description"
-          end
-
-        end
+      it_behaves_like "a sub update endpoint", {
+        :name => "Updated Japanese Translation"
+      } do
+        let(:sub_id) { "ja" }
+        let(:check_value) { "Updated Japanese Translation" }
       end
 
-      describe ".delete_topic" do
-
-        context "delete" do
-
-          before do
-            stub_delete("topics/1.#{format}").
-              to_return(:body => fixture("topic_destroy.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
-          end
+      it_behaves_like "a sub delete endpoint"
 
-          it "should post to the correct resource" do
-            @client.delete_topic(1)
-            a_delete("topics/1.#{format}").
-              should have_been_made
-          end
-
-          it "should return a successful response" do
-            topic = @client.delete_topic(1)
-            topic.success.should == true
-          end
-
-        end
-      end
     end
   end
 end