txbr 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3c02b553986a17b56b22b342fb17880d8fdae3d5d61a109967b26c7a29a0524
-  data.tar.gz: ac13219636877bc7c61536a53bf7e20e6c4f83bdd4c706f4eec05bc15aea436f
+  metadata.gz: 3a26e4fcc27b8a68d3fa2d1460aafaf08966ee6aeaf7a8d16745e79c509955c3
+  data.tar.gz: 10d380377a107dd01c46489870abb21b6fc663d018f3ce88b10670d1f377262f
 SHA512:
-  metadata.gz: 6b2759f1235b6e7490d2d3247f5c3e5e97181857d03a20cda5fb520d11a18ef20ea9651a266e9d5d11022b49979b8843f678f7bee60bb6d72a81fe9b1e799da3
-  data.tar.gz: 85c04374c3c46bfa5a9a51b08ed95ebf09067fd82d87b90f5a40abcf9de880fc097e103b2c34d0346148fc91ea01d88c96fa5258cb923dd10aea8081449be757
+  metadata.gz: 53f0538ee6675d79068528bf834b2df19996f21d1e4c0c731a1cae9b19ee9eccdd5ddb4b6981dd0c68b53dcff6eabe95654037308cecf3a65f6543390f89fa45
+  data.tar.gz: cfddc02280c8c413c4f4a8b0f8f389fc2358b35cdf8940dd149ba7dbab5b6b6013174af205dbf9bad5965d5e14d3b571c0d1d7d5a883a6313a05165ed4f9177a

data/lib/txbr/campaign.rb

@@ -2,6 +2,7 @@ require 'liquid'
 
 module Txbr
   class Campaign
+    ITEM_TYPE = 'campaign'.freeze
     TEMPLATE_KEYS = %w(body subject preheader message alert).freeze
 
     attr_reader :project, :campaign_id
@@ -16,6 +17,16 @@ module Txbr
       template_group.each_resource(&block)
     end
 
+    def metadata
+      @metadata ||= {
+        item_type: ITEM_TYPE,
+        campaign_name: campaign_name,
+        campaign_id: campaign_id
+      }
+    rescue => e
+      {}
+    end
+
     private
 
     def template_group
@@ -29,8 +40,8 @@ module Txbr
             if message = props[key]
               ret << Txbr::Template.new(message_id, ::Liquid::Template.parse(message))
             end
-          rescue ::Liquid::SyntaxError => e
-            Txgh.events.publish_error!(e)
+          rescue => e
+            Txgh.events.publish_error!(e, metadata.merge(template_key: key))
           end
         end
       end

data/lib/txbr/campaign_handler.rb

@@ -11,8 +11,6 @@ module Txbr
       each_campaign { |campaign| campaign.each_resource(&block) }
     end
 
-    private
-
     def each_campaign
       return to_enum(__method__) unless block_given?
 
@@ -20,5 +18,7 @@ module Txbr
         yield Campaign.new(project, campaign['id'])
       end
     end
+
+    alias_method :each_item, :each_campaign
   end
 end

data/lib/txbr/email_template.rb

@@ -3,6 +3,7 @@ require 'txgh'
 
 module Txbr
   class EmailTemplate
+    ITEM_TYPE = 'email_template'.freeze
     TEMPLATE_KEYS = %w(body subject preheader).freeze
 
     attr_reader :project, :email_template_id
@@ -17,6 +18,16 @@ module Txbr
       template_group.each_resource(&block)
     end
 
+    def metadata
+      @metadata ||= {
+        item_type: ITEM_TYPE,
+        template_name: template_name,
+        template_id: email_template_id
+      }
+    rescue => e
+      {}
+    end
+
     private
 
     def template_group
@@ -28,8 +39,8 @@ module Txbr
         begin
           liquid_tmpl = ::Liquid::Template.parse(details[name])
           ret << Txbr::Template.new(email_template_id, liquid_tmpl)
-        rescue ::Liquid::SyntaxError => e
-          Txgh.events.publish_error!(e)
+        rescue => e
+          Txgh.events.publish_error!(e, metadata.merge(template_key: name))
         end
       end
     end

data/lib/txbr/email_template_handler.rb

@@ -14,8 +14,6 @@ module Txbr
       end
     end
 
-    private
-
     def each_template
       return to_enum(__method__) unless block_given?
 
@@ -23,5 +21,7 @@ module Txbr
         yield EmailTemplate.new(project, tmpl['email_template_id'])
       end
     end
+
+    alias_method :each_item, :each_template
   end
 end

data/lib/txbr/uploader.rb

@@ -7,21 +7,27 @@ module Txbr
     end
 
     def upload_all
-      project.handler.each_resource do |resource|
-        begin
-          upload_resource(resource)
-        rescue ::Txgh::TransifexApiError => e
-          Txgh.events.publish_error!(e)
-        end
+      project.handler.each_item do |item|
+        upload_item(item)
       end
     end
 
+    def upload_item(item)
+      item.each_resource do |resource|
+        upload_resource(resource)
+      end
+    end
+
+    private
+
     def upload_resource(resource)
       stream = StringIO.new
       resource.write_to(stream)
       project.transifex_api.create_or_update(
         resource.tx_resource, stream.string
       )
+    rescue ::Txgh::TransifexApiError => e
+      Txgh.events.publish_error!(e)
     end
   end
 end

data/lib/txbr/version.rb

@@ -1,3 +1,3 @@
 module Txbr
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

data/spec/campaign_spec.rb

@@ -36,27 +36,27 @@ describe Txbr::Campaign do
     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
+  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
 
+  describe '#each_resource' do
     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')
@@ -132,5 +132,35 @@ describe Txbr::Campaign do
         expect(resources.first.tx_resource.resource_slug).to eq('my_other_resource')
       end
     end
+
+    context 'when an error occurs' do
+      before do
+        allow(::Liquid::Template).to receive(:parse).and_raise('jelly beans')
+      end
+
+      it 'passes item metadata to the error handler' do
+        errors = []
+
+        Txgh.events.subscribe('errors') do |e, params|
+          errors << [e, params]
+        end
+
+        expect { campaign.each_resource.to_a }.to change { errors.size }.by_at_least(1)
+
+        errors.each do |(_error, params)|
+          expect(params).to eq(campaign.metadata.merge(template_key: 'message'))
+        end
+      end
+    end
+  end
+
+  describe '#metadata' do
+    it 'includes the correct values' do
+      expect(campaign.metadata).to eq(
+        item_type: 'campaign',
+        campaign_name: 'World Domination',
+        campaign_id: campaign_id
+      )
+    end
   end
 end

data/spec/email_template_spec.rb

@@ -54,26 +54,26 @@ describe Txbr::EmailTemplate do
     HTML
   end
 
-  describe '#each_resource' do
-    let(:braze_interactions) do
-      [{
-        request: {
-          verb: 'get',
-          url: Txbr::EmailTemplatesApi::TEMPLATE_DETAILS_PATH,
-          params: { email_template_id: email_template_id }
-        },
-        response: {
-          status: 200,
-          body: {
-            template_name: 'Super Slick Awesome',
-            body: body_html,
-            subject: subject_html,
-            preheader: preheader_html
-          }.to_json
-        }
-      }]
-    end
+  let(:braze_interactions) do
+    [{
+      request: {
+        verb: 'get',
+        url: Txbr::EmailTemplatesApi::TEMPLATE_DETAILS_PATH,
+        params: { email_template_id: email_template_id }
+      },
+      response: {
+        status: 200,
+        body: {
+          template_name: 'Super Slick Awesome',
+          body: body_html,
+          subject: subject_html,
+          preheader: preheader_html
+        }.to_json
+      }
+    }]
+  end
 
+  describe '#each_resource' do
     it 'extracts and groups all strings with the same project, resource, and prefix' do
       resource = email_template.each_resource.to_a.first
       expect(resource.tx_resource.project_slug).to eq('my_project')
@@ -151,5 +151,39 @@ describe Txbr::EmailTemplate do
         expect(resources.last.tx_resource.resource_slug).to eq('my_other_resource')
       end
     end
+
+    context 'when an error occurs' do
+      before do
+        allow(::Liquid::Template).to receive(:parse).and_raise('jelly beans')
+      end
+
+      it 'passes item metadata to the error handler' do
+        errors = []
+
+        Txgh.events.subscribe('errors') do |e, params|
+          errors << [e, params]
+        end
+
+        expect { email_template.each_resource.to_a }.to change { errors.size }.by_at_least(1)
+
+        email_template.class::TEMPLATE_KEYS.each do |key|
+          idx = errors.index { |(_err, params)| params[:template_key] == key }
+          expect(errors[idx][1]).to eq(email_template.metadata.merge(template_key: key))
+          errors.delete_at(idx)
+        end
+
+        expect(errors).to be_empty
+      end
+    end
+  end
+
+  describe '#metadata' do
+    it 'includes the correct values' do
+      expect(email_template.metadata).to eq(
+        item_type: 'email_template',
+        template_name: 'Super Slick Awesome',
+        template_id: email_template_id
+      )
+    end
   end
 end

data/spec/spec_helper.rb

@@ -11,4 +11,9 @@ require 'support/env_helpers'
 
 RSpec.configure do |config|
   config.include(EnvHelpers)
+
+  config.after(:each) do
+    # clear out event handlers
+    Txgh.events.channel_hash.clear
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: txbr
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-13 00:00:00.000000000 Z
+date: 2019-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abroad