txdb 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26654801172fbb542a042bcb6a0449b76ed7b5e7
-  data.tar.gz: deca843a00c592d7f8170c6616e40978b43c99a0
+  metadata.gz: c39d7cc267503be406ceb9aea841669d0734fab7
+  data.tar.gz: 56f4f9eb4af42d20367931b2848b38f9e9702010
 SHA512:
-  metadata.gz: a788e05c2df484b71aa34676f91717d54a53b467f58f0c2c3845b93a5913bddc8afc1291daf21e6d92a9f3922e3a848f6d37d48b48106035a7cf43e12adb611c
-  data.tar.gz: 2436f1495010364e154322a7896fd1cccf37ca1f6e2534bd182ef72e0e15692da64ec231011c13b51578eb13bf40d62b01246edfe05a5094169537a09dc70e05
+  metadata.gz: 4fc62d35484b27195e8e03a6ab378da42efb361eeb2a2442175a89be9d884cfd9d7f2eee05414b41c2d0d4e90e87617f3a7be7f2f726664a26043d624aff49d9
+  data.tar.gz: 4442273c412a2bc1d289e39a80d06ecdb0c15592dbfb4ad8a3eac92807da24c6ec1b965fd18c4e063a42700b7ad2e5205746a3594b0532836ca7af8a7d16948e

data/README.md

@@ -5,13 +5,109 @@ Txdb
 
 Txdb, a mashup of "Transifex" and "database", is an automation tool that facilitates translating database content with Transifex, a popular translation management system.
 
-### Configuration
+Configuration
+---
+
+Configuration is done in the YAML file format. Here's an example:
+
+```yaml
+databases:
+- adapter: mysql2
+  backend: globalize
+  username: txdb_user
+  password: passpasspass
+  host: my-host.com
+  port: 3306
+  name: mydb_production
+  pool: 10
+  locales:
+  - de
+  - es
+  - fr
+  - pt
+  - ja
+  - ko
+  source_locale: en
+  transifex:
+    organization: my-org
+    project_slug: my-project
+    username: txgh.user
+    password: passpasspass
+    webhook_secret: secretsecretsecret
+  tables:
+  - name: product_translations
+    columns:
+    - name
+    - description
+```
+
+The root of the config hierarchy is an array of databases. Each one specifies how to connect to a specific database, which backend to use (see below), what Transifex project it's associated with, and which tables and columns to sync. Txdb will upload a new resource for each table.
+
+### Using Configuration
+
+Txdb supports two different ways of accessing configuration, raw text and a file path. In both cases, config is passed via the `TXDB_CONFIG` environment variable. Prefix the raw text or file path with the appropriate scheme, `raw://` or `file://`, to indicate which strategy Txgh should use.
+
+#### Raw Config
+
+Passing raw config to Txdb can be done like this:
+
+```bash
+export TXDB_CONFIG="raw://big_yaml_string_here"
+```
+
+When Txdb 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 Txdb like this:
+
+```bash
+export TXDB_CONFIG="file://path/to/config.yml"
+```
+
+When Txdb runs, it will read and parse the file at the path that comes after `file://`.
+
+Of course, in both the file and the raw cases, environment variables can be specified via `export` or inline when starting Txdb.
+
+Backends
+---
+
+Backends provide different strategies for syncing content between Transifex and your database. They are made up of a reader and a writer. Currently the only supported backend is the Globalize backend, which understands the database translation strategy used by the [Globalize](https://github.com/globalize/globalize) gem. Adding additional backends is straightforward. Use the Globalize backend as a model to create the reader, writer, and backend classes, then register your new backend:
+
+```ruby
+Txdb::Backends.register(
+  'my-cool-backend', MyModule::MyBackendClass
+)
+```
+
+Usage
+---
+
+Txdb contains a number of HTTP endpoints for triggering uploads and downloads to and from Transifex. However, they're largely untested as of this writing. We suggest you write small scripts instead. The endpoints may be improved later, but right now it's not a priority.
+
+### Downloading
+
+```ruby
+require 'txdb'
+
+Txdb::Config.databases.each do |database|
+  Txdb::Downloader.download_all(database)
+end
+```
+
+When running this script, make sure you set the `TXDB_CONFIG` environment variable.
+
+### Uploading
 
-Coming soon.
+```ruby
+require 'txdb'
 
-### Usage
+Txdb::Config.databases.each do |database|
+  Txdb::Uploader.upload(database)
+end
+```
 
-Coming soon.
+When running this script, make sure you set the `TXDB_CONFIG` environment variable.
 
 Running Tests
 ---

data/lib/txdb/version.rb

@@ -1,3 +1,3 @@
 module Txdb
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

data/txdb.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activesupport', '~> 4.0'
   s.add_dependency 'sequel', '~> 4.0'
-  s.add_dependency 'txgh', '~> 2.0'
+  s.add_dependency 'txgh', '>= 2.0'
 
   s.require_path = 'lib'
   s.files = Dir['{lib,spec}/**/*', 'README.md', 'txdb.gemspec', 'LICENSE']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: txdb
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,14 +42,14 @@ dependencies:
   name: txgh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 description: An automation tool for translating database content with Transifex.
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: An automation tool for translating database content with Transifex.