RubyGems - txbr - Versions diffs - 1.0.0 - Mend

txbr 1.0.0

Files changed (37) hide show

checksums.yaml +7 -0
data/LICENSE +202 -0
data/README.md +137 -0
data/lib/txbr.rb +81 -0
data/lib/txbr/application.rb +48 -0
data/lib/txbr/braze_api.rb +42 -0
data/lib/txbr/braze_session.rb +39 -0
data/lib/txbr/braze_session_api.rb +73 -0
data/lib/txbr/commands.rb +14 -0
data/lib/txbr/config.rb +57 -0
data/lib/txbr/email_template.rb +70 -0
data/lib/txbr/email_template_component.rb +94 -0
data/lib/txbr/email_template_handler.rb +24 -0
data/lib/txbr/project.rb +50 -0
data/lib/txbr/request_methods.rb +45 -0
data/lib/txbr/strings_manifest.rb +55 -0
data/lib/txbr/tasks.rb +8 -0
data/lib/txbr/uploader.rb +23 -0
data/lib/txbr/utils.rb +9 -0
data/lib/txbr/version.rb +3 -0
data/spec/application_spec.rb +78 -0
data/spec/braze_session_api_spec.rb +108 -0
data/spec/braze_session_spec.rb +49 -0
data/spec/config_spec.rb +69 -0
data/spec/email_template_spec.rb +133 -0
data/spec/fixtures/cassettes/braze_login.yml +324 -0
data/spec/spec_helper.rb +46 -0
data/spec/strings_manifest_spec.rb +45 -0
data/spec/support/env_helpers.rb +13 -0
data/spec/support/fake_braze_session.rb +14 -0
data/spec/support/fake_connection.rb +78 -0
data/spec/support/standard_setup.rb +20 -0
data/spec/support/test_config.rb +20 -0
data/spec/uploader_spec.rb +84 -0
data/spec/utils_spec.rb +17 -0
data/txbr.gemspec +27 -0
metadata +190 -0

@@ -0,0 +1,133 @@
+require 'spec_helper'
+require 'support/standard_setup'
+describe Txbr::EmailTemplate do
+  include_context 'standard setup'
+  let(:email_template_id) { 'abc123' }
+  let(:email_template) { described_class.new(project, email_template_id) }
+  let(:template_html) do
+    <<~HTML
+      <html>
+        <head>
+          {% assign project_slug = "my_project" %}
+          {% assign resource_slug = "my_resource" %}
+          {% assign translation_enabled = true %}
+          {% connected_content http://my_strings_api.com/ :save strings %}
+        </head>
+        <body>
+          {{strings.header | default: 'Buy our stuff!'}}
+          {% if user.gets_discount? %}
+            {{strings.discount | default: 'You get a discount'}}
+          {% else %}
+            {{strings.no_discount | default: 'You get no discount'}}
+          {% endif %}
+        </body>
+      </html>
+    HTML
+  end
+  let(:subject_html) do
+    <<~HTML
+      {% assign project_slug = "my_project" %}
+      {% assign resource_slug = "my_resource" %}
+      {% assign translation_enabled = true %}
+      {% connected_content http://my_strings_api.com/ :save strings %}
+      {{strings.meta.subject_line | default: 'You lucky duck maybe'}}
+    HTML
+  end
+  let(:preheader_html) do
+    <<~HTML
+      {% assign project_slug = "my_project" %}
+      {% assign resource_slug = "my_resource" %}
+      {% assign translation_enabled = true %}
+      {% connected_content http://my_strings_api.com/ :save strings %}
+      {{strings.meta.preheader | default: 'Our stuff is the bomb and you should buy it.'}}
+    HTML
+  end
+  describe '#each_resource' do
+    let(:braze_interactions) do
+      [{
+        request: { verb: 'get', url: "engagement/email_templates/#{email_template_id}" },
+        response: {
+          status: 200,
+          body: {
+            name: 'Super Slick Awesome',
+            template: template_html,
+            subject: subject_html,
+            preheader: preheader_html
+          }.to_json
+        }
+      }]
+    end
+    it 'extracts and groups all strings with the same project, resource, and prefix' do
+      resources = email_template.each_resource.to_a
+      expect(resources.size).to eq(1)
+      resource = resources.first
+      # notice how it combined strings from the subject, preheader,
+      # and template (i.e. HTML body)
+      expect(resource.phrases).to eq([
+        { 'key' => 'header', 'string' => 'Buy our stuff!' },
+        { 'key' => 'discount', 'string' => 'You get a discount' },
+        { 'key' => 'no_discount', 'string' => 'You get no discount' },
+        { 'key' => 'meta.subject_line', 'string' => 'You lucky duck maybe' },
+        { 'key' => 'meta.preheader', 'string' => 'Our stuff is the bomb and you should buy it.' }
+      ])
+    end
+    it 'constructs a txgh resource' do
+      resource = email_template.each_resource.to_a.first
+      tx_resource = resource.tx_resource
+      expect(tx_resource.project_slug).to eq('my_project')
+      expect(tx_resource.resource_slug).to eq('my_resource')
+      expect(tx_resource.source_file).to eq('Super Slick Awesome')
+      expect(tx_resource.source_lang).to eq(project.source_lang)
+      expect(tx_resource.type).to eq(project.strings_format)
+    end
+    context 'with translations disabled for the subject' do
+      let(:subject_html) do
+        super().tap do |subj|
+          subj.sub!('translation_enabled = true', 'translation_enabled = false')
+        end
+      end
+      it 'does not include translations for the subject line' do
+        expect(email_template.each_resource.to_a.first.phrases).to_not(
+          include({ 'key' => 'meta.subject_line', 'string' => 'You lucky duck maybe' })
+        )
+      end
+    end
+    context 'when the subject comes from a separate resource' do
+      let(:subject_html) do
+        super().tap do |subj|
+          subj.sub!(
+            'resource_slug = "my_resource"',
+            'resource_slug = "my_other_resource"'
+          )
+        end
+      end
+      it 'includes two resources' do
+        resources = email_template.each_resource.to_a
+        expect(resources.size).to eq(2)
+        expect(resources.first.phrases).to_not(
+          include({ 'key' => 'meta.subject_line', 'string' => 'You lucky duck maybe' })
+        )
+        expect(resources.last.phrases).to eq(
+          [{ 'key' => 'meta.subject_line', 'string' => 'You lucky duck maybe' }]
+        )
+      end
+    end
+  end
+end

data/spec/fixtures/cassettes/braze_login.yml ADDED

@@ -0,0 +1,324 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://dashboard-03.braze.com/auth?email=BRAZE_EMAIL_ADDRESS
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip,deflate,identity
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Mechanize/2.7.5 Ruby/2.5.1p57 (http://github.com/sparklemotion/mechanize/)
+      Accept-Charset:
+      - ISO-8859-1,utf-8;q=0.7,*;q=0.7
+      Accept-Language:
+      - en-us,en;q=0.5
+      Host:
+      - dashboard-03.braze.com
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - '300'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - text/html; charset=utf-8
+      Etag:
+      - W/"0350212486d4a8ab5be5221a08898626"
+      Server:
+      - nginx
+      Set-Cookie:
+      - _session_id=123abc123abc123abc123abc123abc12; path=/; secure; HttpOnly
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Request-Id:
+      - b8a8efff-1307-410b-b09a-ae8d74088b69
+      X-Runtime:
+      - '0.024584'
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '2352'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 31 May 2018 19:51:53 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-sjc3137-SJC
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1527796313.967896,VS0,VE103
+      Vary:
+      - Accept-Encoding
+      Strict-Transport-Security:
+      - max-age=86400; includeSubDomains
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA51YeVPcyBX/n0/RO6kKEI9G9xUYHOMFm/gCG++uTbmoPkcCjVpIPcB4vd89r1vSjDicInFhkNT97t87und/YZKqZcVRpubF3sZu/4djtreB0O6cKwxrqrL41SK/no5eylLxUlmnQDRCtH2bjhS/VbYm3kE0w3XD1XShhJWMDJciLy9RzYvpiJWNVdVccEWzEcrgaTqybXyBbyczKWcFx1XeTKicA6GmVLkq+N5bOUN5iZRE+zX+ztGP9u+u3S6bnUaGNqVThjbNqJXZqGXBm4xz1UvUBjX/tG2BGzURYEMzKbmygQTE20EUuIIQYTkuoVbAU9dKfI9YKQ8SHEZJ6AXpRLO318Y9UfDPRPoBjoUAaVEaeVaASWKRQIRWirFHAi9MuKC9yLsOHRo35yzH01FDa87LlXdxA9FobMav84ZblMRhwkgciRTHMeMJSQQnYSwiJuLEYUnipY7HSEi464gEflxKSeoKRjijbmK0QAPLTVifrEVequKUF0dltVAWdRjxeBqAEnFKIk4wDZLQjVjsuswXIqXU91MapHFCIjfBUcrTKBDwzlzHc8lKF3DJo2D9w/r8wnop5xVWOSmGeD06mHI242Oa1XLOpy7ArcV6j95RD9+NbqHEsG/EOHg3r1QuwcEr9K/xuZSLugMpw01GJK7ZZMW85YEXKpP1gNyAugO8gXGXFwJf5yBjAr96KAOhoguF9PdRB/d8jmfcvrXabxCajd1fLAtd5/ymgu2owWWulkjIGs0lyQuOSC1vGl43E2RZveGtbj3RQLubnKlsquFDuWVexjkwzHFhNRQXnfO0xKODFB3nZckZ+pQr3qBPi8pocF8KrqoipxAUWVpa7n1foF973xmotZFpFZxDiq6JlZSFyqsB/TtcgjfQIA68xBB7hoCumRh+G4OCNAfnCN6sSoPdf5hcNNrFZrupgq182tTCqnCN5wOhOqJQFHMKfj5X8lJn3z29DV23tMLNIbVfCefkZOF8//pGHJ5+uRS+c5RUx/vff/vt9dHbD446+vDiWH76Y/8yzd/IZ+zk4+HJ8uj3d1+Ol29fn7qzr8WXbPlWfnjmXv/6xtsvDuLPL6bTVm0oii1Yh2XxAl/j9qspzQhtiUVJdSS28nEzluPZuB7j8Xz7z/xs85UpyS9KXCzBuOYDueBUbX6b1jv5Wf1tqn/9+LGi3/7TMASWemFyZdYnVz9+nH3bnlSLJtvC9WwxB0c123+NzWIxdf9R8huIt+Jb2zt4CrW/5vByUHC9cUtujzumCM1hdcZVt9TsL0/x7D2gBzadOd928AQ3y5JOXXhqajqd7cwnECjg8l4yPslLQLza55AGfEsbaPj+tb11k5dM3oyhERrdxputezbHm7Z9c3PT9SULcNV6QXcne/120cDOGd7c3tFtCKEZ3tpsbdgco02oP2maRE7sWrF+BxASudQsNEG/v+El06sVQFdnYLu2a7eaAAI3du3MtOSNXSLZ0vQdll+jnE1HGnyAxQLq/HSkoYXzktdddM2ubq2Qs7y0wH7dXIGBfurX9LPVKEwvIVPWTIwASH1eyIrX500+K3PANsMK6yRoCr60rnGRwwfdd+sFpHIp11/WzyOEDcqg3a/4NbZmeK45Ykp5BR2hmx1Gn08PYXhAkHiZBBUqCRm6t5vrttElItRn2ND23SxnTOccCF6AHn//260Xu/6OToOO5u6+dR2+n7Udh49N+Z2rizQVv4cvo+bTfnw9q8okrZvLk5S/Uy+hCz67UNnBx89+ss/V19NC1K+WVy8ku3r/Bhf/zt76Kr28ekfnr48PvzrHKrt4f7JOTPA+7l2vA8tri2BoCW3h78cTjT6ie0M7EO3aWENBg2YYVu1DCwJLMFTePu53twDcKlwurYYXkMCcWR1NBxLN8RNwQUdll2y7NuCmrQ/do1kA6Q/Ea7DUsrBmtVxUK4Z3FOyl8jnOC1QtisIquICAdtIQUrezbLKABP3XTO/R9j7U5K5NMCxcQkG1BkzrfJYNua593MyxFgq9dTUWddB7TmHmrM8Nl3Mq5WXOpwbHa+UQei+V7ijPV/qaUGiPgE6Pu6rDXYenR+y7j91+vuhy7cxo9G10LwPN1768G/GDBL8TClRBQbiRNRtY0il1J31rPdjXHJKsTd87i/O8LHg5g/4/ikaoKjDlmSwArtPRcc8eQQGSGmEF10VACgHpDJ8EFFSoSKvH3uCVXl0ir8rBWb/ywOo1iRk8+39D2w2qDAD0oDOTCurTA/uNw1aJ9wgoBqWpJ7ehP432Dg3PdqzoV54PUGA4r5GwenlquhSY8GJVxDNOL4m8fRi5tozRfr3zYA29ck6gPnfo0EW7/9bmBxTWjmVfI9tgD9z5sWOC3i3RgUbZCt9Gt4fFYOh9IaUa1B4wvy3Vrb7NgsxzmLC6CUrOzVuXGl3hWXUwokrUE2hDVuVN9Y2H5Y2e6GAW1bhc0etJ7TFkSN0grUFj/PBxWNPuppDK8prp1qaWlqEjC6Vk2dwpB2sI/WQ70kbAf4txgReFGg1ACyqaFCMYTmPdoK8l2e3599yo692j+Pm+YT4Y640/4LCsvYPaAW6YMv+tcO3aegzYW3tn/QQs+mFSz1aPn9nNOd4uctLYF1cLXi9tb+JO3O5lAsUEhmpo46u55j7T7qiqD4mW4gV0Nej39p0zoxOG2MM4iVM/TCiNnUDAydBJfBp5LBEu953Ai6lPQ0wwceD0jl03itMgppzHEfm/NFiovGgs7AZ+Ql1fYJcSGvl+EsfYjwQlAYHTOsVpRHyfesLBUZz4jp+mjArmhAENHMG8p4nO4DxqY9KiL+MFzF0N3AMQOKcLj/ixSAIeO6HHkyCM4sBJwtjlMP7ELuFx6KYOc7kIQ0Zo6lARu45Lefg/iO7uCeCwHwrsY58kqUtjklAWM0yFQ3zPg7sDJnwRe3B1EEdOyCIiAu5jVyTgC5eTIHqaxH6G9OLUS0JGHRJjlsTM4wQcSNwIc4cyDDcuEQfDRIhTHwJKmAfRZwlmkfDhCkE8TRogU3u2F4oZg8y2Eof6hDgUHOmxFC5iAE4UcyIccGMaw20EwQm433W564GBLA5jB66CUuGkgonggWwY1tshHYZ2c6v2HyQG0CpmEwAA
+    http_version:
+  recorded_at: Thu, 31 May 2018 19:51:53 GMT
+- request:
+    method: post
+    uri: https://dashboard-03.braze.com/developers/sign_in
+    body:
+      encoding: UTF-8
+      string: utf8=%E2%9C%93&authenticity_token=Rsnzetj99fW5C6sSB7vgpn89rskQ9eMtCcss%2BjthERU38BetZTlfrGyqAodqNKalJhL3t9kqMcmHPFZ0PthjNQ%3D%3D&developer%5Bemail%5D=BRAZE_EMAIL_ADDRESS&developer%5Bpassword%5D=BRAZE_PASSWORD
+    headers:
+      Accept-Encoding:
+      - gzip,deflate,identity
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Mechanize/2.7.5 Ruby/2.5.1p57 (http://github.com/sparklemotion/mechanize/)
+      Accept-Charset:
+      - ISO-8859-1,utf-8;q=0.7,*;q=0.7
+      Accept-Language:
+      - en-us,en;q=0.5
+      Cookie:
+      - _session_id=123abc123abc123abc123abc123abc12
+      Host:
+      - dashboard-03.braze.com
+      Referer:
+      - https://dashboard-03.braze.com/auth?email=BRAZE_EMAIL_ADDRESS
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Content-Length:
+      - '219'
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - '300'
+  response:
+    status:
+      code: 302
+      message: Found
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/html; charset=utf-8
+      Location:
+      - https://dashboard-03.braze.com/dashboard
+      Server:
+      - nginx
+      Set-Cookie:
+      - _session_id=123abc123abc123abc123abc123abc12; path=/; secure; HttpOnly
+      - remember_login_enc_v1=HhZn20fKb8HUFr4vpxoWbw%3D%3D%24CCaTLGofO%2BnbDjIQ56p%2BhQ%3D%3D;
+        domain=.braze.com; path=/; expires=Wed, 30 May 2018 19:51:53 -0000
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Request-Id:
+      - b072ed0b-b60a-4dd5-92ca-b68dbbb8b051
+      X-Runtime:
+      - '0.125571'
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '0'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 31 May 2018 19:51:53 GMT
+      Via:
+      - 1.1 varnish
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-sjc3129-SJC
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1527796313.089966,VS0,VE414
+      Strict-Transport-Security:
+      - max-age=86400; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version:
+  recorded_at: Thu, 31 May 2018 19:51:53 GMT
+- request:
+    method: get
+    uri: https://dashboard-03.braze.com/dashboard
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip,deflate,identity
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Mechanize/2.7.5 Ruby/2.5.1p57 (http://github.com/sparklemotion/mechanize/)
+      Accept-Charset:
+      - ISO-8859-1,utf-8;q=0.7,*;q=0.7
+      Accept-Language:
+      - en-us,en;q=0.5
+      Cookie:
+      - _session_id=123abc123abc123abc123abc123abc12
+      Host:
+      - dashboard-03.braze.com
+      Referer:
+      - https://dashboard-03.braze.com/auth?email=BRAZE_EMAIL_ADDRESS
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - '300'
+  response:
+    status:
+      code: 302
+      message: Found
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - text/html; charset=utf-8
+      Location:
+      - https://dashboard-03.braze.com/dashboard/app_usage
+      Server:
+      - nginx
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Request-Id:
+      - 2613eba9-0357-4080-86f6-313e17d1b227
+      X-Runtime:
+      - '0.022998'
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '0'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 31 May 2018 19:51:53 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-sjc3132-SJC
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1527796314.518727,VS0,VE102
+      Strict-Transport-Security:
+      - max-age=86400; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version:
+  recorded_at: Thu, 31 May 2018 19:51:53 GMT
+- request:
+    method: get
+    uri: https://dashboard-03.braze.com/dashboard/app_usage
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip,deflate,identity
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Mechanize/2.7.5 Ruby/2.5.1p57 (http://github.com/sparklemotion/mechanize/)
+      Accept-Charset:
+      - ISO-8859-1,utf-8;q=0.7,*;q=0.7
+      Accept-Language:
+      - en-us,en;q=0.5
+      Cookie:
+      - _session_id=123abc123abc123abc123abc123abc12
+      Host:
+      - dashboard-03.braze.com
+      Referer:
+      - https://dashboard-03.braze.com/auth?email=BRAZE_EMAIL_ADDRESS
+      Connection:
+      - keep-alive
+      Keep-Alive:
+      - '300'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Encoding:
+      - gzip
+      Content-Type:
+      - text/html; charset=utf-8
+      Etag:
+      - W/"17d621ec3966c40ca1fbd8206ed65de6"
+      Server:
+      - nginx
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Request-Id:
+      - 97db1283-331e-4f93-8f26-7a39632b56b7
+      X-Runtime:
+      - '0.226427'
+      X-Xss-Protection:
+      - 1; mode=block
+      Content-Length:
+      - '0'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Thu, 31 May 2018 19:51:54 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-sjc3134-SJC
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      X-Timer:
+      - S1527796314.634948,VS0,VE537
+      Vary:
+      - Accept-Encoding
+      Strict-Transport-Security:
+      - max-age=86400; includeSubDomains
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version:
+  recorded_at: Thu, 31 May 2018 19:51:54 GMT
+recorded_with: VCR 4.0.0