Merge pull request #75 from apeluffo/add-remove-recipient-smart-invites

Add Support for Smart Invite Remove Participant

Author: gshutler

lib/cronofy/client.rb

@@ -1323,6 +1323,32 @@ def cancel_smart_invite(body={})
       parse_json(SmartInviteResponse, nil, response)
     end
 
+    # Public: Removes an individual recipient from a multiple recipient smart invite
+    #
+    # smart_invite_id - A String uniquely identifying the event for your
+    #                  application (note: this is NOT an ID generated
+    #                  by Cronofy).
+    #
+    # recipient       - A Hash containing the recipient to be removed
+    #                   :email      - A String for the email address of
+    #                                 the recipient to remove.
+    #
+    # See https://docs.cronofy.com/developers/api-alpha/smart-invites/multiple-recipients/#remove-invite-recipient
+    # for reference.
+    #
+    # Returns a SmartInviteResponse
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::InvalidRequestError if the request contains invalid
+    # parameters.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def remove_recipient_smart_invite(body={})
+      body[:method] = 'remove'
+      response = wrapped_request { api_key!.post("/v1/smart_invites", json_request_args(body)) }
+      parse_json(SmartInviteResponse, nil, response)
+    end
+
     # Public: Gets the details for a smart invite.
     #
     # smart_invite_id  - A String uniquely identifying the event for your

spec/lib/cronofy/client_spec.rb

@@ -2630,6 +2630,67 @@
 
   end
 
+  describe "Remove Recipient Smart Invite", test: true do
+    let(:request_url) { "https://api.cronofy.com/v1/smart_invites" }
+    let(:method) { :post }
+
+    let(:request_headers) do
+      {
+        "Authorization" => "Bearer #{client_secret}",
+        "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}",
+        "Content-Type" => "application/json; charset=utf-8",
+      }
+    end
+
+    let(:client_id) { 'example_id' }
+    let(:client_secret) { 'example_secret' }
+
+    let(:client) do
+      Cronofy::Client.new(
+        client_id: client_id,
+        client_secret: client_secret,
+      )
+    end
+
+    let(:args) do
+      {
+        smart_invite_id: "qTtZdczOccgaPncGJaCiLg",
+        recipient: {
+          email: "example@example.com"
+        }
+      }
+    end
+
+    let(:request_body) do
+      {
+        method: 'remove',
+        smart_invite_id: "qTtZdczOccgaPncGJaCiLg",
+        recipient: {
+          email: "example@example.com"
+        }
+      }
+    end
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) do
+      request_body.merge({
+        attachments: {
+          removed: {
+            email: "example@example.com"
+          }
+        }
+      })
+    end
+
+    let(:correct_mapped_result) do
+      Cronofy::SmartInviteResponse.new(correct_response_body)
+    end
+
+    subject { client.remove_recipient_smart_invite(request_body) }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
+
   describe "Batch requests" do
     context "upserting an event" do
       let(:calendar_id) { 'calendar_id_123'}