restflow 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    rake (10.0.3)
+    rdoc (3.12.1)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler (~> 1.8.4)
+  rdoc
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 simcap
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,124 @@
+= Restflow
+
+Simple DSL to assert REST services
+
+== Installation
+
+  $ gem install restflow
+
+== Usage
+
+Create a file that contains the sequences of REST calls and
+add assertions to test the payloads you get back. 
+
+Example with a file name sequence.rb:
+
+  base_url 'https://api.github.com'
+
+  sequence 'Retrieve info of a Github user' do
+    get 'users/simcap'
+    json['login'].should == "simcap"
+    status.should == 200
+  end
+
+  sequence 'Retrieve info of a Github repo' do
+    get 'users/simcap/repos'
+    json[0]['full_name'].should == "simcap/anagram-kata"
+    status.should == 200
+
+    get 'repos/simcap/anagram-kata'
+    json['name'].should == "anagram-kata"
+  end
+
+
+Then run on the file 
+
+  $ restflow sequence.rb
+
+A report file sequences-report.html will be generated in the current directory.
+
+=== Examples 
+
+  GET asserting response code
+
+    sequence 'List all users' do
+      get 'users'
+      status.should == 200
+    end
+
+    sequence 'Cannot find user' do
+      get 'users/3'
+      status.should == 404  
+    end
+
+  GET asserting json content
+
+    sequence 'List one users' do
+      get 'users/1'
+      json['firstname'].should == "John"
+      json['lastname'].should == "Doe"
+
+      get 'users/2'
+      json['firstname'].should == "Sue"
+      json['lastname'].should == "Helen"
+    end
+
+  POST inline post data
+
+    sequence 'Create new user' do
+      post 'users', <<-BODY
+        {"firstname":"James","lastname":"Bond"}
+      BODY
+      
+      get 'users/3'
+      status.should == 200 
+      json['firstname'].should == "James"
+      json['lastname'].should == "Bond"
+    end
+
+  POST post data from file 
+
+    sequence 'Create new user with body from file' do
+      post 'users', :file => "new_user.json"
+      
+      get 'users/4'
+      status.should == 200 
+      json['firstname'].should == "Bob"
+      json['lastname'].should == "Marley"
+    end
+
+  DELETE
+
+    sequence 'Delete users' do
+      delete 'users/3'
+      status.should == 200
+      get 'users/3'
+      status.should == 404 
+
+      delete 'users/4'
+      status.should == 200
+      get 'users/4'
+      status.should == 404 
+    end
+
+  Checking raw response content
+
+    sequence 'Error when creating' do
+      post 'users', <<-BODY
+        {"firstname":"James"}
+      BODY
+        
+      response.should =~ /lastname is missing/
+
+      post 'users', <<-BODY
+        {"lastname":"Bond"}
+      BODY
+
+      response.should =~ /firstname is missing/
+    end
+
+== Copyright
+
+Copyright (c) 2013 simcap. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "restflow"
+  gem.homepage = "http://github.com/simcap/restflow"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple DSL to assert REST services}
+  gem.description = %Q{Simple DSL to assert REST services}
+  gem.authors = ["simcap"]
+  gem.files.exclude "samples"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "restflow #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/restflow

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+if ARGV.empty?
+  puts "File is missing. Usage:\n $ restflow file"
+  exit
+end
+
+require_relative '../lib/restflow'
+
+sequences = Restflow::Sequences.new
+sequences.parse_flow_file(ARGV[0])
+

data/lib/restflow.rb

@@ -0,0 +1,6 @@
+require_relative 'restflow/sequence'
+require_relative 'restflow/report'
+require 'httparty'
+require 'nokogiri'
+require 'rspec'
+require 'json'

data/lib/restflow/report.rb

@@ -0,0 +1,49 @@
+module Restflow
+
+  module Report
+    
+    require 'builder'
+
+    def self.run(sequences)
+      report = File.new("sequences-report.html", "w")
+      b = Builder::XmlMarkup.new :target => report, :indent => 2
+      b.instruct!
+      b.html {
+        b.head { b.title("Sequences")}
+        b.style(self.css_content)
+        b.body {
+          sequences.each { |sequence|
+            b.section(:class => "sequence") {
+              b.h2(sequence.description)
+              sequence.responses.each { |response|
+                b.p(:class => "request"){
+                  b.span(response.request.http_method.to_s.split("::").last, :class => "verb")
+                  b.span(response.request.path, :class => "original-request")
+                  b.span(response.code, :class => "status")
+                }
+                b.code(response.body)           
+              }
+            }
+
+          }
+        }
+      }
+      report.close
+    end
+
+    private
+
+    def self.css_content
+      <<-CSS
+        body { }
+        .request { }
+        span.verb { font-weight: bold; text-transform: uppercase;}
+        span.original-request { text-align: center;}
+        span.status { font-weight: bold; float: right;}
+      CSS
+    end 
+
+  end  
+
+end
+

data/lib/restflow/sequence.rb

@@ -0,0 +1,94 @@
+module Restflow
+
+  class Sequences
+
+    def parse_flow_file(path)
+      @sequences = []
+      @execution_dir = File.dirname(path)
+      instance_eval(File.read(path), path)
+      Restflow::Report.run(@sequences)
+    end
+
+    def sequence(description, &block)
+      puts "Running < #{description} >"
+      @sequences << Sequence.new(@execution_dir, description , @base_url, &block)
+    end
+
+    def base_url(url)
+      @base_url = url
+    end
+
+  end
+
+  class Sequence
+
+    attr_reader :description, :responses
+
+    def initialize(execution_dir, description, base_url = nil, &block)
+      @responses = []
+      @execution_dir = execution_dir
+      @base_url = base_url if base_url
+      @description =  description
+      raise "Sequence block is empty!!" unless block
+      instance_eval &block
+    end
+
+    def base_url(url)
+      @base_url = url
+    end
+
+    def get(path)
+      @response = HTTParty.get("#{@base_url}/#{path}")
+      @responses << @response
+      @response
+    end
+
+    def post(path, data)
+      @response = send_post_data(:post, path, data)
+      @responses << @response
+      @response
+    end
+
+    def delete(path, data = nil)
+      @response = send_post_data(:delete, path, data)
+      @responses << @response
+      @response
+    end
+
+    def put(path, data)
+      @response = send_post_data(:put, path, data)
+      @responses << @response
+      @response
+    end
+
+    def response
+      @response.body
+    end
+
+    def html
+      Nokogiri::HTML(@response.body) 
+    end
+
+    def json
+      JSON.parse(@response.body) if @response.body
+    end
+
+    def status
+      @response.code
+    end
+
+    private
+
+    def send_post_data(verb, path, post_data)
+      if post_data.is_a?(Hash)
+        file_path = File.expand_path(post_data[:file], @execution_dir)
+        body = File.new(file_path).read
+      else
+        body = post_data
+      end
+      HTTParty.send(verb, "#{@base_url}/#{path}", :body => body)
+    end
+
+  end
+
+end

data/restflow.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "restflow"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["simcap"]
+  s.date = "2013-02-24"
+  s.description = "Simple DSL to assert REST services"
+  s.executables = ["restflow"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/restflow",
+    "lib/restflow.rb",
+    "lib/restflow/report.rb",
+    "lib/restflow/sequence.rb",
+    "restflow.gemspec",
+    "samples/github_calls.rb",
+    "samples/local_server.rb",
+    "samples/local_sinatra_calls.rb",
+    "samples/new_user.json",
+    "spec/restflow_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/simcap/restflow"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Simple DSL to assert REST services"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/samples/github_calls.rb

@@ -0,0 +1,16 @@
+base_url 'https://api.github.com'
+
+sequence 'Retrieve info of a Github user' do
+  get 'users/simcap'
+  json['login'].should == "simcap"
+  status.should == 200
+end
+
+sequence 'Retrieve info of a Github repo' do
+  get 'users/simcap/repos'
+  json[0]['full_name'].should == "simcap/anagram-kata"
+  status.should == 200
+
+  get 'repos/simcap/anagram-kata'
+  json['name'].should == "anagram-kata"
+end

data/samples/local_server.rb

@@ -0,0 +1,36 @@
+require 'sinatra'
+require 'json'
+
+class UsersWebApp < Sinatra::Base
+
+  USERS = { 1 => { "firstname" => "John", "lastname" => "Doe"},
+          2 => { "firstname" => "Sue", "lastname" => "Helen"}
+        }
+
+  get '/users/:id' do
+    user_id = params[:id].to_i
+    return status 404 unless USERS[user_id]
+    JSON.generate(USERS[user_id])
+  end
+
+  get '/users' do
+    JSON.generate(USERS)
+  end
+
+  post '/users' do
+    json_data = JSON.parse request.body.read
+    return "firstname is missing" unless json_data['firstname']
+    return "lastname is missing" unless json_data['lastname']
+    USERS[USERS.keys.length + 1] = json_data
+    status 200
+  end
+
+  delete '/users/:id' do
+    user_id = params[:id].to_i
+    return status 404 unless USERS[user_id]
+    USERS.delete(user_id)
+    status 200
+  end
+
+  run!
+end

data/samples/local_sinatra_calls.rb

@@ -0,0 +1,72 @@
+base_url 'http://localhost:4567'
+
+sequence 'List all users' do
+  get 'users'
+  json['1']['firstname'].should == "John"
+  json['2']['lastname'].should == "Helen"
+  status.should == 200
+end
+
+sequence 'List one users' do
+  get 'users/1'
+  json['firstname'].should == "John"
+  json['lastname'].should == "Doe"
+  status.should == 200
+
+  get 'users/2'
+  json['firstname'].should == "Sue"
+  json['lastname'].should == "Helen"
+  status.should == 200
+end
+
+sequence 'Cannot find user' do
+  get 'users/3'
+  status.should == 404  
+end
+
+sequence 'Create new user' do
+  post 'users', <<-BODY
+    {"firstname":"James","lastname":"Bond"}
+  BODY
+  
+  get 'users/3'
+  status.should == 200 
+  json['firstname'].should == "James"
+  json['lastname'].should == "Bond"
+end
+
+sequence 'Create new user with body from file' do
+  post 'users', :file => "new_user.json"
+  
+  get 'users/4'
+  status.should == 200 
+  json['firstname'].should == "Bob"
+  json['lastname'].should == "Marley"
+end
+
+sequence 'Delete users' do
+  delete 'users/3'
+  status.should == 200
+  get 'users/3'
+  status.should == 404 
+
+  delete 'users/4'
+  status.should == 200
+  get 'users/4'
+  status.should == 404 
+end
+
+sequence 'Error when creating' do
+  post 'users', <<-BODY
+    {"firstname":"James"}
+  BODY
+    
+  response.should =~ /lastname is missing/
+
+  post 'users', <<-BODY
+    {"lastname":"Bond"}
+  BODY
+
+  response.should =~ /firstname is missing/
+end
+

data/samples/new_user.json

@@ -0,0 +1 @@
+{"firstname":"Bob","lastname":"Marley"}

data/spec/restflow_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Restflow" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'restflow'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: restflow
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- simcap
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Simple DSL to assert REST services
+email: 
+executables:
+- restflow
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/restflow
+- lib/restflow.rb
+- lib/restflow/report.rb
+- lib/restflow/sequence.rb
+- restflow.gemspec
+- samples/github_calls.rb
+- samples/local_server.rb
+- samples/local_sinatra_calls.rb
+- samples/new_user.json
+- spec/restflow_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/simcap/restflow
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3599554636587573763
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple DSL to assert REST services
+test_files: []