apiaryio 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e6995c7b6279057158a86a019baa4d4b27fdc53
-  data.tar.gz: 27d6406ab90b3bffb7c4585091c65289c22d64ed
+  metadata.gz: 3007546160a6dea1800e9169dcc6c5bf5d7b922a
+  data.tar.gz: d680b08d8dfa134439d995f1ebde24b34c68dc51
 SHA512:
-  metadata.gz: aa8934e0500a0f9b59db8e6d6768669c69c323ab2d387c0db8dfa11b39d1d7fa9f41d9ae92ca6290a471541027912082ef220bded7bc0ef6db445b40fb475916
-  data.tar.gz: b9d5a3e3f6d5f32db8d6902d49b1b8cd65b32f22af53fb8d09204eb8592a0585191f0dbce2f2ab6076fd56423b3b7c0ba7896b8ca83c86c19e3ed1772c257a47
+  metadata.gz: 8bbd3db0eefbb44e76e8ac31db64cce8808ba707a297c246fbaefd17a46840f97867d288de24e8de25d2020777e1bd07aa8be08801077eda6d8876cfbbb42410
+  data.tar.gz: 28e0a1c207101776b32f20c1fda40065cc3ea0e0eceeebd8fb8fa81690468ebb2262bfcf64945276805fbe7634efdfd0f65a220800d45b3d1ab735dc0590d27b

data/.rubocop_todo.yml

@@ -10,7 +10,7 @@ Metrics/AbcSize:
   Max: 33
 
 Metrics/ClassLength:
-  Max: 150 # or whatever ends up being appropriate
+  Max: 190 # or whatever ends up being appropriate
 
 Metrics/PerceivedComplexity:
   Max: 12

data/README.md

@@ -136,6 +136,7 @@ Options:
   [--functions=FUNCTIONS]              # Path to to the file with functions definitions
   [--rules=RULES]                      # Path to to the file with rules definitions - `functions.js` and `rules.json` are loaded if not specified
   [--full-report], [--no-full-report]  # Get passed assertions ass well. Only failed assertions are included to the result by default
+  [--json], [--no-json]                # Outputs all in json
 
 Check API Description Document against styleguide rules (Apiary.io pro plan is required - https://apiary.io/plans )
 

data/features/styleguide.feature

@@ -2,12 +2,19 @@ Feature: Styleguide apiary.apib on docs.API_NAME.apiary.io
 
   # This is integration testing you have to set APIARY_API_KEY
   @needs_apiary_api_key
-  Scenario: Styleguide validation
+  Scenario: Styleguide validation - pass
 
     When I run `apiary  styleguide --functions=../../features/support --rules=../../features/support --add=../../features/support --full_report`
-    Then the output should match /(\"validatorError\": false)/
+    Then the output should match /(PASSED)/
     And the exit status should be 0
 
+  @needs_apiary_api_key
+  Scenario: Styleguide validation - fail
+
+    When I run `apiary  styleguide --functions=../../features/support/functions-fail.js --rules=../../features/support --add=../../features/support --full_report`
+    Then the output should match /(FAILED)/
+    And the exit status should be 1
+
   # This is integration testing you have to set APIARY_API_KEY
   @needs_apiary_api_key
   Scenario: Styleguide fetch

data/features/support/functions-fail.js

@@ -0,0 +1,7 @@
+/*
+ @targets: API_Name
+ */
+
+function validateApiName(apiName) {
+    return 'fail';
+};

data/lib/apiary/cli.rb

@@ -52,6 +52,7 @@ module Apiary
     method_option :functions, type: :string, desc: 'Path to to the file with functions definitions'
     method_option :rules, type: :string, desc: 'Path to to the file with rules definitions - `functions.js` and `rules.json` are loaded if not specified'
     method_option :full_report, type: :boolean, default: false, desc: 'Get passed assertions ass well. Only failed assertions are included to the result by default'
+    method_option :json, type: :boolean, default: false, desc: 'Outputs all in json'
     def styleguide
       cmd = Apiary::Command::Styleguide.new options
       cmd.execute

data/lib/apiary/command/styleguide.rb

@@ -30,6 +30,7 @@ module Apiary::Command
         user_agent: Apiary.user_agent
       }
       @options.failedOnly = !@options.full_report
+      @options.json
     end
 
     def execute
@@ -83,12 +84,66 @@ module Apiary::Command
       headers = @options.headers.clone
       headers[:Authorization] = "Bearer #{token}"
 
-      result = call_resource(@options.vk_url, data, headers, :post)
+      output call_resource(@options.vk_url, data, headers, :post)
+    end
+
+    def print_output_text(result)
+      lines = if result['sourcemapLines']['start'] == result['sourcemapLines']['end']
+                "on line #{result['sourcemapLines']['start']}"
+              else
+                "on lines #{result['sourcemapLines']['start']} - #{result['sourcemapLines']['end']}"
+              end
+
+      if result['result'] == true
+        puts "      [\u2713] PASSED: #{(result['path'] || '').gsub('-', ' #')} #{lines}"
+      else
+        puts "      [\u274C] FAILED: #{(result['path'] || '').gsub('-', ' #')} #{lines} - `#{result['result']}`"
+      end
+    end
+
+    def json_output(json_response)
+      puts JSON.pretty_generate json_response
+    end
+
+    def human_output(json_response)
+      if json_response.empty?
+        puts 'All tests has passed'
+        exit 0
+      end
+
+      puts ''
+
+      at_least_one_failed = false
 
+      json_response.each do |response|
+        puts "    #{(response['intent'] || response['ruleName'] || response['functionName'])}"
+
+        (response['results'] || []).each do |result|
+          print_output_text result
+          at_least_one_failed = true if result['result'] != true
+        end
+
+        puts ''
+      end
+
+      if at_least_one_failed
+        exit 1
+      else
+        exit 0
+      end
+    end
+
+    def output(raw_response)
       begin
-        puts JSON.pretty_generate(JSON.parse(result))
+        json_response = JSON.parse(raw_response)
       rescue
-        abort "Error: Can not parse result: #{result}"
+        abort "Error: Can not parse result: #{raw_response}"
+      end
+
+      if @options.json
+        json_output json_response
+      else
+        human_output json_response
       end
     end
 
@@ -126,7 +181,6 @@ module Apiary::Command
           abort "#{message} #{e.message}"
         end
       end
-
       response
     end
 

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = '0.9.1'.freeze
+  VERSION = '0.10.1'.freeze
 end

data/spec/apiary/command/styleguide_spec.rb

@@ -128,15 +128,38 @@ describe Apiary::Command::Styleguide do
       test_abort(command, 'supportXXZ` not found')
     end
 
-    it 'call command with correct paths' do
+    it 'call command with correct options which should fail' do
       opts = {
         api_key: 'xxx',
-        functions: 'features/support',
+        functions: 'features/support/functions-fail.js',
         rules: 'features/support',
         add: 'features/support',
         full_report: true
       }
 
+      command = Apiary::Command::Styleguide.new(opts)
+      stub_request(:get, "https://#{command.options.api_host}/styleguide-cli/get-token/").to_return(status: 200, body: '{"jwt":"xxx"}')
+      response = '[{"ruleName":"validateApiName","functionName":"validateApiName","target":"API_Name","intent":"validateApiName","code":"function validateApiName(apiName) {\n    return \'fail\';\n}","functionComment":"\n @targets: API_Name\n ","allowedPaths":["API_Name"],"ref":["API_Name-0"],"results":[{"validatorError":false,"result":"fail","path":"API_Name-0","data":"test","sourcemap":[[12,7]],"sourcemapLines":{"start":2,"end":2}}]}]'
+      stub_request(:post, command.options.vk_url).to_return(status: 200, body: response)
+
+      expect do
+        begin
+          command.execute
+        rescue SystemExit
+        end
+      end.to output("\n    validateApiName\n      [❌] FAILED: API_Name #0 on line 2 - `fail`\n\n").to_stdout
+    end
+
+    it 'call command with correct options and json output' do
+      opts = {
+        api_key: 'xxx',
+        functions: 'features/support',
+        rules: 'features/support',
+        add: 'features/support',
+        full_report: true,
+        json: true
+      }
+
       command = Apiary::Command::Styleguide.new(opts)
       stub_request(:get, "https://#{command.options.api_host}/styleguide-cli/get-token/").to_return(status: 200, body: '{"jwt":"xxx"}')
       stub_request(:post, command.options.vk_url).to_return(status: 200, body: '[]')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiaryio
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Apiary Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -234,6 +234,7 @@ files:
 - features/styleguide.feature
 - features/support/apiary.apib
 - features/support/env.rb
+- features/support/functions-fail.js
 - features/support/functions.js
 - features/support/rules.json
 - features/version.feature
@@ -288,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Apiary.io CLI
@@ -300,6 +301,7 @@ test_files:
 - features/styleguide.feature
 - features/support/apiary.apib
 - features/support/env.rb
+- features/support/functions-fail.js
 - features/support/functions.js
 - features/support/rules.json
 - features/version.feature