diff --git a/.circleci/config.yml b/.circleci/config.yml index d671508..6a11127 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -7,6 +7,7 @@ workflows: - test-2.5 - test-2.6 - test-2.7 + - test-3.0 jobs: test-2.4: &test-template docker: @@ -45,3 +46,7 @@ jobs: <<: *test-template docker: - image: circleci/ruby:2.7-browsers + test-3.0: + <<: *test-template + docker: + - image: circleci/ruby:3.0-browsers diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 142edc3..0ea0229 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -11,7 +11,7 @@ jobs: strategy: matrix: os: ["windows-latest", "ubuntu-latest"] - ruby: ["2.7.x", "2.6.x", "2.5.x", "2.4.x"] + ruby: ["3.0.x", "2.7.x", "2.6.x", "2.5.x"] steps: - uses: actions/checkout@v2 - name: Set up Ruby diff --git a/README.md b/README.md index e87c25b..2a3bfbe 100644 --- a/README.md +++ b/README.md @@ -57,10 +57,10 @@ export APIARY_API_KEY= ``` $ apiary help Commands: - apiary fetch --api-name=API_NAME # Fetch API Description Document from API_NAME.apiary.io + apiary fetch --api-name=API_NAME # Fetch API Description Document from API_NAME.docs.apiary.io 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 publish --api-name=API_NAME # Publish API Description Document on API_NAME.docs.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 @@ -79,7 +79,7 @@ Options: --api-name=API_NAME [--output=FILE] # Write API Description Document into specified file -Fetch API Description Document from API_NAME.apiary.io +Fetch API Description Document from API_NAME.docs.apiary.io ``` #### preview @@ -117,7 +117,7 @@ Options: # Default: true --api-name=API_NAME -Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io) +Publish API Description Document on API_NAME.docs.apiary.io (API Description must exist on apiary.io) ``` #### styleguide diff --git a/features/publish.feature b/features/publish.feature index dbdab69..ee24e1d 100644 --- a/features/publish.feature +++ b/features/publish.feature @@ -1,8 +1,8 @@ -Feature: Publish apiary.apib on docs.API_NAME.apiary.io +Feature: Publish apiary.apib on API_NAME.docs.apiary.io # This is integration testing you have to set APIARY_API_KEY @needs_apiary_api_key - Scenario: Publish apiary.apib on docs.API_NAME.apiary.io + Scenario: Publish apiary.apib on API_NAME.docs.apiary.io # expected to fail When I run `apiary publish --path=apiary.apib --api-name 1111apiaryclienttest` diff --git a/features/styleguide.feature b/features/styleguide.feature index d01db56..3ffec6e 100644 --- a/features/styleguide.feature +++ b/features/styleguide.feature @@ -1,4 +1,4 @@ -Feature: Styleguide apiary.apib on docs.API_NAME.apiary.io +Feature: Styleguide apiary.apib on API_NAME.docs.apiary.io # This is integration testing you have to set APIARY_API_KEY @needs_apiary_api_key diff --git a/lib/apiary/cli.rb b/lib/apiary/cli.rb index 81db577..34fbd16 100644 --- a/lib/apiary/cli.rb +++ b/lib/apiary/cli.rb @@ -8,7 +8,7 @@ module Apiary class CLI < Thor - desc 'fetch', 'Fetch API Description Document from API_NAME.apiary.io' + desc 'fetch', 'Fetch API Description Document from API_NAME.docs.apiary.io' method_option :api_name, type: :string, required: true method_option :api_host, type: :string, banner: 'HOST', desc: 'Specify apiary host', hide: true method_option :output, type: :string, banner: 'FILE', desc: 'Write API Description Document into specified file' @@ -34,7 +34,7 @@ def preview cmd.execute end - desc 'publish', 'Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io)' + desc 'publish', 'Publish API Description Document on API_NAME.docs.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` 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' diff --git a/lib/apiary/command/fetch.rb b/lib/apiary/command/fetch.rb index 38eb17c..f351fdd 100644 --- a/lib/apiary/command/fetch.rb +++ b/lib/apiary/command/fetch.rb @@ -32,7 +32,7 @@ def execute def fetch_from_apiary unless @options.api_name - abort 'Please provide an api-name option (subdomain part from your http://docs..apiary.io/)' + abort 'Please provide an api-name option (subdomain part from your https://.docs.apiary.io/)' end unless @options.api_key diff --git a/lib/apiary/command/publish.rb b/lib/apiary/command/publish.rb index 2198c4d..f0c0d30 100644 --- a/lib/apiary/command/publish.rb +++ b/lib/apiary/command/publish.rb @@ -42,7 +42,7 @@ def execute def publish_on_apiary unless @options.api_name - abort 'Please provide an api-name option (subdomain part from your http://docs..apiary.io/)' + abort 'Please provide an api-name option (subdomain part from your https://.docs.apiary.io/)' end unless @options.api_key diff --git a/spec/apiary/command/fetch_spec.rb b/spec/apiary/command/fetch_spec.rb index 9b866a2..25304b7 100644 --- a/spec/apiary/command/fetch_spec.rb +++ b/spec/apiary/command/fetch_spec.rb @@ -4,7 +4,7 @@ it 'pass command without params' do opts = {} command = Apiary::Command::Fetch.new(opts) - expect { command.fetch_from_apiary }.to raise_error('Please provide an api-name option (subdomain part from your http://docs..apiary.io/)') + expect { command.fetch_from_apiary }.to raise_error('Please provide an api-name option (subdomain part from your https://.docs.apiary.io/)') end it 'pass command only with api_name', api_key: true do