rails-swagger 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 042e9785d813113e7b564fbf749427f2ffe1e1b1
-  data.tar.gz: a0c8e5dc0cdb6bfab7aeb99d90320daeeab983e3
+  metadata.gz: 8b89c6bd9042fab14f38e6fd3521e3fa12a33490
+  data.tar.gz: fd06df4097b8b28ffb1b25f7eb70fb9a39adeab3
 SHA512:
-  metadata.gz: 9c105c75ccfc2ba21357a383f66cdc979c9643d1850c9d35e7f69fbb33951095265ae601c79cf3e2740c80d843953be0212a67249ab53a67233d64cef1a8bc5a
-  data.tar.gz: 3b2957c92d4b5645cb845f24e6e439bda15d90b9413496c6b57e98cdb87ca4ebc0c9d630de8de91acc59ccfebb47aabd6cdd03231e7c072f78c405f004f29a42
+  metadata.gz: 75d982c6a1d3813c9d3ffb413314305f1bfc8626ea63d218df0c8e0c57a6d03e921dfea64f2f9d2b007f56f561773f9c5cf217ec7544ee054a595240005ae754
+  data.tar.gz: 0f4da4227fb7fac70c09d58804e009182ed4faa6503eeae552a13eb85a5f68fd2181654d22a5fdeb766d6962c1d6b5619d9d987ddd98b91f9dc3ce28042cbe99

data/lib/rails/swagger.rb

@@ -1,4 +1,4 @@
-require "jschema"
+require "json-schema"
 require "rails/swagger/controller"
 require "rails/swagger/router"
 require "rails/swagger/engine"

data/lib/rails/swagger/controller.rb

@@ -2,26 +2,35 @@ module Rails
 	module Swagger
 		module Controller
 
+			# METHODS_WITH_BODIES = [
+			# 	:post,
+			# 	:patch,
+			# 	:put
+			# ].freeze
+
 			# Injects swagger-related code into the controller when included
 			def self.included base
 
 				# Add controller hooks
-				base.class_eval do
-					before_action :validate_swagger_params
-				end
+				# base.class_eval do
+				# 	before_action :swagger_validate_params
+				# end
 
 				# Returns the swagger spec definition for the endpoint serving
 				# the current request.
 				def swagger_endpoint
 					key = "#{params[:controller]}##{params[:action]}"
-					endpoint = rails_swagger_engine.endpoints[key]
+					endpoint = swagger_engine.endpoints[key]
 				end
 
 				# Validates request parameters against the Swagger API spec
 				# associated with this controller.
-				def validate_swagger_params
-					#puts swagger_endpoint.inspect.white
-				end
+				# def swagger_validate_params
+				# 	if METHODS_WITH_BODIES.include? request.method_symbol
+				# 		body = request.POST
+				# 		# TODO: add validation here
+				# 	end
+				# end
 
 			end
 

data/lib/rails/swagger/engine.rb

@@ -45,14 +45,6 @@ module Rails
 				raise "Unsupported swagger version: #{document["swagger"]}. #{self} supports only version 2.0"
 			end
 
-			# # Parse the swagger schema
-			# schema = nil
-			# begin
-			# 	schema = JSchema.build document
-			# rescue JSchema::UnknownError, JSchema::InvalidSchema => e
-			# 	raise $!, "Problem parsing swagger spec file \"#{file}\": #{e.message}", $@
-			# end
-
 			# Builds a routing tree based on the swagger spec file.
 			# We'll add each endpoint to the routing tree and additionally
 			# store it in an array to be used below.
@@ -90,14 +82,26 @@ module Rails
 					end
 				end
 
+				# Rack app for serving the original swagger file
+				swagger_app = Class.new do
+					def inspect
+						"Rails::Swagger::Engine"
+					end
+					define_method :call do |env|
+						[
+							200,
+							{"Content-Type" => "application/json"},
+							[engine.schema.to_json]
+						]
+					end
+				end
+
 				# Adds routes to the engine by passing the Mapper to the top
 				# of the routing tree. `self` inside the block refers to an
 				# instance of `ActionDispatch::Routing::Mapper`.
 				self.routes.draw do
 					scope module: base_module.name.underscore, format: false do
-						get "swagger.json", to: -> (env) do
-							[200, {"Content-Type" => "application/json"}, [engine.schema.to_json]]
-						end
+						get "swagger.json", to: swagger_app.new
 						router.draw self
 					end
 				end
@@ -136,7 +140,7 @@ module Rails
 				def self.included controller
 					base_module = @base
 					controller.include Controller
-					define_method :rails_swagger_engine do
+					define_method :swagger_engine do
 						base_module.const_get :Engine
 					end
 				end

data/lib/rails/swagger/router.rb

@@ -1,16 +1,19 @@
 module Rails
 	module Swagger
 
+		# Internally represents individual routes
 		Endpoint = Struct.new(:method, :url, :definition, :_path) do
 			def initialize *opts
 				super
 				self[:_path] = self.path
 			end
+			# Translates path params from {bracket} syntax to :symbol syntax
 			def path
 				self[:url].gsub /\{(.+)\}/, ':\\1'
 			end
 		end
 
+		# Defines RESTful routing conventions
 		RESOURCE_ROUTES = {
 			get: :index,
 			post: :create
@@ -28,7 +31,7 @@ module Rails
 
 			def initialize prefix = [], parent = nil
 				@parent = parent
-				@prefix = prefix
+				@prefix = prefix.freeze
 				@endpoints = []
 				@subroutes = Hash.new do |hash, k|
 					hash[k] = Router.new(@prefix + [k], self)
@@ -92,19 +95,22 @@ module Rails
 				when :resource
 
 					# Find collection-level resource actions
-					actions = @endpoints.map{ |route| self.action_for route }.select{ |action| Symbol === action }
+					actions = @endpoints.map{ |r| self.action_for r }.select{ |a| Symbol === a }
 
 					# Find parameter-level resource actions
-					@subroutes.select{ |k, subroute| /^:/ === k}.values.each do |subroute|
-						actions += subroute.endpoints.map{ |route| subroute.action_for route }.select{ |action| Symbol === action }
+					@subroutes.select{ |k, _| /^:/ === k }.values.each do |subroute|
+						actions += subroute.endpoints.map{ |r| subroute.action_for r }.select{ |a| Symbol === a }
 					end
 
+					# Draw a resource
 					map.resources @prefix.last.to_sym, only: actions do
 						draw_actions! map
 						draw_subroutes! map
 					end
 
 				when :namespace
+
+					# Draw a namespace (unless at the top)
 					if @prefix.join("/").blank?
 						draw_subroutes! map
 					else
@@ -112,23 +118,17 @@ module Rails
 							draw_subroutes! map
 						end
 					end
-				when :action
-					draw_actions! map
-				end
 
-			end
+				when :action
 
-			def routing_tree
+					# Draw actions directly
+					draw_actions! map
 
-				puts self.path + " - #{self.route_mode}"
-				@endpoints.each do |route|
-					puts "\t#{route[:method].to_s.upcase} to ##{self.action_for route} (#{self.action_mode})"
 				end
-				@subroutes.each do |k, subroute| subroute.routing_tree end
 
 			end
 
-			# Outputs the routing tree in text format
+			# Returns the routing tree in text format
 			def to_s
 
 				output = ""
@@ -145,13 +145,24 @@ module Rails
 
 			end
 
+			# Outputs a visual representation of the routing tree
+			def _debug_routing_tree
+
+				puts self.path + " - #{self.route_mode}"
+				@endpoints.each do |route|
+					puts "\t#{route[:method].to_s.upcase} to ##{self.action_for route} (#{self.action_mode})"
+				end
+				@subroutes.each do |k, subroute| subroute._debug_routing_tree end
+
+			end
+
 		protected
 
 			def draw_actions! map
-				indent = "\t" * @prefix.count
-				endpoint = @prefix.last
+
 				@endpoints.each do |route|
 
+					# Params hash for the route to be added
 					params = Hash.new
 					params[:via] = route[:method]
 					params[:on] = self.action_mode unless self.action_mode == :param
@@ -161,15 +172,14 @@ module Rails
 					next if Symbol === params[:action]
 
 					# Add this individual route
-					map.match endpoint, params
+					map.match @prefix.last, params
 
 				end
+
 			end
 
 			def draw_subroutes! map
-				@subroutes.values.each do |subroute|
-					subroute.draw map
-				end
+				@subroutes.values.each { |r| r.draw map }
 			end
 
 		end

data/lib/tasks/rails/swagger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_swagger do
+#   # Task goes here
+# end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rails-swagger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Kenaniah Cerny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jschema
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,6 +40,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -77,6 +91,8 @@ files:
 - lib/rails/swagger/controller.rb
 - lib/rails/swagger/engine.rb
 - lib/rails/swagger/router.rb
+- lib/tasks/rails/swagger_tasks.rake
+- test/dummy/lib/assets/.keep
 homepage: https://github.com/kenaniah/rails-swagger
 licenses: []
 metadata: {}