localeapp 2.1.1 → 2.2.0

data/features/bad_command.feature

@@ -1,7 +1,8 @@
-Feature: localeapp executable
-  Scenario: Running a command that doesn't exist
-    In order to warn of a bad command
+Feature: Unknown command
+
+  Scenario: Reports an error when given unknown command
     When I run `localeapp foo`
+    Then the exit status must be 64
     Then the output should contain:
     """
     error: Unknown command 'foo'

data/features/env_file.feature

@@ -0,0 +1,7 @@
+Feature: Reading configuration from `.env' file
+
+  Scenario: Uses the API key from `.env' file
+    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 exit status must be 0

data/features/environment.feature

@@ -0,0 +1,7 @@
+Feature: Reading configuration from environment
+
+  Scenario: Uses the API key set in current environment
+    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 exit status must be 0

data/features/help.feature

@@ -1,8 +1,7 @@
-Feature: Getting help
+Feature: `help' command
 
-  Scenario: Viewing help
-    In order to see what options I have
-    When I run `localeapp help`
+  Scenario: Shows help when given `help' command
+    When I successfully run `localeapp help`
     Then the output should contain:
     """
     localeapp [global options] command [command options]

data/features/install.feature

@@ -1,9 +1,8 @@
-Feature: Installation
+Feature: `install' command
 
-  Scenario: Running Rails install
-    In order to configure my project and check my api key is correct
+  Scenario: Installs rails configuration
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-    When I run `localeapp install MYAPIKEY`
+    When I successfully run `localeapp install MYAPIKEY`
     Then the output should contain:
     """
     Localeapp Install
@@ -13,14 +12,11 @@ Feature: Installation
     Project: Test Project
     Default Locale: en (English)
     """
-      And help should not be displayed
-      And a file named "config/initializers/localeapp.rb" should exist
-      And the exit status should be 0
+    And a file named "config/initializers/localeapp.rb" should exist
 
-  Scenario: Running standalone install
-    In order to configure my non rails project and check my api key is correct
+  Scenario: Installs standalone configuration when given --standalone option
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-    When I run `localeapp install --standalone MYAPIKEY`
+    When I successfully run `localeapp install --standalone MYAPIKEY`
     Then the output should contain:
     """
     Localeapp Install
@@ -32,14 +28,11 @@ Feature: Installation
     Writing configuration file to .localeapp/config.rb
     WARNING: please create the locales directory. Your translation data will be stored there.
     """
-      And help should not be displayed
-      And a file named ".localeapp/config.rb" should exist
-      And the exit status should be 0
+    And a file named ".localeapp/config.rb" should exist
 
-  Scenario: Running github install
-    In order to configure my public github project and check my api key is correct
+  Scenario: Installs standalone config and other files when given --github option
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-    When I run `localeapp install --github MYAPIKEY`
+    When I successfully run `localeapp install --github MYAPIKEY`
     Then the output should contain:
     """
     Localeapp Install
@@ -50,16 +43,13 @@ Feature: Installation
     NOTICE: you probably want to add .localeapp to your .gitignore file
     Writing configuration file to .localeapp/config.rb
     """
-      And help should not be displayed
-      And a file named ".localeapp/config.rb" should exist
-      And a file named ".gitignore" should exist
-      And a file named "README.md" should exist
-      And the exit status should be 0
+    And a file named ".localeapp/config.rb" should exist
+    And a file named ".gitignore" should exist
+    And a file named "README.md" should exist
 
-  Scenario: Running heroku install with no api key
-    In order to configure my project to use localeapp as a heroku addon
+  Scenario: Installs heroku config files when given --heroku option
     Given I have a valid heroku project
-    When I run `localeapp install --heroku`
+    When I successfully run `localeapp install --heroku`
     Then the output should contain:
     """
     Localeapp Install
@@ -73,15 +63,13 @@ Feature: Installation
     Project: Test Project
     Default Locale: en (English)
     """
-      And help should not be displayed
-      And a file named "config/initializers/localeapp.rb" should exist
-      And the file "config/initializers/localeapp.rb" should contain "config.api_key = ENV['LOCALEAPP_API_KEY']"
-      And the exit status should be 0
+    And a file named "config/initializers/localeapp.rb" should exist
+    And the file "config/initializers/localeapp.rb" should contain "config.api_key = ENV['LOCALEAPP_API_KEY']"
 
-  Scenario: Running install with bad api key
-    In order to configure my project and check my api key is correct
+  Scenario: Reports an error when given incorrect API key
     Given I have a valid project on localeapp.com but an incorrect api key "BADAPIKEY"
     When I run `localeapp install BADAPIKEY`
+    Then the exit status must be 1
     Then the output should contain:
     """
     Localeapp Install
@@ -89,6 +77,4 @@ Feature: Installation
     Checking API key: BADAPIKEY
     ERROR: Project not found
     """
-      And help should not be displayed
-      And a file named "config/initializers/localeapp.rb" should not exist
-      And the exit status should not be 0
+    And a file named "config/initializers/localeapp.rb" should not exist

data/features/install/write_env_file.feature

@@ -0,0 +1,26 @@
+Feature: `install' command with `-e' option
+
+  Scenario: describes `-e' option in the `install' command usage
+    When I successfully run `localeapp help install`
+    Then the output must match /-e.*--\[no-\]write-env-file.*write API key to/i
+
+  Scenario: writes API key to `.env' file when given `-e' option
+    Given I have a valid project on localeapp.com with api key "MYAPIKEY"
+    When I successfully run `localeapp install MYAPIKEY -e`
+    Then the file ".env" must contain exactly:
+      """
+      LOCALEAPP_API_KEY=MYAPIKEY
+      """
+
+  Scenario: preserves `.env' file content when given `-e' option
+    Given I have a valid project on localeapp.com with api key "MYAPIKEY"
+    And a file ".env" with content:
+      """
+      FOO=BAR
+      """
+    When I successfully run `localeapp install MYAPIKEY -e`
+    Then the file ".env" must contain exactly:
+      """
+      FOO=BAR
+      LOCALEAPP_API_KEY=MYAPIKEY
+      """

data/features/mv.feature

@@ -1,10 +1,9 @@
-Feature: Renaming a translation from the command line
+Feature: `mv' command
 
-  Scenario: Running mv
-    In order to rename an existing key
+  Scenario: Renames the given translation
     Given I have a valid project on localeapp.com with api key "MYAPIKEY" and the translation key "foo.bar"
-      And an initializer file
-    When I run `localeapp mv foo.bar foo.baz`
+    And an initializer file
+    When I successfully run `localeapp mv foo.bar foo.baz`
     Then the output should contain:
     """
     Localeapp mv
@@ -13,3 +12,8 @@ Feature: Renaming a translation from the command line
     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 mv foo.bar foo.baz`
+    Then the exit status must be 70
+    And the output must match /error.+404/i

data/features/options/api_key.feature

@@ -0,0 +1,6 @@
+Feature: `-k' global option (`--api-key')
+
+  Scenario: Uses the API key given as `-k' option
+    Given I have a valid project on localeapp.com with api key "MYAPIKEY"
+    When I run `localeapp -k MYAPIKEY add foo en:"en content"`
+    Then the exit status must be 0

data/features/pull.feature

@@ -1,11 +1,11 @@
-Feature: Pulling all translation
+Feature: `pull' command
 
-  Scenario: Running pull
-    In order to retrieve my translations
+  Scenario: Pulls translations
     Given I have a translations on localeapp.com for the project with api key "MYAPIKEY"
-      And an initializer file
-      And a directory named "config/locales"
-    When I run `localeapp pull`
+    And an initializer file
+    And a directory named "config/locales"
+    And a directory named "log"
+    When I successfully run `localeapp pull`
     Then the output should contain:
     """
     Localeapp Pull
@@ -15,32 +15,20 @@ Feature: Pulling all translation
     Updating backend:
     Success!
     """
-      And help should not be displayed
-      And a file named "config/locales/en.yml" should exist
+    And a file named "config/locales/en.yml" should exist
 
-  Scenario: Running pull without having a locales dir
-    In order to retreive my translations
+  Scenario: Reports an error when locales directory is missing
     Given I have a translations on localeapp.com for the project with api key "MYAPIKEY"
-      And an initializer file
+    And an initializer file
     When I run `localeapp pull`
-    Then the output should contain:
+    Then the exit status must be 1
+    And the output should contain:
     """
     Could not write locale file, please make sure that config/locales exists and is writable
     """
 
-  Scenario: Running pull with no initializer file, passing the key on the command line
-    In order to retrieve my translations
-    Given I have a translations on localeapp.com for the project with api key "MYAPIKEY"
-      And a directory named "config/locales"
+  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 pull`
-    Then the output should contain:
-    """
-    Localeapp Pull
-
-    Fetching translations:
-    Success!
-    Updating backend:
-    Success!
-    """
-      And help should not be displayed
-      And a file named "config/locales/en.yml" should exist
+    Then the exit status must be 70
+    And the output must match /error.+404/i

data/features/push.feature

@@ -1,11 +1,10 @@
-Feature: Pushing existing translation to localeapp
+Feature: `push' command
 
-  Scenario: Running push on a file
-    In order to send my translations
+  Scenario: Pushes translations in a specific locales file
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And an initializer file
-      And an empty file named "config/locales/en.yml"
-    When I run `localeapp push config/locales/en.yml`
+    And an initializer file
+    And an empty file named "config/locales/en.yml"
+    When I successfully run `localeapp push config/locales/en.yml`
     Then the output should contain:
     """
     Localeapp Push
@@ -15,15 +14,13 @@ Feature: Pushing existing translation to localeapp
 
     config/locales/en.yml queued for processing.
     """
-      And help should not be displayed
 
-  Scenario: Running push on a directory
-    In order to send my translations
+  Scenario: Pushes all locales within given directory
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And an initializer file
-      And an empty file named "config/locales/en.yml"
-      And an empty file named "config/locales/es.yml"
-    When I run `localeapp push config/locales`
+    And an initializer file
+    And an empty file named "config/locales/en.yml"
+    And an empty file named "config/locales/es.yml"
+    When I successfully run `localeapp push config/locales`
     Then the output should contain:
     """
     Localeapp Push
@@ -38,20 +35,10 @@ Feature: Pushing existing translation to localeapp
 
     config/locales/es.yml queued for processing.
     """
-      And help should not be displayed
 
-  Scenario: Running push on a file with no initializer file, passing the key on the command line
-    In order to send my translations
-    Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And an empty file named "config/locales/en.yml"
+  Scenario: Reports an error when the given API key is incorrect
+    Given no project exist on localeapp.com with API key "MYAPIKEY"
+    And an empty file named "config/locales/en.yml"
     When I run `localeapp -k MYAPIKEY push config/locales/en.yml`
-    Then the output should contain:
-    """
-    Localeapp Push
-
-    Pushing file en.yml:
-    Success!
-
-    config/locales/en.yml queued for processing.
-    """
-      And help should not be displayed
+    Then the exit status must be 70
+    And the output must match /error.+404/i

data/features/rm.feature

@@ -1,10 +1,9 @@
-Feature: Removing a translation from the command line
+Feature: `rm' command
 
-  Scenario: Running rm
-    In order to remove an existing key
+  Scenario: Removes the given key
     Given I have a valid project on localeapp.com with api key "MYAPIKEY" and the translation key "foo.bar"
-      And an initializer file
-    When I run `localeapp rm foo.bar`
+    And an initializer file
+    When I successfully run `localeapp rm foo.bar`
     Then the output should contain:
     """
     Localeapp rm
@@ -12,3 +11,9 @@ Feature: Removing a translation from the command line
     Remove key: foo.bar
     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 rm foo.bar`
+    Then the exit status must be 70
+    And the output must match /error.+404/i

data/features/step_definitions/cli_steps.rb

@@ -1,11 +1,23 @@
 require 'net/http'
 require 'time'
 
+Given /^no project exist on localeapp\.com with API key "([^"]+)"$/ do |api_key|
+  add_fake_web_uri :any, /\Ahttps:\/\/api\.localeapp\.com\/.*/,
+    [404, "Not Found"],
+    ""
+end
+
 When /^I have a valid project on localeapp\.com with api key "([^"]*)"$/ do |api_key|
   uri = "https://api.localeapp.com/v1/projects/#{api_key}.json"
   body = valid_project_data.to_json
   add_fake_web_uri(:get, uri, ['200', 'OK'], body)
-  add_fake_web_uri(:post, "https://api.localeapp.com/v1/projects/#{api_key}/import/", ['202', 'OK'], '')
+  add_fake_web_uri(
+    :post,
+    "https://api.localeapp.com/v1/projects/#{api_key}/import/",
+    %w[202 OK],
+    JSON.generate(id: 12345),
+    "Content-Type" => "application/json; charset=utf-8"
+  )
   add_fake_web_uri(:post, "https://api.localeapp.com/v1/projects/#{api_key}/translations/missing.json", ["202", "OK"], '')
 end
 
@@ -71,15 +83,6 @@ When /^an initializer file$/ do
   }
 end
 
-When /^help should not be displayed$/ do
-  steps %Q{
-    And the output should not contain:
-    """
-    Usage: localeapp COMMAND [options]
-    """
-  }
-end
-
 When /^the timestamp is (\d+) months? old$/ do |months|
   @timestamp = Time.now.to_i - months.to_i * 2592000
   steps %Q{

data/features/step_definitions/execution_steps.rb

@@ -0,0 +1,3 @@
+Then /^the exit status must be (\d+)$/ do |status|
+  expect(last_command_started).to have_exit_status status.to_i
+end

data/features/step_definitions/filesystem_steps.rb

@@ -0,0 +1,12 @@
+Given /^a file "([^"]+)" with content:$/ do |path, content|
+  cd ?. do
+    File.write(path, content + $/)
+  end
+end
+
+
+Then /^the file "([^"]+)" must contain exactly:$/ do |path, content|
+  cd ?. do
+    expect(File.read(path)).to eq content + $/
+  end
+end

data/features/step_definitions/output_steps.rb

@@ -0,0 +1,10 @@
+Then /^the output must match \/([^\/]+)\/([imx]*)$/ do |pattern, options|
+  regexp = Regexp.new(pattern, options.each_char.inject(0) do |m, e|
+    m | case e
+      when ?i then Regexp::IGNORECASE
+      when ?m then Regexp::MULTILINE
+      when ?x then Regexp::EXTENDED
+    end
+  end)
+  expect(last_command_started.output).to match regexp
+end

data/features/support/env.rb

@@ -6,7 +6,7 @@ World(LocaleappIntegrationData)
 
 module FakeWebHelper
   def add_fake_web_uri(method, uri, status, body, headers = {})
-    fakes = JSON.parse(aruba.environment['FAKE_WEB_FAKES'] || '[]')
+    fakes = YAML.load(aruba.environment['FAKE_WEB_FAKES'] || '[]')
     fakes << {
       'method' => method,
       'uri' => uri,
@@ -14,7 +14,7 @@ module FakeWebHelper
       'body' => body,
       'headers' => headers
     }
-    set_environment_variable 'FAKE_WEB_FAKES', fakes.to_json
+    set_environment_variable 'FAKE_WEB_FAKES', YAML.dump(fakes)
   end
 end
 World(FakeWebHelper)

data/features/update.feature

@@ -1,38 +1,29 @@
-Feature: Getting new translations
+Feature: `update' command
 
-  Scenario: Running update
-    In order to receive the translations that have been updated since the last check
+  Scenario: Fetches translations
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And an initializer file
-      And the timestamp is 2 months old
-      And new translations for the api key "MYAPIKEY" since last fetch with time "60" seconds later
-      And a directory named "config/locales"
-    When I run `localeapp update`
+    And an initializer file
+    And the timestamp is 2 months old
+    And new translations for the api key "MYAPIKEY" since last fetch with time "60" seconds later
+    And a directory named "config/locales"
+    When I successfully run `localeapp update`
     Then translations should be fetched since last fetch only
-      And help should not be displayed
-      And a file named "config/locales/en.yml" should exist
-      # check the content here
-      # and the localeapp.yml file
+    And a file named "config/locales/en.yml" should exist
 
-  Scenario: Running update with no initializer file, passing the key on the command line
-    In order to receive the translations that have been updated since the last check
+  Scenario: Reports an error when timestamp is too old
     Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And the timestamp is 2 months old
-      And new translations for the api key "MYAPIKEY" since last fetch with time "60" seconds later
-      And a directory named "config/locales"
-    When I run `localeapp -k MYAPIKEY update`
-    Then translations should be fetched since last fetch only
-      And help should not be displayed
-      And a file named "config/locales/en.yml" should exist
-
-  Scenario: Running update with a too old timestamp
-    In order to receive the translations that have been updated since the last check
-    Given I have a valid project on localeapp.com with api key "MYAPIKEY"
-      And an initializer file
-      And the timestamp is 8 months old
-    When I run `localeapp update`
+    And an initializer file
+    And the timestamp is 8 months old
+    When I successfully run `localeapp update`
     Then the output should contain:
     """
     Timestamp is missing or too old
     """
-      And help should not be displayed
+
+  Scenario: Reports an error when the given API key is incorrect
+    Given no project exist on localeapp.com with API key "MYAPIKEY"
+    And the timestamp is 2 months old
+    And a directory named "config/locales"
+    When I run `localeapp -k MYAPIKEY update`
+    Then the exit status must be 70
+    And the output must match /error.+404/i