braze_ruby 0.2.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adcffccc751c8231b0084d858454d36d5b3a034b128bd4c7c7d72e5867a27b4b
-  data.tar.gz: 2e0bf1111244eb7c356f7b8b9edcf9cf146c7f38cf3687f771b9d45953fb4925
+  metadata.gz: 9ef227d9be43770703ff994bcda610a34666b8057c5846f270391ee2a0dfd957
+  data.tar.gz: 866befd357481f0cef4a18b761bb69ce66bfa098af871ee768ef4a8b575c944d
 SHA512:
-  metadata.gz: ae3ccf92edd2f7f82c31812964eba85a57af09f1bf944338491f03bcc2d8e5831f7c21594a7e07a2aa5df8f0f1d732721d3aa7b9147c9380c0f3c4178f99c7e0
-  data.tar.gz: 9c1046684d733a8aab55c2a65a97ff950340df129c44472089424f4a43099609975c96770d39c8a3a896cd05868867ea8b203d7f2f27a5c90204634af6c23ba3
+  metadata.gz: 5bd262c112d84b59dcefe528def47fd7a299715500e032ce0bbb8d3e6cb45fb226aad2c4f2a2f94c202b18efeae0f608c9984e999bb06549b720fedddba0d533
+  data.tar.gz: 050c09bd0ea3d5b3d5bb7b34f869f9053e628e28e6f192e4b072eb7f3242ed1980f8484dce32708ab1b7cf21fc045318c962b75bc5ac5ae9a75b136b1e3a2b78

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/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 .ruby-version
+.ruby-gemset
 .env
 InstalledFiles
 _yardoc

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in braze_ruby.gemspec

data/Gemfile.lock

@@ -1,64 +1,64 @@
 PATH
   remote: .
   specs:
-    braze_ruby (0.2.2)
+    braze_ruby (0.4.0)
       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.15.4)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    hashdiff (1.0.0)
-    i18n (1.6.0)
+    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)
     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
@@ -66,13 +66,13 @@ PLATFORMS
 DEPENDENCIES
   braze_ruby!
   bundler (>= 1.3)
-  dotenv
-  factory_bot
-  pry
-  rake
-  rspec
-  vcr
-  webmock
+  dotenv (~> 2.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

@@ -163,6 +163,70 @@ Delete Braze Users with an array of external_ids
 api.delete_users([1, 2, 3])
 ```
 
+### Subscription groups
+
+#### Get subscription group status for users by id
+```ruby
+api.subscription_user_status(external_id: [1])
+```
+
+#### Get users status for a specific subscription group
+```ruby
+api.subscription_status_get(
+  external_id: [1],
+  subscription_group_id: 'some-uuid'
+)
+```
+
+#### Set user status for a specific subscription group
+```ruby
+api.subscription_status_set(
+  external_id: [1],
+  subscription_group_id: 'some-uuid',
+  subscription_state: 'subscribed|unsubscribed'
+)
+```
+
+### 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",
+    }
+  }]
+)
+```
+
+### 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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/braze_ruby.gemspec

@@ -28,11 +28,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
 
   spec.add_development_dependency 'bundler', '>= 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'dotenv'
-  spec.add_development_dependency 'vcr'
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'factory_bot'
+  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'
 end

data/lib/braze_ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'braze_ruby/version'
 
 module BrazeRuby

data/lib/braze_ruby/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'braze_ruby/deprecated'
 require 'braze_ruby/endpoints/track_users'
 require 'braze_ruby/endpoints/send_messages'
@@ -7,6 +9,7 @@ require 'braze_ruby/endpoints/email_sync'
 require 'braze_ruby/endpoints/delete_users'
 require 'braze_ruby/endpoints/campaigns'
 require 'braze_ruby/endpoints/canvas'
+require 'braze_ruby/endpoints/subscription'
 
 module BrazeRuby
   class API
@@ -20,20 +23,24 @@ module BrazeRuby
     include BrazeRuby::Endpoints::DeleteUsers
     include BrazeRuby::Endpoints::Campaigns
     include BrazeRuby::Endpoints::Canvas
+    include BrazeRuby::Endpoints::Subscription
+    include BrazeRuby::Endpoints::IdentifyUsers
+    include BrazeRuby::Endpoints::CreateUserAliases
 
     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/deprecated.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module Deprecated
     def track(attribute, events = [], purchases = [])

data/lib/braze_ruby/endpoints.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require 'braze_ruby/endpoints/email_status'
 require 'braze_ruby/endpoints/email_sync'
 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'

data/lib/braze_ruby/endpoints/campaigns.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 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

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 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, 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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module Endpoints
     module DeleteUsers
       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)
@@ -14,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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 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

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 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