braze_ruby 0.2.1 → 0.4.0

data/lib/braze_ruby/rest/track_users.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class TrackUsers < Base
-      def perform(api_key, attributes: [], events: [], purchases: [])
+      def perform(attributes: [], events: [], purchases: [])
         http.post '/users/track', {
-          'api_key':        api_key,
           'attributes':     attributes,
           'events':         events,
           'purchases':      purchases

data/lib/braze_ruby/rest/trigger_campaign_send.rb

@@ -1,19 +1,17 @@
+# frozen_string_literal: true
+
 module BrazeRuby
   module REST
     class TriggerCampaignSend < Base
-      attr_reader :api_key, :params
+      attr_reader :params
 
-      def initialize(api_key, braze_url, **params)
-        @api_key = api_key
+      def initialize(api_key, braze_url, options, **params)
         @params = params
-        super braze_url
+        super api_key, braze_url, options
       end
 
       def perform
-        http.post('/campaigns/trigger/send', {
-          'api_key': api_key,
-          **@params
-        })
+        http.post('/campaigns/trigger/send', @params)
       end
     end
   end

data/lib/braze_ruby/rest/trigger_canvas_send.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BrazeRuby
+  module REST
+    class TriggerCanvasSend < 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('/canvas/trigger/send', {
+          **@params
+        })
+      end
+    end
+  end
+end

data/lib/braze_ruby/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BrazeRuby
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/spec/braze_ruby/api_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe BrazeRuby::API do

data/spec/braze_ruby/endpoints/delete_users_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 class API
@@ -21,7 +23,7 @@ describe BrazeRuby::Endpoints::DeleteUsers do
 
     it 'deletes users' do
       expect(delete_users_service).to receive(:perform)
-        .with(:api_key, external_ids: payload)
+        .with(external_ids: payload)
 
       delete_users!
     end

data/spec/braze_ruby/endpoints/track_users_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 class API
@@ -21,11 +23,11 @@ describe BrazeRuby::Endpoints::TrackUsers do
       purchases: [build(:purchase)]
     }}
 
-    subject(:track_users!) { api.track_users(payload) }
+    subject(:track_users!) { api.track_users(**payload) }
 
     it 'tracks attributes, events and purchases' do
       expect(track_users_service).to receive(:perform)
-        .with(:api_key, payload)
+        .with(payload)
 
       track_users!
     end
@@ -34,11 +36,11 @@ describe BrazeRuby::Endpoints::TrackUsers do
   describe '#track_purchase' do
     let(:payload) { build(:purchase) }
 
-    subject(:track_purchase!) { api.track_purchase(payload) }
+    subject(:track_purchase!) { api.track_purchase(**payload) }
 
     it 'tracks a single purchase' do
       expect(track_users_service).to receive(:perform)
-        .with(:api_key, purchases: [payload])
+        .with(purchases: [payload])
 
       track_purchase!
     end
@@ -47,11 +49,11 @@ describe BrazeRuby::Endpoints::TrackUsers do
   describe '#track_event' do
     let(:payload) { build(:event) }
 
-    subject(:track_event!) { api.track_event(payload) }
+    subject(:track_event!) { api.track_event(**payload) }
 
     it 'tracks a single purchase' do
       expect(track_users_service).to receive(:perform)
-        .with(:api_key, events: [payload])
+        .with(events: [payload])
 
       track_event!
     end
@@ -60,11 +62,11 @@ describe BrazeRuby::Endpoints::TrackUsers do
   describe '#track_attribute' do
     let(:payload) { build(:attribute) }
 
-    subject(:track_attribute!) { api.track_attribute(payload) }
+    subject(:track_attribute!) { api.track_attribute(**payload) }
 
     it 'tracks a single purchase' do
       expect(track_users_service).to receive(:perform)
-          .with(:api_key, attributes: [payload])
+          .with(attributes: [payload])
 
       track_attribute!
     end

data/spec/braze_ruby/http_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'braze_ruby/http'
+
+describe BrazeRuby::HTTP do
+  describe "#connection" do
+    let(:options) { double("options", :"[]=" => nil) }
+    let(:headers) { double("headers", :"[]=" => nil) }
+    let(:conn) { double("conn", adapter: nil, options: options, headers: headers) }
+    let(:api_key) { "braze-api-key" }
+    let(:braze_url) { "http://example.com" }
+
+    before :each do
+      allow(Faraday).to receive(:new).and_yield(conn)
+      allow(Faraday).to receive(:default_adapter).and_return(:default_adapter)
+    end
+
+    it "it defaults to the timeout option" do
+      described_class.new(api_key, braze_url).connection
+
+      expect(options).to have_received(:"[]=").with(:timeout, described_class::DEFAULT_TIMEOUT)
+    end
+
+    it "it sets the default timeout option when given" do
+      timeout = 5
+      described_class.new(api_key, braze_url, {timeout: timeout}).connection
+
+      expect(options).to have_received(:"[]=").with(:timeout, timeout)
+    end
+
+    it "sets the headers" do
+      described_class.new(api_key, braze_url).connection
+
+
+      expect(headers).to have_received(:"[]=").with("Content-Type", "application/json")
+      expect(headers).to have_received(:"[]=").with("Accept", "application/json")
+      expect(headers).to have_received(:"[]=").with("User-Agent", "Braze Ruby gem v#{BrazeRuby::VERSION}")
+      expect(headers).to have_received(:"[]=").with("Authorization", "Bearer braze-api-key")
+    end
+
+    it "it sets the default adapter" do
+      described_class.new(api_key, braze_url).connection
+
+      expect(conn).to have_received(:adapter).with(:default_adapter)
+    end
+  end
+end

data/spec/braze_ruby/rest/delete_users_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe BrazeRuby::REST::DeleteUsers do
@@ -7,14 +9,14 @@ describe BrazeRuby::REST::DeleteUsers do
 
   let(:api_key) { :api_key }
 
-  subject { described_class.new :rest_url}
+  subject { described_class.new :api_key, :rest_url, {}}
 
   before { subject.http = http }
 
   it 'makes an http call to the delete user endpoint' do
     expect(http).to receive(:post).with '/users/delete',
-        payload.merge({ api_key: :api_key })
+        payload
 
-    subject.perform(api_key, payload)
+    subject.perform(**payload)
   end
 end

data/spec/braze_ruby/rest/email_status_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe BrazeRuby::REST::EmailStatus do
@@ -5,11 +7,10 @@ describe BrazeRuby::REST::EmailStatus do
 
   before { subject.http = http }
 
-  subject { described_class.new(:api_key, :rest_url, email: :email, status: :status) }
+  subject { described_class.new(:api_key, :rest_url, {}, email: :email, status: :status) }
 
   it 'makes an http call to the email status endpoint' do
     expect(http).to receive(:post).with '/email/status', {
-      api_key: :api_key,
       email: :email,
       subscription_state: :status
     }

data/spec/braze_ruby/rest/export_users_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe BrazeRuby::REST::ExportUsers do
@@ -6,14 +8,14 @@ describe BrazeRuby::REST::ExportUsers do
   let(:payload) {{ external_ids: external_ids }}
   let(:external_ids) { [1] }
 
-  subject { described_class.new :rest_url }
+  subject { described_class.new :api_key, :rest_url, {} }
 
   before { subject.http = http }
 
   it 'makes an http call to the track user endpoint' do
     expect(http).to receive(:post).with '/users/export/ids',
-        payload.merge({ api_key: :api_key })
+        payload
 
-    subject.perform(:api_key, payload)
+    subject.perform(**payload)
   end
 end

data/spec/braze_ruby/rest/identify_users_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BrazeRuby::REST::IdentifyUsers do
+  let(:http) { double(:http) }
+
+  let(:payload) { {aliases_to_identify: [user]} }
+  let(:user) { { external_id: 123, user_alias: { alias_name: 'abc', alias_label: 'foo' } } }
+
+  let(:api_key) { :api_key }
+
+  subject { described_class.new :api_key, :rest_url, {}}
+
+  before { subject.http = http }
+
+  it 'makes an http call to the identify users endpoint' do
+    expect(http).to receive(:post).with '/users/identify',
+        payload
+
+    subject.perform(**payload)
+  end
+end

data/spec/braze_ruby/rest/schedule_messages_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe BrazeRuby::REST::ScheduleMessages do
@@ -12,7 +14,7 @@ describe BrazeRuby::REST::ScheduleMessages do
 
   let(:api_key) { :api_key }
 
-  subject { described_class.new(api_key, :rest_url, payload) }
+  subject { described_class.new(api_key, :rest_url, {}, **payload) }
 
   before { subject.http = http }
 
@@ -24,7 +26,6 @@ describe BrazeRuby::REST::ScheduleMessages do
 
   def expect_schedule_messages_http_call
     expect(http).to receive(:post).with '/messages/schedule/create', {
-      api_key: api_key,
       external_user_ids: :external_user_ids,
       schedule: {
         time: :time,

data/spec/braze_ruby/rest/send_messages_spec.rb

@@ -1,18 +1,16 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe BrazeRuby::REST::SendMessages do
   let(:http) { double(:http) }
 
-  let(:payload) {{
-    messages: :messages,
-    external_user_ids: :external_user_ids,
-  }}
-
-  let(:api_key) { :api_key }
-
-  subject { described_class.new(api_key,
-    messages: :messages,
-    external_user_ids: :external_user_ids
+  subject { described_class.new(
+    :api_key,
+    :rest_url,
+    {},
+    messages: ["message"],
+    external_user_ids: ["1", "2"]
   ) }
 
   before { subject.http = http }
@@ -25,9 +23,8 @@ describe BrazeRuby::REST::SendMessages do
 
   def expect_send_messages_http_call
     expect(http).to receive(:post).with '/messages/send', {
-      api_key: :api_key,
-      messages: [],
-      external_user_ids: [],
+      messages: ["message"],
+      external_user_ids: ["1", "2"],
     }
   end
 end

data/spec/braze_ruby/rest/track_users_spec.rb

@@ -1,24 +1,27 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe BrazeRuby::REST::TrackUsers do
   let(:http) { double(:http) }
 
-  let(:payload) {{
-    attributes: :attributes,
-    events: :events,
-    purchases: :purchases
-  }}
+  let(:payload) do
+    {
+      attributes: :attributes,
+      events: :events,
+      purchases: :purchases
+    }
+  end
 
   let(:api_key) { :api_key }
 
-  subject { described_class.new :rest_url}
+  subject { described_class.new :api_key, :rest_url, {}}
 
   before { subject.http = http }
 
   it 'makes an http call to the track user endpoint' do
-    expect(http).to receive(:post).with '/users/track',
-        payload.merge({ api_key: :api_key })
+    expect(http).to receive(:post).with '/users/track', payload
 
-    subject.perform(api_key, payload)
+    subject.perform(**payload)
   end
 end

data/spec/factories.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   factory :attribute, class: Hash do
     skip_create

data/spec/fixtures/responses/campaigns/trigger_send/sends_an_email.yml

@@ -5,14 +5,16 @@ http_interactions:
     uri: "<BRAZE_REST_URL>/campaigns/trigger/send"
     body:
       encoding: UTF-8
-      string: '{"api_key":"<BRAZE_REST_API_KEY>","campaign_id":"69e9b681-779c-4b4c-b6b8-cd74b17d21d2","recipients":[{"external_user_id":132404,"trigger_properties":{"first_name":"John"}}]}'
+      string: '{"campaign_id":"d8b73da7-0b7c-fc72-1d80-e59c7f20f0d3","recipients":[{"external_user_id":12345,"trigger_properties":{"first_name":"John"}}]}'
     headers:
       Content-Type:
       - application/json
       Accept:
       - application/json
       User-Agent:
-      - Braze Ruby gem v0.2.0
+      - Braze Ruby gem v0.3.3
+      Authorization:
+      - Bearer <BRAZE_REST_API_KEY>
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
   response:
@@ -20,12 +22,16 @@ http_interactions:
       code: 201
       message: Created
     headers:
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '94'
       Cache-Control:
       - max-age=0, private, must-revalidate
       Content-Type:
       - application/json
       Etag:
-      - W/"838a7c62adda8d131d694ae13ba2c5b7"
+      - W/"b02a5788c87daf846d9cf451bf7f4e6d"
       Server:
       - nginx
       Strict-Transport-Security:
@@ -36,34 +42,30 @@ http_interactions:
       X-Ratelimit-Remaining:
       - '249998'
       X-Ratelimit-Reset:
-      - '1567425600'
+      - '1592427600'
       X-Request-Id:
-      - e6f14e03-5226-45f3-9a9f-901a0139b071
+      - ab80a33e-db36-4fe9-af89-6ce274df5edc
       X-Runtime:
-      - '0.019114'
-      Content-Length:
-      - '46'
+      - '0.016803'
       Accept-Ranges:
       - bytes
       Date:
-      - Mon, 02 Sep 2019 11:41:42 GMT
+      - Wed, 17 Jun 2020 20:04:46 GMT
       Via:
       - 1.1 varnish
-      Connection:
-      - keep-alive
       X-Served-By:
-      - cache-hhn4029-HHN
+      - cache-hhn4039-HHN
       X-Cache:
       - MISS
       X-Cache-Hits:
       - '0'
       X-Timer:
-      - S1567424502.370259,VS0,VE27
+      - S1592424287.720589,VS0,VE19
       Vary:
       - Origin,Accept-Encoding
     body:
       encoding: ASCII-8BIT
-      string: '{"message":"success"}'
+      string: '{"dispatch_id":"14497aa4b013bf150881547fb3076fd6","message":"success"}'
     http_version: 
-  recorded_at: Mon, 02 Sep 2019 11:41:42 GMT
+  recorded_at: Wed, 17 Jun 2020 20:04:46 GMT
 recorded_with: VCR 5.0.0