braze_ruby 0.2.1 → 0.4.0

data/spec/fixtures/responses/track_users/with_success/responds_with_created.yml

@@ -5,23 +5,29 @@ http_interactions:
     uri: "<BRAZE_REST_URL>/users/track"
     body:
       encoding: UTF-8
-      string: '{"api_key":"<BRAZE_REST_API_KEY>","attributes":[{"external_id":1,"foo":"bar"}],"events":[{"external_id":1,"name":"baz","time":"2019-02-15
+      string: '{"attributes":[{"external_id":1,"foo":"bar"}],"events":[{"external_id":1,"name":"baz","time":"2019-02-15
         00:00:00 -0500"}],"purchases":[{"external_id":1,"product_id":1,"time":"2019-02-15
         00:00:00 -0500","currency":"CAD","price":1.0}]}'
     headers:
-      User-Agent:
-      - Faraday v0.14.0
       Content-Type:
       - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - Braze Ruby gem v0.3.3
+      Authorization:
+      - Bearer <BRAZE_REST_API_KEY>
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
   response:
     status:
       code: 201
       message: Created
     headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '85'
       Cache-Control:
       - max-age=0, private, must-revalidate
       Content-Type:
@@ -34,38 +40,34 @@ http_interactions:
       - max-age=0; includeSubDomains
       - max-age=31536000; includeSubDomains
       X-Ratelimit-Limit:
-      - '50000'
+      - '250000'
       X-Ratelimit-Remaining:
-      - '50000'
+      - '250000'
       X-Ratelimit-Reset:
-      - '1524002400'
+      - '1592427600'
       X-Request-Id:
-      - af452a7f-9be9-417d-b9d5-2c4db3de274d
+      - 2e7a73fc-7efe-4c04-b837-c696cb10735a
       X-Runtime:
-      - '0.020310'
-      Content-Length:
-      - '85'
+      - '0.007710'
       Accept-Ranges:
       - bytes
       Date:
-      - Tue, 17 Apr 2018 21:08:07 GMT
+      - Wed, 17 Jun 2020 20:31:42 GMT
       Via:
       - 1.1 varnish
-      Connection:
-      - keep-alive
       X-Served-By:
-      - cache-pdk17837-PDK
+      - cache-hhn4030-HHN
       X-Cache:
       - MISS
       X-Cache-Hits:
       - '0'
       X-Timer:
-      - S1523999287.293178,VS0,VE220
+      - S1592425903.632582,VS0,VE10
       Vary:
-      - Accept-Encoding
+      - Origin,Accept-Encoding
     body:
       encoding: ASCII-8BIT
       string: '{"attributes_processed":1,"events_processed":1,"purchases_processed":1,"message":"success"}'
     http_version: 
-  recorded_at: Tue, 17 Apr 2018 21:08:07 GMT
-recorded_with: VCR 4.0.0
+  recorded_at: Wed, 17 Jun 2020 20:31:42 GMT
+recorded_with: VCR 5.0.0

data/spec/fixtures/responses/track_users/with_success/responds_with_success_message.yml

@@ -5,23 +5,29 @@ http_interactions:
     uri: "<BRAZE_REST_URL>/users/track"
     body:
       encoding: UTF-8
-      string: '{"api_key":"<BRAZE_REST_API_KEY>","attributes":[{"external_id":1,"foo":"bar"}],"events":[{"external_id":1,"name":"baz","time":"2019-02-15
+      string: '{"attributes":[{"external_id":1,"foo":"bar"}],"events":[{"external_id":1,"name":"baz","time":"2019-02-15
         00:00:00 -0500"}],"purchases":[{"external_id":1,"product_id":1,"time":"2019-02-15
         00:00:00 -0500","currency":"CAD","price":1.0}]}'
     headers:
-      User-Agent:
-      - Faraday v0.14.0
       Content-Type:
       - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - Braze Ruby gem v0.3.3
+      Authorization:
+      - Bearer <BRAZE_REST_API_KEY>
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
   response:
     status:
       code: 201
       message: Created
     headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '85'
       Cache-Control:
       - max-age=0, private, must-revalidate
       Content-Type:
@@ -34,38 +40,34 @@ http_interactions:
       - max-age=0; includeSubDomains
       - max-age=31536000; includeSubDomains
       X-Ratelimit-Limit:
-      - '50000'
+      - '250000'
       X-Ratelimit-Remaining:
-      - '50000'
+      - '250000'
       X-Ratelimit-Reset:
-      - '1524002400'
+      - '1592427600'
       X-Request-Id:
-      - e810e390-4c31-49ac-abd4-5b1151cc3c33
+      - 75dc3ac0-d4d2-4278-89d0-b29e540dc719
       X-Runtime:
-      - '0.012176'
-      Content-Length:
-      - '85'
+      - '0.008741'
       Accept-Ranges:
       - bytes
       Date:
-      - Tue, 17 Apr 2018 21:08:07 GMT
+      - Wed, 17 Jun 2020 20:31:42 GMT
       Via:
       - 1.1 varnish
-      Connection:
-      - keep-alive
       X-Served-By:
-      - cache-pdk17824-PDK
+      - cache-hhn4063-HHN
       X-Cache:
       - MISS
       X-Cache-Hits:
       - '0'
       X-Timer:
-      - S1523999288.612820,VS0,VE214
+      - S1592425903.749169,VS0,VE11
       Vary:
-      - Accept-Encoding
+      - Origin,Accept-Encoding
     body:
       encoding: ASCII-8BIT
       string: '{"attributes_processed":1,"events_processed":1,"purchases_processed":1,"message":"success"}'
     http_version: 
-  recorded_at: Tue, 17 Apr 2018 21:08:07 GMT
-recorded_with: VCR 4.0.0
+  recorded_at: Wed, 17 Jun 2020 20:31:42 GMT
+recorded_with: VCR 5.0.0

data/spec/integrations/campaigns_spec.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'campaigns' do
   describe 'trigger_send' do
     it 'sends an email', vcr: true do
       response = api.trigger_campaign_send(
-        campaign_id: '69e9b681-779c-4b4c-b6b8-cd74b17d21d2',
+        campaign_id: 'd8b73da7-0b7c-fc72-1d80-e59c7f20f0d3',
         recipients: [
-          external_user_id: 132404,
+          external_user_id: 12345,
           trigger_properties: {first_name: 'John'}
         ]
       )
+
+      expect(response.success?).to eq(true)
     end
   end
 end

data/spec/integrations/canvas_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'canvas' do
+  describe 'trigger_send' do
+    it 'sends a canvas', vcr: true do
+      response = api.trigger_canvas_send(
+        canvas_id: '70a7fb99-cbcb-451a-8224-5f8b8c63e03f',
+        recipients: [
+          external_user_id: 12345,
+          canvas_entry_properties: {first_name: 'John'}
+        ]
+      )
+
+      expect(response.success?).to eq(true)
+    end
+  end
+
+  describe 'details' do
+    it 'returns error when no canvas', vcr: true do
+      response = api.canvas_details(
+        canvas_id: 'non-existing'
+      )
+      expect(response.status).to eq(400)
+    end
+  end
+end

data/spec/integrations/delete_users_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'delete users' do
@@ -14,6 +16,7 @@ describe 'delete users' do
 
     it 'responds with success message' do
       expect(JSON.parse(delete_users.body)).to include(
+          'deleted' => 3,
           'message' => 'success'
         )
     end

data/spec/integrations/email_status_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'email status' do

data/spec/integrations/email_sync_spec.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe 'email sync' do
   describe 'unsubscribes' do
     it 'responds with unsubscribed emails', vcr: true do
-      response = api.email_unsubscribes(start_date: '2019-03-20', end_date: '2019-03-25')
+      response = api.email_unsubscribes(start_date: '2020-06-17', end_date: '2020-06-18')
       emails = JSON.parse(response.body)['emails']
 
       expect(emails.size).to eq(1)
-      expect(emails.first['email']).to eq('wojtek@test.com')
+      expect(emails.first['email']).to eq('example@123.com')
     end
 
     it 'responds with empty array when no unsubscribes', vcr: true do

data/spec/integrations/export_users_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'export users' do
   context 'by ids' do
-    subject(:export_users) { api.export_users(external_ids: [1]) }
+    subject(:export_users) { api.export_users(external_ids: [12345]) }
 
     context 'with success', :vcr do
       it 'responds with created' do
@@ -13,7 +15,7 @@ describe 'export users' do
 
   context 'by segment' do
     context 'with success', :vcr do
-      let(:segment_id) { braze_test_segment }
+      let(:segment_id) { "3aca937b-9bbc-4e42-9370-05e411967b2b" }
 
       subject(:export_users) do
         api.export_users(segment_id: segment_id, callback_endpoint: 'https://example.com')

data/spec/integrations/identify_users_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'identify users' do
+  let(:user) { { external_id: 12345, user_alias: { alias_name: 'abc', alias_label: 'foo' } } }
+
+  subject(:identify_users) do
+    api.identify_users(aliases_to_identify: [user])
+  end
+
+  context 'with success', vcr: true do
+    it 'responds with created' do
+      expect(identify_users.status).to be 201
+    end
+
+    it 'responds with success message' do
+      expect(JSON.parse(identify_users.body)).to eq(
+          'aliases_processed' => 1,
+          'message' => 'success'
+        )
+    end
+  end
+
+  context 'unauthorized', vcr: true do
+    let(:api_key) { 'non-existent' }
+
+    it 'responds with unauthorized' do
+      expect(identify_users.status).to be 401
+    end
+  end
+end

data/spec/integrations/list_segments_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'list segments' do
@@ -9,7 +11,7 @@ describe 'list segments' do
     end
 
     it 'responds with a list of segments' do
-      expect(segments.count).to be 13
+      expect(segments.count).to be 6
     end
 
     def segments

data/spec/integrations/schedule_messages_spec.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'schedule messages' do
-  let(:user_ids) { [1] }
+  let(:user_ids) { [12345] }
+  let(:test_time) { "2020-08-07T00:00:00+02:00" }
   let(:messages) { build(:messages) }
 
   subject(:schedule_messages) do

data/spec/integrations/send_messages_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'send messages' do
-  let(:user_ids) { [1] }
+  let(:user_ids) { [12345] }
   let(:messages) { build(:messages) }
 
   subject(:send_messages) do
@@ -15,6 +17,7 @@ describe 'send messages' do
 
     it 'responds with success message' do
       expect(JSON.parse(send_messages.body)).to eq(
+          'dispatch_id' => "ea0532cddfc97cd4e5767b351d6af0eb",
           'message' => 'success'
         )
     end

data/spec/integrations/subscription_spec.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'subscription', vcr: true do
+  let(:subscription_group_id) { 'ed06e19a-69b1-4f9b-a452-2db2c4e303a8' }
+  let(:subscribed_user) { 'test-user-1' }
+  let(:unsubscribed_user) { 'test-user-2' }
+  let(:never_subscribed_user) { 'test-user-3' }
+
+  context 'when getting subscription group statuses' do
+    let(:json_response) { JSON.parse(response.body) }
+
+    before do
+      api.subscription_status_set(
+        external_id: subscribed_user,
+        subscription_group_id: subscription_group_id,
+        subscription_state: 'subscribed'
+      )
+
+      api.subscription_status_set(
+        external_id: unsubscribed_user,
+        subscription_group_id: subscription_group_id,
+        subscription_state: 'unsubscribed'
+      )
+    end
+
+    describe 'subscription_user_status' do
+      subject(:response) do
+        api.subscription_user_status(
+          external_id: external_id,
+        )
+      end
+
+      let(:external_id) { [subscribed_user, unsubscribed_user, never_subscribed_user] }
+
+      it 'returns subscription groups and status for every group' do
+        expect(response.status).to eq(200)
+        expect(json_response).to match(
+          'message' => 'success',
+          'total_count' => 3,
+          'users' => [
+            hash_including(
+              'external_id' => subscribed_user,
+              'subscription_groups' => [
+                hash_including(
+                  'id' => subscription_group_id,
+                  'status' => 'Subscribed'
+                )
+              ]
+            ),
+            hash_including(
+              'external_id' => unsubscribed_user,
+              'subscription_groups' => [
+                hash_including(
+                  'id' => subscription_group_id,
+                  'status' => 'Unsubscribed'
+                )
+              ]
+            ),
+            hash_including(
+              'external_id' => never_subscribed_user,
+              'subscription_groups' => []
+            )
+          ]
+        )
+      end
+    end
+
+    describe 'subscription_status_get' do
+      subject(:response) do
+        api.subscription_status_get(
+          external_id: external_id,
+          subscription_group_id: subscription_group_id
+        )
+      end
+
+      context 'when checking subscribed and unsubscribed user status' do
+        let(:external_id) { [subscribed_user, unsubscribed_user, never_subscribed_user] }
+
+        it 'returns only users that were once subscribed' do
+          expect(response.status).to eq(200)
+          expect(json_response).to eq(
+            'message' => 'success',
+            'status' => {
+              'test-user-1' => 'Subscribed',
+              'test-user-2' => 'Unsubscribed',
+              'test-user-3' => 'unknown'
+            }
+          )
+        end
+      end
+
+      context 'when group does not exist' do
+        let(:external_id) { subscribed_user }
+        let(:subscription_group_id) { 'non-existing-subscription-group' }
+
+        it 'returns an error' do
+          expect(response.status).to eq(400)
+        end
+      end
+    end
+
+  end
+
+  describe 'subscription_status_set' do
+    subject(:response) do
+      api.subscription_status_set(
+        external_id: external_id,
+        subscription_group_id: subscription_group_id,
+        subscription_state: subscription_state
+      )
+    end
+
+    let(:external_id) { subscribed_user }
+    let(:subscription_state) { 'subscribed' }
+
+    context 'when subscribing' do
+      it 'subscribes the user' do
+        expect(response.status).to eq(201)
+      end
+    end
+
+    context 'when unsubscribing' do
+      let(:external_id) { unsubscribed_user }
+      let(:subscription_state) { 'unsubscribed' }
+
+      before do
+        api.subscription_status_set(
+          external_id: external_id,
+          subscription_group_id: subscription_group_id,
+          subscription_state: 'subscribed'
+        )
+      end
+
+      it 'unsubscribes the user' do
+        expect(response.status).to eq(201)
+      end
+    end
+
+    context 'when subscription group does not exist' do
+      let(:subscription_group_id) { 'non-existing-subscription-group' }
+
+      it 'returns an error status' do
+        expect(response.status).to eq(400)
+      end
+    end
+  end
+end