zephyr_ruby 0.1.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab2c9cf5c2090d39581ded7976db96f025eadf08cc8a33942874718006b3a9ed
-  data.tar.gz: b6819d1e26fab13612a43e494df417ee950986838145eb95a1124120ba057434
+  metadata.gz: 9a3b3bab61cc2f4029d887a6b628e0efba253fa675fed3bee61d4fbdb8b68911
+  data.tar.gz: 6718dd0d341673673b00ac9c0089eef7f2eecdd13202250b21d52d4115827b3a
 SHA512:
-  metadata.gz: 31bf85295413059989b186f46b8162bc77813b8f9b05bd54ec425e730240d1c7e935f781266828c4e759baaea9baed69ea34ffc0f47f7863c3206b501991558a
-  data.tar.gz: 46987d8457bb115a7ec239b1da56ced4bcd2150f676d33fb878b8fe44362ff01e21193ac0f5589329086ebce124a84efb994a8c3edd58558dfc5469699193831
+  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
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zephyr_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -14,19 +12,16 @@ 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'
 
 @client = ZephyrRuby::Client.new('YOUR_API_KEY')
-
-puts @client.list_test_cases
 ```
 
-## Links to Zephyr Scale REST API Documentation
-- [Overview](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#section/Introduction)
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/zephyr_ruby/client.rb

@@ -4,6 +4,7 @@ require_relative 'resource/automations'
 require_relative 'resource/environments'
 require_relative 'resource/folders'
 require_relative 'resource/healthcheck'
+require_relative 'resource/issue_links'
 require_relative 'resource/links'
 require_relative 'resource/priorities'
 require_relative 'resource/projects'
@@ -15,6 +16,7 @@ require_relative 'resource/test_plans'
 require_relative 'connection'
 
 require 'faraday'
+require 'faraday/multipart'
 require 'json'
 
 module ZephyrRuby
@@ -24,6 +26,7 @@ module ZephyrRuby
     include ZephyrRuby::Client::Resource::Environments
     include ZephyrRuby::Client::Resource::Folders
     include ZephyrRuby::Client::Resource::HealthCheck
+    include ZephyrRuby::Client::Resource::IssueLinks
     include ZephyrRuby::Client::Resource::Links
     include ZephyrRuby::Client::Resource::Priorities
     include ZephyrRuby::Client::Resource::Projects
@@ -37,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

@@ -24,6 +24,26 @@ module ZephyrRuby
         def create_test_execution_link(test_execution_id, body)
           post "/testexecutions/#{test_execution_id}/links/issues", body
         end
+
+        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.1.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.1.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Chris Davis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-26 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +76,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -99,7 +100,9 @@ files:
 - lib/zephyr_ruby/resource/test_plans.rb
 - lib/zephyr_ruby/version.rb
 - sig/zephyr_ruby.rbs
-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: {}
@@ -111,14 +114,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Zephyr REST API Client for Ruby