apiaryio 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecb88a84bcbd64fc778b76064828f9ee365b0e7037a5d354807821999aba8301
-  data.tar.gz: a4dd2fa6c417a193a6966f6fe9c25cb3c8af44312243b537947b0d97b7a3a619
+  metadata.gz: 9d82d5213c6cf1b9ec2f14c30c6668d0477de794338df8387087805bbe1fa966
+  data.tar.gz: f3302452ee5dea3f53b70cfba39d94aab3eb99ae2c554c7e822ec7f6351e6e8c
 SHA512:
-  metadata.gz: 4f4fc4b653ca1ab334fd6713ecb1cb4c5cd5da2afef220d1d753419efe2782012146ec4ceac3df8251fefc10af88a323e9e6fe9c9ecb7dd1c86e57a95840898b
-  data.tar.gz: 94d0ea2e1d38dfeb4b0b46e348a2912149b8071613f94f0273e95a183d5f1ca65b521fee013556e23e111f0d5ca18fd28aed460e6a0e6ff5904524b247316676
+  metadata.gz: ad32626008932bf5e4b756d226e2cb393960de6972a41b320fa587374d54859091886732a0dfddb5d1b55a82c50b5c139d8f54b53a124c17fc298aaf888afc19
+  data.tar.gz: 995a9747c582fba4207bbd18b48319d9fc12a25973fc55b39daadbc04be364b1f893b40e496013ed4d4ab4328e870dc5924b7cb9f4b85a1d643956207c9f0c37

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

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

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

@@ -1,6 +1,10 @@
-# Chaneglog
+# Changelog
 
-## Unreleased
+## 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
 

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,14 @@ 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
+    ```
 
 
 ## 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,9 +24,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_runtime_dependency 'rest-client', '~> 2.0'
-  gem.add_runtime_dependency 'rack', '>= 2.1.4'
+  gem.add_runtime_dependency 'rack', '>= 2.2.3'
   gem.add_runtime_dependency 'thor', '~> 0.20.3'
-  gem.add_runtime_dependency 'json', '~> 2.1'
+  gem.add_runtime_dependency 'json', '>= 2.3.0'
   gem.add_runtime_dependency 'launchy', '~> 2.4'
   gem.add_runtime_dependency 'listen', '~> 3.0'
 

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.14.1'.freeze
+  VERSION = '0.15.0'.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.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Apiary Ltd.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -256,7 +256,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/aruba.rb
 - spec/support/webmock.rb
-homepage: http://apiary.io
+homepage: https://apiary.io
 licenses:
 - MIT
 metadata: {}