desk_api 0.6.1 → 0.6.2

data/spec/desk_api/resource/scrud_spec.rb

@@ -0,0 +1,216 @@
+# Copyright (c) 2013-2016, Salesforce.com, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice, this
+#     list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#
+#   * Neither the name of Salesforce.com nor the names of its contributors may be
+#     used to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'spec_helper'
+
+describe DeskApi::Resource::SCRUD do
+  subject { @client ||= DeskApi::Client.new DeskApi::CONFIG }
+
+  context '#create' do
+    it 'creates a new topic', :vcr do
+      expect(
+        topic = subject.topics.create({
+          name: 'My new topic'
+        }).name
+      ).to eq('My new topic')
+    end
+
+    it 'throws an error creating a user', :vcr do
+      expect(lambda { subject.users.create(name: 'Some User') }).to raise_error(DeskApi::Error::MethodNotAllowed)
+    end
+  end
+
+  context '#update' do
+    it 'updates a topic', :vcr do
+      topic = subject.topics.entries.first
+
+      topic.description = 'Some new description'
+      topic.update({
+        name: 'Updated topic name'
+      })
+
+      expect(topic.name).to eq('Updated topic name')
+      expect(topic.description).to eq('Some new description')
+    end
+
+    it 'throws an error updating a user', :vcr do
+      user = subject.users.entries.first
+      expect(lambda { user.update(name: 'Some User') }).to raise_error(DeskApi::Error::MethodNotAllowed)
+    end
+
+    it 'can update without a hash', :vcr do
+      topic = subject.topics.entries.first
+      topic.description = 'Another description update.'
+      topic.update
+      expect(subject.topics.entries.first.description).to eq('Another description update.')
+    end
+
+    it 'can handle update action params', :vcr do
+      customer  = subject.customers.entries.first
+      num_count = customer.phone_numbers.count
+      phone     = { type: 'home', value: '(415) 555-1234' }
+
+      customer.update({
+        phone_numbers: [phone],
+        phone_numbers_update_action: 'append'
+      })
+
+      expect(customer.reload!.phone_numbers.size).to eq(num_count + 1)
+
+      customer.update({
+        phone_numbers: [phone],
+        phone_numbers_update_action: 'append'
+      })
+
+      expect(customer.reload!.phone_numbers.size).to eq(num_count + 2)
+    end
+
+    it 'can handle action params', :vcr do
+      ticket    = subject.cases.entries.first
+      num_count = ticket.to_hash['labels'].count
+      labels    = ['client_spam', 'client_test']
+
+      ticket.update({
+        labels: labels,
+        label_action: 'append'
+      })
+
+      expect(ticket.labels.reload!.total_entries).to eq(num_count + 2)
+
+      ticket.update({
+        labels: labels,
+        label_action: 'replace'
+      })
+
+      expect(ticket.labels.reload!.total_entries).to eq(2)
+    end
+
+    it 'can handle suppress_rules param', skip: 'does not work with VCR' do
+      # This test requires a Case Updated rule which always sets case status
+      # to open and stops processing if case labels contains
+      # 'suppress_rules_test'
+      #
+      # The case is updated to add the suppress_rules label,
+      # the rule will append 'test_failed' if it is run
+
+      VCR.turn_off! ignore_cassettes: true
+
+      ticket = subject.cases.entries.first
+      labels = ticket.to_hash['labels']
+
+      ticket.update({
+        labels: ['suppress_rules_test'],
+        label_action: 'append',
+        suppress_rules: true
+      })
+
+      expect(ticket.labels.reload!.entries.map(&:name).include?('test_failed')).to be false
+
+      ticket.update({
+        labels: labels,
+        label_action: 'replace'
+      })
+
+      VCR.turn_on!
+    end
+
+    it 'can replace instead of append', :vcr do
+      customer  = subject.customers.entries.first
+      phone     = { type: 'home', value: '(415) 555-1234' }
+
+      customer.update({
+        phone_numbers: [phone, phone, phone],
+        phone_numbers_update_action: 'append'
+      })
+
+      num_count = customer.reload!.phone_numbers.size
+      customer.update({
+        phone_numbers: [{ type: 'other', value: '(415) 555-4321' }],
+        phone_numbers_update_action: 'replace'
+      })
+
+      expect(customer.reload!.phone_numbers.size).to eq(1)
+      expect(num_count).not_to eq(customer.phone_numbers.size)
+    end
+
+    it 'can handle links', :vcr do
+      thomas = { "href"=>"/api/v2/users/16096734", "class"=>"user" }
+      andy   = { "href"=>"/api/v2/users/21923785", "class"=>"user" }
+      ticket = subject.cases.find(3186)
+
+      ticket.update({
+        _links: { assigned_user: thomas }
+      })
+
+      expect(ticket.assigned_user.public_name).to eq('Thomas Stachl')
+      expect(ticket.load!.assigned_user.public_name).to eq('Thomas Stachl')
+
+      ticket.update({
+        _links: { assigned_user: andy }
+      })
+
+      expect(ticket.assigned_user.public_name).to eq('Andrew Frauen')
+      expect(ticket.load!.assigned_user.public_name).to eq('Andrew Frauen')
+    end
+  end
+
+  context '#delete' do
+    it 'deletes a resource', :vcr do
+      expect(
+        subject.articles.create({
+          subject: 'My subject',
+          body: 'Some text for this new article',
+          _links: {
+            topic: subject.topics.entries.first.get_self
+          }
+        }).delete
+      ).to eq(true)
+    end
+
+    it 'throws an error deleting a non deletalbe resource', :vcr do
+      user = subject.users.entries.first
+      expect(lambda { user.delete }).to raise_error(DeskApi::Error::MethodNotAllowed)
+    end
+  end
+
+  context '#search' do
+    it 'allows searching on search enabled resources', :vcr do
+      expect(subject.articles.search(text: 'Lorem Ipsum').total_entries).to eq(0)
+    end
+  end
+
+  context '#find' do
+    it 'loads the requested resource', :vcr do
+      expect(subject.cases.find(3065).subject).to eq('Testing the Tank again')
+    end
+
+    it 'has an alias by_id', :vcr do
+      expect(subject.cases.find(3065).subject).to eq('Testing the Tank again')
+    end
+  end
+end

data/spec/desk_api/resource_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2014, Salesforce.com, Inc.
+# Copyright (c) 2013-2016, Salesforce.com, Inc.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -39,11 +39,11 @@ describe DeskApi::Resource do
     end
 
     it 'is not loaded initially' do
-      expect(subject.articles.instance_variable_get(:@_loaded)).to be_false
+      expect(subject.articles.instance_variable_get(:@_loaded)).to eq(false)
     end
 
     it 'sets up the link to self' do
-      expect(subject.articles.href).not_to be_nil
+      expect(subject.articles.href).not_to eq(nil)
     end
 
     context 'additional options' do
@@ -64,19 +64,19 @@ describe DeskApi::Resource do
       end
 
       it 'does not automatically load the resource' do
-        expect(subject.cases(company_id: 1).instance_variable_get(:@_loaded)).to be_false
+        expect(subject.cases(company_id: 1).instance_variable_get(:@_loaded)).to eq(false)
       end
     end
   end
 
   context '#exec!', :vcr do
     it 'loads the current resource' do
-      expect(subject.articles.send(:exec!).instance_variable_get(:@_loaded)).to be_true
+      expect(subject.articles.send(:exec!).instance_variable_get(:@_loaded)).to eq(true)
     end
 
     it 'can be forced to reload' do
       subject.articles.instance_variable_set(:@_loaded, true)
-      subject.should_receive(:get).and_call_original
+      expect(subject).to receive(:get).and_call_original
       subject.articles.send(:exec!, true)
     end
   end
@@ -85,7 +85,7 @@ describe DeskApi::Resource do
     it 'loads the resource to find a suitable method' do
       articles = subject.articles
       articles.instance_variable_set(:@_loaded, false)
-      articles.should_receive(:exec!).and_call_original
+      expect(articles).to receive(:exec!).and_call_original
       articles.entries
     end
 
@@ -104,16 +104,16 @@ describe DeskApi::Resource do
 
     it 'loads the resource to find a suitable method' do
       @company.instance_variable_set(:@_loaded, false)
-      @company.should_receive(:exec!)
+      expect(@company).to receive(:exec!)
       @company.respond_to?(:name)
     end
 
     it 'returns true if method found in definition' do
-      expect(@company.respond_to?(:name)).to be_true
+      expect(@company.respond_to?(:name)).to eq(true)
     end
 
     it 'returns false if method does not exist' do
-      expect(@company.respond_to?(:no_method_here)).to be_false
+      expect(@company.respond_to?(:no_method_here)).to eq(false)
     end
   end
 
@@ -156,249 +156,13 @@ describe DeskApi::Resource do
     end
   end
 
-  context '#search' do
-    it 'allows searching on search enabled resources', :vcr do
-      expect(subject.articles.search(text: 'Lorem Ipsum').total_entries).to eq(0)
-    end
-  end
-
-  context '#create' do
-    it 'creates a new topic', :vcr do
-      expect(
-        topic = subject.topics.create({
-          name: 'My new topic'
-        }).name
-      ).to eq('My new topic')
-    end
-
-    it 'throws an error creating a user', :vcr do
-      expect(lambda { subject.users.create(name: 'Some User') }).to raise_error(DeskApi::Error::MethodNotAllowed)
-    end
-  end
-
-  context '#update' do
-    it 'updates a topic', :vcr do
-      topic = subject.topics.entries.first
-
-      topic.description = 'Some new description'
-      topic.update({
-        name: 'Updated topic name'
-      })
-
-      expect(topic.name).to eq('Updated topic name')
-      expect(topic.description).to eq('Some new description')
-    end
-
-    it 'throws an error updating a user', :vcr do
-      user = subject.users.entries.first
-      expect(lambda { user.update(name: 'Some User') }).to raise_error(DeskApi::Error::MethodNotAllowed)
-    end
-
-    it 'can update without a hash', :vcr do
-      topic = subject.topics.entries.first
-      topic.description = 'Another description update.'
-      topic.update
-      expect(subject.topics.entries.first.description).to eq('Another description update.')
-    end
-
-    it 'can handle update action params', :vcr do
-      customer  = subject.customers.entries.first
-      num_count = customer.phone_numbers.count
-      phone     = { type: 'home', value: '(415) 555-1234' }
-
-      customer.update({
-        phone_numbers: [phone],
-        phone_numbers_update_action: 'append'
-      })
-
-      expect(customer.reload!.phone_numbers.size).to eq(num_count + 1)
-
-      customer.update({
-        phone_numbers: [phone],
-        phone_numbers_update_action: 'append'
-      })
-
-      expect(customer.reload!.phone_numbers.size).to eq(num_count + 2)
-    end
-
-    it 'can handle action params', :vcr do
-      ticket    = subject.cases.entries.first
-      num_count = ticket.to_hash['labels'].count
-      labels    = ['client_spam', 'client_test']
-
-      ticket.update({
-        labels: labels,
-        label_action: 'append'
-      })
-
-      expect(ticket.labels.reload!.total_entries).to eq(num_count + 2)
-
-      ticket.update({
-        labels: labels,
-        label_action: 'replace'
-      })
-
-      expect(ticket.labels.reload!.total_entries).to eq(2)
-    end
-
-    it 'can replace instead of append', :vcr do
-      customer  = subject.customers.entries.first
-      phone     = { type: 'home', value: '(415) 555-1234' }
-
-      customer.update({
-        phone_numbers: [phone, phone, phone],
-        phone_numbers_update_action: 'append'
-      })
-
-      num_count = customer.reload!.phone_numbers.size
-      customer.update({
-        phone_numbers: [{ type: 'other', value: '(415) 555-4321' }],
-        phone_numbers_update_action: 'replace'
-      })
-
-      expect(customer.reload!.phone_numbers.size).to eq(1)
-      expect(num_count).not_to eq(customer.phone_numbers.size)
-    end
-
-    it 'can handle links', :vcr do
-      thomas = { "href"=>"/api/v2/users/16096734", "class"=>"user" }
-      andy   = { "href"=>"/api/v2/users/21923785", "class"=>"user" }
-      ticket = subject.cases.find(3186)
-
-      ticket.update({
-        _links: { assigned_user: thomas }
-      })
-
-      expect(ticket.assigned_user.public_name).to eq('Thomas Stachl')
-      expect(ticket.load!.assigned_user.public_name).to eq('Thomas Stachl')
-
-      ticket.update({
-        _links: { assigned_user: andy }
-      })
-
-      expect(ticket.assigned_user.public_name).to eq('Andrew Frauen')
-      expect(ticket.load!.assigned_user.public_name).to eq('Andrew Frauen')
-    end
-  end
-
-  context '#delete' do
-    it 'deletes a resource', :vcr do
-      expect {
-        subject.articles.create({
-          subject: 'My subject',
-          body: 'Some text for this new article',
-          _links: {
-            topic: subject.topics.entries.first.get_self
-          }
-        }).delete
-      }.to be_true
-    end
-
-    it 'throws an error deleting a non deletalbe resource', :vcr do
-      user = subject.users.entries.first
-      expect(lambda { user.delete }).to raise_error(DeskApi::Error::MethodNotAllowed)
-    end
-  end
-
-  describe 'embeddable' do
-    it 'allows to declare embedds' do
-      expect(lambda { subject.cases.embed(:assigned_user) }).not_to raise_error
-    end
-
-    it 'changes the url' do
-      expect(subject.cases.embed(:assigned_user).href).to eq('/api/v2/cases?embed=assigned_user')
-    end
-
-    context 'if you use embed' do
-      before do
-        VCR.turn_off! ignore_cassettes: true
-
-        @stubs  ||= Faraday::Adapter::Test::Stubs.new
-        @client ||= DeskApi::Client.new(DeskApi::CONFIG).tap do |client|
-          client.middleware = Proc.new do |builder|
-            builder.response :desk_parse_dates
-            builder.response :desk_parse_json
-
-            builder.adapter :test, @stubs
-          end
-        end
-      end
-
-      after do
-        VCR.turn_on!
-      end
-
-      it 'does not load the resource again' do
-        times_called = 0
-        @stubs.get('/api/v2/cases?embed=assigned_user') do
-          times_called += 1
-          [
-            200,
-            { 'content-type' => 'application/json' },
-            File.open(File.join(RSpec.configuration.root_path, 'stubs', 'cases_embed_assigned_user.json')).read
-          ]
-        end
-
-        first_case = @client.cases.embed(:assigned_user).entries.first
-        expect(first_case.assigned_user.name).to eq('Thomas Stachl')
-        expect(first_case.assigned_user.instance_variable_get(:@_loaded)).to be_true
-        expect(times_called).to eq(1)
-      end
-
-      it 'can be used in finder' do
-        @stubs.get('/api/v2/cases/3011?embed=customer') do
-          [
-            200,
-            { 'content-type' => 'application/json' },
-            File.open(File.join(RSpec.configuration.root_path, 'stubs', 'case_embed_customer.json')).read
-          ]
-        end
-
-        customer = @client.cases.find(3011, embed: :customer).customer
-        expect(customer.first_name).to eq('Thomas')
-        customer = @client.cases.find(3011, embed: [:customer]).customer
-        expect(customer.first_name).to eq('Thomas')
-      end
-    end
-  end
-
-  context '#query_params' do
-    before do
-      @page = DeskApi::Resource.new(subject, {
-        '_links'=>{'self'=>{'href'=>'/api/v2/cases?page=2&per_page=50'}}
-      }, true)
-    end
-
-    it 'allows to get query params from the current resource' do
-      expect(@page.send(:query_params_include?, 'page')).to eq('2')
-      expect(@page.send(:query_params_include?, 'per_page')).to eq('50')
-    end
-
-    it 'returns nil if param not found' do
-      expect(@page.send(:query_params_include?, 'blup')).to be_nil
-    end
-  end
-
-  context '#query_params=' do
-    before do
-      @page = DeskApi::Resource.new(subject, {
-        '_links'=>{'self'=>{'href'=>'/api/v2/cases'}}
-      }, true)
-    end
-
-    it 'sets query params on the current url' do
-      @page.send(:query_params=, { page: 5, per_page: 50 })
-      expect(@page.instance_variable_get(:@_definition)['_links']['self']['href']).to eq('/api/v2/cases?page=5&per_page=50')
-    end
-  end
-
   context '#get_linked_resource' do
     it 'returns linked resources', :vcr do
       expect(subject.cases.entries.first.customer).to be_an_instance_of(DeskApi::Resource)
     end
 
     it 'returns nil if link is nil', :vcr do
-      expect(subject.articles.next).to be_nil
+      expect(subject.articles.next).to eq(nil)
     end
 
     it 'saves the linked resource instead of the url', :vcr do
@@ -408,36 +172,6 @@ describe DeskApi::Resource do
     end
   end
 
-  context '#page' do
-    it 'returns the current page and loads if page not defined', :vcr do
-      expect(subject.articles.page).to eq(1)
-    end
-
-    it 'sets the page' do
-      expect(subject.cases.page(5).page).to eq(5)
-    end
-
-    it 'sets the resource to not loaded', :vcr do
-      cases = subject.cases.send(:exec!)
-      expect(cases.page(5).instance_variable_get(:@_loaded)).to be_false
-    end
-
-    it 'keeps the resource as loaded', :vcr do
-      cases = subject.cases.send(:exec!)
-      expect(cases.page(1).instance_variable_get(:@_loaded)).to be_true
-    end
-  end
-
-  context '#find' do
-    it 'loads the requested resource', :vcr do
-      expect(subject.cases.find(3065).subject).to eq('Testing the Tank again')
-    end
-
-    it 'has an alias by_id', :vcr do
-      expect(subject.cases.find(3065).subject).to eq('Testing the Tank again')
-    end
-  end
-
   context '#to_hash' do
     it 'returns a hash for a desk resource', :vcr do
       expect(subject.topics.entries.first.to_hash).to eq({
@@ -491,52 +225,11 @@ describe DeskApi::Resource do
     end
 
     it 'returns nil on the last page', :vcr do
-      expect(subject.cases.last.next!).to eq(nil)
-    end
-
-  end
-
-  context '#each_page' do
-    it 'iterates over each page', :vcr do
-      subject.cases.each_page do |page, page_number|
-        expect(page).to be_an_instance_of(DeskApi::Resource)
-        expect(page.resource_type).to eq('page')
-        expect(page_number).to be_an_instance_of(Fixnum)
-      end
-    end
-
-    it 'uses a default per_page of 1000', :vcr do
-      subject.cases.each_page do |page, page_number|
-        expect((page.query_params['per_page'].to_i % 10)).to eq(0)
-      end
-    end
-
-    it 'uses per_page from query_params if present' do
-      subject.cases.per_page(25) do |page, page_number|
-        expect(page.query_params['per_page']).to eq(25)
-      end
-    end
-
-    it 'raises ArgumentError if no block is given' do
-      expect { subject.cases.each_page }.to raise_error(ArgumentError)
-    end
-
-    it 'raises NoMethodError is called on non-page resources', :vcr do
-      expect { subject.cases.entries.first.each_page { |x| x } }.to raise_error(NoMethodError)
-    end
-  end
-
-  context '#all' do
-    it 'iterates over each resource on each page', :vcr do
-      subject.cases.all do |resource, page_num|
-        expect(resource).to be_an_instance_of(DeskApi::Resource)
-        expect(resource.resource_type).to eq('case')
-        expect(page_num).to be_an_instance_of(Fixnum)
-      end
+      expect(subject.cases.last.next!).to be_nil
     end
 
-    it 'raises an argument error if no block is given' do
-      expect { subject.cases.all }.to raise_error(ArgumentError)
+    it 'returns nil on non-page resources', :vcr do
+      expect(subject.cases.entries.first.next!).to be_nil
     end
   end