braze_ruby 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adcffccc751c8231b0084d858454d36d5b3a034b128bd4c7c7d72e5867a27b4b
-  data.tar.gz: 2e0bf1111244eb7c356f7b8b9edcf9cf146c7f38cf3687f771b9d45953fb4925
+  metadata.gz: d13af3abbb4e98372a950bf22a32729721f50e061b5c4259a0ca8441ffc1b718
+  data.tar.gz: 0ba7370dd8c8bf783643722ff0531a62128deb2361c4b7ce2cd0124659073c26
 SHA512:
-  metadata.gz: ae3ccf92edd2f7f82c31812964eba85a57af09f1bf944338491f03bcc2d8e5831f7c21594a7e07a2aa5df8f0f1d732721d3aa7b9147c9380c0f3c4178f99c7e0
-  data.tar.gz: 9c1046684d733a8aab55c2a65a97ff950340df129c44472089424f4a43099609975c96770d39c8a3a896cd05868867ea8b203d7f2f27a5c90204634af6c23ba3
+  metadata.gz: 12ce012904c603fa5c7d202f46bbbc3b5b0df057a07edb7f04ab18a820154eebba5628f23a3f43ace34b47a03a99415de1911429c6d9a3175b061522ca29025e
+  data.tar.gz: acb859868636273fa6a8b07370e31805cc17760e8f40b392f0141a3ce963b1e0c902209297d7dea2750d69bed6fa86ab55629ae7d50f2a8997a6b31ffe276207

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,8 +1,8 @@
 PATH
   remote: .
   specs:
-    braze_ruby (0.2.2)
-      faraday
+    braze_ruby (0.3.1)
+      faraday (~> 0.17.1)
 
 GEM
   remote: https://rubygems.org/
@@ -23,7 +23,7 @@ GEM
     dotenv (2.7.5)
     factory_bot (5.1.0)
       activesupport (>= 4.2.0)
-    faraday (0.15.4)
+    faraday (0.17.1)
       multipart-post (>= 1.2, < 3)
     hashdiff (1.0.0)
     i18n (1.6.0)
@@ -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.0)
+  vcr (~> 5.0.0)
+  webmock (~> 3.7.5)
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -163,6 +163,30 @@ 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'
+)
+```
+
 ## 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

@@ -25,14 +25,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0'
 
-  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday', '~> 0.17.1'
 
   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.0'
+  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,6 +23,7 @@ module BrazeRuby
     include BrazeRuby::Endpoints::DeleteUsers
     include BrazeRuby::Endpoints::Campaigns
     include BrazeRuby::Endpoints::Canvas
+    include BrazeRuby::Endpoints::Subscription
 
     def export_users(**payload)
       BrazeRuby::REST::ExportUsers.new(braze_url).perform(api_key, payload)

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

data/lib/braze_ruby/endpoints/campaigns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module Endpoints
     module Campaigns

data/lib/braze_ruby/endpoints/canvas.rb

@@ -1,9 +1,15 @@
+# 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
       end
+
+      def canvas_details(**payload)
+        BrazeRuby::REST::CanvasDetails.new(api_key, braze_url, payload).perform
+      end
     end
   end
 end

data/lib/braze_ruby/endpoints/delete_users.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module Endpoints
     module DeleteUsers

data/lib/braze_ruby/endpoints/email_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module Endpoints
     module EmailStatus

data/lib/braze_ruby/endpoints/email_sync.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module Endpoints
     module EmailSync

data/lib/braze_ruby/endpoints/schedule_messages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module Endpoints
     module ScheduleMessages

data/lib/braze_ruby/endpoints/send_messages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module Endpoints
     module SendMessages

data/lib/braze_ruby/endpoints/subscription.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module Endpoints
+    module Subscription
+      def subscription_status_set(**payload)
+        BrazeRuby::REST::SubscriptionStatusSet.new(api_key, braze_url, payload).perform
+      end
+
+      def subscription_status_get(**payload)
+        BrazeRuby::REST::SubscriptionStatusGet.new(api_key, braze_url, payload).perform
+      end
+
+
+      def subscription_user_status(**payload)
+        BrazeRuby::REST::SubscriptionUserStatus.new(api_key, braze_url, payload).perform
+      end
+    end
+  end
+end

data/lib/braze_ruby/endpoints/track_users.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module Endpoints
     module TrackUsers

data/lib/braze_ruby/http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'faraday'
 

data/lib/braze_ruby/rest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'braze_ruby/rest/base'
 require 'braze_ruby/rest/track_users'
 require 'braze_ruby/rest/send_messages'
@@ -10,3 +12,7 @@ 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'

data/lib/braze_ruby/rest/base.rb

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

data/lib/braze_ruby/rest/canvas_details.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class CanvasDetails < Base
+      attr_reader :api_key, :params
+
+      def initialize(api_key, braze_url, **params)
+        @api_key = api_key
+        @params = params
+        super braze_url
+      end
+
+      def perform
+        http.get('/canvas/details', {
+          'api_key': api_key,
+          **@params
+        })
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/delete_users.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class DeleteUsers < Base

data/lib/braze_ruby/rest/email_hard_bounces.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class EmailHardBounces < Base

data/lib/braze_ruby/rest/email_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class EmailStatus < Base

data/lib/braze_ruby/rest/email_unsubscribes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class EmailUnsubscribes < Base

data/lib/braze_ruby/rest/export_users.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class ExportUsers < Base

data/lib/braze_ruby/rest/list_segments.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class ListSegments < Base

data/lib/braze_ruby/rest/schedule_messages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class ScheduleMessages < Base

data/lib/braze_ruby/rest/send_messages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class SendMessages < Base

data/lib/braze_ruby/rest/subscription_status_get.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class SubscriptionStatusGet < Base
+      attr_reader :api_key, :params
+
+      def initialize(api_key, braze_url, **params)
+        @api_key = api_key
+        @params = params
+        super braze_url
+      end
+
+      def perform
+        http.get('/subscription/status/get', {
+          'api_key': api_key,
+          **params
+        })
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/subscription_status_set.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class SubscriptionStatusSet < Base
+      attr_reader :api_key, :params
+
+      def initialize(api_key, braze_url, **params)
+        @api_key = api_key
+        @params = params
+        super braze_url
+      end
+
+      def perform
+        http.post('/subscription/status/set', {
+          'api_key': api_key,
+          **params
+        })
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/subscription_user_status.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class SubscriptionUserStatus < Base
+      attr_reader :api_key, :params
+
+      def initialize(api_key, braze_url, **params)
+        @api_key = api_key
+        @params = params
+        super braze_url
+      end
+
+      def perform
+        http.get('/subscription/user/status', {
+          'api_key': api_key,
+          **params
+        })
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/track_users.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class TrackUsers < Base