braze_ruby 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39bc36a3cad69bd3b9bd36df61c45e8052c594ea7533ea7c888cb6978f739adf
-  data.tar.gz: 4f01c13fa4bc9cb0ca255d370096bd90b9bf811cee980e60dc62186731b86d5d
+  metadata.gz: 92627ab40d55d8abadf9acd07b143a0eae13586d0caad935e657c8e4fb074d54
+  data.tar.gz: e21b4acbf9aef12c2f7ab37029aece94f421a3a9e2d45afd0c41216316b3a402
 SHA512:
-  metadata.gz: c89ff06b6416a93a68a02c360d50cecde4b9132df53e692f7ffd26b259f8d783b3d83d3d78325c5d6b898ae292e3688aa43c83f83ecd2a93d611b4d83424d710
-  data.tar.gz: 51b93002f6521205daf03e196a32f70971b2ad89f8b160c38cbd179e4d813296335979e707e28b0d45242fff54474a961f02f30795ab399baa06eaa0a5eaa13e
+  metadata.gz: 841f8f3d844ee4881f2d98745eaca37cbf47f7e3352e13373a39bf95567cfd10950df47b60ace6810f805db7962e76bcdcf707dd2ae363f7a16a14850e558b57
+  data.tar.gz: 5163647859b894bb7946503995fdbad55bc8becd0eb25fb3378b11cfb5283d1ae0cf01f8003a683246693d9c4e52b085f1b7af99e3e4cab0d6053189e10739df

data/README.md

@@ -1,6 +1,7 @@
 # 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,7 +126,6 @@ api.send_messages(messages: messages, external_user_ids: [123, 456])
 api.send_messages(messages: messages, segment_id: '<segment-id>')
 ```
 
-
 ### Schedule Message
 
 ```ruby
@@ -122,6 +142,15 @@ api.trigger_campaign_schedule(
 )
 ```
 
+### Delete Scheduled Campaign
+
+```ruby
+api.delete_campaign_trigger_schedule(
+  campaign_id: 'campaign_id',
+  schedule_id: 'schedule_id'
+)
+```
+
 ### Send Campaigns
 
 ```ruby
@@ -146,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
@@ -263,7 +298,8 @@ 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
@@ -280,4 +316,7 @@ bundle exec rails whatever
 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/lib/braze_ruby/api.rb

@@ -44,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/endpoints/campaigns.rb

@@ -3,6 +3,10 @@
 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

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/rest/delete_trigger_campaign_schedule.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class DeleteTriggerCampaignSchedule < Base
+      def perform(campaign_id:, schedule_id:)
+        http.post(
+          "/campaigns/trigger/schedule/delete",
+          campaign_id: campaign_id,
+          schedule_id: schedule_id
+        )
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/scheduled_broadcasts.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class ScheduledBroadcasts < Base
+      attr_reader :params
+
+      def initialize(api_key, braze_url, options, **params)
+        @params = params
+        super api_key, braze_url, options
+      end
+
+      def perform
+        http.post "/messages/scheduled_broadcasts", {
+                    **@params
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest.rb

@@ -4,6 +4,7 @@ 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/scheduled_broadcasts"
 require "braze_ruby/rest/email_status"
 require "braze_ruby/rest/email_hard_bounces"
 require "braze_ruby/rest/email_unsubscribes"
@@ -11,6 +12,7 @@ require "braze_ruby/rest/export_users"
 require "braze_ruby/rest/list_segments"
 require "braze_ruby/rest/delete_users"
 require "braze_ruby/rest/trigger_campaign_schedule"
+require "braze_ruby/rest/delete_trigger_campaign_schedule"
 require "braze_ruby/rest/trigger_campaign_send"
 require "braze_ruby/rest/trigger_canvas_send"
 require "braze_ruby/rest/canvas_details"

data/lib/braze_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrazeRuby
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/braze_ruby.rb

@@ -1,9 +1,22 @@
 # frozen_string_literal: true
 
 require "braze_ruby/version"
+require "braze_ruby/configuration"
 
 module BrazeRuby
   autoload :API, "braze_ruby/api"
   autoload :REST, "braze_ruby/rest"
   autoload :Endpoints, "braze_ruby/endpoints"
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: braze_ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Josh Nussbaum
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -163,6 +163,7 @@ files:
 - braze_ruby.gemspec
 - lib/braze_ruby.rb
 - lib/braze_ruby/api.rb
+- lib/braze_ruby/configuration.rb
 - lib/braze_ruby/deprecated.rb
 - lib/braze_ruby/endpoints.rb
 - lib/braze_ruby/endpoints/campaigns.rb
@@ -184,6 +185,7 @@ files:
 - lib/braze_ruby/rest/base.rb
 - lib/braze_ruby/rest/canvas_details.rb
 - lib/braze_ruby/rest/create_user_aliases.rb
+- lib/braze_ruby/rest/delete_trigger_campaign_schedule.rb
 - lib/braze_ruby/rest/delete_users.rb
 - lib/braze_ruby/rest/email_hard_bounces.rb
 - lib/braze_ruby/rest/email_status.rb
@@ -195,6 +197,7 @@ files:
 - lib/braze_ruby/rest/remove_external_ids.rb
 - lib/braze_ruby/rest/rename_external_ids.rb
 - lib/braze_ruby/rest/schedule_messages.rb
+- lib/braze_ruby/rest/scheduled_broadcasts.rb
 - lib/braze_ruby/rest/send_messages.rb
 - lib/braze_ruby/rest/subscription_status_get.rb
 - lib/braze_ruby/rest/subscription_status_set.rb