apiaryio 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 768665ed3a42ed87270a3522905819dc9377c3f6
-  data.tar.gz: a010689469ffb7d892fe9c60a57a44e668b239d7
+  metadata.gz: ac019fb0a54cb6bd3219a060a7fe40ffe9bd6a7d
+  data.tar.gz: 4625c0c0fa4e2f979939cd14e9335413976c15b5
 SHA512:
-  metadata.gz: 2299e404841da76094e0f3adbc688fe4624d37e63de1067fcd639f052a73ff11b7907e63b38f753e8f77605526cff8eb519da21a756fba2b5cd4cefe7637c40d
-  data.tar.gz: 1d016e849e665af2716875d849d8d4bd2b36624d5b42637339b3588a11beb42f78b3ab5757e0793d18498f965dc6fb9a927cbf57b5ff20cc548429f6d9665a09
+  metadata.gz: '09693e31a8d82c94b44e3d2a4ac989d44ac290855ca822b412c75289ece2249f6c3b02c7eaf19119702f3505f580b736853bc43c020777e9fe46020a28c329b4'
+  data.tar.gz: 55ef88709de35254b142bba467576794e72d483209d6adcd3b96d98f0f5fd13a84dd08c8ad5d6a22142420a00354c5349cef6f5b6e29f036211d6755af959a5b

data/README.md

@@ -61,6 +61,7 @@ Commands:
   apiary help [COMMAND]               # Describe available commands or one specific command
   apiary preview                      # Show API documentation in browser or write it to file
   apiary publish --api-name=API_NAME  # Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io)
+  apiary styleguide                   # Check API Description Document against styleguide rules (Apiary.io pro plan is required - https://apiary.io/plans )
   apiary version                      # Show version
 
 ```
@@ -92,7 +93,7 @@ Usage:
 Options:
   [--browser=BROWSER]        # Show API documentation in specified browser (full command is needed - e.g. `--browser='open -a safari'` in case of osx)
   [--output=FILE]            # Write generated HTML into specified file
-  [--path=PATH]              # Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file
+  [--path=PATH]              # Specify path to API Description Document. When given a directory, it will look for `apiary.apib` and `swagger.yaml` file
   [--json], [--no-json]      # Specify that Swagger API Description Document is in json format. Document will be converted to yaml before processing
   [--api-host=HOST]          # Specify apiary host
   [--server], [--no-server]  # Start standalone web server on port 8080
@@ -112,7 +113,7 @@ Usage:
 
 Options:
   [--message=COMMIT_MESSAGE]  # Publish with custom commit message
-  [--path=PATH]               # Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file
+  [--path=PATH]               # Specify path to API Description Document. When given a directory, it will look for `apiary.apib` and `swagger.yaml` file
   [--json], [--no-json]       # Specify that Swagger API Description Document is in json format. Document will be converted to yaml before processing
   [--api-host=HOST]           # Specify apiary host
   [--push], [--no-push]       # Push API Description to the GitHub when API Project is associated with GitHub repository in Apiary
@@ -122,6 +123,24 @@ Options:
 Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io)
 ```
 
+#### styleguide
+
+```
+$ apiary help styleguide
+Usage:
+  apiary styleguide
+
+Options:
+  [--fetch], [--no-fetch]              # Fetch styleguide rules and functions from apiary.io
+  [--add=ADD]                          # Path to API Description Document. When given a directory, it will look for `apiary.apib` and `swagger.yaml` file
+  [--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
+
+Check API Description Document against styleguide rules (Apiary.io pro plan is required - https://apiary.io/plans )
+
+```
+
 #### version
 
 ```

data/features/fetch.feature

@@ -4,5 +4,5 @@ Feature: Fetch apiary.apib from API_NAME.apiary.io
   @needs_apiary_api_key
   Scenario: Fetch apiary.apib from API_NAME.apiary.io
 
-    When I run `apiary fetch --api-name testingapiaryclitestingapiarycli`
+    When I run `apiary fetch --api-name=apiaryclitestingdonottouch`
     Then the output should contain the content of file "apiary.apib"

data/features/step_definitions/file_content_step.rb

@@ -1,6 +1,6 @@
 Then(/^the output should contain the content of file "(.*)"$/) do |filename|
   expected = nil
-  cd('../../spec/fixtures') do
+  cd('../../features/support') do
     expected = File.read(filename)
   end
 

data/features/styleguide.feature

@@ -0,0 +1,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
+
+    When I run `apiary  styleguide --functions=../../features/support --rules=../../features/support --add=../../features/support --full_report`
+    Then the output should match /(\"validatorError\": false)/
+    And the exit status should be 0
+
+  # This is integration testing you have to set APIARY_API_KEY
+  @needs_apiary_api_key
+  Scenario: Styleguide fetch
+
+    When I run `apiary  styleguide --fetch`
+    Then the output should match /(has beed succesfully created)/
+    And  the exit status should be 0
+
+

data/features/support/apiary.apib

@@ -0,0 +1,4 @@
+FORMAT: 1A
+
+# test
+test

data/features/support/env.rb

@@ -7,7 +7,7 @@ end
 Around('@needs_apiary_api_key') do |_scenario, block|
   # DEBUG puts "Scenario #{scenario.name} wants APIARY_API_KEY."
   original_value = ENV.delete('APIARY_API_KEY')
-  ENV['APIARY_API_KEY'] = '340bda135034529ab2abf341295c3aa2' # XXX
+  ENV['APIARY_API_KEY'] = '5a96f04006effca6cc03f1616ed916eb'
   block.call
   ENV['APIARY_API_KEY'] = original_value
 end

data/features/support/functions.js

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

data/features/support/rules.json

@@ -0,0 +1,8 @@
+[
+  {
+    "ruleName": "validateApiName",
+    "functionName": "validateApiName",
+    "target": "API_Name",
+    "intent": "validateApiName"
+  }
+]

data/lib/apiary/cli.rb

@@ -3,6 +3,7 @@ require 'thor'
 require 'apiary/command/fetch'
 require 'apiary/command/preview'
 require 'apiary/command/publish'
+require 'apiary/command/styleguide'
 
 module Apiary
   class CLI < Thor
@@ -19,7 +20,7 @@ module Apiary
     desc 'preview', 'Show API documentation in browser or write it to file'
     method_option :browser, type: :string, desc: 'Show API documentation in specified browser (full command is needed - e.g. `--browser=\'open -a safari\'` in case of osx)'
     method_option :output, type: :string, banner: 'FILE', desc: 'Write generated HTML into specified file'
-    method_option :path, type: :string, desc: 'Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file'
+    method_option :path, type: :string, desc: 'Specify path to API Description Document. When given a directory, it will look for `apiary.apib` and `swagger.yaml` file'
     method_option :json, type: :boolean, desc: 'Specify that Swagger API Description Document is in json format. Document will be converted to yaml before processing'
     method_option :api_host, type: :string, banner: 'HOST', desc: 'Specify apiary host'
     method_option :server, type: :boolean, desc: 'Start standalone web server on port 8080'
@@ -34,7 +35,7 @@ module Apiary
 
     desc 'publish', 'Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io)'
     method_option :message, type: :string, banner: 'COMMIT_MESSAGE', desc: 'Publish with custom commit message'
-    method_option :path, type: :string, desc: 'Specify path to API Description Document. When given a directory, it will look for apiary.apib or swagger.yaml file'
+    method_option :path, type: :string, desc: 'Specify path to API Description Document. When given a directory, it will look for `apiary.apib` and `swagger.yaml` file'
     method_option :json, type: :boolean, desc: 'Specify that Swagger API Description Document is in json format. Document will be converted to yaml before processing'
     method_option :api_host, type: :string, banner: 'HOST', desc: 'Specify apiary host'
     method_option :push, type: :boolean, default: true, desc: 'Push API Description to the GitHub when API Project is associated with GitHub repository in Apiary'
@@ -45,6 +46,17 @@ module Apiary
       cmd.execute
     end
 
+    desc 'styleguide', 'Check API Description Document against styleguide rules (Apiary.io pro plan is required - https://apiary.io/plans )'
+    method_option :fetch, type: :boolean, desc: 'Fetch styleguide rules and functions from apiary.io'
+    method_option :add, type: :string, desc: 'Path to API Description Document. When given a directory, it will look for `apiary.apib` and `swagger.yaml` file'
+    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'
+    def styleguide
+      cmd = Apiary::Command::Styleguide.new options
+      cmd.execute
+    end
+
     desc 'version', 'Show version'
     method_option aliases: '-v'
 

data/lib/apiary/command/styleguide.rb

@@ -0,0 +1,192 @@
+# encoding: utf-8
+require 'rest-client'
+require 'rack'
+require 'ostruct'
+require 'json'
+
+require 'apiary/agent'
+require 'apiary/helpers'
+require 'apiary/exceptions'
+
+module Apiary::Command
+  class Styleguide
+    include Apiary::Helpers
+
+    attr_reader :options
+
+    def initialize(opts)
+      @options = OpenStruct.new(opts)
+      @options.fetch        ||= false
+      @options.add          ||= '.'
+      @options.functions    ||= '.'
+      @options.rules        ||= '.'
+      @options.api_key      ||= ENV['APIARY_API_KEY']
+      @options.proxy        ||= ENV['http_proxy']
+      @options.api_host     ||= 'api.apiary.io'
+      @options.vk_url       ||= 'https://voight-kampff-aws.apiary-services.com/production/validate'
+      @options.headers      ||= {
+        content_type: :json,
+        accept: :json,
+        user_agent: Apiary.user_agent
+      }
+      @options.failedOnly = !@options.full_report
+    end
+
+    def execute
+      check_api_key
+      if @options.fetch
+        fetch
+      else
+        validate
+      end
+    end
+
+    def fetch
+      begin
+        assertions = fetch_from_apiary
+        assertions = JSON.parse(assertions)
+      rescue => e
+        abort "Error: Can not fetch rules and functions: #{e}"
+      end
+
+      begin
+        File.write("./#{default_functions_file_name}", assertions['functions']['functions'])
+        File.write("./#{default_rules_file_name}", JSON.pretty_generate(assertions['rules']['rules']))
+        puts "`./#{default_functions_file_name}` and `./#{default_rules_file_name}` has beed succesfully created"
+      rescue => e
+        abort "Error: Can not write into the rules/functions file: #{e}"
+      end
+    end
+
+    def validate
+      token = jwt
+
+      begin
+        token = JSON.parse(token)['jwt']
+      rescue JSON::ParserError => e
+        abort "Can not authenticate: #{e}"
+      end
+
+      begin
+        load
+      rescue StandardError => e
+        abort "Error: #{e.message}"
+      end
+
+      data = {
+        functions: @functions,
+        rules: @rules,
+        add: @add,
+        failedOnly: @options.failedOnly
+      }.to_json
+
+      headers = @options.headers.clone
+      headers[:Authorization] = "Bearer #{token}"
+
+      result = call_resource(@options.vk_url, data, headers, :post)
+
+      begin
+        puts JSON.pretty_generate(JSON.parse(result))
+      rescue
+        abort "Error: Can not parse result: #{result}"
+      end
+    end
+
+    def default_rules_file_name
+      'rules.json'
+    end
+
+    def default_functions_file_name
+      'functions.js'
+    end
+
+    def call_apiary(path, data, headers, method)
+      call_resource("https://#{@options.api_host}/#{path}", data, headers, method)
+    end
+
+    def call_resource(url, data, headers, method)
+      RestClient.proxy = @options.proxy
+
+      method = :post unless method
+
+      begin
+        response = RestClient::Request.execute(method: method, url: url, payload: data, headers: headers, verify_ssl: false)
+      rescue RestClient::Exception => e
+        begin
+          err = JSON.parse e.response
+        rescue JSON::ParserError
+          err = {}
+        end
+
+        message = 'Error: Apiary service responded with:'
+
+        if err.key? 'message'
+          abort "#{message} #{e.http_code} #{err['message']}"
+        else
+          abort "#{message} #{e.message}"
+        end
+      end
+
+      response
+    end
+
+    def jwt
+      path = 'styleguide-cli/get-token/'
+      headers = @options.headers.clone
+      headers[:authentication] = "Token #{@options.api_key}"
+      call_apiary(path, {}, headers, :get)
+    end
+
+    def check_api_key
+      unless @options.api_key && @options.api_key != ''
+        abort 'Error: API key must be provided through environment variable APIARY_API_KEY. \Please go to https://login.apiary.io/tokens to obtain it.'
+      end
+    end
+
+    def load
+      @add_path = api_description_source_path(@options.add)
+      @add = api_description_source(@add_path)
+      @functions = get_functions(@options.functions)
+      @rules = get_rules(@options.rules)
+    end
+
+    def fetch_from_apiary
+      path = 'styleguide-cli/get-assertions/'
+      headers = @options.headers.clone
+      headers[:authentication] = "Token #{@options.api_key}"
+      call_apiary(path, {}, headers, :get)
+    end
+
+    def get_rules(path)
+      JSON.parse get_file_content(get_path(path, 'rules'))
+    end
+
+    def get_functions(path)
+      get_file_content(get_path(path, 'functions'))
+    end
+
+    def get_path(path, type)
+      raise "`#{path}` not found" unless File.exist? path
+
+      return path if File.file? path
+
+      file =  case type
+              when 'rules'
+                default_rules_file_name
+              else
+                default_functions_file_name
+              end
+
+      path = File.join(path, file)
+
+      return path if File.file? path
+      raise "`#{path}` not found"
+    end
+
+    def get_file_content(path)
+      source = nil
+      File.open(path, 'r:bom|utf-8') { |file| source = file.read }
+      source
+    end
+  end
+end

data/lib/apiary/exceptions.rb

@@ -0,0 +1,2 @@
+class RulesLoadError < StandardError
+end

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/spec/apiary/command/styleguide_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+
+def test_abort(command, message)
+  expect do
+    begin
+      command.execute
+    rescue SystemExit
+    end
+  end.to output(/#{message}/).to_stderr
+end
+
+describe Apiary::Command::Styleguide do
+  describe 'fetch' do
+    it 'call command without APIARY_API_KEY set' do
+      opts = {
+        fetch: true,
+        api_key: ''
+      }
+      command = Apiary::Command::Styleguide.new(opts)
+      test_abort(command, 'Error: API key must be provided through environment variable APIARY_API_KEY.')
+    end
+
+    it 'call command with incorrect APIARY_API_KEY' do
+      opts = {
+        fetch: true,
+        api_key: 'xxx'
+      }
+
+      command = Apiary::Command::Styleguide.new(opts)
+      stub_request(:get, "https://#{command.options.api_host}/styleguide-cli/get-assertions/").to_return(status: [403, 'This resource requires authenticated API call.'])
+
+      test_abort(command, 'Error: Apiary service responded with: 403')
+    end
+
+    it 'call command with correct APIARY_API_KEY' do
+      opts = {
+        fetch: true,
+        api_key: 'xxx'
+      }
+
+      command = Apiary::Command::Styleguide.new(opts)
+
+      body = '{"rules":{"_id":"598af267b999bef906c10ef8","organisation":"5577dbc613036160198734cf","createdAt":"2017-08-22T12:57:05.123Z","rules":[{"intent":"validateApiName","target":"API_Name","functionName":"validateApiName","ruleName":"validateApiName"}]},"functions":{"_id":"598af267b999bef906c10ef9","organisation":"5577dbc613036160198734cf","language":"JavaScript","functions":"/*\r\n @targets: API_Name\r\n */\r\n\r\nfunction validateApiName(apiName) {\r\n    return true;\r\n};\r\n"}}'
+      stub_request(:get, "https://#{command.options.api_host}/styleguide-cli/get-assertions/").to_return(status: 200, body: body)
+
+      expect do
+        begin
+          command.execute
+        rescue SystemExit
+        end
+      end.to output("`./functions.js` and `./rules.json` has beed succesfully created\n").to_stdout
+
+      assertions = JSON.parse(body)
+
+      functions = nil
+      File.open('./functions.js', 'r:bom|utf-8') { |file| functions = file.read }
+      rules = nil
+      File.open('./rules.json', 'r:bom|utf-8') { |file| rules = file.read }
+
+      expect(assertions['functions']['functions']).to eq(functions)
+      expect(JSON.pretty_generate(assertions['rules']['rules'])).to eq(rules)
+    end
+  end
+
+  describe 'validate' do
+    it 'call command without APIARY_API_KEY set' do
+      opts = {
+        api_key: ''
+      }
+      command = Apiary::Command::Styleguide.new(opts)
+      expect do
+        command.execute
+      end.to raise_error(SystemExit)
+
+      test_abort(command, 'Error: API key must be provided through environment variable APIARY_API_KEY')
+    end
+
+    it 'call command with incorrect APIARY_API_KEY' do
+      opts = {
+        api_key: 'xxx'
+      }
+
+      command = Apiary::Command::Styleguide.new(opts)
+      stub_request(:get, "https://#{command.options.api_host}/styleguide-cli/get-token/").to_return(status: 403)
+
+      test_abort(command, 'Error: Apiary service responded with: 403')
+    end
+
+    it 'call command with incorrect ADD path' do
+      opts = {
+        api_key: 'xxx',
+        functions: 'features/support',
+        rules: 'features/support',
+        add: 'features/supportXXX'
+      }
+
+      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"}')
+
+      test_abort(command, 'Invalid path features/supportXXX')
+    end
+
+    it 'call command with incorrect functions path' do
+      opts = {
+        api_key: 'xxx',
+        functions: 'features/supportXXY',
+        rules: 'features/support',
+        add: 'features/support'
+      }
+
+      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"}')
+
+      test_abort(command, 'supportXXY` not found')
+    end
+
+    it 'call command with incorrect rules path' do
+      opts = {
+        api_key: 'xxx',
+        functions: 'features/support',
+        rules: 'features/supportsupportXXZ',
+        add: 'features/support'
+      }
+
+      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"}')
+
+      test_abort(command, 'supportXXZ` not found')
+    end
+
+    it 'call command with correct paths' do
+      opts = {
+        api_key: 'xxx',
+        functions: 'features/support',
+        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"}')
+      stub_request(:post, command.options.vk_url).to_return(status: 200, body: '[]')
+
+      expect do
+        begin
+          command.execute
+        rescue SystemExit
+        end
+      end.to output("[\n\n]\n").to_stdout
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiaryio
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Apiary Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2017-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -231,7 +231,11 @@ files:
 - features/preview.feature
 - features/publish.feature
 - features/step_definitions/file_content_step.rb
+- features/styleguide.feature
+- features/support/apiary.apib
 - features/support/env.rb
+- features/support/functions.js
+- features/support/rules.json
 - features/version.feature
 - lib/apiary.rb
 - lib/apiary/agent.rb
@@ -239,6 +243,8 @@ files:
 - lib/apiary/command/fetch.rb
 - lib/apiary/command/preview.rb
 - lib/apiary/command/publish.rb
+- lib/apiary/command/styleguide.rb
+- lib/apiary/exceptions.rb
 - lib/apiary/file_templates/preview.erb
 - lib/apiary/helpers.rb
 - lib/apiary/helpers/javascript_helper.rb
@@ -247,6 +253,7 @@ files:
 - spec/apiary/command/fetch_spec.rb
 - spec/apiary/command/preview_spec.rb
 - spec/apiary/command/publish_spec.rb
+- spec/apiary/command/styleguide_spec.rb
 - spec/apiary/helpers_spec.rb
 - spec/fixtures/api_blueprint_and_swagger/apiary.apib
 - spec/fixtures/api_blueprint_and_swagger/swagger.json
@@ -290,12 +297,17 @@ test_files:
 - features/preview.feature
 - features/publish.feature
 - features/step_definitions/file_content_step.rb
+- features/styleguide.feature
+- features/support/apiary.apib
 - features/support/env.rb
+- features/support/functions.js
+- features/support/rules.json
 - features/version.feature
 - spec/apiary/cli_spec.rb
 - spec/apiary/command/fetch_spec.rb
 - spec/apiary/command/preview_spec.rb
 - spec/apiary/command/publish_spec.rb
+- spec/apiary/command/styleguide_spec.rb
 - spec/apiary/helpers_spec.rb
 - spec/fixtures/api_blueprint_and_swagger/apiary.apib
 - spec/fixtures/api_blueprint_and_swagger/swagger.json