localeapp 2.1.1 → 2.2.0

data/lib/localeapp.rb

@@ -29,10 +29,13 @@ require 'localeapp/cli/daemon'
 module Localeapp
   API_VERSION = "1"
   LOG_PREFIX = "** [Localeapp] "
+  ENV_FILE_PATH = ".env".freeze
 
   class LocaleappError < StandardError; end
   class PotentiallyInsecureYaml < LocaleappError; end
   class MissingApiKey < LocaleappError; end
+  class RuntimeError < LocaleappError; end
+  class APIResponseError < RuntimeError; end
 
   class << self
     # An Localeapp configuration object.
@@ -106,6 +109,10 @@ module Localeapp
       load_yaml(File.read(filename))
     end
 
+    def env_file_path
+      ENV_FILE_PATH
+    end
+
     private
 
     def private_null_type(results)

data/lib/localeapp/cli/install.rb

@@ -8,8 +8,9 @@ module Localeapp
         @config_type = :default
       end
 
-      def execute(key = nil)
-        installer("#{config_type.to_s.capitalize}Installer").execute(key)
+      def execute(key = nil, **options)
+        installer("#{config_type.to_s.capitalize}Installer")
+          .execute key, options
       end
 
       def installer(installer_class)
@@ -19,18 +20,22 @@ module Localeapp
       class DefaultInstaller
         attr_accessor :key, :project_data, :config_file_path, :data_directory
 
-        def initialize(output)
-          @output = output
+        def initialize(output, key_checker: Localeapp::KeyChecker.new)
+          @output       = output
+          @key_checker  = key_checker
         end
 
-        def execute(key = nil)
+        def execute(key = nil, **options)
           self.key = key
           print_header
           if validate_key
-            check_default_locale
+            print_default_locale
             set_config_paths
             @output.puts "Writing configuration file to #{config_file_path}"
             write_config_file
+            if options[:write_env_file]
+              write_env_file_apikey options[:write_env_file], key
+            end
             check_data_directory_exists
             true
           else
@@ -61,12 +66,13 @@ module Localeapp
           end
         end
 
-        def check_default_locale
+        def print_default_locale
           localeapp_default_code = project_data['default_locale']['code']
-          @output.puts "Default Locale: #{localeapp_default_code} (#{project_data['default_locale']['name']})"
-          if I18n.default_locale.to_s != localeapp_default_code
-            @output.puts "WARNING: I18n.default_locale is #{I18n.default_locale}, change in config/application.rb (Rails 3+)"
-          end
+          @output.puts <<-eoh
+Default Locale: #{localeapp_default_code} (#{project_data['default_locale']['name']})
+Please ensure I18n.default_locale is #{localeapp_default_code} or change it in
+config/application.rb
+          eoh
         end
 
         def set_config_paths
@@ -85,7 +91,7 @@ module Localeapp
 require 'localeapp/rails'
 
 Localeapp.configure do |config|
-  config.api_key = '#{key}'
+  config.api_key = ENV['LOCALEAPP_API_KEY']
 end
 CONTENT
           end
@@ -98,10 +104,13 @@ CONTENT
         end
 
         def check_key(key)
-          Localeapp::KeyChecker.new.check(key)
+          key_checker.check key
         end
 
         private
+
+        attr_reader :key_checker
+
         def config_dir
           File.dirname(config_file_path)
         end
@@ -109,6 +118,10 @@ CONTENT
         def create_config_dir
           FileUtils.mkdir_p(config_dir)
         end
+
+        def write_env_file_apikey(path, key)
+          File.open(path, "a") { |f| f.puts "LOCALEAPP_API_KEY=#{key}" }
+        end
       end
 
       class HerokuInstaller < DefaultInstaller
@@ -161,7 +174,7 @@ CONTENT
       end
 
       class StandaloneInstaller < DefaultInstaller
-        def check_default_locale
+        def print_default_locale
           # do nothing standalone
         end
 
@@ -181,7 +194,7 @@ CONTENT
           File.open(config_file_path, 'w+') do |file|
             file.write <<-CONTENT
 Localeapp.configure do |config|
-  config.api_key                    = '#{key}'
+  config.api_key                    = ENV['LOCALEAPP_API_KEY']
   config.translation_data_directory = '#{data_directory}'
   config.synchronization_data_file  = '#{config_dir}/log.yml'
   config.daemon_pid_file            = '#{config_dir}/localeapp.pid'

data/lib/localeapp/cli/pull.rb

@@ -11,7 +11,7 @@ module Localeapp
         api_call :export,
           :success => :update_backend,
           :failure => :report_failure,
-          :max_connection_attempts => 3
+          :max_connection_attempts => 1
       end
 
       def update_backend(response)
@@ -24,6 +24,7 @@ module Localeapp
 
       def report_failure(response)
         @output.puts "Failed!"
+        fail APIResponseError, "API returned #{response.code} status code"
       end
     end
   end

data/lib/localeapp/cli/push.rb

@@ -24,7 +24,7 @@ module Localeapp
             :payload => { :file => file },
             :success => :report_success,
             :failure => :report_failure,
-            :max_connection_attempts => 3
+            :max_connection_attempts => 1
         else
           @output.puts "Could not load file"
         end
@@ -38,6 +38,7 @@ module Localeapp
 
       def report_failure(response)
         @output.puts "Failed!"
+        fail APIResponseError, "API returned #{response.code} status code"
       end
 
       private

data/lib/localeapp/cli/remove.rb

@@ -11,7 +11,7 @@ module Localeapp
           :url_options => { :key => key },
           :success => :report_success,
           :failure => :report_failure,
-          :max_connection_attempts => 3
+          :max_connection_attempts => 1
       end
 
       def report_success(response)
@@ -20,6 +20,7 @@ module Localeapp
 
       def report_failure(response)
         @output.puts "Failed!"
+        fail APIResponseError, "API returned #{response.code} status code"
       end
     end
   end

data/lib/localeapp/cli/rename.rb

@@ -12,7 +12,7 @@ module Localeapp
           :payload => { :new_name => new_name },
           :success => :report_success,
           :failure => :report_failure,
-          :max_connection_attempts => 3
+          :max_connection_attempts => 1
       end
 
       def report_success(response)
@@ -21,6 +21,7 @@ module Localeapp
 
       def report_failure(response)
         @output.puts "Failed!"
+        fail APIResponseError, "API returned #{response.code} status code"
       end
     end
   end

data/lib/localeapp/configuration.rb

@@ -38,7 +38,7 @@ module Localeapp
     # RAILS_ROOT
     attr_accessor :project_root
 
-    # The names of environments where notifications are sent
+    # The names of environments where missing translations are sent from
     # (defaults to 'development')
     attr_accessor :sending_environments
 

data/lib/localeapp/poller.rb

@@ -52,10 +52,13 @@ module Localeapp
     end
 
     def handle_failure(response)
-      if response.code == 304
+      case response.code
+      when 304
         Localeapp.log_with_time "No new data"
         # Nothing new, update synchronization files
         write_synchronization_data!(current_time, updated_at)
+      when 404
+        fail APIResponseError, "API returned #{response.code} status code"
       end
       @success = false
     end

data/lib/localeapp/sender.rb

@@ -48,6 +48,7 @@ module Localeapp
 
     def handle_missing_translation_failure(response)
        Localeapp.log([translations_url, response.code, @data.inspect].join(' - '))
+       fail APIResponseError, "API returned #{response.code} status code"
     end
   end
 end

data/lib/localeapp/version.rb

@@ -1,3 +1,3 @@
 module Localeapp
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

data/spec/localeapp/cli/install_spec.rb

@@ -1,63 +1,78 @@
 require 'spec_helper'
 require 'localeapp/cli/install'
 
-describe Localeapp::CLI::Install, '.execute(key = nil)' do
-  let(:output) { StringIO.new }
-  let(:key) { 'MYAPIKEY' }
-  let(:command) { Localeapp::CLI::Install.new(:output => output) }
+describe Localeapp::CLI::Install, "#execute" do
+  let(:key)         { "MYAPIKEY" }
+  let(:installer)   { double "installer" }
+  subject(:command) { described_class.new output: output }
 
-  it "creates the installer based on the config type" do
+  it "executes the appropriate installer based on the config type" do
     command.config_type = :heroku
-    expect(command).to receive(:installer).with("HerokuInstaller").and_return(double.as_null_object)
-    command.execute(key)
+    allow(Localeapp::CLI::Install::HerokuInstaller).to receive :new do
+      installer
+    end
+    expect(installer).to receive :execute
+    command.execute key
   end
 
   it "executes the installer with the given key" do
-    installer = double(:installer)
-    expect(installer).to receive(:execute).with(key)
-    allow(command).to receive(:installer).and_return(installer)
-    command.execute(key)
+    allow(Localeapp::CLI::Install::DefaultInstaller).to receive :new do
+      installer
+    end
+    expect(installer)
+      .to receive(:execute)
+      .with key, anything
+    command.execute key
+  end
+
+  it "executes the installer with the given options" do
+    allow(Localeapp::CLI::Install::DefaultInstaller).to receive :new do
+      installer
+    end
+    expect(installer)
+      .to receive(:execute)
+      .with anything, foo: :bar
+    command.execute key, foo: :bar
   end
 end
 
-describe Localeapp::CLI::Install::DefaultInstaller, '#execute(key = nil)' do
-  let(:output) { StringIO.new }
-  let(:key) { 'MYAPIKEY' }
-  let(:installer) { Localeapp::CLI::Install::DefaultInstaller.new(output) }
+describe Localeapp::CLI::Install::DefaultInstaller, "#execute" do
+  let(:key)           { "MYAPIKEY" }
+  subject(:installer) { described_class.new StringIO.new }
 
-  before do
-    allow(installer).to receive(:print_header)
-    allow(installer).to receive(:validate_key).and_return(false)
-  end
+  context "when key validation fails" do
+    before do
+      allow(installer).to receive(:print_header)
+      allow(installer).to receive(:validate_key).and_return(false)
+    end
 
-  it "prints the header" do
-    expect(installer).to receive(:print_header)
-    installer.execute
-  end
+    it "prints the header" do
+      expect(installer).to receive(:print_header)
+      installer.execute
+    end
 
-  it "validates the key" do
-    expect(installer).to receive(:key=).with(key)
-    expect(installer).to receive(:validate_key)
-    installer.execute(key)
-  end
+    it "validates the key" do
+      expect(installer).to receive(:key=).with(key)
+      expect(installer).to receive(:validate_key)
+      installer.execute(key)
+    end
 
-  context "When key validation fails" do
     it "returns false" do
       expect(installer.execute(key)).to eq(false)
     end
   end
 
-  context "When key validation is successful" do
+  context "when key validation is successful" do
     before do
       allow(installer).to receive(:validate_key).and_return(true)
-      allow(installer).to receive(:check_default_locale)
+      allow(installer).to receive(:print_default_locale)
       allow(installer).to receive(:set_config_paths)
       allow(installer).to receive(:write_config_file)
       allow(installer).to receive(:check_data_directory_exists)
     end
 
     it "checks the default locale" do
-      expect(installer).to receive(:check_default_locale)
+      expect(installer).to receive(:print_default_locale)
       installer.execute(key)
     end
 
@@ -80,6 +95,32 @@ describe Localeapp::CLI::Install::DefaultInstaller, '#execute(key = nil)' do
       expect(installer.execute(key)).to eq(true)
     end
   end
+
+  context "when given `write_env_file' option with a path" do
+    let :key_checker do
+      double "key checker", check: [true, Hash.new({})]
+    end
+    subject :installer do
+      described_class.new StringIO.new, key_checker: key_checker
+    end
+
+    around do |example|
+      Dir.mktmpdir("localeapp-spec") { |dir| Dir.chdir(dir) { example.run } }
+    end
+
+    it "writes the API key and a new line to the file at given path" do
+      installer.execute key, write_env_file: "some_env_file"
+      expect(File.read("some_env_file"))
+        .to eq "LOCALEAPP_API_KEY=#{key}\n"
+    end
+
+    it "appends the API key at the end of the file" do
+      File.open("some_env_file", "w") { |f| f.puts "FOO=BAR" }
+      installer.execute key, write_env_file: "some_env_file"
+      expect(File.read("some_env_file"))
+        .to match /\AFOO=BAR\nLOCALEAPP_API_KEY/
+    end
+  end
 end
 
 describe Localeapp::CLI::Install::DefaultInstaller, '#validate_key(key)' do
@@ -110,7 +151,7 @@ describe Localeapp::CLI::Install::DefaultInstaller, '#validate_key(key)' do
   end
 end
 
-describe Localeapp::CLI::Install::DefaultInstaller, '#check_default_locale' do
+describe Localeapp::CLI::Install::DefaultInstaller, '#print_default_locale' do
   let(:output) { StringIO.new }
   let(:installer) { Localeapp::CLI::Install::DefaultInstaller.new(output) }
 
@@ -119,15 +160,13 @@ describe Localeapp::CLI::Install::DefaultInstaller, '#check_default_locale' do
   end
 
   it "displays project base locale" do
-    installer.check_default_locale
+    installer.print_default_locale
     expect(output.string).to match(/en \(English\)/)
   end
 
-  it "displays warning if I18n.default_locale doesn't match what's configured on localeapp.com" do
-    allow(I18n).to receive(:default_locale).and_return(:es)
-    installer.check_default_locale
-    expect(output.string)
-      .to match(%r{WARNING: I18n\.default_locale is es, change in config/application\.rb \(Rails 3\+\)})
+  it "warns that I18n.default_locale must match project locale" do
+    installer.print_default_locale
+    expect(output.string).to include "Please ensure I18n.default_locale is en"
   end
 end
 
@@ -148,24 +187,25 @@ describe Localeapp::CLI::Install::DefaultInstaller, '#set_config_paths' do
   end
 end
 
-describe Localeapp::CLI::Install::DefaultInstaller, '#write_config_file' do
-  let(:output) { StringIO.new }
-  let(:config_file_path) { 'config/initializers/localeapp.rb' }
-  let(:key) { 'APIKEY' }
-  let(:installer) { Localeapp::CLI::Install::DefaultInstaller.new(output) }
+describe Localeapp::CLI::Install::DefaultInstaller, "#write_config_file" do
+  let(:config_file_path)  { "config/initializers/localeapp.rb" }
+  let(:key)               { "APIKEY" }
+  let(:file)              { double "file" }
+  subject(:installer)     { described_class.new StringIO.new }
 
-  it "creates a configuration file containing just the api key" do
-    installer.key = key
+  before do
+    allow(File).to receive(:open).and_yield file
     installer.config_file_path = config_file_path
-    file = double('file')
+  end
+
+  it "creates a configuration file reading the API key from the environment" do
     expect(file).to receive(:write).with <<-CONTENT
 require 'localeapp/rails'
 
 Localeapp.configure do |config|
-  config.api_key = 'APIKEY'
+  config.api_key = ENV['LOCALEAPP_API_KEY']
 end
 CONTENT
-    expect(File).to receive(:open).with(config_file_path, 'w+').and_yield(file)
     installer.write_config_file
   end
 end
@@ -222,12 +262,12 @@ CONTENT
     installer.write_config_file
   end
 end
-describe Localeapp::CLI::Install::StandaloneInstaller, '#check_default_locale' do
+describe Localeapp::CLI::Install::StandaloneInstaller, '#print_default_locale' do
   let(:output) { StringIO.new }
   let(:installer) { Localeapp::CLI::Install::StandaloneInstaller.new(output) }
 
   it "does nothing" do
-    installer.check_default_locale
+    installer.print_default_locale
     expect(output.string).to eq('')
   end
 end
@@ -249,28 +289,28 @@ describe Localeapp::CLI::Install::StandaloneInstaller, '#set_config_paths' do
   end
 end
 
-describe Localeapp::CLI::Install::StandaloneInstaller, '#write_config_file' do
-  let(:output) { StringIO.new }
-  let(:key) { 'APIKEY' }
-  let(:config_file_path) { '.localeapp/config.rb' }
-  let(:data_directory) { 'locales' }
-  let(:installer) { Localeapp::CLI::Install::StandaloneInstaller.new(output) }
+describe Localeapp::CLI::Install::StandaloneInstaller, "#write_config_file" do
+  let(:key)               { "APIKEY" }
+  let(:config_file_path)  { ".localeapp/config.rb" }
+  let(:data_directory)    { "locales" }
+  let(:file)              { double "file" }
+  subject(:installer)     { described_class.new StringIO.new }
 
-  it "creates a configuration file containing the dot file configuration at the given config_file_path" do
-    allow(installer).to receive(:create_config_dir).and_return(File.dirname(config_file_path))
-    installer.key = key
+  before do
+    allow(File).to receive(:open).and_yield file
     installer.config_file_path = config_file_path
     installer.data_directory = data_directory
-    file = double('file')
+  end
+
+  it "creates a configuration file using given config_file_path" do
     expect(file).to receive(:write).with <<-CONTENT
 Localeapp.configure do |config|
-  config.api_key                    = 'APIKEY'
+  config.api_key                    = ENV['LOCALEAPP_API_KEY']
   config.translation_data_directory = 'locales'
   config.synchronization_data_file  = '.localeapp/log.yml'
   config.daemon_pid_file            = '.localeapp/localeapp.pid'
 end
 CONTENT
-    expect(File).to receive(:open).with(config_file_path, 'w+').and_yield(file)
     installer.write_config_file
   end
 end