braze_ruby 0.3.2 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (117) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +57 -0
  3. data/.circleci/gem_credentials +2 -0
  4. data/.circleci/setup-rubygems +6 -0
  5. data/.gitignore +12 -19
  6. data/.standard.yml +1 -0
  7. data/Gemfile +1 -2
  8. data/LICENSE.txt +17 -18
  9. data/README.md +49 -2
  10. data/Rakefile +2 -1
  11. data/bin/release +16 -0
  12. data/braze_ruby.gemspec +28 -31
  13. data/lib/braze_ruby.rb +4 -4
  14. data/lib/braze_ruby/api.rb +20 -14
  15. data/lib/braze_ruby/deprecated.rb +4 -4
  16. data/lib/braze_ruby/endpoints.rb +10 -7
  17. data/lib/braze_ruby/endpoints/campaigns.rb +1 -1
  18. data/lib/braze_ruby/endpoints/canvas.rb +2 -2
  19. data/lib/braze_ruby/endpoints/create_user_aliases.rb +19 -0
  20. data/lib/braze_ruby/endpoints/delete_users.rb +2 -2
  21. data/lib/braze_ruby/endpoints/email_status.rb +1 -1
  22. data/lib/braze_ruby/endpoints/email_sync.rb +2 -2
  23. data/lib/braze_ruby/endpoints/identify_users.rb +2 -2
  24. data/lib/braze_ruby/endpoints/remove_external_ids.rb +19 -0
  25. data/lib/braze_ruby/endpoints/rename_external_ids.rb +19 -0
  26. data/lib/braze_ruby/endpoints/schedule_messages.rb +1 -1
  27. data/lib/braze_ruby/endpoints/send_messages.rb +1 -1
  28. data/lib/braze_ruby/endpoints/subscription.rb +3 -4
  29. data/lib/braze_ruby/endpoints/track_users.rb +5 -5
  30. data/lib/braze_ruby/http.rb +21 -8
  31. data/lib/braze_ruby/rest.rb +20 -17
  32. data/lib/braze_ruby/rest/base.rb +5 -3
  33. data/lib/braze_ruby/rest/canvas_details.rb +4 -6
  34. data/lib/braze_ruby/rest/create_user_aliases.rb +13 -0
  35. data/lib/braze_ruby/rest/delete_users.rb +3 -4
  36. data/lib/braze_ruby/rest/email_hard_bounces.rb +4 -6
  37. data/lib/braze_ruby/rest/email_status.rb +6 -8
  38. data/lib/braze_ruby/rest/email_unsubscribes.rb +4 -6
  39. data/lib/braze_ruby/rest/export_users.rb +9 -11
  40. data/lib/braze_ruby/rest/identify_users.rb +3 -4
  41. data/lib/braze_ruby/rest/list_segments.rb +2 -4
  42. data/lib/braze_ruby/rest/remove_external_ids.rb +13 -0
  43. data/lib/braze_ruby/rest/rename_external_ids.rb +13 -0
  44. data/lib/braze_ruby/rest/schedule_messages.rb +9 -11
  45. data/lib/braze_ruby/rest/send_messages.rb +6 -8
  46. data/lib/braze_ruby/rest/subscription_status_get.rb +4 -6
  47. data/lib/braze_ruby/rest/subscription_status_set.rb +4 -6
  48. data/lib/braze_ruby/rest/subscription_user_status.rb +4 -6
  49. data/lib/braze_ruby/rest/track_users.rb +5 -6
  50. data/lib/braze_ruby/rest/trigger_campaign_send.rb +4 -8
  51. data/lib/braze_ruby/rest/trigger_canvas_send.rb +4 -6
  52. data/lib/braze_ruby/version.rb +1 -1
  53. metadata +61 -175
  54. data/.github/workflows/ci.yml +0 -19
  55. data/Gemfile.lock +0 -78
  56. data/spec/braze_ruby/api_spec.rb +0 -6
  57. data/spec/braze_ruby/endpoints/delete_users_spec.rb +0 -31
  58. data/spec/braze_ruby/endpoints/track_users_spec.rb +0 -74
  59. data/spec/braze_ruby/rest/delete_users_spec.rb +0 -22
  60. data/spec/braze_ruby/rest/email_status_spec.rb +0 -21
  61. data/spec/braze_ruby/rest/export_users_spec.rb +0 -21
  62. data/spec/braze_ruby/rest/identify_users_spec.rb +0 -23
  63. data/spec/braze_ruby/rest/schedule_messages_spec.rb +0 -38
  64. data/spec/braze_ruby/rest/send_messages_spec.rb +0 -35
  65. data/spec/braze_ruby/rest/track_users_spec.rb +0 -26
  66. data/spec/factories.rb +0 -38
  67. data/spec/fixtures/responses/campaigns/trigger_send/sends_an_email.yml +0 -69
  68. data/spec/fixtures/responses/canvas/details/returns_error_when_no_canvas.yml +0 -67
  69. data/spec/fixtures/responses/canvas/trigger_send/sends_a_canvas.yml +0 -69
  70. data/spec/fixtures/responses/delete_users/unauthorized/responds_with_unauthorized.yml +0 -66
  71. data/spec/fixtures/responses/delete_users/with_success/responds_with_created.yml +0 -69
  72. data/spec/fixtures/responses/delete_users/with_success/responds_with_success_message.yml +0 -69
  73. data/spec/fixtures/responses/email_status/existing_email/responds_with_created.yml +0 -69
  74. data/spec/fixtures/responses/email_status/existing_email/responds_with_success_message.yml +0 -69
  75. data/spec/fixtures/responses/email_status/unknown_email/responds_with_bad_request.yml +0 -69
  76. data/spec/fixtures/responses/email_status/unknown_email/responds_with_success_message.yml +0 -69
  77. data/spec/fixtures/responses/email_sync/hard_bounces/responds_with_empty_array_when_no_hard_bounces.yml +0 -73
  78. data/spec/fixtures/responses/email_sync/unsubscribes/responds_with_empty_array_when_no_unsubscribes.yml +0 -73
  79. data/spec/fixtures/responses/email_sync/unsubscribes/responds_with_unsubscribed_emails.yml +0 -74
  80. data/spec/fixtures/responses/export_users/by_ids/with_success/responds_with_created.yml +0 -69
  81. data/spec/fixtures/responses/export_users/by_segment/with_success/responds_with_created.yml +0 -69
  82. data/spec/fixtures/responses/identify_users/unauthorized/responds_with_unauthorized.yml +0 -66
  83. data/spec/fixtures/responses/identify_users/with_success/responds_with_created.yml +0 -69
  84. data/spec/fixtures/responses/identify_users/with_success/responds_with_success_message.yml +0 -69
  85. data/spec/fixtures/responses/list_segments/with_success/responds_with_a_list_of_segments.yml +0 -81
  86. data/spec/fixtures/responses/list_segments/with_success/responds_with_success.yml +0 -81
  87. data/spec/fixtures/responses/schedule_messages/unauthorized/responds_with_unauthorize.yml +0 -67
  88. data/spec/fixtures/responses/schedule_messages/with_success/responds_with_created.yml +0 -70
  89. data/spec/fixtures/responses/schedule_messages/with_success/responds_with_success_message.yml +0 -70
  90. data/spec/fixtures/responses/send_messages/unauthorized/responds_with_unauthorized.yml +0 -66
  91. data/spec/fixtures/responses/send_messages/with_success/responds_with_created.yml +0 -69
  92. data/spec/fixtures/responses/send_messages/with_success/responds_with_success_message.yml +0 -69
  93. data/spec/fixtures/responses/subscription/subscription_status_set/when_subscribing/subscribes_the_user.yml +0 -69
  94. data/spec/fixtures/responses/subscription/subscription_status_set/when_subscription_group_does_not_exist/returns_an_error_status.yml +0 -66
  95. data/spec/fixtures/responses/subscription/subscription_status_set/when_unsubscribing/unsubscribes_the_user.yml +0 -135
  96. data/spec/fixtures/responses/subscription/when_getting_subscription_group_statuses/subscription_status_get/when_checking_subscribed_and_unsubscribed_user_status/returns_only_users_that_were_once_subscribed.yml +0 -205
  97. data/spec/fixtures/responses/subscription/when_getting_subscription_group_statuses/subscription_status_get/when_group_does_not_exist/returns_an_error.yml +0 -193
  98. data/spec/fixtures/responses/subscription/when_getting_subscription_group_statuses/subscription_user_status/returns_subscription_groups_and_status_for_every_group.yml +0 -207
  99. data/spec/fixtures/responses/track_users/unauthorized/responds_with_unauthorized.yml +0 -68
  100. data/spec/fixtures/responses/track_users/with_success/responds_with_created.yml +0 -71
  101. data/spec/fixtures/responses/track_users/with_success/responds_with_success_message.yml +0 -71
  102. data/spec/integrations/campaigns_spec.rb +0 -17
  103. data/spec/integrations/canvas_spec.rb +0 -26
  104. data/spec/integrations/delete_users_spec.rb +0 -31
  105. data/spec/integrations/email_status_spec.rb +0 -38
  106. data/spec/integrations/email_sync_spec.rb +0 -31
  107. data/spec/integrations/export_users_spec.rb +0 -29
  108. data/spec/integrations/identify_users_spec.rb +0 -32
  109. data/spec/integrations/list_segments_spec.rb +0 -21
  110. data/spec/integrations/schedule_messages_spec.rb +0 -33
  111. data/spec/integrations/send_messages_spec.rb +0 -32
  112. data/spec/integrations/subscription_spec.rb +0 -149
  113. data/spec/integrations/track_users_spec.rb +0 -37
  114. data/spec/spec_helper.rb +0 -33
  115. data/spec/support/factory_bot.rb +0 -12
  116. data/spec/support/integrations.rb +0 -23
  117. data/spec/support/vcr.rb +0 -18
@@ -1,19 +0,0 @@
1
- name: CI
2
-
3
- on: [push, pull_request]
4
-
5
- jobs:
6
- build:
7
- runs-on: ubuntu-latest
8
-
9
- steps:
10
- - uses: actions/checkout@v1
11
- - name: Set up Ruby
12
- uses: actions/setup-ruby@v1
13
- with:
14
- ruby-version: 2.6.x
15
- - name: Build and test
16
- run: |
17
- gem install bundler
18
- bundle install --jobs 4 --retry 3
19
- bundle exec rake spec
data/Gemfile.lock DELETED
@@ -1,78 +0,0 @@
1
- PATH
2
- remote: .
3
- specs:
4
- braze_ruby (0.3.2)
5
- faraday
6
-
7
- GEM
8
- remote: https://rubygems.org/
9
- specs:
10
- activesupport (6.0.0)
11
- concurrent-ruby (~> 1.0, >= 1.0.2)
12
- i18n (>= 0.7, < 2)
13
- minitest (~> 5.1)
14
- tzinfo (~> 1.1)
15
- zeitwerk (~> 2.1, >= 2.1.8)
16
- addressable (2.7.0)
17
- public_suffix (>= 2.0.2, < 5.0)
18
- coderay (1.1.2)
19
- concurrent-ruby (1.1.5)
20
- crack (0.4.3)
21
- safe_yaml (~> 1.0.0)
22
- diff-lcs (1.3)
23
- dotenv (2.7.5)
24
- factory_bot (5.1.0)
25
- activesupport (>= 4.2.0)
26
- faraday (0.17.1)
27
- multipart-post (>= 1.2, < 3)
28
- hashdiff (1.0.0)
29
- i18n (1.6.0)
30
- concurrent-ruby (~> 1.0)
31
- method_source (0.9.2)
32
- minitest (5.12.0)
33
- multipart-post (2.1.1)
34
- pry (0.12.2)
35
- coderay (~> 1.1.0)
36
- method_source (~> 0.9.0)
37
- public_suffix (4.0.1)
38
- rake (12.3.3)
39
- rspec (3.8.0)
40
- rspec-core (~> 3.8.0)
41
- rspec-expectations (~> 3.8.0)
42
- rspec-mocks (~> 3.8.0)
43
- rspec-core (3.8.2)
44
- rspec-support (~> 3.8.0)
45
- rspec-expectations (3.8.4)
46
- diff-lcs (>= 1.2.0, < 2.0)
47
- rspec-support (~> 3.8.0)
48
- rspec-mocks (3.8.1)
49
- diff-lcs (>= 1.2.0, < 2.0)
50
- rspec-support (~> 3.8.0)
51
- rspec-support (3.8.2)
52
- safe_yaml (1.0.5)
53
- thread_safe (0.3.6)
54
- tzinfo (1.2.5)
55
- thread_safe (~> 0.1)
56
- vcr (5.0.0)
57
- webmock (3.7.5)
58
- addressable (>= 2.3.6)
59
- crack (>= 0.3.2)
60
- hashdiff (>= 0.4.0, < 2.0.0)
61
- zeitwerk (2.1.10)
62
-
63
- PLATFORMS
64
- ruby
65
-
66
- DEPENDENCIES
67
- braze_ruby!
68
- bundler (>= 1.3)
69
- dotenv (~> 2.7.5)
70
- factory_bot (~> 5.1.0)
71
- pry (~> 0.12.2)
72
- rake (~> 12.3.3)
73
- rspec (~> 3.8.0)
74
- vcr (~> 5.0.0)
75
- webmock (~> 3.7.5)
76
-
77
- BUNDLED WITH
78
- 2.1.1
@@ -1,6 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- describe BrazeRuby::API do
6
- end
@@ -1,31 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- class API
6
- include BrazeRuby::Endpoints::DeleteUsers
7
-
8
- def api_key
9
- :api_key
10
- end
11
- end
12
-
13
- describe BrazeRuby::Endpoints::DeleteUsers do
14
- let(:api) { API.new }
15
- let(:delete_users_service) { double(:delete_users_service) }
16
-
17
- before { api.delete_users_service = delete_users_service }
18
-
19
- describe '#delete_users' do
20
- let(:payload) { [1, 2, 3] }
21
-
22
- subject(:delete_users!) { api.delete_users(payload) }
23
-
24
- it 'deletes users' do
25
- expect(delete_users_service).to receive(:perform)
26
- .with(:api_key, external_ids: payload)
27
-
28
- delete_users!
29
- end
30
- end
31
- end
@@ -1,74 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- class API
6
- include BrazeRuby::Endpoints::TrackUsers
7
-
8
- def api_key
9
- :api_key
10
- end
11
- end
12
-
13
- describe BrazeRuby::Endpoints::TrackUsers do
14
- let(:api) { API.new }
15
- let(:track_users_service) { double(:track_users_service) }
16
-
17
- before { api.track_users_service = track_users_service }
18
-
19
- describe '#track_users' do
20
- let(:payload) {{
21
- attributes: [build(:attribute)],
22
- events: [build(:event)],
23
- purchases: [build(:purchase)]
24
- }}
25
-
26
- subject(:track_users!) { api.track_users(payload) }
27
-
28
- it 'tracks attributes, events and purchases' do
29
- expect(track_users_service).to receive(:perform)
30
- .with(:api_key, payload)
31
-
32
- track_users!
33
- end
34
- end
35
-
36
- describe '#track_purchase' do
37
- let(:payload) { build(:purchase) }
38
-
39
- subject(:track_purchase!) { api.track_purchase(payload) }
40
-
41
- it 'tracks a single purchase' do
42
- expect(track_users_service).to receive(:perform)
43
- .with(:api_key, purchases: [payload])
44
-
45
- track_purchase!
46
- end
47
- end
48
-
49
- describe '#track_event' do
50
- let(:payload) { build(:event) }
51
-
52
- subject(:track_event!) { api.track_event(payload) }
53
-
54
- it 'tracks a single purchase' do
55
- expect(track_users_service).to receive(:perform)
56
- .with(:api_key, events: [payload])
57
-
58
- track_event!
59
- end
60
- end
61
-
62
- describe '#track_attribute' do
63
- let(:payload) { build(:attribute) }
64
-
65
- subject(:track_attribute!) { api.track_attribute(payload) }
66
-
67
- it 'tracks a single purchase' do
68
- expect(track_users_service).to receive(:perform)
69
- .with(:api_key, attributes: [payload])
70
-
71
- track_attribute!
72
- end
73
- end
74
- end
@@ -1,22 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- describe BrazeRuby::REST::DeleteUsers do
6
- let(:http) { double(:http) }
7
-
8
- let(:payload) { {external_ids: [1, 2, 3]} }
9
-
10
- let(:api_key) { :api_key }
11
-
12
- subject { described_class.new :rest_url}
13
-
14
- before { subject.http = http }
15
-
16
- it 'makes an http call to the delete user endpoint' do
17
- expect(http).to receive(:post).with '/users/delete',
18
- payload.merge({ api_key: :api_key })
19
-
20
- subject.perform(api_key, payload)
21
- end
22
- end
@@ -1,21 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- describe BrazeRuby::REST::EmailStatus do
6
- let(:http) { double(:http) }
7
-
8
- before { subject.http = http }
9
-
10
- subject { described_class.new(:api_key, :rest_url, email: :email, status: :status) }
11
-
12
- it 'makes an http call to the email status endpoint' do
13
- expect(http).to receive(:post).with '/email/status', {
14
- api_key: :api_key,
15
- email: :email,
16
- subscription_state: :status
17
- }
18
-
19
- subject.perform
20
- end
21
- end
@@ -1,21 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- describe BrazeRuby::REST::ExportUsers do
6
- let(:http) { double(:http) }
7
-
8
- let(:payload) {{ external_ids: external_ids }}
9
- let(:external_ids) { [1] }
10
-
11
- subject { described_class.new :rest_url }
12
-
13
- before { subject.http = http }
14
-
15
- it 'makes an http call to the track user endpoint' do
16
- expect(http).to receive(:post).with '/users/export/ids',
17
- payload.merge({ api_key: :api_key })
18
-
19
- subject.perform(:api_key, payload)
20
- end
21
- end
@@ -1,23 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- describe BrazeRuby::REST::IdentifyUsers do
6
- let(:http) { double(:http) }
7
-
8
- let(:payload) { {aliases_to_identify: [user]} }
9
- let(:user) { { external_id: 123, user_alias: { alias_name: 'abc', alias_label: 'foo' } } }
10
-
11
- let(:api_key) { :api_key }
12
-
13
- subject { described_class.new :rest_url}
14
-
15
- before { subject.http = http }
16
-
17
- it 'makes an http call to the identify users endpoint' do
18
- expect(http).to receive(:post).with '/users/identify',
19
- payload.merge({ api_key: :api_key })
20
-
21
- subject.perform(api_key, payload)
22
- end
23
- end
@@ -1,38 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- describe BrazeRuby::REST::ScheduleMessages do
6
- let(:http) { double(:http) }
7
-
8
- let(:payload) {{
9
- external_user_ids: :external_user_ids,
10
- time: :time,
11
- in_local_time: :in_local_time,
12
- messages: :messages
13
- }}
14
-
15
- let(:api_key) { :api_key }
16
-
17
- subject { described_class.new(api_key, :rest_url, payload) }
18
-
19
- before { subject.http = http }
20
-
21
- it 'makes an http call to the schedule messages endpoint' do
22
- expect_schedule_messages_http_call
23
-
24
- subject.perform
25
- end
26
-
27
- def expect_schedule_messages_http_call
28
- expect(http).to receive(:post).with '/messages/schedule/create', {
29
- api_key: api_key,
30
- external_user_ids: :external_user_ids,
31
- schedule: {
32
- time: :time,
33
- in_local_time: :in_local_time
34
- },
35
- messages: :messages
36
- }
37
- end
38
- end
@@ -1,35 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- describe BrazeRuby::REST::SendMessages do
6
- let(:http) { double(:http) }
7
-
8
- let(:payload) {{
9
- messages: :messages,
10
- external_user_ids: :external_user_ids,
11
- }}
12
-
13
- let(:api_key) { :api_key }
14
-
15
- subject { described_class.new(api_key,
16
- messages: :messages,
17
- external_user_ids: :external_user_ids
18
- ) }
19
-
20
- before { subject.http = http }
21
-
22
- it 'makes an http call to the send messages endpoint' do
23
- expect_send_messages_http_call
24
-
25
- subject.perform
26
- end
27
-
28
- def expect_send_messages_http_call
29
- expect(http).to receive(:post).with '/messages/send', {
30
- api_key: :api_key,
31
- messages: [],
32
- external_user_ids: [],
33
- }
34
- end
35
- end
@@ -1,26 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require 'spec_helper'
4
-
5
- describe BrazeRuby::REST::TrackUsers do
6
- let(:http) { double(:http) }
7
-
8
- let(:payload) {{
9
- attributes: :attributes,
10
- events: :events,
11
- purchases: :purchases
12
- }}
13
-
14
- let(:api_key) { :api_key }
15
-
16
- subject { described_class.new :rest_url}
17
-
18
- before { subject.http = http }
19
-
20
- it 'makes an http call to the track user endpoint' do
21
- expect(http).to receive(:post).with '/users/track',
22
- payload.merge({ api_key: :api_key })
23
-
24
- subject.perform(api_key, payload)
25
- end
26
- end
data/spec/factories.rb DELETED
@@ -1,38 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- FactoryBot.define do
4
- factory :attribute, class: Hash do
5
- skip_create
6
- external_id { 1 }
7
- foo { :bar }
8
-
9
- initialize_with { attributes }
10
- end
11
-
12
- factory :event, class: Hash do
13
- skip_create
14
- external_id { 1 }
15
- name { :baz }
16
- time { Time.now }
17
-
18
- initialize_with { attributes }
19
- end
20
-
21
- factory :purchase, class: Hash do
22
- skip_create
23
- external_id { 1 }
24
- product_id { 1 }
25
- time { Time.now }
26
- currency { 'CAD' }
27
- price { 1.0 }
28
-
29
- initialize_with { attributes }
30
- end
31
-
32
- factory :messages, class: Hash do
33
- skip_create
34
- apple_push { {alert: :hello} }
35
-
36
- initialize_with { attributes }
37
- end
38
- end