txdb 1.0.0

data/spec/handlers/triggers/pull_handler_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'spec_helpers/test_backend'
+require 'spec_helpers/test_db'
+require 'uri'
+require 'yaml'
+
+include Txdb::Handlers::Triggers
+
+describe PullHandler do
+  include Rack::Test::Methods
+
+  let(:database) { TestDb.database }
+  let(:table) { database.tables.first }
+  let(:project) { database.transifex_project }
+
+  def app
+    Txdb::Triggers
+  end
+
+  before(:each) do
+    allow(Txdb::Config).to receive(:databases).and_return([database])
+  end
+
+  let(:params) do
+    { 'database' => database.database, 'table' => table.name }
+  end
+
+  it 'downloads the table for each locale' do
+    locales = [{ 'language_code' => 'es' }, { 'language_code' => 'ja' }]
+    content = { 'phrase' => 'trans' }
+    expect(database.transifex_api).to receive(:get_languages).and_return(locales)
+    allow(database.transifex_api).to receive(:download).and_return(YAML.dump(content))
+
+    expect { patch('/pull', params) }.to(
+      change { Txdb::TestBackend.writes.size }.from(0).to(2)
+    )
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('{}')
+
+    expect(Txdb::TestBackend.writes).to include(
+      locale: 'es', table: table.name, content: content
+    )
+
+    expect(Txdb::TestBackend.writes).to include(
+      locale: 'ja', table: table.name, content: content
+    )
+  end
+
+  it 'reports errors' do
+    expect(database.transifex_api).to receive(:get_languages).and_raise('jelly beans')
+    patch '/pull', params
+    expect(last_response.status).to eq(500)
+    expect(JSON.parse(last_response.body)).to eq(
+      [{ 'error' => 'Internal server error: jelly beans' }]
+    )
+  end
+end

data/spec/handlers/triggers/push_handler_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'spec_helpers/test_backend'
+require 'spec_helpers/test_db'
+require 'uri'
+require 'yaml'
+
+include Txdb::Handlers::Triggers
+
+describe PushHandler do
+  include Rack::Test::Methods
+
+  let(:database) { TestDb.database }
+  let(:table) { database.tables.first }
+  let(:project) { database.transifex_project }
+
+  def app
+    Txdb::Triggers
+  end
+
+  before(:each) do
+    allow(Txdb::Config).to receive(:databases).and_return([database])
+  end
+
+  let(:params) do
+    { 'database' => database.database, 'table' => table.name }
+  end
+
+  it 'uploads the table' do
+    expect(database.transifex_api).to receive(:create_or_update)
+
+    expect { patch('/push', params) }.to(
+      change { Txdb::TestBackend.reads.size }.from(0).to(1)
+    )
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('{}')
+
+    expect(Txdb::TestBackend.reads).to include(table: table.name)
+  end
+
+  it 'reports errors' do
+    expect(database.transifex_api).to receive(:create_or_update).and_raise('jelly beans')
+    patch '/push', params
+    expect(last_response.status).to eq(500)
+    expect(JSON.parse(last_response.body)).to eq(
+      [{ 'error' => 'Internal server error: jelly beans' }]
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'pry-byebug'
+require 'rack/test'
+require 'rake'
+require 'rspec'
+require 'sequel'
+require 'sqlite3'
+require 'txdb'
+
+require 'spec_helpers/env_helpers'
+require 'spec_helpers/test_backend'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Txdb::TestBackend.reset
+  end
+
+  config.include(EnvHelpers)
+end
+
+Txdb::Backends.register('test-backend', Txdb::TestBackend)

data/spec/spec_helpers/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/spec_helpers/globalize_db.rb

@@ -0,0 +1,60 @@
+require 'spec_helpers/test_db'
+
+class GlobalizeDb < TestDb
+  class << self
+    def database
+      @database ||= Txdb::Database.new(
+        raw_config[:databases].first.merge(
+          backend: Txdb::Backends.get('globalize'),
+          tables: [{
+            name: 'widget_translations',
+            source_lang: 'en',
+            columns: %w(name)
+          }]
+        )
+      )
+    end
+
+    def setup_db
+      db.create_table(:widgets) do
+        primary_key :id
+        string :name
+      end
+
+      db.create_table(:widget_translations) do
+        primary_key :id
+        integer :widget_id
+        string :locale
+        string :name
+      end
+    end
+
+    def widgets
+      db[:widgets]
+    end
+
+    def widget_translations
+      db[:widget_translations]
+    end
+
+    def widget_translations_table
+      database.tables.find do |table|
+        table.name == 'widget_translations'
+      end
+    end
+  end
+end
+
+RSpec.shared_context(:globalize) do
+  let(:widgets) { GlobalizeDb.widgets }
+  let(:widget_translations) { GlobalizeDb.widget_translations }
+  let(:widget_translations_table) { GlobalizeDb.widget_translations_table }
+  let(:database) { GlobalizeDb.database }
+end
+
+RSpec.configure do |config|
+  config.around(:each) do |example|
+    GlobalizeDb.reset_db if example.metadata[:globalize_db]
+    example.run
+  end
+end

data/spec/spec_helpers/test_backend.rb

@@ -0,0 +1,28 @@
+module Txdb
+  class TestBackend
+    class << self
+      def reads
+        @reads ||= []
+      end
+
+      def writes
+        @writes ||= []
+      end
+
+      def reset
+        @reads = nil
+        @writes = nil
+      end
+
+      def read_content_from(table)
+        reads << { table: table.name }
+        {}
+      end
+
+      def write_content_to(table, content, locale)
+        writes << { table: table.name, content: content, locale: locale }
+        nil
+      end
+    end
+  end
+end

data/spec/spec_helpers/test_db.rb

@@ -0,0 +1,76 @@
+require 'spec_helpers/env_helpers'
+require 'spec_helpers/test_backend'
+require 'yaml'
+
+class TestDb
+  class << self
+    def db
+      @db ||= database.db
+    end
+
+    def database
+      @database ||= Txdb::Database.new(raw_config[:databases].first)
+    end
+
+    def db_path
+      File.join(File.dirname(__FILE__), '../test.sqlite3')
+    end
+
+    def raw_config
+      @config ||= deep_freeze({
+        databases: [{
+          adapter: 'sqlite',
+          backend: 'test-backend',
+          username: 'username',
+          password: 'password',
+          database: 'spec/test.sqlite3',
+          transifex: {
+            organization: 'myorg',
+            project_slug: 'myproject',
+            username: 'username',
+            password: 'password',
+            webhook_secret: '123abc'
+          },
+          tables: [{
+            name: 'my_table',
+            source_lang: 'en',
+            columns: %w(my_column)
+          }]
+        }]
+      })
+    end
+
+    def reset_db
+      db.tables.each { |t| db.drop_table(t) }
+      setup_db
+    end
+
+    def setup_db
+      # no-op
+    end
+
+    private
+
+    def deep_freeze(obj)
+      case obj
+        when Hash
+          obj.each_with_object({}) do |(k, v), ret|
+            ret[k] = deep_freeze(v)
+          end.freeze
+
+        when Array
+          obj.map { |elem| deep_freeze(elem) }.freeze
+
+        else
+          obj
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.around(:each) do |example|
+    TestDb.reset_db if example.metadata[:test_db]
+    example.run
+  end
+end

data/spec/table_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'spec_helpers/test_db'
+require 'yaml'
+
+include Txdb
+
+describe Table, test_db: true do
+  let(:database) { TestDb.database }
+  let(:table) { database.tables.first }
+
+  describe '#db' do
+    it 'returns a dataset primed to select from the table' do
+      expect(table.db).to be_a(Sequel::Dataset)
+      expect(table.db.sql).to eq('SELECT * FROM `my_table`')
+    end
+  end
+
+  describe '#resource' do
+    it 'creates a TxResource from the table' do
+      resource = table.resource
+      expect(resource).to be_a(Txdb::TxResource)
+      expect(resource.project_slug).to eq('myproject')
+      expect(resource.resource_slug).to eq(
+        Txgh::Utils.slugify("#{database.database}-#{table.name}")
+      )
+      expect(resource.source_file).to eq(table.name)
+      expect(resource.source_lang).to eq('en')
+    end
+  end
+
+  describe '#read_content' do
+    let(:content) { { foo: 'bar' } }
+
+    it 'dumps the content in YAML format' do
+      expect(database.backend).to(
+        receive(:read_content_from).and_return(content)
+      )
+
+      expect(table.read_content).to eq(YAML.dump(content))
+    end
+  end
+
+  describe '#write_content' do
+    let(:content) { { foo: 'bar' } }
+    let(:locale) { 'es' }
+
+    it 'parses and writes the content to the database' do
+      expect(database.backend).to(
+        receive(:write_content_to) do |_, cont, loc|
+          expect(cont).to eq(content)
+          expect(loc).to eq(locale)
+        end
+      )
+
+      table.write_content(YAML.dump(content), locale)
+    end
+  end
+end

data/spec/transifex_project_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'spec_helpers/test_db'
+
+include Txdb
+
+describe TransifexProject, test_db: true do
+  let(:database) { TestDb.database }
+  let(:project) { database.transifex_project }
+
+  describe '#api' do
+    it 'returns a transifex api instance' do
+      expect(project.api).to be_a(Txgh::TransifexApi)
+    end
+  end
+end

data/spec/tx_resource_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'spec_helpers/test_db'
+
+include Txdb
+
+describe TxResource, test_db: true do
+  let(:database) { TestDb.database }
+  let(:table) { database.tables.first }
+  let(:resource) { table.resource }
+
+  it 'proxies methods to the underlying Txgh::TxResource' do
+    expect(resource.project_slug).to eq('myproject')
+    expect(resource.resource_slug).to(
+      eq(Txgh::Utils.slugify("#{database.database}-#{table.name}"))
+    )
+  end
+end

data/spec/uploader_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'spec_helpers/test_db'
+require 'spec_helpers/test_backend'
+
+include Txdb
+
+describe Uploader, test_db: true do
+  let(:database) { Txdb::Config.databases.first }
+  let(:uploader) { Uploader.new(database) }
+  let(:transifex_api) { double(:transifex_api) }
+
+  before(:each) do
+    allow(database.transifex_project).to(
+      receive(:api).and_return(transifex_api)
+    )
+  end
+
+  describe '#upload' do
+    it 'reads phrases from the database and uploads them to Transifex' do
+      expect(transifex_api).to receive(:create_or_update) do |resource, content|
+        expect(resource.project_slug).to eq('myproject')
+        expect(resource.resource_slug).to(
+          eq(Txgh::Utils.slugify("#{database.database}-#{database.tables.first.name}"))
+        )
+      end
+
+      expect { uploader.upload }.to(
+        change { TestBackend.reads.size }.from(0).to(1)
+      )
+
+      expect(TestBackend.reads.first).to eq(
+        table: database.tables.first.name
+      )
+    end
+  end
+end