source2swagger 0.0.1

data/test/data/sample4.rb

@@ -0,0 +1,44 @@
+##~ sapi = source2swagger.namespace("sentiment")
+##~ sapi.basePath = "http://helloworld.3scale.net"
+##~ sapi.swagrVersion = "0.1a"
+##~ sapi.apiVersion = "1.0"
+
+##~ sapi = source2swagger.namespace("sentiment")
+##~ a = sapi.apis.add
+## 
+##~ a.set :path => "/word/{word}", :format => "json"
+##~ a.description = "Access to the sentiment of a given word"
+##
+##  declaring errors
+##~ @error_sanitize = {:reason => "failure to sanitize: \"input\"", :code => 422}
+##~ @error_api_down = {:reason => "API down", :code => 500}
+
+##
+##~ a.errorResponses.add @error_sanitize
+##~ a.errorResponses.add @error_api_down
+##~ a.errorResponses.add :reason => "failure to sanitize: \"input\", returns empty set", :code => 422
+##~ a.errorResponses.add :reason => "access denied, either your access credentials are incorrect or you are about the limits of your quota", :code => 403
+##~ 
+##~ op = a.operations.add   
+##~ op.set :httpMethod => "GET", :tags => ["production"], :nickname => "get_word", :deprecated => false
+##~ op.summary = "Returns the sentiment values of a given word"  
+##~ op.parameters.add :name => "word", :description => "The word whose sentiment is returned", :dataType => "string", :allowMultiple => false, :required => true, :paramType => "path"
+##~ op.parameters.add :name => "app_id", :description => "Your access application id", :dataType => "string", :allowMultiple => false, :required => true, :paramType => "query"
+##~ op.parameters.add :name => "app_key", :description => "Your access application key", :dataType => "string", :allowMultiple => false, :required => false, :paramType => "query"
+## 
+##~ sapi = source2swagger.namespace("sentiment")
+##
+##~ a = sapi.apis.add
+## 
+##~ a.set :path => "/ping", :format => "text"
+##~ a.description = "Check the status to see if it's up and running"
+##
+##  declaring errors
+##
+##~ a.errorResponses.add @error_api_down
+## 
+##~ op = a.operations.add   
+##~ op.set :httpMethod => "GET", :tags => ["test"], :nickname => "ping", :deprecated => true
+##~ op.summary = "This operation is DEPRECATED. It returns the string \"that's getting old... pong \" if the API is up and running"  
+##
+

data/test/data/sample5.rb

@@ -0,0 +1,46 @@
+##~ sapi = source2swagger.namespace("sentiment")
+##~ sapi.basePath = "http://helloworld.3scale.net"
+##~ sapi.swagrVersion = "0.1a"
+##~ sapi.apiVersion = "1.0"
+
+##~ sapi = source2swagger.namespace("sentiment")
+##~ a = sapi.apis.add
+## 
+##~ a.set :path => "/word/{word}", :format => "json"
+##~ a.description = "Access to the sentiment of a given word"
+##
+##  REMOVING THE DECLARATION ON @error_sanitize and @error_api_dow TO THE END OF THE FILE
+##  COULD ALSO BE A DIFFERENT FILE
+##
+##~ a.errorResponses.add @error_sanitize
+##~ a.errorResponses.add @error_api_down
+##~ a.errorResponses.add :reason => "failure to sanitize: \"input\", returns empty set", :code => 422
+##~ a.errorResponses.add :reason => "access denied, either your access credentials are incorrect or you are about the limits of your quota", :code => 403
+##~ 
+##~ op = a.operations.add   
+##~ op.set :httpMethod => "GET", :tags => ["production"], :nickname => "get_word", :deprecated => false
+##~ op.summary = "Returns the sentiment values of a given word"  
+##~ op.parameters.add :name => "word", :description => "The word whose sentiment is returned", :dataType => "string", :allowMultiple => false, :required => true, :paramType => "path"
+##~ op.parameters.add :name => "app_id", :description => "Your access application id", :dataType => "string", :allowMultiple => false, :required => true, :paramType => "query"
+##~ op.parameters.add :name => "app_key", :description => "Your access application key", :dataType => "string", :allowMultiple => false, :required => false, :paramType => "query"
+## 
+##~ sapi = source2swagger.namespace("sentiment")
+##
+##~ a = sapi.apis.add
+## 
+##~ a.set :path => "/ping", :format => "text"
+##~ a.description = "Check the status to see if it's up and running"
+##
+##  declaring errors
+##
+##~ a.errorResponses.add @error_api_down
+## 
+##~ op = a.operations.add   
+##~ op.set :httpMethod => "GET", :tags => ["test"], :nickname => "ping", :deprecated => true
+##~ op.summary = "This operation is DEPRECATED. It returns the string \"that's getting old... pong \" if the API is up and running"  
+##
+##  MOVED VAR DECLARATION
+##~ @error_sanitize = {:reason => "failure to sanitize: \"input\"", :code => 422}
+##~ @error_api_down = {:reason => "API down", :code => 500}
+
+

data/test/data/sample_bad1.rb

@@ -0,0 +1,20 @@
+##~ sapi = source2swagger.namespace("sentiment")
+##~ sapi.basePath = "http://helloworld.3scale.net"
+##~ sapi.swagrVersion = "0.1a"
+##~ sapi.apiVersion = "1.0"
+##
+##~ a = sapi.apis.add
+## 
+##~ a.set :path => "/ping", :format => "text"
+##~ a.description = "Check the status to see if it's up and running"
+##
+##  declaring errors
+##
+##~ a.errorResponses.add :reason => "API down", :code => 500
+## 
+##  end CANNOT BE USED AS VARIABLE SINCE IT'S A RUBY RESERVED WORD
+##
+##~ end = a.operations.add   
+##~ end.set :httpMethod => "GET", :tags => ["test"], :nickname => "ping", :deprecated => true
+##~ end.summary = "This operation is DEPRECATED. It returns the string \"that's getting old... pong \" if the API is up and running"  
+##

data/test/data/sample_bad2.rb

@@ -0,0 +1,16 @@
+##~ sapi = source2swagger.namespace("sentiment")
+##~ sapi.basePath = "http://helloworld.3scale.net"
+##~ sapi.swagrVersion = "0.1a"
+##~ sapi.apiVersion = "1.0"
+##
+##~ a = sapi.apis.add
+## 
+##~ a.set :path => "/ping", :format => "text"
+##~ a.description = Check the status to see if it's up and running
+## 
+##  THE STRING ABOVE IS NOT WITHIN QUOTES
+##  declaring errors
+##
+##~ a.errorResponses.add :reason => "API down", :code => 500
+## 
+

data/test/data/sample_bad3.rb

@@ -0,0 +1,44 @@
+##~ sapi = source2swagger.namespace("sentiment")
+##~ sapi.basePath = "http://helloworld.3scale.net"
+##~ sapi.swagrVersion = "0.1a"
+##~ sapi.apiVersion = "1.0"
+
+##~ sapi = source2swagger.namespace("sentiment")
+##~ a = sapi.apis.add
+## 
+##~ a.set :path => "/word/{word}", :format => "json"
+##~ a.description = "Access to the sentiment of a given word"
+##
+##  declaring errors
+##~ @error_sanitize = {:reason => "failure to sanitize: \"input\"", :code => 422}
+##~ @error_api_down = {:reason => "API down", :code => 500}
+
+##
+##~ a.errorResponses.add @error_sanitize_NOT_YET_DEFINED
+##~ a.errorResponses.add @error_api_down
+##~ a.errorResponses.add :reason => "failure to sanitize: \"input\", returns empty set", :code => 422
+##~ a.errorResponses.add :reason => "access denied, either your access credentials are incorrect or you are about the limits of your quota", :code => 403
+##~ 
+##~ op = a.operations.add   
+##~ op.set :httpMethod => "GET", :tags => ["production"], :nickname => "get_word", :deprecated => false
+##~ op.summary = "Returns the sentiment values of a given word"  
+##~ op.parameters.add :name => "word", :description => "The word whose sentiment is returned", :dataType => "string", :allowMultiple => false, :required => true, :paramType => "path"
+##~ op.parameters.add :name => "app_id", :description => "Your access application id", :dataType => "string", :allowMultiple => false, :required => true, :paramType => "query"
+##~ op.parameters.add :name => "app_key", :description => "Your access application key", :dataType => "string", :allowMultiple => false, :required => false, :paramType => "query"
+## 
+##~ sapi = source2swagger.namespace("sentiment")
+##
+##~ a = sapi.apis.add
+## 
+##~ a.set :path => "/ping", :format => "text"
+##~ a.description = "Check the status to see if it's up and running"
+##
+##  declaring errors
+##
+##~ a.errorResponses.add @error_api_down
+## 
+##~ op = a.operations.add   
+##~ op.set :httpMethod => "GET", :tags => ["test"], :nickname => "ping", :deprecated => true
+##~ op.summary = "This operation is DEPRECATED. It returns the string \"that's getting old... pong \" if the API is up and running"  
+##
+

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'test/unit'
+require 'swagger_hash'
+require 'swagger_reader'
+require 'json'
+
+$:.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
+Dir[File.dirname(__FILE__) + '/test_helpers/**/*.rb'].each { |file| require file }
+
+

data/test/test_helpers/compare_hashes.rb

@@ -0,0 +1,57 @@
+module TestHelpers
+  module CompareHashes
+
+    def paths(path,h)
+      
+      if h.class==Hash
+        v = []
+        h.each do |k,val|
+          v << paths("#{path}/#{k}",val)
+        end
+        return v.flatten
+      else
+        if h.class==Array
+          v = []
+          if h.size>0
+            h.each do |item|
+              v << paths("#{path}/[]",item)
+           end
+          else
+            v << ["#{path}/[]"]
+          end
+        
+          return v.flatten
+        else
+          return ["#{path}/#{h}:(#{h.class})"]
+        end
+      end
+    end
+
+    def diff(h1, h2)
+      
+      v1 = paths("",h1)
+      v2 = paths("",h2)
+
+      return [] if v1.size==v2.size && v1-v2 == []
+
+      v1 = v1.sort
+      v2 = v2.sort
+
+      num = v1.size
+      num = v2.size if v2.size < num
+
+      v1.size.times do |i|
+        if v1[i]!=v2[i]
+          return [v1[i], v2[i]]
+        end
+      end
+
+      return [nil, nil]
+
+    end  
+  end
+end
+
+Test::Unit::TestCase.send(:include, TestHelpers::CompareHashes)
+
+

data/test/unit/swagger_hash_test.rb

@@ -0,0 +1,177 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class SwaggerHashTest < Test::Unit::TestCase
+
+
+  def test_basics
+    h = SwaggerHash.new
+    
+    h.o = 1
+    assert_equal h, {:o => 1}
+    
+    h.u.u.u = {:y => "1"}
+    assert_equal h, {:o => 1, :u => {:u => {:u => {:y => "1"}}}}
+    
+    h.x
+    assert_equal h, {:o => 1, :u => {:u => {:u => {:y => "1"}}}, :x => {}}
+    
+    h.x = []
+    assert_equal h, {:o => 1, :u => {:u => {:u => {:y => "1"}}}, :x => []}
+    
+  end
+  
+  def test_basics_add
+    
+    h = SwaggerHash.new
+    
+    v = h.x.y.z.add
+    assert_equal v, {}
+    assert_equal h, {:x => {:y => {:z => {:_array => [{}]}}}}
+    
+    v.a = 10
+    assert_equal h, {:x => {:y => {:z => {:_array =>[{:a => 10}]}}}}
+    
+    v.b.b = "5"
+    assert_equal h, {:x => {:y => {:z => {:_array =>[{:a => 10, :b => {:b => "5"}}]}}}}
+    
+    v = h.x.y.z.add
+    assert_equal h, {:x => {:y => {:z => {:_array =>[{:a => 10, :b => {:b => "5"}},{}]}}}}
+    
+    v.c.c = "3"
+    assert_equal h, {:x => {:y => {:z => {:_array =>[{:a => 10, :b => {:b => "5"}}, {:c => {:c => "3"}}]}}}}
+    
+  end
+  
+  def test_basics_add_params
+    
+    h = SwaggerHash.new
+    
+    h.z.add :a => 1
+    h.z.add :a => 1
+    
+    assert_equal h.to_hash, {:z => [{:a => 1}, {:a => 1}]}
+  
+    h = SwaggerHash.new
+    
+    h.z.add :a => 1, :b => 2, :c => 3
+    h.z.add :a => 1, :b => 2, :c => 3
+    
+    assert_equal h.to_hash, {:z => [{:a => 1, :b => 2, :c => 3}, {:a => 1, :b => 2, :c => 3}]}
+    
+    h = SwaggerHash.new
+
+    h.z.add :a => 1, :b => 2, :c => 3
+    h.z.add :a => 1, :b => 2, :c => 3
+    i = h.z.add 
+    i.bs = "k"
+
+    assert_equal h.to_hash, {:z => [{:a => 1, :b => 2, :c => 3}, {:a => 1, :b => 2, :c => 3}, {:bs => "k"}]}
+    
+  end
+  
+  def test_to_hash
+        
+    h = SwaggerHash.new
+    assert_equal h.to_hash, {}
+        
+    h = SwaggerHash.new
+    a = h.x.y.add 
+    a.a1 = "1"
+    a.a2 = "2"
+    
+    a = h.x.y.add 
+    a.a1 = "1"
+    
+    a = h.y.add
+    
+    a.set :bs => "k", :bs2 => "k2"
+    
+    a.bs3 = "k3"
+    
+    assert_equal h.to_hash, {:x => {:y => [{:a1 => "1", :a2 => "2"}, {:a1 => "1"}]}, :y => [{:bs => "k", :bs2 => "k2", :bs3 => "k3"}]}
+     
+  end
+  
+  
+  def test_load_same_api_space
+    
+    source2swagger = SwaggerHash.new
+
+    a = source2swagger.namespace("namespace1")
+    a.bla = 10
+    a.foo = "100"
+    
+    a = source2swagger.namespace("namespace2")
+    assert_equal a.to_hash, {}
+    
+    a = source2swagger.namespace("namespace1")
+    assert_equal a.to_hash, {:bla => 10, :foo => "100"}
+
+    a.bar.add :a => 1, :b => 2
+    assert_equal a.to_hash, {:bla => 10, :foo => "100", :bar => [{:a => 1, :b => 2}]}
+    
+    a = source2swagger.namespace("namespace2")
+    assert_equal a.to_hash, {}
+    
+    a = source2swagger.namespace("namespace1")
+    assert_equal a.to_hash, {:bla => 10, :foo => "100", :bar => [{:a => 1, :b => 2}]}
+    
+  end
+  
+  def test_save
+
+    source2swagger = SwaggerHash.new
+
+    a = source2swagger.namespace("namespace1")
+    a.bla = 10
+    a.foo = "100"
+
+    b = source2swagger.namespace("namespace2")
+    b.foo.bar = 42
+
+    assert_equal source2swagger.namespace("namespace1").to_hash, {:bla => 10, :foo => "100"}
+    assert_equal source2swagger.namespace("namespace2").to_hash, {:foo => {:bar => 42}}
+
+    a = source2swagger.namespace("namespace1")
+    assert_equal a.to_hash, {:bla => 10, :foo => "100"}
+
+  end
+  
+
+  def test_compare
+    
+    reader = SwaggerReader.new
+    
+    assert_equal [], diff([],[])
+    assert_equal [], diff({},{})
+    assert_equal [], diff("10","10")    
+    assert_not_equal [], diff("10","11")
+      
+    assert_equal [], diff({:a=>1,:b=>{:a=>1}},{:b=>{:a=>1},:a=>1})
+    assert_not_equal [], diff({:a=>1,:b=>{:a=>1}},{:b=>{:a=>1},:a=>"1"})
+    assert_not_equal [], diff({:a=>1,:b=>{:a=>1}},{:b=>{:a=>2},:a=>1})
+
+    assert_equal [], diff({:a=>1,:b=>{:a=>1,:c=>[ 11, 10, 9] }},{:b=>{:c=>[9, 10, 11],:a=>1},:a=>1})
+    
+    a = {:a=>1, :b=>{:a=>1, :c => [{:z=>1}, {}, {:z2=>"2"}] }}
+    b = {:b=> {:c => [ {}, {:z2=>"2"}, {:z=>1}], :a=>1}, :a=>1}
+
+    assert_equal [], diff(a,b)
+
+    a = {:z => [{}, {:a => {:b => [1,2]}}]}
+    b = {:z => [{:a => {:b => [1,2]}}, {}]}
+
+    assert_equal [], diff(a,b)
+
+    b = {:z => [{}, {:a => {:b => [2,1]}}]}
+
+    assert_equal [], diff(a,b)
+
+    a = {:z => [{}, {:a => {:b => [{:c => 3}, {:d => 4}]}}]}
+    b = {:z => [{}, {:a => {:b => [{:d => 4}, {:c => 3}]}}]}
+
+    assert_equal [], diff(a,b)
+    
+  end
+
+end

data/test/unit/swagger_reader_test.rb

@@ -0,0 +1,181 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class SwaggerReaderTest < Test::Unit::TestCase
+
+  def setup
+    source2swagger = SwaggerHash.new
+  end 
+ 
+  def test_swagger_simple
+  
+    source2swagger = SwaggerHash.new
+    sapi = source2swagger.namespace("test")
+    ep = sapi.endpoint.add
+    ep.set :path => "/sentence/{sentence}", :format => "json"
+    ep.description = "Returns the aggregated sentiment of a sentence"
+  
+    expected = {:endpoint => [{:path => "/sentence/{sentence}", :format => "json", :description => "Returns the aggregated sentiment of a sentence"}]}  
+    assert_equal source2swagger.namespace("test").to_hash, expected
+    
+    
+      
+    code = ["source2swagger = SwaggerHash.new", "sapi = source2swagger.namespace(\"test\")", "ep = sapi.endpoint.add", "ep.set :path => \"/sentence/{sentence}\", :format => \"json\"", "ep.description = \"Returns the aggregated sentiment of a sentence\""]
+    code << "source2swagger.namespace(\"test\").to_hash"
+    res = eval(code.join(";"))
+    assert_equal res, expected  
+    
+  end
+  
+  def test_samples_1
+    
+    reader = SwaggerReader.new
+
+    code = reader.analyze_file("#{File.dirname(__FILE__)}/../data/sample1.rb","##~")
+
+    api1 = reader.process_code(code)
+    
+    api1 = api1["sentiment"].to_hash
+    
+    api2 = JSON::load(File.new("#{File.dirname(__FILE__)}/../data/sample1.json","r"))
+
+    assert_equal [], diff(api1, api2)  
+  
+  end
+ 
+  def test_samples_2
+    
+    reader = SwaggerReader.new
+    
+    code = reader.analyze_file("#{File.dirname(__FILE__)}/../data/sample2.rb","##~")
+    api1 = reader.process_code(code)
+    
+    api1 = api1["sentiment"].to_hash
+    
+    api2 = JSON::load(File.new("#{File.dirname(__FILE__)}/../data/sample2.json","r"))
+
+    assert_equal [], diff(api1, api2)  
+  
+  end
+
+  def test_samples_3
+    
+    reader = SwaggerReader.new
+    
+    code = reader.analyze_file("#{File.dirname(__FILE__)}/../data/sample3.rb","##~")
+    api1 = reader.process_code(code)
+    
+    api1 = api1["sentiment"].to_hash
+    
+    api2 = JSON::load(File.new("#{File.dirname(__FILE__)}/../data/sample3.json","r"))
+
+    assert_equal [], diff(api1, api2)  
+  
+  end
+
+  def test_samples_4
+    
+    ## sample4.rb is same as sample2.rb with the use of variables
+    
+    reader = SwaggerReader.new
+    
+    code = reader.analyze_file("#{File.dirname(__FILE__)}/../data/sample4.rb","##~")
+    api1 = reader.process_code(code)
+    api1 = api1["sentiment"].to_hash
+    
+    api2 = JSON::load(File.new("#{File.dirname(__FILE__)}/../data/sample2.json","r"))
+
+    assert_equal [], diff(api1, api2)  
+  
+  end
+
+
+  def test_incorrect_samples
+    
+    reader = SwaggerReader.new
+    
+    code = reader.analyze_file("#{File.dirname(__FILE__)}/../data/sample1.rb","##~")
+    api1 = reader.process_code(code)
+    
+    api1 = api1["sentiment"].to_hash
+    
+    api2 = JSON::load(File.new("#{File.dirname(__FILE__)}/../data/sample2.json","r"))
+
+    assert_not_equal [], diff(api1, api2)
+
+    api3 = JSON::load(File.new("#{File.dirname(__FILE__)}/../data/sample3.json","r"))
+    assert_not_equal [], diff(api1, api3)
+  
+
+  end
+
+  def test_exception_single_file
+
+    reader = SwaggerReader.new
+    
+    begin
+      code = reader.analyze_file("#{File.dirname(__FILE__)}/../data/sample_bad2.rb","##~")
+      api1 = reader.process_code(code)
+      assert_equal true, false
+    rescue Exception => e
+      assert_equal "Error parsing source files at #{File.dirname(__FILE__)}/../data/sample_bad2.rb:9\n#<SyntaxError: (eval):1: unterminated string meets end of file>", e.to_s
+    end
+
+  end
+
+  def test_exception_all_files
+
+    reader = SwaggerReader.new
+    
+    begin
+      code = reader.analyze_all_files("#{File.dirname(__FILE__)}/../data","rb","##~")
+      api1 = reader.process_code(code)
+      assert_equal true, false
+    rescue Exception => e
+      assert_equal "Error parsing source files at #{File.dirname(__FILE__)}/../data/sample_bad1.rb:17\n#<SyntaxError: (eval):1: syntax error, unexpected keyword_end, expecting $end\n...=> \"API down\", :code => 500;end = a.operations.add;out = {:a...\n...                               ^>", e.to_s
+    end
+
+  end
+
+  def test_exception_variable_not_defined
+
+    reader = SwaggerReader.new
+    
+    begin
+      code = reader.analyze_file("#{File.dirname(__FILE__)}/../data/sample_bad3.rb","##~")
+      api1 = reader.process_code(code)
+      assert_equal true, false
+    rescue Exception => e
+      assert_equal "Error parsing source files at #{File.dirname(__FILE__)}/../data/sample_bad3.rb:17\n#<NameError: undefined local variable or method `error_sanitize_NOT_YET_DEFINED' ", e.to_s.split("for")[0].to_s
+
+    end
+  end
+
+  def test_unordered_variables_do_not_matter
+    
+    reader = SwaggerReader.new
+    
+    code = reader.analyze_file("#{File.dirname(__FILE__)}/../data/sample5.rb","##~")
+    api1 = reader.process_code(code)
+    api1 = api1["sentiment"].to_hash
+    
+    api2 = JSON::load(File.new("#{File.dirname(__FILE__)}/../data/sample2.json","r"))
+
+    assert_equal [], diff(api1, api2) 
+  end
+
+  def test_safe_level
+    
+    assert_raises SwaggerReaderException do
+      reader = SwaggerReader.new
+
+      code = {:code => [], :line_number => [], :file => []}
+   
+      code[:code] << "system \"rm -rf /tmp/test.txt\""
+      code[:line_number] << 0
+      code[:file] << "foo"
+
+      reader.process_code(code)
+    end
+  end
+
+end