txbr 1.1.1 → 2.0.0

data/lib/txbr/liquid/connected_content_tag.rb

@@ -0,0 +1,99 @@
+require 'liquid'
+require 'uri'
+require 'cgi'
+
+module Txbr
+  module Liquid
+    class ConnectedContentTag < ::Liquid::Tag
+      IDENTIFIER = ::Liquid::Lexer::IDENTIFIER
+
+      # This regex is used to split apart the arguments provided in
+      # connected_content tags, which typically look like this:
+      #
+      # connected_content https://foo.com/strings.json?project_slug=myproj&resource_slug=myrsrc :save strings :retry
+
+      # This is a regular expression to pull out the variable in
+      # which to store the value returned from the call made by
+      # the connected_content filter. For example, if
+      # connected_content makes a request to http://foo.com and is
+      # told to store the results in a variable called "strings",
+      # the API response will then be accessible via the normal
+      # Liquid variable mechanism, i.e. {{...}}. Say the API at
+      # foo.com returned something like {"bar":"baz"}, then the
+      # template might contain {{strings.bar}}, which would print
+      # out "baz".
+      PARSE_RE = /(:#{IDENTIFIER})\s+(#{IDENTIFIER})/
+      ASSIGNS_RE = /\{\{(?:(?!\}\}).)*\}\}/
+
+      attr_reader :tag_name, :url, :arguments
+
+      def initialize(tag_name, arg, _context = nil)
+        @tag_name = tag_name
+        @url, @arguments = parse_arg(arg)
+      end
+
+      # this method is called inside Txbr::ContentTag#metadata
+      def render(context)
+        @metadata_hash =
+          Metadata::ASSIGNMENTS.each_with_object({}) do |assignment, ret|
+            ret[assignment] = context[assignment]
+          end
+      end
+
+      def prefix
+        # we want to blow up if "save" isn't present
+        arguments.fetch('save').first
+      end
+
+      def metadata
+        @metadata ||= begin
+          query_hash = CGI.parse(uri.query)
+
+          Metadata.new(
+            query_hash
+              .each_with_object({}) { |(k, v), ret| ret[k] = v.first }
+              .merge('prefix' => prefix)
+          )
+        end
+      end
+
+      private
+
+      def uri
+        @uri ||= URI.parse(
+          url.gsub(ASSIGNS_RE) do |assign|
+            # remove curlies from beginning and end, look up in assigns hash
+            @metadata_hash[assign.gsub(/\A\{\{|\}\}\z/, '')]
+          end
+        )
+      end
+
+      def parse_arg(arg)
+        url, *components = arg.split(PARSE_RE)
+
+        url.strip!
+        components.map!(&:strip).reject!(&:empty?)
+
+        idx = 0
+        args = {}
+
+        while idx < components.size
+          if components[idx].start_with?(':')
+            key = components[idx][1..-1]
+            sub_args = []
+            idx += 1
+
+            while idx < components.size && !components[idx].start_with?(':')
+              sub_args << components[idx]
+              idx += 1
+            end
+
+            args[key] = sub_args
+          end
+        end
+
+        [url, args]
+      end
+    end
+  end
+end

data/lib/txbr/metadata.rb

@@ -0,0 +1,30 @@
+module Txbr
+  class Metadata
+    ASSIGNMENTS = %w(project_slug resource_slug prefix)
+
+    attr_reader :project_slug, :resource_slug, :prefix
+
+    def initialize(options = {})
+      @project_slug = options.fetch('project_slug')
+      @resource_slug = options.fetch('resource_slug')
+      @prefix = options.fetch('prefix')
+    end
+
+    def ==(other)
+      project_slug == other.project_slug &&
+        resource_slug == other.resource_slug &&
+        prefix == prefix
+    end
+
+    def eql?(other)
+      hash == other.hash
+    end
+
+    def hash
+      h = 7
+      h = 31 * h + project_slug.hash
+      h = 31 * h + resource_slug.hash
+      h = 31 * h + prefix.hash
+    end
+  end
+end

data/lib/txbr/request_methods.rb

@@ -1,7 +1,5 @@
 module Txbr
   module RequestMethods
-    private
-
     def get_json(url, params = {})
       response = get(url, params)
       JSON.parse(response.body)

data/lib/txbr/template.rb

@@ -0,0 +1,54 @@
+module Txbr
+  class Template
+    attr_reader :id, :liquid_template
+
+    def initialize(id, liquid_template)
+      @id = id
+      @liquid_template = liquid_template
+    end
+
+    def each_content_tag
+      return to_enum(__method__) unless block_given?
+
+      content_tags.each do |content_tag|
+        next unless translation_enabled?
+        yield content_tag
+      end
+    end
+
+    private
+
+    def translation_enabled?
+      return @translation_enabled unless @translation_enabled.nil?
+
+      liquid_template.root.nodelist.each do |node|
+        if node.is_a?(::Liquid::Assign)
+          variable = node.instance_variable_get(:@to)
+          value = node.instance_variable_get(:@from).name
+
+          if variable == 'translation_enabled'
+            @translation_enabled = value
+            break
+          end
+        end
+      end
+
+      @translation_enabled = true if @translation_enabled.nil?
+      @translation_enabled
+    end
+
+    def content_tags
+      @content_tags ||= connected_content_tags.map do |tag|
+        ContentTag.new(liquid_template, tag)
+      end
+    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::Liquid::ConnectedContentTag)
+      end
+    end
+  end
+end

data/lib/txbr/template_group.rb

@@ -0,0 +1,50 @@
+module Txbr
+  class TemplateGroup
+    attr_reader :template_name, :templates, :project
+
+    def initialize(template_name, templates, project)
+      @template_name = template_name
+      @templates = templates
+      @project = project
+    end
+
+    def each_resource
+      return to_enum(__method__) unless block_given?
+
+      templates
+        .flat_map { |tmpl| tmpl.each_content_tag.to_a }
+        .group_by(&:metadata)
+        .each do |metadata, content_tags|
+          strings = content_tags.inject(StringsManifest.new) do |manifest, content_tag|
+            manifest.merge(content_tag.strings_manifest)
+          end
+
+          yield to_resource(metadata, strings)
+        end
+    end
+
+    private
+
+    def to_resource(metadata, strings_manifest)
+      phrases = strings_manifest.each_string
+        .reject { |_, value| value.nil? }
+        .map do |path, value|
+          { 'key' => path.join('.'), 'string' => value }
+        end
+
+      return nil if phrases.empty?
+
+      resource = Txgh::TxResource.new(
+        metadata.project_slug,
+        metadata.resource_slug,
+        project.strings_format,
+        project.source_lang,
+        template_name,
+        {},   # lang_map (none)
+        nil   # translation_file (none)
+      )
+
+      Txgh::ResourceContents.from_phrase_list(resource, phrases)
+    end
+  end
+end

data/lib/txbr/version.rb

@@ -1,3 +1,3 @@
 module Txbr
-  VERSION = '1.1.1'
+  VERSION = '2.0.0'
 end

data/spec/campaign_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+require 'support/standard_setup'
+require 'json'
+
+describe Txbr::Campaign do
+  include_context 'standard setup'
+
+  let(:campaign_id) { 'abc123' }
+  let(:campaign) { described_class.new(project, campaign_id) }
+
+  let(:first_message) do
+    <<~MESSAGE
+        {% assign project_slug = "my_project" %}
+        {% assign resource_slug = "my_resource" %}
+        {% assign translation_enabled = true %}
+        {% 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 %}
+
+        {{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 %}
+        {{footer.company | default: 'Megamarketing Corp'}}
+    MESSAGE
+  end
+
+  let(:second_message) do
+    <<~HTML
+      {% assign project_slug = "my_project" %}
+      {% assign resource_slug = "my_resource" %}
+      {% assign translation_enabled = true %}
+      {% 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
+
+  describe '#each_resource' do
+    let(:braze_interactions) do
+      [{
+        request: {
+          verb: 'get',
+          url: Txbr::CampaignsApi::CAMPAIGN_DETAILS_PATH,
+          params: { campaign_id: campaign_id }
+        },
+        response: {
+          status: 200,
+          body: {
+            name: 'World Domination',
+            messages: {
+              abc123: { name: 'Subliminal Messaging', message: first_message },
+              def456: { name: 'Propaganda', message: second_message }
+            }
+          }.to_json
+        }
+      }]
+    end
+
+    it 'extracts and groups all strings with the same project, resource, and prefix' do
+      resource = campaign.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 both messages,
+      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' }
+      ])
+    end
+
+    it 'constructs a txgh resource' do
+      resource = campaign.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('World Domination')
+      expect(tx_resource.source_lang).to eq(project.source_lang)
+      expect(tx_resource.type).to eq(project.strings_format)
+    end
+
+    it 'constructs a separate resource for the footer' do
+      footer = campaign.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 first message' do
+      let(:first_message) do
+        super().tap do |subj|
+          subj.sub!('translation_enabled = true', 'translation_enabled = false')
+        end
+      end
+
+      it 'does not include translations for the first message' do
+        expect(campaign.each_resource.to_a.first.phrases).to_not(
+          include({ 'key' => 'header', 'string' => 'Buy our stuff!' })
+        )
+      end
+    end
+
+    context 'when the message comes from a separate resource' do
+      let(:first_message) do
+        super().tap do |subj|
+          subj.sub!(
+            'resource_slug = "my_resource"',
+            'resource_slug = "my_other_resource"'
+          )
+        end
+      end
+
+      it 'includes the additional resource' do
+        resources = campaign.each_resource.to_a
+        expect(resources.size).to eq(3)
+
+        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' }]
+        )
+
+        expect(resources.first.tx_resource.project_slug).to eq('my_project')
+        expect(resources.first.tx_resource.resource_slug).to eq('my_other_resource')
+      end
+    end
+  end
+end

data/spec/campaigns_api_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'support/fake_connection'
+require 'shared_examples/api_errors'
+
+require 'json'
+
+describe Txbr::CampaignsApi do
+  let(:api_key) { 'abc123' }
+  let(:api_url) { 'https://somewhere.braze.com' }
+  let(:connection) { FakeConnection.new(interactions) }
+  let(:braze_api) { Txbr::BrazeApi.new(api_key, api_url, connection: connection) }
+  let(:client) { described_class.new(braze_api) }
+
+  describe '#each' do
+    subject { client.each.to_a }
+
+    before do
+      stub_const("#{described_class.name}::CAMPAIGN_BATCH_SIZE", 1)
+    end
+
+    let(:interactions) do
+      [{
+        request: { verb: 'get', url: described_class::CAMPAIGN_LIST_PATH, params: { page: 0 } },
+        response: { status: 200, body: { campaigns: [{ id: '123abc' }] }.to_json }
+      }, {
+        request: { verb: 'get', url: described_class::CAMPAIGN_LIST_PATH, params: { page: 1 } },
+        response: { status: 200, body: { campaigns: [{ id: '456def' }] }.to_json }
+      }, {
+        request: { verb: 'get', url: described_class::CAMPAIGN_LIST_PATH, params: { page: 2 } },
+        response: { status: 200, body: { campaigns: [] }.to_json }
+      }]
+    end
+
+    it 'yields each template' do
+      expect(subject).to eq([
+        { 'id' => '123abc' }, { 'id' => '456def' }
+      ])
+    end
+
+    it_behaves_like 'a client request that handles errors'
+  end
+
+  describe '#details' do
+    subject { client.details(campaign_id: campaign_id) }
+    let(:campaign_id) { 'abc123' }
+
+    let(:details) do
+      {
+        'name' => 'World Domination',
+        'messages' => [{
+          'message' => 'Today vegetables. Tomorrow the world.'
+        }, {
+          'message' => 'I haz teh power.'
+        }]
+      }
+    end
+
+    let(:interactions) do
+      [{
+        request: { verb: 'get', url: described_class::CAMPAIGN_DETAILS_PATH, params: { campaign_id: campaign_id } },
+        response: { status: 200, body: details.to_json }
+      }]
+    end
+
+    it 'retrieves the template details' do
+      expect(subject).to eq(details)
+    end
+
+    it_behaves_like 'a client request that handles errors'
+  end
+end