apiaryio 0.15.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9cf83dd0d7e7a8dbb3904365643c0d97a12a7dbe6da66164fed071590f02554
-  data.tar.gz: f3f37cedf72a7771244cd1ba576a2512279eda88b139573389b7e0f438320d71
+  metadata.gz: 11fd537095ac5adda62367672def3244dce2d84c72c6d7b03b7682c9d28ddc2f
+  data.tar.gz: e5baae75069ef7ea100d6a33dcd9b6de804cb743a74f311bd6b2680af52e4f43
 SHA512:
-  metadata.gz: 889dd89e77bf9a7623f3c6171e4862216e69ae273f5e96a6e76ee2c033c4da1ff9b5a626974bd7f7ca664d16c582e6f68cd6cba298dc8f71d362e67d7ca49f04
-  data.tar.gz: d8b59b905ba7e7d577667d26a091af399da68aca3dae17bb346ba2c242fce409326a4caf0b67e828e24bf324b3463b61c876835cf3a953594e2e5326b0513ef0
+  metadata.gz: ec91c6a3188c45d14cc7359947f3e7a677198f1020285247f770d2bee1015f5d08469ef6d4e2478a98800d13f1bfe3307b9951a178eab6ec134884ab21a2678b
+  data.tar.gz: b6f106d656d4a5551c2a710c7ec40540ab80b6e16c55d165a9aec57991b3f89b5c7682ce0e1a0679277a3c62effda744f8412ee5214b1fc967e59050cbc0cadb

data/.editorconfig

@@ -0,0 +1,15 @@
+; EditorConfig file: http://EditorConfig.org
+; Install the "EditorConfig" plugin into your editor to use
+
+root = true
+
+[*]
+charset = utf-8
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+[README.md]
+trim_trailing_whitespace = false
+insert_final_newline = false

data/.github/workflows/release.yml

@@ -8,8 +8,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - name: Login to docker
-        uses: azure/docker-login@v1
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
@@ -22,3 +22,13 @@ jobs:
           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/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.16.1
+
+* add option for exclude team API projects
+## 0.16.0
+
+* add archive command to get all your API projects
 ## 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)

data/README.md

@@ -57,6 +57,7 @@ export APIARY_API_KEY=<your_token>
 ```
 $ apiary help
 Commands:
+  apiary archive                      # Archive All Your API Description Documents from apiary.io to local files named following [api-project-subdomain.apib] pattern.
   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
@@ -68,6 +69,19 @@ Commands:
 
 ### Details
 
+#### archive
+
+```
+$ apiary help archive
+Usage:
+  apiary archive
+
+Options:
+  [--exclude-team-projects], [--no-exclude-team-projects]  # Skip team projects
+
+Archive All Your API Description Documents from apiary.io to local files named following [api-project-subdomain.apib] pattern.
+```
+
 #### fetch
 
 ```
@@ -198,7 +212,8 @@ Only gem owners `gem owner apiaryio` can publish new gem into [RubyGems](https:/
 4. make gem release:
 
     ```sh
-    $ rake release
+    $ git tag $VERSION
+    $ git push --tags    
     ```
 
   - if release is stuck you need use `$ rake release --trace` to get OTP prompt.

data/apiary.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'rest-client', '~> 2.0'
   gem.add_runtime_dependency 'rack', '>= 2.2.3'
-  gem.add_runtime_dependency 'thor', '~> 0.20.3'
+  gem.add_runtime_dependency 'thor', '~> 1.1.0'
   gem.add_runtime_dependency 'json', '>= 2.3.0'
   gem.add_runtime_dependency 'launchy', '~> 2.4'
   gem.add_runtime_dependency 'listen', '~> 3.0'

data/lib/apiary/cli.rb

@@ -2,12 +2,23 @@
 
 require 'thor'
 require 'apiary/command/fetch'
+require 'apiary/command/archive'
 require 'apiary/command/preview'
 require 'apiary/command/publish'
 require 'apiary/command/styleguide'
 
 module Apiary
   class CLI < Thor
+
+    desc 'archive', 'Archive All Your API Description Documents from apiary.io to local files named following [api-project-subdomain.apib] pattern.'
+    method_option :api_host, type: :string, banner: 'HOST', desc: 'Specify apiary host', hide: true
+    method_option :exclude_team_projects, type: :boolean, default: false, desc: 'Skip team projects'
+
+    def archive
+      cmd = Apiary::Command::Archive.new options
+      cmd.execute
+    end
+
     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

data/lib/apiary/command/archive.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'rest-client'
+require 'json'
+
+require 'apiary/agent'
+
+module Apiary::Command
+  # Retrieve blueprint from apiary
+  class Archive
+    def initialize(opts)
+      @options = OpenStruct.new(opts)
+      @options.api_host     ||= 'api.apiary.io'
+      @options.api_key      ||= ENV['APIARY_API_KEY']
+      @options.proxy        ||= ENV['http_proxy']
+      @options.headers      ||= {
+        accept: 'application/json',
+        content_type: 'application/json',
+        authorization: "Bearer #{@options.api_key}",
+        user_agent: Apiary.user_agent
+      }
+    end
+
+    def execute
+      response = apilist_from_apiary
+
+      return unless response.instance_of? String
+
+      puts response
+    end
+
+    def apilist_from_apiary
+      unless @options.api_key
+        abort 'API key must be provided through environment variable APIARY_API_KEY. Please go to https://login.apiary.io/tokens to obtain it.'
+      end
+
+      response = query_apiary
+
+      response['apis'].each do |api|
+        if api['apiIsTeam'] == true && @options.exclude_team_projects == true
+          puts "#{api['apiSubdomain']}... Team API skipping"
+          next
+        end
+        puts api['apiSubdomain']
+
+        @options = OpenStruct.new
+        @options.api_host     ||= 'api.apiary.io'
+        @options.api_name     ||= api['apiSubdomain']
+        @options.api_key      ||= ENV['APIARY_API_KEY']
+        @options.proxy        ||= ENV['http_proxy']
+        @options.output       ||= api['apiSubdomain'] + '.apib'
+        @options.headers      ||= {
+          accept: 'text/html',
+          content_type: 'text/plain',
+          authentication: "Token #{@options.api_key}",
+          user_agent: Apiary.user_agent
+        }
+        cmd = Apiary::Command::Fetch.new(@options)
+        cmd.execute
+      end
+    end
+
+    def query_apiary
+      url = "https://#{@options.api_host}/me/apis"
+      RestClient.proxy = @options.proxy
+
+      begin
+        response = RestClient.get url, @options.headers
+      rescue RestClient::Exception => e
+        abort "Apiary service responded with an error: #{e.message}"
+      end
+      JSON.parse response.body
+    end
+
+  end
+end

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = '0.15.1'.freeze
+  VERSION = '0.17.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiaryio
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Apiary Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -201,6 +201,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".editorconfig"
 - ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -228,6 +229,7 @@ files:
 - lib/apiary.rb
 - lib/apiary/agent.rb
 - lib/apiary/cli.rb
+- lib/apiary/command/archive.rb
 - lib/apiary/command/fetch.rb
 - lib/apiary/command/preview.rb
 - lib/apiary/command/publish.rb
@@ -275,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Apiary.io CLI