txbr 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31315acfac2024dccf07c712f3146c897d85f1932e3cf9d832dd5d0eeef3fadf
-  data.tar.gz: d7f450603dad38710b0415e8fa5a76d38d99fcc3af48c90a756b75b3d2cc7e47
+  metadata.gz: 5715c1621b00c110e167d8116399482d7bad3622a7fcd205ac64bfac194f654e
+  data.tar.gz: 016b5d0f0455b11a0b73986f9aac04a704ca74d1168a2d417bee9479873b33e0
 SHA512:
-  metadata.gz: 9e52a042f6b550f9616d8f06454691172befa00dc9933defaecfccd88cd0033996f140f11cac3d18c492c01fe8c2a667b38a4828f9ae87c0abec4a17152aa349
-  data.tar.gz: 12987f0c5e313fadb81e256d1c5ebad38aea68a5bb67d8406fc52dd88aa53789ec12f52684124473386eb117750a164e080bc7037034160b2593d86f32a74bfb
+  metadata.gz: 9e902060a7bc2a89399f2217188bc05c0069319e1177068bca3522ed86f75c451eca5dc375a348bf1f45c37a6332f12f0d0bff7ba60052c64cf5492c31ff95fe
+  data.tar.gz: ea742212714f4d9bd8227275867266729925f7cc9d69071222e8db7e7b8f13d400da080ada51ddfc0f4f3e14111fe984b34e22742c93a94483abd8f6ec56cbbd

data/README.md

@@ -47,16 +47,14 @@ Configuration
 Txbr requires several configuration options in order to communicate with Braze and Transifex. Configuration is done in the YAML file format. Here's an example:
 
 ```yaml
+transifex_api_username: tx_username
+transifex_api_password: tx_password
 projects:
   - handler_id: email-templates
-    transifex_api_username: tx_username
-    transifex_api_password: tx_password
     strings_format: YML
     source_lang: en
-    braze_email_address: login@yourcompany.com
-    braze_password: your_braze_password
-    braze_app_group_id: your_braze_app_group_id
-    braze_api_url: https://dashboard-03.braze.com/
+    braze_api_url: https://rest.iad-01.braze.com/ # or whatever
+    braze_api_key: abc123
 
 ```
 

data/lib/txbr/braze_api.rb

@@ -3,21 +3,38 @@ require 'faraday_middleware'
 
 module Txbr
   class BrazeApi
+    TEMPLATE_BATCH_SIZE = 35
+    TEMPLATE_LIST_PATH = 'templates/email/list'.freeze
+    TEMPLATE_INFO_PATH = 'templates/email/info'.freeze
+
     include RequestMethods
 
     attr_reader :api_key, :api_url
 
-    def initialize(api_key, api_url)
+    def initialize(api_key, api_url, connection: nil)
       @api_key = api_key
       @api_url = api_url
+      @connection = connection
     end
 
-    def each_email_template
-      raise NotImplementedError, 'Braze does not support this operation yet'
+    def each_email_template(offset: 1, &block)
+      return to_enum(__method__, offset: offset) unless block_given?
+
+      loop do
+        templates = get_json(
+          TEMPLATE_LIST_PATH,
+          offset: offset,
+          limit: TEMPLATE_BATCH_SIZE
+        )
+
+        templates['templates'].each(&block)
+        offset += templates['templates'].size
+        break if templates['templates'].size < TEMPLATE_BATCH_SIZE
+      end
     end
 
     def get_email_template_details(email_template_id:)
-      raise NotImplementedError, 'Braze does not support this operation yet'
+      get_json(TEMPLATE_INFO_PATH, email_template_id: email_template_id)
     end
 
     private

data/lib/txbr/email_template.rb

@@ -40,7 +40,7 @@ module Txbr
     private
 
     def strings_map
-      @strings_map ||= %w(template subject preheader).each_with_object({}) do |name, ret|
+      @strings_map ||= %w(body subject preheader).each_with_object({}) do |name, ret|
         component = EmailTemplateComponent.new(
           Liquid::Template.parse(details[name])
         )
@@ -58,7 +58,7 @@ module Txbr
     end
 
     def template_name
-      details['name']
+      details['template_name']
     end
 
     def details

data/lib/txbr/email_template_handler.rb

@@ -17,7 +17,7 @@ module Txbr
       return to_enum(__method__) unless block_given?
 
       project.braze_api.each_email_template do |tmpl|
-        yield EmailTemplate.new(project, tmpl['id'])
+        yield EmailTemplate.new(project, tmpl['email_template_id'])
       end
     end
   end

data/lib/txbr/project.rb

@@ -5,9 +5,6 @@ module Txbr
     attr_reader :braze_api_url, :braze_api_key, :handler_id
     attr_reader :strings_format, :source_lang
 
-    # @TODO: remove these when Braze gives us the endpoints we asked for
-    attr_reader :braze_app_group_id, :braze_email_address, :braze_password
-
     def initialize(options = {})
       @braze_api_url = options.fetch(:braze_api_url)
       @braze_api_key = options.fetch(:braze_api_key)
@@ -15,25 +12,12 @@ module Txbr
       @strings_format = options.fetch(:strings_format)
       @source_lang = options.fetch(:source_lang)
 
-      # @TODO: remove these when Braze gives us the endpoints we asked for
-      @braze_app_group_id = options.fetch(:braze_app_group_id)
-      @braze_email_address = options.fetch(:braze_email_address)
-      @braze_password = options.fetch(:braze_password)
-
       @braze_api = options[:braze_api]
       @transifex_api = options[:transifex_api]
     end
 
-    def braze_session
-      @@braze_session ||= Txbr::BrazeSession.new(
-        braze_api_url, braze_email_address, braze_password
-      )
-    end
-
     def braze_api
-      # @TODO: use BrazeApi when Braze gives us the endpoints we asked for
-      # @braze_api ||= Txbr::BrazeApi.new(braze_api_key, braze_api_url)
-      @braze_api ||= Txbr::BrazeSessionApi.new(braze_session, braze_app_group_id)
+      @braze_api ||= Txbr::BrazeApi.new(braze_api_key, braze_api_url)
     end
 
     def transifex_api

data/lib/txbr/version.rb

@@ -1,3 +1,3 @@
 module Txbr
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/{braze_session_api_spec.rb → braze_api_spec.rb}

@@ -1,14 +1,11 @@
 require 'spec_helper'
-require 'support/fake_braze_session'
 require 'support/fake_connection'
 
-describe Txbr::BrazeSessionApi do
-  let(:session_id) { 'session_id' }
-  let(:app_group_id) { 'app_group_id' }
+describe Txbr::BrazeApi do
+  let(:api_key) { 'abc123' }
   let(:api_url) { 'https://somewhere.braze.com' }
-  let(:session) { FakeBrazeSession.new(api_url, session_id) }
   let(:connection) { FakeConnection.new(interactions) }
-  let(:client) { described_class.new(session, app_group_id, connection: connection) }
+  let(:client) { described_class.new(api_key, api_url, connection: connection) }
 
   shared_examples 'a client request that handles errors' do
     context 'when the resource is not found' do
@@ -18,7 +15,7 @@ describe Txbr::BrazeSessionApi do
         end
       end
 
-      it 'raises an error' do
+      it 'raises a not found error' do
         expect { subject }.to raise_error(Txbr::BrazeNotFoundError)
       end
     end
@@ -33,9 +30,8 @@ describe Txbr::BrazeSessionApi do
         end
       end
 
-      it 'resets the session and tries again' do
-        expect { subject }.to_not raise_error
-        expect(session).to be_reset
+      it 'raises an unauthorized error' do
+        expect { subject }.to raise_error(Txbr::BrazeUnauthorizedError)
       end
     end
 
@@ -46,34 +42,37 @@ describe Txbr::BrazeSessionApi do
         end
       end
 
-      it 'raises an error' do
+      it 'raises a generic error' do
         expect { subject }.to raise_error(Txbr::BrazeApiError)
       end
     end
   end
 
   describe '#each_email_template' do
+    subject { client.each_email_template.to_a }
+
     before do
-      stub_const("#{described_class.name}::EMAIL_TEMPLATE_BATCH_SIZE", 1)
+      stub_const("#{described_class.name}::TEMPLATE_BATCH_SIZE", 1)
     end
 
-    subject { client.each_email_template.to_a }
-
     let(:interactions) do
       [{
-        request: { verb: 'get', url: 'engagement/email_templates', start: 0, length: 1 },
-        response: { status: 200, body: { results: [{ id: '123abc' }] }.to_json }
+        request: { verb: 'get', url: described_class::TEMPLATE_LIST_PATH, params: { offset: 1, limit: 1 } },
+        response: { status: 200, body: { templates: [{ email_template_id: '123abc' }] }.to_json }
       }, {
-        request: { verb: 'get', url: 'engagement/email_templates', start: 1, length: 1 },
-        response: { status: 200, body: { results: [{ id: '456def' }] }.to_json }
+        request: { verb: 'get', url: described_class::TEMPLATE_LIST_PATH, params: { offset: 2, limit: 1 } },
+        response: { status: 200, body: { templates: [{ email_template_id: '456def' }] }.to_json }
       }, {
-        request: { verb: 'get', url: 'engagement/email_templates', start: 2, length: 0 },
-        response: { status: 200, body: { results: [] }.to_json }
+        request: { verb: 'get', url: described_class::TEMPLATE_LIST_PATH, params: { offset: 3, limit: 1 } },
+        response: { status: 200, body: { templates: [] }.to_json }
       }]
     end
 
     it 'yields each template' do
-      expect(subject).to eq([{ 'id' => '123abc' }, { 'id' => '456def' }])
+      expect(subject).to eq([
+        { 'email_template_id' => '123abc' },
+        { 'email_template_id' => '456def' }
+      ])
     end
 
     it_behaves_like 'a client request that handles errors'
@@ -85,16 +84,16 @@ describe Txbr::BrazeSessionApi do
 
     let(:details) do
       {
-        'name' => 'Foo Template',
-        'template' => "<html><body>I'm a little teapot</body</html>",
+        'template_name' => 'Foo Template',
+        'body' => "<html><body>I'm a little teapot</body</html>",
         'subject' => 'Subject subject',
-        'preheader' => 'Preheader preheader',
+        'preheader' => 'Preheader preheader'
       }
     end
 
     let(:interactions) do
       [{
-        request: { verb: 'get', url: "engagement/email_templates/#{email_template_id}" },
+        request: { verb: 'get', url: described_class::TEMPLATE_INFO_PATH, params: { email_template_id: email_template_id } },
         response: { status: 200, body: details.to_json }
       }]
     end

data/spec/config_spec.rb

@@ -25,11 +25,6 @@ describe Txbr::Config do
       expect(project.braze_api_url).to eq('https://somewhere.braze.com')
       expect(project.strings_format).to eq('YML')
       expect(project.source_lang).to eq('en')
-
-      # @TODO: remove once Braze implements the endpoints we asked for
-      expect(project.braze_email_address).to eq('braze@email.com')
-      expect(project.braze_password).to eq('braze_password')
-      expect(project.braze_app_group_id).to eq('5551212')
     end
   end
 

data/spec/email_template_spec.rb

@@ -7,7 +7,7 @@ describe Txbr::EmailTemplate do
   let(:email_template_id) { 'abc123' }
   let(:email_template) { described_class.new(project, email_template_id) }
 
-  let(:template_html) do
+  let(:body_html) do
     <<~HTML
       <html>
         <head>
@@ -51,12 +51,16 @@ describe Txbr::EmailTemplate do
   describe '#each_resource' do
     let(:braze_interactions) do
       [{
-        request: { verb: 'get', url: "engagement/email_templates/#{email_template_id}" },
+        request: {
+          verb: 'get',
+          url: Txbr::BrazeApi::TEMPLATE_INFO_PATH,
+          params: { email_template_id: email_template_id }
+        },
         response: {
           status: 200,
           body: {
-            name: 'Super Slick Awesome',
-            template: template_html,
+            template_name: 'Super Slick Awesome',
+            body: body_html,
             subject: subject_html,
             preheader: preheader_html
           }.to_json

data/spec/support/standard_setup.rb

@@ -1,17 +1,15 @@
 require 'txgh'
-require 'support/fake_braze_session'
 require 'support/fake_connection'
 require 'support/test_config'
 
 shared_context 'standard setup' do
-  let(:session_id) { 'session_id' }
-  let(:app_group_id) { config[:braze_app_group_id] }
+  let(:config) { TestConfig.config[:projects].first }
+  let(:api_url) { config[:braze_api_url] }
+  let(:api_key) { config[:braze_api_key] }
   let(:braze_connection) { FakeConnection.new(braze_interactions) }
   let(:transifex_connection) { FakeConnection.new(transifex_interactions) }
-  let(:braze_session) { FakeBrazeSession.new(config[:braze_api_url], session_id) }
-  let(:braze_api) { Txbr::BrazeSessionApi.new(braze_session, app_group_id, connection: braze_connection) }
+  let(:braze_api) { Txbr::BrazeApi.new(api_key, api_url, connection: braze_connection) }
   let(:transifex_api) { Txgh::TransifexApi.create_from_connection(transifex_connection) }
-  let(:config) { TestConfig.config[:projects].first }
   let(:project) { Txbr::Project.new(config.merge(braze_api: braze_api, transifex_api: transifex_api)) }
 
   # override these

data/spec/support/test_config.rb

@@ -9,11 +9,6 @@ class TestConfig
         braze_api_url: 'https://somewhere.braze.com',
         strings_format: 'YML',
         source_lang: 'en',
-
-        # @TODO: remove once Braze implements the endpoints we asked for
-        braze_email_address: 'braze@email.com',
-        braze_password: 'braze_password',
-        braze_app_group_id: '5551212'
       }]
     }
   end

data/spec/uploader_spec.rb

@@ -8,15 +8,22 @@ describe Txbr::Uploader do
 
   let(:braze_interactions) do
     [{
-      request: { verb: 'get', url: 'engagement/email_templates', start: 0, length: 1 },
-      response: { status: 200, body: { results: [{ id: email_template_id }] }.to_json }
+      request: {
+        verb: 'get',
+        url: Txbr::BrazeApi::TEMPLATE_LIST_PATH,
+        params: { offset: 1, limit: Txbr::BrazeApi::TEMPLATE_BATCH_SIZE }
+      },
+      response: {
+        status: 200,
+        body: { templates: [{ email_template_id: email_template_id }] }.to_json
+      }
     }, {
-      request: { verb: 'get', url: "engagement/email_templates/#{email_template_id}" },
+      request: { verb: 'get', url: Txbr::BrazeApi::TEMPLATE_INFO_PATH, params: { email_template_id: email_template_id } },
       response: {
         status: 200,
         body: {
-          name: 'Super Slick Awesome',
-          template: template_html,
+          template_name: 'Super Slick Awesome',
+          body: body_html,
           subject: '',
           preheader: ''
         }.to_json
@@ -35,7 +42,7 @@ describe Txbr::Uploader do
     }]
   end
 
-  let(:template_html) do
+  let(:body_html) do
     <<~HTML
       <html>
         <head>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: txbr
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-30 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abroad
@@ -135,7 +135,6 @@ files:
 - lib/txbr/application.rb
 - lib/txbr/braze_api.rb
 - lib/txbr/braze_session.rb
-- lib/txbr/braze_session_api.rb
 - lib/txbr/commands.rb
 - lib/txbr/config.rb
 - lib/txbr/email_template.rb
@@ -149,7 +148,7 @@ files:
 - lib/txbr/utils.rb
 - lib/txbr/version.rb
 - spec/application_spec.rb
-- spec/braze_session_api_spec.rb
+- spec/braze_api_spec.rb
 - spec/braze_session_spec.rb
 - spec/config_spec.rb
 - spec/email_template_spec.rb
@@ -157,7 +156,6 @@ files:
 - spec/spec_helper.rb
 - spec/strings_manifest_spec.rb
 - spec/support/env_helpers.rb
-- spec/support/fake_braze_session.rb
 - spec/support/fake_connection.rb
 - spec/support/standard_setup.rb
 - spec/support/test_config.rb

data/lib/txbr/braze_session_api.rb

@@ -1,73 +0,0 @@
-require 'faraday'
-require 'faraday_middleware'
-
-module Txbr
-  class BrazeSessionApi
-    EMAIL_TEMPLATE_BATCH_SIZE = 35
-
-    include RequestMethods
-
-    attr_reader :session, :app_group_id
-
-    def initialize(session, app_group_id, connection: nil)
-      @session = session
-      @app_group_id = app_group_id
-      @connection = connection
-    end
-
-    def each_email_template(start: 0, &block)
-      return to_enum(__method__, start: start) unless block_given?
-
-      loop do
-        templates = get_json(
-          'engagement/email_templates',
-          start: start,
-          limit: EMAIL_TEMPLATE_BATCH_SIZE
-        )
-
-        templates['results'].each(&block)
-        start += templates['results'].size
-        break if templates['results'].size < EMAIL_TEMPLATE_BATCH_SIZE
-      end
-    end
-
-    def get_email_template_details(email_template_id:)
-      get_json("engagement/email_templates/#{email_template_id}")
-    end
-
-    private
-
-    def act(*args)
-      retried = false
-
-      begin
-        super(*args, { cookie: "_session_id=#{session.session_id}" })
-      rescue BrazeUnauthorizedError => e
-        raise e if retried
-        reset!
-        retried = true
-        retry
-      end
-    end
-
-    def reset!
-      session.reset!
-    end
-
-    def connection
-      @connection ||= begin
-        options = {
-          url: session.api_url,
-          params: { app_group_id: app_group_id }
-        }
-
-        Faraday.new(options) do |faraday|
-          faraday.request(:json)
-          faraday.response(:logger)
-          faraday.use(FaradayMiddleware::FollowRedirects)
-          faraday.adapter(:net_http)
-        end
-      end
-    end
-  end
-end

data/spec/support/fake_braze_session.rb

@@ -1,14 +0,0 @@
-class FakeBrazeSession
-  attr_reader :api_url, :session_id, :was_reset
-  alias reset? was_reset
-
-  def initialize(api_url, session_id)
-    @api_url = api_url
-    @session_id = session_id
-    @was_reset = false
-  end
-
-  def reset!
-    @was_reset = true
-  end
-end