txbr 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad8a2929f789e8df389eba18aab034fbd3c089306ef86b86e496859196088aea
+  data.tar.gz: ab4a6147c75a7432e2ef0b34c30efdd5949cd1a07b774eae1d84e953a0c7d111
+SHA512:
+  metadata.gz: 93871ba2e176ff5c9fcf85a9a521fd209fbec9599f286fb52be30f447bc1016a31d2a93587a918ebd7a4a55d80935a4ae9b79256460bc1f0f26ec5bb187b310b
+  data.tar.gz: 38b3253c2bfaa7053c9605c7bc7e861d86b3d702ab63acd27ee78c6e0e264f7e6406473d52880c952c7a0d259ba990e28c6fc33cc74740657fad7f2f6c2009a1

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,137 @@
+Txbr
+====
+
+[![Build Status](https://travis-ci.org/lumoslabs/txbr.svg?branch=master)](https://travis-ci.org/lumoslabs/txbr)
+
+Txbr, a mashup of "Transifex" and "Braze", is an automation tool that facilitates translating Braze content (emails, push notifications, etc) with Transifex, a popular translation management system.
+
+How does it work?
+---
+
+Txbr looks for specific Liquid tags in your email templates, push notifications, etc to know what translations your template contains and where to store them in Transifex. Txbr extracts source language strings (i.e. strings in English) from your templates and creates resources in Transifex. Once translations are ready, you can use Braze's Connected Content feature to make them available in your template.
+
+Here's an example template for the impatient:
+
+```liquid
+<html>
+  <head>
+    {% assign project_slug = "my_transifex_project" %}
+    {% assign resource_slug = "my_transifex_resource" %}
+    {% connected_content https://your_txbr_server.com/strings.json?project_slug={{project_slug}}&resource_slug={{resource_slug}}&locale={{${language} | default: 'en'}}&strings_format=YML :basic_auth txbr :save strings %}
+  </head>
+  <body>
+    {{strings.header.title | default: "Buy my stuff!"}}
+  </body>
+</html>
+```
+
+There are several important bits in the example above:
+
+1. Every template you would like Txbr to manage must contain these three required Liquid tags: `assign project_slug`, `assign resource_slug`, and `connected_content`. The first two correspond to the Transifex project and resource in which you would like to store the template's strings, and the third is the mechanism by which translations are fetched and inserted into the template when it is previewed or delivered.
+2. The project slug should correspond to a valid Transifex project. You'll need to create the project in Transifex, then copy the slug from the URL.
+3. The resource slug should be unique within the Transifex project and must only contain uppercase and lowercase letters, numbers, underscores (i.e. "_"), and dashes (i.e. "-"). It's a safe bet to simply use the template's API identifier found at the bottom of the template's configuration page. Txbr itself places no restrictons on and performs no validation against this field, so it can contain any custom slug you want.
+4. The `connected_content` tag fetches translated content from Transifex using the project and resource slugs you assigned earlier in the locale of the "current" user. When previewing your template, the locale can be set in the left-hand sidebar via a simulated current user.
+5. Notice the `{{strings.header.title | default: "Buy my stuff!}}` tag. This defines and fetches a string at the key `header.title`, with a default English value of "Buy my stuff!" Txbr uses this key and default value to construct the translation file it will submit to Transifex. Providing a default value allows for easy template construction and previewing, since your template probably won't be translated immediately. Braze will fall back to this value if the translation doesn't yet exist. Liquid tags that do not specify a default value will not be included in the submission to Transifex. Finally, pay close attention to the `strings.` prefix. It corresponds to the `connected_content` tag's `:save strings` option. The `:save` option tells Braze to store the translated strings in a template variable called `strings`, which can then be used to grab individual strings. The value given to `:save` must be the same value used as the key prefix. For example, simply typing `{{header.title}}` won't work.
+
+### Enabling Translation
+
+Template translation is enabled by default. To skip translating a given template, add the following Liquid tag to the top of your template:
+
+```liquid
+{% assign translation_enabled = false %}
+```
+
+Configuration
+---
+
+Txbr requires several configuration options in order to communicate with Braze and Transifex. Configuration is done in the YAML file format. Here's an example:
+
+```yaml
+projects:
+  - handler_id: email-templates
+    transifex_api_username: tx_username
+    transifex_api_password: tx_password
+    strings_format: YML
+    source_lang: en
+    braze_email_address: login@yourcompany.com
+    braze_password: your_braze_password
+    braze_app_group_id: your_braze_app_group_id
+    braze_api_url: https://dashboard-03.braze.com/
+
+```
+
+1. The `handler_id` indicates what kind of content this project should contain. In this case, we're translating email templates, the only currently supported option.
+2. Your Transifex username and password should have access to the Transifex projects you want to submit content to. You can configure access via Transifex's access control system.
+3. The `strings_format` option must be one of [Transifex's supported formats](https://docs.transifex.com/formats/introduction).
+4. The `source_lang` option should be the language in which your source strings are written in. In other words, it should be the language in which the `default:` text is written in your template's Liquid tags.
+
+### Using Configuration
+
+Txbr supports two different ways of accessing configuration, raw text and a file path. In both cases, config is passed via the `TXBR_CONFIG` environment variable. Prefix the raw text or file path with the appropriate scheme, `raw://` or `file://`, to indicate which strategy Txbr should use.
+
+#### Raw Config
+
+Passing raw config to Txbr can be done like this:
+
+```bash
+export TXBR_CONFIG="raw://big_yaml_string_here"
+```
+
+When Txbr starts up, it will use the YAML payload that starts after `raw://`.
+
+#### File Config
+
+It might make more sense to store all your config in a file. Pass the path to Txbr like this:
+
+```bash
+export TXBR_CONFIG="file://path/to/config.yml"
+```
+
+When Txbr runs, it will read and parse the file at the path that comes after `file://`.
+
+Usage
+---
+
+Txbr is both a library and a server. It provides access to Transifex resources via a single API endpoint, `strings.json`, and includes a set of rake tasks to extract strings from templates and upload them to Transifex.
+
+### API Endpoint
+
+Txbr provides a single API endpoint for retrieving translated content from Transifex. You'll need to stand up a Txbr server somewhere and make it publicly available on the Internet. The URL to your server will be used in the `connected_content` tag in your Braze templates (see above).
+
+The endpoint will be available at http://your_txbr_server.com/strings.json and accepts the following required GET parameters:
+
+1. **project_slug**: The Transifex project slug in which the resource resides.
+2. **resource_slug**: The Transifex resource containing the translated content.
+3. **locale**: The locale (i.e. language) to fetch translations for.
+4. **strings_format**: The Transifex-supported strings format the resource was created with. In our examples, we have used "YML".
+
+The easiest way to get
+
+### Rake Tasks
+
+First, load the rake task via `require txbr/tasks`. Then run `rake txbr:upload_all`. You can also install the gem and use the provided (very simple) CLI tool: `txbr upload_all`.
+
+Running Tests
+---
+
+Txbr uses the popular RSpec test framework and has a comprehensive set of unit tests. To run the test suite, run `bundle exec rspec`.
+
+Requirements
+---
+
+Txbr requires an Internet connection to access the Transifex and Braze APIs.
+
+Compatibility
+---
+
+Txdb requires Ruby 2.5.
+
+Authors
+---
+
+This project is maintained by [Cameron Dutro](https://github.com/camertron).
+
+License
+---
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file included in this repository for the full text.

data/lib/txbr.rb

@@ -0,0 +1,81 @@
+require 'liquid'
+
+module Txbr
+  autoload :Application,            'txbr/application'
+  autoload :BrazeApi,               'txbr/braze_api'
+  autoload :BrazeSession,           'txbr/braze_session'
+  autoload :BrazeSessionApi,        'txbr/braze_session_api'
+  autoload :Commands,               'txbr/commands'
+  autoload :Config,                 'txbr/config'
+  autoload :EmailTemplate,          'txbr/email_template'
+  autoload :EmailTemplateComponent, 'txbr/email_template_component'
+  autoload :EmailTemplateHandler,   'txbr/email_template_handler'
+  autoload :Project,                'txbr/project'
+  autoload :RequestMethods,         'txbr/request_methods'
+  autoload :StringsManifest,        'txbr/strings_manifest'
+  autoload :Uploader,               'txbr/uploader'
+  autoload :Utils,                  'txbr/utils'
+
+  class BrazeApiError < StandardError
+    attr_reader :status_code
+
+    def initialize(message, status_code)
+      super(message)
+      @status_code = status_code
+    end
+  end
+
+  class BrazeUnauthorizedError < BrazeApiError
+    def initialize(message)
+      super(message, 401)
+    end
+  end
+
+  class BrazeNotFoundError < BrazeApiError
+    def initialize(message)
+      super(message, 404)
+    end
+  end
+
+  class << self
+    def handler_for(project)
+      handlers[project.handler_id].new(project)
+    end
+
+    def register_handler(id, klass)
+      handlers[id] = klass
+    end
+
+    private
+
+    def handlers
+      @handlers ||= {}
+    end
+  end
+
+  Txbr.register_handler('email-templates', Txbr::EmailTemplateHandler)
+
+
+  class ConnectedContentTag < Liquid::Tag
+    # 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".
+    PREFIX_RE = /:save\s+(#{Liquid::Lexer::IDENTIFIER})/
+
+    attr_reader :tag_name, :prefix
+
+    def initialize(tag_name, arg, *)
+      @tag_name = tag_name
+      @prefix = arg.match(PREFIX_RE).captures.first
+    end
+  end
+
+  Liquid::Template.register_tag(:connected_content, ConnectedContentTag)
+end

data/lib/txbr/application.rb

@@ -0,0 +1,48 @@
+require 'abroad'
+require 'json'
+require 'sinatra/json'
+require 'txgh'
+
+module Txbr
+  class Application < Sinatra::Base
+    TARGET_FORMAT = 'json/dotted-key'.freeze
+    REQUIRED_PARAMS = %w(project_slug resource_slug locale strings_format).freeze
+
+    get '/strings.json' do
+      begin
+        REQUIRED_PARAMS.each do |required_param|
+          unless params.include?(required_param)
+            status 400
+            return json(error: "Missing parameter '#{required_param}'")
+          end
+        end
+
+        transifex_client = Txgh::TransifexApi.create_from_credentials(
+          Txbr::Config.transifex_api_username,
+          Txbr::Config.transifex_api_password
+        )
+
+        source = transifex_client.download(
+          params[:project_slug], params[:resource_slug], params[:locale]
+        )
+
+        target = StringIO.new
+        strings_format = Txgh::ResourceContents::EXTRACTOR_MAP[params[:strings_format]]
+
+        Abroad.serializer(TARGET_FORMAT).from_stream(target, params[:locale]) do |serializer|
+          Abroad.extractor(strings_format)
+            .from_string(source)
+            .extract_each do |key, value|
+              serializer.write_key_value(key, value)
+            end
+        end
+
+        status 200
+        json(JSON.parse(target.string))
+      rescue StandardError => e
+        status 500
+        json(error: e.message)
+      end
+    end
+  end
+end