braze_ruby 0.4.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aae95520a637f8bfb69c12c2df7700966eec68e243743fabc03798b194a924f
-  data.tar.gz: 95791c077beeb50119d715e81374533778032ee85d1fef28ed946352a1bd618b
+  metadata.gz: 92627ab40d55d8abadf9acd07b143a0eae13586d0caad935e657c8e4fb074d54
+  data.tar.gz: e21b4acbf9aef12c2f7ab37029aece94f421a3a9e2d45afd0c41216316b3a402
 SHA512:
-  metadata.gz: 61bd0b6c2bb7c59e396cc1c3aa40fe0b54095c95f0195c5287e96c6e8504955442052a36d8e137150e816a357e2ae2982c112d4a79df95047d4841adf9b8b448
-  data.tar.gz: 1ac6bb7da1dc22c6138c62a00072ec62d82d48ac2ee8b2922607c62dabcd7febe36b798c606466d85c88bc86f8d01067f347a3c4b11d0d92ba7c46a003b6ea91
+  metadata.gz: 841f8f3d844ee4881f2d98745eaca37cbf47f7e3352e13373a39bf95567cfd10950df47b60ace6810f805db7962e76bcdcf707dd2ae363f7a16a14850e558b57
+  data.tar.gz: 5163647859b894bb7946503995fdbad55bc8becd0eb25fb3378b11cfb5283d1ae0cf01f8003a683246693d9c4e52b085f1b7af99e3e4cab0d6053189e10739df

data/.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2.1
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: << parameters.ruby-version >>
+    steps:
+      - checkout
+      - run:
+          name: Gem install bundler
+          command: gem update --system && gem install bundler
+      - run:
+          name: Bundle install
+          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - run:
+          name: Run tests
+          command: bundle exec rake
+workflows:
+  all-tests:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby-version: ["ruby:3.0.1", "ruby:2.7.3", "ruby:2.6.7"]

data/.github/workflows/gem_credentials

@@ -0,0 +1,2 @@
+---
+:rubygems_api_key: REPLACE_ME

data/.github/workflows/release.yml

@@ -0,0 +1,20 @@
+name: release
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup rubygems
+        run: |
+          mkdir ~/.gem
+          cp ./.github/workflows/gem_credentials ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+          sed -i "s/REPLACE_ME/${{ secrets.RUBYGEMS_KEY }}/g" ~/.gem/credentials
+      - name: Build gem
+        run: gem build braze_ruby.gemspec --output braze_ruby.gem
+      - name: Publish gem
+        run: gem push braze_ruby.gem

data/.gitignore

@@ -1,19 +1,12 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.ruby-version
-.ruby-gemset
-.env
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.standard.yml

@@ -0,0 +1 @@
+format: progress

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2014 Josh Nussbaum
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2021 Jon Allured
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,6 +1,7 @@
-# BrazeRuby
+# BrazeRuby [![CircleCI][badge]][circle]
 
-A wrapper for the Braze REST API. Forked from https://github.com/DynamoMTL/appboy
+A wrapper for the Braze REST API. Forked from
+https://github.com/DynamoMTL/appboy
 
 ## Installation
 
@@ -16,12 +17,32 @@ Or install it yourself as:
 
     $ gem install braze_ruby
 
+### Configuration
+
+Configuration options may be passed when a new API object is instantiated:
+
+```ruby
+BrazeRuby::API.new('<braze-rest-api-key>', '<braze-rest-url', {<additional options>})
+```
+
+Alternatively, you can pass your [Braze REST API key][braze_api_key], [Braze
+REST URL][braze_url], and any required [Faraday options][faraday_options] to the
+`BrazeRuby::configure` method:
+
+```ruby
+BrazeRuby.configure do |config|
+  config.rest_api_key = '<braze-rest-api-key>'
+  config.rest_url = '<braze-rest-url>'
+  config.options = {<additional options>}
+end
+```
+
 ## Examples
 
 ### Initializing API
 
 ```ruby
-api = BrazeRuby::API.new('<braze-rest-api-key>', '<braze-rest-api-url')
+api = BrazeRuby::API.new('<braze-rest-api-key>', '<braze-rest-url')
 ```
 
 ### Track User Attributes
@@ -105,19 +126,37 @@ api.send_messages(messages: messages, external_user_ids: [123, 456])
 api.send_messages(messages: messages, segment_id: '<segment-id>')
 ```
 
-
 ### Schedule Message
 
 ```ruby
 api.schedule_messages(send_at: 1.hour.since, messages: messages, external_user_ids: [123, 456])
 ```
 
+### Schedule Campaigns
+
+```ruby
+api.trigger_campaign_schedule(
+  campaign_id: 'campaign-id',
+  recipients: [{ external_user_id: 123 }]
+  schedule: { time: Time.now.iso8601 }
+)
+```
+
+### Delete Scheduled Campaign
+
+```ruby
+api.delete_campaign_trigger_schedule(
+  campaign_id: 'campaign_id',
+  schedule_id: 'schedule_id'
+)
+```
+
 ### Send Campaigns
 
 ```ruby
 api.trigger_campaign_send(
   campaign_id: 'campaign-id',
-  recipients: [external_user_id: 123, trigger_properties: {first_name: 'John'}]
+  recipients: [{external_user_id: 123, trigger_properties: { first_name: 'John' }}]
 )
 ```
 
@@ -136,6 +175,12 @@ api.trigger_canvas_send(
 api.email_status(email: 'john@example.com', status: :opted_in)
 ```
 
+### List Scheduled Messages and Canvases
+
+```ruby
+api.scheduled_messages(end_time: Time.now.advance(weeks: 2).iso861)
+```
+
 ### List Segments
 
 ```ruby
@@ -246,9 +291,15 @@ api.email_unsubscribes(email: ['jdoe@example.com'])
 api.email_hard_bounces(email: ['jdoe@example.com'])
 ```
 
+#### Remove Email Addresses From Spam List
+```ruby
+api.remove_emails_from_spam(email: ['jdoe@example.com'])
+```
+
 ## Debugging
 
-The BRAZE_RUBY_DEBUG environment variable will trigger full printouts of the Faraday gem's HTTP requests and responses.
+The BRAZE_RUBY_DEBUG environment variable will trigger full printouts of the
+Faraday gem's HTTP requests and responses.
 
 ```bash
 cd /my/app
@@ -263,3 +314,9 @@ bundle exec rails whatever
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[badge]: https://circleci.com/gh/jonallured/braze_ruby.svg?style=svg
+[braze_api_key]: https://www.braze.com/docs/api/api_key/
+[braze_url]: https://www.braze.com/docs/api/basics/#endpoints
+[circle]: https://circleci.com/gh/jonallured/braze_ruby
+[faraday_options]: https://github.com/lostisland/faraday/blob/main/lib/faraday/options.rb

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+task default: %i[standard spec]

data/bin/release

@@ -0,0 +1,16 @@
+#! /bin/sh
+set -ex
+
+old_version=$1
+new_version=$2
+
+version_files="lib/braze_ruby/version.rb Gemfile.lock"
+commit_message="Bumping version numbers for $new_version"
+tag_message="Tagging version $new_version"
+
+sed -i "" "s/$old_version/$new_version/g" $version_files
+git add .
+git commit --message "$commit_message"
+git push origin main
+git tag --annotate v$new_version --message "$tag_message"
+git push origin --tags

data/braze_ruby.gemspec

@@ -1,38 +1,35 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'braze_ruby/version'
+require_relative "lib/braze_ruby/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'braze_ruby'
-  spec.version       = BrazeRuby::VERSION
-  spec.authors       = ['Josh Nussbaum', 'Hugo Bastien', 'Justin Boltz']
-  spec.email         = %w(josh@godynamo.com hugo@godynamo.com justin.boltz@takl.com)
-  spec.description   = %q{Braze wrapper}
-  spec.summary       = %q{A wrapper for the Braze REST API forked from the appboy gem, track users/events/purchases, send & schedule messages}
-  spec.homepage      = 'https://www.braze.com/'
-  spec.license       = 'MIT'
+  spec.name = "braze_ruby"
+  spec.version = BrazeRuby::VERSION
+  spec.authors = ["Josh Nussbaum", "Hugo Bastien", "Justin Boltz", "Jonathan Allured"]
+  spec.email = %w[josh@godynamo.com hugo@godynamo.com justin.boltz@takl.com jon.allured@gmail.com]
 
-  if spec.respond_to?(:metadata)
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/jboltz88/braze_ruby"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
+  spec.summary = "A wrapper gem for the Braze REST API."
+  spec.description = "Wrapper for Braze API"
+  spec.homepage = "https://github.com/jonallured/braze_ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.0'
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday'
+  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'
-  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 "dotenv"
+  spec.add_development_dependency "factory_bot"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 end

data/lib/braze_ruby/api.rb

@@ -1,17 +1,18 @@
 # frozen_string_literal: true
 
-require 'braze_ruby/deprecated'
-require 'braze_ruby/endpoints/track_users'
-require 'braze_ruby/endpoints/send_messages'
-require 'braze_ruby/endpoints/schedule_messages'
-require 'braze_ruby/endpoints/email_status'
-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'
-require 'braze_ruby/endpoints/rename_external_ids'
-require 'braze_ruby/endpoints/remove_external_ids'
+require "braze_ruby/deprecated"
+require "braze_ruby/endpoints/track_users"
+require "braze_ruby/endpoints/send_messages"
+require "braze_ruby/endpoints/schedule_messages"
+require "braze_ruby/endpoints/email_status"
+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"
+require "braze_ruby/endpoints/rename_external_ids"
+require "braze_ruby/endpoints/remove_external_ids"
+require "braze_ruby/endpoints/remove_email_addresses_from_spam"
 
 module BrazeRuby
   class API
@@ -30,6 +31,7 @@ module BrazeRuby
     include BrazeRuby::Endpoints::CreateUserAliases
     include BrazeRuby::Endpoints::RenameExternalIds
     include BrazeRuby::Endpoints::RemoveExternalIds
+    include BrazeRuby::Endpoints::RemoveEmailAddressesFromSpam
 
     def export_users(**payload)
       BrazeRuby::REST::ExportUsers.new(api_key, braze_url, options).perform(**payload)
@@ -42,9 +44,9 @@ module BrazeRuby
     attr_reader :api_key, :braze_url, :options
 
     def initialize(api_key, braze_url, options = {})
-      @api_key = api_key
-      @braze_url = braze_url
-      @options = options
+      @api_key = api_key || configuration.rest_api_key
+      @braze_url = braze_url || configuration.rest_url
+      @options = options || configuration.options
     end
   end
 end

data/lib/braze_ruby/configuration.rb

@@ -0,0 +1,13 @@
+module BrazeRuby
+  class Configuration
+    attr_accessor :rest_api_key,
+      :rest_url,
+      :options # See BrazeRuby::HTTP#default_options
+
+    def initialize
+      @rest_api_key = nil
+      @rest_url = nil
+      @options = nil
+    end
+  end
+end

data/lib/braze_ruby/deprecated.rb

@@ -3,19 +3,18 @@
 module BrazeRuby
   module Deprecated
     def track(attribute, events = [], purchases = [])
-      warn('[BrazeRuby] `track` is deprecated. Please use `track_users` instead.')
+      warn("[BrazeRuby] `track` is deprecated. Please use `track_users` instead.")
       track_users(attribute: attribute, events: events, purchases: purchases)
     end
 
     def send_message(message, user_ids, segment_ids = nil)
-      warn('[BrazeRuby] `send_message` is deprecated. Please use `send_messages` instead.')
+      warn("[BrazeRuby] `send_message` is deprecated. Please use `send_messages` instead.")
       send_messages(messages: message, user_ids: user_ids, segment_ids: segment_ids)
     end
 
     def schedule_message(date, message, segment_id, local_timezone = false)
-      warn('[BrazeRuby] `schedule_message` is deprecated. Please use `schedule_messages` instead.')
-      schedule_messages(send_at: date, messages: message,
-        segment_id: segment_id, local_timezone: local_timezone)
+      warn("[BrazeRuby] `schedule_message` is deprecated. Please use `schedule_messages` instead.")
+      schedule_messages(send_at: date, messages: message, segment_id: segment_id, local_timezone: local_timezone)
     end
   end
 end

data/lib/braze_ruby/endpoints/campaigns.rb

@@ -3,9 +3,17 @@
 module BrazeRuby
   module Endpoints
     module Campaigns
+      def delete_campaign_trigger_schedule(**payload)
+        BrazeRuby::REST::DeleteTriggerCampaignSchedule.new(api_key, braze_url, options).perform(**payload)
+      end
+
       def trigger_campaign_send(**payload)
         BrazeRuby::REST::TriggerCampaignSend.new(api_key, braze_url, options, **payload).perform
       end
+
+      def trigger_campaign_schedule(**payload)
+        BrazeRuby::REST::TriggerCampaignSchedule.new(api_key, braze_url, options, **payload).perform
+      end
     end
   end
 end

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

@@ -5,8 +5,8 @@ module BrazeRuby
     module RemoveExternalIds
       attr_writer :remove_external_ids_service
 
-      def remove_external_ids(**payload)
-        remove_external_ids_service.perform(**payload)
+      def remove_external_ids(payload)
+        remove_external_ids_service.perform(external_ids: payload[:external_ids])
       end
 
       private

data/lib/braze_ruby/endpoints/rename_external_ids.rb

@@ -5,8 +5,8 @@ module BrazeRuby
     module RenameExternalIds
       attr_writer :rename_external_ids_service
 
-      def rename_external_ids(**payload)
-        rename_external_ids_service.perform(**payload)
+      def rename_external_ids(payload)
+        rename_external_ids_service.perform(external_id_renames: payload[:external_id_renames])
       end
 
       private

data/lib/braze_ruby/endpoints/schedule_messages.rb

@@ -4,13 +4,11 @@ module BrazeRuby
   module Endpoints
     module ScheduleMessages
       def schedule_messages(**payload)
-        schedule_messages_service.new(api_key, braze_url, options, **payload).perform
+        BrazeRuby::REST::ScheduleMessages.new(api_key, braze_url, options, **payload).perform
       end
 
-      private
-
-      def schedule_messages_service
-        BrazeRuby::REST::ScheduleMessages
+      def scheduled_messages(**payload)
+        BrazeRuby::REST::ScheduledBroadcasts.new(api_key, braze_url, options, **payload).perform
       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/endpoints.rb

@@ -1,12 +1,13 @@
 # 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'
-require 'braze_ruby/endpoints/rename_external_ids'
-require 'braze_ruby/endpoints/remove_external_ids'
+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"
+require "braze_ruby/endpoints/rename_external_ids"
+require "braze_ruby/endpoints/remove_external_ids"
+require "braze_ruby/endpoints/remove_email_addresses_from_spam"

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