braze_ruby 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92627ab40d55d8abadf9acd07b143a0eae13586d0caad935e657c8e4fb074d54
-  data.tar.gz: e21b4acbf9aef12c2f7ab37029aece94f421a3a9e2d45afd0c41216316b3a402
+  metadata.gz: 13d93e632f509eb5ccaef744c1e378092fc25c68829f0819524484c1612e5438
+  data.tar.gz: f3827d451cf7ba1d424a23365676c74e83d0d3e999a0dfc295bacc0240de4261
 SHA512:
-  metadata.gz: 841f8f3d844ee4881f2d98745eaca37cbf47f7e3352e13373a39bf95567cfd10950df47b60ace6810f805db7962e76bcdcf707dd2ae363f7a16a14850e558b57
-  data.tar.gz: 5163647859b894bb7946503995fdbad55bc8becd0eb25fb3378b11cfb5283d1ae0cf01f8003a683246693d9c4e52b085f1b7af99e3e4cab0d6053189e10739df
+  metadata.gz: fc3543daf80e77fa1a59d0cbcb11825ca0078426c02802dc7acd66b48f9e745baaa0a0e7f19b86c22c7678b0732c9a04d53fbe92e521daa50e32734f12298b78
+  data.tar.gz: 89d604660de041f123a0d051d1a075d9b51ccf389e6e2342966657ea557aa6408fc149340855523d23454106d2efba65fbb8881cb1c63cf29aad27bb9b8c042f

data/.circleci/config.yml

@@ -23,4 +23,4 @@ workflows:
       - test:
           matrix:
             parameters:
-              ruby-version: ["ruby:3.0.1", "ruby:2.7.3", "ruby:2.6.7"]
+              ruby-version: ["ruby:3.1.6", "ruby:3.2.5", "ruby:3.3.5"]

data/.github/workflows/release.yml

@@ -1,13 +1,15 @@
 name: release
+
 on:
   push:
     tags:
       - v*
+
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Setup rubygems
         run: |
           mkdir ~/.gem

data/.rspec

@@ -1 +1,3 @@
 --color
+--order random
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,126 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog][] and this project adheres to
+[Semantic Versioning][].
+
+[Keep a Changelog]: https://keepachangelog.com
+[Semantic Versioning]: https://semver.org
+
+## [Unreleased][]
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## [0.9.0][] - 2024-10-25
+
+### Added
+
+* Add a CHANGELOG ([#61][])
+* Add console script ([#63][])
+
+### Changed
+
+* Improve configuration support ([#64][])
+* Improve release script ([#65][])
+
+### Fixed
+
+* Fix CircleCI builds ([#62][])
+
+## [0.8.0][] - 2022-01-24
+
+### Added
+
+* Add a Configuration class ([#42][])
+* Add an endpoint for messages that are scheduled ([#43][])
+* Document #scheduled_messages ([#45][])
+* Add support for deleting scheduled triggers ([#47][])
+
+### Changed
+
+* Standardize rest test code structure ([#44][])
+
+### Fixed
+
+* Fix typo in README code example ([#46][])
+
+## [0.7.0][] - 2021-09-29
+
+### Added
+
+* Add campaign scheduling endpoint ([#41][])
+
+### Fixed
+
+* Fix syntax error in "send campaigns" example ([#38][])
+
+## [0.6.0][] - 2021-07-23
+
+### Added
+
+* Add retry configuration pass through ([#31][])
+* Endpoint for 'remove email address from spam' ([#32][])
+* Ability to set Faraday connection options ([#34][])
+
+### Changed
+
+* Publish via GitHub actions ([#36][])
+* Allow options when exporting users by ids ([#37][])
+
+## [0.5.0][] - 2021-05-06
+
+### Added
+
+* Add .circleci/config.yml ([#25][])
+* Setup and comply with standardrb ([#28][])
+* Add release workflow to publish gem from CI ([#29][])
+* Add script to help automate releases ([#30][])
+
+### Changed
+
+* Modernize a few files and tinker with CI setup ([#26][])
+* Update authors and license ([#27][])
+
+[Unreleased]: https://github.com/jonallured/braze_ruby/compare/v0.9.0...HEAD
+
+[0.5.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.5.0
+[0.6.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.6.0
+[0.7.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.7.0
+[0.8.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.8.0
+[0.9.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.9.0
+
+[#25]: https://github.com/jonallured/braze_ruby/pull/25
+[#26]: https://github.com/jonallured/braze_ruby/pull/26
+[#27]: https://github.com/jonallured/braze_ruby/pull/27
+[#28]: https://github.com/jonallured/braze_ruby/pull/28
+[#29]: https://github.com/jonallured/braze_ruby/pull/29
+[#30]: https://github.com/jonallured/braze_ruby/pull/30
+[#31]: https://github.com/jonallured/braze_ruby/pull/31
+[#32]: https://github.com/jonallured/braze_ruby/pull/32
+[#34]: https://github.com/jonallured/braze_ruby/pull/34
+[#36]: https://github.com/jonallured/braze_ruby/pull/36
+[#37]: https://github.com/jonallured/braze_ruby/pull/37
+[#38]: https://github.com/jonallured/braze_ruby/pull/38
+[#41]: https://github.com/jonallured/braze_ruby/pull/41
+[#42]: https://github.com/jonallured/braze_ruby/pull/42
+[#43]: https://github.com/jonallured/braze_ruby/pull/43
+[#44]: https://github.com/jonallured/braze_ruby/pull/44
+[#45]: https://github.com/jonallured/braze_ruby/pull/45
+[#46]: https://github.com/jonallured/braze_ruby/pull/46
+[#47]: https://github.com/jonallured/braze_ruby/pull/47
+[#61]: https://github.com/jonallured/braze_ruby/pull/61
+[#62]: https://github.com/jonallured/braze_ruby/pull/62
+[#63]: https://github.com/jonallured/braze_ruby/pull/63
+[#64]: https://github.com/jonallured/braze_ruby/pull/64
+[#65]: https://github.com/jonallured/braze_ruby/pull/65

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Jon Allured
+Copyright (c) 2024 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

data/README.md

@@ -19,22 +19,43 @@ Or install it yourself as:
 
 ### Configuration
 
-Configuration options may be passed when a new API object is instantiated:
+Configuration settings may be passed when a new API object is instantiated:
 
 ```ruby
-BrazeRuby::API.new('<braze-rest-api-key>', '<braze-rest-url', {<additional options>})
+api_key = "instance-api-key"
+braze_url = "instance-braze-url"
+options = { key: "instance-options" }
+
+api = BrazeRuby::API.new(api_key, braze_url, options)
+
+api.api_key
+# => "instance-api-key"
+api.braze_url
+# => "instance-braze-url"
+api.options
+# => {:key=>"instance-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:
+`BrazeRuby::configure` method. Then, if you instantiate an API object with no
+arguments it will use these global configuration settings:
 
 ```ruby
 BrazeRuby.configure do |config|
-  config.rest_api_key = '<braze-rest-api-key>'
-  config.rest_url = '<braze-rest-url>'
-  config.options = {<additional options>}
+  config.rest_api_key = "global-api-key"
+  config.rest_url = "global-braze-url"
+  config.options = { key: "global-options" }
 end
+
+api = BrazeRuby::API.new
+
+api.api_key
+# => "global-api-key"
+api.braze_url
+# => "global-braze-url"
+api.options
+# => {:key=>"global-options"}
 ```
 
 ## Examples
@@ -307,6 +328,18 @@ export BRAZE_RUBY_DEBUG=true
 bundle exec rails whatever
 ```
 
+## Releasing
+
+Before releasing the CHANGELOG should be updated so that the new version has
+it's own section and an empty Unreleased section is ready for the next change.
+New versions are released by running a script locally that bumps the minor level
+of the gem and then pushes to a GitHub Action that actually sends the new
+version to RubyGems.org:
+
+```
+$ ./bin/release
+```
+
 ## Contributing
 
 1. Fork it
@@ -314,6 +347,7 @@ 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
+6. Update CHANGELOG
 
 [badge]: https://circleci.com/gh/jonallured/braze_ruby.svg?style=svg
 [braze_api_key]: https://www.braze.com/docs/api/api_key/

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "braze_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/release

@@ -1,16 +1,6 @@
 #! /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"
+bundle exec bump minor --tag
 git push origin main
-git tag --annotate v$new_version --message "$tag_message"
 git push origin --tags

data/braze_ruby.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   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]
+  spec.email = %w[josh@godynamo.com hugo@godynamo.com justin.boltz@takl.com jon@jonallured.com]
 
   spec.summary = "A wrapper gem for the Braze REST API."
   spec.description = "Wrapper for Braze API"
@@ -19,11 +19,11 @@ Gem::Specification.new do |spec|
     `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_development_dependency "bump"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "pry"

data/lib/braze_ruby/api.rb

@@ -43,10 +43,10 @@ module BrazeRuby
 
     attr_reader :api_key, :braze_url, :options
 
-    def initialize(api_key, braze_url, options = {})
-      @api_key = api_key || configuration.rest_api_key
-      @braze_url = braze_url || configuration.rest_url
-      @options = options || configuration.options
+    def initialize(api_key = nil, braze_url = nil, options = nil)
+      @api_key = api_key || BrazeRuby.configuration.rest_api_key
+      @braze_url = braze_url || BrazeRuby.configuration.rest_url
+      @options = options || BrazeRuby.configuration.options || {}
     end
   end
 end

data/lib/braze_ruby/rest/canvas_details.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/email_hard_bounces.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/email_status.rb

@@ -8,7 +8,7 @@ module BrazeRuby
       def initialize(api_key, braze_url, options, email: nil, status: nil)
         @email = email
         @status = status
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/email_unsubscribes.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/schedule_messages.rb

@@ -10,7 +10,7 @@ module BrazeRuby
         @time = time
         @external_user_ids = external_user_ids
         @in_local_time = in_local_time
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/scheduled_broadcasts.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/send_messages.rb

@@ -8,7 +8,7 @@ module BrazeRuby
       def initialize(api_key, braze_url, options, messages: [], external_user_ids: [])
         @messages = messages
         @external_user_ids = external_user_ids
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/subscription_status_get.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/subscription_status_set.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/subscription_user_status.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/trigger_campaign_schedule.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/trigger_campaign_send.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/rest/trigger_canvas_send.rb

@@ -7,7 +7,7 @@ module BrazeRuby
 
       def initialize(api_key, braze_url, options, **params)
         @params = params
-        super api_key, braze_url, options
+        super(api_key, braze_url, options)
       end
 
       def perform

data/lib/braze_ruby/version.rb

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

data/lib/braze_ruby.rb

@@ -16,6 +16,10 @@ module BrazeRuby
     @configuration ||= Configuration.new
   end
 
+  def self.reset
+    @configuration = Configuration.new
+  end
+
   def self.configure
     yield(configuration)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: braze_ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Josh Nussbaum
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -27,6 +27,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +158,7 @@ email:
 - josh@godynamo.com
 - hugo@godynamo.com
 - justin.boltz@takl.com
-- jon.allured@gmail.com
+- jon@jonallured.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -155,10 +169,12 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".standard.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - bin/release
 - braze_ruby.gemspec
 - lib/braze_ruby.rb
@@ -228,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: A wrapper gem for the Braze REST API.