rosette-client 1.0.0

data/lib/rosette/client/repo.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+
+module Rosette
+  module Client
+
+    class Repo
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      def get_head
+        execute_in_repo('git symbolic-ref --short HEAD').strip
+      end
+
+      def rev_parse(ref)
+        commit_id = execute_in_repo("git rev-parse #{ref}").strip
+        commit_id ? commit_id : nil
+      end
+
+      private
+
+      def execute_in_repo(cmd)
+        Dir.chdir(path) do
+          `#{cmd}`
+        end
+      end
+    end
+
+  end
+end

data/lib/rosette/client/response.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+module Rosette
+  module Client
+
+    class Response
+      attr_reader :attributes
+
+      def self.from_api_response(hash)
+        new(hash)
+      end
+
+      def initialize(hash)
+        @attributes = hash
+      end
+
+      def error?
+        attributes.include?('error')
+      end
+
+      def success?
+        !error?
+      end
+
+      def method_missing(method, *args, &block)
+        if attributes.include?(method.to_s)
+          attributes[method.to_s]
+        end
+      end
+
+      # responds to everything, returns nil for any unset attributes
+      def respond_to?(method)
+        true
+      end
+    end
+
+  end
+end

data/lib/rosette/client/terminal.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+require 'colorize'
+
+module Rosette
+  module Client
+    class Terminal
+
+      attr_reader :stream
+
+      def initialize(stream = STDOUT)
+        @stream = stream
+      end
+
+      def say(str, color = :none)
+        stream.write(colorize(str, color))
+        stream.write("\n")
+      end
+
+      private
+
+      def colorize(str, color)
+        case color
+          when :none
+            str
+          else
+            str.colorize(color)
+        end
+      end
+
+    end
+  end
+end

data/lib/rosette/client/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Rosette
+  module Client
+    VERSION = "1.0.0"
+  end
+end

data/lib/rosette/client.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+require 'rosette/client/cli'
+require 'rosette/client/repo'
+
+module Rosette
+  module Client
+    autoload :Api,         'rosette/client/api'
+    autoload :Terminal,    'rosette/client/terminal'
+    autoload :Commands,    'rosette/client/commands'
+    autoload :Response,    'rosette/client/response'
+  end
+end

data/rosette-client.gemspec

@@ -0,0 +1,23 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'rosette/client/version'
+
+Gem::Specification.new do |s|
+  s.name     = "rosette-client"
+  s.version  = ::Rosette::Client::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["camertron@gmail.com"]
+  s.homepage = "http://github.com/camertron"
+
+  s.description = s.summary = "Git command integration for the Rosette internationalization platform that manages the translatable content in the source files of a git repository."
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_dependency 'colorize', '~> 0.7.0'
+  s.add_dependency 'json', '~> 1.8.0'
+
+  s.executables << 'git-rosette'
+
+  s.require_path = 'lib'
+  s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "README.md", "Rakefile", "rosette-client.gemspec"]
+end

data/spec/api_spec.rb

@@ -0,0 +1,96 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include Rosette::Client
+
+describe Api do
+  let(:api_class) { Api }
+
+  it 'uses default options' do
+    api_class.new.tap do |api|
+      expect(api.host).to eq('localhost')
+      expect(api.port).to eq(8080)
+      expect(api.version).to eq('v1')
+    end
+  end
+
+  it 'uses only some default options' do
+    api_class.new(host: 'foo.com').tap do |api|
+      expect(api.host).to eq('foo.com')
+      expect(api.port).to eq(8080)
+      expect(api.version).to eq('v1')
+    end
+  end
+
+  shared_examples 'an api endpoint' do
+    let(:api) { api_class.new }
+    let(:params) { { param: 'value' } }
+    let(:endpoint) { method }
+
+    before(:each) do
+      url = "http://localhost:8080/v1/#{path}"
+
+      args = case verb
+        when :get
+          ["#{url}/#{endpoint_override rescue endpoint}.json/?param=value"]
+        else
+          ["#{url}/#{endpoint_override rescue endpoint}.json", params]
+      end
+
+      allow(api).to receive(verb).with(*args).and_return('{"foo":"bar"}')
+    end
+
+    it 'wraps the response in a Response object' do
+      expect(api.send(endpoint, params)).to be_a(Response)
+    end
+  end
+
+  context 'get requests' do
+    let(:verb) { :get }
+
+    describe '#diff' do
+      let(:path) { 'git' }
+      let(:method) { :diff }
+      it_behaves_like 'an api endpoint'
+    end
+
+    describe '#show' do
+      let(:path) { 'git' }
+      let(:method) { :show }
+      it_behaves_like 'an api endpoint'
+    end
+
+    describe '#status' do
+      let(:path) { 'git' }
+      let(:method) { :status }
+      it_behaves_like 'an api endpoint'
+    end
+
+    describe '#commit' do
+      let(:path) { 'git' }
+      let(:method) { :commit }
+      it_behaves_like 'an api endpoint'
+    end
+
+    describe '#snapshot' do
+      let(:path) { 'git' }
+      let(:method) { :snapshot }
+      it_behaves_like 'an api endpoint'
+    end
+
+    describe '#repo_snapshot' do
+      let(:path) { 'git' }
+      let(:method) { :repo_snapshot }
+      it_behaves_like 'an api endpoint'
+    end
+
+    describe '#add_or_update_translation' do
+      let(:path) { 'translations' }
+      let(:method) { :add_or_update_translation }
+      let(:endpoint_override) { 'add_or_update' }
+      let(:verb) { :post }
+      it_behaves_like 'an api endpoint'
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include Rosette::Client
+
+describe Cli do
+  let(:api) { double }
+  let(:base_repo) { TmpRepo.new }
+  let(:repo) { Repo.new(base_repo.working_dir) }
+  let(:terminal) { FakeTerminal.new }
+  let(:cli) { Cli.new(terminal, api, repo) }
+
+  before(:each) do
+    add_user_to(base_repo)
+  end
+
+  describe '#start' do
+    it 'resolves the command into a class and executes it' do
+      base_repo.create_file('file.txt') { |f| f.write('hello, world') }
+      base_repo.add_all
+      base_repo.commit('Initial commit')
+
+      expect(api).to receive(:commit).and_return(Response.new({ 'foo' => 'bar' }))
+      cli.start(['commit', base_repo.git('rev-parse HEAD').strip])
+    end
+
+    it "prints a message if the command isn't recognized" do
+      cli.start(['foobar'])
+      expect(terminal).to have_said("Command 'foobar' not recognized.")
+    end
+  end
+end

data/spec/commands/commit_command_spec.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include Rosette::Client
+include Rosette::Client::Commands
+
+describe CommitCommand do
+  let(:api) { double }
+  let(:base_repo) { TmpRepo.new }
+  let(:repo) { Repo.new(base_repo.working_dir) }
+  let(:terminal) { FakeTerminal.new }
+  let(:repo_name) { 'my_awesome_repo' }
+  let(:commit_id) { base_repo.git('rev-parse HEAD').strip }
+  let(:command) { CommitCommand.new(api, terminal, repo, [commit_id]) }
+
+  before(:each) do
+    add_user_to(base_repo)
+    base_repo.git("remote add origin git@github.com/camertron/#{repo_name}")
+    base_repo.create_file('file.txt') { |f| f.write('hello, world') }
+    base_repo.add_all
+    base_repo.commit('Initial commit')
+  end
+
+  around(:each) do |example|
+    Dir.chdir(base_repo.working_dir) do
+      example.run
+    end
+  end
+
+  describe '#execute' do
+    it 'makes a commit api call' do
+      expect(api).to receive(:commit)
+        .with(repo_name: repo_name, ref: commit_id)
+        .and_return(Response.new({}))
+
+      command.execute
+    end
+
+    it 'prints the number of phrases added, removed, and modified' do
+      expect(api).to receive(:commit)
+        .with(repo_name: repo_name, ref: commit_id)
+        .and_return(
+          Response.new(
+            { 'added' => 1, 'removed' => 2, 'modified' => 3 }
+          )
+        )
+
+      command.execute
+
+      expect(terminal).to have_said('Added: 1')
+      expect(terminal).to have_said('Removed: 2')
+      expect(terminal).to have_said('Modified: 3')
+    end
+
+    it 'prints the error if the api response contains one' do
+      expect(api).to receive(:commit)
+        .with(repo_name: repo_name, ref: commit_id)
+        .and_return(
+          Response.new({ 'error' => 'Jelly beans', 'added' => 1 })
+        )
+
+      command.execute
+
+      expect(terminal).to have_said('Jelly beans')
+      expect(terminal).to_not have_said('Added: 1')
+    end
+  end
+end

data/spec/commands/diff_command_spec.rb

@@ -0,0 +1,151 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include Rosette::Client
+include Rosette::Client::Commands
+
+describe 'diff' do
+  let(:args) { DiffCommandArgs }
+  let(:base_repo) { TmpRepo.new }
+  let(:repo) { Repo.new(base_repo.working_dir) }
+  let(:repo_name) { 'my_awesome_repo' }
+  let(:new_branch) { 'new_branch' }
+  let(:new_branch_commit_id) { base_repo.git("rev-parse #{new_branch}").strip }
+  let(:master_commit_id) { base_repo.git("rev-parse master").strip }
+
+  before(:each) do
+    add_user_to(base_repo)
+    base_repo.git("remote add origin git@github.com/camertron/#{repo_name}")
+    base_repo.create_file('file.txt') { |f| f.write('hello, world') }
+    base_repo.add_all
+    base_repo.commit('Initial commit')
+    base_repo.create_branch(new_branch)
+    base_repo.create_file('file2.txt') { |f| f.write('another file') }
+    base_repo.add_all
+    base_repo.commit('Second file')
+  end
+
+  around(:each) do |example|
+    Dir.chdir(base_repo.working_dir) do
+      example.run
+    end
+  end
+
+  describe DiffCommandArgs do
+    it "uses the default head if one isn't provided" do
+      args.from_argv(['master'], repo).tap do |args|
+        expect(args.diff_point_ref).to eq(master_commit_id)
+        expect(args.head_ref).to eq(new_branch_commit_id)
+        expect(args.paths).to eq([])
+      end
+    end
+
+    it 'accepts both head and diff point as the first two arguments' do
+      args.from_argv(['master', new_branch], repo).tap do |args|
+        expect(args.diff_point_ref).to eq(master_commit_id)
+        expect(args.head_ref).to eq(new_branch)
+        expect(args.paths).to eq([])
+      end
+    end
+
+    it 'allows the second argument to be a path' do
+      args.from_argv(['master', '.'], repo).tap do |args|
+        expect(args.diff_point_ref).to eq(master_commit_id)
+        expect(args.head_ref).to eq(new_branch_commit_id)
+        expect(args.paths).to eq(['.'])
+      end
+    end
+
+    it 'allows multiple paths' do
+      args.from_argv(['master', 'file.txt', 'file2.txt'], repo).tap do |args|
+        expect(args.diff_point_ref).to eq(master_commit_id)
+        expect(args.head_ref).to eq(new_branch_commit_id)
+        expect(args.paths).to eq(['file.txt', 'file2.txt'])
+      end
+    end
+
+    it 'allows paths to be separated by --' do
+      args.from_argv(['master', '--', 'file.txt', 'file2.txt'], repo).tap do |args|
+        expect(args.diff_point_ref).to eq(master_commit_id)
+        expect(args.head_ref).to eq(new_branch_commit_id)
+        expect(args.paths).to eq(['file.txt', 'file2.txt'])
+      end
+    end
+
+    it 'allows a head and diff point followed by -- and paths' do
+      args.from_argv(['master', new_branch, '--', 'file.txt', 'file2.txt'], repo).tap do |args|
+        expect(args.diff_point_ref).to eq(master_commit_id)
+        expect(args.head_ref).to eq(new_branch)
+        expect(args.paths).to eq(['file.txt', 'file2.txt'])
+      end
+    end
+  end
+
+  describe DiffCommand do
+    let(:api) { double }
+    let(:command) { DiffCommand.new(api, terminal, repo, [master_commit_id, new_branch_commit_id]) }
+    let(:terminal) { FakeTerminal.new }
+
+    describe '#execute' do
+      it 'makes a diff api call' do
+        expect(api).to receive(:diff)
+          .with(
+            repo_name: repo_name,
+            head_ref: new_branch_commit_id,
+            diff_point_ref: master_commit_id,
+            paths: ''
+          )
+          .and_return(Response.new({}))
+
+        command.execute
+      end
+
+      it 'prints the number of phrases added, removed, and modified' do
+        expect(api).to receive(:diff)
+          .with(
+            repo_name: repo_name,
+            head_ref: new_branch_commit_id,
+            diff_point_ref: master_commit_id,
+            paths: ''
+          )
+          .and_return(
+            Response.new(
+              sample_diff(new_branch_commit_id)
+            )
+          )
+
+        command.execute
+
+        expect(terminal).to have_said("+ I'm a little teapot (about.training.teapot)", :green)
+        expect(terminal).to have_said('- The green albatross flitters in the moonlight (animals.birds.albatross.message)', :red)
+
+        expect(terminal).to have_said('+ Purple eggplants make delicious afternoon snacks (foods.vegetables.eggplant.snack_message)', :green)
+        expect(terminal).to have_said('- Blue eggplants make wonderful evening meals (foods.vegetables.eggplant.snack_message)', :red)
+
+        expect(terminal).to have_said('+ The Seattle Seahawks rock (sports.teams.football.best)', :green)
+        expect(terminal).to have_said('- The Seattle Seahawks rule (sports.teams.football.best)', :red)
+      end
+
+      it 'prints the error if the api response contains one' do
+        expect(api).to receive(:diff)
+          .with(
+            repo_name: repo_name,
+            head_ref: new_branch_commit_id,
+            diff_point_ref: master_commit_id,
+            paths: ''
+          )
+          .and_return(
+            Response.new({ 'error' => 'Jelly beans' }.merge(
+              sample_diff(new_branch_commit_id))
+            )
+          )
+
+        command.execute
+
+        expect(terminal).to have_said('Jelly beans')
+        expect(terminal).to_not have_said("+ I'm a little teapot (about.training.teapot)", :green)
+      end
+    end
+  end
+end

data/spec/commands/repo_snapshot_command_spec.rb

@@ -0,0 +1,71 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include Rosette::Client
+include Rosette::Client::Commands
+
+describe RepoSnapshotCommand do
+  let(:api) { double }
+  let(:base_repo) { TmpRepo.new }
+  let(:repo) { Repo.new(base_repo.working_dir) }
+  let(:terminal) { FakeTerminal.new }
+  let(:repo_name) { 'my_awesome_repo' }
+  let(:commit_id) { base_repo.git('rev-parse HEAD').strip }
+  let(:command) { RepoSnapshotCommand.new(api, terminal, repo, [commit_id]) }
+
+  before(:each) do
+    add_user_to(base_repo)
+    base_repo.git("remote add origin git@github.com/camertron/#{repo_name}")
+    base_repo.create_file('file.txt') { |f| f.write('hello, world') }
+    base_repo.add_all
+    base_repo.commit('Initial commit')
+  end
+
+  around(:each) do |example|
+    Dir.chdir(base_repo.working_dir) do
+      example.run
+    end
+  end
+
+  describe '#execute' do
+    it 'makes a repo_snapshot api call' do
+      expect(api).to receive(:repo_snapshot)
+        .with(repo_name: repo_name, ref: commit_id)
+        .and_return(Response.new({}))
+
+      command.execute
+    end
+
+    it 'prints the hash of files to commit ids' do
+      expect(api).to receive(:repo_snapshot)
+        .with(repo_name: repo_name, ref: commit_id)
+        .and_return(
+          Response.new({
+            'file1.txt' => 'abc123',
+            'path/file2.txt' => 'def456',
+            'my/awesome/file3.rb' => 'ghi789'
+          })
+        )
+
+      command.execute
+
+      expect(terminal).to have_said('file1.txt: abc123')
+      expect(terminal).to have_said('path/file2.txt: def456')
+      expect(terminal).to have_said('my/awesome/file3.rb: ghi789')
+    end
+
+    it 'prints the error if the api response contains one' do
+      expect(api).to receive(:repo_snapshot)
+        .with(repo_name: repo_name, ref: commit_id)
+        .and_return(
+          Response.new({ 'error' => 'Jelly beans', 'file1.txt' => 'abc123' })
+        )
+
+      command.execute
+
+      expect(terminal).to have_said('Jelly beans')
+      expect(terminal).to_not have_said('file1.txt: abc123')
+    end
+  end
+end

data/spec/commands/show_command_spec.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include Rosette::Client
+include Rosette::Client::Commands
+
+describe ShowCommand do
+  let(:api) { double }
+  let(:base_repo) { TmpRepo.new }
+  let(:repo) { Repo.new(base_repo.working_dir) }
+  let(:terminal) { FakeTerminal.new }
+  let(:repo_name) { 'my_awesome_repo' }
+  let(:commit_id) { base_repo.git('rev-parse HEAD').strip }
+  let(:command) { ShowCommand.new(api, terminal, repo, [commit_id]) }
+
+  before(:each) do
+    add_user_to(base_repo)
+    base_repo.git("remote add origin git@github.com/camertron/#{repo_name}")
+    base_repo.create_file('file.txt') { |f| f.write('hello, world') }
+    base_repo.add_all
+    base_repo.commit('Initial commit')
+  end
+
+  around(:each) do |example|
+    Dir.chdir(base_repo.working_dir) do
+      example.run
+    end
+  end
+
+  describe '#execute' do
+    it 'makes a commit api call' do
+      expect(api).to receive(:show)
+        .with(repo_name: repo_name, ref: commit_id)
+        .and_return(Response.new({}))
+
+      command.execute
+    end
+
+    it 'prints the phrases that were added, removed, and modified' do
+      expect(api).to receive(:show)
+        .with(repo_name: repo_name, ref: commit_id)
+        .and_return(
+          Response.new(sample_diff(commit_id))
+        )
+
+      command.execute
+
+      expect(terminal).to have_said("+ I'm a little teapot (about.training.teapot)", :green)
+      expect(terminal).to have_said('- The green albatross flitters in the moonlight (animals.birds.albatross.message)', :red)
+
+      expect(terminal).to have_said('+ Purple eggplants make delicious afternoon snacks (foods.vegetables.eggplant.snack_message)', :green)
+      expect(terminal).to have_said('- Blue eggplants make wonderful evening meals (foods.vegetables.eggplant.snack_message)', :red)
+
+      expect(terminal).to have_said('+ The Seattle Seahawks rock (sports.teams.football.best)', :green)
+      expect(terminal).to have_said('- The Seattle Seahawks rule (sports.teams.football.best)', :red)
+    end
+
+    it 'prints the error if the api response contains one' do
+      expect(api).to receive(:show)
+        .with(repo_name: repo_name, ref: commit_id)
+        .and_return(
+          Response.new({ 'error' => 'Jelly beans' }.merge(sample_diff(commit_id)))
+        )
+
+      command.execute
+
+      expect(terminal).to have_said('Jelly beans')
+      expect(terminal).to_not have_said("+ I'm a little teapot (about.training.teapot)", :green)
+    end
+  end
+end