braze_ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c0406b29e745be8bd5e98d2353edb96e5753c12
-  data.tar.gz: ff30b73feb4b87a7bc02ad38a8b4b359490c2427
+  metadata.gz: e78db383c73ab0375f4c015ce0f99d17e7ed7035
+  data.tar.gz: c5d7efa4e531f247e114288e2afbba7e3f6107ec
 SHA512:
-  metadata.gz: e22f67115caaa99d694cae39b5e2c930c352d037939313ce7ba82426c4197c094588305d4f3fa51329d3aefbc2177f1addcd07ea1dbd0a3403c43e97e995b931
-  data.tar.gz: 54ae4986cfe73d3dddff37450bf947187aaf4b36ebbb7585b9050c6ecc34d753e6e439eaeac1c62ef78ef9bf02f376d169d564836656bd192bb1d091c0aaeefb
+  metadata.gz: 7400b2b2035c80486acd34dfbe77fbde74c8a56f7afc7837e9a4e773a9f636ac13d94de054dc709a040dfd5195bfc92b5534f5ad4b1108a6a85dfb909c4e1788
+  data.tar.gz: 1a575b9c132c8a1489bf8e9fa873dc2175ee158fd1eb05f70793872f0a9c35ebd4324f4d197ede7ba383e8194116272da9c0f4032156562fd78e6ba017dffc05

data/README.md

@@ -137,6 +137,13 @@ api.export_users(external_ids: [1])
 ```ruby
 api.export_users(segment_id: segment_id, callback_endpoint: 'https://example.com')
 ```
+### Delete Users
+
+#####
+Delete Braze Users with an array of external_ids
+```ruby
+api.delete_users([1, 2, 3])
+```
 
 ## Debugging
 

data/lib/braze_ruby/api.rb

@@ -3,6 +3,7 @@ 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/delete_users'
 
 module BrazeRuby
   class API
@@ -12,6 +13,7 @@ module BrazeRuby
     include BrazeRuby::Endpoints::SendMessages
     include BrazeRuby::Endpoints::ScheduleMessages
     include BrazeRuby::Endpoints::EmailStatus
+    include BrazeRuby::Endpoints::DeleteUsers
 
     def export_users(**payload)
       BrazeRuby::REST::ExportUsers.new(braze_url).perform(api_key, payload)

data/lib/braze_ruby/endpoints.rb

@@ -2,3 +2,4 @@ require 'braze_ruby/endpoints/email_status'
 require 'braze_ruby/endpoints/schedule_messages'
 require 'braze_ruby/endpoints/send_messages'
 require 'braze_ruby/endpoints/track_users'
+require 'braze_ruby/endpoints/delete_users'

data/lib/braze_ruby/endpoints/delete_users.rb

@@ -0,0 +1,21 @@
+module BrazeRuby
+  module Endpoints
+    module DeleteUsers
+      attr_writer :delete_users_service
+
+      def delete_users_action(**payload)
+        delete_users_service.perform(api_key, payload)
+      end
+
+      def delete_users(payload)
+        delete_users_action(external_ids: payload.compact.uniq)
+      end
+
+      private
+
+      def delete_users_service
+        @delete_users_service ||= BrazeRuby::REST::DeleteUsers.new(braze_url)
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest.rb

@@ -5,3 +5,4 @@ require 'braze_ruby/rest/schedule_messages'
 require 'braze_ruby/rest/email_status'
 require 'braze_ruby/rest/export_users'
 require 'braze_ruby/rest/list_segments'
+require 'braze_ruby/rest/delete_users'

data/lib/braze_ruby/rest/delete_users.rb

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

data/lib/braze_ruby/version.rb

@@ -1,3 +1,3 @@
 module BrazeRuby
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: braze_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Josh Nussbaum
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -200,6 +200,7 @@ files:
 - lib/braze_ruby/api.rb
 - lib/braze_ruby/deprecated.rb
 - lib/braze_ruby/endpoints.rb
+- lib/braze_ruby/endpoints/delete_users.rb
 - lib/braze_ruby/endpoints/email_status.rb
 - lib/braze_ruby/endpoints/schedule_messages.rb
 - lib/braze_ruby/endpoints/send_messages.rb
@@ -207,6 +208,7 @@ files:
 - lib/braze_ruby/http.rb
 - lib/braze_ruby/rest.rb
 - lib/braze_ruby/rest/base.rb
+- lib/braze_ruby/rest/delete_users.rb
 - lib/braze_ruby/rest/email_status.rb
 - lib/braze_ruby/rest/export_users.rb
 - lib/braze_ruby/rest/list_segments.rb