braze_ruby 0.4.0 → 0.6.0

data/lib/braze_ruby/endpoints/remove_email_addresses_from_spam.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module Endpoints
+    module RemoveEmailAddressesFromSpam
+      attr_writer :remove_emails_from_spam_service
+
+      def remove_emails_from_spam(**payload)
+        remove_emails_from_spam_service.perform(**payload)
+      end
+
+      private
+
+      def remove_emails_from_spam_service
+        @remove_emails_from_spam_service ||= BrazeRuby::REST::RemoveEmailAddressesFromSpam.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(external_ids: payload[:external_ids])
+      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(external_id_renames: payload[:external_id_renames])
+      end
+
+      private
+
+      def rename_external_ids_service
+        @rename_external_ids ||= BrazeRuby::REST::RenameExternalIds.new(api_key, braze_url, options)
+      end
+    end
+  end
+end

data/lib/braze_ruby/endpoints/subscription.rb

@@ -11,7 +11,6 @@ module BrazeRuby
         BrazeRuby::REST::SubscriptionStatusGet.new(api_key, braze_url, options, **payload).perform
       end
 
-
       def subscription_user_status(**payload)
         BrazeRuby::REST::SubscriptionUserStatus.new(api_key, braze_url, options, **payload).perform
       end

data/lib/braze_ruby/http.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'faraday'
+require "json"
+require "faraday"
 
 module BrazeRuby
   class HTTP
     DEFAULT_TIMEOUT = 30
+    DEFAULT_OPEN_TIMEOUT = 5
 
     def initialize(api_key, braze_url, options = {})
-      @api_key   = api_key
+      @api_key = api_key
       @braze_url = braze_url
-      @options   = default_options.merge(options)
+      @options = default_options.merge(options)
     end
 
     def post(path, payload)
@@ -25,23 +26,25 @@ module BrazeRuby
 
     def connection
       @connection ||= Faraday.new(url: @braze_url) do |connection|
-        connection.headers["Content-Type"]  = "application/json"
-        connection.headers["Accept"]        = "application/json"
-        connection.headers["User-Agent"]    = "Braze Ruby gem v#{BrazeRuby::VERSION}"
+        connection.headers["Content-Type"] = "application/json"
+        connection.headers["Accept"] = "application/json"
+        connection.headers["User-Agent"] = "Braze Ruby gem v#{BrazeRuby::VERSION}"
         connection.headers["Authorization"] = "Bearer #{@api_key}"
 
-        connection.response :logger if ENV['BRAZE_RUBY_DEBUG']
+        connection.response :logger if ENV["BRAZE_RUBY_DEBUG"]
+        connection.request :retry, @options[:retry] if @options[:retry]
 
         connection.adapter Faraday.default_adapter
 
         connection.options[:timeout] = @options[:timeout]
+        connection.options[:open_timeout] = @options[:open_timeout]
       end
     end
 
     private
 
     def default_options
-      {timeout: DEFAULT_TIMEOUT}
+      {timeout: DEFAULT_TIMEOUT, open_timeout: DEFAULT_OPEN_TIMEOUT}
     end
   end
 end

data/lib/braze_ruby/rest.rb

@@ -1,19 +1,23 @@
 # frozen_string_literal: true
 
-require 'braze_ruby/rest/base'
-require 'braze_ruby/rest/track_users'
-require 'braze_ruby/rest/send_messages'
-require 'braze_ruby/rest/schedule_messages'
-require 'braze_ruby/rest/email_status'
-require 'braze_ruby/rest/email_hard_bounces'
-require 'braze_ruby/rest/email_unsubscribes'
-require 'braze_ruby/rest/export_users'
-require 'braze_ruby/rest/list_segments'
-require 'braze_ruby/rest/delete_users'
-require 'braze_ruby/rest/trigger_campaign_send'
-require 'braze_ruby/rest/trigger_canvas_send'
-require 'braze_ruby/rest/canvas_details'
-require 'braze_ruby/rest/subscription_status_set'
-require 'braze_ruby/rest/subscription_status_get'
-require 'braze_ruby/rest/subscription_user_status'
-require 'braze_ruby/rest/identify_users'
+require "braze_ruby/rest/base"
+require "braze_ruby/rest/track_users"
+require "braze_ruby/rest/send_messages"
+require "braze_ruby/rest/schedule_messages"
+require "braze_ruby/rest/email_status"
+require "braze_ruby/rest/email_hard_bounces"
+require "braze_ruby/rest/email_unsubscribes"
+require "braze_ruby/rest/export_users"
+require "braze_ruby/rest/list_segments"
+require "braze_ruby/rest/delete_users"
+require "braze_ruby/rest/trigger_campaign_send"
+require "braze_ruby/rest/trigger_canvas_send"
+require "braze_ruby/rest/canvas_details"
+require "braze_ruby/rest/subscription_status_set"
+require "braze_ruby/rest/subscription_status_get"
+require "braze_ruby/rest/subscription_user_status"
+require "braze_ruby/rest/identify_users"
+require "braze_ruby/rest/create_user_aliases"
+require "braze_ruby/rest/rename_external_ids"
+require "braze_ruby/rest/remove_external_ids"
+require "braze_ruby/rest/remove_email_addresses_from_spam"

data/lib/braze_ruby/rest/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'braze_ruby/http'
+require "braze_ruby/http"
 
 module BrazeRuby
   module REST
@@ -8,9 +8,9 @@ module BrazeRuby
       attr_writer :http
 
       def initialize(api_key, braze_url, options)
-        @api_key   = api_key
+        @api_key = api_key
         @braze_url = braze_url
-        @options   = options
+        @options = options
       end
 
       private

data/lib/braze_ruby/rest/canvas_details.rb

@@ -11,7 +11,7 @@ module BrazeRuby
       end
 
       def perform
-        http.get('/canvas/details', {
+        http.get("/canvas/details", {
           **@params
         })
       end

data/lib/braze_ruby/rest/create_user_aliases.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class CreateUserAliases < Base
+      def perform(user_aliases: [])
+        http.post "/users/alias/new", {
+          user_aliases: user_aliases
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/delete_users.rb

@@ -4,8 +4,8 @@ module BrazeRuby
   module REST
     class DeleteUsers < Base
       def perform(external_ids: [])
-        http.post '/users/delete', {
-          'external_ids':   external_ids
+        http.post "/users/delete", {
+          external_ids: external_ids
         }
       end
     end

data/lib/braze_ruby/rest/email_hard_bounces.rb

@@ -11,7 +11,7 @@ module BrazeRuby
       end
 
       def perform
-        http.get('/email/hard_bounces', {
+        http.get("/email/hard_bounces", {
           **@params
         })
       end

data/lib/braze_ruby/rest/email_status.rb

@@ -12,9 +12,9 @@ module BrazeRuby
       end
 
       def perform
-        http.post '/email/status', {
-          'email': email,
-          'subscription_state': status
+        http.post "/email/status", {
+          email: email,
+          subscription_state: status
         }
       end
     end

data/lib/braze_ruby/rest/email_unsubscribes.rb

@@ -11,7 +11,7 @@ module BrazeRuby
       end
 
       def perform
-        http.get('/email/unsubscribes', {
+        http.get("/email/unsubscribes", {
           **params
         })
       end

data/lib/braze_ruby/rest/export_users.rb

@@ -4,22 +4,22 @@ module BrazeRuby
   module REST
     class ExportUsers < Base
       def perform(external_ids: nil, segment_id: nil, **options)
-        return export_users_by_ids(external_ids) if external_ids
+        return export_users_by_ids(external_ids, options) if external_ids
 
         export_users_by_segment(segment_id, options) if segment_id
       end
 
       private
 
-      def export_users_by_ids(external_ids)
-        http.post '/users/export/ids', {
-          'external_ids': external_ids
-        }
+      def export_users_by_ids(external_ids, options)
+        http.post "/users/export/ids", {
+          external_ids: external_ids
+        }.merge(options)
       end
 
       def export_users_by_segment(segment_id, options)
-        http.post '/users/export/segment', {
-          'segment_id': segment_id
+        http.post "/users/export/segment", {
+          segment_id: segment_id
         }.merge(options)
       end
     end

data/lib/braze_ruby/rest/identify_users.rb

@@ -4,8 +4,8 @@ module BrazeRuby
   module REST
     class IdentifyUsers < Base
       def perform(aliases_to_identify: [])
-        http.post '/users/identify', {
-          'aliases_to_identify': aliases_to_identify
+        http.post "/users/identify", {
+          aliases_to_identify: aliases_to_identify
         }
       end
     end

data/lib/braze_ruby/rest/list_segments.rb

@@ -4,7 +4,7 @@ module BrazeRuby
   module REST
     class ListSegments < Base
       def perform
-        http.get '/segments/list'
+        http.get "/segments/list"
       end
     end
   end

data/lib/braze_ruby/rest/remove_email_addresses_from_spam.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class RemoveEmailAddressesFromSpam < Base
+      def perform(email: [])
+        http.post "/email/spam/remove", {
+          email: email
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/remove_external_ids.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class RemoveExternalIds < Base
+      def perform(external_ids: [])
+        http.post "/users/external_ids/remove", {
+          external_ids: external_ids
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/rename_external_ids.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class RenameExternalIds < Base
+      def perform(external_id_renames: [])
+        http.post "/users/external_ids/rename", {
+          external_id_renames: external_id_renames
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/schedule_messages.rb

@@ -14,13 +14,13 @@ module BrazeRuby
       end
 
       def perform
-        http.post '/messages/schedule/create', {
-          'external_user_ids':          external_user_ids,
-          'schedule': {
-            'time':                       time,
-            'in_local_time':              in_local_time
+        http.post "/messages/schedule/create", {
+          external_user_ids: external_user_ids,
+          schedule: {
+            time: time,
+            in_local_time: in_local_time
           },
-          'messages':                   messages
+          messages: messages
         }
       end
     end

data/lib/braze_ruby/rest/send_messages.rb

@@ -12,9 +12,9 @@ module BrazeRuby
       end
 
       def perform
-        http.post '/messages/send', {
-          'messages':          messages,
-          'external_user_ids': external_user_ids
+        http.post "/messages/send", {
+          messages: messages,
+          external_user_ids: external_user_ids
         }
       end
     end

data/lib/braze_ruby/rest/subscription_status_get.rb

@@ -11,7 +11,7 @@ module BrazeRuby
       end
 
       def perform
-        http.get('/subscription/status/get', {
+        http.get("/subscription/status/get", {
           **params
         })
       end

data/lib/braze_ruby/rest/subscription_status_set.rb

@@ -11,7 +11,7 @@ module BrazeRuby
       end
 
       def perform
-        http.post('/subscription/status/set', {
+        http.post("/subscription/status/set", {
           **params
         })
       end

data/lib/braze_ruby/rest/subscription_user_status.rb

@@ -11,7 +11,7 @@ module BrazeRuby
       end
 
       def perform
-        http.get('/subscription/user/status', {
+        http.get("/subscription/user/status", {
           **params
         })
       end

data/lib/braze_ruby/rest/track_users.rb

@@ -4,10 +4,10 @@ module BrazeRuby
   module REST
     class TrackUsers < Base
       def perform(attributes: [], events: [], purchases: [])
-        http.post '/users/track', {
-          'attributes':     attributes,
-          'events':         events,
-          'purchases':      purchases
+        http.post "/users/track", {
+          attributes: attributes,
+          events: events,
+          purchases: purchases
         }
       end
     end

data/lib/braze_ruby/rest/trigger_campaign_send.rb

@@ -11,7 +11,7 @@ module BrazeRuby
       end
 
       def perform
-        http.post('/campaigns/trigger/send', @params)
+        http.post("/campaigns/trigger/send", @params)
       end
     end
   end