txgh 1.0.0

data/spec/handlers/tgz_stream_response_spec.rb

@@ -0,0 +1,59 @@
+require 'rubygems/package'
+require 'spec_helper'
+require 'stringio'
+require 'zlib'
+
+include Txgh::Handlers
+
+describe TgzStreamResponse do
+  def read_tgz_from(io)
+    contents = {}
+
+    Zlib::GzipReader.wrap(io) do |gz|
+      tar = Gem::Package::TarReader.new(gz)
+      tar.each do |entry|
+        contents[entry.full_name] = entry.read
+      end
+    end
+
+    contents
+  end
+
+  let(:attachment) { 'abc123' }
+
+  let(:enum) do
+    {
+      'first_file.yml' => "first\nfile\ncontents\n",
+      'second_file.yml' => "wowowow\nanother file!\n"
+    }
+  end
+
+  let(:response) do
+    TgzStreamResponse.new(attachment, enum)
+  end
+
+  describe '#write_to' do
+    it 'writes a gzipped tar file with the correct entries to the stream' do
+      io = StringIO.new('', 'wb')
+      response.write_to(io)
+      io = io.reopen(io.string, 'rb')
+      contents = read_tgz_from(io)
+      expect(contents).to eq(enum)
+    end
+  end
+
+  describe '#headers' do
+    it 'includes the correct content type and disposition headers' do
+      expect(response.headers).to eq({
+        'Content-Disposition' => "attachment; filename=\"#{attachment}.tgz\"",
+        'Content-Type' => 'application/x-gtar'
+      })
+    end
+  end
+
+  describe '#streaming?' do
+    it 'returns true' do
+      expect(response).to be_streaming
+    end
+  end
+end

data/spec/handlers/transifex/hook_handler_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'helpers/nil_logger'
+require 'helpers/standard_txgh_setup'
+
+include Txgh
+include Txgh::Handlers::Transifex
+
+describe HookHandler do
+  include StandardTxghSetup
+
+  let(:requested_resource_slug) do
+    resource_slug
+  end
+
+  let(:handler) do
+    HookHandler.new(
+      project: transifex_project,
+      repo: github_repo,
+      resource_slug: requested_resource_slug,
+      language: language,
+      logger: logger
+    )
+  end
+
+  let(:downloader) do
+    instance_double(ResourceDownloader)
+  end
+
+  before(:each) do
+    allow(ResourceDownloader).to receive(:new).and_return(downloader)
+    allow(downloader).to(receive(:first)).and_return([
+      "translations/#{language}/sample.yml", translations
+    ])
+  end
+
+  it 'downloads translations and pushes them to the correct branch (head)' do
+    expect(github_api).to(
+      receive(:commit).with(
+        repo_name, "heads/#{branch}", {
+          "translations/#{language}/sample.yml" => translations
+        }
+      )
+    )
+
+    response = handler.execute
+    expect(response.status).to eq(200)
+    expect(response.body).to eq(true)
+  end
+
+  it "responds with an error if the config can't be found" do
+    expect(handler).to receive(:tx_config).and_return(nil)
+    response = handler.execute
+    expect(response.status).to eq(404)
+    expect(response.body).to eq([
+      { error: "Could not find configuration for branch 'heads/#{branch}'" }
+    ])
+  end
+
+  context 'with a non-existent resource' do
+    let(:requested_resource_slug) { 'foobarbazboo' }
+
+    it "responds with an error if the resource can't be found" do
+      response = handler.execute
+      expect(response.status).to eq(404)
+      expect(response.body).to eq(
+        [{ error: "Could not find resource '#{requested_resource_slug}' in config" }]
+      )
+    end
+  end
+
+  context 'when asked to process all branches' do
+    let(:branch) { 'all' }
+    let(:ref) { 'heads/my_branch' }
+
+    let(:requested_resource_slug) do
+      'my_resource-heads_my_branch'
+    end
+
+    it 'pushes to the individual branch' do
+      expect(transifex_api).to receive(:get_resource) do
+        { 'categories' => ["branch:#{ref}"] }
+      end
+
+      expect(github_api).to(
+        receive(:commit).with(
+          repo_name, ref, {
+            "translations/#{language}/sample.yml" => translations
+          }
+        )
+      )
+
+      response = handler.execute
+      expect(response.status).to eq(200)
+      expect(response.body).to eq(true)
+    end
+  end
+
+  context 'with a tag instead of a branch' do
+    let(:branch) { 'tags/my_tag' }
+
+    it 'downloads translations and pushes them to the tag' do
+      expect(github_api).to(
+        receive(:commit).with(
+          repo_name, "tags/my_tag", {
+            "translations/#{language}/sample.yml" => translations
+          }
+        )
+      )
+
+      response = handler.execute
+      expect(response.status).to eq(200)
+      expect(response.body).to eq(true)
+    end
+  end
+end

data/spec/handlers/zip_stream_response_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'tempfile'
+
+include Txgh::Handlers
+
+describe ZipStreamResponse do
+  def read_zip_from(file)
+    contents = {}
+
+    Zip::File.open(file) do |zipfile|
+      zipfile.each do |entry|
+        contents[entry.name] = entry.get_input_stream.read
+      end
+    end
+
+    contents
+  end
+
+  let(:attachment) { 'abc123' }
+
+  let(:enum) do
+    {
+      'first_file.yml' => "first\nfile\ncontents\n",
+      'second_file.yml' => "wowowow\nanother file!\n"
+    }
+  end
+
+  let(:response) do
+    ZipStreamResponse.new(attachment, enum)
+  end
+
+  describe '#write_to' do
+    it 'writes a zip file with the correct entries to the stream' do
+      # this does NOT WORK with a StringIO - zip contents MUST be written to a file
+      io = Tempfile.new('testzip')
+      response.write_to(io)
+      contents = read_zip_from(io.path)
+      expect(contents).to eq(enum)
+      io.close
+      io.unlink
+    end
+  end
+
+  describe '#headers' do
+    it 'includes the correct content type and disposition headers' do
+      expect(response.headers).to eq({
+        'Content-Disposition' => "attachment; filename=\"#{attachment}.zip\"",
+        'Content-Type' => 'application/zip'
+      })
+    end
+  end
+
+  describe '#streaming?' do
+    it 'returns true' do
+      expect(response).to be_streaming
+    end
+  end
+end

data/spec/helpers/github_payload_builder.rb

@@ -0,0 +1,141 @@
+require 'json'
+
+class GithubPayloadBuilder
+  class << self
+    def push_payload(*args)
+      GithubPushPayload.new(*args)
+    end
+
+    def delete_payload(*args)
+      GithubDeletePayload.new(*args)
+    end
+  end
+end
+
+class GithubPayload
+  def to_h
+    # convert symbolized keys to strings
+    JSON.parse(to_json)
+  end
+
+  def to_json
+    @result.to_json
+  end
+
+  protected
+
+  def digits
+    @@digits ||= ('a'..'f').to_a + ('0'..'9').to_a
+  end
+
+  def generate_timestamp
+    Time.now.strftime('%Y-%m-%dT%H:%M:%S%:z')
+  end
+
+  def generate_sha
+    blank_commit_id.gsub(/0/) { digits.sample }
+  end
+
+  def blank_commit_id
+    '0' * 40
+  end
+end
+
+class GithubDeletePayload < GithubPayload
+  attr_reader :repo, :ref
+
+  def initialize(repo, ref)
+    @repo = repo
+    @ref = ref
+
+    @result = {
+      ref: "refs/#{ref}",
+      ref_type: 'branch',
+      pusher_type: 'user',
+
+      repository: {
+        name: repo.split('/').last,
+        full_name: repo,
+        owner: {
+          login: repo.split('/').first
+        }
+      },
+
+      sender: {
+        login: repo.split('/').first,
+        type: 'User'
+      }
+    }
+  end
+end
+
+class GithubPushPayload < GithubPayload
+  attr_reader :repo, :ref, :before, :after
+
+  DEFAULT_USER = {
+    name: 'Test User',
+    email: 'test@user.com',
+    username: 'testuser'
+  }
+
+  def initialize(repo, ref, before = nil, after = nil)
+    @repo = repo
+    @ref = ref
+    @before = before || blank_commit_id
+    @after = after || generate_sha
+
+    @result = {
+      ref: "refs/#{ref}",
+      before: @before,
+      after: @after,
+      created: true,
+      deleted: false,
+      forced: true,
+      base_ref: nil,
+      compare: "https://github.com/#{@repo}/commit/#{@after[0..12]}",
+      commits: [],
+      repository: {
+        name: repo.split('/').last,
+        full_name: repo,
+        owner: {
+          name: repo.split('/').first
+        }
+      }
+    }
+  end
+
+  def add_commit(options = {})
+    id = if commits.empty? && !options.include?(:id)
+      after
+    else
+      options.fetch(:id) { generate_sha }
+    end
+
+    commit_data = {
+      id: id,
+      distinct: options.fetch(:distinct, true),
+      message: options.fetch(:message, 'Default commit message'),
+      timestamp: options.fetch(:timestamp) { generate_timestamp },
+      url: "https://github.com/#{repo}/commit/#{id}",
+      author: options.fetch(:author, DEFAULT_USER),
+      committer: options.fetch(:committer, DEFAULT_USER),
+      added: options.fetch(:added, []),
+      removed: options.fetch(:removed, []),
+      modified: options.fetch(:modified, [])
+    }
+
+    if commit_data[:id] == after
+      @result[:head_commit] = commit_data
+    end
+
+    commits << commit_data
+  end
+
+  def commits
+    @result[:commits]
+  end
+
+  def head_commit
+    @result[:head_commit]
+  end
+end

data/spec/helpers/integration_setup.rb

@@ -0,0 +1,47 @@
+module IntegrationSetup
+  extend RSpec::SharedContext
+
+  let(:base_config) do
+    {
+      'github' => {
+        'repos' => {
+          'txgh-bot/txgh-test-resources' => {
+            'api_username' => 'txgh-bot',
+            # github will auto-revoke a token if they notice it in one of your commits ;)
+            'api_token' => Base64.decode64('YjViYWY3Nzk5NTdkMzVlMmI0OGZmYjk4YThlY2M1ZDY0NzAwNWRhZA=='),
+            'push_source_to' => 'test-project-88',
+            'branch' => 'master'
+          }
+        }
+      },
+      'transifex' => {
+        'projects' => {
+          'test-project-88' => {
+            'tx_config' => 'file://./config/tx.config',
+            'api_username' => 'txgh.bot',
+            'api_password' => '2aqFGW99fPRKWvXBPjbrxkdiR',
+            'push_translations_to' => 'txgh-bot/txgh-test-resources'
+          }
+        }
+      }
+    }
+  end
+
+  before(:all) do
+    VCR.configure do |config|
+      config.filter_sensitive_data('<GITHUB_TOKEN>') do
+        base_config['github']['repos']['txgh-bot/txgh-test-resources']['api_token']
+      end
+
+      config.filter_sensitive_data('<TRANSIFEX_PASSWORD>') do
+        base_config['transifex']['projects']['test-project-88']['api_password']
+      end
+    end
+  end
+
+  before(:each) do
+    allow(Txgh::Config::KeyManager).to(
+      receive(:base_config).and_return(base_config)
+    )
+  end
+end

data/spec/helpers/nil_logger.rb

@@ -0,0 +1,10 @@
+class NilLogger
+  def info(*args)
+  end
+
+  def warn(*args)
+  end
+
+  def error(*args)
+  end
+end

data/spec/helpers/standard_txgh_setup.rb

@@ -0,0 +1,92 @@
+require 'helpers/nil_logger'
+require 'yaml'
+
+module StandardTxghSetup
+  extend RSpec::SharedContext
+
+  let(:logger) { NilLogger.new }
+  let(:github_api) { double(:github_api) }
+  let(:transifex_api) { double(:transifex_api) }
+
+  let(:project_name) { 'my_awesome_project' }
+  let(:resource_slug) { 'my_resource' }
+  let(:repo_name) { 'my_org/my_repo' }
+  let(:branch) { 'master' }
+  let(:tag) { 'all' }
+  let(:ref) { 'heads/master' }
+  let(:language) { 'ko_KR' }
+  let(:translations) { 'translation file contents' }
+  let(:diff_point) { nil }
+
+  let(:project_config) do
+    {
+      'api_username' => 'transifex_api_username',
+      'api_password' => 'transifex_api_password',
+      'push_translations_to' => repo_name,
+      'name' => project_name,
+      'tx_config' => "raw://#{tx_config_raw}",
+      'webhook_secret' => 'abc123',
+      'auto_delete_resources' => 'true'
+    }
+  end
+
+  let(:repo_config) do
+    {
+      'api_username' => 'github_api_username',
+      'api_token' => 'github_api_token',
+      'push_source_to' => project_name,
+      'branch' => branch,
+      'tag' => tag,
+      'name' => repo_name,
+      'webhook_secret' => 'abc123',
+      'diff_point' => diff_point
+    }
+  end
+
+  let(:tx_config_raw) do
+    """
+    [main]
+    host = https://www.transifex.com
+    lang_map = pt-BR:pt, ko-KR:ko
+
+    [#{project_name}.#{resource_slug}]
+    file_filter = translations/<lang>/sample.yml
+    source_file = sample.yml
+    source_lang = en
+    type = YML
+    """
+  end
+
+  let(:tx_config) do
+    Txgh::Config::TxConfig.load(tx_config_raw)
+  end
+
+  before(:each) do
+    allow(Txgh::Config::KeyManager).to(
+      receive(:raw_config) { "raw://#{YAML.dump(base_config)}" }
+    )
+  end
+
+  let(:base_config) do
+    {
+      'github' => {
+        'repos' => {
+          repo_name => repo_config
+        }
+      },
+      'transifex' => {
+        'projects' => {
+          project_name => project_config
+        }
+      }
+    }
+  end
+
+  let(:transifex_project) do
+    Txgh::TransifexProject.new(project_config, transifex_api)
+  end
+
+  let(:github_repo) do
+    Txgh::GithubRepo.new(repo_config, github_api)
+  end
+end