appboy 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2539aee6f4676b905088a742fd7f4483940c1dd92357bb90b80429c9c8f39be
-  data.tar.gz: f50416d403099d46c0756415e532f0bf756a63bcc81ed46a5c6f7d1738e2e303
+  metadata.gz: 40adbe58a4c6aa0fc54d42723bd422307cb4a07ca7d4b9c6eeb4c0832c03ba61
+  data.tar.gz: 970578c0bae8fe4486fe6ba5c183573fc8bdcac07e9dc5affd17d5b01abfea4d
 SHA512:
-  metadata.gz: 86539b94ede05d465e58499621ed49b10779a2bf3ecf4c6d175f0cd7c03c1987b5c03122a7d0b1ad09cee2d1b5e2fd7e2a0359d15ea78588a6cf9a11ce667495
-  data.tar.gz: 2a95b92212b4e434257edf59c5c0dd18287b328c6222c14da6a5b31b1f3616398ee4556d61af1dae894146b1a3c2b113c475f4a2ef9bed6a32cac6fd2d745dd8
+  metadata.gz: 38e72090668868edad059635cf35d74087a97cfe653e9e5d5abeb61e5b51ddc6e6b9cd28bae8f43f06658539c69debb0bac3f1af7b67dc619f8b6bdbbc8f77b9
+  data.tar.gz: 99f58e65afbd21443d00602d343e8e79dce2178d5b848fcd5af752eed69adc90ef86b83c12a870ec3f2528ac90f61dee68a5867818ad86033c1624828b7ce01e

data/README.md

@@ -27,12 +27,12 @@ api = Appboy::API.new('<app-group-id>')
 By default Appboy will be using 'https://api.appboy.com' as the default REST API base url, but you can override this base url by setting the env variable `APPBOY_REST_BASE_URL`. E.G.
 
 ```
-APPBOY_REST_BASE_URL="https://rest.iad-01.braze.com" 
+APPBOY_REST_BASE_URL="https://rest.iad-01.braze.com"
 ```
 
 ### Track User Attributes
 
-See: [User Attributes Object Specification](https://documentation.appboy.com/REST_APIs/User_Data#user-attribute-object)
+See: [User Attributes Object Specification](https://www.braze.com/documentation/REST_API/#user-attributes-object-specification)
 
 ```ruby
 api.track_users(attributes: [{
@@ -52,7 +52,7 @@ api.track_attribute(external_id: 123, first_name: 'John', ...)
 
 ### Track Event
 
-See: [Event Object Specification](https://documentation.appboy.com/REST_APIs/User_Data#event-object)
+See: [Event Object Specification](https://www.braze.com/documentation/REST_API/#event-object-specification)
 
 ```ruby
 api.track_users(events: [{
@@ -70,7 +70,7 @@ api.track_event(external_id: 123, name: 'Event', ...)
 
 ### Track Purchase
 
-See: [Purchase Object Specfication](https://documentation.appboy.com/REST_APIs/User_Data#purchase-object)
+See: [Purchase Object Specfication](https://www.braze.com/documentation/REST_API/#purchase-object-specification)
 
 ```ruby
 api.track_users(purchases: [{
@@ -96,7 +96,7 @@ api.track_users(purchases: purchases, events: events, attributes: attributes)
 
 ### Send Message
 
-See: [Platform Push Object Specifications](https://documentation.appboy.com/REST_APIs/Messaging#platform-push-object)
+See: [Platform Push Object Specifications](https://www.braze.com/documentation/REST_API/#messaging)
 
 ##### Messages Payload
 
@@ -119,10 +119,39 @@ api.send_messages(messages: messages, external_user_ids: [123, 456])
 api.send_messages(messages: messages, segment_id: '<segment-id>')
 ```
 
+### Triggered Delivery Messages
+
+See: [Sending Messages via API Triggered Delivery](https://www.braze.com/documentation/REST_API/#sending-messages-via-api-triggered-delivery)
+
+##### Option A, Using Campaign ID
+```ruby
+api.trigger_campaign(
+  api_key: (required, string),
+  campaign_id: (required, string),
+  send_id: (optional, string),
+  audience: (optional, string),
+  trigger_properties: (optional, object),
+  broadcast: (optional, boolean, default, false),
+  recipients: (optional, array of recipient objects)
+)
+```
+
+##### Option B, Using Canvas ID
+
+```ruby
+api.trigger_canvas(
+  api_key: (required, string),
+  campaign_id: (required, string),
+  audience: (optional, string),
+  canvas_entry_properties: (optional, object),
+  broadcast: (optional, boolean, default, false),
+  recipients: (optional, array of recipient objects)
+)
+```
 
 ### Schedule Message
 
-See: [Platform Push Object Specifications](https://documentation.appboy.com/REST_APIs/Messaging#platform-push-object)
+See: [Platform Push Object Specifications](https://www.braze.com/documentation/REST_API/#schedule-api-triggered-campaigns-and-canvases)
 
 ```ruby
 api.schedule_messages(send_at: 1.hour.since, messages: messages, segment_id: '<segment-id>')
@@ -130,7 +159,7 @@ api.schedule_messages(send_at: 1.hour.since, messages: messages, segment_id: '<s
 
 ### Changing Email Subscription
 
-See: [Changing Email Subscription Status](https://documentation.appboy.com/REST_APIs/Email_Sync#post)
+See: [Changing Email Subscription Status](https://www.braze.com/documentation/REST_API/#email-sync)
 
 ```ruby
 api.email_status(email: 'john@example.com', status: :opted_in)
@@ -138,7 +167,7 @@ api.email_status(email: 'john@example.com', status: :opted_in)
 
 ### List Segments
 
-See: [Segment Export](https://documentation.appboy.com/REST_APIs/Export)
+See: [Segment Export](https://www.braze.com/documentation/REST_API/#segment-export)
 
 ```ruby
 api.list_segments
@@ -146,7 +175,7 @@ api.list_segments
 
 ### Export Users
 
-See: [User Export](https://documentation.appboy.com/REST_APIs/Export#user-export)
+See: [User Export](https://www.braze.com/documentation/REST_API/#user-export)
 
 #### By IDs
 

data/lib/appboy/api.rb

@@ -4,6 +4,8 @@ require 'appboy/endpoints/delete_users'
 require 'appboy/endpoints/send_messages'
 require 'appboy/endpoints/schedule_messages'
 require 'appboy/endpoints/email_status'
+require 'appboy/endpoints/trigger_campaign'
+require 'appboy/endpoints/trigger_canvas'
 
 module Appboy
   class API
@@ -14,6 +16,8 @@ module Appboy
     include Appboy::Endpoints::SendMessages
     include Appboy::Endpoints::ScheduleMessages
     include Appboy::Endpoints::EmailStatus
+    include Appboy::Endpoints::TriggerCampaign
+    include Appboy::Endpoints::TriggerCanvas
 
     def export_users(**payload)
       Appboy::REST::ExportUsers.new.perform(app_group_id, payload)

data/lib/appboy/endpoints/trigger_campaign.rb

@@ -0,0 +1,15 @@
+module Appboy
+  module Endpoints
+    module TriggerCampaign
+      def trigger_campaign(**payload)
+        trigger_campaign_service.new(app_group_id, payload).perform
+      end
+
+      private
+
+      def trigger_campaign_service
+        Appboy::REST::TriggerCampaign
+      end
+    end
+  end
+end

data/lib/appboy/endpoints/trigger_canvas.rb

@@ -0,0 +1,15 @@
+module Appboy
+  module Endpoints
+    module TriggerCanvas
+      def trigger_canvas(**payload)
+        trigger_canvas_service.new(app_group_id, payload).perform
+      end
+
+      private
+
+      def trigger_canvas_service
+        Appboy::REST::TriggerCanvas
+      end
+    end
+  end
+end

data/lib/appboy/rest.rb

@@ -6,3 +6,5 @@ require 'appboy/rest/schedule_messages'
 require 'appboy/rest/email_status'
 require 'appboy/rest/export_users'
 require 'appboy/rest/list_segments'
+require 'appboy/rest/trigger_campaign'
+require 'appboy/rest/trigger_canvas'

data/lib/appboy/rest/trigger_campaign.rb

@@ -0,0 +1,30 @@
+module Appboy
+  module REST
+    class TriggerCampaign < Base
+      attr_reader :api_key, :audience, :broadcast, :campaign_id,
+                  :recipients, :send_id, :trigger_properties
+
+      def initialize(api_key, options = {})
+        @api_key            = api_key
+        @audience           = options[:audience]
+        @broadcast          = options[:broadcast] || false
+        @campaign_id        = options[:campaign_id]
+        @recipients         = options[:recipients]
+        @send_id            = options[:send_id]
+        @trigger_properties = options[:trigger_properties]
+      end
+
+      def perform
+        http.post '/campaigns/trigger/send', {
+          api_key:            api_key,
+          audience:           audience,
+          broadcast:          broadcast,
+          campaign_id:        campaign_id,
+          recipients:         recipients,
+          send_id:            send_id,
+          trigger_properties: trigger_properties
+        }.compact
+      end
+    end
+  end
+end

data/lib/appboy/rest/trigger_canvas.rb

@@ -0,0 +1,28 @@
+module Appboy
+  module REST
+    class TriggerCanvas < Base
+      attr_reader :api_key, :audience, :broadcast, :canvas_id,
+                  :canvas_entry_properties, :recipients
+
+      def initialize(app_group_id, options = {})
+        @api_key                 = app_group_id
+        @audience                = options[:audience]
+        @broadcast               = options[:broadcast] || false
+        @canvas_entry_properties = options[:canvas_entry_properties]
+        @canvas_id               = options[:canvas_id]
+        @recipients              = options[:recipients]
+      end
+
+      def perform
+        http.post '/canvas/trigger/send', {
+          api_key:                 api_key,
+          audience:                audience,
+          broadcast:               broadcast,
+          canvas_entry_properties: canvas_entry_properties,
+          canvas_id:               canvas_id,
+          recipients:              recipients
+        }.compact
+      end
+    end
+  end
+end

data/lib/appboy/version.rb

@@ -1,3 +1,3 @@
 module Appboy
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/spec/appboy/endpoints/trigger_campaigns_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'appboy/endpoints/trigger_campaign'
+
+class API
+  include Appboy::Endpoints::TriggerCampaign
+
+  def app_group_id
+    :api_key
+  end
+end
+
+describe 'Appboy::Endpoints::TriggerCampaign' do
+  let(:api) { API.new }
+  let(:performer) do
+    instance_double 'Appboy::REST::TriggerCampaign'
+  end
+
+  before do
+    allow(api.send(:trigger_campaign_service))
+      .to receive(:new).and_return(performer)
+    allow(performer).to receive(:perform).and_return true
+  end
+
+  describe '#trigger_campaign_service', vcr: true do
+    let(:payload) do
+      {
+        audience: :audience,
+        broadcast: :broadcast,
+        campaign_id: :campaign_id,
+        recipients: :recipients,
+        send_id: :send_id,
+        trigger_properties: :trigger_properties
+      }
+    end
+
+    subject(:trigger_campaign!) do
+      api.trigger_campaign(payload)
+    end
+
+    it 'sends a campaign message with recipients' do
+      expect(api.send(:trigger_campaign_service))
+        .to receive(:new).with(:api_key, payload)
+
+      trigger_campaign!
+    end
+  end
+end

data/spec/appboy/endpoints/trigger_canvas_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'appboy/endpoints/trigger_canvas'
+
+class API
+  include Appboy::Endpoints::TriggerCanvas
+
+  def app_group_id
+    :api_key
+  end
+end
+
+describe Appboy::Endpoints::TriggerCanvas do
+  let(:api) { API.new }
+  let(:performer) do
+    instance_double "Appboy::REST::TriggerCanvas"
+  end
+
+  before do
+    allow(api.send(:trigger_canvas_service))
+      .to receive(:new).and_return(performer)
+    allow(performer).to receive(:perform).and_return true
+  end
+
+  describe '#trigger_canvas_service', vcr: true do
+    let(:payload) do
+      {
+        audience: :audience,
+        broadcast: :broadcast,
+        canvas_entry_properties: :canvas_entry_properties,
+        canvas_id: :canvas_id,
+        recipients: :recipients,
+        send_id: :send_id
+      }
+    end
+
+    subject(:trigger_canvas!) do
+      api.trigger_canvas(payload)
+    end
+
+    it 'sends a canvas message with recipients' do
+      expect(api.send(:trigger_canvas_service))
+        .to receive(:new).with(:api_key, payload)
+
+      trigger_canvas!
+    end
+  end
+end

data/spec/appboy/rest/trigger_campaign_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Appboy::REST::TriggerCampaign do
+  let(:http) { double(:http) }
+
+  let(:payload) do
+    {
+      audience: :audience,
+      broadcast: :broadcast,
+      campaign_id: :campaign_id,
+      recipients: :recipients,
+      send_id: :send_id,
+      trigger_properties: :trigger_properties
+    }
+  end
+
+  let(:api_key) { :api_key }
+
+  subject do
+    described_class.new(
+      api_key,
+      audience: :audience,
+      broadcast: :broadcast,
+      campaign_id: :campaign_id,
+      recipients: :recipients,
+      send_id: :send_id,
+      trigger_properties: :trigger_properties
+    )
+  end
+
+  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 '/campaigns/trigger/send', {
+      api_key: :api_key,
+      audience: :audience,
+      broadcast: :broadcast,
+      campaign_id: :campaign_id,
+      recipients: :recipients,
+      send_id: :send_id,
+      trigger_properties: :trigger_properties
+    }
+  end
+end

data/spec/appboy/rest/trigger_canvas_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Appboy::REST::TriggerCanvas do
+  let(:http) { double(:http) }
+
+  let(:payload) do
+    {
+      audience: :audience,
+      broadcast: :broadcast,
+      canvas_id: :canvas_id,
+      canvas_entry_properties: :canvas_entry_properties,
+      recipients: :recipients
+    }
+  end
+
+  let(:api_key) { :api_key }
+
+  subject do
+    described_class.new(
+      api_key,
+      audience: :audience,
+      broadcast: :broadcast,
+      canvas_id: :canvas_id,
+      canvas_entry_properties: :canvas_entry_properties,
+      recipients: :recipients
+    )
+  end
+
+  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 '/canvas/trigger/send', {
+      api_key: :api_key,
+      audience: :audience,
+      broadcast: :broadcast,
+      canvas_id: :canvas_id,
+      canvas_entry_properties: :canvas_entry_properties,
+      recipients: :recipients
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appboy
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Josh Nussbaum
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -202,6 +202,8 @@ files:
 - lib/appboy/endpoints/schedule_messages.rb
 - lib/appboy/endpoints/send_messages.rb
 - lib/appboy/endpoints/track_users.rb
+- lib/appboy/endpoints/trigger_campaign.rb
+- lib/appboy/endpoints/trigger_canvas.rb
 - lib/appboy/http.rb
 - lib/appboy/rest.rb
 - lib/appboy/rest/base.rb
@@ -212,9 +214,13 @@ files:
 - lib/appboy/rest/schedule_messages.rb
 - lib/appboy/rest/send_messages.rb
 - lib/appboy/rest/track_users.rb
+- lib/appboy/rest/trigger_campaign.rb
+- lib/appboy/rest/trigger_canvas.rb
 - lib/appboy/version.rb
 - spec/appboy/api_spec.rb
 - spec/appboy/endpoints/track_users_spec.rb
+- spec/appboy/endpoints/trigger_campaigns_spec.rb
+- spec/appboy/endpoints/trigger_canvas_spec.rb
 - spec/appboy/http_spec.rb
 - spec/appboy/rest/delete_users_spec.rb
 - spec/appboy/rest/email_status_spec.rb
@@ -222,6 +228,8 @@ files:
 - spec/appboy/rest/schedule_messages_spec.rb
 - spec/appboy/rest/send_messages_spec.rb
 - spec/appboy/rest/track_users_spec.rb
+- spec/appboy/rest/trigger_campaign_spec.rb
+- spec/appboy/rest/trigger_canvas_spec.rb
 - spec/factories.rb
 - spec/fixtures/responses/delete_users/unauthorized/responds_with_unauthorized.yml
 - spec/fixtures/responses/delete_users/with_success/responds_with_created.yml
@@ -282,6 +290,8 @@ summary: A wrapper for the Appboy REST API, track users/events/purchases, send &
 test_files:
 - spec/appboy/api_spec.rb
 - spec/appboy/endpoints/track_users_spec.rb
+- spec/appboy/endpoints/trigger_campaigns_spec.rb
+- spec/appboy/endpoints/trigger_canvas_spec.rb
 - spec/appboy/http_spec.rb
 - spec/appboy/rest/delete_users_spec.rb
 - spec/appboy/rest/email_status_spec.rb
@@ -289,6 +299,8 @@ test_files:
 - spec/appboy/rest/schedule_messages_spec.rb
 - spec/appboy/rest/send_messages_spec.rb
 - spec/appboy/rest/track_users_spec.rb
+- spec/appboy/rest/trigger_campaign_spec.rb
+- spec/appboy/rest/trigger_canvas_spec.rb
 - spec/factories.rb
 - spec/fixtures/responses/delete_users/unauthorized/responds_with_unauthorized.yml
 - spec/fixtures/responses/delete_users/with_success/responds_with_created.yml