http_baseline 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1d502502a3e40a4e37ea2de44c208703d4c457a
+  data.tar.gz: 0e1b7fc0fe7dbea7217d1921e94f0941b2282e32
+SHA512:
+  metadata.gz: b9abdf2f661b21114e8a5c02c4c5978aadcb74df3ad919a5c6d072222270093e60c6d66c6ef03a4c31d1feb25126da561632e519b99e16334a88e073ab988e1e
+  data.tar.gz: 2eafae1ccdd1e727e74cf00afd74ad24c44fbebc6d791e651b6ba64c3f551ed809c1a823d5540c688a67fafb0e4ab3a4c03eb84b44731965fd9c1dfbfd190567

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+rspec.xml

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 rlishtaba
+
+MIT License
+
+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.md

@@ -0,0 +1,60 @@
+# HTTP
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'http'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install http
+
+## Usage in terms of Cucumber
+
+Here is :
+
+### Steps examples for HTTP headers:
+
+    Given I set headers:
+     |Set-Cookie| my secret cookie |
+
+    Given I send and accept JSON
+
+    Given I send and accept XML
+
+    Given I send and accept HTML
+
+    Given the HTTP response should have header "Set-Cookie" with value "server side secret cookie"
+
+    Given the HTTP response should have headers:
+     | Accept | text/xml |
+
+    Given the JSON response should have default headers
+
+
+### Steps to handle requests or responses:
+
+     Given I send a :put request to "/open"
+
+     Given I send a :put request to "/open" with the following:
+       |timeout| 15 |
+
+     Then the response status should be "404"
+
+     And the JSON response should have "$..Message" with the text "Invalid communication setting"
+
+     And the JSON response should have "$..Message" with the regexp "Invalid communication setting.+?"
+
+     And the XML response should have "Message" with the text "Invalid communication setting"
+
+     Then show me the response
+
+     Then show me the headers
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = '--format RspecJunitFormatter  --out rspec.xml --tag ~online'
+  t.verbose    = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
+  t.profile = 'default'
+end
+
+task :default => [:spec, :cucumber]

data/cucumber.yml

@@ -0,0 +1,7 @@
+<%
+defaults = ['--require', 'features/support', '--require', 'features/step_definitions', 'features'].join(' ')
+%>
+
+ruby_1_9: <%= defaults %>
+ruby_2_0: <%= defaults %>
+default: <%= defaults %>

data/features/step_definitions/generic/debugging_steps.rb

@@ -0,0 +1,34 @@
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#   * show me the response
+#
+Then /^show me the response$/ do
+  $stdout.puts '------------- show me the response ------------- '
+
+  if @response.headers['Content-Type'] =~ /json/
+    $stdout.puts JSON.pretty_generate(@response.body)
+  elsif @response.headers['Content-Type'] =~ /xml/
+    $stdout.puts Nokogiri::XML(@response.body.to_s)
+  else
+    $stdout.puts @response.headers.to_hash
+    $stdout.puts @response.body
+  end
+
+  $stdout.puts '------------- end of show me the response ------ '
+end
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#   * show me the headers
+#
+Then /^show me the headers/ do
+  $stdout.puts '------------- show me the headers ------------- '
+
+  $stdout.puts JSON.pretty_generate @response.headers
+
+  $stdout.puts '------------- end of show me the headers ------ '
+end

data/features/step_definitions/generic/header_steps.rb

@@ -0,0 +1,56 @@
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#  * I set headers:
+#    | Content-Type | application/json |
+#    | X-roam-auth  | token            |
+#
+Given /^I set headers:$/ do |headers|
+  headers.rows_hash.each { |k, v| connection.add_header k, v }
+end
+
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#  * I send and accept JSON
+#  * I send and accept XML
+#  * I send and accept HTML
+#
+Given /^I send and accept (XML|JSON|HTML)$/ do |type|
+  case type
+    when 'XML', 'JSON'
+      connection.add_header 'Accept', "application/#{type.downcase}"
+      connection.add_header 'Content-Type', "application/#{type.downcase}"
+    when 'HTML'
+      connection.add_header 'Accept', 'text/html'
+    else
+      nil
+  end
+end
+
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#  * the HttpBaseline response should have headers:
+#    | Accept | text/xml |
+#
+Then /^the HttpBaseline response should have headers:$/ do |table|
+  hashed = table.rows_hash
+
+  hashed.each_pair do |key, expected|
+
+    actual = @response.headers[key.downcase]
+
+    if self.respond_to?(:should)
+      actual.should == expected
+    else
+      assert_equal actual, expected
+    end
+  end
+
+end

data/features/step_definitions/generic/request_steps.rb

@@ -0,0 +1,69 @@
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example
+#
+#    *  I send a :get request to "/user/login" with the following:
+#        | userId   | user     |
+#        | password | password |
+#
+When /^I send a :(get|post|put|delete) request (?:for|to) "([^"]*)"(?: with the following:)?$/ do |*args|
+  request_type = args.shift
+  path         = args.shift
+  input        = args.shift
+  request_opts = {}
+
+  unless input.nil?
+    if input.class == Cucumber::Ast::Table # table
+      request_opts.merge!(input.rows_hash)
+    else # lines
+      request_opts.merge!(input)
+    end
+  end
+
+  request_opts.each do |key, value|
+    if value =~ /\@default_(token|user|password)/
+      request_opts[key] = HttpBaseline.config.comm.http.send($1)
+    end
+  end
+
+  transmit(request_type, path, request_opts)
+end
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#   * I send Form Data via :post request to "/user/changePassword" with the following:
+#      | userId      | user            |
+#      | oldPassword | fibonacci_123   |
+#      | newPassword | fibonacci_12358 |
+#
+#
+Given /^I send Form Data via :(post|put) request (?:for|to) "([^"]*)" with the following:$/ do |request_type, path, raw_table|
+  request_opts = sub_to_default_credentials(raw_table.rows_hash.dup)
+
+  step 'I set headers:', table('| Content-Type | application/x-www-form-urlencoded |')
+
+  transmit(request_type, path, request_opts.to_query)
+end
+
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#   * I send Form Data via :post request to "/user/changePassword" with the following raw body:
+#      """
+#       {
+#         "hello": "world"
+#       }
+#      """
+When /^I send a :(post|put) request (?:for|to) "([^"]*)" with the following raw body:$/ do |*args|
+  request_type = args.shift
+  path         = args.shift
+  body         = args.shift
+
+  set_headers_by(body.content_type)
+
+  transmit(request_type, path, body.lines.to_a.join("\n").dup)
+end

data/features/step_definitions/generic/response_steps.rb

@@ -0,0 +1,133 @@
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#   * the response code should be "404"
+#
+Then /^the response (code|status) should be "([^"]*)"$/ do |_, code|
+  if self.respond_to? :should
+    @response.status.should == code.to_i
+  else
+    assert_equal code, @response.code
+  end
+end
+
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#   * the JSON response should have "userId" matching with "[a-zA-Z0-9_-]{3,50}"
+#
+Then /^the JSON response should (not)?\s?have "([^"]*)" matching with "([^"]*)"$/ do |*options|
+  negative      = options.shift
+  json_path     = options.shift
+  regexp_string = options.shift
+  regexp        = Regexp.compile("^#{regexp_string}$", Regexp::IGNORECASE)
+  raw_json      = @response.body
+  results       = JsonPath.new(json_path).on(raw_json).to_a.map(&:to_s)
+
+  if !negative.nil?
+    results.first.should_not =~ regexp
+  else
+    results.first.should =~ regexp
+  end
+
+end
+
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#   * the JSON response should have "errCode" with the text "SYSTEM_ERROR"
+#
+Then /^the JSON response should (not)?\s?have "([^"]*)" with the text "([^"]*)"$/ do |negative, json_path, text|
+  json    = @response.body
+  results = JsonPath.new(json_path).on(json).to_a.map(&:to_s)
+
+  if self.respond_to?(:should)
+    if negative.nil?
+      results.should include(text)
+    else
+      results.should_not include(text)
+    end
+  else
+    if negative.nil?
+      assert results.include?(text)
+    else
+      assert !results.include?(text)
+    end
+  end
+end
+
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#   * the XML response should have "errCode" with the text "SYSTEM_ERROR"
+#
+Then /^the XML response should have "([^"]*)" with the text "([^"]*)"$/ do |xpath, text|
+  parsed_response = Nokogiri::XML(@response.body.to_s)
+  elements        = parsed_response.xpath(xpath)
+  if self.respond_to?(:should)
+    elements.should_not be_empty, "could not find #{xpath} in:\n#{@response.body.to_s}"
+    elements.find { |e| e.text == text }.should_not be_nil, "found elements but could not find #{text} in:\n#{elements.inspect}"
+  else
+    assert !elements.empty?, "could not find #{xpath} in:\n#{@response.body.to_s}"
+    assert elements.find { |e| e.text == text }, "found elements but could not find #{text} in:\n#{elements.inspect}"
+  end
+end
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+#   * the JSON response should match:
+#   """
+#   {
+#      "tspUser": {
+#          "address": {
+#              "address1": "aaa",
+#              "address2": "bbb",
+#              "address3": "ccc",
+#              "city": "Boston",
+#              "country": "US",
+#              "fullAddress": "fullAddress",
+#              "id": "909",
+#              "postal": "200231",
+#              "state": "MA"
+#             }
+#        }
+#   }
+#   """
+#
+Then 'the JSON response should match:' do |json|
+  expected = JSON.parse(json)
+  actual   = @response.body
+
+  if self.respond_to?(:should)
+    actual.should == expected
+  else
+    assert_equal actual, response
+  end
+end
+
+
+# * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
+#
+# Example:
+#
+# * the JSON response should have "address" node with a elements counter matching to "10"
+#
+#
+Then /^the JSON response should have "([^"]*)" node with a elements counter matching to "(\d+)"$/ do |json_path, length|
+  json    = @response.body
+  results = JsonPath.new(json_path).on(json)
+  if self.respond_to?(:should)
+    results.length.should == length.to_i
+  else
+    assert_equal length.to_i, results.length
+  end
+end

data/features/step_definitions/generic/user_story_steps.rb

@@ -0,0 +1,11 @@
+Given /^I am logged in with the following credentials:$/ do |raw_table|
+  step 'I send a :get request to "/user/login" with the following:', raw_table
+  step 'the JSON response should have "status" with the text "success"'
+end
+
+Given /^I am logged in$/ do
+  login_to_web_service
+  step 'the response code should be "200"'
+  step 'the JSON response should have "status" with the text "success"'
+end
+

data/features/step_definitions/internal_test_steps.rb

@@ -0,0 +1,42 @@
+When /^I perform the following steps?:$/ do |step_strings|
+  steps = step_strings.split("\n")
+  steps.each { |step_string| step step_string.strip }
+end
+
+Then /^the response should equal:$/ do |response_body|
+  @response.body.should eq(response_body)
+end
+
+When /^I perform the following step with table:$/ do |step_definition|
+  lines       = step_definition.split("\n")
+  step_string = lines.shift.strip
+
+  raw = lines.map do |line|
+    line.squish.gsub(/^\|/, '').gsub(/\|$/, '').squish.split("|").map(&:squish)
+  end
+
+  step step_string.strip, table(raw)
+end
+
+When /^I perform the following step with string:$/ do |step_definition|
+  lines       = step_definition.split("\n")
+  step_string = lines.shift
+
+  param_string = lines.join("\n")
+
+  step step_string.strip, param_string
+end
+
+Then /^the request headers should be:$/ do |headers|
+  headers_hash = headers.rows_hash
+  request '/'
+  @stack.env.slice(*headers_hash.keys).values.should eq(headers_hash.values)
+end
+
+Then /^I should be authenticated$/ do
+  @response.env["HTTP_AUTHORIZATION"].should eq("Basic #{Base64.encode64("roman:lishtaba")}")
+end
+
+Then /^I should be digest authenticated$/ do
+  @response.env["HTTP_AUTHORIZATION"].starts_with?("Digest ").should be_true
+end

data/features/support/env.rb

@@ -0,0 +1,3 @@
+require 'bundler'
+require 'bundler/setup'
+require 'http_baseline'

data/http_baseline.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http_baseline/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'http_baseline'
+  spec.version     = HttpBaseline::VERSION
+  spec.authors     = ['Roman Lishtaba']
+  spec.email       = %w(roman@lishtaba.com)
+  spec.description = %q{Baseline library}
+  spec.summary     = %q{Baseline library for automation}
+  spec.homepage    = 'https://github.com/rlishtaba'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(env lib)
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'rspec'
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'builder'
+  spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'jsonpath'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'addressable'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'hashie'
+
+end

data/lib/ext_core/array.rb

@@ -0,0 +1,10 @@
+class Array
+  # Converts an array into a string suitable for use as a URL query string,
+  # using the given +key+ as the param name.
+  #
+  #   ['Ruby', 'coding'].to_query('hobbies') # => "hobbies%5B%5D=Ruby&hobbies%5B%5D=coding"
+  def to_query(key)
+    prefix = "#{key}[]"
+    collect { |value| value.to_query(prefix) }.join '&'
+  end
+end

data/lib/ext_core/hash.rb

@@ -0,0 +1,3 @@
+class Hash
+  alias_method :to_query, :to_param
+end

data/lib/ext_core/object.rb

@@ -0,0 +1,9 @@
+class Object
+  # Converts an object into a string suitable for use as a URL query string, using the given <tt>key</tt> as the
+  # param name.
+  #
+  # Note: This method is defined as a default implementation for all Objects for Hash#to_query to work.
+  def to_query(key)
+    "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+  end
+end

data/lib/ext_core/query.rb

@@ -0,0 +1,58 @@
+class Object
+  # Alias of <tt>to_s</tt>.
+  def to_param
+    to_s
+  end
+end
+
+class NilClass
+  # Returns +self+.
+  def to_param
+    self
+  end
+end
+
+class TrueClass
+  # Returns +self+.
+  def to_param
+    self
+  end
+end
+
+class FalseClass
+  # Returns +self+.
+  def to_param
+    self
+  end
+end
+
+class Array
+  # Calls <tt>to_param</tt> on all its elements and joins the result with
+  # slashes. This is used by <tt>url_for</tt> in Action Pack.
+  def to_param
+    collect { |e| e.to_param }.join '/'
+  end
+end
+
+class Hash
+  # Returns a string representation of the receiver suitable for use as a URL
+  # query string:
+  #
+  #   {name: 'David', nationality: 'Danish'}.to_param
+  #   # => "name=David&nationality=Danish"
+  #
+  # An optional namespace can be passed to enclose the param names:
+  #
+  #   {name: 'David', nationality: 'Danish'}.to_param('user')
+  #   # => "user[name]=David&user[nationality]=Danish"
+  #
+  # The string pairs "key=value" that conform the query string
+  # are sorted lexicographically in ascending order.
+  #
+  # This method is also aliased as +to_query+.
+  def to_param(namespace = nil)
+    collect do |key, value|
+      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+    end.sort * '&'
+  end
+end