txbr 1.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+$:.push(File.dirname(__FILE__))
+
+require 'rspec'
+require 'rack/test'
+require 'pry-byebug'
+require 'txbr'
+require 'txgh'
+require 'cgi'
+require 'vcr'
+
+require 'support/env_helpers'
+
+FAKE_SESSION_ID = '123abc123abc123abc123abc123abc12'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/cassettes'
+  config.hook_into :webmock
+
+  %w(BRAZE_EMAIL_ADDRESS BRAZE_PASSWORD).each do |var|
+    config.filter_sensitive_data(var) { ENV[var] || var }
+    config.filter_sensitive_data(var) { CGI.escape(ENV[var] || var) }
+  end
+
+  config.before_record do |interaction|
+    # Clear out the body for requests to the dashboard, etc. We need to keep
+    # the body for the auth request so mechanize can find the login form.
+    if %w(/auth).none? { |str| interaction.request.uri.include?(str) }
+      interaction.response.body.replace('')
+      interaction.response.headers['Content-Length'] = ['0']
+    end
+
+    # remove session ID from request cookie header
+    interaction.request.headers.fetch('Cookie', []).each do |header|
+      header.sub!(/_session_id=[a-z0-9]{32}/, "_session_id=#{FAKE_SESSION_ID}")
+    end
+
+    # remove session ID from response set cookie headers
+    interaction.response.headers.fetch('Set-Cookie', []).each do |header|
+      header.sub!(/_session_id=[a-z0-9]{32}/, "_session_id=#{FAKE_SESSION_ID}")
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(EnvHelpers)
+end

data/spec/strings_manifest_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Txbr::StringsManifest do
+  let(:manifest) { described_class.new }
+
+  describe '#add' do
+    it 'adds the string with the given path' do
+      manifest.add(%w(foo bar), 'baz')
+      expect(manifest.to_h).to eq(
+        { 'foo' => { 'bar' => 'baz' } }
+      )
+    end
+
+    it 'nests correctly' do
+      manifest.add(%w(foo bar), 'baz')
+      manifest.add(%w(foo baz boo), 'bizz')
+      expect(manifest.to_h).to eq(
+        { 'foo' => { 'bar' => 'baz', 'baz' => { 'boo' => 'bizz' } } }
+      )
+    end
+  end
+
+  describe '#merge!' do
+    it 'merges the strings from another manifest into this one' do
+      other = described_class.new
+      other.add(%w(foo bar), 'baz')
+      manifest.add(%w(foo baz boo), 'bizz')
+      manifest.merge!(other)
+      expect(manifest.to_h).to eq(
+        { 'foo' => { 'bar' => 'baz', 'baz' => { 'boo' => 'bizz' } } }
+      )
+    end
+  end
+
+  describe '#each' do
+    it 'yields each path and corresponding value' do
+      manifest.add(%w(foo bar), 'baz')
+      manifest.add(%w(foo baz boo), 'bizz')
+
+      expect(manifest.each.to_a).to(
+        eq([[['foo', 'bar'], 'baz'], [['foo', 'baz', 'boo'], 'bizz']])
+      )
+    end
+  end
+end

data/spec/support/env_helpers.rb

@@ -0,0 +1,13 @@
+module EnvHelpers
+  def with_env(env)
+    # ENV can't be duped, so use select instead to make a copy
+    old_env = ENV.select { true }
+    env.each_pair { |k, v| ENV[k] = v }
+    yield
+  ensure
+    # reset back to old vars
+    env.each_pair { |k, _| ENV[k] = old_env[k] }
+  end
+end
+
+EnvHelpers.extend(EnvHelpers)

data/spec/support/fake_braze_session.rb

@@ -0,0 +1,14 @@
+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

data/spec/support/fake_connection.rb

@@ -0,0 +1,78 @@
+class FakeEnv
+  attr_reader :url
+
+  def initialize(url)
+    @url = url
+  end
+end
+
+class FakeResponse
+  attr_reader :env, :status, :body, :headers
+
+  def initialize(url, status, body, headers)
+    @env = FakeEnv.new(url)
+    @status = status
+    @body = body
+    @headers = headers
+  end
+end
+
+class FakeConnection
+  class UnexpectedRequestError < StandardError; end
+
+  attr_reader :interactions
+
+  # of the form:
+  # [{
+  #    request: { verb: 'get', url: 'foo.com', params: { ... }, body: '...' },
+  #    response: { status: 200, body: '...', headers: { ... } }
+  # }]
+  def initialize(interactions)
+    @interactions = interactions
+  end
+
+  def get(url, params = {}, _headers = {})
+    idx, interaction = find_interaction('get', url)
+    raise UnexpectedRequestError, url unless interaction
+
+    if interaction_params = interaction[:request][:params]
+      raise UnexpectedRequestError, url unless params == interaction_params
+    end
+
+    interactions.delete_at(idx)
+    response_for(url, interaction)
+  end
+
+  def post(url, body = '', _headers = {})
+    idx, interaction = find_interaction('post', url)
+    raise UnexpectedRequestError, url unless interaction
+
+    if interaction_body = interaction[:request][:body]
+      raise UnexpectedRequestError, url unless body == interaction_body
+    end
+
+    interactions.delete_at(idx)
+    response_for(url, interaction)
+  end
+
+  private
+
+  def response_for(url ,interaction)
+    FakeResponse.new(
+      url,
+      interaction[:response][:status],
+      interaction[:response][:body],
+      interaction[:response][:headers]
+    )
+  end
+
+  def find_interaction(verb, url)
+    idx = interactions.find_index do |interaction|
+      request = interaction[:request]
+      request[:verb] == verb && request[:url] == url
+    end
+
+    return [nil, nil] unless idx
+    [idx, interactions[idx]]
+  end
+end

data/spec/support/standard_setup.rb

@@ -0,0 +1,20 @@
+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(: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(: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
+  let(:braze_interactions) { [] }
+  let(:transifex_interactions) { [] }
+end

data/spec/support/test_config.rb

@@ -0,0 +1,20 @@
+class TestConfig
+  def self.config
+    {
+      transifex_api_username: 'transifex_username',
+      transifex_api_password: 'transifex_password',
+      projects: [{
+        handler_id: 'email-templates',
+        braze_api_key: 'braze_api_key',
+        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
+end

data/spec/uploader_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'support/standard_setup'
+
+describe Txbr::Uploader do
+  include_context 'standard setup'
+
+  let(:email_template_id) { 'abc123' }
+
+  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: "engagement/email_templates/#{email_template_id}" },
+      response: {
+        status: 200,
+        body: {
+          name: 'Super Slick Awesome',
+          template: template_html,
+          subject: '',
+          preheader: ''
+        }.to_json
+      }
+    }]
+  end
+
+  let(:transifex_interactions) do
+    # indicate the resource doesn't exist so the client will create it
+    [{
+      request: {
+        verb: 'get',
+        url: "#{Txgh::TransifexApi::API_ROOT}/project/my_project/resource/my_resource/"
+      },
+      response: { status: 404 }
+    }]
+  end
+
+  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
+
+  it 'uploads all resources' do
+    # unfortunately this can't be added to the transifex_interactions array
+    # because we need to check the upload contents, which is this funky
+    # UploadIO object from Faraday
+    create_url = "#{Txgh::TransifexApi::API_ROOT}/project/my_project/resources/"
+
+    expect(transifex_connection).to(
+      receive(:post)
+        .with(create_url, Hash) do |url, body|
+          expect(YAML.load(body[:content].io.string)).to eq(
+            {
+              'en' => {
+                'header'=>'Buy our stuff!',
+                'discount'=>'You get a discount',
+                'no_discount'=>'You get no discount'
+              }
+            }
+          )
+
+          FakeResponse.new(create_url, 200, '', {})
+        end
+    )
+
+    described_class.new(project).upload_all
+  end
+end

data/spec/utils_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Txbr::Utils do
+  describe '.url_join' do
+    it 'joins urls' do
+      expect(described_class.url_join(*%w(http://foo.bar baz boo))).to(
+        eq('http://foo.bar/baz/boo')
+      )
+    end
+
+    it 'joins urls with leading slashes' do
+      expect(described_class.url_join(*%w(http://foo.bar/ baz /boo))).to(
+        eq('http://foo.bar/baz/boo')
+      )
+    end
+  end
+end

data/txbr.gemspec

@@ -0,0 +1,27 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'txbr/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'txbr'
+  s.version  = ::Txbr::VERSION
+  s.authors  = ['Cameron Dutro']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'https://github.com/lumoslabs/txbr'
+
+  s.description = s.summary = 'A library for syncing translation resources between Braze and Transifex.'
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_dependency 'abroad', '~> 4.5'
+  s.add_dependency 'faraday', '~> 0.9'
+  s.add_dependency 'faraday_middleware', '~> 0.10'
+  s.add_dependency 'liquid', '~> 4.0'
+  s.add_dependency 'mechanize', '~> 2.7'
+  s.add_dependency 'sinatra', '~> 1.4'
+  s.add_dependency 'sinatra-contrib', '~> 1.4'
+  s.add_dependency 'txgh', '~> 6.6'
+
+  s.require_path = 'lib'
+  s.files = Dir['{lib,spec}/**/*', 'README.md', 'txbr.gemspec', 'LICENSE']
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: txbr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: abroad
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: txgh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.6'
+description: A library for syncing translation resources between Braze and Transifex.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/txbr.rb
+- 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
+- lib/txbr/email_template_component.rb
+- lib/txbr/email_template_handler.rb
+- lib/txbr/project.rb
+- lib/txbr/request_methods.rb
+- lib/txbr/strings_manifest.rb
+- lib/txbr/tasks.rb
+- lib/txbr/uploader.rb
+- lib/txbr/utils.rb
+- lib/txbr/version.rb
+- spec/application_spec.rb
+- spec/braze_session_api_spec.rb
+- spec/braze_session_spec.rb
+- spec/config_spec.rb
+- spec/email_template_spec.rb
+- spec/fixtures/cassettes/braze_login.yml
+- 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
+- spec/uploader_spec.rb
+- spec/utils_spec.rb
+- txbr.gemspec
+homepage: https://github.com/lumoslabs/txbr
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A library for syncing translation resources between Braze and Transifex.
+test_files: []