testrail-ruby 0.0.25 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4ccea7ce8bd366b7707b13371c2e1aa724aa25c
-  data.tar.gz: d5d7452a441b044193853ff3e605ff4fb36d5014
+  metadata.gz: 904c7cb657f6119209dc39dab2ff4bede4b639c5
+  data.tar.gz: 7c42db52877d5de46334bae1ee84e749ddb382b4
 SHA512:
-  metadata.gz: 7b41cdc1e02547b0853670b10b132cb5e6f54d59654a0d1e17e982c72fa50734b1c42d6d2e0f22dad0d57baa58a3c45eceb87dd64eea87142e01d78f5562b14f
-  data.tar.gz: 52a727af3b2390eae510ee7a0fd9b5e5760706eb0f2753b3379bfe8729118ef92fc9dea460f0b513eac8a8f8b4d8e69ee957431ce8372d56330fc6a0968f1fa6
+  metadata.gz: a42df30911e8911ab678b8addab502a259220ccf07fd574ae2780667d7795f574ffe5e9bb759ab40917e51ffe61a2f6a27e06980aa6dc77b21458dfd331d9df9
+  data.tar.gz: 697a7bb11855a1c67e2da489fff779fcf8aa8b586a6f6180377378bfc36f54813c7f4d5ea19755616b4fd61fd5be9e10717ca3cfd64385f328a6a56b0c7f0a21

data/lib/testrail-ruby-broken.rb

@@ -0,0 +1,85 @@
+require_relative 'version'
+require_relative 'endpoints'
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+## #USAGE:
+## #@client = TestRail::APIClient.new('YourBaseURLHere')
+## #@client.user = 'UserName'
+## #@client.password = 'Password'
+
+module TestRail
+  class APIClient
+    @url = ''
+    @user = ''
+    @password = ''
+
+    include Endpoints
+    attr_accessor :user
+    attr_accessor :password
+
+    def initialize(base_url)
+      base_url += '/' unless base_url =~ /\/$/
+      @url = base_url + 'index.php?/api/v2/'
+    end
+
+    def send_get(uri, data)
+      puts "Getting: #{uri}"
+      puts "Sending Data: #{data}"
+      _send_request('GET', uri, data)
+    end
+
+    def send_post(uri, data)
+      puts "Posting: #{uri}"
+      puts "Sending Data: #{data}"
+      _send_request('POST', uri, data)
+    end
+
+    private
+
+    def _send_request(method, uri, data)
+      url = URI.parse(@url + uri)
+      puts "URL: #{url}"
+      puts "url.query: #{url.query}"
+      puts "Data Payload: #{data}"
+      if method == 'POST'
+        request = Net::HTTP::Post.new(url.path + '?' + url.query)
+        request.body = JSON.dump(data)
+      else
+        request = Net::HTTP::Get.new(url.path + '?' + url.query)
+      end
+      request.basic_auth(@user, @password)
+      request.add_field('Content-Type', 'application/json')
+
+      conn = Net::HTTP.new(url.host, url.port)
+      if url.scheme == 'https'
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      response = conn.request(request)
+
+      result = if response.body && !response.body.empty?
+                 JSON.parse(response.body)
+               else
+                 {}
+               end
+
+      if response.code != '200'
+        error = if result && result.key?('error')
+                  '"' + result['error'] + '"'
+                else
+                  'No additional error message received'
+                end
+        raise APIError, 'TestRail API returned HTTP %s (%s)' %
+                        [response.code, error]
+      end
+
+      result
+    end
+  end
+
+  class APIError < StandardError
+  end
+end

data/lib/testrail-ruby.rb

@@ -21,30 +21,47 @@ module TestRail
     attr_accessor :password
 
     def initialize(base_url)
-      base_url += '/' unless base_url =~ /\/$/
+      if !base_url.match(/\/$/)
+        base_url += '/'
+      end
       @url = base_url + 'index.php?/api/v2/'
     end
 
-    def send_get(uri, data)
-      puts "Getting: #{uri}"
-      puts "Sending Data: #{data}"
-      _send_request('GET', uri, data)
+    #
+    # Send Get
+    #
+    # Issues a GET request (read) against the API and returns the result
+    # (as Ruby hash).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. get_case/1)
+    #
+    def send_get(uri)
+      _send_request('GET', uri, nil)
     end
 
+    #
+    # Send POST
+    #
+    # Issues a POST request (write) against the API and returns the result
+    # (as Ruby hash).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. add_case/1)
+    # data                The data to submit as part of the request (as
+    #                     Ruby hash, strings must be UTF-8 encoded)
+    #
     def send_post(uri, data)
-      puts "Posting: #{uri}"
-      puts "Sending Data: #{data}"
       _send_request('POST', uri, data)
     end
 
     private
-
     def _send_request(method, uri, data)
       url = URI.parse(@url + uri)
-      puts "Request URL: #{url}"
-      puts "url.path: #{url.path}"
-      puts "url.query: #{url.query}"
-      puts "Data Payload: #{data}"
       if method == 'POST'
         request = Net::HTTP::Post.new(url.path + '?' + url.query)
         request.body = JSON.dump(data)
@@ -61,20 +78,20 @@ module TestRail
       end
       response = conn.request(request)
 
-      result = if response.body && !response.body.empty?
-                 JSON.parse(response.body)
-               else
-                 {}
-               end
+      if response.body && !response.body.empty?
+        result = JSON.parse(response.body)
+      else
+        result = {}
+      end
 
       if response.code != '200'
-        error = if result && result.key?('error')
-                  '"' + result['error'] + '"'
-                else
-                  'No additional error message received'
-                end
-        raise APIError, 'TestRail API returned HTTP %s (%s)' %
-                        [response.code, error]
+        if result && result.key?('error')
+          error = '"' + result['error'] + '"'
+        else
+          error = 'No additional error message received'
+        end
+        raise APIError.new('TestRail API returned HTTP %s (%s)' %
+          [response.code, error])
       end
 
       result

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Testrail
-  VERSION = '0.0.25'.freeze
+  VERSION = '0.0.26'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testrail-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
 platform: ruby
 authors:
 - Frances Morales
@@ -105,6 +105,7 @@ files:
 - README.md
 - Rakefile
 - lib/endpoints.rb
+- lib/testrail-ruby-broken.rb
 - lib/testrail-ruby.rb
 - lib/version.rb
 - spec/spec_helper.rb