api_explorer 0.0.1 → 0.0.2

data/README.rdoc

@@ -7,7 +7,48 @@ The only precondition is that it requires a multithreaded rails server.
 
 Instructions:
 
-- gem "thin", "~> 1.6.1"
+- gem 'thin', '~> 1.6.1'
 - bundle install
 - Add to development.rb (or production.rb): config.thread_safe!
-- Start the server with "thin start --threaded" 
+
+
+
+Create a file named ws_specification.json (or any name you desire) and place it on /lib. 
+
+As an example:
+
+	{
+		"methods": [ {
+			"name": "Users index",
+			"url": "v1/users",
+			"description": "The index of users",
+			"method": "GET",
+			"parameters": [{"name": "API_TOKEN"}]
+		}, 
+		{
+			"name": "User login",
+			"url": "v1/users/login",
+			"description": "Users login",
+			"method": "POST",
+			"parameters": [{"name": "API_TOKEN"}, {"name": "email"}, {"name": "password"}]
+		}
+		]
+	}
+
+
+Create an initializer in /config/initializers/api_explorer.rb with the following content: 
+
+ApiExplorer::use_file = true
+ApiExplorer::json_path = 'lib/ws_specification.json'
+
+
+
+And finally mount the engine on config/routes.rb
+
+mount ApiExplorer::Engine => "/api_explorer"
+
+
+- Start the server with "thin start --threaded" 
+
+Then go to http://localhost:3000/api_explorer
+

data/lib/api_explorer/version.rb

@@ -1,3 +1,3 @@
 module ApiExplorer
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/dummy/lib/file2.json

@@ -4,16 +4,14 @@
 		"url": "v1/users",
 		"description": "The index of users",
 		"method": "GET",
-		"parameters": [{"name": "API_TOKEN"}],
-		"http_headers": [{"X-USER-ID": "ASSAJISIJA"}]
+		"parameters": [{"name": "API_TOKEN"}]
 	}, 
 	{
 		"name": "User login",
 		"url": "v1/users/login",
 		"description": "Users login",
 		"method": "POST",
-		"parameters": [{"name": "API_TOKEN"}, {"name": "email"}, {"name": "password"}],
-		"http_headers": [{"X-USER-ID": "6"}, {"X-API-ID": "JAOSIJAS"}]
+		"parameters": [{"name": "API_TOKEN"}, {"name": "email"}, {"name": "password"}]
 	}
 	]
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_explorer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: https://github.com/toptierlabs/api_explorer
 email:
 - afigueroa@toptierlabs.com