braze_ruby 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13d93e632f509eb5ccaef744c1e378092fc25c68829f0819524484c1612e5438
-  data.tar.gz: f3827d451cf7ba1d424a23365676c74e83d0d3e999a0dfc295bacc0240de4261
+  metadata.gz: f8b917b476524829a7321aba5094d205b8354c09ea1f9440af5d65c1766e3dda
+  data.tar.gz: 76f533b0029ceed757ad322caad5e3c3671db936a80bcada11bcec7dd9fc02c2
 SHA512:
-  metadata.gz: fc3543daf80e77fa1a59d0cbcb11825ca0078426c02802dc7acd66b48f9e745baaa0a0e7f19b86c22c7678b0732c9a04d53fbe92e521daa50e32734f12298b78
-  data.tar.gz: 89d604660de041f123a0d051d1a075d9b51ccf389e6e2342966657ea557aa6408fc149340855523d23454106d2efba65fbb8881cb1c63cf29aad27bb9b8c042f
+  metadata.gz: 12e35e8e02474f45b79e7090ee3d09ab0396511b4575a0e21e6bfa25aacc65932a664b6695d5e53ada5c5c312e724fd961d3e693bcf6af59d811e8c9e5dd49fb
+  data.tar.gz: 8b8933c389cc3d43ec94a047c1dcfdf596b9ff1cc26f60366a0fb41faec3be5a22fb8752c2357a851759d4adf650d83469dabaec96e145a6fb8f432d5b0b157b

data/.circleci/config.yml

@@ -1,4 +1,5 @@
 version: 2.1
+
 jobs:
   test:
     parameters:
@@ -17,10 +18,16 @@ jobs:
       - run:
           name: Run tests
           command: bundle exec rake
+
 workflows:
   all-tests:
     jobs:
       - test:
-          matrix:
-            parameters:
-              ruby-version: ["ruby:3.1.6", "ruby:3.2.5", "ruby:3.3.5"]
+          name: test-latest
+          ruby-version: ruby:3.3.6
+      - test:
+          name: test-minus-one
+          ruby-version: ruby:3.2.6
+      - test:
+          name: test-minus-two
+          ruby-version: ruby:3.1.6

data/CHANGELOG.md

@@ -22,6 +22,17 @@ The format is based on [Keep a Changelog][] and this project adheres to
 
 ### Security
 
+## [0.10.0][] - 2024-11-15
+
+### Added
+
+* Partial support for Braze catalogs ([#60][])
+
+### Changed
+
+* Use more generic CI job names ([#67][])
+* Bump Ruby versions for CI ([#68][])
+
 ## [0.9.0][] - 2024-10-25
 
 ### Added
@@ -92,13 +103,14 @@ The format is based on [Keep a Changelog][] and this project adheres to
 * 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
+[Unreleased]: https://github.com/jonallured/braze_ruby/compare/v0.10.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
+[0.10.0]: https://github.com/jonallured/braze_ruby/releases/tag/v0.10.0
 
 [#25]: https://github.com/jonallured/braze_ruby/pull/25
 [#26]: https://github.com/jonallured/braze_ruby/pull/26
@@ -119,8 +131,11 @@ The format is based on [Keep a Changelog][] and this project adheres to
 [#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
+[#60]: https://github.com/jonallured/braze_ruby/pull/60
 [#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
+[#67]: https://github.com/jonallured/braze_ruby/pull/67
+[#68]: https://github.com/jonallured/braze_ruby/pull/68

data/README.md

@@ -317,6 +317,83 @@ api.email_hard_bounces(email: ['jdoe@example.com'])
 api.remove_emails_from_spam(email: ['jdoe@example.com'])
 ```
 
+### Braze catalogs
+
+As of november 2024, Braze catalogs still have some moving parts (beta) and only
+partial support has been implemented
+
+#### Create Catalogs
+```ruby
+api.create_catalogs(
+  catalogs: [
+    {
+      name: "restaurants",
+      description: "My Restaurants",
+      fields: [
+        {name: "id", type: "string"},
+        {name: "Name", type: "string"},
+        {name: "Loyalty_Program", type: "boolean"},
+        {name: "Created_At", type: "time"}
+      ]
+    }
+  ]
+)
+```
+
+#### List Catalogs
+```ruby
+api.list_catalogs
+```
+
+#### Delete Catalog
+```ruby
+api.delete_catalog("restaurants")
+```
+
+#### Create Catalog Items
+```ruby
+api.create_catalog_items(
+  "restaurants",
+  items: [
+    {
+      id: "restaurant1",
+      Name: "Restaurant1",
+      Loyalty_Program: true,
+      Created_At: "2022-11-01T09:03:19.967+00:00"
+    }
+  ]
+)
+```
+
+#### Delete Catalog Items
+```ruby
+api.delete_catalog_items(
+  "restaurants",
+  items: [
+    {id: "restaurant1"}
+  ]
+)
+```
+
+#### Update Catalog Items
+
+This functions like an upsert, the name of the associated permission api key
+permission is `catalog.replace_items`
+
+```ruby
+api.update_catalog_items(
+  "restaurants",
+  items: [
+    {
+      id: "restaurant1",
+      Name: "NewRestaurantName",
+      Loyalty_Program: false,
+      Created_At: "2022-11-01T09:03:19.967+00:00"
+    }
+  ]
+)
+```
+
 ## Debugging
 
 The BRAZE_RUBY_DEBUG environment variable will trigger full printouts of the

data/lib/braze_ruby/api.rb

@@ -9,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/catalogs"
 require "braze_ruby/endpoints/subscription"
 require "braze_ruby/endpoints/rename_external_ids"
 require "braze_ruby/endpoints/remove_external_ids"
@@ -26,6 +27,7 @@ module BrazeRuby
     include BrazeRuby::Endpoints::DeleteUsers
     include BrazeRuby::Endpoints::Campaigns
     include BrazeRuby::Endpoints::Canvas
+    include BrazeRuby::Endpoints::Catalogs
     include BrazeRuby::Endpoints::Subscription
     include BrazeRuby::Endpoints::IdentifyUsers
     include BrazeRuby::Endpoints::CreateUserAliases

data/lib/braze_ruby/endpoints/catalogs.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module Endpoints
+    module Catalogs
+      # Catalog management
+      def create_catalogs(**payload)
+        BrazeRuby::REST::CreateCatalogs.new(api_key, braze_url, options, **payload).perform
+      end
+
+      def delete_catalog(catalog_name)
+        BrazeRuby::REST::DeleteCatalog.new(api_key, braze_url, options, catalog_name).perform
+      end
+
+      def list_catalogs
+        BrazeRuby::REST::ListCatalogs.new(api_key, braze_url, options).perform
+      end
+
+      # Catalog items
+      def create_catalog_items(catalog_name, **payload)
+        BrazeRuby::REST::CreateCatalogItems.new(api_key, braze_url, options, catalog_name, **payload).perform
+      end
+
+      def delete_catalog_items(catalog_name, **payload)
+        BrazeRuby::REST::DeleteCatalogItems.new(api_key, braze_url, options, catalog_name, **payload).perform
+      end
+
+      def update_catalog_items(catalog_name, **payload)
+        BrazeRuby::REST::UpdateCatalogItems.new(api_key, braze_url, options, catalog_name, **payload).perform
+      end
+    end
+  end
+end

data/lib/braze_ruby/http.rb

@@ -20,10 +20,22 @@ module BrazeRuby
       end
     end
 
+    def put(path, payload)
+      connection.post path do |request|
+        request.body = JSON.dump(payload)
+      end
+    end
+
     def get(path, query = {})
       connection.get path, query
     end
 
+    def delete(path, payload = nil)
+      connection.delete path do |request|
+        request.body = JSON.dump(payload) if payload
+      end
+    end
+
     def connection
       @connection ||= Faraday.new(url: @braze_url) do |connection|
         connection.headers["Content-Type"] = "application/json"

data/lib/braze_ruby/rest/create_catalog_items.rb

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

data/lib/braze_ruby/rest/create_catalogs.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class CreateCatalogs < 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("/catalogs", @params)
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/delete_catalog.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class DeleteCatalog < Base
+      attr_reader :params
+
+      def initialize(api_key, braze_url, options, catalog_name)
+        @catalog_name = catalog_name
+        super(api_key, braze_url, options)
+      end
+
+      def perform
+        http.delete("/catalogs/#{@catalog_name}")
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/delete_catalog_items.rb

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

data/lib/braze_ruby/rest/list_catalogs.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class ListCatalogs < Base
+      def perform
+        http.get("/catalogs")
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/update_catalog_items.rb

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

data/lib/braze_ruby/rest.rb

@@ -24,3 +24,9 @@ require "braze_ruby/rest/create_user_aliases"
 require "braze_ruby/rest/rename_external_ids"
 require "braze_ruby/rest/remove_external_ids"
 require "braze_ruby/rest/remove_email_addresses_from_spam"
+require "braze_ruby/rest/create_catalogs"
+require "braze_ruby/rest/delete_catalog"
+require "braze_ruby/rest/list_catalogs"
+require "braze_ruby/rest/create_catalog_items"
+require "braze_ruby/rest/delete_catalog_items"
+require "braze_ruby/rest/update_catalog_items"

data/lib/braze_ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: braze_ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Josh Nussbaum
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-25 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -184,6 +184,7 @@ files:
 - lib/braze_ruby/endpoints.rb
 - lib/braze_ruby/endpoints/campaigns.rb
 - lib/braze_ruby/endpoints/canvas.rb
+- lib/braze_ruby/endpoints/catalogs.rb
 - lib/braze_ruby/endpoints/create_user_aliases.rb
 - lib/braze_ruby/endpoints/delete_users.rb
 - lib/braze_ruby/endpoints/email_status.rb
@@ -200,7 +201,11 @@ files:
 - lib/braze_ruby/rest.rb
 - lib/braze_ruby/rest/base.rb
 - lib/braze_ruby/rest/canvas_details.rb
+- lib/braze_ruby/rest/create_catalog_items.rb
+- lib/braze_ruby/rest/create_catalogs.rb
 - lib/braze_ruby/rest/create_user_aliases.rb
+- lib/braze_ruby/rest/delete_catalog.rb
+- lib/braze_ruby/rest/delete_catalog_items.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
@@ -208,6 +213,7 @@ files:
 - lib/braze_ruby/rest/email_unsubscribes.rb
 - lib/braze_ruby/rest/export_users.rb
 - lib/braze_ruby/rest/identify_users.rb
+- lib/braze_ruby/rest/list_catalogs.rb
 - lib/braze_ruby/rest/list_segments.rb
 - lib/braze_ruby/rest/remove_email_addresses_from_spam.rb
 - lib/braze_ruby/rest/remove_external_ids.rb
@@ -222,6 +228,7 @@ files:
 - lib/braze_ruby/rest/trigger_campaign_schedule.rb
 - lib/braze_ruby/rest/trigger_campaign_send.rb
 - lib/braze_ruby/rest/trigger_canvas_send.rb
+- lib/braze_ruby/rest/update_catalog_items.rb
 - lib/braze_ruby/version.rb
 homepage: https://github.com/jonallured/braze_ruby
 licenses: