apiaryio 0.0.2 → 0.0.3

data/.gitignore

@@ -2,8 +2,12 @@
 .rvmrc
 .tags
 .rbenv-version
+*.gem
 /coverage
 /pkg
 /rdoc
 /vendor
 !/doc
+/.idea
+/nbproject/
+

data/README.md

@@ -3,10 +3,18 @@ apiaryio
 
 Apiary.io CLI
 
+
+## Install
+
+``` bash
+gem install apiaryio
+```
+
+
 ## Description
 
-Apiaryio gem provides a way to display your API documentation on your local
-machine, either using static files or using a standalone web server
+Apiaryio gem provides a way to test and display your API documentation on your local
+machine, either using static files or using a standalone web server...
 
 ## Usage
 
@@ -23,7 +31,7 @@ machine, either using static files or using a standalone web server
       preview --api_host [HOST]                   Specify apiary host
       preview --server                            Start standalone web server on port 8080
       preview --server --port [PORT]              Start standalone web server on specified port
-
+      okapi     help                              Show okapi testing tool help
       help                                        Show help
 
       version                                     Show version
@@ -38,6 +46,7 @@ Copyright 2012 (c) Apiary Ltd.
 - James Charles Russell
 - Lukáš Linhart
 - Emili Parreño
+- Peter Grilli [Tu1ly]
 
 ## License
 

data/apiary.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "rest-client", "~> 1.6.7"
   gem.add_dependency "rack", "~> 1.4.1"
+  gem.add_dependency "json"
 
   gem.add_development_dependency "rspec",   "~> 2.11.0"
   gem.add_development_dependency "yard",    "~> 0.8.2.1"
 
-  gem.post_install_message = "This gem is a client for http://apiary.io. Apiary is in closed beta version now, you need an invitation. If you don't have one, visit http://apiary.us2.list-manage.com/subscribe?u=b89934a238dcec9533f4a834a&id=08f2bdde55 to get on the waiting list!"
 end

data/bin/apiary

@@ -1,6 +1,12 @@
 #!/usr/bin/env ruby
 $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..','lib')))
 require 'apiary'
+require 'okapi'
 
 trap(:INT) { abort "" }
-Apiary::CLI.new(ARGV)
+if ARGV[0] == 'okapi' || ARGV[0] == 'test'
+  ARGV.delete_at(0)
+  Apiary::Okapi::CLI.new(ARGV)
+else
+  Apiary::CLI.new(ARGV)
+end

data/lib/apiary/cli.rb

@@ -11,7 +11,7 @@ module Apiary
     end
 
     def run(args, options)
-      command = args.first
+      command = args.first || :help
       command = @command if @command
       Apiary::Command::Runner.run(command, options)
     end
@@ -21,7 +21,7 @@ module Apiary
       options = {}
       options_parser = OptionParser.new do |opts|
         opts.on("--path [PATH]") do |path|
-          options[:apib_path] = path
+          options[:path] = path
         end
 
         opts.on("--api_host API_HOST") do |api_host|

data/lib/apiary/command/help.rb

@@ -22,8 +22,9 @@ module Apiary
         puts "\tpreview --api_host [HOST]                   Specify apiary host"
         puts "\tpreview --server                            Start standalone web server on port 8080"
         puts "\tpreview --server --port [PORT]              Start standalone web server on specified port"
+        puts "\tokapi help                                  Show okapi testing tool help"
         puts "\n"
-        puts "\thelp                                        Show help"
+        puts "\thelp                                        Show this help"
         puts "\n"
         puts "\tversion                                     Show version"
         puts "\n"

data/lib/apiary/command/preview.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 require 'rest_client'
 require 'rack'
+require 'ostruct'
+
 module Apiary
   module Command
     # Display preview of local blueprint file
@@ -14,13 +16,13 @@ module Apiary
 
       attr_reader :options
 
-      def initialize(args)
-        @options = {}
-        @options[:apib_path]   = "apiary.apib"
-        @options[:api_host]    = "api.apiary.io"
-        @options[:headers]     = {:accept => "text/html", :content_type => "text/plain"}
-        @options[:port]        = 8080
-        @options.merge! args
+      # TODO: use OpenStruct to store @options
+      def initialize(opts)
+        @options = OpenStruct.new(opts)
+        @options.path         ||= "apiary.apib"
+        @options.api_host     ||= "api.apiary.io"
+        @options.headers      ||= {:accept => "text/html", :content_type => "text/plain"}
+        @options.port         ||= 8080
       end
 
       def self.execute(args)
@@ -32,7 +34,7 @@ module Apiary
       end
 
       def show
-        generate_static(apib_path)
+        generate_static(path)
       end
 
       def validate_apib_file(apib_file)
@@ -41,20 +43,12 @@ module Apiary
         end
       end
 
-      def apib_path
-        @options[:apib_path] || "#{File.basename(Dir.pwd)}.apib"
+      def path
+        @options.path || "#{File.basename(Dir.pwd)}.apib"
       end
 
       def browser
-        BROWSERS[@options[:browser]]  || nil
-      end
-
-      def api_host
-        @options[:api_host]
-      end
-
-      def port
-        @options[:port]
+        BROWSERS[@options.browser]  || nil
       end
 
       def rack_app(&block)
@@ -65,21 +59,21 @@ module Apiary
 
       def run_server
         app = self.rack_app do
-          self.query_apiary(api_host, apib_path)
+          self.query_apiary(@options.api_host, @options.path)
         end
 
-        Rack::Server.start(:Port => port, :app => app)
+        Rack::Server.start(:Port => @options.port, :app => app)
       end
 
-      def preview_path(apib_path)
-        basename = File.basename(apib_path)
+      def preview_path(path)
+        basename = File.basename(@options.path)
         "/tmp/#{basename}-preview.html"
       end
 
-      def query_apiary(host, apib_path)
+      def query_apiary(host, path)
         url  = "https://#{host}/blueprint/generate"
-        data = File.read(apib_path)
-        RestClient.post(url, data, @options[:headers])
+        data = File.read(path)
+        RestClient.post(url, data, @options.headers)
       end
 
       # TODO: add linux and windows systems
@@ -87,16 +81,16 @@ module Apiary
         exec "open #{browser_options} #{path}"
       end
 
-      def generate_static(apib_path)
-        File.open(preview_path(apib_path), "w") do |file|
-          file.write(query_apiary(api_host, apib_path))
+      def generate_static(path)
+        File.open(preview_path(path), "w") do |file|
+          file.write(query_apiary(@options.api_host, path))
           open_generated_page(file.path)
         end
       end
 
       private
         def browser_options
-          "-a #{BROWSERS[@options[:browser].to_sym]}" if @options[:browser]
+          "-a #{BROWSERS[@options.browser.to_sym]}" if @options.browser
         end
     end
   end

data/lib/apiary/version.rb

@@ -1,3 +1,3 @@
 module Apiary
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/okapi.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'rubygems'
+require "okapi/config"
+require "okapi/output"
+require "okapi/apiary_connector"
+require "okapi/resources"
+require "okapi/spec_parser"
+require "okapi/test"
+require "okapi/cli"
+require "okapi/help"
+
+module Okapi
+end

data/lib/okapi/apiary_connector.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+require 'rest_client'
+require 'json'
+
+module Apiary
+  module Okapi
+    class ApiaryConnector
+      attr_reader :apiary_url, :blueprint
+
+      def initialize(apiary_url, req_path, res_path)
+        @apiary_url = apiary_url
+        @req_path = req_path
+        @res_path  = res_path
+      end
+
+      def get_response(raw_resp, json_data, error, code)
+        { :resp => raw_resp,
+          :data => json_data ? json_data['requests'] : nil,
+          :status => json_data ? json_data['status'] : nil ,
+          :error => json_data ? json_data['error'] || error : error,
+          :code => code
+          }
+      end
+
+      def get_requests(resources, blueprint, all_resources = false, global_vars = {})
+        resources_list = []
+
+        resources.each() do |res|
+          resources_list << {
+            :resource =>  res['resource'],
+            :method =>  res['method'],
+            :params =>  res['params']
+          }
+        end
+
+        data = {
+          :resources => resources_list,
+          :blueprint => blueprint,
+          :all_resources => all_resources,
+          :global_vars => global_vars
+        }.to_json()
+        
+        begin
+          response = RestClient.post @apiary_url + @req_path, data, :content_type => :json, :accept => :json
+          get_response(response, JSON.parse(response.to_str), nil, response.code.to_i)
+        rescue RestClient::BadRequest, RestClient::InternalServerError  => e
+          begin
+            data = JSON.parse(e.http_body)
+            get_response(nil, JSON.parse(e.http_body), data['error'], e.http_code.to_i)
+          rescue
+            get_response(nil, nil, e.to_s, e.http_code.to_i)
+          end
+        rescue Exception => e
+          get_response(nil, nil, e.to_s, nil)
+        end
+
+      end
+
+      def get_results(resources, blueprint)
+        resources_list = []
+        resources.each() do |res|
+          resources_list << {
+            :request => {
+              :uri =>  res.uri,
+              :expandedUri => res.expanded_uri,
+              :method =>  res.method,
+              :headers =>  res.headers,
+              :body =>  res.body,
+            },
+            :response => {
+              :status =>  res.response.status,
+              :headers => res.response.headers ,
+              :body =>  res.response.body
+            }
+          }
+        end
+
+        data = {
+          :resources => resources_list,
+          :blueprint => blueprint
+        }.to_json()
+
+        begin
+          response = RestClient.post @apiary_url + @res_path, data, :content_type => :json, :accept => :json
+          get_response(response, JSON.parse(response.to_str), nil, response.code.to_i)
+        rescue RestClient::BadRequest, RestClient::InternalServerError  => e
+          begin
+            get_response(nil, JSON.parse(e.http_body), data['error'], e.http_code.to_i)
+          rescue
+            get_response(nil, nil, e.to_s, e.http_code.to_i)
+          end
+        rescue Exception => e
+          get_response(nil, nil, e.to_s, nil)
+        end
+      end
+    end
+  end
+end

data/lib/okapi/cli.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+require 'optparse'
+require 'yaml'
+
+module Apiary
+  module Okapi
+    class CLI
+
+      def initialize(args)
+        case args.first
+          when 'help'
+            Apiary::Okapi::Help.show
+            exit 0
+          when 'okapi'
+            Apiary::Okapi::Help.okapi
+            exit 0
+          else
+            parse_options!(args)
+            parse_config
+            @options[:blueprint]   ||= BLUEPRINT_PATH
+            @options[:test_spec]   ||= TEST_SPEC_PATHS
+            @options[:output]      ||= OUTPUT
+            @options[:test_url]    ||= TEST_URL
+            @options[:apiary_url]  ||= APIARY_URL
+
+            @options[:test_spec] ||= TEST_SPEC_PATHS.gsub(' ','').split(',')
+
+            if @options[:params]
+              puts "running with :"
+              p @options
+              puts "\n"
+            end
+
+            exit run
+        end    
+      end
+
+      def run
+        pass = true
+        @options[:test_spec].each { |spec|
+          pass = Apiary::Okapi::Test.new(@options[:blueprint], spec, @options[:test_url], @options[:output], @options[:apiary_url]).run()
+          }
+        if pass
+          0
+        else
+          1
+        end
+      end
+
+      def parse_config
+        begin
+          if tests = YAML.load_file(@options[:config_path])['tests']
+            @options[:test_url] ||= tests['host'] if tests['host']
+            @options[:test_spec] ||= tests['specs'] if tests['specs']
+          end
+        rescue Errno::ENOENT  => e          
+          puts "Config file (#{@options[:config_path]}) not accessible ... skiping"
+          puts "\n"
+        rescue Exception => e
+          puts "Config file (#{@options[:config_path]}) loading problem :#{e}"
+          puts "\n"
+          exit 1
+        end
+      end
+
+      def parse_options!(args)
+        @options = {}
+        options_parser = OptionParser.new do |opts|
+          opts.on("-c", "--config CONFIG",
+                  "path config file (default: " + CONFIG_PATH + " )") do |config|
+            @options[:config_path] = config
+          end
+
+          opts.on("-b", "--blueprint BLUEPRINT",
+                  "path to the blueprint (default: " + BLUEPRINT_PATH + " )") do |blueprint|            
+            @options[:blueprint] = blueprint
+          end
+
+          opts.on("-t","--test_spec TEST_SPEC",
+                  "comma separated paths to the test specifications (default: " + TEST_SPEC_PATHS + " )") do |test_spec|
+            @options[:test_spec] = test_spec
+          end
+
+          opts.on("-o","--output OUTPUT",
+                  "output format (default" + OUTPUT + ")") do |output|
+            @options[:output] = output
+          end
+
+          opts.on("-u","--test_url TEST_URL",
+                  "url to test (default" + TEST_URL + ")") do |test_url|
+            @options[:test_url] = test_url
+          end
+
+          opts.on("-a","--apiary APIARY",
+                  "apiary url  (default" + APIARY_URL + ")") do |apiary|
+            @options[:apiary_url] = apiary
+          end
+
+          opts.on("-p","--params [PARAMS]",
+                  "show parameters" ) do |params|
+            @options[:params] = true
+          end          
+        end
+
+        options_parser.parse!
+
+        @options[:config_path]  ||= CONFIG_PATH
+        @options[:test_spec] = @options[:test_spec].gsub(' ','').split(',') if @options[:test_spec]
+
+        @options
+
+      rescue OptionParser::InvalidOption => e
+        puts "\n"
+        puts e
+        Apiary::Okapi::Help.banner
+        puts "\n"
+        exit 1
+      end
+
+    end
+  end
+end

data/lib/okapi/config.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+module Apiary
+  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 Apiary
+  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 Apiary
+  module Okapi
+    class Output
+      def self.get(output,resources, error)
+        output = Apiary::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 Apiary
+  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

data/lib/okapi/test.rb

@@ -0,0 +1,141 @@
+# encoding: utf-8
+require 'rest_client'
+
+module Apiary
+  module Okapi
+    class Test
+      def initialize(blueprint_path, test_spec_path, test_url, output, apiary_url)
+        @blueprint_path = blueprint_path
+        @test_spec_path = test_spec_path
+        @test_url       = test_url
+        @output_format  = output
+        @apiary_url     = apiary_url
+        @req_path       = GET_REQUESTS_PATH
+        @res_path       = GET_RESULTS_PATH
+        @connector = Apiary::Okapi::ApiaryConnector.new(@apiary_url, @req_path, @res_path)
+        @proces_all_bp_resources = false
+        @output = []
+        @resources = []
+        @error = nil        
+      end
+
+      def run
+        begin
+          test()
+        rescue Exception => e
+          @resources = []
+          @error = e
+        end        
+        Apiary::Okapi::Output.get(@output_format, @resources, @error)
+      end
+
+      def test
+        prepare()
+        if not @resources.empty?
+          get_responses
+          evaluate
+        else
+          raise Exception, 'No resources provided'
+        end
+      end
+
+      def prepare
+        @resources = []
+        parser = get_test_spec_parser(@test_spec_path)
+        resources = parser.resources
+        counter = 0
+
+        resources.each { |res|
+          counter += 1
+          raise Exception, "Rresource not defined for item #{counter.to_d} in #{@test_spec_path}" unless res["resource"]
+          raise Exception, "Method not defined for resource #{res["resource"].to_s} in #{@test_spec_path}" unless res["method"]
+        }
+
+        @proces_all_bp_resources = parser.proces_all_bp_resources
+        data = get_requests_spec(resources, parser.global_vars)
+        
+        if data[:error] or data[:code] != 200
+          raise Exception, 'Can not get request data from Apiary: ' + data[:error] ? data[:error] : ''
+        end
+         
+        data[:data].each do |res|
+          raise Exception, 'Resource error "' + res['error'] + '" for resource "' + res["method"] + ' ' + res["uri"]  + '"' if res['error']
+          @resources << Apiary::Okapi::Resource.new(res["uri"], res["method"], res["params"], res["expandedUri"], res["headers"], res["body"])          
+        end
+
+        @resources      
+      end
+
+      def blueprint
+        @blueprint ||= parse_blueprint(@blueprint_path)
+      end
+
+      def get_responses
+        @resources.each { |resource|
+          params = {:method => resource.method, :url => @test_url + resource.expanded_uri['url'], :headers => resource.headers || {}}
+          begin            
+            response = RestClient::Request.execute(params)
+
+            raw_headers = response.raw_headers.inject({}) do |out, (key, value)|
+                            out[key] = %w{ set-cookie }.include?(key.downcase) ? value : value.first
+                            out
+                          end
+
+            resource.response =  Apiary::Okapi::Response.new(response.code, raw_headers, response.body)
+          rescue Exception => e
+            raise Exception, 'Can not get response for: ' + params.to_json + ' (' + e.to_s + ')'
+          end
+          }
+
+      end
+
+      def evaluate
+
+        data = @connector.get_results(@resources, blueprint)
+        if data[:error] or data[:code] != 200
+          raise Exception, 'Can not get evaluation data from apiary: ' + data[:error] ? data[:error] : ''
+        end
+        
+        data[:data].each { |validation|
+          @resources.each { |resource|
+            if validation['resource']['uri'] == resource.uri and validation['resource']['method'] == resource.method
+              resource.validation_result = Apiary::Okapi::ValidationResult.new()
+              resource.validation_result.error = validation['errors']
+              resource.validation_result.schema_res = validation["validations"]['reqSchemaValidations']
+              resource.validation_result.body_pass = !validation["validations"]['reqData']['body']['isDifferent']
+              resource.validation_result.body_diff = validation["validations"]['reqData']['body']['diff']
+              resource.validation_result.header_pass = !validation["validations"]['reqData']['headers']['isDifferent']
+              resource.validation_result.header_diff = validation["validations"]['reqData']['headers']['diff']
+
+              resource.response.validation_result = Apiary::Okapi::ValidationResult.new()
+              resource.response.validation_result.error = validation['errors']
+              resource.response.validation_result.schema_res = validation["validations"]['resSchemaValidations']
+              resource.response.validation_result.body_pass = !validation["validations"]['resData']['body']['isDifferent']
+              resource.response.validation_result.body_diff = validation["validations"]['resData']['body']['diff']
+              resource.response.validation_result.header_pass = !validation["validations"]['resData']['headers']['isDifferent']
+              resource.response.validation_result.header_diff = validation["validations"]['resData']['headers']['diff']
+            end
+
+          }
+        }
+      end      
+
+      def get_test_spec_parser(test_spec)
+        Apiary::Okapi::Parser.new(test_spec)                
+      end
+
+      def parse_blueprint(blueprint_path)
+        if not File.exist? blueprint_path
+          raise Exception, "Blueprint file '#{blueprint_path}' not found"
+        end
+        File.read(blueprint_path)
+      end
+
+      def get_requests_spec(resources, global_vars)
+        @connector.get_requests(resources, blueprint, @proces_all_bp_resources, global_vars)
+      end
+
+    end
+  end
+end
+

metadata

@@ -1,88 +1,112 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: apiaryio
-version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
-authors:
+authors: 
 - Apiary Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-05-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.7
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 6
+        - 7
         version: 1.6.7
-- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rack
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 4
+        - 1
         version: 1.4.1
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.4.1
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.11.0
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 11
+        - 0
         version: 2.11.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.2.1
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 8
+        - 2
+        - 1
         version: 0.8.2.1
+  type: :development
+  version_requirements: *id005
 description: Apiary.io CLI
-email:
+email: 
 - team@apiary.io
-executables:
+executables: 
 - apiary
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - Gemfile
@@ -120,36 +144,59 @@ files:
 - lib/apiary/command/runner.rb
 - lib/apiary/command/version.rb
 - lib/apiary/version.rb
+- lib/okapi.rb
+- lib/okapi/apiary_connector.rb
+- lib/okapi/cli.rb
+- lib/okapi/config.rb
+- lib/okapi/examples/apiary.apib
+- lib/okapi/examples/apiary.yaml
+- lib/okapi/examples/tests.spec
+- lib/okapi/examples/tests2.spec
+- lib/okapi/exceptions.rb
+- lib/okapi/help.rb
+- lib/okapi/okapi
+- lib/okapi/output.rb
+- lib/okapi/outputs/base.rb
+- lib/okapi/outputs/tap.rb
+- lib/okapi/resources.rb
+- lib/okapi/spec_parser.rb
+- lib/okapi/test.rb
 - spec/cli_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://apiary.io
-licenses:
+licenses: 
 - MIT
-post_install_message: This gem is a client for http://apiary.io. Apiary is in closed
-  beta version now, you need an invitation. If you don't have one, visit http://apiary.us2.list-manage.com/subscribe?u=b89934a238dcec9533f4a834a&id=08f2bdde55
-  to get on the waiting list!
+post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Apiary.io CLI
-test_files:
+test_files: 
 - spec/cli_spec.rb
 - spec/spec_helper.rb
-has_rdoc: