braze_ruby 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00f98a5e5a27d4b6fee439d6a9e94d4cba07a289d19156676cb40ca461f49ebe
-  data.tar.gz: f1d8d93b6fc59235283f56d97a70e5865648f0112ed96d4e236ee026b71e4afb
+  metadata.gz: c8cd9bb68fd35c0ccd7a9ecae5c5231696f2a48e906cea65f4436d7383167916
+  data.tar.gz: 54c80de739f86eaf92321a6ff2a2fae377e17c2915427ea614e242547debd32a
 SHA512:
-  metadata.gz: 5054700908a8a4082656351cf8be6a1e1f2733f1ca9b82a1fb1d3bc6b66332dc1c08c46cb739dd13f3083ee09dde3cf3ecce21afee61aca4d1be46c386a7066f
-  data.tar.gz: a2a388bb6cdef1683ccd31b6a185d2343d6190c4c4d32479158c830fe94ba79bc30599e7c7bc8a882faa11a7bf4fe4267166f0476ec4198e48cf076ab4014240
+  metadata.gz: 8862330d38a1b209bcb0afcb4ad11140e91c76cb3d4070010ed39f8272c3a21834412e5d41945e2e5a0e1ed8bc162e6ef75d92933e5e16b7cb1960e7bf1ff0ed
+  data.tar.gz: 6df0f44bc9e59531234a465384eb2ad7996abf43329f84aa0efff5714c980269277e83f464e0b6e33a54fc2ef6753e66d48110f34dbda8e4fa0bb203c024de39

data/.github/workflows/ci.yml

@@ -7,13 +7,24 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
+
     - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Cache gems
+      uses: actions/cache@v1
       with:
-        ruby-version: 2.6.x
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
     - name: Build and test
       run: |
         gem install bundler
+        bundle config path vendor/bundle
         bundle install --jobs 4 --retry 3
         bundle exec rake spec

data/Gemfile.lock

@@ -1,64 +1,64 @@
 PATH
   remote: .
   specs:
-    braze_ruby (0.3.2)
+    braze_ruby (0.4.0)
       faraday
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     dotenv (2.7.5)
-    factory_bot (5.1.0)
+    factory_bot (5.2.0)
       activesupport (>= 4.2.0)
-    faraday (0.17.1)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    hashdiff (1.0.0)
-    i18n (1.6.0)
+    hashdiff (1.0.1)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.2)
-    minitest (5.12.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
     multipart-post (2.1.1)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (4.0.1)
-    rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     safe_yaml (1.0.5)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    vcr (5.0.0)
-    webmock (3.7.5)
+    vcr (6.0.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.1.10)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -67,12 +67,12 @@ DEPENDENCIES
   braze_ruby!
   bundler (>= 1.3)
   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)
+  factory_bot (>= 5.1.0)
+  pry (>= 0.12.2)
+  rake (>= 12.3.3)
+  rspec (~> 3.8)
+  vcr (>= 5.0.0)
+  webmock (>= 3.7.5)
 
 BUNDLED WITH
-   2.1.1
+   2.1.4

data/braze_ruby.gemspec

@@ -28,11 +28,11 @@ Gem::Specification.new do |spec|
   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 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.8'
   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 '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/api.rb

@@ -27,11 +27,11 @@ module BrazeRuby
     include BrazeRuby::Endpoints::IdentifyUsers
 
     def export_users(**payload)
-      BrazeRuby::REST::ExportUsers.new(braze_url, options).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, options).perform(api_key)
+      BrazeRuby::REST::ListSegments.new(api_key, braze_url, options).perform
     end
 
     attr_reader :api_key, :braze_url, :options

data/lib/braze_ruby/endpoints/campaigns.rb

@@ -4,7 +4,7 @@ module BrazeRuby
   module Endpoints
     module Campaigns
       def trigger_campaign_send(**payload)
-        BrazeRuby::REST::TriggerCampaignSend.new(api_key, braze_url, options, payload).perform
+        BrazeRuby::REST::TriggerCampaignSend.new(api_key, braze_url, options, **payload).perform
       end
     end
   end

data/lib/braze_ruby/endpoints/canvas.rb

@@ -4,11 +4,11 @@ module BrazeRuby
   module Endpoints
     module Canvas
       def trigger_canvas_send(**payload)
-        BrazeRuby::REST::TriggerCanvasSend.new(api_key, braze_url, options, payload).perform
+        BrazeRuby::REST::TriggerCanvasSend.new(api_key, braze_url, options, **payload).perform
       end
 
       def canvas_details(**payload)
-        BrazeRuby::REST::CanvasDetails.new(api_key, braze_url, options, payload).perform
+        BrazeRuby::REST::CanvasDetails.new(api_key, braze_url, options, **payload).perform
       end
     end
   end

data/lib/braze_ruby/endpoints/delete_users.rb

@@ -6,7 +6,7 @@ module BrazeRuby
       attr_writer :delete_users_service
 
       def delete_users_action(**payload)
-        delete_users_service.perform(api_key, payload)
+        delete_users_service.perform(**payload)
       end
 
       def delete_users(payload)
@@ -16,7 +16,7 @@ module BrazeRuby
       private
 
       def delete_users_service
-        @delete_users_service ||= BrazeRuby::REST::DeleteUsers.new(braze_url, options)
+        @delete_users_service ||= BrazeRuby::REST::DeleteUsers.new(api_key, braze_url, options)
       end
     end
   end

data/lib/braze_ruby/endpoints/email_status.rb

@@ -4,7 +4,7 @@ module BrazeRuby
   module Endpoints
     module EmailStatus
       def email_status(**payload)
-        email_status_service.new(api_key, braze_url, options, payload).perform
+        email_status_service.new(api_key, braze_url, options, **payload).perform
       end
 
       def email_status_service

data/lib/braze_ruby/endpoints/email_sync.rb

@@ -4,11 +4,11 @@ module BrazeRuby
   module Endpoints
     module EmailSync
       def email_unsubscribes(**payload)
-        BrazeRuby::REST::EmailUnsubscribes.new(api_key, braze_url, options, payload).perform
+        BrazeRuby::REST::EmailUnsubscribes.new(api_key, braze_url, options, **payload).perform
       end
 
       def email_hard_bounces(**payload)
-        BrazeRuby::REST::EmailHardBounces.new(api_key, braze_url, options, payload).perform
+        BrazeRuby::REST::EmailHardBounces.new(api_key, braze_url, options, **payload).perform
       end
     end
   end

data/lib/braze_ruby/endpoints/identify_users.rb

@@ -6,13 +6,13 @@ module BrazeRuby
       attr_writer :identify_users_service
 
       def identify_users(**payload)
-        identify_users_service.perform(api_key, payload)
+        identify_users_service.perform(**payload)
       end
 
       private
 
       def identify_users_service
-        @identify_users_service ||= BrazeRuby::REST::IdentifyUsers.new(braze_url, options)
+        @identify_users_service ||= BrazeRuby::REST::IdentifyUsers.new(api_key, braze_url, options)
       end
     end
   end

data/lib/braze_ruby/endpoints/schedule_messages.rb

@@ -4,7 +4,7 @@ module BrazeRuby
   module Endpoints
     module ScheduleMessages
       def schedule_messages(**payload)
-        schedule_messages_service.new(api_key, braze_url, options, payload).perform
+        schedule_messages_service.new(api_key, braze_url, options, **payload).perform
       end
 
       private

data/lib/braze_ruby/endpoints/send_messages.rb

@@ -4,7 +4,7 @@ module BrazeRuby
   module Endpoints
     module SendMessages
       def send_messages(**payload)
-        send_messages_service.new(api_key, braze_url, options, payload).perform
+        send_messages_service.new(api_key, braze_url, options, **payload).perform
       end
 
       private

data/lib/braze_ruby/endpoints/subscription.rb

@@ -4,16 +4,16 @@ module BrazeRuby
   module Endpoints
     module Subscription
       def subscription_status_set(**payload)
-        BrazeRuby::REST::SubscriptionStatusSet.new(api_key, braze_url, options, payload).perform
+        BrazeRuby::REST::SubscriptionStatusSet.new(api_key, braze_url, options, **payload).perform
       end
 
       def subscription_status_get(**payload)
-        BrazeRuby::REST::SubscriptionStatusGet.new(api_key, braze_url, options, payload).perform
+        BrazeRuby::REST::SubscriptionStatusGet.new(api_key, braze_url, options, **payload).perform
       end
 
 
       def subscription_user_status(**payload)
-        BrazeRuby::REST::SubscriptionUserStatus.new(api_key, braze_url, options, payload).perform
+        BrazeRuby::REST::SubscriptionUserStatus.new(api_key, braze_url, options, **payload).perform
       end
     end
   end

data/lib/braze_ruby/endpoints/track_users.rb

@@ -6,25 +6,25 @@ module BrazeRuby
       attr_writer :track_users_service
 
       def track_users(**payload)
-        track_users_service.perform(api_key, payload)
+        track_users_service.perform(**payload)
       end
 
-      def track_purchase(payload)
+      def track_purchase(**payload)
         track_users(purchases: [payload])
       end
 
-      def track_event(payload)
+      def track_event(**payload)
         track_users(events: [payload])
       end
 
-      def track_attribute(payload)
+      def track_attribute(**payload)
         track_users(attributes: [payload])
       end
 
       private
 
       def track_users_service
-        @track_users_service ||= BrazeRuby::REST::TrackUsers.new(braze_url, options)
+        @track_users_service ||= BrazeRuby::REST::TrackUsers.new(api_key, braze_url, options)
       end
     end
   end

data/lib/braze_ruby/http.rb

@@ -7,9 +7,10 @@ module BrazeRuby
   class HTTP
     DEFAULT_TIMEOUT = 30
 
-    def initialize(braze_url, options = {})
+    def initialize(api_key, braze_url, options = {})
+      @api_key   = api_key
       @braze_url = braze_url
-      @options = default_options.merge(options)
+      @options   = default_options.merge(options)
     end
 
     def post(path, payload)
@@ -18,15 +19,16 @@ module BrazeRuby
       end
     end
 
-    def get(path, query)
+    def get(path, query = {})
       connection.get path, query
     end
 
     def connection
       @connection ||= Faraday.new(url: @braze_url) do |connection|
-        connection.headers['Content-Type'] = 'application/json'
-        connection.headers['Accept']       = 'application/json'
-        connection.headers['User-Agent']   = "Braze Ruby gem v#{BrazeRuby::VERSION}"
+        connection.headers["Content-Type"]  = "application/json"
+        connection.headers["Accept"]        = "application/json"
+        connection.headers["User-Agent"]    = "Braze Ruby gem v#{BrazeRuby::VERSION}"
+        connection.headers["Authorization"] = "Bearer #{@api_key}"
 
         connection.response :logger if ENV['BRAZE_RUBY_DEBUG']
 

data/lib/braze_ruby/rest/base.rb

@@ -7,15 +7,16 @@ module BrazeRuby
     class Base
       attr_writer :http
 
-      def initialize(braze_url, options)
+      def initialize(api_key, braze_url, options)
+        @api_key   = api_key
         @braze_url = braze_url
-        @options = options
+        @options   = options
       end
 
       private
 
       def http
-        @http ||= BrazeRuby::HTTP.new(@braze_url, @options)
+        @http ||= BrazeRuby::HTTP.new(@api_key, @braze_url, @options)
       end
     end
   end

data/lib/braze_ruby/rest/canvas_details.rb

@@ -3,17 +3,15 @@
 module BrazeRuby
   module REST
     class CanvasDetails < Base
-      attr_reader :api_key, :params
+      attr_reader :params
 
       def initialize(api_key, braze_url, options, **params)
-        @api_key = api_key
         @params = params
-        super braze_url, options
+        super api_key, braze_url, options
       end
 
       def perform
         http.get('/canvas/details', {
-          'api_key': api_key,
           **@params
         })
       end

data/lib/braze_ruby/rest/delete_users.rb

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

data/lib/braze_ruby/rest/email_hard_bounces.rb

@@ -3,17 +3,15 @@
 module BrazeRuby
   module REST
     class EmailHardBounces < Base
-      attr_reader :api_key, :params
+      attr_reader :params
 
       def initialize(api_key, braze_url, options, **params)
-        @api_key = api_key
         @params = params
-        super braze_url, options
+        super api_key, braze_url, options
       end
 
       def perform
         http.get('/email/hard_bounces', {
-          'api_key': api_key,
           **@params
         })
       end