desk_api 0.6.1 → 0.6.2

data/spec/desk_api/client_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,
@@ -183,14 +183,40 @@ describe DeskApi::Client do
   end
 
   describe '#request' do
-    it 'catches Faraday errors' do
-      allow(subject).to receive(:connection).and_raise(Faraday::Error::ClientError.new('Oops'))
-      expect(lambda { subject.send(:request, :get, '/path') }).to raise_error(DeskApi::Error::ClientError)
+    context 'Faraday::Error::ClientError' do
+      before do
+        allow(subject).to receive(:connection).and_raise(Faraday::Error::ClientError.new('Oops'))
+      end
+
+      it 'catches the error' do
+        expect(lambda { subject.send(:request, :get, '/path') }).to raise_error(DeskApi::Error::ClientError)
+      end
+
+      it 'wraps the original error' do
+        begin
+          subject.send(:request, :get, '/path')
+        rescue DeskApi::Error::ClientError => err
+          expect(err.instance_variable_get(:@wrapped_err)).to be_an_instance_of(Faraday::Error::ClientError)
+        end
+      end
     end
 
-    it 'catches JSON::ParserError errors' do
-      allow(subject).to receive(:connection).and_raise(JSON::ParserError.new('unexpected token'))
-      expect(lambda { subject.send(:request, :get, '/path') }).to raise_error(DeskApi::Error::ParserError)
+    context 'JSON::ParserError' do
+      before do
+        allow(subject).to receive(:connection).and_raise(JSON::ParserError.new('unexpected token'))
+      end
+
+      it 'catches the error' do
+        expect(lambda { subject.send(:request, :get, '/path') }).to raise_error(DeskApi::Error::ParserError)
+      end
+
+      it 'wraps the original error' do
+        begin
+          subject.send(:request, :get, '/path')
+        rescue DeskApi::Error::ParserError => err
+          expect(err.instance_variable_get(:@wrapped_err)).to be_an_instance_of(JSON::ParserError)
+        end
+      end
     end
   end
 end

data/spec/desk_api/configuration_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,
@@ -199,13 +199,13 @@ describe DeskApi::Configuration do
     end
 
     it 'returns false if no authentication credentials are set' do
-      expect(@client.credentials?).to be_false
+      expect(@client.credentials?).to eq(false)
     end
 
     it 'returns true if basic auth credentials are set' do
       @client.username = 'UN'
       @client.password = 'PW'
-      expect(@client.credentials?).to be_true
+      expect(@client.credentials?).to eq(true)
     end
 
     it 'returns true if oauth credentials are set' do
@@ -213,7 +213,7 @@ describe DeskApi::Configuration do
       @client.consumer_secret = 'CS'
       @client.token = 'TOK'
       @client.token_secret = 'TOKS'
-      expect(@client.credentials?).to be_true
+      expect(@client.credentials?).to eq(true)
     end
   end
 end

data/spec/desk_api/default_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,

data/spec/desk_api/error_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,

data/spec/desk_api/rate_limit_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,

data/spec/desk_api/request/encode_dates_spec.rb

@@ -0,0 +1,63 @@
+# 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'
+require 'desk_api/request/encode_dates'
+
+describe DeskApi::Request::EncodeDates do
+  before(:all) do
+    VCR.turn_off!
+
+    @time  = Time.now
+    @stubs = Faraday::Adapter::Test::Stubs.new
+    @conn  = Faraday.new do |builder|
+      builder.request :desk_encode_dates
+      builder.request :desk_encode_json
+      builder.adapter :test, @stubs
+    end
+  end
+
+  after(:all) do
+    VCR.turn_on!
+  end
+
+  it 'encodes the date, datetime and time to iso8601' do
+    @stubs.post('/echo') do |env|
+      body = JSON.parse(env[:body], symbolize_names: true)
+      expect(body[:date]).to eq(@time.to_date.to_time.utc.iso8601)
+      expect(body[:datetime]).to eq(@time.utc.iso8601)
+      expect(body[:time]).to eq(@time.utc.iso8601)
+    end
+
+    @conn.post('http://localhost/echo', {
+      date: @time.to_date,
+      datetime: @time.to_datetime,
+      time: @time
+    })
+  end
+end

data/spec/desk_api/request/encode_json_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,
@@ -30,7 +30,7 @@ require 'spec_helper'
 require 'desk_api/request/encode_json'
 
 describe DeskApi::Request::EncodeJson do
-  before do
+  before(:all) do
     VCR.turn_off!
 
     @stubs = Faraday::Adapter::Test::Stubs.new
@@ -40,7 +40,7 @@ describe DeskApi::Request::EncodeJson do
     end
   end
 
-  after do
+  after(:all) do
     VCR.turn_on!
   end
 
@@ -54,7 +54,7 @@ describe DeskApi::Request::EncodeJson do
 
   it 'encodes the body into json' do
     @stubs.post('/echo') do |env|
-      expect(!!JSON.parse(env[:body])).to be_true
+      expect(!!JSON.parse(env[:body])).to eq(true)
     end
     @conn.post('http://localhost/echo', test: 'test')
   end

data/spec/desk_api/request/oauth_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,

data/spec/desk_api/request/retry_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,

data/spec/desk_api/resource/download_spec.rb

@@ -0,0 +1,45 @@
+# 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'
+require 'fileutils'
+
+describe DeskApi::Resource::Download do
+  subject { @client ||= DeskApi::Client.new DeskApi::CONFIG }
+
+  it 'throws an error on non attachment resources', :vcr do
+    expect(lambda { subject.cases.find(3065).download })
+      .to raise_error(NoMethodError)
+  end
+
+  it 'downloads the attachment', :vcr do
+    a = subject.cases.find(3065).attachments.entries.first.download
+    b = File.open(File.join(RSpec.configuration.root_path, 'stubs', 'file.jpg'))
+    expect(a.read).to eq(b.read)
+  end
+end

data/spec/desk_api/resource/pagination_spec.rb

@@ -0,0 +1,77 @@
+# 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::Pagination do
+  subject { @client ||= DeskApi::Client.new DeskApi::CONFIG }
+
+  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
+    end
+
+    it 'raises an argument error if no block is given' do
+      expect { subject.cases.all }.to raise_error(ArgumentError)
+    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
+end

data/spec/desk_api/resource/query_params_spec.rb

@@ -0,0 +1,145 @@
+# 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::QueryParams do
+  subject { @client ||= DeskApi::Client.new DeskApi::CONFIG }
+
+  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 eq(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 eq(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 '#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 eq(false)
+    end
+
+    it 'keeps the resource as loaded', :vcr do
+      cases = subject.cases.send(:exec!)
+      expect(cases.page(1).instance_variable_get(:@_loaded)).to eq(true)
+    end
+  end
+end