lapiz 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbcfb12b4eb5e6c27e44e6493c418445b9c54d17
-  data.tar.gz: 248f79b173cefd7fecb53cf29bb43e3ceb0bac8d
+  metadata.gz: e7962443bbda79bd48219d63b261ff4bead15429
+  data.tar.gz: 33d0a913c948c92b8e693abf592f7d38f052f769
 SHA512:
-  metadata.gz: de52e209ce8ff8262d30c84d8ee03225572c4e641af7400b72facd945237cfb851e97ba7785ad2f482c9fa06fd68ca03803695433bf690619ddb732b297b1bb9
-  data.tar.gz: 729c1715f77268cbe8d62225b4fb10b29270eaafe0397d96104c78d108f78065c2810a4d7e540ab1da7acdc6df2086f9a8b9cef98604e3d23bc90c401c365e20
+  metadata.gz: 745e5b576c5f170f9702dfc62ec136fa9fbae143b096d9ba67b882eba1f9df4065c94329b204eba9468134bdac314fdabc4236f6617a5020bb87437defe3506e
+  data.tar.gz: 719f14a38c5eab259552aeffb19727e223c1e63d8b2d2dcd67ed758c54fd012654535b5cd2b485ab339c2944834ed339ee5938a78ed63b4ae120042338171ee7

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/*.gem

data/lib/lapiz/version.rb

@@ -1,3 +1,3 @@
 module Lapiz
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/lapiz.rb

@@ -1,10 +1,156 @@
 require "lapiz/version"
+require "fileutils"
+require "cgi"
+
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end
+
+class Hash
+  def flatten
+    new_hash = self.dup
+
+    while new_hash.values.map(&:class).include?(Hash)
+      updated_hash = {}
+      new_hash.each_pair do |k,v| 
+        if v.is_a?(Hash)
+          v.each_pair do |ik, iv| 
+            updated_hash["#{k},#{ik}"] = iv
+          end
+        else
+          updated_hash[k.to_s] = v
+        end
+      end
+      new_hash = updated_hash
+    end
+
+    new_hash = new_hash.to_a.map{ |e|
+      if e[0].include?(",")
+        main = e[0].split(",").first
+        rest = e[0].split(",")[1..-1]
+        rest_string = rest.map{ |r| "[#{r}]" }.join("")
+        ["#{main}#{rest_string}", e[1]]
+      else
+        e
+      end
+    }.to_h
+
+    new_hash
+  end
+end
+
+module Lapiz
+  def group(name, &block)
+    describe(name) do
+      config = YAML.load(IO.read("config.yml"))
+      metadata[:base_uri] = config["server"]["base_uri"]
+      metadata[:group_name] = name
+
+      FileUtils.mkdir_p("api_docs")
+      File.open("api_docs/#{name.gsub(/[^a-zA-Z_]+/,'_').underscore}.txt", "w+") do |fp|
+        fp.puts "# Group #{name}"
+        fp.puts
+      end
+
+      instance_eval &block
+    end
+  end
+
+  def get(path, params = {}, &block)
+    http_call(:get, path, params, &block)
+  end
+
+  def post(path, params, &block)
+    http_call(:post, path, params, &block)
+  end
+
+  def http_call(method, path, params, &block)
+    it "tests action '#{path}'", self  do |group|
+      expect {
+        @response = HTTParty.send(method, group.metadata[:base_uri] + path, params)
+      }.to_not raise_error
+      instance_eval "def response;@response;end"
+      instance_eval &block
+
+      request_type = nil
+      unless method == :head || method == :get
+        # Attempt to find request type
+        if @response.request.options[:headers]
+          request_type = @response.request.options[:headers]["Content-Type"]
+        end
+
+        if  request_type.nil? # it was not set explicitly
+          # if body is present, assume they meant x-www-form-urlencoded
+          request_type = "x-www-form-urlencoded"
+        end
+      end
+
+      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
+
+        if request_type
+          if request_type == "application/json"
+            fp.puts "+ Request (#{request_type})"
+          elsif request_type == "x-www-form-urlencoded"
+            fp.puts "+ Parameters"
+
+            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})"
+              end
+            end
+          end
+        end
+
+        if @response.body
+          fp.puts
+          fp.puts "+ Response #{@response.code} (#{@response.content_type})"
+          fp.puts 
+
+          hash = JSON.parse(@response.body)
+
+          fp.puts JSON.pretty_generate(hash).split("\n").map{ |line| "        #{line}" }.join("\n")
+
+          fp.puts
+        end
+      end
+    end
+  end
+end
 
 RSpec.configure do |config|
-  configure.before(:suite) do
-    # Create or clear api-docs folder
+  config.after(:suite) do
+    config = YAML.load(IO.read("config.yml"))
+    base_uri = config["server"]["base_uri"]
+
+    File.open("api_docs/api.md", "w+") do |fp| 
+      fp.puts "FORMAT: 1A"
+      fp.puts "HOST: #{base_uri}"
+      fp.puts
+      fp.puts "# #{config["meta"]["title"]}"
+      fp.puts
+      fp.puts config["meta"]["description"]
+      fp.puts
+      
+      Dir["api_docs/*.txt"].each do |f|
+        IO.readlines(f).map(&:chomp).each do |line|
+          fp.puts line
+        end
+      end
+    end
   end
 
   config.after(:example) do |example|
   end
 end
+
+include Lapiz

metadata

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