cucumber-apis 0.10 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9c8d2d92ec42c065c7e394e9c65e626b5959dff28f762f8156823d5e4323a6c
-  data.tar.gz: 8132bcaa3fa74712acbdceb76a4dd41f33083c528911d0272281aed8db9874ca
+  metadata.gz: 4e87d8d57cf08d02cbc711ddf04c6639a59aaecf0780f5aa375ce81127545462
+  data.tar.gz: 5b637a0bb285ce98c9c0d2a699da0f320cd76d8dcdda8eabf4e4889935095003
 SHA512:
-  metadata.gz: 736b57acce0025754c451bfff7e928be4897a735afacedd9a5081018cdd4f61ebad11ca5e05a2d346f0ca184354e4009314d64cf8cf801ab43ee14acf8b026b1
-  data.tar.gz: d7f1a320b70f38b8b3952841819b73bcc8dbe506cf029831a67ea2cf2fc899abfeffd68016ee66a377828bb85c5f27d31489cda2b09f73fd862a7c5fb9b94b5c
+  metadata.gz: 3ee18f7f9bee4f1186796bc3aa01d39e2131781ec29d38248922b78e7fbbe8a196544ef1160edf497f010565f30805d3cb348bbae3d09d1640b9b62423091fa7
+  data.tar.gz: f3c87a52a414b24cb3066f1f37dae8e5fe4e04df6c0b26ecade0e89edf8b05bc01c33c2c442f44f818a5f0891315eb0ff8cacebff5e952e880515e5e24efd7b8

data/lib/cucumber-api/helpers.rb

@@ -0,0 +1,21 @@
+module CucumberApi
+  module Helpers
+    # Bind grabbed values into placeholders in given URL
+    # Ex: http://example.com?id={id} with {id => 1} becomes http://example.com?id=1
+    # @param url [String] parameterized URL with placeholders
+    # @return [String] binded URL or original URL if no placeholders
+    def resolve url
+      url.gsub!(/\{([a-zA-Z0-9_]+)\}/) do |s|
+        s.gsub!(/[\{\}]/, '')
+        if instance_variable_defined?("@#{s}")
+          CGI.escape %/#{instance_variable_get("@#{s}")}/
+        else
+          raise 'Did you forget to "grab" ' + s + '?'
+        end
+      end
+      url
+    end
+  end
+end
+
+World(CucumberApi::Helpers)

data/lib/cucumber-api/response.rb

@@ -0,0 +1,117 @@
+require 'json'
+require 'jsonpath'
+require 'rest-client'
+
+module CucumberApi
+
+  # Extension of {RestClient::Response} with support for JSON path traversal and validation
+  module Response
+    # Create a Response with JSON path support
+    # @param response [RestClient::Response] original response
+    # @return [Response] self
+    def self.create response
+      result = response
+      result.extend Response
+      result
+    end
+
+    # Check if given JSON path exists
+    # @param json_path [String] a valid JSON path expression
+    # @param json [String] optional JSON from which to check JSON path, default to response body
+    # @return [true, false] true if JSON path is valid and exists, false otherwise
+    def has json_path, json=nil
+      if json.nil?
+        json = JSON.parse body
+      end
+      not JsonPath.new(json_path).on(json).empty?
+    end
+
+    # Retrieve value of the first JSON element with given JSON path
+    # @param json_path [String] a valid JSON path expression
+    # @param json [String] optional JSON from which to apply JSON path, default to response body
+    # @return [Object] value of first retrieved JSON element in form of Ruby object
+    # @raise [Exception] if JSON path is invalid or no matching JSON element found
+    def get json_path, json=nil
+      if json.nil?
+        json = JSON.parse body
+      end
+      results = JsonPath.new(json_path).on(json)
+      if results.empty?
+        raise %/Expected json path '#{json_path}' not found\n#{to_json_s}/
+      end
+      results.first
+    end
+
+    # Retrieve value of the first JSON element with given JSON path as given type
+    # @param json_path [String] a valid JSON path expression
+    # @param type [String] required type, possible values are 'numeric', 'array', 'string', 'boolean', 'numeric_string'
+    # or 'object'
+    # @param json [String] optional JSON from which to apply JSON path, default to response body
+    # @return [Object] value of first retrieved JSON element in form of given type
+    # @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match
+    # required type
+    def get_as_type json_path, type, json=nil
+      value = get json_path, json
+      case type
+        when 'numeric'
+          valid = value.is_a? Numeric
+        when 'array'
+          valid = value.is_a? Array
+        when 'string'
+          valid = value.is_a? String
+        when 'boolean'
+          valid = !!value == value
+        when 'numeric_string'
+          valid = value.is_a?(Numeric) or value.is_a?(String)
+        when 'object'
+          valid = value.is_a? Hash
+        else
+          raise %/Invalid expected type '#{type}'/
+      end
+
+      unless valid
+        raise %/Expect '#{json_path}' as a '#{type}' but was '#{value.class}'\n#{to_json_s}/
+      end
+      value
+    end
+
+    # Retrieve value of the first JSON element with given JSON path as given type, with nil value allowed
+    # @param json_path [String] a valid JSON path expression
+    # @param type [String] required type, possible values are 'numeric', 'array', 'string', 'boolean', 'numeric_string'
+    # or 'object'
+    # @param json [String] optional JSON from which to apply JSON path, default to response body
+    # @return [Object] value of first retrieved JSON element in form of given type or nil
+    # @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match
+    # required type
+    def get_as_type_or_null json_path, type, json=nil
+      value = get json_path, json
+      value.nil? ? value : get_as_type(json_path, type, json)
+    end
+
+    # Retrieve value of the first JSON element with given JSON path as given type, and check for a given value
+    # @param json_path [String] a valid JSON path expression
+    # @param type [String] required type, possible values are 'numeric', 'string', 'boolean', or 'numeric_string'
+    # @param value [String] value to check for
+    # @param json [String] optional JSON from which to apply JSON path, default to response body
+    # @return [Object] value of first retrieved JSON element in form of given type or nil
+    # @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match
+    # required type or value
+    def get_as_type_and_check_value json_path, type, value, json=nil
+      v = get_as_type json_path, type, json
+      if value != v.to_s
+        raise %/Expect '#{json_path}' to be '#{value}' but was '#{v}'\n#{to_json_s}/
+      end
+    end
+
+    # Retrieve pretty JSON response for logging
+    # @return [String] pretty JSON response if verbose setting is true, empty string otherwise
+    def to_json_s
+      if ENV['cucumber_api_verbose'] == 'true'
+        JSON.pretty_generate(JSON.parse to_s)
+      else
+        ''
+      end
+    end
+    RestClient::Response.send(:include, self)
+  end
+end

data/lib/cucumber-api/steps.rb

@@ -0,0 +1,180 @@
+require 'cucumber-api/response'
+require 'cucumber-api/helpers'
+require 'rest-client'
+require 'json-schema'
+
+if ENV['cucumber_api_verbose'] == 'true'
+  RestClient.log = 'stdout'
+end
+
+$cache = {}
+
+Given(/^I clear the response cache$/) do
+  $cache = {}
+end
+
+Given(/^I send and accept JSON$/) do
+  steps %Q{
+    Given I send "application/json" and accept JSON
+  }
+end
+
+Given(/^I send "(.*?)" and accept JSON$/) do |content_type|
+  @headers = {
+      :Accept => 'application/json',
+      :'Content-Type' => %/#{content_type}/
+  }
+end
+
+Given(/^I add Headers:$/) do |params|
+  params.rows_hash.each do |key, value|
+    @headers[key.to_sym] = resolve(value)
+  end
+end
+
+When(/^I grab "([^"]+)"$/) do |k|
+  if @response.nil?
+    raise 'No response found.'
+  end
+
+  if k[0] == '$'
+    v = k
+  else
+    v = "$.#{k}"
+  end
+
+  k.gsub!(/[^0-9a-zA-Z_]/, '')
+  instance_variable_set("@#{k}", @response.get(v))
+end
+
+When(/^I grab "([^"]+)" as "([^"]+)"$/) do |k, v|
+  if @response.nil?
+    raise 'No response found.'
+  end
+
+  k = "$.#{k}" unless k[0] == '$'
+  instance_variable_set("@#{v}", @response.get(k))
+end
+
+When(/^I set JSON request body to '(.*?)'$/) do |body|
+  @body = JSON.parse body
+end
+
+When(/^I set JSON request body to:$/) do |body|
+  @body = JSON.dump(JSON.parse(body))
+end
+
+When(/^I set form request body to:$/) do |params|
+  @body = {}
+  params.rows_hash.each do |key, value|
+    p_value = value
+    @grabbed.each { |k, v| p_value = v if value == %/{#{k}}/ } unless @grabbed.nil?
+    p_value = File.new %-#{Dir.pwd}/#{p_value.sub 'file://', ''}- if %/#{p_value}/.start_with? "file://"
+    @body[%/#{key}/] = p_value
+  end
+end
+
+When(/^I set request body from "(.*?).(yml|json)"$/) do |filename, extension|
+  path = %-#{Dir.pwd}/#{filename}.#{extension}-
+  if File.file? path
+    case extension
+      when 'yml'
+        @body = YAML.load File.open(path)
+      when 'json'
+        @body = JSON.parse File.read(path)
+      else
+        raise %/Unsupported file type: '#{path}'/
+    end
+  else
+    raise %/File not found: '#{path}'/
+  end
+end
+
+When(/^I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)" with:$/) do |method, url, params|
+  unless params.hashes.empty?
+    query = params.hashes.first.map{|key, value| %/CGI.escape #{key}=#{value}/}.join("&")
+    url = url.include?('?') ? %/#{url}&#{query}/ : %/#{url}?#{query}/
+  end
+  steps %Q{
+      When I send a #{method} request to "#{url}"
+    }
+end
+
+When(/^I send a (GET|POST|PATCH|PUT|DELETE) request to "(.*?)"$/) do |method, url|
+  request_url = resolve(url)
+  if 'GET' == %/#{method}/ and $cache.has_key? %/#{request_url}/
+    @response = $cache[%/#{request_url}/]
+    @headers = nil
+    @body = nil
+    next
+  end
+
+  @headers = {} if @headers.nil?
+  begin
+    case method
+      when 'GET'
+        response = RestClient.get request_url, @headers
+      when 'POST'
+        response = RestClient.post request_url, @body, @headers
+      when 'PATCH'
+        response = RestClient.patch request_url, @body, @headers
+      when 'PUT'
+        response = RestClient.put request_url, @body, @headers
+      else
+        response = RestClient.delete request_url, @headers
+    end
+  rescue RestClient::Exception => e
+    response = e.response
+  end
+  @response = CucumberApi::Response.create response
+  @headers = nil
+  @body = nil
+  $cache[%/#{request_url}/] = @response if 'GET' == %/#{method}/
+end
+
+Then(/^the response status should be "(\d+)"$/) do |status_code|
+  raise %/Expect #{status_code} but was #{@response.code}/ if @response.code != status_code.to_i
+end
+
+Then(/^the JSON response should follow "(.*?)"$/) do |schema|
+  file_path = %-#{Dir.pwd}/#{schema}-
+  if File.file? file_path
+    begin
+      JSON::Validator.validate!(file_path, @response.to_s)
+    rescue JSON::Schema::ValidationError => e
+      raise JSON::Schema::ValidationError.new(%/#{$!.message}\n#{@response.to_json_s}/,
+                                              $!.fragments, $!.failed_attribute, $!.schema)
+    end
+  else
+    raise %/Schema not found: '#{file_path}'/
+  end
+end
+
+Then(/^the JSON response root should be (object|array)$/) do |type|
+  steps %Q{
+    Then the JSON response should have required key "$" of type #{type}
+  }
+end
+
+Then(/^the JSON response should have key "([^\"]*)"$/) do |json_path|
+  steps %Q{
+    Then the JSON response should have required key "#{json_path}" of type any
+  }
+end
+
+Then(/^the JSON response should have (required|optional) key "(.*?)" of type \
+(numeric|string|boolean|numeric_string|object|array|any)( or null)?$/) do |optionality, json_path, type, null_allowed|
+  next if optionality == 'optional' and not @response.has(json_path)  # if optional and no such key then skip
+  if 'any' == type
+    @response.get json_path
+  elsif null_allowed.nil?
+    @response.get_as_type json_path, type
+  else
+    @response.get_as_type_or_null json_path, type
+  end
+end
+
+Then(/^the JSON response should have "([^"]*)" of type \
+(numeric|string|boolean|numeric_string) and value "([^"]*)"$/) do |json_path, type, value|
+  @response.get_as_type_and_check_value json_path, type, resolve(value)
+end

data/lib/cucumber-api/version.rb

@@ -0,0 +1,3 @@
+module CucumberApi
+  VERSION = "0.12"
+end

data/lib/cucumber-api.rb

@@ -0,0 +1 @@
+require 'cucumber-api/steps'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-apis
 version: !ruby/object:Gem::Version
-  version: '0.10'
+  version: '0.12'
 platform: ruby
 authors:
 - Ha Duy Trung
@@ -29,22 +29,16 @@ dependencies:
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jsonpath
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +89,13 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/.DS_Store
+- lib/cucumber-api.rb
+- lib/cucumber-api/helpers.rb
+- lib/cucumber-api/response.rb
+- lib/cucumber-api/steps.rb
+- lib/cucumber-api/version.rb
 homepage: https://github.com/hidroh/cucumber-api
 licenses:
 - Apache-2.0