jsonapi_swagger_helpers 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1feea97f395c500cbf8914d31a2e02a3ad0529cd
-  data.tar.gz: 1d5e093336798ba21f41020ef8b58c83e8fa979e
+  metadata.gz: c590130598ec385f7cd5f751daebc434134dbcbd
+  data.tar.gz: 88ebb028ff3384493e81e0f2f1ede2c99387c8fe
 SHA512:
-  metadata.gz: 13265b4a6f5f91b060536991587c8be0878537e705230faf04cd8df381e138257d573ad8dbaf6d3fba1e9d6ce9c25448f0e243566af0c29ea3d9f09393c8d9a6
-  data.tar.gz: c277e20daa4b1785cfbffb826267e34c733179c4ba21a87dd120ffa24508e551d19e52d346d8a9347a119404f11d8aab0b1b8c52acffb65d72b209e627632a69
+  metadata.gz: 0e539c0912d897ac4a99dd4e231f74746dc763974890096c8b15e4205319627a0ff95cb2ec38f1344a86146a8f9850a3c9ea7a6089493dd868b67df81412c61c
+  data.tar.gz: b27dbe4c58645933105a45f9b1779a57000c9e9228b086ecb2cecb63b36abd9778685b0fb509dea83785225b146c0c9f4d0b4204554cf41c695c2b5c2d957d6b

data/lib/jsonapi_swagger_helpers.rb

@@ -11,10 +11,11 @@ require "jsonapi_swagger_helpers/show_action"
 require "jsonapi_swagger_helpers/create_action"
 require "jsonapi_swagger_helpers/update_action"
 require "jsonapi_swagger_helpers/destroy_action"
-
 require "jsonapi_swagger_helpers/resource_mixin"
 require "jsonapi_swagger_helpers/docs_controller_mixin"
 
+require "jsonapi_swagger_helpers/railtie" if defined?(Rails)
+
 module JsonapiSwaggerHelpers
   def self.configure
     yield config

data/lib/jsonapi_swagger_helpers/index_action.rb

@@ -43,9 +43,14 @@ module JsonapiSwaggerHelpers
           _self.util.jsonapi_includes(self)
 
           _self.each_association do |association_name, association_resource|
+            _self.util.jsonapi_fields(self, association_resource.config[:type])
+
+            if association_resource.config[:extra_fields].keys.length > 0
+              _self.util.jsonapi_extra_fields(self, association_resource)
+            end
+
             _self.util.each_filter(association_resource, association_name) do |filter_label|
               _self.util.jsonapi_filter(self, filter_label)
-              _self.util.jsonapi_fields(self, association_resource.config[:type])
             end
           end
         end

data/lib/jsonapi_swagger_helpers/railtie.rb

@@ -0,0 +1,7 @@
+module MyGem
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/swagger_diff.rake'
+    end
+  end
+end

data/lib/jsonapi_swagger_helpers/readable.rb

@@ -68,8 +68,12 @@ module JsonapiSwaggerHelpers
     end
 
     def each_association
+      types = [jsonapi_type]
       resource_map = util.all_resources(resource, include_directive)
       resource_map.each_pair do |association_name, association_resource|
+        resource_type = association_resource.config[:type]
+        next if types.include?(resource_type)
+        types << resource_type
         yield association_name, association_resource
       end
     end

data/lib/jsonapi_swagger_helpers/show_action.rb

@@ -37,13 +37,14 @@ module JsonapiSwaggerHelpers
           _self.util.jsonapi_includes(self)
 
           _self.each_association do |association_name, association_resource|
+            _self.util.jsonapi_fields(self, association_resource.config[:type])
+
+            if association_resource.config[:extra_fields].keys.length > 0
+              _self.util.jsonapi_extra_fields(self, association_resource)
+            end
+
             _self.util.each_filter(association_resource, association_name) do |filter_label|
               _self.util.jsonapi_filter(self, filter_label)
-              _self.util.jsonapi_fields(self, association_resource.config[:type])
-
-              if association_resource.config[:extra_fields].keys.length > 0
-                _self.util.jsonapi_extra_fields(self, association_resource)
-              end
             end
           end
         end

data/lib/jsonapi_swagger_helpers/version.rb

@@ -1,3 +1,3 @@
 module JsonapiSwaggerHelpers
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/tasks/swagger_diff.rake

@@ -0,0 +1,43 @@
+require 'pp'
+begin
+  require 'swagger/diff'
+rescue LoadError
+  puts "You must install the swagger-diff gem to use the swagger_diff rake task"
+  exit(1)
+end
+
+def get_swagger(path)
+  token = ENV['JSONAPI_TOKEN']
+  session = ActionDispatch::Integration::Session.new(Rails.application)
+  session.get path, headers: {
+    'Authorization' => "Token token=\"#{token}\""
+  }
+  session.response.body
+end
+
+desc <<-DESC
+Compare a local swagger.json to a remote swagger.json
+
+Usage: swagger_diff[namespace,local_host,remote_host]
+
+Example swagger_diff["api","http://localhost:3000","http://myapp.com"]
+
+If your app relies on JSON Web Tokens, you can set JSONAPI_TOKEN for authentication
+DESC
+task :swagger_diff, [:namespace, :local_host, :remote_host] => [:environment] do |_, args|
+  local_host  = args[:local_host]  || 'http://localhost:3000'
+  remote_host = args[:remote_host] || 'http://localhost:3000'
+  namespace   = args[:namespace]   || 'api'
+
+  old  = get_swagger("#{remote_host}/#{namespace}/swagger.json")
+  new  = get_swagger("#{local_host}/#{namespace}/swagger.json")
+  diff = Swagger::Diff::Diff.new(old, new)
+
+  if diff.compatible?
+    puts 'No backwards incompatibilities found!'
+  else
+    puts "Found backwards incompatibilities!\n\n"
+    pp JSON.parse(diff.incompatibilities)
+    exit(1)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_swagger_helpers
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Lee Richmond
@@ -105,6 +105,7 @@ files:
 - lib/jsonapi_swagger_helpers/errors.rb
 - lib/jsonapi_swagger_helpers/index_action.rb
 - lib/jsonapi_swagger_helpers/payload_definition.rb
+- lib/jsonapi_swagger_helpers/railtie.rb
 - lib/jsonapi_swagger_helpers/readable.rb
 - lib/jsonapi_swagger_helpers/resource_mixin.rb
 - lib/jsonapi_swagger_helpers/show_action.rb
@@ -112,6 +113,7 @@ files:
 - lib/jsonapi_swagger_helpers/util.rb
 - lib/jsonapi_swagger_helpers/version.rb
 - lib/jsonapi_swagger_helpers/writeable.rb
+- lib/tasks/swagger_diff.rake
 homepage: 
 licenses:
 - MIT