webpoke 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b980ca6a8f667b53abd42762d98796f5ff420d2
+  data.tar.gz: d21244eb1d3d4456d433b2d0a37deb8faea1359b
+SHA512:
+  metadata.gz: b48244af31f75d68687a26a65e2bf0b37e5ff5a7fb80175fca71931b32b72252213dea9cf1d241e4000c22af6c06935d992e0de589df2879cd940e95a6182225
+  data.tar.gz: bb4357cf189c738263f457936ffced676d9870df6598a0786588fa846a5f2a5d19989453e694c53ca585a730d43c2868255c0c4ba88e607c3451d28270df9b3f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csapi.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :release do
+  system "gem build webpoke.gemspec"
+end

data/bin/poke

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'webpoke'
+require 'optparse'
+
+options = {}
+
+file = ARGV[0]
+
+optparser = OptionParser.new do |opts|
+  opts.banner = "Usage: poke [options] file_with_tests"
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+  
+  options[:bootstrap] = false
+  opts.on( '-b file', '--bootstrap file', "Bootstrap file" ) do |file|
+    options[:bootstrap] = File.expand_path file
+  end
+  
+  options[:group] = []
+  opts.on( '-g group', '--group groups', Array, "Only run tests in group" ) do |group|
+    options[:group] = group
+  end
+  
+  options[:quiet] = false
+  opts.on('-q', '--quiet', 'Run tests and exit with status code') do |quiet|
+    options[:quiet] = true
+  end
+  
+  options[:doc] = false
+  opts.on('-d <file>', '--document <document>', "Generate documentation for test instead of running") do |file|
+    options[:doc] = File.expand_path file
+  end
+  
+  options[:format] = false
+  formats = Webpoke.formats
+  opts.on("-f [#{formats.join('|')}]", "--format [#{formats.join('|')}]", "Set the format to a desired output\n") do |format|
+    
+    if !formats.include?(format)
+      puts "<#{format}> is not a recognized format, try [#{formats.join(', ')}]"
+      exit
+    end
+    
+  end
+  
+  if !file
+    puts opts.help()
+    exit 255
+  end
+  
+end.parse!
+
+if options[:bootstrap]
+  require options[:bootstrap]
+end
+
+
+if (File.directory?(file))
+  Dir.glob(File.expand_path(file)+'/*.rb').each do |f|
+    require File.expand_path(f)
+  end
+elsif (File.file?(file))
+  require File.expand_path(file)
+end
+
+if options[:doc]
+  File.open(options[:doc], 'w+') do |f|
+    f << Webpoke.document(options[:group])
+  end
+  exit 0
+end
+
+Webpoke.run(options[:group])
+
+puts "\nTests: #{Webpoke.tested}, success: #{Webpoke.success}, errors: #{Webpoke.failed}";

data/lib/Webpoke/Class.rb

@@ -0,0 +1,10 @@
+class Class
+  
+  def mark_accessible (*args)
+    args.each do |arg|
+      self.class_eval("def #{arg} (val=nil); if (val) then @#{arg} = val; else @#{arg}; end end")
+      self.class_eval("def #{arg}=(val);@#{arg}=val;end") 
+    end
+  end
+  
+end

data/lib/Webpoke/Config.rb

@@ -0,0 +1,59 @@
+class Webpoke::Config
+  
+  mark_accessible :base, :headers, :parse, :on_failure, :beforeSend, :format
+  
+  @@valid_parse_types = ['json']
+  
+  def initialize(&block)
+    @base = '';
+    @headers = {}
+    @parse = {input:nil, output:nil}
+    
+    if (block_given?)
+      instance_eval(&block);
+    end
+    
+    @format = @format || 'stdout'
+    
+  end
+  
+  def on_failure(&block)
+    if (block_given?)
+      @on_failure = block
+    else
+      @on_failure
+    end
+  end
+  
+  def beforeSend callable=nil
+    if callable
+      raise new Webpoke::ConfigError("Can't register your beforeSend callable because, well, it isn't callable") if !callable.respond_to? :call
+      @beforeSend = callable
+    else 
+      @beforeSend
+    end
+  end
+  
+  def parse type=nil
+    if (type)
+      case type
+      when String
+        raise new Webpoke::ConfigError("I don't know how to parse [#{type}] responses yet :/") unless @@valid_parse_types.include? type
+        @parse = {
+          input: lambda {|d| JSON.parse(d, symbolyze_names: true)},
+          output: lambda {|d| d.to_json }
+        }
+      when Hash      
+        @parse = type
+      end
+    else
+      @parse
+    end
+    
+  end
+    
+  
+end
+
+class Webpoke::ConfigError < StandardError
+end

data/lib/Webpoke/Test.rb

@@ -0,0 +1,83 @@
+=begin rdoc
+  A test
+=end
+class Webpoke::Test
+  
+  mark_accessible :description, :group, :url, :method, :success, :query, :should_fail, :headers, :data
+  
+  def initialize(&block)
+    instance_eval(&block);
+    @group = @group || ''
+    @method = @method || 'get'
+    @headers = @headers || {}
+    
+  end
+  
+  
+  def default_success (code, body)
+    if @should_fail
+      return code > 399
+    else
+      return (200..202).include?(code)
+    end
+  end
+  
+  
+  def success (&block)
+    @success = block
+  end
+  
+=begin rdoc
+Returns the test description
+
+
+=end
+  def to_s
+    @description
+  end
+  
+=begin rdoc
+  Returns the test description definition (so that we can auto-generate documentation)
+=end  
+  def describe
+    
+    return {
+      description: @description,
+      url: @url,
+      method: @method
+    }
+    
+  end
+  
+  
+=begin rdoc
+  Run the test
+=end
+  def passed? (response, body)
+    
+    if !self.default_success(response, body)
+      return false
+    end
+    
+   
+    
+    if @success
+      begin
+        result = @success.call(response, body)
+      rescue Exception => e
+        result = false
+        Webpoke.log "Error while executing success for test".red
+        Webpoke.log e
+      end
+    else
+      result = self.default_success(response, body)
+    end
+    
+    return result
+    
+  end
+  
+end
+
+class Webpoke::TestError < StandardError
+end

data/lib/Webpoke/version.rb

@@ -0,0 +1,3 @@
+module Webpoke
+  VERSION = "0.0.3"
+end

data/lib/webpoke.rb

@@ -0,0 +1,172 @@
+#!/usr/bin/env ruby
+#encoding: utf-8
+#
+#
+# License
+#
+# DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE Version 2, December 2004
+# 
+# (C) 2012 Roberto Hidalgo un@rob.mx
+# 
+# Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long as the name is changed.
+# 
+# DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+# 
+# You just DO WHAT THE FUCK YOU WANT TO.
+
+
+class String
+  
+  def red
+    "\033[41m\033[37m#{self}\033[0m"
+  end
+  
+  def green
+    "\033[42m\033[37m#{self}\033[0m"
+  end
+  
+  def bold
+    "\033[1m#{self}\033[0m";
+  end
+  
+end
+
+module Webpoke
+  
+  require 'httparty'
+  require 'Webpoke/Class'
+  require 'Webpoke/Config'
+  require 'Webpoke/Test'
+  
+  $successes = 0;
+  $errors = 0;
+  $tested = 0;
+  $tests = [];
+  $log = ""
+  $config = nil
+  
+  # Adds a test to the queue
+  # @param block [Proc] the configuration for this test
+  def test(&block)
+    $tests << Test.new(&block)
+  end
+  
+  
+  def args_for_test(test)
+      
+    if (!$config)
+      $config = Webpoke::Config.new
+    end
+            
+    args = {
+      headers: $config.headers.merge(test.headers),
+    }
+    
+    if test.data
+      if $config.parse[:input]
+        args[:body] = config.parse[:input].call(test.data)
+      else
+        args[:data] = test.data
+      end
+    end
+    
+    args[:query] = test.query if test.query
+    
+    args
+  end
+  
+  # Configures the poking
+  # @param &block [Block] the configuration options
+  # (see #Webpoke::Config)
+  def config (&block)
+    $config = Webpoke::Config.new(&block)
+  end
+
+  
+  def run (group=nil)
+    
+    $tests.each do |test|
+      return if group && !test.group == group
+      $tested +=1
+      
+      fqu = if test.url.match(/^https?:\/\//i) then url; else $config.base+test.url; end
+      
+      args = args_for_test(test)
+      
+      $config.beforeSend(test.method, fqu, args) if $config.beforeSend
+      
+      log "#{$tested}: #{test.description}".bold
+      log "#{test.method.upcase}: #{test.url}...", false
+      begin
+        r = HTTParty.send(test.method, fqu, args)
+      rescue Exception => e
+        log 'FAIL:'.red
+        log e
+        $errors += 1;
+        next;
+      end
+            
+      begin
+        body = $config.parse[:ouput] ? $config.parse[:output].call(r.body) : r.body
+      rescue Exception => e
+        log "Parsing failure: ".red
+        log "\t#{e}"
+        log "Data:"
+        log "\t"+r.body
+        $errors += 1;
+        next;
+      end
+      
+      if test.passed?(r.code, body)
+        $successes +=1
+        log "OK!".green
+      else
+        log "FAIL!".red
+                
+        if $config.on_failure
+          log $config.on_failure.call(r.code, body)
+        end
+      end
+    end
+      
+  end
+  
+  
+  def log (message, newLine=true)
+    return true if $config.format != 'stdout'
+    $stdout << message
+    $stdout << "\n" if newLine
+  end
+  
+  def Webpoke.document(group)
+    
+    data = []
+    
+    $tests.each do |test|
+      return if group && !test.group == group
+      
+      data << test.describe
+      
+    end
+    
+    return data.to_json
+    
+  end
+  
+  def Webpoke.success
+    return $successes
+  end
+  
+  def Webpoke.failed
+    return $errors
+  end
+  
+  def Webpoke.tested
+    return $tested
+  end
+  
+  def Webpoke.formats
+    return ['json', 'html', 'stdout']
+  end
+  
+end

data/webpoke.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Webpoke/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "webpoke"
+  gem.version       = Webpoke::VERSION
+  gem.authors       = ["Roberto Hidalgo"]
+  gem.email         = ["un@rob.mx"]
+  gem.description   = "A very simple REST API tester"
+  gem.summary       = "I still have no idea what is this"
+  gem.homepage      = "https://github.com/unRob/webpoke"
+  gem.licenses      = ['WTFPL', 'GPLv2']
+  gem.has_rdoc      = true
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  
+  gem.add_runtime_dependency 'httparty'
+  
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: webpoke
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Roberto Hidalgo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A very simple REST API tester
+email:
+- un@rob.mx
+executables:
+- poke
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- bin/poke
+- lib/Webpoke/Class.rb
+- lib/Webpoke/Config.rb
+- lib/Webpoke/Test.rb
+- lib/Webpoke/version.rb
+- lib/webpoke.rb
+- webpoke.gemspec
+homepage: https://github.com/unRob/webpoke
+licenses:
+- WTFPL
+- GPLv2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: I still have no idea what is this
+test_files: []