rswag_schema_export 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56dc1566ef40b4689c9546a3f5daa0b62c5aa066f56af01de96e563fb8b796b5
-  data.tar.gz: 1e3c00c1812d7f1748525263f24573846064394ce34f0e9a989893cc0d7f9323
+  metadata.gz: 4ece302cfc94feecbe4036c53b240af0e2fc95d53969f8224a3fd411510f6b6b
+  data.tar.gz: 6d7d15132174d2108961ee218f92bcb53d1f419b874572e186430921cac4d939
 SHA512:
-  metadata.gz: 3743c24a0de165ae785740537ec41ad3deb3aa76f00b78b354258d907d7f42e049e9fa959b0db6b597765c4f584becb393e6972367b37b3eb3cc9b4d9e7e3f93
-  data.tar.gz: '09ef3131b1f7ae054a69eda7b0bd57787e9c3bbfc5481cce831fc3edf2f75a0a0ab9c3749c927c77e3de0261a1fff86b1cf40a6fda2c8a6e96c595b2ae6a33a1'
+  metadata.gz: d8219a08a4582429b6a1cdbebbc1e02a47268bebe098485b82fea4c82c1e711d480c68002868a896d48a4dec02f7c9574fd7fe9151346abd2a7fb8af6565ba86
+  data.tar.gz: 8ea02fe62ff0def8ca211c22107ce82b3bdd34f90984b637715a392313d23d2d722d59df84055a5c93b5c76d03e71360cc8e9e7b93ceb57549f39ccd55b576b8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rswag_schema_export (0.1.1)
+    rswag_schema_export (0.2.1)
       aws-sdk-s3 (~> 1)
       azure-storage-blob (~> 1.1)
 

data/README.md

@@ -1,9 +1,9 @@
-# [Beta] Rswag::Schema::Export
+# Rswag::Schema::Export
 
 [![CircleCI](https://circleci.com/gh/MLSDev/rswag_schema_export.svg?style=svg)](https://circleci.com/gh/MLSDev/rswag_schema_export)
 
 
-Export your schema.json file to AWS s3 bucket and import back after deploy. 
+Export your schema.json file to **AWS S3**/**Azure Blob** storage and import back after deploy. 
 
 ## Installation
 
@@ -22,40 +22,73 @@ Or install it yourself as:
     $ gem install rswag_schema_export
     $ rails g rswag_schema_export:install
 
-## Usage
-
-Gem contains two rake tasks:
-
-    $ rake rswag:schema_export
-    $ rake rswag:schema_import
+## Set up
+```diff
+# config/initializers/rswag_schema_export.rb
+RswagSchemaExport.configure do |c|
++  c.schemas = ['swagger/client/swagger.json', 'swagger/backoffice/swagger.json']
++  c.client = :aws
+end
+```
+## Lifecycle
+```
+swaggerize -> export to cloud storage -> deploy -> import from cloud storage
+```
 
-## Lifecicle
-```bash
-# Pipeline
+## Export example with CI
+```yaml
+.gitlab-ci.yml
 stages:
-  staging:
-    - rspec spec
-    - rails rswag:specs:swaggerize
-    - STAGE=staging rails rswag:schema_export
-    - cap staging deploy
-    - STAGE=staging rails rswag:schema_import
+  - test
+  - export_api_doc
+  - deploy
+test:
+  tags:
+  - shell-ruby
+  before_script:
+    - RAILS_ENV=test bundle exec rails db:create db:migrate
+  script:
+    - rspec
+  artifacts:
+    paths:
+      - coverage/
+  after_script:
+    - RAILS_ENV=test bundle exec rails db:drop
+rswag_schema_export:
+  dependencies: []
+  stage: export_api_doc
+  before_script:
+    - RAILS_ENV=test bundle exec rails db:create
+  tags:
+  - shell-ruby
+  script:
+  - rails db:schema:load rswag:specs:swaggerize RAILS_ENV=test
+  - STAGE=develop rails rswag:schema_export
+develop:
+  dependencies: []
+  stage: deploy
+  tags:
+  - shell-ruby
+  script:
+  - bundle exec cap develop deploy
+  only:
+  - develop
 ```
 
-## Capistrano
+
+## Import example with Capistrano
+
+```diff
+# Capfile
+require 'rswag_schema_export/capistrano'
+```
 
 ```diff
 # config/deploy.rb
-+ folders = %w[swagger]
-namespace :deploy do
-  after :restart, :clear_cache do
-    on roles(:web), in: :groups, limit: 3, wait: 10 do
-    
-    end
-  end
-+  after :finishing, 'rswag:schema_import'
-end
++ append :linked_dirs, "swagger"
 ````
 
+
 ## Configuration
 
 Set up ENVIRONMENT VARIABLES on your CI
@@ -82,16 +115,6 @@ APP_NAME='' # Default: app
 
 ![image](https://user-images.githubusercontent.com/2664467/64493266-bc699f00-d286-11e9-8827-e99d0eada9ce.png)
 
-## rswag_schema_export
-```diff
-# config/initializers/rswag_schema_export.rb
-RswagSchemaExport.configure do |c|
-+  c.schemas = ['swagger/client/swagger.json', 'swagger/backoffice/swagger.json']
-+  c.client = :aws
-end
-
-```
-
 ## rswag-api
 ```diff
 # config/initializers/rswag_api.rb

data/lib/rswag_schema_export/capistrano.rb

@@ -1 +1 @@
-load File.expand_path("tasks/rswag.rake", __dir__)
+load File.expand_path("../tasks/rswag.rake", __FILE__)

data/lib/rswag_schema_export/client.rb

@@ -52,7 +52,7 @@ module RswagSchemaExport
     def copy_latest_version_to_root(last_schema_key, schema_id)
       if aws_client?
         bucket.object(last_schema_key)
-              .copy_to("#{ENV['RSWAG_BUCKET']}/schemas/#{app_name}/#{stage}_#{schema_id}/schema.json")
+              .copy_to("#{ENV['RSWAG_AWS_BUCKET']}/schemas/#{app_name}/#{stage}_#{schema_id}/schema.json")
       else
         client.copy_blob(ENV["RSWAG_AZURE_CONTAINER"], "schemas/#{app_name}/#{stage}_#{schema_id}/schema.json",
                          ENV["RSWAG_AZURE_CONTAINER"], last_schema_key)
@@ -60,6 +60,7 @@ module RswagSchemaExport
     end
 
     def download_file(schema_id, path)
+      FileUtils.mkdir_p(path.split('/')[0...-1].join('/'))
       if aws_client?
         bucket.object("schemas/#{app_name}/#{stage}_#{schema_id}/schema.json").download_file(path)
       else

data/lib/rswag_schema_export/tasks/rswag.rake

@@ -1,15 +1,14 @@
-require "rswag_schema_export/schema_import"
-
 namespace :rswag do
-  desc "Import latest schema.json to app"
+  desc 'schema_import'
   task :schema_import do
-    on roles(:all) do
-      stage = ENV["STAGE"] || fetch(:stage, "develop")
-      RswagSchemaExport::Import.new.run(stage) do
-        RswagSchemaExport.config.shemas.map do |schema|
-          upload!(schema, "#{current_path}/#{schema}")
+    on roles(fetch(:rswag_schema_export_roles, :app)) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :rake, 'rswag:schema_import'
         end
       end
     end
   end
 end
+
+after  'deploy:finishing', 'rswag:schema_import'

data/lib/rswag_schema_export/version.rb

@@ -1,3 +1,3 @@
 module RswagSchemaExport
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

data/lib/tasks/rswag_tasks.rake

@@ -1,11 +1,11 @@
 namespace :rswag do
-  desc "Export schema.json to cloud storage"
-  task schema_export: :environment do
-    RswagSchemaExport::Export.new.run
-  end
-
-  desc "Import latest schema.json to app"
-  task schema_import: :environment do
-    RswagSchemaExport::Import.new.run
-  end
-end
+    desc "Export schema.json to cloud storage"
+    task schema_export: :environment do
+      RswagSchemaExport::Export.new.run
+    end
+  
+    desc "Import latest schema.json to app"
+    task schema_import: :environment do
+      RswagSchemaExport::Import.new.run
+    end
+  end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rswag_schema_export
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ruslan Tolstov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3