localeapp 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 690435fd986bf2774e1e41678d33f661ac5666ea
-  data.tar.gz: 34312483afc9c05268c324b6f4f870741a9216d2
+  metadata.gz: 778186a71665c8f24e361206ffa3b65ac2cee621
+  data.tar.gz: 60bfaf8940fd301c0854e2c1d41d4a2d4862cab8
 SHA512:
-  metadata.gz: dd05673abf620abf78326d981e8565ba92c65639a2209b9c58af9ee5571897a5f857125f12afeefe21bd0e3a39a2f67e1e8e6acf304e64bdf4a8905c5a1b77e3
-  data.tar.gz: fa285a2816b2e78254cb1abda09f9c3955447f34042429d1dbc5b3afa5ced32b18b84acbad55ce16fc34e3f10482199dde25b8e6489cdd53948de1451f5c14ab
+  metadata.gz: '06567599ed2fa7388bdcbd49b448d426ebfa581566128af299520eac8e56c1b4c993e0fa48ae6eb34eabd4ea87e7803d228e8c693381dab6809ad754c2a4ab0b'
+  data.tar.gz: 69ea7fb872f3f4524d448c31f968373a70e8db445b03328cb3392856d3e4e103363376cba9e51209c128adc9c907695cd0d033e17b385385121d16af1cea5c6f

data/.travis.yml

@@ -3,12 +3,13 @@ dist: trusty
 before_install:
   - gem install bundler
 rvm:
-  - 2.4.0
-  - 2.3.3
-  - 2.2.6
+  - 2.4.1
+  - 2.3.4
+  - 2.2.7
   - 2.1.10
   - jruby
 gemfile:
+  - Gemfile
   - gemfiles/i18n_0.4.gemfile
   - gemfiles/i18n_0.5.gemfile
   - gemfiles/i18n_0.6.gemfile

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # master
 
+# Version 2.2.0
+
+* Read API key from environment in generated config files, instead of
+  writing the API key directly in those files
+* Fix handling of HTTP errors when querying API
+* Stop checking project and app default locale at install
+
+# Version 2.1.1
+
 * Support ruby 2.4
+
+# Version 2.1.0
+
 * Drop ruby 1.9 and ruby 2.0 support
 
 # Version 2.0.0

data/README.md

@@ -14,6 +14,15 @@ Though the i18n gem uses YAML as it's default file format it doesn't require ser
 
 ## Installation
 
+Note that the API key is actually never written to configuration files
+generated by the gem, but is expected to be set in the environment as
+`LOCALEAPP_API_KEY`.
+
+For convenience, the `install` command accepts a `-e` or
+`--write-env-file` option that will append the API key to `.env` file,
+so that you can use `foreman` or other tools supporting this
+convention.
+
 ### Rails 3+
 
 Add the localeapp gem to your `Gemfile` and install it:

data/bin/localeapp

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+require 'gli'
+
 require 'localeapp'
 
 # Don't connect to the net if we're running under cucumber for testing
@@ -11,157 +13,177 @@ if ENV['FAKE_WEB_DURING_CUCUMBER_RUN']
   end
   FakeWeb.allow_net_connect = false
   if fake_data_as_json = ENV['FAKE_WEB_FAKES']
-    fakes = JSON.parse(fake_data_as_json)
+    fakes = YAML.load(fake_data_as_json)
     fakes.each do |fake|
       FakeWeb.register_uri fake['method'].to_sym, fake['uri'], { :body => fake['body'], :status => fake['status'] }.merge(fake['headers'])
     end
   end
 end
 
-require 'gli'
-gli2 = GLI::VERSION >= '2.0.0'
-
-if gli2
-  include GLI::App
-else
-  include GLI
-end
-
-pre do |global_options, command, options, args|
-  global_options[:k] = if global_options[:k]
-    global_options[:k]
-  elsif ENV['LOCALEAPP_API_KEY']
-    ENV['LOCALEAPP_API_KEY']
-  elsif File.exist?('.env') && IO.read('.env') =~ /^LOCALEAPP_API_KEY=(\w+)$/
-    $1
+module LocaleappGLIWrapper
+  gli2 = GLI::VERSION >= '2.0.0'
+  if gli2
+    include GLI::App
   else
-    nil
+    include GLI
   end
+  extend self
+
+  pre do |global_options, command, options, args|
+    global_options[:k] = if global_options[:k]
+      global_options[:k]
+    elsif ENV['LOCALEAPP_API_KEY']
+      ENV['LOCALEAPP_API_KEY']
+    elsif File.exist?('.env') && IO.read('.env') =~ /^LOCALEAPP_API_KEY=(\w+)$/
+      $1
+    else
+      nil
+    end
 
-  if Localeapp.has_config_file? || !global_options[:k].nil?
-    true
-  else
-    puts "Could not load config file and no key specified"
-    exit 1
+    if Localeapp.has_config_file? || !global_options[:k].nil?
+      true
+    else
+      puts "Could not load config file and no key specified"
+      exit 1
+    end
   end
-end
 
-desc "API Key (for when there is no configuration file)"
-flag [:k, 'api-key']
-
-version Localeapp::VERSION
-
-desc "Creates new configuration files and confirms key works"
-skips_pre
-arg_name "<api_key>"
-command :install do |c|
-  c.desc "install configuration files in .localeapp/"
-  c.switch [:s, 'standalone']
-
-  c.desc "create configuration when using localeapp via a heroku addon (PRE ALPHA)"
-  c.switch [:h, 'heroku']
-
-  c.desc "install a skeleton project suitable for Github (warning: README.md will be overwritten)"
-  c.switch [:g, 'github']
-
-  c.action do |global_options, options, args|
-    key = args.first
-    installer = Localeapp::CLI::Install.new
-    installer.config_type = :standalone if options[:standalone]
-    installer.config_type = :heroku if options[:heroku]
-    installer.config_type = :github if options[:github]
-    installer.config_type ||= :rails
-    unless installer.execute(key)
-      exit_now! "", 1
+  on_error do |ex|
+    case ex
+    when Localeapp::APIResponseError
+      $stderr.puts "ERROR: #{ex}"
+      exit 70
+      false
+    else
+      true
     end
   end
-end
 
-desc "Sends the key and content to localeapp.com"
-arg_name "<key> <locale:content> (<locale:content> ...)"
-command :add do |c|
-  c.action do |global_options, options, args|
-    key = args.shift
-    if key.nil? || args.size.zero?
-      exit_now! "localeapp add requires a key name and at least one translation", 1
-    else
-      Localeapp::CLI::Add.new(global_options).execute(key, *args)
+  desc "API Key (for when there is no configuration file)"
+  flag [:k, 'api-key']
+
+  version Localeapp::VERSION
+
+  desc "Creates new configuration files and confirms key works"
+  skips_pre
+  arg_name "<api_key>"
+  command :install do |c|
+    c.desc "install configuration files in .localeapp/"
+    c.switch [:s, 'standalone']
+
+    c.desc "create configuration when using localeapp via a heroku addon (PRE ALPHA)"
+    c.switch [:h, 'heroku']
+
+    c.desc "install a skeleton project suitable for Github " \
+      "(warning: will write to .gitignore and README.md"
+    c.switch [:g, 'github']
+
+    c.desc "write API key to `#{Localeapp.env_file_path}'"
+    c.switch [:e, "write-env-file"]
+
+    c.action do |global_options, options, args|
+      install_opts = {}
+      if options[:"write-env-file"]
+        install_opts[:write_env_file] = Localeapp.env_file_path
+      end
+      key = args.first
+      installer = Localeapp::CLI::Install.new
+      installer.config_type = :standalone if options[:standalone]
+      installer.config_type = :heroku if options[:heroku]
+      installer.config_type = :github if options[:github]
+      installer.config_type ||= :rails
+      unless installer.execute(key, install_opts)
+        exit_now! "", 1
+      end
     end
   end
-end
 
-desc "removes a key from the project"
-arg_name "<key>"
-command :rm do |c|
-  c.action do |global_options, options, args|
-    key = args.shift
-    if key.nil?
-      exit_now! "localeapp rm requires a key name", 1
-    else
-      Localeapp::CLI::Remove.new(global_options).execute(key, *args)
+  desc "Sends the key and content to localeapp.com"
+  arg_name "<key> <locale:content> (<locale:content> ...)"
+  command :add do |c|
+    c.action do |global_options, options, args|
+      key = args.shift
+      if key.nil? || args.size.zero?
+        exit_now! "localeapp add requires a key name and at least one translation", 1
+      else
+        Localeapp::CLI::Add.new(global_options).execute(key, *args)
+      end
     end
   end
-end
 
-desc "renames a key in the project"
-arg_name "<current key name> <new key name>"
-command :mv do |c|
-  c.action do |global_options, options, args|
-    current_name = args.shift
-    new_name = args.shift
-    if current_name.nil? || new_name.nil?
-      exit_now! "localeapp mv requires a current key name and a new key name", 1
-    else
-      Localeapp::CLI::Rename.new(global_options).execute(current_name, new_name, *args)
+  desc "removes a key from the project"
+  arg_name "<key>"
+  command :rm do |c|
+    c.action do |global_options, options, args|
+      key = args.shift
+      if key.nil?
+        exit_now! "localeapp rm requires a key name", 1
+      else
+        Localeapp::CLI::Remove.new(global_options).execute(key, *args)
+      end
     end
   end
-end
 
-desc "Pulls all translations from localeapp.com"
-command :pull do |c|
-  c.action do |global_options, options, args|
-    Localeapp::CLI::Pull.new(global_options).execute
+  desc "renames a key in the project"
+  arg_name "<current key name> <new key name>"
+  command :mv do |c|
+    c.action do |global_options, options, args|
+      current_name = args.shift
+      new_name = args.shift
+      if current_name.nil? || new_name.nil?
+        exit_now! "localeapp mv requires a current key name and a new key name", 1
+      else
+        Localeapp::CLI::Rename.new(global_options).execute(current_name, new_name, *args)
+      end
+    end
   end
-end
 
-desc "Pushes a translation file or directory to localeapp.com"
-arg_name "<file>"
-command :push do |c|
-  c.action do |global_options, options, args|
-    if args.empty?
-      exit_now! "localeapp push requires a file or directory to push", 1
-    else
-      path = args.first
-      pusher = Localeapp::CLI::Push.new(global_options)
-      pusher.execute(path)
+  desc "Pulls all translations from localeapp.com"
+  command :pull do |c|
+    c.action do |global_options, options, args|
+      Localeapp::CLI::Pull.new(global_options).execute
+    end
+  end
+
+  desc "Pushes a translation file or directory to localeapp.com"
+  arg_name "<file>"
+  command :push do |c|
+    c.action do |global_options, options, args|
+      if args.empty?
+        exit_now! "localeapp push requires a file or directory to push", 1
+      else
+        path = args.first
+        pusher = Localeapp::CLI::Push.new(global_options)
+        pusher.execute(path)
+      end
     end
   end
-end
 
-desc "Gets any changes since the last poll and updates the yml"
-command :update do |c|
-  c.action do |global_options, options, args|
-    Localeapp::CLI::Update.new(global_options).execute
+  desc "Gets any changes since the last poll and updates the yml"
+  command :update do |c|
+    c.action do |global_options, options, args|
+      Localeapp::CLI::Update.new(global_options).execute
+    end
   end
-end
 
-desc "Simple daemon (checks for new translations in the background)"
-command :daemon do |c|
-  c.desc "Interval to wait between checks"
-  c.arg_name 'interval'
-  c.default_value 5
-  c.flag [:i, :interval]
+  desc "Simple daemon (checks for new translations in the background)"
+  command :daemon do |c|
+    c.desc "Interval to wait between checks"
+    c.arg_name 'interval'
+    c.default_value 5
+    c.flag [:i, :interval]
 
-  c.desc "run the daemon in the background"
-  c.switch [:b, 'background']
+    c.desc "run the daemon in the background"
+    c.switch [:b, 'background']
 
-  c.action do |global_options, options, args|
-    Localeapp::CLI::Daemon.new(global_options).execute(options)
+    c.action do |global_options, options, args|
+      Localeapp::CLI::Daemon.new(global_options).execute(options)
+    end
   end
-end
 
-if gli2
-  exit run(ARGV)
-else
-  exit GLI.run(ARGV)
+  if gli2
+    exit run(ARGV)
+  else
+    exit GLI.run(ARGV)
+  end
 end

data/features/add.feature

@@ -1,10 +1,9 @@
-Feature: Adding a translation from the command line
+Feature: `add' command
 
-  Scenario: Running add
-    In order to add a key and translation content
+  Scenario: Adds the given translation
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And an initializer file
-    When I run `localeapp add foo.baz en:"test en content" es:"test es content"`
+    And an initializer file
+    When I successfully run `localeapp add foo.baz en:"test en content" es:"test es content"`
     Then the output should contain:
     """
     Localeapp Add
@@ -13,60 +12,27 @@ Feature: Adding a translation from the command line
     Success!
     """
 
-  Scenario: Running add with no arguments
-    In order to add a key and translation content
+  Scenario: Reports an error when no translation is given
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And an initializer file
+    And an initializer file
     When I run `localeapp add`
-    Then the output should contain:
+    Then the exit status must be 1
+    And the output should contain:
     """
     localeapp add requires a key name and at least one translation
     """
 
-  Scenario: Running add with just a key name
-    In order to add a key and translation content
+  Scenario: Reports an error when given a translation without description
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And an initializer file
+    And an initializer file
     When I run `localeapp add foo.bar`
     Then the output should contain:
     """
     localeapp add requires a key name and at least one translation
     """
 
-  Scenario: Running add with no initializer file, passing the key on the command line
-    In order to add a key and translation content
-    Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-    When I run `localeapp -k MYAPIKEY add foo.baz en:"test en content"`
-    Then the output should contain:
-    """
-    Localeapp Add
-
-    Sending key: foo.baz
-    Success!
-    """
-
-  Scenario: Running add with no initializer file, passing the key via an ENV variable
-    In order to add a key and translation content
-    Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And I have a LOCALEAPP_API_KEY env variable set to "MYAPIKEY"
-    When I run `localeapp add foo.baz en:"test en content"`
-    Then the output should contain:
-    """
-    Localeapp Add
-
-    Sending key: foo.baz
-    Success!
-    """
-
-  Scenario: Running add with no initializer file, passing the key via a .env file
-    In order to add a key and translation content
-    Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And I have a .env file containing the api key "MYAPIKEY"
-    When I run `localeapp add foo.baz en:"test en content"`
-    Then the output should contain:
-    """
-    Localeapp Add
-
-    Sending key: foo.baz
-    Success!
-    """
+  Scenario: Reports an error when the given API key is incorrect
+    Given no project exist on localeapp.com with API key "MYAPIKEY"
+    When I run `localeapp -k MYAPIKEY add foo en:bar`
+    Then the exit status must be 70
+    And the output must match /error.+404/i