braze_ruby 0.0.1

data/lib/braze_ruby/rest/email_status.rb

@@ -0,0 +1,22 @@
+module BrazeRuby
+  module REST
+    class EmailStatus < Base
+      attr_reader :api_key, :email, :status
+
+      def initialize(api_key, braze_url, email: nil, status: nil)
+        @api_key = api_key
+        @email = email
+        @status = status
+        super braze_url
+      end
+
+      def perform
+        http.post '/email/status', {
+          'api_key': api_key,
+          'email': email,
+          'subscription_state': status
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/export_users.rb

@@ -0,0 +1,27 @@
+module BrazeRuby
+  module REST
+    class ExportUsers < Base
+      def perform(api_key, external_ids: nil, segment_id: nil, **options)
+        return export_users_by_ids(api_key, external_ids) if external_ids
+
+        export_users_by_segment(api_key, segment_id, options) if segment_id
+      end
+
+      private
+
+      def export_users_by_ids(api_key, external_ids)
+        http.post '/users/export/ids', {
+          'api_key': api_key,
+          'external_ids': external_ids
+        }
+      end
+
+      def export_users_by_segment(api_key, segment_id, options)
+        http.post '/users/export/segment', {
+          'api_key': api_key,
+          'segment_id': segment_id
+        }.merge(options)
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/list_segments.rb

@@ -0,0 +1,11 @@
+module BrazeRuby
+  module REST
+    class ListSegments < Base
+      def perform(api_key)
+        http.get '/segments/list', {
+          'api_key': api_key
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/schedule_messages.rb

@@ -0,0 +1,28 @@
+module BrazeRuby
+  module REST
+    class ScheduleMessages < Base
+      attr_reader :api_key, :time, :messages, :in_local_time, :external_user_ids
+
+      def initialize(api_key, braze_url, time: nil, messages: [], external_user_ids: [], in_local_time: false)
+        @api_key = api_key
+        @messages = messages
+        @time = time
+        @external_user_ids = external_user_ids
+        @in_local_time = in_local_time
+        super braze_url
+      end
+
+      def perform
+        http.post '/messages/schedule/create', {
+          'api_key':                    api_key,
+          'external_user_ids':          external_user_ids,
+          'schedule': {
+            'time':                       time,
+            'in_local_time':              in_local_time
+          },
+          'messages':                   messages
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/send_messages.rb

@@ -0,0 +1,22 @@
+module BrazeRuby
+  module REST
+    class SendMessages < Base
+      attr_reader :api_key, :messages, :external_user_ids
+
+      def initialize(api_key, braze_url, messages: [], external_user_ids: [])
+        @api_key = api_key
+        @messages = messages
+        @external_user_ids = external_user_ids
+        super braze_url
+      end
+
+      def perform
+        http.post '/messages/send', {
+          'api_key':           api_key,
+          'messages':          messages,
+          'external_user_ids': external_user_ids
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest/track_users.rb

@@ -0,0 +1,14 @@
+module BrazeRuby
+  module REST
+    class TrackUsers < Base
+      def perform(api_key, attributes: [], events: [], purchases: [])
+        http.post '/users/track', {
+          'api_key':        api_key,
+          'attributes':     attributes,
+          'events':         events,
+          'purchases':      purchases
+        }
+      end
+    end
+  end
+end

data/lib/braze_ruby/version.rb

@@ -0,0 +1,3 @@
+module BrazeRuby
+  VERSION = '0.0.1'
+end

data/spec/braze_ruby/api_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe BrazeRuby::API do
+end

data/spec/braze_ruby/endpoints/track_users_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+class API
+  include BrazeRuby::Endpoints::TrackUsers
+
+  def api_key
+    :api_key
+  end
+end
+
+describe BrazeRuby::Endpoints::TrackUsers do
+  let(:api) { API.new }
+  let(:track_users_service) { double(:track_users_service) }
+
+  before { api.track_users_service = track_users_service }
+
+  describe '#track_users' do
+    let(:payload) {{
+      attributes: [build(:attribute)],
+      events: [build(:event)],
+      purchases: [build(:purchase)]
+    }}
+
+    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)
+
+      track_users!
+    end
+  end
+
+  describe '#track_purchase' do
+    let(:payload) { build(:purchase) }
+
+    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])
+
+      track_purchase!
+    end
+  end
+
+  describe '#track_event' do
+    let(:payload) { build(:event) }
+
+    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])
+
+      track_event!
+    end
+  end
+
+  describe '#track_attribute' do
+    let(:payload) { build(:attribute) }
+
+    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])
+
+      track_attribute!
+    end
+  end
+end

data/spec/braze_ruby/rest/email_status_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe BrazeRuby::REST::EmailStatus do
+  let(:http) { double(:http) }
+
+  before { subject.http = http }
+
+  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
+    }
+
+    subject.perform
+  end
+end

data/spec/braze_ruby/rest/export_users_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe BrazeRuby::REST::ExportUsers do
+  let(:http) { double(:http) }
+
+  let(:payload) {{ external_ids: external_ids }}
+  let(:external_ids) { [1] }
+
+  subject { described_class.new :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 })
+
+    subject.perform(:api_key, payload)
+  end
+end

data/spec/braze_ruby/rest/schedule_messages_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe BrazeRuby::REST::ScheduleMessages do
+  let(:http) { double(:http) }
+
+  let(:payload) {{
+    external_user_ids: :external_user_ids,
+    time: :time,
+    in_local_time: :in_local_time,
+    messages: :messages
+  }}
+
+  let(:api_key) { :api_key }
+
+  subject { described_class.new(api_key, :rest_url, payload) }
+
+  before { subject.http = http }
+
+  it 'makes an http call to the schedule messages endpoint' do
+    expect_schedule_messages_http_call
+
+    subject.perform
+  end
+
+  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,
+        in_local_time: :in_local_time
+      },
+      messages: :messages
+    }
+  end
+end

data/spec/braze_ruby/rest/send_messages_spec.rb

@@ -0,0 +1,33 @@
+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
+  ) }
+
+  before { subject.http = http }
+
+  it 'makes an http call to the send messages endpoint' do
+    expect_send_messages_http_call
+
+    subject.perform
+  end
+
+  def expect_send_messages_http_call
+    expect(http).to receive(:post).with '/messages/send', {
+      api_key: :api_key,
+      messages: [],
+      external_user_ids: [],
+    }
+  end
+end

data/spec/braze_ruby/rest/track_users_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe BrazeRuby::REST::TrackUsers do
+  let(:http) { double(:http) }
+
+  let(:payload) {{
+    attributes: :attributes,
+    events: :events,
+    purchases: :purchases
+  }}
+
+  let(:api_key) { :api_key }
+
+  subject { described_class.new :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 })
+
+    subject.perform(api_key, payload)
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,36 @@
+FactoryBot.define do
+  factory :attribute, class: Hash do
+    skip_create
+    external_id 1
+    foo :bar
+
+    initialize_with { attributes }
+  end
+
+  factory :event, class: Hash do
+    skip_create
+    external_id 1
+    name :baz
+    time Time.now
+
+    initialize_with { attributes }
+  end
+
+  factory :purchase, class: Hash do
+    skip_create
+    external_id 1
+    product_id 1
+    time Time.now
+    currency 'CAD'
+    price 1.0
+
+    initialize_with { attributes }
+  end
+
+  factory :messages, class: Hash do
+    skip_create
+    apple_push({ alert: :hello })
+
+    initialize_with { attributes }
+  end
+end

data/spec/fixtures/responses/email_status/existing_email/responds_with_created.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<BRAZE_REST_URL>/email/status"
+    body:
+      encoding: UTF-8
+      string: '{"api_key":"<BRAZE_REST_API_KEY>","email":"john@example.com","subscription_state":"unsubscribed"}'
+    headers:
+      User-Agent:
+      - Faraday v0.14.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json
+      Etag:
+      - W/"838a7c62adda8d131d694ae13ba2c5b7"
+      Server:
+      - nginx
+      Strict-Transport-Security:
+      - max-age=0; includeSubDomains
+      - max-age=31536000; includeSubDomains
+      X-Ratelimit-Limit:
+      - '50000'
+      X-Ratelimit-Remaining:
+      - '49999'
+      X-Ratelimit-Reset:
+      - '1524002400'
+      X-Request-Id:
+      - 24433bbb-89d6-4bd3-918f-46e7865d383e
+      X-Runtime:
+      - '0.034502'
+      Content-Length:
+      - '46'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Tue, 17 Apr 2018 21:08:19 GMT
+      Via:
+      - 1.1 varnish
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-pdk17830-PDK
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1523999299.770713,VS0,VE230
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"success"}'
+    http_version: 
+  recorded_at: Tue, 17 Apr 2018 21:08:19 GMT
+recorded_with: VCR 4.0.0