testrailv2 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmUyOWQ2ZTkyMjVlMmU3OTIwMGY1NzVjYzFhZmQ2MDE0NDNmMjg5Mg==
+  data.tar.gz: !binary |-
+    ZTIxOTUxNzY3MWE0ZjU2Mzg1NzA0MGVlZjU5MjU3Y2Y1ZjhkZjU2OA==
+SHA512:
+  metadata.gz: !binary |-
+    MTY1Mjc0ZWMzN2JiZDI1MDRkYjA3ZmVkZjdhMzU0ZGRiODRkOTIxNWNiY2Iz
+    NmNiZTg3ZjFmYTFiZjM3MGM1MDA5MzE1ZmY2MDQ0ZmNjMDM4Yzc1NWIyYTFi
+    Yjc3ZGU3YzhjZjMxMDZkZWY2ZTA3ZjZiZWE0N2U2YzNhY2I4NTc=
+  data.tar.gz: !binary |-
+    MmNkNzdiYmMzOGY1MTlmM2JlOWE2YTZmY2I5OTMwY2UyZmRlZTNmNDc4OWM4
+    MTcwZGNjMWI4NjMyNTQ3MzVmZTg4ZTE2ODc2NDgyZmE5NWExMmY4ZjU2NjQ4
+    NDk3YjMxMDliYTI2YjU2MDQxMjVmNmZhN2Y5NzY4OTM1OWVjY2M=

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in testrail.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kristine Robison
+
+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,59 @@
+# testrail [![Gem Version](https://badge.fury.io/rb/testrail.png)](http://badge.fury.io/rb/testrail) [![Travis Status](https://travis-ci.org/krobi64/testrail.png)](https://travis-ci.org/krobi64/testrail) [![Code Climate](https://codeclimate.com/github/krobi64/testrail.png)](https://codeclimate.com/github/krobi64/testrail) [![Gemnasium](https://gemnasium.com/krobi64/testrail.png)](https://gemnasium.com/krobi64/testrail)
+
+A Ruby client that tries to match TestRail's API one-to-one, while still
+providing an idiomatic interface.
+
+## Installation
+    gem install testrail
+
+or in Gemfile
+
+    gem "testrail"
+
+## Configuration
+
+By default, Testrail's configuration points to their hosted service. You can set your api_key in either of the following ways:
+
+    Testrail.config.api_key = 'my_api_key'
+
+    Testrail.configure do |c|
+      c.api_key = 'my_api_key'
+    end
+
+Configuration options [defaults] include:
+* server: the location of the TestRail application. ['https://example.testrail.com']
+* api_path: the path on the server that provides the api. ['/index.php?/miniapi/']
+* api_key: the api_key required to access the TestRail application. [nil]
+* logger:  the logging instance to use for capturing log messages. [Logger.new]
+
+## Usage
+
+    client = Testrail::Client.new
+    response = client.add_case(<section_id>, body: {
+      title: "A New Test",
+      priority_id: 4,
+      references: 'url_to_issue_tracker'
+    })
+    
+    test_id = response.payload if response.success
+    error = response.error unless response.success
+
+# ToDo
+
+* Add Testrail specific objects to represent the Testrail domain.
+
+# Contributing to testrail
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Kristine Robison. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:simplecov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Testrail'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/testrail.rb

@@ -0,0 +1,10 @@
+require 'testrail/config'
+require 'testrail/request'
+require 'testrail/response'
+require 'testrail/client'
+
+module Testrail
+  def self.logger
+    Testrail.config.logger
+  end
+end

data/lib/testrail/client.rb

@@ -0,0 +1,212 @@
+module Testrail
+  class Client
+
+    attr_reader :request
+
+    def initialize
+      @request = Testrail::Request
+    end
+
+    # Test Results - see http://docs.gurock.com/testrail-api/reference-results
+    def add_result(test_id, opts = {})
+      request.post(__method__, test_id, opts)
+    end
+
+    def add_result_for_case(run_id, case_id, opts = {})
+      request.post(__method__, [run_id, case_id], opts)
+    end
+    
+    def get_results(test_id, limit, opts = {})
+      request.get(__method__, test_id, limit, opts)
+    end
+
+    def get_results_for_case(run_id, case_id, limit, opts = {})
+      request.get(__method__, [run_id, case_id], limit, opts)
+    end
+
+    # Test - see http://docs.gurock.com/testrail-api/reference-tests
+    def get_test(test_id, opts = {})
+      request.get(__method__, test_id, opts)
+    end
+
+    def get_tests(run_id, opts = {})
+      request.get(__method__, run_id, opts)
+    end
+
+    # Test Cases - see http://docs.gurock.com/testrail-api/reference-cases
+    def get_case(case_id, opts = {})
+      request.get(__method__, case_id, opts)
+    end
+
+    def get_cases(project_id, suite_id, section_id, opts = {})
+      request.get(__method__, project_id, suite_id, section_id, opts)
+    end
+
+    def add_case(section_id, opts = {})
+      request.post(__method__, section_id, opts)
+    end
+
+    def update_case(case_id, opts = {})
+      request.post(__method__, case_id, opts)
+    end
+
+    def delete_case(case_id, opts = {})
+      request.post(__method__, case_id, opts)
+    end
+
+    # Suites - see http://docs.gurock.com/testrail-api/reference-suites
+    def get_suite(suite_id, opts = {})
+      request.get(__method__, suite_id, opts)
+    end
+
+    def get_suites(project_id, opts = {})
+      request.get(__method__, project_id, opts)
+    end
+
+    def add_suite(project_id, opts = {})
+      request.post(__method__, project_id, opts)
+    end
+
+    def update_suite(suite_id, opts = {})
+      request.post(__method__, suite_id, opts)
+    end
+
+    def delete_suite(suite_id, opts = {})
+      request.post(__method__, suite_id, opts)
+    end
+
+    #Sections
+    def get_section(section_id, opts = {})
+      request.get(__method__, section_id, opts)
+    end
+
+    def get_sections(project_id, suite_id, opts = {})
+      request.get(__method__, project_id, suite_id, opts)
+    end
+
+    def add_section(project_id, opts = {})
+      request.post(__method__, project_id, opts)
+    end
+
+    def update_section(section_id, opts = {})
+      request.get(__method__, section_id, opts)
+    end
+
+    def delete_section(section_id, opts = {})
+      request.get(__method__, section_id, opts)
+    end
+
+    # Test Runs - see http://docs.gurock.com/testrail-api/reference-runs
+    def get_run(run_id, opts = {})
+      request.get(__method__, run_id, opts)
+    end
+
+    def get_runs(project_id, opts = {})
+      request.get(__method__, project_id, opts)
+    end
+
+    def add_run(project_id, opts = {})
+      request.post(__method__, project_id, opts)
+    end
+
+    def update_run(run_id, opts = {})
+      request.post(__method__, run_id, opts)
+    end
+
+    def close_run(run_id, opts = {})
+      request.post(__method__, run_id, opts)
+    end
+
+    def delete_run(run_id, opts = {})
+      request.post(__method__, run_id, opts)
+    end
+
+    # Test Plans - see http://docs.gurock.com/testrail-api/reference-plans
+    def get_plan(plan_id, opts = {})
+      request.get(__method__, plan_id, opts)
+    end
+
+    def get_plans(project_id, opts = {})
+      request.get(__method__, project_id, opts)
+    end
+
+    def add_plan(project_id, opts = {})
+      request.post(__method__, project_id, opts)
+    end
+
+    def add_plan_entry(plan_id, opts = {})
+      request.post(__method__, plan_id, opts)
+    end
+
+    def update_plan(plan_id, opts = {})
+      request.post(__method__, plan_id, opts)
+    end
+
+    def close_plan(plan_id, opts = {})
+      request.post(__method__, plan_id, opts)
+    end
+
+    # Milestones - see http://docs.gurock.com/testrail-api/reference-milestones
+    def get_milestone(milestone_id, opts = {})
+      request.get(__method__, milestone_id, opts)
+    end
+
+    def get_milestones(project_id, opts = {})
+      request.get(__method__, project_id, opts)
+    end
+
+    def add_milestone(project_id, opts = {})
+      request.post(__method__, project_id, opts)
+    end
+
+    # Projects - see http://docs.gurock.com/testrail-api/reference-projects
+    def get_project(project_id, opts = {})
+      request.get(__method__, project_id, opts)
+    end
+
+    def get_projects(opts = {})
+      request.get(__method__, opts)
+    end
+
+    # Statuses
+    def get_statuses(opts = {})
+      request.get(__method__, opts)
+    end
+    
+    # COMMANDS.each do |method_name|
+    #   define_method method_name
+    # end
+
+    COMMANDS = %w[add_result
+                  add_result_for_case
+                  get_results
+                  get_results_for_case
+                  get_test
+                  get_tests
+                  get_case
+                  get_cases
+                  add_case
+                  update_case
+                  delete_case
+                  get_suite
+                  get_suites
+                  get_section
+                  get_sections
+                  add_suite
+                  add_section
+                  get_run
+                  get_runs
+                  add_run
+                  close_run
+                  get_plan
+                  get_plans
+                  add_plan
+                  add_plan_entries
+                  close_plan
+                  get_milestone
+                  get_milestones
+                  add_milestone
+                  get_project
+                  get_projects]
+  end
+end

data/lib/testrail/command_helper.rb

@@ -0,0 +1,29 @@
+module Testrail
+  module CommandHelper
+    def build_url(command, ids = nil)
+      arg_names = Client.instance_method(command.to_sym).parameters.map(&:last).map(&:to_s)
+      command = Testrail.config.server + Testrail.config.api_path + Testrail.config.version + "/" + command
+      unless ids.nil?
+        args = ids.shift
+        if args.kind_of?(Array)
+          arg_names.shift(args.size)
+          args = args.join('/')
+        else
+          arg_names.shift
+          args = args.to_s
+        end
+        command += '/' + args
+        command += '&' + ids.each_with_index.map{ |x,i| arg_names[i] + '=' + x.to_s}.join('&') unless ids.empty?
+        #ids = '/' + [ids].flatten.join('/')
+        #command += ids
+      end
+      puts command
+      command + key
+    end
+
+    private
+    def key
+      ('&key=' + String(Testrail.config.api_key) unless Testrail.config.api_key.nil?).to_s
+    end
+  end
+end

data/lib/testrail/config.rb

@@ -0,0 +1,36 @@
+require 'logger'
+require 'active_support/configurable'
+
+module Testrail
+
+  def self.configure(&block)
+    @config = Config.new
+    yield @config if block_given?
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  class Config
+    include ActiveSupport::Configurable
+    config_accessor :headers, :server, :api_path, :version, :api_key, :username, :password, :logger
+
+    def initialize
+      default_config
+    end
+
+    def default_config
+      self.headers = {
+        "Accept" => "application/json"
+      }
+      self.server = "https://example.testrail.com"
+      self.version = "api/v2"
+      self.api_path = "/index.php?/"
+      self.api_key = nil
+      self.username = nil
+      self.password = nil
+      self.logger = Logger.new STDOUT
+    end
+  end
+end

data/lib/testrail/request.rb

@@ -0,0 +1,60 @@
+require 'httparty'
+require 'testrail/command_helper'
+
+module Testrail
+  class Request
+    extend Testrail::CommandHelper
+    include HTTParty
+
+    base_uri Testrail.config.server
+    format :json
+
+    def self.get(*args)
+      request(:get, *args)
+    end
+
+    def self.post(*args)
+      request(:post, *args)
+    end
+
+    private
+
+    def self.request(method, *args)
+      command, ids, opts = parse_args(*args)
+      url = build_url(command, ids)
+      if not Testrail.config.username.nil? and not Testrail.config.password.nil?
+        opts.merge!({:basic_auth => {:username => Testrail.config.username, :password => Testrail.config.password}})
+      end
+      attempts = 0
+      begin
+        response = Testrail::Response.new(HTTParty.send(method, url, opts))
+      rescue TimeoutError => error
+        attempts += 1
+        retry if attempts < 3
+        log_error error, "Timeout connecting to #{method.to_s.upcase} #{url}"
+        raise error
+      rescue Exception => error
+        log_error error, "Unexpected exception intercepted calling TestRail"
+        raise error
+      end
+      response
+    end
+    
+    def self.log_error(error, message)
+      unless Testrail.logger.nil?
+        Testrail.logger.error message
+        Testrail.logger.error error
+      end
+    end
+
+    def self.parse_args(*args)
+      opts = args.last.instance_of?(Hash) ? args.pop : {}
+      opts[:headers] = opts[:headers] ? Testrail.config.headers.merge(opts[:headers]) : Testrail.config.headers
+      opts[:headers].merge!({"Content-Type" => "application/json"}) if Testrail.config.version != "miniapi"
+      opts[:body] = opts[:body].to_json if opts[:body] != nil and Testrail.config.version != "miniapi"
+      command = args.shift.to_s
+      ids = args.empty? ? nil : args
+      [command, ids, opts]
+    end
+  end
+end