rswag_schema_export 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f5365e70225088820039474c2a86d974be33d467f8e13c58df1c3ec188b0b6f
-  data.tar.gz: eee348c31709d7e0480eef9b57b49377fb105ea356468f7a9af1861b25e74799
+  metadata.gz: f24a3d058e7de831bcb2c6d757e9c222a4c31b74ccf60bb40b78921c966cc047
+  data.tar.gz: e99c297dcdc2fa906d63218234996aea66cfe802f64e882c4f00371775ef3980
 SHA512:
-  metadata.gz: a4c75d96589614953a8d2cd666f701db04bafe65041f72acabc044842a82b4d98546abe424c0edb89b9540fea0329edc1196725d65d429464a209c8a39f8998e
-  data.tar.gz: 6f0dc260aa5e48188eb6c975a6839efe19cd3686a20065fbf3a90da2328252873944d788049d6db36351d95f11800220eb72b4a67050b6ed644ab92478f76a04
+  metadata.gz: ec81ef26bf39543e9a25b7bae9a18ebc24f4057b1fa0523ae5d1ee6fac8dab961c2f78c0d76e43fad73e45633a81cfeb6fac1dcc87af68912217cca2aab07135
+  data.tar.gz: 79e0648d094184b35b966f64d03934ddffac74b8815fa82e23ebb6eac50eb83c7d54865c647487016ec1942059933ac87b31490f77b11dc3fcd93b89f74cfbcc

data/.circleci/config.yml

@@ -10,6 +10,12 @@ jobs:
           keys:
             - rswag_schema_export-{{ checksum "Gemfile.lock" }}
             - rswag_schema_export-
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler:2.0.2
 
       - run:
           name: install dependencies

data/Gemfile.lock

@@ -1,44 +1,49 @@
 PATH
   remote: .
   specs:
-    rswag_schema_export (0.2.4)
+    rswag_schema_export (0.3.0)
       aws-sdk-s3 (~> 1)
       azure-storage-blob (~> 1.1)
+      slack-notifier (~> 2.3.2)
+      swagger-diff (~> 1.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
+    actionpack (6.0.1)
+      actionview (= 6.0.1)
+      activesupport (= 6.0.1)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.1)
+      activesupport (= 6.0.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.3)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     aws-eventstream (1.0.3)
-    aws-partitions (1.210.0)
-    aws-sdk-core (3.66.0)
+    aws-partitions (1.251.0)
+    aws-sdk-core (3.84.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
-      aws-partitions (~> 1.0)
+      aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.24.0)
-      aws-sdk-core (~> 3, >= 3.61.1)
+    aws-sdk-kms (1.26.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.48.0)
-      aws-sdk-core (~> 3, >= 3.61.1)
+    aws-sdk-s3 (1.59.0)
+      aws-sdk-core (~> 3, >= 3.83.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.1.0)
@@ -57,64 +62,67 @@ GEM
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
-    crass (1.0.4)
+    crass (1.0.5)
     diff-lcs (1.3)
     docile (1.3.2)
-    erubi (1.8.0)
-    faraday (0.15.4)
+    erubi (1.9.0)
+    faraday (0.17.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
+    jaro_winkler (1.5.4)
     jmespath (1.4.0)
     json (2.2.0)
-    loofah (2.2.3)
+    json-schema (2.8.1)
+      addressable (>= 2.4)
+    loofah (2.3.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (0.9.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
+    minitest (5.13.0)
     multipart-post (2.1.1)
-    nokogiri (1.10.4)
+    nokogiri (1.10.5)
       mini_portile2 (~> 2.4.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
+    parallel (1.18.0)
+    parser (2.6.5.0)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    public_suffix (4.0.1)
     rack (2.0.7)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.1)
+      actionpack (= 6.0.1)
+      activesupport (= 6.0.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.72.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
@@ -122,29 +130,34 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    simplecov (0.17.0)
+    simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    slack-notifier (2.3.2)
+    swagger-diff (1.1.2)
+      json-schema (~> 2.6)
+      rspec-expectations (~> 3.3)
     thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
+    zeitwerk (2.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.0)
   pry
-  railties (>= 3.1, < 6.0)
-  rake (~> 10.0)
+  railties (>= 3.1, < 7.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rswag_schema_export!
   rubocop
   simplecov
 
 BUNDLED WITH
-   1.17.2
+   2.0.2

data/README.md

@@ -93,6 +93,13 @@ require 'rswag_schema_export/capistrano'
 + set :rswag_schema_export_disable_import, true
 ```
 
+## Slack notifications
+
+```diff
+# config/deploy/develop.rb
++ set :rswag_schema_export_slack_webhook_url, ENV.fetch('SLACK_WEBHOOK_URL')
+```
+
 ## Configuration
 
 Set up ENVIRONMENT VARIABLES on your CI

data/lib/rswag_schema_export.rb

@@ -4,6 +4,9 @@ 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"
+require "rswag_schema_export/differ"
+require "swagger/diff"
+require "slack-notifier"
 
 module RswagSchemaExport
   def self.configure

data/lib/rswag_schema_export/differ.rb

@@ -0,0 +1,31 @@
+require 'json'
+
+module RswagSchemaExport
+  class Differ
+    def self.call(previews_schema, new_schema)
+      previews_schema_json = JSON.parse(File.read(previews_schema))
+      previews_schema_json["host"] = "localhost"
+
+      File.write(previews_schema, JSON.pretty_generate(previews_schema_json))
+
+      new_schema_json = JSON.parse(File.read(new_schema))
+      new_schema_json["host"] = "localhost"
+
+      File.write(new_schema, JSON.pretty_generate(new_schema_json))
+
+      diff = ::Swagger::Diff::Diff.new(previews_schema, new_schema)
+      changes = []
+      report = ""
+
+      diff.changes.map do |topic|
+        report += "#{topic.first}: #{topic.last} \n"
+        changes << topic.last unless topic.last.empty?
+      end
+      if changes.empty?
+        nil
+      else
+        report
+      end
+    end
+  end
+end

data/lib/rswag_schema_export/schema_import.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module RswagSchemaExport
   class Import
     def run
@@ -6,6 +8,9 @@ module RswagSchemaExport
       begin
         client = ::RswagSchemaExport::Client.new(ENV["STAGE"])
         RswagSchemaExport.config.schemas.map do |schema|
+          # Copy previous version
+          FileUtils.cp(schema, "#{schema}.previous") if File.exist?(schema)
+
           schema_id = schema.gsub(/[^a-zA-Z0-9\-]/, "_")
 
           # Copy latest version to root
@@ -19,6 +24,18 @@ module RswagSchemaExport
           client.clean(versions)
 
           puts("Schema has been successfully imported. Stage: #{client.stage} | Key: #{last_schema_key}")
+          if ENV["SLACK_WEBHOOK_URL"]
+            begin
+              changes = Differ.call("#{schema}.previous", schema)
+
+              unless changes.nil?
+                Slack::Notifier.new(ENV["SLACK_WEBHOOK_URL"], username: 'Swagger API Differ').post(
+                  text: '', attachments: [{ color: 'good', text: "_Swagger schema has been updated:_ \n #{changes}"}])
+              end
+            rescue StandardError => e
+              puts("Slack notification error: #{e}")
+            end
+          end
         end
         yield if block_given?
         puts("Import finished")

data/lib/rswag_schema_export/tasks/rswag.rake

@@ -5,7 +5,7 @@ namespace :rswag do
       on roles(fetch(:rswag_schema_export_roles, :app)) do
         within current_path do
           with rails_env: fetch(:rails_env) do
-            execute :rake, "rswag:schema_import STAGE=#{fetch(:stage)}"
+            execute :rake, "rswag:schema_import STAGE=#{fetch(:stage)} SLACK_WEBHOOK_URL=#{fetch(:rswag_schema_export_slack_webhook_url)}"
           end
         end
       end

data/lib/rswag_schema_export/version.rb

@@ -1,3 +1,3 @@
 module RswagSchemaExport
-  VERSION = "0.2.4".freeze
+  VERSION = "0.3.0".freeze
 end

data/rswag_schema_export.gemspec

@@ -21,11 +21,13 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "aws-sdk-s3", "~> 1"
   spec.add_dependency "azure-storage-blob", "~> 1.1"
+  spec.add_dependency "swagger-diff", "~> 1.1.2"
+  spec.add_dependency "slack-notifier", "~> 2.3.2"
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "railties", ">= 3.1", "< 6.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "railties", ">= 3.1", "< 7.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "simplecov"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rswag_schema_export
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Ruslan Tolstov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -38,20 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: swagger-diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +103,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,21 +113,21 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +198,7 @@ files:
 - lib/rswag_schema_export/capistrano.rb
 - lib/rswag_schema_export/client.rb
 - lib/rswag_schema_export/configuration.rb
+- lib/rswag_schema_export/differ.rb
 - lib/rswag_schema_export/railtie.rb
 - lib/rswag_schema_export/schema_export.rb
 - lib/rswag_schema_export/schema_import.rb
@@ -196,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Export/Import your rswag schema.json during deploy with CI