rtrail 0.0.1

data/lib/rtrail/project.rb

@@ -0,0 +1,83 @@
+require_relative 'entity'
+require_relative 'suite'
+require_relative 'run'
+require_relative 'plan'
+
+module RTrail
+  class Project < Entity
+    def self.all
+      return client.get("get_projects").map do |project|
+        self.new(project)
+      end
+    end
+
+    def self.by_name(project_name)
+      result = Project.all.find do |project|
+        project.name == project_name
+      end
+
+      if result.nil?
+        raise RTrail::NotFound.new("Project '#{project_name}' not found in TestRail")
+      else
+        return self.new(result)
+      end
+    end
+
+    # Return a suite with the given name in the current project.
+    def suite_by_name(suite_name)
+      suite = self.suites.find do |s|
+        s.name == suite_name
+      end
+      if suite.nil?
+        raise RTrail::NotFound.new(
+          "Suite '#{suite_name}' not found in project '#{self.data.name}'")
+      end
+      return suite
+    end
+
+    # Return a suite with the given name or id in the current project.
+    def suite(suite_name_or_id)
+      if is_id?(suite_name_or_id)
+        return Suite.new(suite_name_or_id)
+      else
+        return suite_by_name(suite_name_or_id)
+      end
+    end
+
+    def suite_id(suite_name_or_id)
+      return self.suite(suite_name_or_id).id
+    end
+
+    def plans
+      return get_entities(Plan, data.id)
+    end
+
+    def runs
+      return get_entities(Run, data.id)
+    end
+
+    def suites
+      return get_entities(Suite, data.id)
+    end
+
+    # Return an existing run with the given name, or create and
+    # return a new run.
+    def run(suite_name_or_id, run_name)
+      existing = runs.find {|r| r.name == run_name}
+      if existing
+        return existing
+      else
+        return add_run(suite_name_or_id, :name => run_name)
+      end
+    end
+
+    # Create a new Run in the given Suite in this project.
+    def add_run(suite_name_or_id, fields={})
+      run_data = fields.merge({
+        :suite_id => suite_id(suite_name_or_id),
+      })
+      return add_entity(Run, data.id, run_data)
+    end
+  end
+end # module RTrail
+

data/lib/rtrail/result.rb

@@ -0,0 +1,9 @@
+require_relative 'entity'
+require_relative 'helpers'
+
+module RTrail
+  class Result < Entity
+    include HasCreateTime
+  end
+end # module RTrail
+

data/lib/rtrail/run.rb

@@ -0,0 +1,39 @@
+require_relative 'entity'
+require_relative 'test'
+require_relative 'helpers'
+
+module RTrail
+  class Run < Entity
+    include HasCreateTime
+
+    # Return a one-line summary of this Run
+    def summary
+      # TODO: Include these?
+      # self.untested_count
+      # self.blocked_count
+      # self.passed_count
+      # self.failed_count
+      result = "#{self.id}: #{self.name}"
+      if self.completed?
+        result += " [completed #{self.complete_time}]"
+      else
+        result += " [not completed]"
+      end
+      return result
+    end
+
+    def tests
+      return get_entities(Test, data.id)
+    end
+
+    def complete_time
+      return nil if !completed?
+      return Time.at(self[:completed_on].to_i).utc
+    end
+
+    def completed?
+      return !self[:completed_on].nil?
+    end
+  end
+end # module RTrail
+

data/lib/rtrail/section.rb

@@ -0,0 +1,7 @@
+require_relative 'entity'
+
+module RTrail
+  class Section < Entity
+  end
+end # module RTrail
+

data/lib/rtrail/suite.rb

@@ -0,0 +1,26 @@
+require_relative 'entity'
+require_relative 'case'
+require_relative 'section'
+
+module RTrail
+  class Suite < Entity
+    def sections
+      return get_entities(
+        Section,
+        data.project_id,
+        :suite_id => data.id
+      )
+    end
+
+    def cases(section_id=nil)
+      return get_entities(
+        Case,
+        data.project_id,
+        :suite_id => data.id,
+        :section_id => section_id
+      )
+    end
+  end
+
+end # module RTrail
+

data/lib/rtrail/test.rb

@@ -0,0 +1,22 @@
+require_relative 'entity'
+require_relative 'result'
+
+module RTrail
+  class Test < Entity
+    # Return all Results for this Test.
+    def results
+      return get_entities(Result, data.id)
+    end
+
+    # Return the most recently created Result for this Test.
+    def latest_result
+      return get_entities(Result, data.id, :limit => 1).first
+    end
+
+    # Add a new Result to this test.
+    def add_result(fields)
+      return add_entity(Result, data.id, fields)
+    end
+  end
+end # module RTrail
+

data/mock/app.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'sinatra/base'
+require 'sinatra/reloader'
+require 'yajl'
+
+# Mock TestRail web application
+class TestApp < Sinatra::Base
+  set :root, File.dirname(__FILE__)
+
+  configure do
+    register Sinatra::Reloader
+  end
+
+  helpers do
+    def parse(params)
+      path = ''
+      query = {}
+      params.each do |key, value|
+        if key.start_with?("/api/v2")
+          path = key.gsub('/api/v2/', '')
+        else
+          query[key] = value
+        end
+      end
+      return path, query
+    end
+  end
+
+  get '/index.php' do
+    # FIXME: Handle query (used for suite_id, section_id etc.)
+    path, query = parse(params)
+    begin
+      yajl(path.to_sym)
+    rescue => ex
+      halt 400, yajl(:error, :locals => {:error => ex.message})
+    end
+  end
+
+  post '/index.php' do
+    path, query = parse(params)
+    data = Yajl::Parser.parse(request.body.read)
+    begin
+      yajl(path.to_sym, :locals => data)
+    rescue => ex
+      halt 400, yajl(:error, :locals => {:error => ex.message})
+    end
+  end
+end
+
+if __FILE__ == $0
+  TestApp.run! :port => 8080
+end
+

data/mock/views/add_result/1.yajl

@@ -0,0 +1,4 @@
+json = {
+  :id => 5,
+  :status_id => status_id
+}

data/mock/views/add_run/1.yajl

@@ -0,0 +1,7 @@
+json = {
+  :id => 4,
+  :name => name,
+  :suite_id => suite_id,
+  :created_on => Time.now.to_i,
+  :completed_on => nil,
+}

data/mock/views/error.yajl

@@ -0,0 +1,3 @@
+json = {
+  :error => error,
+}

data/mock/views/get_case/1.yajl

@@ -0,0 +1,4 @@
+json = {
+  :id => 1,
+  :title => "First Case",
+}

data/mock/views/get_cases/1.yajl

@@ -0,0 +1,3 @@
+json = [
+  eval(File.read('mock/views/get_case/1.yajl')),
+]

data/mock/views/get_plan/1.yajl

@@ -0,0 +1,4 @@
+json = {
+  :id => 1,
+  :name => "First Plan",
+}

data/mock/views/get_plans/1.yajl

@@ -0,0 +1,3 @@
+json = [
+  eval(File.read('mock/views/get_plan/1.yajl')),
+]

data/mock/views/get_project/1.yajl

@@ -0,0 +1,4 @@
+json = {
+  :id => 1,
+  :name => "First Project"
+}

data/mock/views/get_project/2.yajl

@@ -0,0 +1,4 @@
+json = {
+  :id => 2,
+  :name => "Second Project"
+}

data/mock/views/get_projects.yajl

@@ -0,0 +1,4 @@
+json = [
+  eval(File.read('mock/views/get_project/1.yajl')),
+  eval(File.read('mock/views/get_project/2.yajl')),
+]

data/mock/views/get_result/1.yajl

@@ -0,0 +1,4 @@
+json = {
+  :id => 1,
+  :test_id => 1,
+}

data/mock/views/get_results/1.yajl

@@ -0,0 +1,3 @@
+json = [
+  eval(File.read('mock/views/get_result/1.yajl')),
+]

data/mock/views/get_run/1.yajl

@@ -0,0 +1,7 @@
+json = {
+  :id => 1,
+  :name => "First Run",
+  :suite_id => 1,
+  :created_on => Time.utc(2014, 'jun', 5, 12, 34, 56).to_i,
+  :completed_on => Time.utc(2014, 'jun', 5, 13, 34, 56).to_i,
+}

data/mock/views/get_run/2.yajl

@@ -0,0 +1,7 @@
+json = {
+  :id => 2,
+  :name => "Second Run",
+  :suite_id => 1,
+  :created_on => Time.utc(2014, 'jun', 6, 12, 34, 56).to_i,
+  :completed_on => nil,
+}

data/mock/views/get_runs/1.yajl

@@ -0,0 +1,4 @@
+json = [
+  eval(File.read('mock/views/get_run/1.yajl')),
+  eval(File.read('mock/views/get_run/2.yajl')),
+]

data/mock/views/get_section/1.yajl

@@ -0,0 +1,9 @@
+json = {
+  :id => 1,
+  :name => "First Section",
+  :suite_id => 1,
+  :parent_id => 1,
+  :display_order => 1,
+  :depth => 0,
+}
+

data/mock/views/get_section/2.yajl

@@ -0,0 +1,9 @@
+json = {
+  :id => 2,
+  :name => "Second Section",
+  :suite_id => 1,
+  :parent_id => 1,
+  :display_order => 2,
+  :depth => 0,
+}
+

data/mock/views/get_sections/1.yajl

@@ -0,0 +1,4 @@
+json = [
+  eval(File.read('mock/views/get_section/1.yajl')),
+  eval(File.read('mock/views/get_section/2.yajl')),
+]

data/mock/views/get_suite/1.yajl

@@ -0,0 +1,6 @@
+json = {
+  :id => 1,
+  :name => "First Suite",
+  :project_id => 1,
+}
+

data/mock/views/get_suite/2.yajl

@@ -0,0 +1,5 @@
+json = {
+  :id => 2,
+  :name => "Second Suite",
+}
+

data/mock/views/get_suite/3.yajl

@@ -0,0 +1,6 @@
+json = {
+  :id => 3,
+  :name => "Third Suite",
+  :project_id => 2,
+}
+

data/mock/views/get_suites/1.yajl

@@ -0,0 +1,4 @@
+json = [
+  eval(File.read('mock/views/get_suite/1.yajl')),
+  eval(File.read('mock/views/get_suite/1.yajl')),
+]

data/mock/views/get_suites/2.yajl

@@ -0,0 +1,4 @@
+json = [
+  eval(File.read('mock/views/get_suite/3.yajl')),
+]
+

data/mock/views/get_test/1.yajl

@@ -0,0 +1,4 @@
+json = {
+  :id => 1,
+}
+

data/mock/views/get_test/2.yajl

@@ -0,0 +1,4 @@
+json = {
+  :id => 2,
+}
+

data/mock/views/get_tests/1.yajl

@@ -0,0 +1,5 @@
+json = [
+  eval(File.read('mock/views/get_test/1.yajl')),
+  eval(File.read('mock/views/get_test/2.yajl')),
+]
+

data/rtrail.gemspec

@@ -0,0 +1,41 @@
+Gem::Specification.new do |s|
+  s.name = "rtrail"
+  s.version = "0.0.1"
+  s.summary = "Ruby object wrapper for TestRail API"
+  s.description = <<-EOS
+    RTrail wraps the TestRail API v2.0 in Ruby objects
+  EOS
+  s.authors = ["Eric Pierce"]
+  s.email = "epierce@automation-excellence.com"
+  s.homepage = "http://github.com/a-e/rtrail"
+  s.platform = Gem::Platform::RUBY
+
+  s.add_dependency 'hashie'
+
+  # Basic utilities
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+
+  # For testing
+  s.add_development_dependency 'rspec'
+
+  # Mock webapp to support testing
+  s.add_development_dependency 'sinatra'
+  s.add_development_dependency 'sinatra-contrib'
+  s.add_development_dependency 'thin'
+
+  # For test coverage
+  s.add_development_dependency 'simplecov'
+
+  # For documentation and markdown support
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'rdiscount'
+
+  # Others
+  s.add_development_dependency 'yajl-ruby'
+
+  # Files to distribute
+  s.files = `git ls-files`.split("\n")
+
+  s.require_path = 'lib'
+end