honey 0.0.6

data/lib/okapi/config.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+module Honey
+  module Okapi
+    CONFIG_PATH = "apiary.yaml"
+    APIARY_URL = "https://api.apiary.io"
+    GET_REQUESTS_PATH = "/tests/get-requests"
+    GET_RESULTS_PATH = "/tests/get-test-results"
+    BLUEPRINT_PATH = "apiary.apib"
+    TEST_SPEC_PATHS = "tests.spec"
+    TEST_URL = "http://127.0.0.1"
+    OUTPUT = 'tap'    
+  end
+end

data/lib/okapi/examples/apiary.apib

@@ -0,0 +1,59 @@
+HOST: http://www.google.com/
+
+--- test API ---
+
+---
+Welcome to the our sample API documentation. All comments can be written in (support [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax)
+---
+
+--
+Shopping Cart Resources
+The following is a section of resources related to the shopping cart
+--
+
+List products added into your shopping-cart. (comment block again in Markdown)
+GET /shopping-cart/{id}
+< 200
+< Content-Type: application/json
+{ "items": [
+{ "url": "/shopping-cart/1", "product":"2ZY48XPZ", "quantity": 1, "name": "New socks", "price": 1.25 }
+] }
+
+Save new products in your shopping cart
+POST /shopping-cart/{id2}
+> Content-Type: application/json
+> CCC: aaa
+{ "product":"1AB23ORM", "quantity": 2 }
+< 201
+< Content-Type: application/json
+< CCC: aaa
+{ "status": "created", "url": "/shopping-cart/2" }
+
+-- Payment Resources --
+
+This resource allows you to submit payment information to process your *shopping cart* items
+POST /payment
+{ "cc": "12345678900", "cvc": "123", "expiry": "0112" }
+< 200
+{ "receipt": "/payment/receipt/1" }
+
+-- JSON Schema Validations --
+
+POST /shopping-cart/{id2}
+{"request":
+    { "type": "object",
+      "properties": {
+        "product": { "type": "string","format": "alphanumeric" },
+        "quantity": { "type": "integer" }
+      }
+    }
+,
+"response":
+    { "type": "object",
+      "properties": {
+        "product": { "type": "string","format": "alphanumeric" },
+        "status": { "type": "integer" }
+      }
+    }
+}
+

data/lib/okapi/examples/apiary.yaml

@@ -0,0 +1,5 @@
+tests:
+  host: http://aptest.apiary.io
+  specs:
+    - tests.spec
+    - tests2.spec

data/lib/okapi/examples/tests.spec

@@ -0,0 +1,6 @@
+VARS {"id2": "eee", "id": "5"}
+POST /shopping-cart/{id2} {"id2": "eee2"}
+POST 
+CONTINUE
+
+

data/lib/okapi/examples/tests2.spec

@@ -0,0 +1,3 @@
+POST /shopping-cart/{id2} {"id2": "eee2"}
+POST /payment
+

data/lib/okapi/help.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module Honey
+  module Okapi
+    class Help
+      
+      def self.show
+        banner
+        options
+      end
+
+      def self.banner
+        puts "\nUsage: okapi [options]"
+        puts "Try 'okapi help' for more information."
+      end
+
+      def self.options
+        puts "\nCurrently available okapi options are:\n\n"
+
+        puts "\t-b, --blueprint             path to the blueprint (default: " + BLUEPRINT_PATH + " )"
+        puts "\t-t, --test_spec             path to the test specification (default: " + TEST_SPEC_PATHS + " )"
+        #puts "\t-o, --output                output format (default: " + OUTPUT + ")"
+        puts "\t-u, --test_url              url to test (default: " + TEST_URL + ")"
+        puts "\t-a, --apiary                apiary url  (default: " + APIARY_URL + ")"
+        puts "\t-s, --config                config file  (default: " + CONFIG_PATH + ")"
+        puts "\t-p, --params                prints used parameters"
+        puts "\n"
+        puts "\thelp                        Show this help"
+        puts "\n"
+      end
+
+      def self.okapi
+        puts File.read(File.dirname(__FILE__) + '/okapi')
+      end
+    end
+  end
+end

data/lib/okapi/okapi

@@ -0,0 +1,43 @@
+
+                 ,#.@:
+                @;#@@#
+               #+#@#@;
+          :+#;#'+@#@#`
+         @@##@+@;;    ```  ,` ;,;@@@+',`
+        ;@###@@. ,+#@@@@@@@@#@@@@@@@@@@#``
+       #@@:     `,@@#@#@#@@##@@@@@@@'#`+:+:`
+     .#@` #+     ` ::`  :`,.+;#`,``'`@.##:#`+`##;` `
+    '@#  `      ,  #+@#@+':@###@+;+.#@,@#`+`+#@@@#:.
+   +@@`         +  `;#;++`'@@###@@+ @@,@@`#;@@#@#@@@#;+'
+  :@@@@.      `;    ';#+@,##@####@;,@+,@#`:#':#+'@##@@#'@+`
+ `@@@@###; ` '           @;+#@@#@#.@@'@@@``.'` +#:@'@@#@#@#;
+  `,`#+`,#`              `:;#;@#@;.#+;@@#:'`++ ` #.@@@:@,@@@#
+                           `:;##@##@:##@.'+:@#,#`.@#@:@@;@##+`
+                               #,#@+@@@##@##@#+:`#@@#@`+#;##++
+                               @@@@@@@@@@;'@+@#`#.'@@@@``,.,:#,
+                               ####@@@##'`#@'@@`#'#,@@@#    `@#
+                               ;#@@+@@#'+@'@+@#`#@+@@@@@##   #,#
+                                #@@##@#+##:@#@@,'@.@@@` ::   ;#;
+                                '#,#`#@#.'.#@@#+,####` `     `'#
+                                 +     +:;+@@#@#.##@@#.@.    `+`,
+                                  '    `#+###@@@@@#@@@+`.:`  .'#
+                                  @`    ##@#####@:@@##``     #,@
+                                  @#'`   #@@##@#,'### `      @'#
+                                  ###'       @   :##`#;;#,   @.,
+                                  ,+,+ .. `       +#+':  . ``++,
+                                   :':'@;         +;  `,,,   `;
+                                    #; `:          @;#'`;  :+``
+                                                    
+                                    +`  `            '+;' :   .#`
+                                    @@,@+              .+. ; +##;
+                                    ;#,#@              ',+. `@##
+                                    :#:#                
+                                                        `+   .
+                                    ##.#`               +    #
+                                    #+,@.               @    +
+                                    #+ .`               #    `
+                                    :;                  '``  `
+                                                       +##  ###
+                                                      `@@: .##`
+                                                      '##  ##:
+                                                      `#    `

data/lib/okapi/output.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+Dir["#{File.dirname(__FILE__)}/outputs/*.rb"].each { |f|   require(f)  }
+
+module Honey
+  module Okapi
+    class Output
+      def self.get(output,resources, error)
+        output = Honey::Okapi::Outputs.const_get(output.to_s.capitalize).send(:new, resources, error)
+        output.get()
+        output.status
+      end
+    end
+  end
+end

data/lib/okapi/outputs/base.rb

@@ -0,0 +1,91 @@
+module Apiary
+  module Okapi
+    module Outputs
+      class BaseOutput
+        attr_reader :status
+
+        def initialize(resources, error)
+          @resources = resources
+          @error = error
+          @results = {
+            :count => 0,
+            :give_up => false,
+          }
+          @status = true
+          get_results
+        end
+
+        def get
+          p @results[:count].to_s + ' tests'
+          p @results[:give_up][:error].to_s if @results[:give_up]
+          @results[:tests].each { |test|
+            p '-------------------------------------------------'
+            p test[:test_no]
+            p test[:description]
+            if test[:pass]
+              p 'OK'
+            else
+              p "FAILED"
+              p test[:exp]
+            end
+          }
+        end
+
+        def get_results
+          @results[:count] = @resources.count
+          @results[:tests] = []
+          
+          if @error
+            @results[:give_up] = {:error => @error}
+            @status = false
+          else
+            counter = 0
+            @resources.each { |res|
+              counter += 1
+              test_res = {
+                :test_no=> counter,
+                :pass => (res.validation_result.status and res.response.validation_result.status),
+                :description => (res.method + ' ' + res.uri) + ((res.expanded_uri and res.uri != res.expanded_uri['url']) ? " (#{res.expanded_uri['url']}) " : '')
+                }
+              if not test_res[:pass]
+                test_res[:exp] = {:request => {:pass => false}, :response => {:pass => false}}
+                if res.validation_result.status
+                  test_res[:exp][:request][:pass] = true
+                else
+                  test_res[:exp][:request][:reasons] = get_fail_result(res.validation_result)
+                  @status = false
+                end
+
+                if res.response.validation_result.status
+                  test_res[:exp][:response][:pass] = true
+                else
+                  test_res[:exp][:response][:reasons] = get_fail_result(res.response.validation_result)
+                  @status = false
+                end              
+              end
+            @results[:tests] << test_res
+            }
+          end
+        end
+
+        def get_fail_result(result)
+          res = []
+
+          if result.schema
+            result.schema_res["errors"]["length"].times {|i|
+              res << result.schema_res["errors"][i.to_s]["message"]
+            }
+          else
+            if not result.body_pass
+              res << 'Body does not match'
+            end
+          end
+          if not result.header_pass
+            res << 'Headers does not match'
+          end
+          res
+        end
+      end
+    end
+  end
+end

data/lib/okapi/outputs/tap.rb

@@ -0,0 +1,44 @@
+require "#{File.dirname(__FILE__)}/base.rb"
+require 'yaml'
+
+module Apiary
+  module Okapi
+   module Outputs
+     class Tap < Apiary::Okapi::Outputs::BaseOutput
+
+       def get
+         get_int
+         puts "\n\n"
+       end
+       
+       def get_int
+         puts "TAP version 13"
+         puts "1..#{@results[:count].to_s}"
+         if @results[:give_up]
+             puts "Bail out! #{@results[:give_up][:error].to_s.tr("\n"," ")}"
+             return
+         end
+         @results[:tests].each { |test|
+           if test[:pass]
+             o = 'ok '
+           else
+             o = 'not ok '
+           end
+           puts o + test[:test_no].to_s + ' ' + test[:description]
+           if not test[:pass]
+             error_block(test)
+           end
+         }      
+       end
+
+       def error_block(test)
+         test[:exp].to_yaml.split(/\n/).each { |line|
+           puts "  #{line}"
+         }
+         puts "  ..."
+         
+       end
+     end
+   end
+  end
+end

data/lib/okapi/resources.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+module Apiary
+  module Okapi
+    class Resource
+      attr_accessor :uri, :method, :params, :expanded_uri,  :headers, :body, :response, :validation_result
+
+      def initialize(uri, method, params, expanded_uri = nil,  headers = nil, body = nil, response = nil, validation_result = nil)
+        #p uri, method, params
+        @uri          = uri
+        @method       = method
+        @params       = params
+        @expanded_uri = expanded_uri
+        @headers      = headers
+        @body         = body
+        @response     = response
+        @validation_result = validation_result
+      end
+    end
+
+    class Response
+      attr_accessor :status,  :headers, :body, :error, :validation_result
+
+      def initialize(status = nil, headers = nil, body = nil, error = nil, validation_result = nil)
+        @headers      = headers
+        @body         = body
+        @status       = status
+        @error        = error
+        @validation_result = validation_result
+      end
+    end
+
+    class ValidationResult
+      attr_accessor :status, :error, :schema_res , :body_pass, :body_diff, :header_pass, :header_diff
+
+      def status
+        @status ||= get_status
+      end
+
+      def get_status
+        return true if not @error and @header_pass and ((schema and  schema_pass) or (not schema and @body_pass))
+        return false
+      end
+
+      def schema
+        !(@schema_res == false)
+      end
+
+      def schema_pass
+        not schema or schema and @schema_res and not @schema_res['errors']
+      end
+    end
+  end
+end

data/lib/okapi/spec_parser.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+require 'json'
+
+module Honey
+  module Okapi
+    class Parser
+      attr_reader :data, :resources, :proces_all_bp_resources, :global_vars
+
+      def initialize(spec_path)
+        if not File.exist? spec_path
+          raise Exception, "Test spec. file '#{spec_path}' not found"
+        end
+        @data = read_file(spec_path)
+        @proces_all_bp_resources = false
+      end
+
+      def resources
+        @resources ||= parse_data
+      end
+
+      def read_file(path)
+        @data = []
+          File.open(path).each do |line|
+            @data << line if line.strip != ""
+          end
+        @data
+      end
+
+      def substituite_vars(local, global)
+        tmp = {}
+        global.each {|k,v|
+          tmp[k] = v
+        }
+        local.each {|k,v|
+          tmp[k] = v
+        }
+        tmp
+      end
+
+      def parse_data
+        global_vars = {}
+        resources = []
+        @data.each { |res|
+          if res.index('CONTINUE') == 0
+            @proces_all_bp_resources = true
+            next
+          end
+
+          if res.index('VARS') == 0
+            splited = res.split(' ',2)
+            begin
+              global_vars = JSON.parse splited[1] if splited[1] and splited[1] != ''
+            rescue Exception => e
+              raise Exception, "can not parse global parameters (#{e})"
+            end
+            next
+          end
+
+          splited = res.split(' ',3)
+
+          begin
+            splited[2] = JSON.parse splited[2] if splited[2] and splited[2] != ''
+          rescue Exception => e
+            raise Exception, 'can not parse parameters for resource:' + res + "(#{e})"
+          end
+          
+          if splited[1] and splited[1] != '' and splited[0] and splited[0] != ''
+            out = {
+              'resource' => splited[1],
+              'method' => splited[0],
+              'params' => substituite_vars(splited[2] || {}, global_vars)
+              }
+            resources << out
+          end
+        }
+
+        @global_vars = global_vars
+        resources
+      end
+    end
+  end
+end