apiaryio 0.13.0 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ca172a477a7f9278a2574bed856538adf54ddcfb
-  data.tar.gz: 4cc86962d31b818fa3ea5b3b8f0ff72529e401b9
+SHA256:
+  metadata.gz: a2cbc41bcb380395b638267fe70ca1e7edae887ef7ff2476a4748ace00f670b3
+  data.tar.gz: 3b2b4bafaab4e05805814aae78addd36aedaa69d7dc20e83cd41c612bc46fb93
 SHA512:
-  metadata.gz: c76e2481fe726a420d73da8bfa1af4dbf050fdb66a9ee98c74f61a22006390d7b16b943acd06173dc7b09109691dfc7ea5dfd0249c71cb69fc4d2b1cad5df13b
-  data.tar.gz: d5daa7b88e8fba01946620ca24174f6d0c58eab0dfc13d1d4fd0f3671f2b5babf5d34e8b9371c3e0490b52d21c94601537df9da2508a6155f72c35d9d45f7bd3
+  metadata.gz: 681b132cdb458157d71e9c89577a406b5b232af6727dcdcff75151f40be3ddb3403040245e2f42b890bbe30e1c6f291d7cc426f20ccb3e3fe6f3626d5817ac66
+  data.tar.gz: '0620901f63e3b66b45dc33d524ac1e34039d9e660c1f98b7a2253ee34214eeb0392a899f0bc5dc01f9d797219bf85c2b3b237dfaa540ae9838e2f3b7f4a7cf62'

data/.circleci/config.yml

@@ -3,13 +3,15 @@ workflows:
   version: 2
   test:
     jobs:
-      - test-2.3
       - test-2.4
       - test-2.5
+      - test-2.6
+      - test-2.7
+      - test-3.0
 jobs:
-  test-2.3: &test-template
+  test-2.4: &test-template
     docker:
-      - image: circleci/ruby:2.3-browsers
+      - image: circleci/ruby:2.4-browsers
     steps:
       - checkout
       - run:
@@ -32,11 +34,19 @@ jobs:
           name: Run cucumber
           command: |
             bundle exec cucumber
-  test-2.4:
-    <<: *test-template
-    docker:
-      - image: circleci/ruby:2.4-browsers
   test-2.5:
     <<: *test-template
     docker:
       - image: circleci/ruby:2.5-browsers
+  test-2.6:
+    <<: *test-template
+    docker:
+      - image: circleci/ruby:2.6-browsers
+  test-2.7:
+    <<: *test-template
+    docker:
+      - image: circleci/ruby:2.7-browsers
+  test-3.0:
+    <<: *test-template
+    docker:
+      - image: circleci/ruby:3.0-browsers

data/.github/workflows/release.yml

@@ -0,0 +1,34 @@
+name: release
+on:
+  push:
+    tags: [v*]
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      - name: Get the version
+        id: version
+        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\/v/}
+      - name: Docker Build and Release
+        run: |
+          docker build . -t apiaryio/client
+          docker tag apiaryio/client apiaryio/client:${{ steps.version.outputs.VERSION }}
+          docker push apiaryio/client
+          docker push apiaryio/client:${{ steps.version.outputs.VERSION }}
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: test
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+    types: [opened, reopened, synchronize]
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ["windows-latest", "ubuntu-latest"]
+        ruby: ["3.0.x", "2.7.x", "2.6.x", "2.5.x"]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Set up Bundler
+        run: gem install bundler --no-document
+      - name: Install dependencies
+        run: bundle install
+      - name: Run test
+        run: bundle exec rspec spec
+      - name: Run cucumber tests
+        if: matrix.os != 'windows-latest'
+        run: bundle exec cucumber

data/.gitignore

@@ -37,9 +37,11 @@ Gemfile.lock
 
 # testing
 spec/fixtures/test.html
+rules.json
+functions.js
 
 # idea ide
 /.idea
 
 # netbeans IDE
-/nbproject
+/nbproject

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.15.0
+* fix: change domain from docs.<subdomain>.apiary.io to <subdomain>.docs.apiary.io
+* fix(security): [CVE-2020-10663](https://www.ruby-lang.org/en/news/2020/03/19/json-dos-cve-2020-10663/) and [CVE-2020-8184](https://nvd.nist.gov/vuln/detail/CVE-2020-8184)
+## 0.14.1
+* fix: [update rack to 2.1.4](https://github.com/advisories/GHSA-j6w9-fv6q-3q52)
+
+## 0.14.0
+
+### Breaking
+* Remove support for ruby 2.3

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM coopermaa/alpine-ruby:2.2
+FROM ruby:2.7-alpine
 RUN apk add --update build-base && rm /var/cache/apk/*
 RUN gem install apiaryio
 ENTRYPOINT ["apiary"]

data/README.md

@@ -8,12 +8,12 @@ Apiary CLI Client
 ## Description
 
 The Apiary CLI Client gem is a command line tool for developing and previewing
-[API Blueprint](http://apiblueprint.org) documents locally. It can also be
+[API Blueprint](https://apiblueprint.org) documents locally. It can also be
 used for pushing updated documents to and fetching existing documents from
-[Apiary](http://apiary.io).
+[Apiary](https://apiary.io).
 
 
-Please see the `apiary help` command and the [full documentation](http://client.apiary.io) for an in-depth look in how to use this tool.
+Please see the `apiary help` command and the [full documentation](https://client.apiary.io) for an in-depth look in how to use this tool.
 
 For instructions on making your  own changes, see [Hacking Apiary CLI Client](#hacking-apiary-cli-client), below.
 
@@ -45,7 +45,7 @@ docker build -t "apiaryio/client" .
 *Required only for publish and fetch commands.*
 
 
-1. Make sure you are a registered user of [Apiary](http://apiary.io).
+1. Make sure you are a registered user of [Apiary](https://apiary.io).
 2. Retrieve API key (token) on [this page](https://login.apiary.io/tokens).
 3. Export it as an environment variable:
 
@@ -57,10 +57,10 @@ export APIARY_API_KEY=<your_token>
 ```
 $ 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
@@ -192,9 +192,16 @@ Use `bundle install` to install your changes locally, for manual and ad-hock tes
 
 Only gem owners `gem owner apiaryio` can publish new gem into [RubyGems](https://rubygems.org/gems/apiaryio).
 
-```sh
-$ rake release
-```
+1. bump version in `lib/apiary/version.rb`
+2. update `CHANGELOG.md`
+3. prepare Github Release with text in `CHANGELOG`
+4. make gem release:
+
+    ```sh
+    $ rake release
+    ```
+
+  - if release is stuck you need use `$ rake release --trace` to get OTP prompt.
 
 
 ## License

data/apiary.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
 
   gem.description   = 'Apiary.io CLI'
   gem.summary       = 'Apiary.io CLI'
-  gem.homepage      = 'http://apiary.io'
+  gem.homepage      = 'https://apiary.io'
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
@@ -24,14 +24,14 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_runtime_dependency 'rest-client', '~> 2.0'
-  gem.add_runtime_dependency 'rack', '~> 2.0.0'
-  gem.add_runtime_dependency 'thor', '~> 0.19.1'
-  gem.add_runtime_dependency 'json', '~> 1.8'
+  gem.add_runtime_dependency 'rack', '>= 2.2.3'
+  gem.add_runtime_dependency 'thor', '~> 0.20.3'
+  gem.add_runtime_dependency 'json', '>= 2.3.0'
   gem.add_runtime_dependency 'launchy', '~> 2.4'
-  gem.add_runtime_dependency 'listen', '~> 2.0'
+  gem.add_runtime_dependency 'listen', '~> 3.0'
 
-  gem.add_development_dependency 'bundler', '~> 2.0'
-  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'bundler', '>= 2.2.11'
+  gem.add_development_dependency 'rake', '>= 12.3.3'
   gem.add_development_dependency 'rspec', '~> 3.4'
   gem.add_development_dependency 'webmock', '>= 2.2.0'
   gem.add_development_dependency 'aruba', '~> 0.14'

data/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`

data/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

data/lib/apiary/cli.rb

@@ -8,7 +8,7 @@ require 'apiary/command/styleguide'
 
 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 @@ module Apiary
       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'

data/lib/apiary/command/fetch.rb

@@ -32,7 +32,7 @@ module Apiary::Command
 
     def fetch_from_apiary
       unless @options.api_name
-        abort 'Please provide an api-name option (subdomain part from your http://docs.<api-name>.apiary.io/)'
+        abort 'Please provide an api-name option (subdomain part from your https://<api-name>.docs.apiary.io/)'
       end
 
       unless @options.api_key

data/lib/apiary/command/publish.rb

@@ -42,7 +42,7 @@ module Apiary::Command
 
     def publish_on_apiary
       unless @options.api_name
-        abort 'Please provide an api-name option (subdomain part from your http://docs.<api-name>.apiary.io/)'
+        abort 'Please provide an api-name option (subdomain part from your https://<api-name>.docs.apiary.io/)'
       end
 
       unless @options.api_key

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.15.2'.freeze
 end

data/spec/apiary/command/fetch_spec.rb

@@ -4,7 +4,7 @@ describe Apiary::Command::Fetch do
   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.<api-name>.apiary.io/)')
+    expect { command.fetch_from_apiary }.to raise_error('Please provide an api-name option (subdomain part from your https://<api-name>.docs.apiary.io/)')
   end
 
   it 'pass command only with api_name', api_key: true do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiaryio
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.2
 platform: ruby
 authors:
 - Apiary Ltd.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -28,44 +28,44 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.3
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -86,42 +86,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.11
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -201,17 +201,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop_todo.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Dockerfile
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - apiary.gemspec
-- appveyor.yml
 - bin/apiary
 - features/fetch.feature
 - features/preview.feature
@@ -255,11 +256,11 @@ files:
 - spec/spec_helper.rb
 - spec/support/aruba.rb
 - spec/support/webmock.rb
-homepage: http://apiary.io
+homepage: https://apiary.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -274,9 +275,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Apiary.io CLI
 test_files:

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - "ruby-2.3.1"
-  - "ruby-2.4.0"
-  - "ruby-2.5.0"
-  - "jruby-9.1.0.0"
-
-matrix:
-  allow_failures:
-    - rvm: rbx-2
-cache: bundler
-before_install:
-  - gem update --system
-  - gem update bundler
-script:
-  - bundle exec rspec spec
-  - bundle exec cucumber

data/appveyor.yml

@@ -1,32 +0,0 @@
----
-version: "{branch}-{build}"
-
-clone_depth: 10
-
-build: off
-
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - gem install bundler -f
-  - bundle config --local path vendor/bundle
-  - bundle install
-
-before_test:
-  - ruby --version
-  - gem --version
-  - bundler --version
-
-test_script:
-  - bundle exec rspec spec
-
-artifacts:
-  - path: pkg\*.gem
-
-cache:
-  - vendor/bundle
-
-environment:
-  matrix:
-    - ruby_version: 23
-    - ruby_version: 24
-    - ruby_version: 25