zephyr_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab2c9cf5c2090d39581ded7976db96f025eadf08cc8a33942874718006b3a9ed
+  data.tar.gz: b6819d1e26fab13612a43e494df417ee950986838145eb95a1124120ba057434
+SHA512:
+  metadata.gz: 31bf85295413059989b186f46b8162bc77813b8f9b05bd54ec425e730240d1c7e935f781266828c4e759baaea9baed69ea34ffc0f47f7863c3206b501991558a
+  data.tar.gz: 46987d8457bb115a7ec239b1da56ced4bcd2150f676d33fb878b8fe44362ff01e21193ac0f5589329086ebce124a84efb994a8c3edd58558dfc5469699193831

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-11-24
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zephyr_ruby.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rubocop'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Chris Davis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# 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:
+
+    $ bundle add zephyr_ruby
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install zephyr_ruby
+
+## Usage
+
+This gem provides access to the Zephyr Scale REST API.
+
+```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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zephyr_ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/lib/zephyr_ruby/client.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'resource/automations'
+require_relative 'resource/environments'
+require_relative 'resource/folders'
+require_relative 'resource/healthcheck'
+require_relative 'resource/links'
+require_relative 'resource/priorities'
+require_relative 'resource/projects'
+require_relative 'resource/statuses'
+require_relative 'resource/test_cases'
+require_relative 'resource/test_cycles'
+require_relative 'resource/test_executions'
+require_relative 'resource/test_plans'
+require_relative 'connection'
+
+require 'faraday'
+require 'json'
+
+module ZephyrRuby
+  # Client provides methods for interacting with all zephyr scale endpoints
+  class Client
+    include ZephyrRuby::Client::Resource::Automations
+    include ZephyrRuby::Client::Resource::Environments
+    include ZephyrRuby::Client::Resource::Folders
+    include ZephyrRuby::Client::Resource::HealthCheck
+    include ZephyrRuby::Client::Resource::Links
+    include ZephyrRuby::Client::Resource::Priorities
+    include ZephyrRuby::Client::Resource::Projects
+    include ZephyrRuby::Client::Resource::Statuses
+    include ZephyrRuby::Client::Resource::TestCases
+    include ZephyrRuby::Client::Resource::TestCycles
+    include ZephyrRuby::Client::Resource::TestExecutions
+    include ZephyrRuby::Client::Resource::TestPlans
+    include ZephyrRuby::Connection
+
+    def initialize(api_token)
+      @base_url = 'https://api.zephyrscale.smartbear.com/v2'
+      @api_token = api_token
+      @client = Faraday.new(@base_url, builder: build_middleware)
+      @headers = {
+        'Authorization' => "Bearer #{@api_token}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    attr_reader :base_url
+
+    def request(method, path, params, headers = @headers)
+      path = URI.parse("#{@base_url}#{path}").normalize.to_s
+      @client.send(method, path, params, headers)
+    end
+
+    def build_middleware
+      Faraday::RackBuilder.new do |builder|
+        builder.response :json
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/connection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  # Connection provides the base functionality for interacting with APIs using
+  # get, post, put, and delete operations.
+  module Connection
+    def get(path, params = {})
+      request :get, path, params
+    end
+
+    def post(path, body)
+      body = body.to_json if body.is_a?(Hash)
+      request :post, path, body
+    end
+
+    def put(path, body)
+      body = body.to_json if body.is_a?(Hash)
+      request :put, path, body
+    end
+
+    def delete(path, params = {})
+      request :delete, path, params
+    end
+  end
+end

data/lib/zephyr_ruby/resource/automations.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Automations
+      module Automations
+        def create_automation_custom(body)
+          post '/automations/executions/custom', body
+        end
+
+        def create_automation_cucumber(body)
+          post '/automations/executions/cucumber', body
+        end
+
+        def create_automation_junit(body)
+          post '/automations/executions/junit', body
+        end
+
+        def get_zip_file(params = {})
+          get '/automations/testcases', params
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/environments.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Environments
+      module Environments
+        def list_environments(params = {})
+          get '/environments', params
+        end
+
+        def get_environment(environment_id)
+          get "/environments/#{environment_id}"
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/folders.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Folders
+      module Folders
+        def create_folder(body)
+          post '/folders', body
+        end
+
+        def get_folder(folder_id)
+          get "/folders/#{folder_id}"
+        end
+
+        def list_folders(params = {})
+          get '/folders', params
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/healthcheck.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to API Health
+      module HealthCheck
+        def healthcheck_status
+          get '/healthcheck'
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/issue_links.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Issue Links
+      module IssueLinks
+        def get_issuelinks_testplans(issue_key)
+          get "/issuelinks/#{issue_key}/testplans"
+        end
+
+        def get_issuelinks_testcases(issue_key)
+          get "/issuelinks/#{issue_key}/testcases"
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/links.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Links
+      module Links
+        def delete_link(link_id)
+          delete "/links/#{link_id}"
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/priorities.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Priorities
+      module Priorities
+        def list_priorities(params = {})
+          get '/priorities', params
+        end
+
+        def create_priority(body)
+          post '/priorities', body
+        end
+
+        def get_priority(priority_id)
+          get "/priorities/#{priority_id}"
+        end
+
+        def update_priority(priority_id, params = {})
+          put "/priorities/#{priority_id}", params
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/projects.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Projects
+      module Projects
+        def list_projects(params = {})
+          get '/projects', params
+        end
+
+        def get_project(project_id)
+          get "/projects/#{project_id}"
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/statuses.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Statuses
+      module Statuses
+        def list_statuses(params = {})
+          get '/statuses', params
+        end
+
+        def create_status(body)
+          post '/statuses', body
+        end
+
+        def get_status(status_id)
+          get "/statuses/#{status_id}"
+        end
+
+        def update_status(status_id, params = {})
+          put "/statuses/#{status_id}", params
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/test_cases.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Test Cases
+      module TestCases
+        def create_testcase(body)
+          post '/testcases', body
+        end
+
+        def list_testcases(params = {})
+          get '/testcases', params
+        end
+
+        def get_testcase(testcase_key)
+          get "/testcases/#{testcase_key}"
+        end
+
+        def update_testcase(testcase_key, params = {})
+          put "/testcases/#{testcase_key}", params
+        end
+
+        def get_testcase_links(testcase_key)
+          get "/testcases/#{testcase_key}/links"
+        end
+
+        def create_testcase_issue_link(testcase_key, body)
+          post "/testcases/#{testcase_key}/links/issues", body
+        end
+
+        def create_testcase_web_link(testcase_key, body)
+          post "/testcases/#{testcase_key}/links/weblinks", body
+        end
+
+        def list_testcase_versions(testcase_key, params = {})
+          get "/testcases/#{testcase_key}/versions", params
+        end
+
+        def get_testcase_version(testcase_key)
+          get "/testcases/#{testcase_key}/version"
+        end
+
+        def get_testcase_testscript(testcase_key)
+          get "/testcases/#{testcase_key}/testscript"
+        end
+
+        def create_testcase_testscript(testcase_key, body)
+          post "/testcases/#{testcase_key}/testscript", body
+        end
+
+        def get_testcase_teststeps(testcase_key, params = {})
+          get "/testcases/#{testcase_key}/teststeps", params
+        end
+
+        def create_testcase_teststeps(testcase_key, body)
+          post "/testcases/#{testcase_key}/teststeps", body
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/test_cycles.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Test Cycles
+      module TestCycles
+        def create_testcycle(body)
+          post '/testcycles', body
+        end
+
+        def get_testcycle(testcycle_id)
+          get "/testcycles/#{testcycle_id}"
+        end
+
+        def update_testcycle(testcycle_id, params = {})
+          put "/testcycles/#{testcycle_id}", params
+        end
+
+        def list_testcycles(params = {})
+          get '/testcycles', params
+        end
+
+        def get_testcycle_links(testcycle_id)
+          get "/testcycles/#{testcycle_id}/links"
+        end
+
+        def create_testcycle_issue_link(testcycle_id, body)
+          post "/testcycles/#{testcycle_id}/links/issues", body
+        end
+
+        def create_testcycle_web_link(testcycle_id, body)
+          post "/testcycles/#{testcycle_id}/links/weblinks", body
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/test_executions.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Test Executions
+      module TestExecutions
+        def create_test_execution(body)
+          post '/testexecutions', body
+        end
+
+        def list_test_executions(params = {})
+          get '/testexecutions', params
+        end
+
+        def get_test_execution(test_execution_id, params = {})
+          get "/testexecutions/#{test_execution_id}", params
+        end
+
+        def get_test_execution_links(test_execution_id)
+          get "/testexecutions/#{test_execution_id}/links"
+        end
+
+        def create_test_execution_link(test_execution_id, body)
+          post "/testexecutions/#{test_execution_id}/links/issues", body
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/resource/test_plans.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ZephyrRuby
+  class Client
+    module Resource
+      # Operations related to Test Plans
+      module TestPlans
+        def create_testplan(body)
+          post '/testplans', body
+        end
+
+        def get_testplan(testplan_id)
+          get "/testplans/#{testplan_id}"
+        end
+
+        def list_testplans(params = {})
+          get '/testplans', params
+        end
+
+        def create_testplan_weblink(testplan_id, body)
+          post "/testplans/#{testplan_id}/links/weblinks", body
+        end
+
+        def create_testplan_issuelink(testplan_id, body)
+          post "/testplans/#{testplan_id}/links/issuelink", body
+        end
+
+        def create_testplan_testcycle_link(testplan_id, body)
+          post "/testplans/#{testplan_id}/links/testcycles", body
+        end
+      end
+    end
+  end
+end

data/lib/zephyr_ruby/version.rb

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

data/lib/zephyr_ruby.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'zephyr_ruby/client'
+require_relative 'zephyr_ruby/version'
+
+module ZephyrRuby
+  class Error < StandardError; end
+end

data/sig/zephyr_ruby.rbs

@@ -0,0 +1,4 @@
+module ZephyrRuby
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: zephyr_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Davis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+description: Allows users to use Zephyr's REST API
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zephyr_ruby.rb
+- lib/zephyr_ruby/client.rb
+- lib/zephyr_ruby/connection.rb
+- lib/zephyr_ruby/resource/automations.rb
+- lib/zephyr_ruby/resource/environments.rb
+- lib/zephyr_ruby/resource/folders.rb
+- lib/zephyr_ruby/resource/healthcheck.rb
+- lib/zephyr_ruby/resource/issue_links.rb
+- lib/zephyr_ruby/resource/links.rb
+- lib/zephyr_ruby/resource/priorities.rb
+- lib/zephyr_ruby/resource/projects.rb
+- lib/zephyr_ruby/resource/statuses.rb
+- lib/zephyr_ruby/resource/test_cases.rb
+- lib/zephyr_ruby/resource/test_cycles.rb
+- lib/zephyr_ruby/resource/test_executions.rb
+- lib/zephyr_ruby/resource/test_plans.rb
+- lib/zephyr_ruby/version.rb
+- sig/zephyr_ruby.rbs
+homepage: https://github.com/chrisdavis180/zephyr_ruby
+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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Zephyr REST API Client for Ruby
+test_files: []