RubyGems - txbr - Versions diffs - 1.1.1 → 2.0.0 - Mend

txbr 1.1.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (26) hide show

checksums.yaml +4 -4
data/README.md +16 -10
data/lib/txbr.rb +11 -23
data/lib/txbr/braze_api.rb +4 -20
data/lib/txbr/campaign.rb +39 -0
data/lib/txbr/campaign_handler.rb +24 -0
data/lib/txbr/campaigns_api.rb +29 -0
data/lib/txbr/content_tag.rb +64 -0
data/lib/txbr/email_template.rb +9 -40
data/lib/txbr/email_template_handler.rb +1 -1
data/lib/txbr/email_templates_api.rb +33 -0
data/lib/txbr/liquid.rb +5 -0
data/lib/txbr/liquid/connected_content_tag.rb +99 -0
data/lib/txbr/metadata.rb +30 -0
data/lib/txbr/request_methods.rb +0 -2
data/lib/txbr/template.rb +54 -0
data/lib/txbr/template_group.rb +50 -0
data/lib/txbr/version.rb +1 -1
data/spec/campaign_spec.rb +136 -0
data/spec/campaigns_api_spec.rb +71 -0
data/spec/email_template_spec.rb +25 -10
data/spec/{braze_api_spec.rb → email_templates_api_spec.rb} +11 -48
data/spec/shared_examples/api_errors.rb +40 -0
data/spec/uploader_spec.rb +10 -4
metadata +16 -4
data/lib/txbr/email_template_component.rb +0 -96

data/spec/email_template_spec.rb CHANGED

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'support/standard_setup'
+require 'json'
 describe Txbr::EmailTemplate do
   include_context 'standard setup'
@@ -14,7 +15,8 @@ describe Txbr::EmailTemplate do
           {% assign project_slug = "my_project" %}
           {% assign resource_slug = "my_resource" %}
           {% assign translation_enabled = true %}
-          {% connected_content http://my_strings_api.com/ :save strings %}
+          {% connected_content http://my_strings_api.com?project_slug={{project_slug}}&resource_slug={{resource_slug}} :save strings %}
+          {% connected_content http://my_strings_api.com?project_slug=my_project&resource_slug=my_footer_resource :save footer %}
         </head>
         <body>
           {{strings.header | default: 'Buy our stuff!'}}
@@ -23,6 +25,7 @@ describe Txbr::EmailTemplate do
           {% else %}
             {{strings.no_discount | default: 'You get no discount'}}
           {% endif %}
+          {{footer.company | default: 'Megamarketing Corp'}}
         </body>
       </html>
     HTML
@@ -33,7 +36,7 @@ describe Txbr::EmailTemplate do
       {% assign project_slug = "my_project" %}
       {% assign resource_slug = "my_resource" %}
       {% assign translation_enabled = true %}
-      {% connected_content http://my_strings_api.com/ :save strings %}
+      {% connected_content http://my_strings_api.com?project_slug={{project_slug}}&resource_slug={{resource_slug}} :save strings %}
       {{strings.meta.subject_line | default: 'You lucky duck maybe'}}
     HTML
   end
@@ -43,7 +46,7 @@ describe Txbr::EmailTemplate do
       {% assign project_slug = "my_project" %}
       {% assign resource_slug = "my_resource" %}
       {% assign translation_enabled = true %}
-      {% connected_content http://my_strings_api.com/ :save strings %}
+      {% connected_content http://my_strings_api.com?project_slug={{project_slug}}&resource_slug={{resource_slug}} :save strings %}
       {{strings.meta.preheader | default: 'Our stuff is the bomb and you should buy it.'}}
     HTML
   end
@@ -53,7 +56,7 @@ describe Txbr::EmailTemplate do
       [{
         request: {
           verb: 'get',
-          url: Txbr::BrazeApi::TEMPLATE_INFO_PATH,
+          url: Txbr::EmailTemplatesApi::TEMPLATE_DETAILS_PATH,
           params: { email_template_id: email_template_id }
         },
         response: {
@@ -69,10 +72,9 @@ describe Txbr::EmailTemplate do
     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
+      resource = email_template.each_resource.to_a.first
+      expect(resource.tx_resource.project_slug).to eq('my_project')
+      expect(resource.tx_resource.resource_slug).to eq('my_resource')
       # notice how it combined strings from the subject, preheader,
       # and template (i.e. HTML body)
@@ -96,6 +98,16 @@ describe Txbr::EmailTemplate do
       expect(tx_resource.type).to eq(project.strings_format)
     end
+    it 'constructs a separate resource for the footer' do
+      footer = email_template.each_resource.to_a.last
+      expect(footer.tx_resource.project_slug).to eq('my_project')
+      expect(footer.tx_resource.resource_slug).to eq('my_footer_resource')
+      expect(footer.phrases).to eq([
+        { 'key' => 'company', 'string' => 'Megamarketing Corp' }
+      ])
+    end
     context 'with translations disabled for the subject' do
       let(:subject_html) do
         super().tap do |subj|
@@ -120,9 +132,9 @@ describe Txbr::EmailTemplate do
         end
       end
-      it 'includes two resources' do
+      it 'includes the additional resource' do
         resources = email_template.each_resource.to_a
-        expect(resources.size).to eq(2)
+        expect(resources.size).to eq(3)
         expect(resources.first.phrases).to_not(
           include({ 'key' => 'meta.subject_line', 'string' => 'You lucky duck maybe' })
@@ -131,6 +143,9 @@ describe Txbr::EmailTemplate do
         expect(resources.last.phrases).to eq(
           [{ 'key' => 'meta.subject_line', 'string' => 'You lucky duck maybe' }]
         )
+        expect(resources.last.tx_resource.project_slug).to eq('my_project')
+        expect(resources.last.tx_resource.resource_slug).to eq('my_other_resource')
       end
     end
   end

data/spec/{braze_api_spec.rb → email_templates_api_spec.rb} RENAMED

@@ -1,55 +1,18 @@
 require 'spec_helper'
 require 'support/fake_connection'
+require 'shared_examples/api_errors'
-describe Txbr::BrazeApi do
+require 'json'
+describe Txbr::EmailTemplatesApi do
   let(:api_key) { 'abc123' }
   let(:api_url) { 'https://somewhere.braze.com' }
   let(:connection) { FakeConnection.new(interactions) }
-  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
-      let(:interactions) do
-        super().tap do |inter|
-          inter[0][:response][:status] = 404
-        end
-      end
-      it 'raises a not found error' do
-        expect { subject }.to raise_error(Txbr::BrazeNotFoundError)
-      end
-    end
-    context 'when the request is unauthorized' do
-      let(:interactions) do
-        super().tap do |inter|
-          inter.unshift(
-            request: inter[0][:request],
-            response: { status: 401 }
-          )
-        end
-      end
-      it 'raises an unauthorized error' do
-        expect { subject }.to raise_error(Txbr::BrazeUnauthorizedError)
-      end
-    end
-    context 'when some other bad thing happens' do
-      let(:interactions) do
-        super().tap do |inter|
-          inter[0][:response][:status] = 500
-        end
-      end
-      it 'raises a generic error' do
-        expect { subject }.to raise_error(Txbr::BrazeApiError)
-      end
-    end
-  end
+  let(:braze_api) { Txbr::BrazeApi.new(api_key, api_url, connection: connection) }
+  let(:client) { described_class.new(braze_api) }
-  describe '#each_email_template' do
-    subject { client.each_email_template.to_a }
+  describe '#each' do
+    subject { client.each.to_a }
     before do
       stub_const("#{described_class.name}::TEMPLATE_BATCH_SIZE", 1)
@@ -78,8 +41,8 @@ describe Txbr::BrazeApi do
     it_behaves_like 'a client request that handles errors'
   end
-  describe '#get_email_template_details' do
-    subject { client.get_email_template_details(email_template_id: email_template_id) }
+  describe '#details' do
+    subject { client.details(email_template_id: email_template_id) }
     let(:email_template_id) { 'abc123' }
     let(:details) do
@@ -93,7 +56,7 @@ describe Txbr::BrazeApi do
     let(:interactions) do
       [{
-        request: { verb: 'get', url: described_class::TEMPLATE_INFO_PATH, params: { email_template_id: email_template_id } },
+        request: { verb: 'get', url: described_class::TEMPLATE_DETAILS_PATH, params: { email_template_id: email_template_id } },
         response: { status: 200, body: details.to_json }
       }]
     end

data/spec/shared_examples/api_errors.rb ADDED

@@ -0,0 +1,40 @@
+shared_examples 'a client request that handles errors' do
+  context 'when the resource is not found' do
+    let(:interactions) do
+      super().tap do |inter|
+        inter[0][:response][:status] = 404
+      end
+    end
+    it 'raises a not found error' do
+      expect { subject }.to raise_error(Txbr::BrazeNotFoundError)
+    end
+  end
+  context 'when the request is unauthorized' do
+    let(:interactions) do
+      super().tap do |inter|
+        inter.unshift(
+          request: inter[0][:request],
+          response: { status: 401 }
+        )
+      end
+    end
+    it 'raises an unauthorized error' do
+      expect { subject }.to raise_error(Txbr::BrazeUnauthorizedError)
+    end
+  end
+  context 'when some other bad thing happens' do
+    let(:interactions) do
+      super().tap do |inter|
+        inter[0][:response][:status] = 500
+      end
+    end
+    it 'raises a generic error' do
+      expect { subject }.to raise_error(Txbr::BrazeApiError)
+    end
+  end
+end

data/spec/uploader_spec.rb CHANGED

@@ -10,15 +10,21 @@ describe Txbr::Uploader do
     [{
       request: {
         verb: 'get',
-        url: Txbr::BrazeApi::TEMPLATE_LIST_PATH,
-        params: { offset: 1, limit: Txbr::BrazeApi::TEMPLATE_BATCH_SIZE }
+        url: Txbr::EmailTemplatesApi::TEMPLATE_LIST_PATH,
+        params: { offset: 1, limit: Txbr::EmailTemplatesApi::TEMPLATE_BATCH_SIZE }
       },
       response: {
         status: 200,
         body: { templates: [{ email_template_id: email_template_id }] }.to_json
       }
     }, {
-      request: { verb: 'get', url: Txbr::BrazeApi::TEMPLATE_INFO_PATH, params: { email_template_id: email_template_id } },
+      request: {
+        verb: 'get',
+        url: Txbr::EmailTemplatesApi::TEMPLATE_DETAILS_PATH,
+        params: { email_template_id: email_template_id }
+      },
       response: {
         status: 200,
         body: {
@@ -49,7 +55,7 @@ describe Txbr::Uploader do
           {% assign project_slug = "my_project" %}
           {% assign resource_slug = "my_resource" %}
           {% assign translation_enabled = true %}
-          {% connected_content http://my_strings_api.com/ :save strings %}
+          {% connected_content http://my_strings_api.com?project_slug={{project_slug}}&resource_slug={{resource_slug}} :save strings %}
         </head>
         <body>
           {{strings.header | default: 'Buy our stuff!'}}

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: txbr
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-10 00:00:00.000000000 Z
+date: 2019-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abroad
@@ -120,22 +120,34 @@ files:
 - lib/txbr.rb
 - lib/txbr/application.rb
 - lib/txbr/braze_api.rb
+- lib/txbr/campaign.rb
+- lib/txbr/campaign_handler.rb
+- lib/txbr/campaigns_api.rb
 - lib/txbr/commands.rb
 - lib/txbr/config.rb
+- lib/txbr/content_tag.rb
 - lib/txbr/email_template.rb
-- lib/txbr/email_template_component.rb
 - lib/txbr/email_template_handler.rb
+- lib/txbr/email_templates_api.rb
+- lib/txbr/liquid.rb
+- lib/txbr/liquid/connected_content_tag.rb
+- lib/txbr/metadata.rb
 - lib/txbr/project.rb
 - lib/txbr/request_methods.rb
 - lib/txbr/strings_manifest.rb
 - lib/txbr/tasks.rb
+- lib/txbr/template.rb
+- lib/txbr/template_group.rb
 - lib/txbr/uploader.rb
 - lib/txbr/utils.rb
 - lib/txbr/version.rb
 - spec/application_spec.rb
-- spec/braze_api_spec.rb
+- spec/campaign_spec.rb
+- spec/campaigns_api_spec.rb
 - spec/config_spec.rb
 - spec/email_template_spec.rb
+- spec/email_templates_api_spec.rb
+- spec/shared_examples/api_errors.rb
 - spec/spec_helper.rb
 - spec/strings_manifest_spec.rb
 - spec/support/env_helpers.rb

data/lib/txbr/email_template_component.rb DELETED

@@ -1,96 +0,0 @@
-module Txbr
-  class EmailTemplateComponent
-    ASSIGNMENTS = %w(project_slug resource_slug translation_enabled)
-    attr_reader :liquid_template
-    def initialize(liquid_template)
-      @liquid_template = liquid_template
-    end
-    def project_slug
-      # blow up with KeyError if not found
-      assignments.fetch('project_slug')
-    end
-    def resource_slug
-      # blow up with KeyError if not found
-      assignments.fetch('resource_slug')
-    end
-    def translation_enabled?
-      # translation is disabled by default
-      assignments.fetch('translation_enabled', true)
-    end
-    def assignments
-      @assignments ||= {}.tap do |assgn|
-        liquid_template.root.nodelist.each do |node|
-          case node
-            when Liquid::Assign
-              to = node.instance_variable_get(:@to)
-              if ASSIGNMENTS.include?(to)
-                from = node.instance_variable_get(:@from).name
-                assgn[to] = from
-              end
-          end
-        end
-      end
-    end
-    def strings
-      @strings ||= StringsManifest.new.tap do |manifest|
-        extract_strings_from(liquid_template.root, manifest)
-      end
-    end
-    private
-    def extract_strings_from(root, manifest)
-      return unless root.nodelist
-      root.nodelist.each do |node|
-        case node
-          # We only care about Liquid variables, which are written
-          # like {{prefix.foo.bar}}. We identify the prefix (i.e.
-          # the first lookup, or path segment) to verify it's
-          # associated with a connected_content call. Then we add
-          # the prefix and the rest of the lookups to the strings
-          # manifest along with the value. The prefix is used to
-          # divide the strings into individual Transifex resources
-          # while the rest of the lookups form the string's key.
-          when Liquid::Variable
-            next unless node.name.is_a?(Liquid::VariableLookup)
-            prefix = node.name.name
-            path = node.name.lookups
-            # the English translation (or whatever language your
-            # source strings are written in) is provided using
-            # Liquid's built-in "default" filter
-            next unless connected_content_prefixes.include?(prefix)
-            default = node.filters.find { |f| f.first == 'default' }
-            manifest.add(path, default&.last&.first)
-        end
-        if node.respond_to?(:nodelist)
-          extract_strings_from(node, manifest)
-        end
-      end
-    end
-    def connected_content_prefixes
-      @connected_content_prefixes ||= connected_content_tags.map(&:prefix)
-    end
-    def connected_content_tags
-      # this assumes these are basically at the top of the template and not
-      # nested inside other liquid tags
-      @connected_content_tags ||= liquid_template.root.nodelist.select do |node|
-        node.is_a?(Txbr::ConnectedContentTag)
-      end
-    end
-  end
-end