rswag_schema_export 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 663ecc311960cc8848e244d4f71790eb0a9e91da66aa820b9b673761528d4e50
-  data.tar.gz: c693f56751d318e60fd6a8cc26f3b9568c2f35388a0b5e2771ba0eb121f021b4
+  metadata.gz: 56dc1566ef40b4689c9546a3f5daa0b62c5aa066f56af01de96e563fb8b796b5
+  data.tar.gz: 1e3c00c1812d7f1748525263f24573846064394ce34f0e9a989893cc0d7f9323
 SHA512:
-  metadata.gz: b6c679fe76ac810612e968195d01ddd0ac754dc34b807bd49ff93d27cbbdaccd71eb96bcd7ac8d2beaac3c728077cd81675d6c21f3937530f87927a32cfeee87
-  data.tar.gz: db33f882f45ae29bef2cffc23442bfb0179e06dd27c1c3ce9c38180a1e057283ac9eaeec6a8dc5bdc65a81cd6212a03465fe19e471b39fd78d67f66d6fbc40d9
+  metadata.gz: 3743c24a0de165ae785740537ec41ad3deb3aa76f00b78b354258d907d7f42e049e9fa959b0db6b597765c4f584becb393e6972367b37b3eb3cc9b4d9e7e3f93
+  data.tar.gz: '09ef3131b1f7ae054a69eda7b0bd57787e9c3bbfc5481cce831fc3edf2f75a0a0ab9c3749c927c77e3de0261a1fff86b1cf40a6fda2c8a6e96c595b2ae6a33a1'

data/.rubocop.yml

@@ -9,6 +9,9 @@ Metrics/LineLength:
 Style/Documentation:
   Enabled: false
 
+Metrics/MethodLength:
+  Enabled: false
+
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    rswag_schema_export (0.1.0)
+    rswag_schema_export (0.1.1)
       aws-sdk-s3 (~> 1)
+      azure-storage-blob (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -27,21 +28,32 @@ GEM
       tzinfo (~> 1.1)
     ast (2.4.0)
     aws-eventstream (1.0.3)
-    aws-partitions (1.184.0)
-    aws-sdk-core (3.59.0)
+    aws-partitions (1.210.0)
+    aws-sdk-core (3.66.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.23.0)
-      aws-sdk-core (~> 3, >= 3.58.0)
+    aws-sdk-kms (1.24.0)
+      aws-sdk-core (~> 3, >= 3.61.1)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.45.0)
-      aws-sdk-core (~> 3, >= 3.58.0)
+    aws-sdk-s3 (1.48.0)
+      aws-sdk-core (~> 3, >= 3.61.1)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.1.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
+    azure-core (0.1.15)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.10)
+      nokogiri (~> 1.6)
+    azure-storage-blob (1.1.0)
+      azure-core (~> 0.1.13)
+      azure-storage-common (~> 1.0)
+      nokogiri (~> 1.6, >= 1.6.8)
+    azure-storage-common (1.1.0)
+      azure-core (~> 0.1.13)
+      nokogiri (~> 1.6, >= 1.6.8)
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
@@ -49,6 +61,10 @@ GEM
     diff-lcs (1.3)
     docile (1.3.2)
     erubi (1.8.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
@@ -60,7 +76,8 @@ GEM
     method_source (0.9.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
-    nokogiri (1.10.3)
+    multipart-post (2.1.1)
+    nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.3.0)

data/README.md

@@ -20,6 +20,7 @@ And then execute:
 Or install it yourself as:
 
     $ gem install rswag_schema_export
+    $ rails g rswag_schema_export:install
 
 ## Usage
 
@@ -44,7 +45,7 @@ stages:
 
 ```diff
 # config/deploy.rb
-+ folders = %w[tmp/swagger]
++ folders = %w[swagger]
 namespace :deploy do
   after :restart, :clear_cache do
     on roles(:web), in: :groups, limit: 3, wait: 10 do
@@ -60,12 +61,17 @@ end
 Set up ENVIRONMENT VARIABLES on your CI
 
 ```bash
-# Required
-RSWAG_SCHEMA_PATH='' # Example: tmp/swagger/swagger.json
-RSWAG_ACCESS_KEY_ID='' # Example: XXXXXXXXXX
-RSWAG_SECRET_ACCESS_KEY='' # Example: XXXXXXXXXXXXXXXXXXXXX
-RSWAG_REGION='' # Example: us-west-1
-RSWAG_BUCKET='' # Example: bucket-name
+# Required for AWS
+RSWAG_AWS_ACCESS_KEY_ID='' # Example: XXXXXXXXXX
+RSWAG_AWS_SECRET_ACCESS_KEY='' # Example: XXXXXXXXXXXXXXXXXXXXX
+RSWAG_AWS_REGION='' # Example: us-west-1
+RSWAG_AWS_BUCKET='' # Example: bucket-name
+
+# Required for AZURE
+
+RSWAG_AZURE_STORAGE_ACCOUNT_NAME='' # Example: XXXXX
+RSWAG_AZURE_STORAGE_ACCESS_KEY='' # Example: XXXXXXXXXXXXXXXXXXXXX
+RSWAG_AZURE_CONTAINER='' # Example: continter-name
 
 # Optional
 STAGE='' # Default: develop
@@ -74,23 +80,23 @@ APP_NAME='' # Default: app
 
 ## Gitlab Variables
 
-![image](https://user-images.githubusercontent.com/2664467/60773983-c69bdf80-a115-11e9-9f46-57d835ba4561.png)
-
+![image](https://user-images.githubusercontent.com/2664467/64493266-bc699f00-d286-11e9-8827-e99d0eada9ce.png)
 
-## rswag-api
+## rswag_schema_export
 ```diff
-# config/initializers/rswag_api.rb
-Rswag::Api.configure do |c|
-+  c.swagger_root = Rails.root.to_s + '/tmp/swagger'
+# 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-specs
+## rswag-api
 ```diff
-# spec/swagger_helper.rb
-
-RSpec.configure do |config|
-+  config.swagger_root = Rails.root.to_s + '/tmp/swagger'
+# config/initializers/rswag_api.rb
+Rswag::Api.configure do |c|
++  c.swagger_root = Rails.root.to_s + '/swagger'
 end
 ```
 

data/lib/generators/rswag_schema_export/install/install_generator.rb

@@ -0,0 +1,11 @@
+require "rails/generators"
+
+module RswagSchemaExport
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def add_initializer
+      template("rswag_schema_export.rb", "config/initializers/rswag_schema_export.rb")
+    end
+  end
+end

data/lib/generators/rswag_schema_export/install/templates/rswag_schema_export.rb

@@ -0,0 +1,9 @@
+RswagSchemaExport.configure do |c|
+  # Set up your schemas
+  #
+  # c.schemas = ['swagger/client/swagger.json', 'swagger/backoffice/swagger.json']
+  #
+  # Set up your cloud provider - (:aws, :azure) :aws by default
+  #
+  # c.client = :aws
+end

data/lib/rswag_schema_export.rb

@@ -1,7 +1,16 @@
 require "rswag_schema_export/version"
+require "rswag_schema_export/configuration"
+require "rswag_schema_export/client"
 require "rswag_schema_export/railtie" if defined?(Rails)
 require "rswag_schema_export/schema_export"
 require "rswag_schema_export/schema_import"
 
 module RswagSchemaExport
+  def self.configure
+    yield(config)
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
 end

data/lib/rswag_schema_export/client.rb

@@ -0,0 +1,91 @@
+require "azure/storage/blob"
+require "aws-sdk-s3"
+
+module RswagSchemaExport
+  class Client
+    attr_reader :stage, :app_name
+
+    def initialize(stage)
+      @app_name = ENV["APP_NAME"] || "app"
+      @stage = stage || "develop"
+    end
+
+    def client # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity:
+      if aws_client?
+        abort("RSWAG_AWS_ACCESS_KEY_ID is not defined") unless ENV["RSWAG_AWS_ACCESS_KEY_ID"]
+        abort("RSWAG_AWS_SECRET_ACCESS_KEY is not defined") unless ENV["RSWAG_AWS_SECRET_ACCESS_KEY"]
+        abort("RSWAG_AWS_REGION is not defined") unless ENV["RSWAG_AWS_REGION"]
+        abort("RSWAG_AWS_BUCKET is not defined") unless ENV["RSWAG_AWS_BUCKET"]
+
+        @client ||= Aws::S3::Resource.new(access_key_id: ENV["RSWAG_AWS_ACCESS_KEY_ID"],
+                                          secret_access_key: ENV["RSWAG_AWS_SECRET_ACCESS_KEY"],
+                                          region: ENV["RSWAG_AWS_REGION"])
+      else
+        abort("RSWAG_AZURE_STORAGE_ACCOUNT_NAME is not defined") unless ENV["RSWAG_AZURE_STORAGE_ACCOUNT_NAME"]
+        abort("RSWAG_AZURE_STORAGE_ACCESS_KEY is not defined") unless ENV["RSWAG_AZURE_STORAGE_ACCESS_KEY"]
+        abort("RSWAG_AZURE_CONTAINER is not defined") unless ENV["RSWAG_AZURE_CONTAINER"]
+
+        @client = Azure::Storage::Blob::BlobService.create(
+          storage_account_name: ENV["RSWAG_AZURE_STORAGE_ACCOUNT_NAME"],
+          storage_access_key: ENV["RSWAG_AZURE_STORAGE_ACCESS_KEY"]
+        )
+      end
+    end
+
+    def upload_file(key, file)
+      if aws_client?
+        client.bucket(ENV["RSWAG_AWS_BUCKET"]).object(key).upload_file(file)
+      else
+        client.create_block_blob(ENV["RSWAG_AZURE_CONTAINER"], key, ::File.open(file, &:read))
+      end
+    end
+
+    def fetch_versions(schema_id)
+      if aws_client?
+        bucket.objects(prefix: "schemas/#{app_name}/#{stage}_#{schema_id}/versions").collect(&:key)
+      else
+        prefix = "schemas/#{app_name}/#{stage}_#{schema_id}/versions"
+        client.list_blobs(ENV["RSWAG_AZURE_CONTAINER"], prefix: prefix).collect(&:name)
+      end
+    end
+
+    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")
+      else
+        client.copy_blob(ENV["RSWAG_AZURE_CONTAINER"], "schemas/#{app_name}/#{stage}_#{schema_id}/schema.json",
+                         ENV["RSWAG_AZURE_CONTAINER"], last_schema_key)
+      end
+    end
+
+    def download_file(schema_id, path)
+      if aws_client?
+        bucket.object("schemas/#{app_name}/#{stage}_#{schema_id}/schema.json").download_file(path)
+      else
+        _blob, content = client.get_blob(ENV["RSWAG_AZURE_CONTAINER"],
+                                         "schemas/#{app_name}/#{stage}_#{schema_id}/schema.json")
+        ::File.open(path, "wb") { |f| f.write(content) }
+      end
+    end
+
+    def clean(versions)
+      old_versions = versions - versions.sort.last(5)
+      if aws_client?
+        old_versions.each { |key| bucket.object(key).delete }
+      else
+        old_versions.each { |key| client.delete_blob(ENV["RSWAG_AZURE_CONTAINER"], key) }
+      end
+    end
+
+    private
+
+    def bucket
+      @bucket ||= client.bucket(ENV["RSWAG_AWS_BUCKET"]) if aws_client?
+    end
+
+    def aws_client?
+      RswagSchemaExport.config.client&.to_sym == :aws
+    end
+  end
+end

data/lib/rswag_schema_export/configuration.rb

@@ -0,0 +1,9 @@
+module RswagSchemaExport
+  class Configuration
+    attr_accessor :schemas, :client
+
+    def initialize
+      @client = :aws
+    end
+  end
+end

data/lib/rswag_schema_export/schema_export.rb

@@ -1,31 +1,27 @@
 module RswagSchemaExport
   class Export
-    def run
-      abort("RSWAG_SCHEMA_PATH is not defined. Example: tmp/swagger/swagger.json") unless ENV["RSWAG_SCHEMA_PATH"]
-      abort("RSWAG_ACCESS_KEY_ID is not defined") unless ENV["RSWAG_ACCESS_KEY_ID"]
-      abort("RSWAG_SECRET_ACCESS_KEY is not defined") unless ENV["RSWAG_SECRET_ACCESS_KEY"]
-      abort("RSWAG_REGION is not defined") unless ENV["RSWAG_REGION"]
-      abort("RSWAG_BUCKET is not defined") unless ENV["RSWAG_BUCKET"]
+    def run # rubocop:disable Metrics/AbcSize
+      abort("Set up RswagSchemaExport.config.schemas") unless RswagSchemaExport.config.schemas
 
-      stage = ENV["STAGE"] || "develop"
-      app_name = ENV["APP_NAME"] || "app"
+      RswagSchemaExport.config.schemas.map do |schema|
+        next if File.file?(schema)
 
-      unless File.file?(ENV["RSWAG_SCHEMA_PATH"])
-        message = "Not found schema at #{ENV['RSWAG_SCHEMA_PATH']}.
-                 For generate schema run: RAILS_ENV=test rake rswag:specs:swaggerize"
+        message = "Not found schema at #{schema}.
+               For generate schema run: RAILS_ENV=test rake rswag:specs:swaggerize"
         abort(message)
       end
 
       begin
-        s3 = Aws::S3::Resource.new(access_key_id: ENV["RSWAG_ACCESS_KEY_ID"],
-                                   secret_access_key: ENV["RSWAG_SECRET_ACCESS_KEY"],
-                                   region: ENV["RSWAG_REGION"])
+        client = ::RswagSchemaExport::Client.new(ENV["STAGE"])
+        RswagSchemaExport.config.schemas.map do |schema|
+          schema_id = schema.gsub(/[^a-zA-Z0-9\-]/, "_")
+          key = "schemas/#{client.app_name}/#{client.stage}_#{schema_id}/versions/#{Time.now.getutc.iso8601}.json"
+          # Upload latest version to the cloud
+          client.upload_file(key, schema)
 
-        key = "schemas/#{app_name}/#{stage}_schemas/versions/#{Time.now.getutc.iso8601}.json"
-        # Download latest version to app
-        s3.bucket(ENV["RSWAG_BUCKET"]).object(key).upload_file(ENV["RSWAG_SCHEMA_PATH"])
-
-        puts("Schema has been successfully exported. Stage: #{stage} | Key: #{key}")
+          puts("Schema has been successfully exported. Stage: #{client.stage} | Key: #{key}")
+        end
+        puts("Export finished")
       rescue StandardError => e
         abort(e.message)
       end

data/lib/rswag_schema_export/schema_import.rb

@@ -1,39 +1,27 @@
-require "aws-sdk-s3"
-
 module RswagSchemaExport
   class Import
-    def run(stage = "develop")
-      abort("RSWAG_SCHEMA_PATH is not defined. Example: tmp/swagger/swagger.json") unless ENV["RSWAG_SCHEMA_PATH"]
-      abort("RSWAG_ACCESS_KEY_ID is not defined") unless ENV["RSWAG_ACCESS_KEY_ID"]
-      abort("RSWAG_SECRET_ACCESS_KEY is not defined") unless ENV["RSWAG_SECRET_ACCESS_KEY"]
-      abort("RSWAG_REGION is not defined") unless ENV["RSWAG_REGION"]
-      abort("RSWAG_BUCKET is not defined") unless ENV["RSWAG_BUCKET"]
-      app_name = ENV["APP_NAME"] || "app"
+    def run(stage = "develop") # rubocop:disable Metrics/AbcSize:
+      abort("Set up RswagSchemaExport.config.schemas") unless RswagSchemaExport.config.schemas
 
       begin
-        s3 = Aws::S3::Resource.new(access_key_id: ENV["RSWAG_ACCESS_KEY_ID"],
-                                   secret_access_key: ENV["RSWAG_SECRET_ACCESS_KEY"],
-                                   region: ENV["RSWAG_REGION"])
+        client = ::RswagSchemaExport::Client.new(stage)
+        RswagSchemaExport.config.schemas.map do |schema|
+          schema_id = schema.gsub(/[^a-zA-Z0-9\-]/, "_")
 
-        bucket = s3.bucket(ENV["RSWAG_BUCKET"])
-        # Copy latest version to root
-        versions = bucket.objects(prefix: "schemas/#{app_name}/#{stage}_schemas/versions").collect(&:key)
+          # Copy latest version to root
+          versions = client.fetch_versions(schema_id)
+          last_schema_key = versions.max
 
-        last_schema_key = versions.max
-        bucket.object(last_schema_key)
-              .copy_to("#{ENV['RSWAG_BUCKET']}/schemas/#{app_name}/#{stage}_schemas/schema.json")
-        # Download schema.json
-        if block_given?
-          bucket.object("schemas/#{app_name}/#{stage}_schemas/schema.json").download_file("schema.json")
-          yield
-        else
-          bucket.object("schemas/#{app_name}/#{stage}_schemas/schema.json").download_file(ENV["RSWAG_SCHEMA_PATH"])
-        end
-        # Clean versions folder
-        old_versions = versions - versions.sort.last(5)
-        old_versions.each { |key| bucket.object(key).delete }
+          client.copy_latest_version_to_root(last_schema_key, schema_id)
+          # Download schema.json
+          client.download_file(schema_id, schema)
+          # Clean versions folder
+          client.clean(versions)
 
-        puts("Schema has been successfully imported. Stage: #{stage} | Key: #{last_schema_key}")
+          puts("Schema has been successfully imported. Stage: #{client.stage} | Key: #{last_schema_key}")
+        end
+        yield if block_given?
+        puts("Import finished")
       rescue StandardError => e
         abort(e.message)
       end

data/lib/rswag_schema_export/tasks/rswag.rake

@@ -6,7 +6,9 @@ namespace :rswag do
     on roles(:all) do
       stage = ENV["STAGE"] || fetch(:stage, "develop")
       RswagSchemaExport::Import.new.run(stage) do
-        upload!("schema.json", "#{current_path}/#{ENV['RSWAG_SCHEMA_PATH']}")
+        RswagSchemaExport.config.shemas.map do |schema|
+          upload!(schema, "#{current_path}/#{schema}")
+        end
       end
     end
   end

data/lib/rswag_schema_export/version.rb

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

data/rswag_schema_export.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "aws-sdk-s3", "~> 1"
+  spec.add_dependency "azure-storage-blob", "~> 1.1"
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rswag_schema_export
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ruslan Tolstov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: azure-storage-blob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +164,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/rswag_schema_export/install/install_generator.rb
+- lib/generators/rswag_schema_export/install/templates/rswag_schema_export.rb
 - lib/rswag_schema_export.rb
 - lib/rswag_schema_export/capistrano.rb
+- lib/rswag_schema_export/client.rb
+- lib/rswag_schema_export/configuration.rb
 - lib/rswag_schema_export/railtie.rb
 - lib/rswag_schema_export/schema_export.rb
 - lib/rswag_schema_export/schema_import.rb