braze_ruby 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5649f519796cde810f2c2e2028c5a14fbcdfc7c6d93cf33043068fb4195b481
-  data.tar.gz: b81d2eed4f84937c0bd4721318c2474f36e987d97418961fb407744dcee068fb
+  metadata.gz: adcffccc751c8231b0084d858454d36d5b3a034b128bd4c7c7d72e5867a27b4b
+  data.tar.gz: 2e0bf1111244eb7c356f7b8b9edcf9cf146c7f38cf3687f771b9d45953fb4925
 SHA512:
-  metadata.gz: 766e1d5e83222af37ba40d6e1333ea6e350b4e9ae327e943a31dfc60772253368a67fe8048b5ef72681759ce8e1ab13a7bdeb6c77fe92c82f167094881c22830
-  data.tar.gz: a1011b8b5f84bba75a5eae4bb1535d0582788ea10ef838b6821912a05dad3f3abc06bc4033a93004c3554b05ca949d74f40916caa4115f2dc9087cf066f418bf
+  metadata.gz: ae3ccf92edd2f7f82c31812964eba85a57af09f1bf944338491f03bcc2d8e5831f7c21594a7e07a2aa5df8f0f1d732721d3aa7b9147c9380c0f3c4178f99c7e0
+  data.tar.gz: 9c1046684d733a8aab55c2a65a97ff950340df129c44472089424f4a43099609975c96770d39c8a3a896cd05868867ea8b203d7f2f27a5c90204634af6c23ba3

data/.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake spec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    braze_ruby (0.2.1)
+    braze_ruby (0.2.2)
       faraday
 
 GEM
@@ -21,7 +21,7 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     dotenv (2.7.5)
-    factory_bot (5.0.2)
+    factory_bot (5.1.0)
       activesupport (>= 4.2.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
@@ -29,7 +29,7 @@ GEM
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     method_source (0.9.2)
-    minitest (5.11.3)
+    minitest (5.12.0)
     multipart-post (2.1.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -54,11 +54,11 @@ GEM
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     vcr (5.0.0)
-    webmock (3.7.1)
+    webmock (3.7.5)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.1.9)
+    zeitwerk (2.1.10)
 
 PLATFORMS
   ruby

data/README.md

@@ -121,6 +121,15 @@ api.trigger_campaign_send(
 )
 ```
 
+### Send Canvas
+
+```ruby
+api.trigger_canvas_send(
+  canvas_id: 'canvas-id',
+  recipients: [external_user_id: 123, canvas_entry_properties: {first_name: 'John'}]
+)
+```
+
 ### Changing Email Subscription
 
 ```ruby

data/lib/braze_ruby/api.rb

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

data/lib/braze_ruby/endpoints/canvas.rb

@@ -0,0 +1,9 @@
+module BrazeRuby
+  module Endpoints
+    module Canvas
+      def trigger_canvas_send(**payload)
+        BrazeRuby::REST::TriggerCanvasSend.new(api_key, braze_url, payload).perform
+      end
+    end
+  end
+end

data/lib/braze_ruby/rest.rb

@@ -9,3 +9,4 @@ 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'
+require 'braze_ruby/rest/trigger_canvas_send'

data/lib/braze_ruby/rest/trigger_canvas_send.rb

@@ -0,0 +1,20 @@
+module BrazeRuby
+  module REST
+    class TriggerCanvasSend < 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('/canvas/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.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/spec/fixtures/responses/canvas/trigger_send/sends_a_canvas.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: "<BRAZE_REST_URL>/canvas/trigger/send"
+    body:
+      encoding: UTF-8
+      string: '{"api_key":"<BRAZE_REST_API_KEY>","canvas_id":"dc23ade4-e970-0c52-81bc-b369f64f533d","recipients":[{"external_user_id":132404,"canvas_entry_properties":{"first_name":"John"}}]}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      User-Agent:
+      - Braze Ruby gem v0.2.1
+      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/"fe0b7fad99d691854e76da70f1fcfff9"
+      Server:
+      - nginx
+      Strict-Transport-Security:
+      - max-age=0; includeSubDomains
+      - max-age=31536000; includeSubDomains
+      X-Ratelimit-Limit:
+      - '250000'
+      X-Ratelimit-Remaining:
+      - '249998'
+      X-Ratelimit-Reset:
+      - '1569409200'
+      X-Request-Id:
+      - 768c83db-2694-4267-b21c-d070cb4a1828
+      X-Runtime:
+      - '0.023062'
+      Content-Length:
+      - '94'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Wed, 25 Sep 2019 10:36:45 GMT
+      Via:
+      - 1.1 varnish
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-fra19174-FRA
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1569407805.340414,VS0,VE71
+      Vary:
+      - Origin,Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"dispatch_id":"0bda43218769391588ee304c36fafb03","message":"success"}'
+    http_version: 
+  recorded_at: Wed, 25 Sep 2019 10:36:45 GMT
+recorded_with: VCR 5.0.0

data/spec/integrations/canvas_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+RSpec.describe 'canvas' do
+  describe 'trigger_send' do
+    it 'sends a canvas', vcr: true do
+      response = api.trigger_canvas_send(
+        canvas_id: 'dc23ade4-e970-0c52-81bc-b369f64f533d',
+        recipients: [
+          external_user_id: 132404,
+          canvas_entry_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.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Josh Nussbaum
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-02 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -147,6 +147,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
@@ -160,6 +161,7 @@ files:
 - lib/braze_ruby/deprecated.rb
 - lib/braze_ruby/endpoints.rb
 - lib/braze_ruby/endpoints/campaigns.rb
+- lib/braze_ruby/endpoints/canvas.rb
 - lib/braze_ruby/endpoints/delete_users.rb
 - lib/braze_ruby/endpoints/email_status.rb
 - lib/braze_ruby/endpoints/email_sync.rb
@@ -179,6 +181,7 @@ files:
 - 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/rest/trigger_canvas_send.rb
 - lib/braze_ruby/version.rb
 - spec/braze_ruby/api_spec.rb
 - spec/braze_ruby/endpoints/delete_users_spec.rb
@@ -191,6 +194,7 @@ files:
 - spec/braze_ruby/rest/track_users_spec.rb
 - spec/factories.rb
 - spec/fixtures/responses/campaigns/trigger_send/sends_an_email.yml
+- spec/fixtures/responses/canvas/trigger_send/sends_a_canvas.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
@@ -215,6 +219,7 @@ files:
 - 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/canvas_spec.rb
 - spec/integrations/delete_users_spec.rb
 - spec/integrations/email_status_spec.rb
 - spec/integrations/email_sync_spec.rb
@@ -265,6 +270,7 @@ test_files:
 - spec/braze_ruby/rest/track_users_spec.rb
 - spec/factories.rb
 - spec/fixtures/responses/campaigns/trigger_send/sends_an_email.yml
+- spec/fixtures/responses/canvas/trigger_send/sends_a_canvas.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
@@ -289,6 +295,7 @@ test_files:
 - 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/canvas_spec.rb
 - spec/integrations/delete_users_spec.rb
 - spec/integrations/email_status_spec.rb
 - spec/integrations/email_sync_spec.rb