zgen_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 221a72ebc9e46b8dbbc1541c0db356f7ce5c0eaca31cce44f79fa9349d45b5b9
+  data.tar.gz: 95ceb308e1705c49f5c91113a8386871f58ecd2c7a2b1fda255598e08cf33f3a
+SHA512:
+  metadata.gz: 59ceaa64ae5763155d058b762fc7755e58ef403ece1e632dc394393109ec43a6a29c61dc44f7d18f5173b568a8b758726dbe16ca75320cb4c4bb5dfa6a14735d
+  data.tar.gz: 594a2ec36f7ac2bdabab0bd18d9364bc701643654d330ead12553bd75c09c66e5f0302c4c6e9764606c6af85cbe3f4de67fecad12e15f42cf18fa19f19ab0eb1

data/lib/zgen_client.rb

@@ -0,0 +1,85 @@
+require "rest-client"
+require "jwt"
+require "uri"
+require "json"
+require "time"
+
+# The Zgen Client main class
+class ZgenClient
+  @@users_login_endpoint = "users/login"
+  @@test_execution_endpoint = "v1/Incident/TestCaseExecution"
+  @@attachment_endpoint = "v1/Incident/attachment"
+
+  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
+    @user_email = user_email
+    @user_password = user_password
+    @user_customer_name = user_customer_name
+    @proxy_host = proxy_host
+    @proxy_port = proxy_port
+    @timeout = timeout
+    @is_https = is_https
+    @token = nil
+    @user_id = nil
+  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
+  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" }
+    body = { projectID: project_id, executionCode: execution_code, cycleStartDate: cycle_start_date, testResultOK: test_result_ok, testerUserID: @user_id, testResultComments: test_result_comments, date: date, tags: tags, incidentID: incident_id, status: status, statusDate: status_date }.to_json
+    response = RestClient.post(url, body, headers)
+    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
+  # @return OpenStruct
+  def post_attachment(test_result_id:, evidence:)
+    url = "#{build_base_url()}/#{@@attachment_endpoint}"
+    headers = { :Authorization => "Bearer #{get_token()}" }
+    body = { :file => evidence, :TestResultID => test_result_id }
+    response = RestClient.post(url, body, headers)
+    JSON.parse(response.body, object_class: OpenStruct)
+  end
+
+  private
+
+  def build_base_url()
+    if @is_https
+      base_url = URI::HTTPS.build(:host => @api_host, :port => @api_port).to_s
+    elsif base_url = URI::HTTP.build(:host => @api_host, :port => @api_port).to_s
+    end
+    "#{base_url}/api"
+  end
+
+  def get_token()
+    if @token == nil || is_token_expired()
+      url = "#{build_base_url()}/#{@@users_login_endpoint}"
+      body = { email: @user_email, password: @user_password }.to_json
+      response = RestClient.post(url, body, params: { customerName: @user_customer_name }, content_type: "application/json")
+      @user_id = JSON.parse(response.body)["userID"]
+      @token = JSON.parse(response.body)["token"]
+    else
+      @token
+    end
+  end
+
+  def is_token_expired()
+    payload, header = JWT.decode @token, nil, false
+    Time.at(payload["exp"]) < Time.now
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: zgen_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Guilherme Silva Sousa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: The REST Client for ZGen/Knooly
+email: guilherme.sousa@keeggo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zgen_client.rb
+homepage: https://rubygems.org/gems/zgen_client
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: ZGen Client
+test_files: []