kanoah_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7938f3bcc54c23d4f2e4b96508319e64038773d0
+  data.tar.gz: 04d70849e12414673a1abc10dfe1189767187c20
+SHA512:
+  metadata.gz: 49849bf9958262b0292a33089bbaa2bfa728af50a86f2bd94c96a22fbe77cd5077c0599723be0073944cc72c6b1d70ad13fac97f28a68e59ca9d9bd6050935fb
+  data.tar.gz: 18e1fe533b2418126adafea5e0f860dc0006bdcd0183be896e5a2371c56586eb79c8028b7136e4ac46d0b7a3521b6fc157d16b28b913d08506240a933e842a26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  Justin Commu <Justin.Commu@loblaw.ca>
+
+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,37 @@
+# Kanoah Ruby (API Wrapper)
+
+Welcome to kanoah_ruby, a ruby API wrapper for Kanoah to help you create formatters and interactions with Kanoah!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kanoah_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kanoah_ruby_
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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 tags, 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]/test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/client.rb

@@ -0,0 +1,32 @@
+module Kanoah
+  class Client
+    include HTTParty
+
+    include Kanoah::Services::Authentication
+    include Kanoah::Services::IssueLink
+    include Kanoah::Services::TestCase
+    include Kanoah::Services::TestPlan
+    include Kanoah::Services::TestResult
+    include Kanoah::Services::TestRun
+
+    default_options.update(verify: false)
+    format :json
+    attr_reader :environment, :test_run_id, :project
+
+
+    def initialize(options={})
+      self.class.base_uri options.fetch(:base_url) { Kanoah.config.base_url }
+      @environment = options.fetch(:environment)
+      @test_run_id = options.fetch(:test_run_id) { nil }
+      @project_id     = options.fetch(:project_id)
+      token = Base64.encode64(options.fetch(:username)+':'+options.fetch(:password))
+      set_access_token(token[0..-2])
+    end
+
+    def set_access_token(token)
+      @header = { "Authorization" => "Basic #{token}", "Content-Type" => "application/json"}
+    end
+
+  end
+end
+

data/lib/configuration.rb

@@ -0,0 +1,20 @@
+module Kanoah
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :base_url
+
+    def initialize
+      @base_url    = nil
+    end
+
+  end
+end

data/lib/kanoah_ruby.rb

@@ -0,0 +1,13 @@
+require 'httparty'
+require 'base64'
+
+require_relative 'configuration'
+
+require_relative 'services/authentication'
+require_relative 'services/issue_link'
+require_relative 'services/test_case'
+require_relative 'services/test_plan'
+require_relative 'services/test_result'
+require_relative 'services/test_run'
+
+require_relative 'client'

data/lib/services/authentication.rb

@@ -0,0 +1,13 @@
+module Kanoah
+  module Services
+    module Authentication
+
+      def login(username, password)
+        @response = self.class.post('/rest/auth/1/session', body: {'username' => username, 'password' => password}.to_json, headers: {"Content-Type" => "application/json"})
+        #set_access_token(@response['session']['name'] +'='+@response['session']['value'])
+        self
+      end
+
+    end
+  end
+end

data/lib/services/issue_link.rb

@@ -0,0 +1,12 @@
+module Kanoah
+  module Services
+    module IssueLink
+
+      def get_linked_tests(issue_key)
+        @response = self.class.get("/rest/kanoahtests/1.0/issuelink/#{issue_key}/testcases", headers: @header)
+        self
+      end
+
+    end
+  end
+end

data/lib/services/test_case.rb

@@ -0,0 +1,22 @@
+module Kanoah
+  module Services
+    module TestCase
+
+      def post_new_test_case(body)
+        @response = self.class.post("/rest/kanoahtests/1.0/testcase", body: body.to_json, headers: @header)
+        self
+      end
+
+      def get_test_case_details(test_case_key)
+        @response = self.class.get("/rest/kanoahtests/1.0/testcase/#{test_case_key}", headers: @header)
+        self
+      end
+
+      def search_test_cases(query_string)
+        @response = self.calss.get("/rest/kanoahtests/1.0/testcase/search", headers: @header, query: {query: query_string})
+        self
+      end
+
+    end
+  end
+end

data/lib/services/test_plan.rb

@@ -0,0 +1,12 @@
+module Kanoah
+  module Services
+    module TestPlan
+
+      def get_plan_details(test_plan_key)
+        @response = self.class.get("/rest/kanoahtests/1.0/testplan/#{test_plan_key}", headers: @header)
+        self
+      end
+
+    end
+  end
+end

data/lib/services/test_result.rb

@@ -0,0 +1,15 @@
+module Kanoah
+  module Services
+    module TestResult
+
+      def post_new_result(scenario)
+        @response = self.class.post("/rest/kanoahtests/1.0/testresult",
+                                    body: { 'projectKey' => @project_id, 'testCaseKey'=> scenario[:test_case] ,'status' => scenario[:status],
+                                            'environment' => @environment, 'comment' => scenario[:comment], 'executionTime' => scenario[:execution_time], 'scriptResults' => scenario[:script_results]}.to_json,
+                                    headers: @header)
+        self
+      end
+
+    end
+  end
+end

data/lib/services/test_run.rb

@@ -0,0 +1,29 @@
+module Kanoah
+  module Services
+    module TestRun
+
+      def post_new_test_run(body)
+        @response = self.class.post("/rest/kanoahtests/1.0/testrun", body: body.to_json, headers: @header)
+        self
+      end
+
+      def get_run_details(test_run_key)
+        @response = self.class.get("/rest/hkanoahtests/1.0/testrun/#{test_run_key}", headers: @header)
+        self
+      end
+
+      def post_new_result_to_run(scenario)
+        @response = self.class.post("/rest/kanoahtests/1.0/testrun/#{@test_run_id}/testcase/#{scenario[:test_case]}/testresult",
+                                    body: { 'status' => scenario[:status], 'environment' => @environment, 'comment' => scenario[:comment], 'executionTime' => scenario[:execution_time], 'scriptResults' => scenario[:script_results]}.to_json,
+                                    headers: @header)
+        self
+      end
+
+      def update_result_of_run(test_run_key, test_case_key, body)
+        @response = self.class.put("/rest/kanoahtests/1.0/testrun/#{test_run_key}/testcase/#{test_case_key}/testresult", body: body.to_json, headers: @header)
+        self
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: kanoah_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Automation Wizards
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+description: Use this library to interact with the Kanoah API in Ruby
+email:
+- Justin.Commu@loblaw.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/client.rb
+- lib/configuration.rb
+- lib/kanoah_ruby.rb
+- lib/services/authentication.rb
+- lib/services/issue_link.rb
+- lib/services/test_case.rb
+- lib/services/test_plan.rb
+- lib/services/test_result.rb
+- lib/services/test_run.rb
+homepage: https://loblawdigital.ca
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Kanoah API
+test_files: []