lapiz 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0ab0b44e4874b9bdfc660a8a5aac8d713590293
-  data.tar.gz: 9d06ae27e0b93082aabb4c5a7f38ce21a969b1c2
+  metadata.gz: df794cb2e0809ed82604aab62e686c2fef7a76a3
+  data.tar.gz: 6e687df08e82ab48483855f36c45d4e1da7cf501
 SHA512:
-  metadata.gz: b4b1ec0a78f21c60d0b38280c8601e374b03fb72172b2063dc63f7d02edddb3464e514016c9d249da59393eee255119a817098e8649f80efca6b7155a64f1a93
-  data.tar.gz: eb4b20fc26669e158fc1364461845e259f90810a5c8821bb3fecffeb4373faa6a7a4c237e6562b6ead964fca5107dd85309d0b8f79bae629da73794520751c78
+  metadata.gz: 8c34a733d6c6d4bd76e92e1e86e67df3951920d46f59561fb022ecf14e2c08654a34d6ebf59565b7a200e22125644c4061b226cb290dc73180f2f69f75639772
+  data.tar.gz: 1a1f9e089081adcfed2ebc16f6ad50cc996925c93a4023cd2d6a319a031ed1f90a49872f0d6cca0e776525ae8353aaa79e02f89a26f7ad4d47d5bb5bbbe0d7df

data/lib/lapiz/version.rb

@@ -1,3 +1,3 @@
 module Lapiz
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/lapiz.rb

@@ -82,14 +82,17 @@ module Lapiz
     http_call(:delete, path, params, &block)
   end
 
-  def http_call(method, path, params, &block)
+  def http_call(method, path_pattern, params, &block)
+    path = path_pattern.gsub(/{([^{}]*)}/) { $1.split("=").last }       # path_pattern contains {field=default_value}. gsub it with default value 
+    pattern = path_pattern.gsub(/{([^{}]*)}/) { "{#{$1.split("=").first}}" }  # same as above, but gsub it with field
+
     if block.nil?
       config = YAML.load(IO.read("config.yml"))
       base_uri = config["server"]["base_uri"]
       return HTTParty.send(method, base_uri + path, params)
     end
 
-    it "tests action '#{path}'", self  do |group|
+    it "tests action '#{pattern}'", self  do |group|
       expect {
         @response = HTTParty.send(method, group.metadata[:base_uri] + path, params)
       }.to_not raise_error
@@ -111,22 +114,48 @@ module Lapiz
 
       group_name = group.metadata[:group_name]
       File.open("api_docs/#{group_name.gsub(/[^a-zA-Z_]+/,'_').underscore}.txt", "a+") do |fp|
-        fp.puts "## #{method.to_s.upcase} #{path}"
+        fp.puts "## #{method.to_s.upcase} #{pattern}"
         fp.puts
 
-        if request_type
+        if @response.request.options[:description]
+          fp.puts @response.request.options[:description].lstrip
+        end 
+
+        if request_type || (path != pattern) # path != pattern when there is a url pattern # TODO: Use better checks
           if request_type == "application/json"
             fp.puts "+ Request (#{request_type})"
-          elsif request_type == "x-www-form-urlencoded"
+          elsif request_type == "x-www-form-urlencoded" || (path != pattern)
             fp.puts "+ Parameters"
 
+            flattened_params = {}
             if @response.request.options[:body]
               flattened_params = @response.request.options[:body] ? @response.request.options[:body].flatten : {}
               flattened_params.each_pair do |k,v| 
-                fp.puts "    + #{CGI.escape(k)}: \"#{v.to_s}\" (#{v.class.name})"
+                description = nil
+                if @response.request.options[:parameter_descriptions]
+                  description = @response.request.options[:parameter_descriptions][k.to_s] || @response.request.options[:parameter_descriptions][k.to_sym]
+                end
+                fp.puts "    + #{CGI.escape(k)}: (#{v.class.name})#{description ? " - #{description}" : ""}"
               end
             end
+
+            # This converts param_desc hash to an array ([[k1,v1],[k2,v2]]), removes any which are already in the body (and hence documented), and then convers back to hash
+            @response.request.options[:parameter_descriptions].to_a.map{|e| [e[0].to_s, e[1]]}.reject{|e| flattened_params.keys.include?(e[0])}.to_h.each_pair do |k,v|
+              fp.puts "    + #{CGI.escape(k)}: (String) - #{v}"
+            end
+          end
+        end
+
+        if @response.request.options[:headers]
+          fp.puts
+          fp.puts "+ Request"
+          fp.puts
+          fp.puts "    + Headers"
+          fp.puts
+          @response.request.options[:headers].each_pair  do |k,v|
+            fp.puts "            #{k}: #{v}"
           end
+          fp.puts
         end
 
         if @response.body && (@response.code / 100 == 2)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lapiz
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ajith Hussain
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler