zephyr_ruby 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55a66aab079225aab9ce400e88f67007c5f2eacdceaff6cecfbb3456c4f2f678
-  data.tar.gz: 4fb99ddb69c4c3225a5300dbf27e0d28331d1597c9b52d4ef05507f4db2747b9
+  metadata.gz: 9a3b3bab61cc2f4029d887a6b628e0efba253fa675fed3bee61d4fbdb8b68911
+  data.tar.gz: 6718dd0d341673673b00ac9c0089eef7f2eecdd13202250b21d52d4115827b3a
 SHA512:
-  metadata.gz: 4a958eb629c36f117c3ad6b9fba8103a96719a6280242ae29ecc1fcc761e9c0d9379de2793920bfb2d56ffa91c3776b4d8b3773a61c48cfd36822186b51bbe3b
-  data.tar.gz: 5cba67d702ef5829fecc9a4a3ebb5adcc8eb7086dba2bddcc20b77690f961e646e0e62b67b359cb97452cd8752c71df870ce4cca04520a21a043e79de0e0ba22
+  metadata.gz: 0a0a806a2d95fa89f4cb074dbbc1bdfd12e0c7f04eb83f0f5a36734d084f62f427000e6513da7775653be66c395872aa5a689371062040d17a0b3e67892da83d
+  data.tar.gz: e6335fd4cb30b53b0be7fea62c08211392b7d9c6a8afec71fbba80106a987861faad286a2f6510df72e0d0d9ad3e07c8f2601179ed8e2618c943fb37f5e4dd69

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/MethodLength:
+  Max: 13
+
+AllCops:
+    NewCops: disable
+    TargetRubyVersion: 3.0

data/README.md

@@ -1,7 +1,5 @@
 # ZephyrRuby
 
-[Zephyr REST API Documentation](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#section/Introduction)
-
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -14,7 +12,9 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-This gem provides access to the Zephyr Scale REST API.
+To get started all you need to do is set your zephyr API access token and instantiate the client.
+
+For API endpoint usage see the official REST API documentation [here](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#section/Introduction).
 
 ```ruby
 require 'zephyr_ruby'

data/lib/zephyr_ruby/client.rb

@@ -16,6 +16,7 @@ require_relative 'resource/test_plans'
 require_relative 'connection'
 
 require 'faraday'
+require 'faraday/multipart'
 require 'json'
 
 module ZephyrRuby
@@ -39,7 +40,11 @@ module ZephyrRuby
     def initialize(api_token)
       @base_url = 'https://api.zephyrscale.smartbear.com/v2'
       @api_token = api_token
-      @client = Faraday.new(@base_url, builder: build_middleware)
+      @client = Faraday.new(@base_url) do |f|
+        f.request :multipart
+        f.request :url_encoded
+        f.adapter Faraday.default_adapter
+      end
       @headers = {
         'Authorization' => "Bearer #{@api_token}",
         'Content-Type' => 'application/json'

data/lib/zephyr_ruby/connection.rb

@@ -8,8 +8,21 @@ module ZephyrRuby
       request :get, path, params
     end
 
-    def post(path, body)
-      body = body.to_json if body.is_a?(Hash)
+    def post(path, body, file_path = nil)
+      if file_path
+        mime_type = case File.extname(file_path).downcase
+                    when '.json' then 'application/json'
+                    when '.xml'  then 'application/xml'
+                    when '.zip'  then 'application/zip'
+                    else 'application/octet-stream'
+                    end
+
+        file = Faraday::UploadIO.new(file_path, mime_type)
+        body = { file: file }.merge(body) if body.is_a?(Hash)
+      elsif body.is_a?(Hash)
+        body = body.to_json
+      end
+
       request :post, path, body
     end
 

data/lib/zephyr_ruby/resource/automations.rb

@@ -5,16 +5,16 @@ module ZephyrRuby
     module Resource
       # Operations related to Automations
       module Automations
-        def create_automation_custom(body)
-          post '/automations/executions/custom', body
+        def create_automation_custom(body, file_path = nil)
+          post '/automations/executions/custom', body, file_path
         end
 
-        def create_automation_cucumber(body)
-          post '/automations/executions/cucumber', body
+        def create_automation_cucumber(body, file_path = nil)
+          post '/automations/executions/cucumber', body, file_path
         end
 
-        def create_automation_junit(body)
-          post '/automations/executions/junit', body
+        def create_automation_junit(body, file_path = nil)
+          post '/automations/executions/junit', body, file_path
         end
 
         def get_zip_file(params = {})

data/lib/zephyr_ruby/resource/test_executions.rb

@@ -28,6 +28,22 @@ module ZephyrRuby
         def update_test_execution(test_execution_id, body)
           put "/testexecutions/#{test_execution_id}", body
         end
+
+        def get_test_steps(test_execution_id)
+          get "/testexecutions/#{test_execution_id}/teststeps"
+        end
+
+        def update_test_steps(test_execution_id, body)
+          put "/testexecutions/#{test_execution_id}/teststeps", body
+        end
+
+        def sync_test_execution(test_execution_id)
+          post "/testexecutions/#{test_execution_id}/teststeps/sync"
+        end
+
+        def create_test_execution_issue_link(test_execution_id, body)
+          post "/testexecutions/#{test_execution_id}/links/issues", body
+        end
       end
     end
   end

data/lib/zephyr_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZephyrRuby
-  VERSION = '0.4.0'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zephyr_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Chris Davis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -76,6 +76,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -99,8 +100,9 @@ files:
 - lib/zephyr_ruby/resource/test_plans.rb
 - lib/zephyr_ruby/version.rb
 - sig/zephyr_ruby.rbs
-- zephyr_ruby-0.3.0.gem
-homepage: https://github.com/chrisdavis180/zephyr_ruby
+- zephyr_ruby-0.4.0.gem
+- zephyr_ruby-0.5.0.gem
+homepage: https://github.com/cdavis-personal/zephyr_ruby
 licenses:
 - MIT
 metadata: {}
@@ -112,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="