braze_ruby 0.3.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d13af3abbb4e98372a950bf22a32729721f50e061b5c4259a0ca8441ffc1b718
-  data.tar.gz: 0ba7370dd8c8bf783643722ff0531a62128deb2361c4b7ce2cd0124659073c26
+  metadata.gz: 8aae95520a637f8bfb69c12c2df7700966eec68e243743fabc03798b194a924f
+  data.tar.gz: 95791c077beeb50119d715e81374533778032ee85d1fef28ed946352a1bd618b
 SHA512:
-  metadata.gz: 12ce012904c603fa5c7d202f46bbbc3b5b0df057a07edb7f04ab18a820154eebba5628f23a3f43ace34b47a03a99415de1911429c6d9a3175b061522ca29025e
-  data.tar.gz: acb859868636273fa6a8b07370e31805cc17760e8f40b392f0141a3ce963b1e0c902209297d7dea2750d69bed6fa86ab55629ae7d50f2a8997a6b31ffe276207
+  metadata.gz: 61bd0b6c2bb7c59e396cc1c3aa40fe0b54095c95f0195c5287e96c6e8504955442052a36d8e137150e816a357e2ae2982c112d4a79df95047d4841adf9b8b448
+  data.tar.gz: 1ac6bb7da1dc22c6138c62a00072ec62d82d48ac2ee8b2922607c62dabcd7febe36b798c606466d85c88bc86f8d01067f347a3c4b11d0d92ba7c46a003b6ea91

data/.github/workflows/ci.yml

@@ -7,13 +7,24 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
+
     - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Cache gems
+      uses: actions/cache@v1
       with:
-        ruby-version: 2.6.x
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
     - name: Build and test
       run: |
         gem install bundler
+        bundle config path vendor/bundle
         bundle install --jobs 4 --retry 3
         bundle exec rake spec

data/Gemfile.lock

@@ -1,64 +1,68 @@
 PATH
   remote: .
   specs:
-    braze_ruby (0.3.1)
-      faraday (~> 0.17.1)
+    braze_ruby (0.4.2)
+      faraday
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     dotenv (2.7.5)
-    factory_bot (5.1.0)
+    factory_bot (5.2.0)
       activesupport (>= 4.2.0)
-    faraday (0.17.1)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    hashdiff (1.0.0)
-    i18n (1.6.0)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    hashdiff (1.0.1)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.2)
-    minitest (5.12.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
     multipart-post (2.1.1)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (4.0.1)
-    rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    ruby2_keywords (0.0.4)
     safe_yaml (1.0.5)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    vcr (5.0.0)
-    webmock (3.7.5)
+    vcr (6.0.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.1.10)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -67,12 +71,12 @@ DEPENDENCIES
   braze_ruby!
   bundler (>= 1.3)
   dotenv (~> 2.7.5)
-  factory_bot (~> 5.1.0)
-  pry (~> 0.12.2)
-  rake (~> 12.3.3)
-  rspec (~> 3.8.0)
-  vcr (~> 5.0.0)
-  webmock (~> 3.7.5)
+  factory_bot (>= 5.1.0)
+  pry (>= 0.12.2)
+  rake (>= 12.3.3)
+  rspec (~> 3.8)
+  vcr (>= 5.0.0)
+  webmock (>= 3.7.5)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -187,6 +187,65 @@ api.subscription_status_set(
 )
 ```
 
+### User Alias
+
+#### Create an alias-only user
+
+```ruby
+api.create_user_aliases(
+  user_aliases: [{
+    user_alias: {
+      alias_name: "device123",
+      alias_label: "my_device_identifier",
+    }
+  }]
+)
+```
+
+#### Identify an alias-only user
+```ruby
+api.identify_users(
+  aliases_to_identify: [{
+    external_id: 1234,
+    user_alias: {
+      alias_name: "device123",
+      alias_label: "my_device_identifier",
+    }
+  }]
+)
+```
+
+### External ID Migration
+
+#### Rename users' external IDs with an array of external_id_renames
+Note: you can send up to 50 rename objects per request.
+```ruby
+api.rename_external_ids(
+  external_id_renames: [{
+    current_external_id: "old_external_id",
+    new_external_id: "new_external_id",
+  }]
+)
+```
+
+#### Remove users' old deprecated external IDs
+Note: you can send up to 50 external IDs per request.
+```ruby
+api.remove_external_ids(external_ids: ['old_external_id'])
+```
+
+### Email Sync
+
+#### Get List of or Query Email Unsubscribes
+```ruby
+api.email_unsubscribes(email: ['jdoe@example.com'])
+```
+
+#### Get List of or Query Hard Bounced Emails
+```ruby
+api.email_hard_bounces(email: ['jdoe@example.com'])
+```
+
 ## Debugging
 
 The BRAZE_RUBY_DEBUG environment variable will trigger full printouts of the Faraday gem's HTTP requests and responses.

data/braze_ruby.gemspec

@@ -25,14 +25,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0'
 
-  spec.add_dependency 'faraday', '~> 0.17.1'
+  spec.add_dependency 'faraday'
 
   spec.add_development_dependency 'bundler', '>= 1.3'
-  spec.add_development_dependency 'rake', '~> 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.8.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'dotenv', '~> 2.7.5'
-  spec.add_development_dependency 'vcr', '~> 5.0.0'
-  spec.add_development_dependency 'webmock', '~> 3.7.5'
-  spec.add_development_dependency 'pry', '~> 0.12.2'
-  spec.add_development_dependency 'factory_bot', '~> 5.1.0'
+  spec.add_development_dependency 'vcr', '>= 5.0.0'
+  spec.add_development_dependency 'webmock', '>= 3.7.5'
+  spec.add_development_dependency 'pry', '>= 0.12.2'
+  spec.add_development_dependency 'factory_bot', '>= 5.1.0'
 end

data/lib/braze_ruby/api.rb

@@ -10,6 +10,8 @@ require 'braze_ruby/endpoints/delete_users'
 require 'braze_ruby/endpoints/campaigns'
 require 'braze_ruby/endpoints/canvas'
 require 'braze_ruby/endpoints/subscription'
+require 'braze_ruby/endpoints/rename_external_ids'
+require 'braze_ruby/endpoints/remove_external_ids'
 
 module BrazeRuby
   class API
@@ -24,20 +26,25 @@ module BrazeRuby
     include BrazeRuby::Endpoints::Campaigns
     include BrazeRuby::Endpoints::Canvas
     include BrazeRuby::Endpoints::Subscription
+    include BrazeRuby::Endpoints::IdentifyUsers
+    include BrazeRuby::Endpoints::CreateUserAliases
+    include BrazeRuby::Endpoints::RenameExternalIds
+    include BrazeRuby::Endpoints::RemoveExternalIds
 
     def export_users(**payload)
-      BrazeRuby::REST::ExportUsers.new(braze_url).perform(api_key, payload)
+      BrazeRuby::REST::ExportUsers.new(api_key, braze_url, options).perform(**payload)
     end
 
     def list_segments
-      BrazeRuby::REST::ListSegments.new(braze_url).perform(api_key)
+      BrazeRuby::REST::ListSegments.new(api_key, braze_url, options).perform
     end
 
-    attr_reader :api_key, :braze_url
+    attr_reader :api_key, :braze_url, :options
 
-    def initialize(api_key, braze_url)
+    def initialize(api_key, braze_url, options = {})
       @api_key = api_key
       @braze_url = braze_url
+      @options = options
     end
   end
 end

data/lib/braze_ruby/endpoints.rb

@@ -6,3 +6,7 @@ require 'braze_ruby/endpoints/schedule_messages'
 require 'braze_ruby/endpoints/send_messages'
 require 'braze_ruby/endpoints/track_users'
 require 'braze_ruby/endpoints/delete_users'
+require 'braze_ruby/endpoints/identify_users'
+require 'braze_ruby/endpoints/create_user_aliases'
+require 'braze_ruby/endpoints/rename_external_ids'
+require 'braze_ruby/endpoints/remove_external_ids'

data/lib/braze_ruby/endpoints/campaigns.rb

@@ -4,7 +4,7 @@ module BrazeRuby
   module Endpoints
     module Campaigns
       def trigger_campaign_send(**payload)
-        BrazeRuby::REST::TriggerCampaignSend.new(api_key, braze_url, payload).perform
+        BrazeRuby::REST::TriggerCampaignSend.new(api_key, braze_url, options, **payload).perform
       end
     end
   end

data/lib/braze_ruby/endpoints/canvas.rb

@@ -4,11 +4,11 @@ module BrazeRuby
   module Endpoints
     module Canvas
       def trigger_canvas_send(**payload)
-        BrazeRuby::REST::TriggerCanvasSend.new(api_key, braze_url, payload).perform
+        BrazeRuby::REST::TriggerCanvasSend.new(api_key, braze_url, options, **payload).perform
       end
 
       def canvas_details(**payload)
-        BrazeRuby::REST::CanvasDetails.new(api_key, braze_url, payload).perform
+        BrazeRuby::REST::CanvasDetails.new(api_key, braze_url, options, **payload).perform
       end
     end
   end

data/lib/braze_ruby/endpoints/create_user_aliases.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module Endpoints
+    module CreateUserAliases
+      attr_writer :create_user_aliases_service
+
+      def create_user_aliases(**payload)
+        create_user_aliases_service.perform(**payload)
+      end
+
+      private
+
+      def create_user_aliases_service
+        @create_user_aliases_service ||= BrazeRuby::REST::CreateUserAliases.new(api_key, braze_url, options)
+      end
+    end
+  end
+end

data/lib/braze_ruby/endpoints/delete_users.rb

@@ -6,7 +6,7 @@ module BrazeRuby
       attr_writer :delete_users_service
 
       def delete_users_action(**payload)
-        delete_users_service.perform(api_key, payload)
+        delete_users_service.perform(**payload)
       end
 
       def delete_users(payload)
@@ -16,7 +16,7 @@ module BrazeRuby
       private
 
       def delete_users_service
-        @delete_users_service ||= BrazeRuby::REST::DeleteUsers.new(braze_url)
+        @delete_users_service ||= BrazeRuby::REST::DeleteUsers.new(api_key, braze_url, options)
       end
     end
   end

data/lib/braze_ruby/endpoints/email_status.rb

@@ -4,7 +4,7 @@ module BrazeRuby
   module Endpoints
     module EmailStatus
       def email_status(**payload)
-        email_status_service.new(api_key, braze_url, payload).perform
+        email_status_service.new(api_key, braze_url, options, **payload).perform
       end
 
       def email_status_service

data/lib/braze_ruby/endpoints/email_sync.rb

@@ -4,11 +4,11 @@ module BrazeRuby
   module Endpoints
     module EmailSync
       def email_unsubscribes(**payload)
-        BrazeRuby::REST::EmailUnsubscribes.new(api_key, braze_url, payload).perform
+        BrazeRuby::REST::EmailUnsubscribes.new(api_key, braze_url, options, **payload).perform
       end
 
       def email_hard_bounces(**payload)
-        BrazeRuby::REST::EmailHardBounces.new(api_key, braze_url, payload).perform
+        BrazeRuby::REST::EmailHardBounces.new(api_key, braze_url, options, **payload).perform
       end
     end
   end

data/lib/braze_ruby/endpoints/identify_users.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module Endpoints
+    module IdentifyUsers
+      attr_writer :identify_users_service
+
+      def identify_users(**payload)
+        identify_users_service.perform(**payload)
+      end
+
+      private
+
+      def identify_users_service
+        @identify_users_service ||= BrazeRuby::REST::IdentifyUsers.new(api_key, braze_url, options)
+      end
+    end
+  end
+end

data/lib/braze_ruby/endpoints/remove_external_ids.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module Endpoints
+    module RemoveExternalIds
+      attr_writer :remove_external_ids_service
+
+      def remove_external_ids(**payload)
+        remove_external_ids_service.perform(**payload)
+      end
+
+      private
+
+      def remove_external_ids_service
+        @remove_external_ids ||= BrazeRuby::REST::RemoveExternalIds.new(api_key, braze_url, options)
+      end
+    end
+  end
+end

data/lib/braze_ruby/endpoints/rename_external_ids.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module Endpoints
+    module RenameExternalIds
+      attr_writer :rename_external_ids_service
+
+      def rename_external_ids(**payload)
+        rename_external_ids_service.perform(**payload)
+      end
+
+      private
+
+      def rename_external_ids_service
+        @rename_external_ids ||= BrazeRuby::REST::RenameExternalIds.new(api_key, braze_url, options)
+      end
+    end
+  end
+end