resttestrail 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a935b075ecbece7851487f42f18b1f68e1f934fa
-  data.tar.gz: bdc3cf12d0af8becf7a41f6d104c68ef14b2a356
+  metadata.gz: e859e3b2d6abaa04f73e2d465c0bf6995a347c10
+  data.tar.gz: 92ae098a43dbe84e2301db51bfbc17a5efc61451
 SHA512:
-  metadata.gz: 5447d341cfe086885a218364952143f073c38d4ceb8f45f6ba75e5ad2d2b35181520218e59b44ce9e1ed5ac37a3057293c4261d8b2c5d61b1f4ed31448124b32
-  data.tar.gz: 73ed3e513ee531957eee55da5c5d4a5d562178da802c2028b79835bfebb4ebfd66e2e78771e4d0736e8e4360e239ac64e58231ca37d790d30966c9e020685a57
+  metadata.gz: 12ac7a30918e0f61401948b9648bba6ce5ca007ab8f85c2009fc031bb56857e5a06606bf593d1a2a3f57079cdc199fb1298df770141b4d7c7809a681ecd770ef
+  data.tar.gz: c3c074edc193e5802afcc0acc5f4d55d50fbffad0dd0b11c527bf5b5c09e4c8f6435c390f04c6a6820066d02203c41180d16f91ed5ab047175cb78b8dc58e1c0

data/README.md

@@ -1,6 +1,11 @@
 # Resttestrail
 
-TODO: Write a gem description
+Resttestrail is a ruby gem for the TestRail API (v2) which is available with TestRail 3.0 and later.
+
+Features include:
+
+- Publish test results (add run, get run, delete run, add result for case)
+- Add test case to a section (add case, get case, delete case)
 
 ## Installation
 
@@ -18,11 +23,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+See the integration spec for usage.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/resttestrail/fork )
+1. Fork it ( https://github.com/sfaiqh/resttestrail/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/integration_spec/resttestrail.rb

@@ -20,6 +20,14 @@ module Resttestrail
 
   begin
     client = Resttestrail::Client.instance
+
+    new_test_case_id = client.add_case(72621, "a new test case - delete me",
+                                    Resttestrail::Requests::Case_Type::FUNCTIONALITY,
+                                    Resttestrail::Requests::Case_Priority::MEDIUM,
+                                    estimate="1m 14s", milestone_id=nil, refs="REF1 REF2")
+    puts client.get_case(new_test_case_id)
+    client.delete_case(new_test_case_id)
+
     run_id = client.add_run("an amazing run #{Time.new.strftime("%H_%M_%S_%N")}", suite_id)
     puts "run id = #{run_id}"
 

data/lib/resttestrail/client.rb

@@ -17,6 +17,22 @@ module Resttestrail
       @net_http = Net::HTTP.new(Resttestrail.config.host, Resttestrail.config.port)
     end
 
+    def add_case(section_id, title, type_id, priority_id, estimate=nil, milestone_id=nil, refs=nil)
+      request = Resttestrail::Requests.add_case(section_id, title, type_id, priority_id, estimate, milestone_id, refs)
+      http_response = Resttestrail::Client.response(@net_http.request(request))
+      http_response[:body]["id"]
+    end
+
+    def get_case(case_id)
+      request = Resttestrail::Requests.get_case(case_id)
+      Resttestrail::Client.response(@net_http.request(request))
+    end
+
+    def delete_case(case_id)
+      request = Resttestrail::Requests.delete_case(case_id)
+      Resttestrail::Client.response(@net_http.request(request))
+    end
+
     def add_run(run_name, suite_id)
       request = Resttestrail::Requests.add_run(run_name, suite_id)
       http_response = Resttestrail::Client.response(@net_http.request(request))

data/lib/resttestrail/requests.rb

@@ -5,6 +5,9 @@ module Resttestrail
 
   module Requests
     URI = "/index.php?/api/v2"
+    ADD_CASE = "/add_case/"
+    GET_CASE = "/get_case/"
+    DELETE_CASE = "/delete_case/"
     ADD_RUN = "/add_run/"
     GET_RUN = "/get_run/"
     DELETE_RUN = "/delete_run/"
@@ -15,6 +18,44 @@ module Resttestrail
     TEST_STATUS_FAILED = 5
     TEST_STATUS_BLOCKED = 2
 
+    module Case_Type
+      ACCEPTANCE    = 10
+      COMPREHENSIVE = 9
+      SMOKE         = 8
+      SCENARIO      = 7
+      OTHER         = 6
+      USABILITY     = 5
+      REGRESSION    = 4
+      PERFORMANCE   = 3
+      FUNCTIONALITY = 2
+    end
+
+    module Case_Priority
+      CRITICAL = 7
+      HIGH     = 4
+      MEDIUM   = 3
+      LOW      = 5
+    end
+
+    def self.add_case(section_id, title, type_id, priority_id, estimate, milestone_id, refs)
+      uri = "#{URI}#{ADD_CASE}#{section_id}"
+      request = Net::HTTP::Post.new(uri, initheader = {'Content-Type' => 'application/json', 'Authorization' => basic_auth_string})
+      body = {"title" => title, "type_id" => type_id, "priority_id" => priority_id}
+      body.merge!("estimate" => estimate) if (!estimate.nil? && estimate.is_a?(String))
+      body.merge!("milestone_id" => milestone_id) if (!milestone_id.nil? && milestone_id.is_a?(Integer))
+      body.merge!("refs" => refs) if (!refs.nil? && refs.is_a?(String))
+      request.body = body.to_json
+      request
+    end
+
+    def self.get_case(case_id)
+      Net::HTTP::Get.new("#{URI}#{GET_CASE}#{case_id}", initheader = {'Content-Type' => 'application/json', 'Authorization' => basic_auth_string})
+    end
+
+    def self.delete_case(case_id)
+      Net::HTTP::Post.new("#{URI}#{DELETE_CASE}#{case_id}", initheader = {'Content-Type' => 'application/json', 'Authorization' => basic_auth_string})
+    end
+
     def self.add_run(run_name, suite_id)
       uri = "#{URI}#{ADD_RUN}#{Resttestrail.config.project_id}"
       request = Net::HTTP::Post.new(uri, initheader = {'Content-Type' => 'application/json', 'Authorization' => basic_auth_string})

data/lib/resttestrail/version.rb

@@ -1,3 +1,3 @@
 module Resttestrail
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/resttestrail.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Syed Hussain"]
   spec.email         = ["shussain@groupon.com"]
   spec.summary       = %q{Gem for Testrail rest api}
-  spec.description   = %q{Write a longer description. Optional.}
+  spec.description   = %q{Resttestrail is a ruby gem for the TestRail API (v2) which is available with TestRail 3.0 and later.}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/spec/lib/resttestrail/requests_spec.rb

@@ -12,6 +12,63 @@ describe Resttestrail::Requests do
     expect(Resttestrail::Requests.basic_auth_string).to eq "Basic c29tZV91c2VybmFtZTpzb21lX3Bhc3N3b3Jk\n"
   end
 
+  it "makes the add test case request" do
+    add_test_case_request = Resttestrail::Requests.add_case("12345", "a great test",
+                                                            Resttestrail::Requests::Case_Type::SMOKE,
+                                                            Resttestrail::Requests::Case_Priority::MEDIUM,
+                                                            "1m 10s", 4321, "REF1, REF2")
+    expect(add_test_case_request.method).to eq "POST"
+    expect(add_test_case_request.path).to eq "/index.php?/api/v2/add_case/12345"
+    body = JSON.parse(add_test_case_request.body)
+    expect(body).to be == {"title" => "a great test", "type_id" => Resttestrail::Requests::Case_Type::SMOKE,
+                           "priority_id" => Resttestrail::Requests::Case_Priority::MEDIUM,
+                           "estimate" => "1m 10s", "milestone_id" => 4321, "refs" => "REF1, REF2"}
+  end
+
+  it "makes the add test case request with nil estimate, milestone_id and refs" do
+    add_test_case_request = Resttestrail::Requests.add_case("12345", "a great test",
+                                                            Resttestrail::Requests::Case_Type::SMOKE,
+                                                            Resttestrail::Requests::Case_Priority::MEDIUM,
+                                                            nil, nil, nil)
+    expect(add_test_case_request.method).to eq "POST"
+    expect(add_test_case_request.path).to eq "/index.php?/api/v2/add_case/12345"
+    body = JSON.parse(add_test_case_request.body)
+    expect(body).to be == {"title" => "a great test", "type_id" => Resttestrail::Requests::Case_Type::SMOKE,
+                           "priority_id" => Resttestrail::Requests::Case_Priority::MEDIUM}
+    expect(body).not_to have_key("estimate")
+    expect(body).not_to have_key("milestone_id")
+    expect(body).not_to have_key("refs")
+  end
+
+  it "makes the add test case request with wrong case estimate, milestone_id and refs" do
+    add_test_case_request = Resttestrail::Requests.add_case("12345", "a great test",
+                                                            Resttestrail::Requests::Case_Type::SMOKE,
+                                                            Resttestrail::Requests::Case_Priority::MEDIUM,
+                                                            123, "4321", 456)
+    expect(add_test_case_request.method).to eq "POST"
+    expect(add_test_case_request.path).to eq "/index.php?/api/v2/add_case/12345"
+    body = JSON.parse(add_test_case_request.body)
+    expect(body).to be == {"title" => "a great test", "type_id" => Resttestrail::Requests::Case_Type::SMOKE,
+                           "priority_id" => Resttestrail::Requests::Case_Priority::MEDIUM}
+    expect(body).not_to have_key("estimate")
+    expect(body).not_to have_key("milestone_id")
+    expect(body).not_to have_key("refs")
+  end
+
+  it "makes the get test case request" do
+    get_run_request = Resttestrail::Requests.get_case(1234)
+    expect(get_run_request.method).to eq "GET"
+    expect(get_run_request.path).to eq "/index.php?/api/v2/get_case/1234"
+    expect(get_run_request.body).to eq nil
+  end
+
+  it "makes the delete test case request" do
+    request = Resttestrail::Requests.delete_case(1234)
+    expect(request.method).to eq "POST"
+    expect(request.path).to eq "/index.php?/api/v2/delete_case/1234"
+    expect(request.body).to eq nil
+  end
+
   it "makes the add run request" do
     add_run_request = Resttestrail::Requests.add_run("an amazing run", 1234)
     expect(add_run_request.method).to eq "POST"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resttestrail
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Syed Hussain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Write a longer description. Optional.
+description: Resttestrail is a ruby gem for the TestRail API (v2) which is available
+  with TestRail 3.0 and later.
 email:
 - shussain@groupon.com
 executables: []