[RB-326] v31 client updates (#73)

Author: rmustafin

lib/xpm_ruby/connection.rb

@@ -39,8 +39,9 @@ def put(endpoint:, data:)
       raise ConnectionTimeout.new(error.message)
     end
 
-    def delete(endpoint:, id:)
-      response = build_connection(url: url).delete("#{endpoint}/#{id}", nil, headers)
+    def delete(endpoint:, id:, params: {})
+      query_string = CGI.unescape(params.to_query)
+      response = build_connection(url: url).delete("#{endpoint}/#{id}?#{query_string}", nil, headers)
       handle_response(response)
     rescue Faraday::ConnectionFailed => error
       raise ConnectionFailed.new(error.message)

lib/xpm_ruby/contact.rb

@@ -24,10 +24,12 @@ def update(access_token:, xero_tenant_id:, id:, contact:)
       response["Contact"]
     end
 
-    def delete(access_token:, xero_tenant_id:, contact_id:)
+    def delete(access_token:, xero_tenant_id:, contact_id:, client_id: nil)
+      request_params = { client_id: client_id }.compact
+
       response = Connection
         .new(access_token: access_token, xero_tenant_id: xero_tenant_id)
-        .delete(endpoint: "client.api/contact", id: contact_id)
+        .delete(endpoint: "client.api/contact", id: contact_id, params: request_params)
 
       response["Contact"]
     end

lib/xpm_ruby/schema/contact/update.rb

@@ -4,6 +4,9 @@ module XpmRuby
   module Schema
     module Contact
       Update = Types::Hash.schema(
+        Client?: Types::Hash.schema(
+          ID: Types::Coercible::String
+        ).with_key_transform(&:to_sym),
         Name?: Types::String,
         IsPrimary?: Types::String,
         Salutation?: Types::String,

lib/xpm_ruby/version.rb

@@ -1,3 +1,3 @@
 module XpmRuby
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

spec/vcr_cassettes/xpm_ruby/contact/delete.yml

@@ -30,22 +30,46 @@ module XpmRuby
       let(:xero_tenant_id) { "0791dc22-8611-4c1c-8df7-1c5453d0795b" }
       let(:access_token) { "token" }
 
-      let(:contact) do
-        {
-          "Name" => "Acmer Pty Ltd Updated 3"
-        }
+      context "without Client ID" do
+        let(:contact) do
+          {
+            "Name" => "Acmer Pty Ltd Updated 3"
+          }
+        end
+
+        it "updates contact" do
+          VCR.use_cassette("xpm_ruby/contact/update") do
+            updated_contact = Contact.update(
+              access_token: access_token,
+              xero_tenant_id: xero_tenant_id,
+              id: 15412877,
+              contact: contact)
+
+            expect(updated_contact["ID"]).not_to be_nil
+            expect(updated_contact["Name"]).to eql(updated_contact["Name"])
+          end
+        end
       end
 
-      it "updates contact" do
-        VCR.use_cassette("xpm_ruby/contact/update") do
-          updated_contact = Contact.update(
-            access_token: access_token,
-            xero_tenant_id: xero_tenant_id,
-            id: 15412877,
-            contact: contact)
+      context "with Client ID" do
+        let(:contact) do
+          {
+            "Client" => { "ID" => 25655881 },
+            "Name" => "Acmer Pty Ltd Updated 3"
+          }
+        end
+
+        it "updates contact" do
+          VCR.use_cassette("xpm_ruby/contact/update") do
+            updated_contact = Contact.update(
+              access_token: access_token,
+              xero_tenant_id: xero_tenant_id,
+              id: 15412877,
+              contact: contact)
 
-          expect(updated_contact["ID"]).not_to be_nil
-          expect(updated_contact["Name"]).to eql(updated_contact["Name"])
+            expect(updated_contact["ID"]).not_to be_nil
+            expect(updated_contact["Name"]).to eql(updated_contact["Name"])
+          end
         end
       end
     end
@@ -55,15 +79,32 @@ module XpmRuby
       let(:access_token) { "token" }
       let(:contact_id) { "14574323" }
 
-      it "deletes the contact" do
-        VCR.use_cassette("xpm_ruby/contact/delete") do
-          deleted_contact = Contact.delete(
-            access_token: access_token,
-            xero_tenant_id: xero_tenant_id,
-            contact_id: contact_id)
+      context "without Client ID" do
+        it "deletes the contact" do
+          VCR.use_cassette("xpm_ruby/contact/delete") do
+            deleted_contact = Contact.delete(
+              access_token: access_token,
+              xero_tenant_id: xero_tenant_id,
+              contact_id: contact_id)
+
+            expect(deleted_contact["ID"]).to eql(contact_id)
+            expect(deleted_contact["Name"]).to eql("some guy person")
+          end
+        end
+      end
+
+      context "with Client ID" do
+        it "deletes the contact" do
+          VCR.use_cassette("xpm_ruby/contact/delete") do
+            deleted_contact = Contact.delete(
+              access_token: access_token,
+              xero_tenant_id: xero_tenant_id,
+              contact_id: contact_id,
+              client_id: 25655881)
 
-          expect(deleted_contact["ID"]).to eql(contact_id)
-          expect(deleted_contact["Name"]).to eql("some guy person")
+            expect(deleted_contact["ID"]).to eql(contact_id)
+            expect(deleted_contact["Name"]).to eql("some guy person")
+          end
         end
       end
     end

spec/vcr_cassettes/xpm_ruby/contact/update.yml

@@ -8,6 +8,13 @@ module Schema
           hash = { "Name" => "Joe Bloggs" }
           expect { Contact::Update[hash] }.not_to raise_error
         end
+
+        context "with a client ID" do
+          it "should not raise an error" do
+            hash = { "Client" => { "ID" => "123" }, "Name" => "Joe Bloggs" }
+            expect { Contact::Update[hash] }.not_to raise_error
+          end
+        end
       end
     end
   end