testrail-client 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1874bd4d07830db69ca5be41ffd40cf8342b3b0e5ed72852cce04eded71ad9c
+  data.tar.gz: a70994ff627bf68a499a897f1d0f0e72b4276bfe1b8b8791e9dd67947dfc868e
+SHA512:
+  metadata.gz: da717d9b3481a2ed35c687de158c8cc01fd3783995c0dc766517181347e4a0bcb2c1a520ca0d4996ecc5d7ec4b62e10ae6fac09c64064ef6ad8fe7edd24b58a9
+  data.tar.gz: 4594c8d5ce51f433c8d9b4adf9facda3744d2ff9da42e52691dc16b898f9fc3177aa64ce00da4044ad2e72b6d139c6c62cb74da5bf4d308ef51e93974ebdf205

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in testrail-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    testrail-client (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (1.0.0)
+    mustermann (1.0.3)
+    public_suffix (3.1.1)
+    rack (2.0.7)
+    rack-protection (2.0.5)
+      rack
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    safe_yaml (1.0.5)
+    sinatra (2.0.5)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.5)
+      tilt (~> 2.0)
+    tilt (2.0.9)
+    webmock (3.6.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sinatra (~> 2.0.5)
+  testrail-client!
+  webmock (~> 3.6.2)
+  yard (~> 0.9.2)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Edmundo Sanchez
+
+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,90 @@
+# Testrail::Client
+
+Based on [testrail_client](https://github.com/zachpendleton/testrail) and [testrail-ruby](https://gitlab.com/RubyAPITools/testrail-ruby) gems.
+
+Why? [testrail_client](https://github.com/zachpendleton/testrail) requires more setup and [testrail-ruby](https://gitlab.com/RubyAPITools/testrail-ruby) has a lot of missing endpoints which hard to maintain and time consuming to add.
+
+This gem provides both the Testrail::Client to send get and posts requests and an idiomatic interface for testrail v2 API, which ever sits better on you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testrail-client'
+```
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install testrail-client`
+
+## Usage
+
+### Common Configuration
+
+``` ruby
+require 'testrail/api'
+
+client = TestRail::Client::Api.new('https://YourTestrailURL')
+client.user = 'YourUserName'
+client.password = 'YourPassword'
+```
+### First way, Client::Request
+This is how you would normally use the gem [testrail_client](https://github.com/zachpendleton/testrail), it uses Net::HTTP to send requests to the API
+
+``` ruby
+# GET case with ID 1
+client.send_get("get_case/1")
+# GET cases from Project_id 22, limit to 1 case
+client.send_get("get_cases/22&limit1")
+# POST update to case with ID 1, update case title
+client.send_post("update_case/1",{:title => "new Name"})
+# POST delete to case with ID 1, delete the case
+client.send_post("delete_case/1")
+```
+### Second way, Client::Api
+This is how you would normally use [testrail-ruby](https://gitlab.com/RubyAPITools/testrail-ruby), the change is on how it is coded, but the functionality stays, plus all endpoints from the testrail API are supported
+
+``` ruby
+# GET case with ID 1
+client.get_case(1)
+# GET cases from Project_id 22, limit to 1 case
+client.get_cases(22,{:limit => 1})
+# POST update to case with ID 1, update case title
+client.update_case(1,{:title => "new Name"})
+# POST delete to case with ID 1, delete the case
+client.delete_case(1)
+```
+As you see, this is more standardized and easy. It follows the testrail documentation.
+
+## Attachments, the special case.
+The add_attachment endpoints require the `multipart/form-data` content type and you to send a File, this is how that is done.
+
+```ruby
+# takes result ID and a hash with the file
+file = File.open('path/to/file')
+client.add_attachment_to_result(1,{:attachment => file})
+# takes case ID and a hash with the file
+client.add_attachment_to_result_for_case(22,{:attachment => file})
+```
+## TODO
+
+1.  Test if add_attachment routes actually work
+
+## 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 [mundo03/testrails-client-ruby](https://github.com/mundo03/testrails-client-ruby).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "testrail/client"
+require "testrail/api"
+
+# 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/testrail/api.rb

@@ -0,0 +1,34 @@
+require "testrail/client"
+# @author Edmundo Sanchez
+module Testrail
+  module Client
+    # Metaprogrammed class to provide an idiomatic interface to the testrails API
+    class Api < Request
+      private
+      # Using Meta programming, catch all endpoints adn send a request to them
+      # @param m [string] name of the missing method
+      # @param args [Array] Arguments
+      # @param block [Proc] Block
+      def method_missing(m, *args, &block)
+        x,y = *args
+        id = x if x.is_a? Integer #if Integer it is an ID
+        opts = x if x.is_a? Hash #if Hash it is an options array
+        opts ||= y #if opts not set, take second arg
+        case m
+        when /get/
+          send_get("#{m}/#{id}&#{_param_stringify(opts)}")
+        when /add_attachment/
+          send_post("#{m}/#{id}",opts.to_a)
+        else
+          send_post("#{m}/#{id}",opts)
+        end
+      end
+      # Stringify parameters for GET requests
+      # @param opts [Hash] parameters for the request
+      # @return [String] Stringified parameters
+      def _param_stringify(opts)
+        opts.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&")
+      end
+    end
+  end
+end

data/lib/testrail/client.rb

@@ -0,0 +1,99 @@
+require "testrail/client/version"
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+# @author Edmundo Sanchez
+module Testrail
+  # Client for the TestRail API, both request based and idiomatic
+  module Client
+    # Net:HTTP based interface for the Testrail API
+    # @attr url [String] Your Test rail URL
+    # @attr user [String] Your testrail user
+    # @attr password [String] Your testrail password
+    class Request
+      attr_accessor :url
+      attr_accessor :user
+      attr_accessor :password
+      # Initialize Client
+      # @param base_url [String] Your Testrail URL
+      def initialize(base_url)
+        if !base_url.match(/\/$/)
+          base_url += '/'
+        end
+        @url = base_url + 'index.php?/api/v2/'
+        @content_type = "application/json"
+      end
+      # send GET to uri
+      # @param uri [String] Test rail API path
+      # @return [Hash] Response from testrail API
+      def send_get(uri)
+         request = _setup_request("GET",uri)
+        _send_request(request)
+      end
+      # send POST to uri
+      # @param uri [String] test rail API path
+      # @param data [Enumerable] data to be sent in the POST request
+      # @return [Hash] Response from testrail API
+      def send_post(uri, data = nil)
+        request = _setup_request('POST', uri, data)
+        _send_request(request)
+      end
+
+      private
+      # Setup NET::HTTP request object
+      # @param method [String] can be POST, GET, PUT, PATCH, or DELETE
+      # @param uri [String] test rail API path
+      # @param data [Enumerable] data to be sent in request
+      # @return [Net::HTTPRequest] Request object
+      def _setup_request(method,uri,data = nil)
+        url = URI.parse(@url + uri)
+        STDERR.puts "#{method} #{url}"
+        http_request = eval("Net::HTTP::#{method.capitalize}")
+        request = http_request.new(url)
+        request.add_field('Content-Type', @content_type)
+        request.body = JSON.dump(data) if data.is_a? Hash
+        request.set_form data, 'multipart/form-data' if data.is_a? Array
+        request.basic_auth(@user, @password)
+        return request
+      end
+
+      # Returns response from API
+      # @param request [Net::HTTPRequest] Request object created on _setup_request
+      # @return [Hash] Response from API
+      def _send_request(request)
+        conn = Net::HTTP.new(request.uri.host, request.uri.port)
+        if request.uri.scheme == 'https'
+          conn.use_ssl = true
+          conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        response = conn.request(request)
+
+        if response.body && !response.body.empty?
+          begin
+            result = JSON.parse(response.body)
+          rescue
+            raise APIError.new("Can't parse response \n" + response.body)
+          end
+        else
+          result = {}
+        end
+        if response.code != '200'
+          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
+      end
+    end
+
+    # Custom Error class
+    class APIError < StandardError; end
+
+  end
+end

data/lib/testrail/client/version.rb

@@ -0,0 +1,6 @@
+module Testrail
+  module Client
+    # Gem version
+    VERSION = "0.2.0"
+  end
+end

data/testrail-client.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "testrail/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "testrail-client"
+  spec.version       = Testrail::Client::VERSION
+  spec.authors       = ["Edmundo Sanchez"]
+  spec.email         = ["zomundo@gmail.com"]
+
+  spec.summary       = "Another Client wrapper in Ruby for TestRail API (v2)"
+  spec.description   = "An easy to mantain gem that wrapps the v2 testrail API"
+  spec.homepage      = "https://github.com/mundo03/testrails-client-ruby"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.required_ruby_version = '>= 2.6.3'
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sinatra", "~> 2.0.5"
+  spec.add_development_dependency 'webmock', "~> 3.6.2"
+  spec.add_development_dependency 'yard', "~> 0.9.2"
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: testrail-client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Edmundo Sanchez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: An easy to mantain gem that wrapps the v2 testrail API
+email:
+- zomundo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/testrail/api.rb
+- lib/testrail/client.rb
+- lib/testrail/client/version.rb
+- testrail-client.gemspec
+homepage: https://github.com/mundo03/testrails-client-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Another Client wrapper in Ruby for TestRail API (v2)
+test_files: []