tl-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35f3e1f23777fbfbed8b65ccde8d9b44917b0042
+  data.tar.gz: b672a89cdea34c058e6298e23d577938b82775f8
+SHA512:
+  metadata.gz: '08a5b786251df496409bb58feab0ec0b9fff2d3f6ae9c50b2b716423963b76ae3e3411829be042bf7176207702fa39b903f0afdf73538eb4d14ae1251ba64db9'
+  data.tar.gz: e50041fdbac747d6962bfe848b4915eae15d8b14793c47fdbe7b297ead7c66f6f40e5ad7aada850c339bcc45cb718d06dc20bcfa1d9f4a90256f3d5b557a7b8f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tl-api-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Emma Chen
+
+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,41 @@
+# Tl::Api::Client
+
+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/tl/api/client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tl-api-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tl-api-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 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]/tl-api-client.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tl/api/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/testlink/client.rb

@@ -0,0 +1,229 @@
+require "testlink/client/version"
+require "xmlrpc/client"
+
+module Testlink
+  module Client
+
+    def self.new uri, key
+      klass = const_get("TestlinkAPIClient")
+      klass.new uri, key
+    end
+
+    class TestlinkAPIClient
+      attr_accessor :uri, :key
+
+      def initialize uri, key
+        @key = key
+        @uri = get_api_uri uri
+      end
+
+
+      def get_api_uri uri
+        uri + "/lib/api/xmlrpc/v1/xmlrpc.php"
+      end
+
+
+      def get_result method, input = {}
+        connection = XMLRPC::Client.new_from_uri @uri
+        input["devKey"] = @key
+
+        result = connection.call2 method, input
+        if result[0]
+          if result[1][0].class == {}.class and result[1][0].has_key? "message"
+            warn result[1][0]["message"]
+          else
+            result[1]
+          end
+        else
+          raise MethodCallFailed, "Method call to XMLRPC API failed."
+        end
+      end
+
+
+      def get_latest_build_for_test_plan tplanid
+
+        input = {"testplanid" => tplanid }
+        get_result "tl.getLatestBuildForTestPlan", input
+      end
+      
+
+      def get_last_execution_result_by_tcid tplanid, tcid
+
+        input = { "testplanid" => tplanid,
+                  "testcaseid" => tcid }
+        get_result "tl.getLastExecutionResult", input
+      end
+
+
+      def get_projects
+        
+       get_result "tl.getProjects" 
+      end
+
+
+      def get_project_test_plans projectid
+
+        input = { "testprojectid" => projectid }
+        get_result "tl.getProjectTestPlans", input
+      end
+
+
+      def get_test_case_keywords tcid = nil, tcexternalid = nil
+
+        input = { "testcaseid" => tcid,
+                  "testcaseexternalid" => tcexternalid }
+        get_result "tl.getTestCaseKeywords", input
+      end
+
+      
+      def get_test_case_keywords_by_tcid tcid
+        get_test_case_keywords tcid
+      end
+
+      
+      def get_test_case_keywords_by_tcexternalid tcexternalid
+        get_test_case_keywords nil, tcexternalid
+      end
+
+
+      def get_test_project_by_name tprojectname
+
+        input = { "testprojectname" => tprojectname }
+        get_result "tl.getTestProjectByName", input
+      end
+
+      
+      def get_test_plan_by_name tprojectname, tplanname
+
+        input = { "testprojectname" => tprojectname,
+                  "testplanname" => tplanname }
+        get_result "tl.getTestPlanByName", input
+      end
+
+
+      def get_test_suites_for_test_plan tplanid
+
+        input = { "testplanid" => tplanid }
+        get_result "tl.getTestSuitesForTestPlan", input
+      end
+
+
+      def get_test_cases_for_test_plan tplanid, buildid = nil, platformid = nil, testcaseid = nil, keywordid = nil, keywords = nil, executed = nil, assignedto = nil, executestatus = nil, executiontype = nil, getstepinfo = false, details = nil
+
+        input = { "testplanid" => tplanid, 
+                  "buildid" => buildid,
+                  "platformid" => platformid,
+                  "testcaseid" => testcaseid,
+                  "keywordid" => keywordid,
+                  "keywords" => keywords,
+                  "executed" => executed,
+                  "assignedto" => assignedto,
+                  "executestatus" => executestatus,
+                  "executiontype" => executiontype,
+                  "getstepinfo" => getstepinfo,
+                  "details" => details }
+        get_result "tl.getTestCasesForTestPlan", input
+      end
+
+
+      def get_test_suites_for_test_suite tsuiteid
+
+        input = { "testsuiteid" => tsuiteid }
+        get_result "tl.getTestSuitesForTestSuite", input
+      end
+
+
+      def get_test_case_id_by_name tcasename, tsuitename = nil, tprojectname = nil, tcasepathname = nil
+
+        input = { "testcasename" => tcasename,
+                  "testsuitename" => tsuitename,
+                  "testprojectname" => tprojectname,
+                  "testcasepathanme" => tcasepathname }
+        get_result "tl.getTestCaseIDByName", input
+      end
+
+
+      def get_first_level_test_suites_for_test_project tprojectid
+
+        input = {"testprojectid" => tprojectid }
+        get_result "tl.getFirstLevelTestSuitesForTestProject", input
+      end
+
+
+      def get_test_case tcid = nil, tcexternalid = nil
+
+        input = { "testcaseid" => tcid,
+                  "testcaseexternalid" => tcexternalid }
+        get_result "tl.getTestCase", input
+      end
+
+
+      def get_test_case_by_tcid tcid
+
+        get_test_case tcid
+      end
+
+
+      def get_test_case_by_tcexternalid tcexternalid
+
+        get_test_case nil, tcexternalid
+      end
+
+
+      def get_test_suite_by_id tsuiteid
+
+        input =  { "testsuiteid" => tsuiteid }
+        get_result "tl.getTestSuiteByID", input
+      end
+
+
+      def get_user_by_id userid
+
+        input =  { "userid" => userid }
+        get_result "tl.getUserByID", input
+      end
+
+
+      def update_test_case tcid, version = nil, testcasename = nil, summary = nil, preconditions = nil, steps = nil, importance = nil, executiontype = nil. status = nil, estimatedexecduration = nil, user = nil
+
+        input = { "testcaseid" => tcid,
+                  "version" => version,
+                  "testcasename" => testcasename,
+                  "summary" => summary,
+                  "preconditions" => preconditions,
+                  "steps" => steps,
+                  "importance" => importance,
+                  "executiontype" => executiontype,
+                  "status" => status,
+                  "estimatedexecduration" => estimatedexecduration,
+                  "user" => user }
+        get_result "tl.updateTestCase", input
+      end
+
+
+      def set_test_case_execution_type tcid, version, tprojectid, executiontype
+
+       input = { "testcaseid" => tcid,
+                 "version" => version,
+                 "testprojectid" => tprojectid,
+                 "executiontype" => executiontype }
+      get_result "tl.setTestCaseExecutionType", input 
+      end
+
+
+      def add_testcase_keywords keywords
+
+        # keywords is a map key: testcaseexternalid, values: array of keyword name
+        input = { "keywords" => keywords }
+        get_result "tl.addTestCaseKeywords", input
+      end
+
+
+      def remove_test_case_keywords keywords
+
+        input = { "keywords" => keywords }
+        get_result "tl.removeTestCaseKeywords", input
+      end
+    end
+  end
+end

data/lib/testlink/client/tl-api-cli.rb

@@ -0,0 +1,29 @@
+require "xmlrpc/client"
+
+class TestlinkAPIClient
+
+  attr_accessor :url, :key
+
+  def initialize url, key
+    @key = key
+    @url = get_api_url url
+  end
+
+
+  def get_api_url url
+    url + "/lib/api/xmlrpc/v1/xmlrpc.php"
+  end
+  
+
+  def get_latest_build_for_test_plan tplanid
+    connection = XMLRPC::Client.new_from_url @url
+
+    input = { "devKey" => @key,"tplanid" => tplanid }
+    result = connection.call2 "getLatestBuildForPlan", input
+    puts result
+  end
+
+end
+
+
+

data/lib/testlink/client/version.rb

@@ -0,0 +1,7 @@
+module Tl
+  module Api
+    module Client
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/tl-api-client.rb

@@ -0,0 +1,3 @@
+require 'testlink/client'
+
+

data/tl-api-client.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'testlink/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tl-api-client"
+  spec.version       = Tl::Api::Client::VERSION
+  spec.authors       = ["Emma Chen"]
+  spec.email         = ["emmac@synopsys.com"]
+
+  spec.summary       = %q{Ruby client for Testlink API.}
+  spec.description   = %q{Ruby client with an interface to the Testlink XMLRPC client}
+  spec.homepage      = "https://gitlab.com/emchen39/testlink-api-cli"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: tl-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emma Chen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby client with an interface to the Testlink XMLRPC client
+email:
+- emmac@synopsys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/testlink/client.rb
+- lib/testlink/client/tl-api-cli.rb
+- lib/testlink/client/version.rb
+- lib/tl-api-client.rb
+- tl-api-client.gemspec
+homepage: https://gitlab.com/emchen39/testlink-api-cli
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.12
+signing_key: 
+specification_version: 4
+summary: Ruby client for Testlink API.
+test_files: []