apiaryio 0.15.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d82d5213c6cf1b9ec2f14c30c6668d0477de794338df8387087805bbe1fa966
-  data.tar.gz: f3302452ee5dea3f53b70cfba39d94aab3eb99ae2c554c7e822ec7f6351e6e8c
+  metadata.gz: a3f826ea9db9773c47de22a91b8627ab015c4aaab3356453e15d9e7c9a7a6c2f
+  data.tar.gz: d325cd4be26355139c01e2e1f8cb62ff49a148e7740042ad5cfb8933e9aec3ed
 SHA512:
-  metadata.gz: ad32626008932bf5e4b756d226e2cb393960de6972a41b320fa587374d54859091886732a0dfddb5d1b55a82c50b5c139d8f54b53a124c17fc298aaf888afc19
-  data.tar.gz: 995a9747c582fba4207bbd18b48319d9fc12a25973fc55b39daadbc04be364b1f893b40e496013ed4d4ab4328e870dc5924b7cb9f4b85a1d643956207c9f0c37
+  metadata.gz: 908a8d90749ab666fb1427ab8f2950badb74ac91dde5c54faf7a6c2b3372015f12c9066df6a622590090d59af6fdea9a96749e4b68b862ae307c1e8ebc23920a
+  data.tar.gz: 5cb3e36dfbd29a7cd81056ccf9273b665dc2a780a18404b226e70b7a8e8697aad359b638bd4f3dfacdf06fe521cab4161edd931bd1539ab07f06593288538242

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

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

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,9 +212,12 @@ 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.
+
 
 ## License
 

data/apiary.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'launchy', '~> 2.4'
   gem.add_runtime_dependency 'listen', '~> 3.0'
 
-  gem.add_development_dependency 'bundler', '~> 2.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'

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.0'.freeze
+  VERSION = '0.16.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiaryio
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.1
 platform: ruby
 authors:
 - Apiary Ltd.
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -98,16 +98,16 @@ dependencies:
   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
@@ -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
@@ -260,7 +262,7 @@ homepage: https://apiary.io
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -275,8 +277,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Apiary.io CLI
 test_files: