braze_ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d764aef365cc62df6c6b78c7df64e302e5e662b23d602acaec830f98159e3605
-  data.tar.gz: b5b2affefe873659ef00624c004309b095454479e2324f9923f613e06366212b
+  metadata.gz: e5649f519796cde810f2c2e2028c5a14fbcdfc7c6d93cf33043068fb4195b481
+  data.tar.gz: b81d2eed4f84937c0bd4721318c2474f36e987d97418961fb407744dcee068fb
 SHA512:
-  metadata.gz: 818b213e16dcd5665c9b0029e0d683a9b0631ff49732362fc904ea176e4ff4aa639ebec8b1467e5cf40b313d57b9377fca1074a2f2d47dedc894a93377ae6630
-  data.tar.gz: 149b620b3a6e27b39e4ab34a6f7826e866015a04ba170bdc38e0d66407a0c6518503108edfb60100e4f9a0642591cc1d170fdb609ff678e53f328e1c7a0cbd56
+  metadata.gz: 766e1d5e83222af37ba40d6e1333ea6e350b4e9ae327e943a31dfc60772253368a67fe8048b5ef72681759ce8e1ab13a7bdeb6c77fe92c82f167094881c22830
+  data.tar.gz: a1011b8b5f84bba75a5eae4bb1535d0582788ea10ef838b6821912a05dad3f3abc06bc4033a93004c3554b05ca949d74f40916caa4115f2dc9087cf066f418bf

data/Gemfile.lock

@@ -1,62 +1,64 @@
 PATH
   remote: .
   specs:
-    braze_ruby (0.2.0)
+    braze_ruby (0.2.1)
       faraday
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    dotenv (2.7.2)
+    dotenv (2.7.5)
     factory_bot (5.0.2)
       activesupport (>= 4.2.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    hashdiff (0.3.8)
+    hashdiff (1.0.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
     minitest (5.11.3)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.3)
-    rake (12.3.2)
+    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.0)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.2)
     safe_yaml (1.0.5)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    vcr (4.0.0)
-    webmock (3.5.1)
+    vcr (5.0.0)
+    webmock (3.7.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.1.9)
 
 PLATFORMS
   ruby
@@ -73,4 +75,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/README.md

@@ -112,6 +112,15 @@ api.send_messages(messages: messages, segment_id: '<segment-id>')
 api.schedule_messages(send_at: 1.hour.since, messages: messages, external_user_ids: [123, 456])
 ```
 
+### Send Campaigns
+
+```ruby
+api.trigger_campaign_send(
+  campaign_id: 'campaign-id',
+  recipients: [external_user_id: 123, trigger_properties: {first_name: 'John'}]
+)
+```
+
 ### Changing Email Subscription
 
 ```ruby

data/lib/braze_ruby/api.rb

@@ -5,6 +5,7 @@ require 'braze_ruby/endpoints/schedule_messages'
 require 'braze_ruby/endpoints/email_status'
 require 'braze_ruby/endpoints/email_sync'
 require 'braze_ruby/endpoints/delete_users'
+require 'braze_ruby/endpoints/campaigns'
 
 module BrazeRuby
   class API
@@ -16,6 +17,7 @@ module BrazeRuby
     include BrazeRuby::Endpoints::EmailStatus
     include BrazeRuby::Endpoints::EmailSync
     include BrazeRuby::Endpoints::DeleteUsers
+    include BrazeRuby::Endpoints::Campaigns
 
     def export_users(**payload)
       BrazeRuby::REST::ExportUsers.new(braze_url).perform(api_key, payload)

data/lib/braze_ruby/endpoints/campaigns.rb

@@ -0,0 +1,9 @@
+module BrazeRuby
+  module Endpoints
+    module Campaigns
+      def trigger_campaign_send(**payload)
+        BrazeRuby::REST::TriggerCampaignSend.new(api_key, braze_url, payload).perform
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest.rb

@@ -8,3 +8,4 @@ require 'braze_ruby/rest/email_unsubscribes'
 require 'braze_ruby/rest/export_users'
 require 'braze_ruby/rest/list_segments'
 require 'braze_ruby/rest/delete_users'
+require 'braze_ruby/rest/trigger_campaign_send'

data/lib/braze_ruby/rest/trigger_campaign_send.rb

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

data/lib/braze_ruby/version.rb

@@ -1,3 +1,3 @@
 module BrazeRuby
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

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

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: post
+    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"}}]}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - Braze Ruby gem v0.2.0
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  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:
+      - '250000'
+      X-Ratelimit-Remaining:
+      - '249998'
+      X-Ratelimit-Reset:
+      - '1567425600'
+      X-Request-Id:
+      - e6f14e03-5226-45f3-9a9f-901a0139b071
+      X-Runtime:
+      - '0.019114'
+      Content-Length:
+      - '46'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Mon, 02 Sep 2019 11:41:42 GMT
+      Via:
+      - 1.1 varnish
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-hhn4029-HHN
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1567424502.370259,VS0,VE27
+      Vary:
+      - Origin,Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"success"}'
+    http_version: 
+  recorded_at: Mon, 02 Sep 2019 11:41:42 GMT
+recorded_with: VCR 5.0.0

data/spec/integrations/campaigns_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+RSpec.describe 'campaigns' do
+  describe 'trigger_send' do
+    it 'sends an email', vcr: true do
+      response = api.trigger_campaign_send(
+        campaign_id: '69e9b681-779c-4b4c-b6b8-cd74b17d21d2',
+        recipients: [
+          external_user_id: 132404,
+          trigger_properties: {first_name: 'John'}
+        ]
+      )
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: braze_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Josh Nussbaum
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2019-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,6 +159,7 @@ files:
 - lib/braze_ruby/api.rb
 - lib/braze_ruby/deprecated.rb
 - lib/braze_ruby/endpoints.rb
+- lib/braze_ruby/endpoints/campaigns.rb
 - lib/braze_ruby/endpoints/delete_users.rb
 - lib/braze_ruby/endpoints/email_status.rb
 - lib/braze_ruby/endpoints/email_sync.rb
@@ -177,6 +178,7 @@ files:
 - lib/braze_ruby/rest/schedule_messages.rb
 - lib/braze_ruby/rest/send_messages.rb
 - lib/braze_ruby/rest/track_users.rb
+- lib/braze_ruby/rest/trigger_campaign_send.rb
 - lib/braze_ruby/version.rb
 - spec/braze_ruby/api_spec.rb
 - spec/braze_ruby/endpoints/delete_users_spec.rb
@@ -188,6 +190,7 @@ files:
 - spec/braze_ruby/rest/send_messages_spec.rb
 - spec/braze_ruby/rest/track_users_spec.rb
 - spec/factories.rb
+- spec/fixtures/responses/campaigns/trigger_send/sends_an_email.yml
 - spec/fixtures/responses/delete_users/unauthorized/responds_with_unauthorized.yml
 - spec/fixtures/responses/delete_users/with_success/responds_with_created.yml
 - spec/fixtures/responses/delete_users/with_success/responds_with_success_message.yml
@@ -211,6 +214,7 @@ files:
 - spec/fixtures/responses/track_users/unauthorized/responds_with_unauthorized.yml
 - spec/fixtures/responses/track_users/with_success/responds_with_created.yml
 - spec/fixtures/responses/track_users/with_success/responds_with_success_message.yml
+- spec/integrations/campaigns_spec.rb
 - spec/integrations/delete_users_spec.rb
 - spec/integrations/email_status_spec.rb
 - spec/integrations/email_sync_spec.rb
@@ -244,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A wrapper for the Braze REST API forked from the appboy gem, track users/events/purchases,
@@ -260,6 +264,7 @@ test_files:
 - spec/braze_ruby/rest/send_messages_spec.rb
 - spec/braze_ruby/rest/track_users_spec.rb
 - spec/factories.rb
+- spec/fixtures/responses/campaigns/trigger_send/sends_an_email.yml
 - spec/fixtures/responses/delete_users/unauthorized/responds_with_unauthorized.yml
 - spec/fixtures/responses/delete_users/with_success/responds_with_created.yml
 - spec/fixtures/responses/delete_users/with_success/responds_with_success_message.yml
@@ -283,6 +288,7 @@ test_files:
 - spec/fixtures/responses/track_users/unauthorized/responds_with_unauthorized.yml
 - spec/fixtures/responses/track_users/with_success/responds_with_created.yml
 - spec/fixtures/responses/track_users/with_success/responds_with_success_message.yml
+- spec/integrations/campaigns_spec.rb
 - spec/integrations/delete_users_spec.rb
 - spec/integrations/email_status_spec.rb
 - spec/integrations/email_sync_spec.rb