braze_ruby 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69312ed5aded0835cc1a47be5d8192b0055edef0c64acf05aca8eef6333e8ba1
-  data.tar.gz: aa86ae45bb15cce4fd1c4ac56f36cc9fe5fcc935e4015c07cd9f611e76b22bf5
+  metadata.gz: ae77ca2f5ea9cf492d7f681c37fcbff40f912b8ce8ac9db237a9b91e8c5fc76a
+  data.tar.gz: 033f2a42048dfff0af864534900a5405ba5a56099e3630c23512f73a30a56468
 SHA512:
-  metadata.gz: ae746b58c45e1b24a8b5eae483cc9ec5d42a4669aa70803803a9fe49575ee1b17d58e644f3d95c37b7668e1fa967baa850d76423687689f68b7bf56b3c53ac2d
-  data.tar.gz: 57a527541dc22889bd4ffd015e52ca2d04c45c6e251539de5e6830a9a76ff4b9a01041b6dbbc3f836e98b23689565b652d263986e8200628a51d08c08de28b7e
+  metadata.gz: 67d8ff06c45f2e3d90e000c9093118c80d85136e77961cf5cf6bbdf1d45dd57b704905b1ff5388413df142773cd2e76a2473e92b9e2edcdbc85752ed09a6d111
+  data.tar.gz: 409c1603839abd4bf95c0096c54c936ea6fa438f350d368b8e3e117b1d1a17a082c55991c53fd4d75c2b67a2649792c01330db2e7f58ef94896cd00fe8f5bbaf

data/.circleci/config.yml

@@ -0,0 +1,57 @@
+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
+
+  publish:
+    docker:
+      - image: ruby:3.0.0
+    steps:
+      - checkout
+
+      - run:
+          name: Setup Rubygems
+          command: bash .circleci/setup-rubygems
+
+      - run:
+          name: Build gem
+          command: gem build braze_ruby.gemspec --output braze_ruby.gem
+
+      - run:
+          name: Publish gem
+          command: gem push braze_ruby.gem
+
+workflows:
+  all-tests:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby-version: ["ruby:3.0.0", "ruby:2.7.2", "ruby:2.6.3"]
+  release:
+    jobs:
+      - publish:
+          filters:
+            tags:
+              only: /^v.*/
+            branches:
+              ignore: /.*/

data/.circleci/gem_credentials

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

data/.circleci/setup-rubygems

@@ -0,0 +1,6 @@
+#! /bin/sh
+
+mkdir -p ~/.gem
+cp ./.circleci/gem_credentials ~/.gem/credentials
+chmod 0600 ~/.gem/credentials
+sed -i "s/REPLACE_ME/${RUBYGEMS_API_KEY}/g" ~/.gem/credentials

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,4 +1,4 @@
-# BrazeRuby
+# BrazeRuby [![CircleCI][badge]][circle]
 
 A wrapper for the Braze REST API. Forked from https://github.com/DynamoMTL/appboy
 
@@ -187,7 +187,20 @@ api.subscription_status_set(
 )
 ```
 
-### User Identification
+### User Alias
+
+#### Create an alias-only user
+
+```ruby
+api.create_user_aliases(
+  user_aliases: [{
+    user_alias: {
+      alias_name: "device123",
+      alias_label: "my_device_identifier",
+    }
+  }]
+)
+```
 
 #### Identify an alias-only user
 ```ruby
@@ -202,6 +215,37 @@ api.identify_users(
 )
 ```
 
+### External ID Migration
+
+#### Rename users' external IDs with an array of external_id_renames
+Note: you can send up to 50 rename objects per request.
+```ruby
+api.rename_external_ids(
+  external_id_renames: [{
+    current_external_id: "old_external_id",
+    new_external_id: "new_external_id",
+  }]
+)
+```
+
+#### Remove users' old deprecated external IDs
+Note: you can send up to 50 external IDs per request.
+```ruby
+api.remove_external_ids(external_ids: ['old_external_id'])
+```
+
+### Email Sync
+
+#### Get List of or Query Email Unsubscribes
+```ruby
+api.email_unsubscribes(email: ['jdoe@example.com'])
+```
+
+#### Get List of or Query Hard Bounced Emails
+```ruby
+api.email_hard_bounces(email: ['jdoe@example.com'])
+```
+
 ## Debugging
 
 The BRAZE_RUBY_DEBUG environment variable will trigger full printouts of the Faraday gem's HTTP requests and responses.
@@ -219,3 +263,6 @@ 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
+[circle]: https://circleci.com/gh/jonallured/braze_ruby

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.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'
+  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.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'braze_ruby/version'
+require "braze_ruby/version"
 
 module BrazeRuby
-  autoload :API, 'braze_ruby/api'
-  autoload :REST, 'braze_ruby/rest'
-  autoload :Endpoints, 'braze_ruby/endpoints'
+  autoload :API, "braze_ruby/api"
+  autoload :REST, "braze_ruby/rest"
+  autoload :Endpoints, "braze_ruby/endpoints"
 end

data/lib/braze_ruby/api.rb

@@ -1,15 +1,17 @@
 # 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/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"
 
 module BrazeRuby
   class API
@@ -25,20 +27,24 @@ module BrazeRuby
     include BrazeRuby::Endpoints::Canvas
     include BrazeRuby::Endpoints::Subscription
     include BrazeRuby::Endpoints::IdentifyUsers
+    include BrazeRuby::Endpoints::CreateUserAliases
+    include BrazeRuby::Endpoints::RenameExternalIds
+    include BrazeRuby::Endpoints::RemoveExternalIds
 
     def export_users(**payload)
-      BrazeRuby::REST::ExportUsers.new(braze_url).perform(api_key, payload)
+      BrazeRuby::REST::ExportUsers.new(api_key, braze_url, options).perform(**payload)
     end
 
     def list_segments
-      BrazeRuby::REST::ListSegments.new(braze_url).perform(api_key)
+      BrazeRuby::REST::ListSegments.new(api_key, braze_url, options).perform
     end
 
-    attr_reader :api_key, :braze_url
+    attr_reader :api_key, :braze_url, :options
 
-    def initialize(api_key, braze_url)
+    def initialize(api_key, braze_url, options = {})
       @api_key = api_key
       @braze_url = braze_url
+      @options = options
     end
   end
 end

data/lib/braze_ruby/deprecated.rb

@@ -3,19 +3,19 @@
 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.')
+      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)
+                        segment_id: segment_id, local_timezone: local_timezone)
     end
   end
 end

data/lib/braze_ruby/endpoints.rb

@@ -1,9 +1,12 @@
 # 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/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"