zgen_client 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d866687367e9374c56f191a7f410d645a89ab43a5697561af50f9ee8e40f1ca
-  data.tar.gz: 7d14715cb85e5487aee2a5226aca370a578fe89aa0fbe36dc99f27e58ace2527
+  metadata.gz: 2dfa9dea47569861d4490e658cb09e2b67292d79db6560dfe28039b512a43901
+  data.tar.gz: 33178f3e0492fd2c87aed34390444676cc1dde0ffac693f84474f276581e2ea6
 SHA512:
-  metadata.gz: 3bbb1d476c77c40d4aa774ffcd8aa41a3ae531e40dfb1b163803d1e92f67d6c8f80dc7c9f95b5778abdb488885beb2aba374f2b67927395baacd6a7bb06ae012
-  data.tar.gz: d27d5af08e97c24505415ca5b0ba466bf0d962dca6c64ddf1978069c0155dd52e9b01e2f8a82ce28f67a8ffdbce63cbc561f21e87925a55d70c76a242d2c22a3
+  metadata.gz: 0f778a6dc0679b3fcd6cdc067997f43920c57ca3a55f6c48a4c3547d254309aa8f235c990bdcfabdda374e86ff18ea0933d417cdb37004a7f3b3c40195a5f458
+  data.tar.gz: bbfa857b4985070d03bb872cf6af0e44514002bc2fc2e6d31bfe7ebf28d6e532c6ab75b279be42662a8786ca23b266fcc80aa46ac3cc217179da820e649a910d

data/lib/zgen_client.rb

@@ -4,12 +4,23 @@ require "uri"
 require "json"
 require "time"
 
-# The Zgen Client main class
+# The Zgen Client main class.
 class ZgenClient
   @@users_login_endpoint = "users/login"
   @@test_execution_endpoint = "v1/Incident/TestCaseExecution"
   @@attachment_endpoint = "v1/Incident/attachment"
 
+  # Returns a new instance of ZgenClient.
+  #
+  # @param api_host [String] The host of the Knooly API such as IP address like 192.168.0.1 or knooly{-clientname}.keeggo.com.
+  # @param api_port [Integer] The API port per example 80 (default http port) or 443 (default https port).
+  # @param user_email [String] The user e-mail used to authenticate on API.
+  # @param user_password [String] The user password used to authenticate on API.
+  # @param user_customer_name [String] The customer name that is associated with the +user_email+.
+  # @param proxy_host [String] Pass the value of the proxy IP address if there is a proxy between you and the API. (Not required)
+  # @param proxy_port [Integer] The proxy port like 8080. (Not required)
+  # @param timeout [Integer] The amount of time in seconds for the client to read, write and connect to the API before timing out. (Not required)
+  # @param is_https [true, false] true, if the API address URL starts with https, otherwise false. (Not required)
   def initialize(api_host:, api_port:, user_email:, user_password:, user_customer_name:, proxy_host: nil, proxy_port: nil, timeout: 30, is_https: false)
     @api_host = api_host
     @api_port = api_port
@@ -25,17 +36,18 @@ class ZgenClient
   end
 
   # Create a test case result with the information passed from a test case.
-  # @param project_id [Integer] the project id
-  # @param execution_code [String] the execution code
-  # @param cycle_start_date [String] The initial date of the project cycle
-  # @param test_result_ok [true, false] true if the test passed
-  # @param date [String] Date of test execution. Format: 2022-02-09 00:00:00
-  # @param test_result_comments [String] Comments to assign to test result
-  # @param tags [Array<String>] List of tags
-  # @param incident_id [Integer] Incident id
-  # @param status [String] Status
-  # @param status_date [String] Status date
-  # @return [String] Test result id
+  #
+  # @param project_id [Integer] The project id is generated when a project is registered in Knooly. For more information access +Help Knooly > Projetos > Criando um projeto de teste+ on Knooly documentation.
+  # @param execution_code [String] The execution code assigned to the scenario. This field is used in automated test integration and is available in scenario name. For more information access +Help Knooly > Projetos > Adicionando cobertura ao projeto+ on Knooly documentation.
+  # @param cycle_start_date [String] The initial date of the project cycle. It can be obtained from Knooly. For more information access +Help Knooly > Projetos > Definindo os ciclos de execução+ on Knooly documentation.
+  # @param test_result_ok [true, false] True if the scenario execution result was passed, otherwise false.
+  # @param date [String] Date of scenario test execution (generated in runtime). Format: 2022-02-09 00:00:00.
+  # @param test_result_comments [String] Comments to assign to test result. (Not required)
+  # @param tags [Array<String>] List of tags. (Not required)
+  # @param incident_id [Integer] Incident id. (Not required)
+  # @param status [String] Status. (Not required)
+  # @param status_date [String] Status date. (Not required)
+  # @return [String] Test result id.
   def post_test_execution(project_id:, execution_code:, cycle_start_date:, test_result_ok:, date:, test_result_comments: "", tags: [], incident_id: nil, status: nil, status_date: nil)
     url = "#{build_base_url()}/#{@@test_execution_endpoint}"
     headers = { :Authorization => "Bearer #{get_token()}", content_type: "application/json" }
@@ -44,9 +56,10 @@ class ZgenClient
     JSON.parse(response.body)["testResultID"]
   end
 
-  # An attachment is persisted to the result of a test case.
-  # @param test_result_id [String] Test result id
-  # @param evidence [File] Evidence file
+  # Send an attachment as the evidence of a test execution result that was previosly saved using {#post_test_execution}.
+  #
+  # @param test_result_id [String] Test result id returned from the method {#post_test_execution}
+  # @param evidence [File] The attachment file to send. It can be an image, pdf or video file per example.
   # @return [String] Attachment id
   def post_attachment(test_result_id:, evidence:)
     url = "#{build_base_url()}/#{@@attachment_endpoint}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zgen_client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Guilherme Silva Sousa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Zgen Client