swag 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32bc8a758f8ddbfc48c7d10b11fc39f760744b8b
-  data.tar.gz: e177da8c57c5c06157a6a353ae2f64ec7c29cc3b
+  metadata.gz: 34ae21308f9a2bf56ca1e79e960cfe790cc55132
+  data.tar.gz: 0ad17a73b82f097ed91fb1ad0876a02d974b6b0e
 SHA512:
-  metadata.gz: e5cbc5a2d8993061faf7364d6170a1e7806669ab67f88e9f119a5ca2d74e61d60b0d3237b059c2cd18419ba212b23a7fd01ec91e7f4e8efdb638888eb7502043
-  data.tar.gz: ac552d828e53d02f1d923f2483ab4ae9feecfc01ba72d7714411bc342f09ed371eb6b8462ef14208efcc4293bed3998995e7ce27c3fa40710a21bd5b1dd35700
+  metadata.gz: 72a13f9c7193e5097d6f420856b70d0e53695d3c93af4d6ec267384f6cc81332f07fbe19d08d78ad8a6d504050a1c6dff246042ad3b30accf59bb793ef98d78b
+  data.tar.gz: 0100875e0e178bef2675fd5a944848435632b75525b554fc536a0a1a761963932eaffa5415516177fc59c2a8e9127925266cf94bc6f89496e38d10b49d9b78ae

data/bin/swag

@@ -1,7 +1,15 @@
 #! /usr/bin/env ruby
 
 require 'swag'
-puts Swag.hi
-puts Swag.check
-puts Swag.checkControllers
-puts Swag.writePaths
+Swag.hi
+if ARGV[0] == nil
+  Swag.usage
+elsif ARGV[1]
+  Swag.usage
+elsif ARGV[0] == "config"
+  Swag.config
+elsif ARGV[0] == "merge"
+  Swag.merge
+else
+  Swag.path(ARGV[0])
+end

data/lib/swag.rb

@@ -1,92 +1,96 @@
 require_relative 'swag_helper.rb'
-require_relative 'global_vars.rb'
+require_relative 'vars.rb'
+
 
 class Swag
 
 	@helper = SwagHelper.new
 
-	def initialize
-	end
-
 	def self.hi
-    	puts "Swag, world."
+		puts "Swag, world."
 	end
 
-	# verifies rails directory
-	def self.check
-		puts "Checking your directory: #{Dir.pwd}"
-    	if File.exist?("bin/rails")
-    		puts "Rails App detected. Proceeding."
-    	else
-    		puts "You must be in a Rails root directory for Swag to work. Aborting."
-    		abort
-    	end
+	def self.usage
+		puts "Usage: swag <command>"
+		puts "Command options: config, <path>, merge"
+		puts "config"
+		puts " - sets up the 'swag' folder in your current directory."
+		puts " - creates 'swag/config.yml' for your API's meta information."
+		puts " - swag/config.yml MUST exist in order for swag to run properly."
+		puts "<path>"
+		puts " - where <path> is a path in your API to document"
+		puts " - for example , 'swag users' will document the /users path"
+		puts " - documentation is generated as swag/<path>-api.yml"
+		# might get rid of the below part
+		# puts "merge"
+		# puts " - generates swag/api.yml, a full documentation of your API."
+		# puts " - reads from all swag/<path>-api.yml files to accomplish this."
+		# puts " - important: you must document each path individually before merging."
 	end
 
-	# checks that app/controllers can be read
-	def self.checkControllers
-    	puts "Checking controllers."
-		begin
-			Dir.foreach("app/controllers") do |c|
-					puts "Found #{c}"
-				end
-    		rescue => ex
-    			puts "Error while reading controllers."
-					puts ex.inspect
-					puts ex.backtrace
-		end # end begin
-	end # end checkControllers
-
-	# writes specific controller's routes (helper for self.writePaths)
-	# 'controllerName' is the controller's name, 'doc' is the open File
-	def self.analyzeController(controllerName, doc)
-		puts "Analyzing controller: #{controllerName}"
+	def self.config
+		puts "Starting configuration..."
+		if File.exist?("swag/config.yml")
+			puts "Config file already exists."
+		else
+			begin
+				# make swag directory
+				Dir.mkdir("swag") unless Dir.exists?("swag")
 
-		# edits the controller name for use in the File
-		nameSliced = controllerName.slice(0..(controllerName.index('_') -1))
-		doc << "  /#{nameSliced}:\n"
+				# make config file
+				config = File.open("swag/config.yml", 'w')
+				config << $DEFAULT_CONFIG.to_yaml
+				config.close
 
-		File.open("app/controllers/#{controllerName}", 'r') do |c|
-			@show = false
-			@delete = false
-			c.each_line do |line|
-				if line.include? "def index"
-					@helper.doIndex(nameSliced, controllerName, doc)
-				elsif line.include? "def create"
-					@helper.doCreate(nameSliced, controllerName, doc)
-				elsif line.include? "def show"
-					@show = true
-				elsif line.include? "def delete"
-					@delete = true
-				end
-			end # end each_line do block
-			@helper.doShow(nameSliced, controllerName, doc) if @show
-			@helper.doDelete(nameSliced, controllerName, doc) if @delete
-		end # end File.open do block (File is closed automatically)
-	end # end analyzeController
+				puts "Created swag/config.yml"
+				puts "Please edit swag/config.yml to include your API's meta info."
+				puts "This is important in order for swag to work properly!"
+				puts "Run swag again when ready. Aborting."
+				abort
+			rescue Errno::ENOENT => e
+				puts "Error while making swag/config.yml"
+				puts e
+				puts e.backtrace
+			end # end try/catch
+		end # end if/else
+	end # end method
 
-	# lists controller paths by reading app/controllers directory
-	def self.writePaths
-    puts "Writing paths."
+	def self.merge
 		begin
-			# creates directory for swag to use
-			Dir.mkdir("swagGem") unless File.exists?("swagGem")
-			doc = File.open("swagGem/api.yml", 'w')
-
-			# sets up doc w/ config info
-			@helper.checkConfig(doc)
+			doc = File.open("swag/api.yml", 'w')
+			@helper.readConfig(doc)
+			doc.close
+		rescue Errno::ENOENT => e
+			puts "Error opening file."
+			puts e
+		rescue IOError => e
+			puts "Error writing to file."
+			puts e
+		end
+	end
 
-			Dir.foreach("app/controllers") do |c|
-				unless (c == "." || c == ".." || c == "concerns" ||
-					c == "application_controller.rb")
-					analyzeController(c, doc)
-				end
-			end
-	  	doc.close
-			rescue => ex
-				puts "Error while writing paths."
-				puts ex.inspect
-				puts ex.backtrace
-		end # end begin block
-	end # end writePaths
+	def self.path(arg)
+		@helper.setupApi unless File.exist?("swag/api.yml")
+		begin
+			api = YAML.load_file('./swag/api.yml')
+			puts api
+			puts "Path to explore: #{api["host"]}#{api["basepath"]}#{arg}"
+		rescue Errno::ENOENT => e
+			puts "Error loading swag/api.yml. Make sure it is configured properly."
+			puts e
+			puts e.backtrace
+		end
+		puts "Is this correct? [y/n]:"
+		answer = STDIN.gets.chomp
+		if answer.downcase == "y"
+			@helper.doPath(arg, api)
+		elsif answer == ""
+			puts "yes"
+			@helper.doPath(arg, api)
+		elsif answer.downcase == "n"
+			puts "Please try again."
+		else
+			puts "Please try again."
+		end
+	end # end method
 end # end Class

data/lib/swag_helper.rb

@@ -1,120 +1,68 @@
-require_relative 'global_vars.rb'
+require_relative 'swag.rb'
+require_relative 'vars.rb'
+require 'yaml'
+require 'net/http'
 
 class SwagHelper
 
   def initialize
   end
 
-  def readConfig(doc)
-    File.open("swagGem/config.yml", 'r') do |c|
-      c.each_line do |line|
-        doc << "#{line}"
-      end # end each line block
-    end # close File block
+  def setupApi
+    doc = File.open("swag/api.yml", 'w')
+    # read config.yml in as a Ruby hash. Populate doc with appropriate info.
+    config = YAML.load_file('./swag/config.yml')
+    puts "Loaded config info from swag/config.yml"
+    doc << config.to_yaml
+    puts "Wrote config info to swag/api.yml"
+    doc.close
   end
 
-  def writeConfig
-    config = File.open("swagGem/config.yml", 'w')
-    config << "swag: #{SWAG_VERSION}\n"
-    config << "info:\n"
-    config << "  version:\n"
-    config << "  title: #{File.basename(Dir.getwd)}\n"
-    config << "  description: a Rails app.\n"
-    config << "  author:\n"
-    config << "      name:\n"
-    config << "      contact:\n"
-    config << "  license:\n"
-    config << "schemes:\n"
-    config << "  - http\n"
-    config << "consumes:\n"
-    config << "produces:\n"
-    config << "paths:\n"
-    config.close
-  end
+  # TODO: leaving this as a reminder to implement the /path/:id path thing yeah
+  # def doShow(nameSliced, controllerName, doc)
+  #   # puts "#{controllerName} contains show"
+  #   doc << "  /#{nameSliced}/:id\n"
+  # end
 
-  # checks config info
-  def checkConfig(doc)
-    # open config file (if it exists)
-    # read line-by-line
-    # write relevant information to doc
-    if File.exists?("swagGem/config.yml")
-      readConfig(doc)
-    else
-      writeConfig
-      readConfig(doc)
-    end
+  def doGet(fullPath)
+    puts "Sending an http get request to #{fullPath}. Returning a hash."
+    return $DEFAULT_GET
   end
 
-  # prints index info to open YAML File 'doc'
-  def doIndex(nameSliced, controllerName, doc)
-    # puts "#{controllerName} contains index"
-    doc << "    get:\n"
-    doc << "      description: returns an index for this resource.\n"
-    doc << "      produces:\n"
-    doc << "      parameters:\n"
-    doc << "      responses:\n"
-    doc << "        200:\n"
-    doc << "            description: #{nameSliced} response\n"
-    doc << "            schema:\n"
-    doc << "        default:\n"
-    doc << "            description: unexpected error\n"
-    doc << "            schema:\n"
-  end
+  def doPath(arg, api)
+    input = {
+      "#{arg}" => {
+        "get" => $DEFAULT_GET,
+        "post" => $DEFAULT_POST,
+        "patch" => {},
+        "delete" => $DEFAULT_DELETE,
+      },
+    }
+    # the path to send to HTTP methods
+    fullPath = "#{api["host"]}#{api["basepath"]}#{arg}"
 
-  def doCreate(nameSliced, controllerName, doc)
-    # puts "#{controllerName} contains new"
-    doc << "    post:\n"
-    doc << "      description: creates a new instance of this resource.\n"
-    doc << "      produces:\n"
-    doc << "      parameters:\n"
-    doc << "      responses:\n"
-    doc << "        200:\n"
-    doc << "            description: #{nameSliced} response\n"
-    doc << "            schema:\n"
-    doc << "        default:\n"
-    doc << "            description: unexpected error\n"
-    doc << "            schema:\n"
-  end
+    # assign the get, post, patch, delete sections for this path
+    # call the HTTP methods from above
+    input["#{arg}"]["get"] = doGet(fullPath)
+    # input["#{arg}"]["post"] = doPost(fullPath)
+    # input["#{arg}"]["patch"] = doPatch(fullPath)
+    # input["#{arg}"]["delete"] = doDelete(fullPath)
 
-  def doShow(nameSliced, controllerName, doc)
-    # puts "#{controllerName} contains show"
-    doc << "  /#{nameSliced}/:id\n"
-    doc << "    get:\n"
-    doc << "      description: returns a specific #{nameSliced} item by id.\n"
-    doc << "      produces:\n"
-    doc << "      parameters:\n"
-    doc << "        - name: id\n"
-    doc << "          in: path\n"
-    doc << "          description: id of specific #{nameSliced} object\n"
-    doc << "          required: true\n"
-    doc << "          type: integer\n"
-    doc << "          format:\n"
-    doc << "      responses:\n"
-    doc << "        200:\n"
-    doc << "          description: #{nameSliced} response\n"
-    doc << "          schema:\n"
-    doc << "        default:\n"
-    doc << "          description: unexpected error\n"
-    doc << "          schema:\n"
-  end
+    # now that the path info is assigned, combine it with the whole API doc
+    api["paths"]["#{arg}"] = input["#{arg}"]
 
-  def doDelete(nameSliced, controllerName, doc)
-    doc << "    delete:\n"
-    doc << "      description: deletes a specific #{nameSliced} item by id.\n"
-    doc << "      produces:\n"
-    doc << "      parameters:\n"
-    doc << "        - name: id\n"
-    doc << "          in: path\n"
-    doc << "          description: id of specific #{nameSliced} object\n"
-    doc << "          required: true\n"
-    doc << "          type: integer\n"
-    doc << "          format:\n"
-    doc << "      responses:\n"
-    doc << "        204:\n"
-    doc << "          description: #{nameSliced} object deleted\n"
-    doc << "          schema:\n"
-    doc << "        default:\n"
-    doc << "          description: unexpected error\n"
-    doc << "          schema:\n"
+    # write the final product to swag/api.yml
+    begin
+      doc = File.open("swag/api.yml", 'w')
+      doc << api.to_yaml
+          puts "Wrote api info to swag/api.yml"
+      doc.close
+    rescue Errno::ENOENT => e
+      puts "Error creating file: swag/api.yml"
+      puts e
+    rescue IOError => e
+      puts "Error writing to file: swag/api.yml"
+      puts e
+    end
   end
 end # end class

data/lib/vars.rb

@@ -0,0 +1,73 @@
+SWAG_VERSION = '0.5.0'
+
+$DEFAULT_CONFIG = {
+  "swag" => "#{SWAG_VERSION}",
+  "info" => {
+    "version" => '0.0',
+    "title" => "My API.",
+    "description" => "An API.",
+    "author" => {
+      "name" => "Example",
+      "contact" => "example@example.com",
+    },
+    "license" => "BSD 3-Clause",
+  },
+  "host" => "localhost:3000",
+  "basepath" => "/",
+  "schemes" => ["http"],
+  "paths" => {}
+}
+
+$DEFAULT_GET = {
+  "description" => "",
+  "produces" => "",
+  "parameters" => "",
+  "responses" => {
+    "200:" => {
+      "description" => "",
+      "schema" => "",
+    },
+    "default" => {
+      "description" => "unexpected error",
+      "schema" => [],
+    },
+  },
+}
+
+$DEFAULT_POST = {
+  "description" => "",
+  "produces" => "",
+  "parameters" => [],
+  "responses" => {
+    "200:" => {
+      "description" => "",
+      "schema" => [],
+    },
+    "default" => {
+      "description" => "unexpected error",
+      "schema" => [],
+    },
+  },
+}
+
+$DEFAULT_DELETE = {
+  "description" => "",
+  "produces" => "",
+  "parameters" => [{
+    "name" => "id",
+    "in" => "path",
+    "description" => "id of entry to be deleted.",
+    "required" => "true",
+    "type" => "integer",
+    }],
+  "responses" => {
+    "200:" => {
+      "description" => "",
+      "schema" => [],
+    },
+    "default" => {
+      "description" => "unexpected error",
+      "schema" => "",
+    },
+  },
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swag
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ethan Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-08-12 00:00:00.000000000 Z
 dependencies: []
 description: |-
   A gem with which to generate YAML from a Rails app. Currently
@@ -20,9 +20,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/swag
-- lib/global_vars.rb
 - lib/swag.rb
 - lib/swag_helper.rb
+- lib/vars.rb
 homepage: http://rubygems.org/gems/swag
 licenses:
 - BSD-3-Clause

data/lib/global_vars.rb

@@ -1 +0,0 @@
-SWAG_VERSION = '0.2.0'