testrail_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb52cfc594ad739c4d1dd01c7d64c946c79f0f9d
-  data.tar.gz: 897f5941ce0664f700278dfeb821f465a81b752d
+  metadata.gz: 56946d133f1eaa0e9b2e342c28e6f3b910379b7c
+  data.tar.gz: 1c0a33fa6e867ed4f116a164c8b8d9b67425eb64
 SHA512:
-  metadata.gz: a76bfba7357235af742b1d49bb66e448013cf4026af84a97c09b89cab2b95e4a8687e8d4373a0dafb873c39ceecb3fe768267557d8af81b60ebc829967c645c6
-  data.tar.gz: 63da2d010b5e42575b8e179f8f86981c317dc644bca8f5a69e3e8862b68dc59554117f3e2f44e585eab2458562f47d22ef06d13fc7b7b8f6fa54f62b9fbd7c05
+  metadata.gz: 5876e9354a0ec6abbc0cdfdbf443f9a7f1ac494f1c7cb9b37a10cca36f4f06d1d764e4c3333cc126978ca5570ba2ede2e300dbd31d623ba91ad687dab2a34619
+  data.tar.gz: 14dd134a9e8dbcd10bf7db8abe11d147be13fd93ac8992ff4ff0e9e568738269123bef79e0dac6bd987b1e28d8c4c5d27da40040fbb44b90a38c4e9adaef81d3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,42 @@
+# Testrail API v2 client
+
+This is client for TestRail API v2. See official [documentation](http://docs.gurock.com/testrail-api2/start) for 
+reference.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testrail_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install testrail_api
+
+## Usage
+
+```ruby
+client = TestRail::Client.new('example.testrail.com', 'admin@example.com', 'pass')
+puts client.projects
+```
+
+## Development
+
+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 https://github.com/kirillzh/testrail_api. This project is 
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/testrail_api.rb

@@ -0,0 +1 @@
+require 'testrail_api/client'

data/lib/testrail_api/client.rb

@@ -0,0 +1,71 @@
+require 'testrail_api/endpoints'
+require 'testrail_api/version'
+
+require 'typhoeus'
+require 'json'
+
+module TestRail
+  class Client
+    attr_accessor :server
+    attr_accessor :username, :password
+    attr_accessor :verbose
+
+    # @param server [String] TestRail server host
+    # @param email [String] TestRail email
+    # @param password [String] TestRail password or API key
+    # @param opts [Hash] Optional parameters
+    # @option opts [Boolean] :verbose Print libcurl debug output to the console (STDERR) if true (default : false)
+    # @option opts [Boolean] :secure Use HTTPS if true (default: true)
+    def initialize(server, email, password, opts = {})
+      # required
+      @server                  = server
+      @username                = email
+      @password                = password
+
+      # optional
+      @verbose                 = opts.fetch(:verbose, false)
+      @secure                  = opts.fetch(:secure, true)
+      Typhoeus::Config.verbose = verbose
+    end
+
+    def scheme
+      @scheme ||= @secure ? 'https' : 'http'
+    end
+
+    def api_endpoint
+      @api_endpoint ||= File.join("#{scheme}://#{@server}", 'index.php?api/v2') if @server
+    end
+
+    def user_agent
+      @user_agent ||= "TestRail API v2 Gem #{VERSION}"
+    end
+
+    def default_headers
+      @default_headers ||= {
+          'Accept'       => 'application/json',
+          'Content-Type' => 'application/json',
+          'User-Agent'   => user_agent
+      }
+    end
+
+    def get(path, opts = {})
+      request(:get, path, opts)
+    end
+
+    def post(path, opts = {})
+      request(:post, path, opts)
+    end
+
+    def request(method, path, opts = {})
+      body = Typhoeus::Request.new(
+          File.join(api_endpoint, path),
+          { method:  method,
+            headers: default_headers,
+            userpwd: "#{@username}:#{@password}" }.merge(opts)
+      ).run.body
+      JSON.parse(body)
+    rescue JSON::ParserError
+      body
+    end
+  end
+end

data/lib/testrail_api/client/case_fields.rb

@@ -0,0 +1,17 @@
+module TestRail
+  class Client
+    # Methods for the Case Fields API
+    # Use the following API methods to request details about custom fields for test cases.
+
+    # @see http://docs.gurock.com/testrail-api2/reference-cases-fields
+
+    #
+    # Returns a list of available test case custom fields.
+    #
+    # @return [Array<Hash>] a list of available test case custom fields
+    #
+    def case_fields
+      get('get_case_fields')
+    end
+  end
+end

data/lib/testrail_api/client/case_types.rb

@@ -0,0 +1,10 @@
+module TestRail
+  class Client
+    # Methods for the Case Types API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-cases-types
+    def case_types
+      get('get_case_types')
+    end
+  end
+end

data/lib/testrail_api/client/cases.rb

@@ -0,0 +1,78 @@
+module TestRail
+  class Client
+    # Methods for the Cases API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-cases
+    #
+    # Returns an existing test case
+    #
+    # @param [Integer, String] case_id  The ID of the test case
+    # @return an existing test case
+    # @see http://docs.gurock.com/testrail-api2/reference-cases#get_case
+    def case(case_id)
+      get("get_case/#{case_id}")
+    end
+
+    #
+    # Returns a list of test cases for a test suite or specific section in a test suite.
+    #
+    # @param [Integer, String] project_id  The ID of the project the test run should be added to
+    # @param [Integer, String] suite_id  The ID of the test suite (optional if the project is operating in single suite mode)
+    # @param [Integer, String] section_id  The ID of the section (optional)
+    # @param filters [Hash]: A customizable set of filters
+    # @option filters [Integer] :created_after Only return test cases created after this date (as UNIX timestamp).
+    # @option filters [Integer] :created_before Only return test cases created before this date (as UNIX timestamp).
+    # @option filters [Array<Integer>] :created_by A comma-separated list of creators (user IDs) to filter by.
+    # @option filters [Array<Integer>] :milestone_id A comma-separated list of milestone IDs to filter by (not available if the milestone field is disabled for the project).
+    # @option filters [Array<Integer>] :priority_id A comma-separated list of priority IDs to filter by.
+    # @option filters [Array<Integer>] :type_id A comma-separated list of case type IDs to filter by.
+    # @option filters [Integer] :updated_after Only return test cases updated after this date (as UNIX timestamp).
+    # @option filters [Integer] :updated_before Only return test cases updated before this date (as UNIX timestamp).
+    # @option filters [Array<Integer>] :updated_by A comma-separated list of users who updated test cases to filter by.
+    # @return a list of test cases for a test suite or specific section in a test suite. The response includes an array of test cases. Each test case in this list follows the same format as TestRail#Client#get_case
+    # @see http://docs.gurock.com/testrail-api2/reference-cases#get_cases
+    def cases(project_id, suite_id, section_id = '', filters = {})
+      get("get_cases/#{project_id}&suite_id=#{suite_id}&section_id=#{section_id}", filters)
+    end
+
+    #
+    # Creates a new test case.
+    #
+    # @param [Integer, String] section_id  The ID of the section the test case should be added to
+    # @param payload [Hash]: A customizable payload
+    # @option payload [String] :title The title of the test case (required)
+    # @option payload [Integer] :type_id The ID of the case type
+    # @option payload [Integer] :priority_id The ID of the case priority
+    # @option payload [String] :estimate The estimate, e.g. "30s" or "1m 45s"
+    # @option payload [Integer] :milestone_id The ID of the milestone to link to the test case
+    # @option payload [String] :refs A comma-separated list of references/requirements
+    # TODO: finish docs
+    # @return
+    # @see http://docs.gurock.com/testrail-api2/reference-cases#add_case
+    def add_case(section_id, payload)
+      post("get_case/#{section_id}", payload)
+    end
+
+    #
+    # Returns an existing test case by its name.
+    # :case_name  The ID of the test case if number provided
+    #
+    def case_by_name(_case_name)
+      # TODO: implement get_case_by_name
+    end
+
+    # Custom method
+    # TODO: finish docs
+    def cases_ids(project_id, suite_id, section_id = '')
+      cases(project_id, suite_id, section_id).map { |x| x['id'] }
+    end
+
+    def update_case(_case_id, _payload)
+      # TODO: finish
+    end
+
+    def delete_case(_case_id)
+      # TODO: finish
+    end
+  end
+end

data/lib/testrail_api/client/milestones.rb

@@ -0,0 +1,8 @@
+module TestRail
+  class Client
+    # Methods for the Milestones API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-milestones
+    # TODO: implement
+  end
+end

data/lib/testrail_api/client/plans.rb

@@ -0,0 +1,8 @@
+module TestRail
+  class Client
+    # Methods for the Plans API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-plans
+    # TODO: implement
+  end
+end

data/lib/testrail_api/client/priorities.rb

@@ -0,0 +1,13 @@
+module TestRail
+  class Client
+    # Methods for the Priorities API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-priorities
+    #
+    # Returns a list of available priorities
+    #
+    def priorities
+      get('get_priorities')
+    end
+  end
+end

data/lib/testrail_api/client/projects.rb

@@ -0,0 +1,35 @@
+module TestRail
+  class Client
+    # Methods for the Projects API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-projects
+    #
+    # Returns the list of available projects.
+    #
+    def projects
+      get('get_projects')
+    end
+
+    #
+    # Returns an existing project by its ID.
+    #
+    # :project_id  The ID of the project
+    #
+    def project(project_id)
+      get("get_project/#{project_id}")
+    end
+
+    #
+    # Returns an existing project by its name.
+    #
+    # :project_name  The name of the project
+    #
+    def project_by_name(project_name, ignore_case = true)
+      if ignore_case
+        projects.find { |project| project['name'].casecmp(project_name) == 0 }
+      else
+        projects.find { |project| project['name'] == project_name }
+      end
+    end
+  end
+end

data/lib/testrail_api/client/result_fields.rb

@@ -0,0 +1,8 @@
+module TestRail
+  class Client
+    # Methods for the Result Fields API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-results-fields
+    # TODO: implement
+  end
+end

data/lib/testrail_api/client/results.rb

@@ -0,0 +1,108 @@
+# TODO: finish docs
+module TestRail
+  class Client
+    # Methods for the Results API
+    # Use the following API methods to request details about test results and to add new test results.
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-results
+    #
+    # Returns a list of test results for a test.
+    #
+    # @param [Integer, String] test_id  The ID of the test
+    # @return a list of test results for a test
+    # @see http://docs.gurock.com/testrail-api2/reference-results#get_results
+    def results(test_id)
+      get("get_results/#{test_id}")
+    end
+
+    #
+    # Returns a list of test results for a test run and case combination.
+    # The difference to get_results is that this method expects a test run + test case instead of a test. In TestRail,
+    # tests are part of a test run and the test cases are part of the related test suite.
+    # So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run.
+    # You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status.
+    # Please also see TestRail's getting started guide for more details about the differences between test cases and tests.
+    #
+    # This method uses the same response format as get_results.
+    #
+    # :run_id	The ID of the test run
+    # :case_id	The ID of the test case
+    #
+    def results_for_case(run_id, case_id)
+      get("get_results_for_case/#{run_id}/#{case_id}")
+    end
+
+    #
+    # Returns a list of test results for a test run.
+    #
+    # :run_id	The ID of the test run
+    #
+    def results_for_run(run_id)
+      get("get_results_for_run/#{run_id}")
+    end
+
+    # TODO: add custom fields docs
+    #
+    # Adds a new test result, comment or assigns a test.
+    # It's recommended to use #add_results instead if you plan to add results for multiple tests.
+    #
+    # @param [Integer, String] test_id  The ID of the test the result should be added to
+    # @param data [Hash]: Optional query data
+    # @option data [Integer, String] :status_id The ID of the test status. The built-in system statuses have the
+    # following IDs:
+    # 1 Passed
+    # 2 Blocked
+    # 3 Untested (not allowed when adding a result)
+    # 4 Retest
+    # 5 Failed
+    # You can get a full list of system and custom statuses via #TestRail#Client#Statuses#get_statuses.
+    # @option data [String] :comment The comment / description for the test result
+    # @option data [String] :version The version or build you tested against
+    # @option data [String] :elapsed The time it took to execute the test, e.g. "30s" or "1m 45s"
+    # @option data [Array<Integer>, Array<String>] :defects A comma-separated list of defects to link to the test result
+    # @option data [Integer, String] :assignedto_id The ID of a user the test should be assigned to
+    # @return the new test result using the same response format as get_results, but with a single result instead of a list of results.
+    # @see http://docs.gurock.com/testrail-api2/reference-results#add_result
+    def add_result(test_id, data)
+      post("add_result/#{test_id}", data)
+    end
+
+    #
+    # Adds a new test result, comment or assigns a test (for a test run and case combination).
+    # It's recommended to use add_results_for_cases instead if you plan to add results for multiple test cases.
+    # The difference to add_result is that this method expects a test run + test case instead of a test.
+    # In TestRail, tests are part of a test run and the test cases are part of the related test suite.
+    # So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run.
+    # You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status.
+    # Please also see TestRail's getting started guide for more details about the differences between test cases and tests.
+    #
+    # This method supports the same POST fields as add_result.
+    #
+    # :run_id   The ID of the test run
+    # :case_id  The ID of the test case
+    #
+    def add_result_for_case(run_id, case_id, data)
+      post("add_result_for_case/#{run_id}/#{case_id}", data)
+    end
+
+    #
+    # Adds a new test result, comment or assigns a test.
+    # It's recommended to use add_results instead if you plan to add results for multiple tests.
+    #
+    # :run_id	The ID of the test run
+    #
+    def add_results(run_id, data)
+      post("add_results/#{run_id}", data)
+    end
+
+    #
+    # Adds one or more new test results, comments or assigns one or more tests (using the case IDs).
+    # Ideal for test automation to bulk-add multiple test results in one step.
+    #
+    # :run_id The ID of the test run the results should be added to
+    #
+    def add_results_for_cases(run_id, data)
+      post("add_results_for_cases/#{run_id}", data)
+    end
+  end
+end

data/lib/testrail_api/client/runs.rb

@@ -0,0 +1,72 @@
+module TestRail
+  class Client
+    # Methods for the Runs API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-runs
+    # Use the following API methods to request details about test runs and to create or modify test runs.
+
+    #
+    # Returns an existing test run. Please see get_tests for the list of included tests in this run.
+    #
+    # :run_id  The ID of the test run
+    #
+    def run(run_id)
+      get("get_run/#{run_id}")
+    end
+
+    #
+    # Returns a list of test runs for a project.
+    # Only returns those test runs that are not part of a test plan (please see get_plans/get_plan for this).
+    #
+    # :project_id  The ID of the project
+    #
+    def runs(project_id)
+      get("get_runs/#{project_id}")
+    end
+
+    #
+    # Creates a new test run.
+    #
+    # @param [Integer, String] project_id  The ID of the project the test run should be added to
+    # @param data [Hash]: A customizable set of options
+    # @option data [Integer] :suite_id  The ID of the test suite for the test run (optional if the project is operating in single suite mode, required otherwise)
+    # @option data [String] :name The name of the test run
+    # @option data [String] :description The description of the test run
+    # @option data [Integer] :milestone_id The ID of the milestone to link to the test run
+    # @option data [Integer] :assignedto_id The ID of the user the test run should be assigned to
+    # @option data [Boolean] :include_all True for including all test cases of the test suite and false for a custom case selection (default: true)
+    # @option data [Array<Integer>] :case_ids An array of case IDs for the custom case selection
+    # @return # TODO:
+    # @see http://docs.gurock.com/testrail-api2/reference-runs#add_run
+    def add_run(project_id, data)
+      post("add_run/#{project_id}", data)
+    end
+
+    #
+    # Updates an existing test run (partial updates are supported, i.e. you can submit and update specific fields only).
+    #
+    # :run_id    The ID of the test run
+    #
+    def update_run(run_id, data)
+      post("update_run/#{run_id}", data)
+    end
+
+    #
+    # Closes an existing test run and archives its tests & results.
+    #
+    # :run_id The ID of the test run
+    #
+    def close_run(run_id, data)
+      post("close_run/#{run_id}", data)
+    end
+
+    #
+    # Deletes an existing test run.
+    #
+    # :run_id The ID of the test run
+    #
+    def delete_run(run_id, data)
+      post("delete_run/#{run_id}", data)
+    end
+  end
+end

data/lib/testrail_api/client/sections.rb

@@ -0,0 +1,65 @@
+module TestRail
+  class Client
+    # Methods for the Sections API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-sections
+    # Use the following API methods to request details about sections and to create or modify sections.
+    # Sections are used to group and organize test cases in test suites.
+
+    #
+    # Returns an existing section.
+    #
+    # :section_id The ID of the section
+    #
+    def section(section_id)
+      get("get_section/#{section_id}")
+    end
+
+    #
+    # Returns a list of sections for a project and test suite.
+    #
+    # :project_id The ID of the project
+    # :suite_id The ID of the test suite (optional if the project is operating in single suite mode)
+    #
+    def sections(project_id, suite_id)
+      get("get_sections/#{project_id}&suite_id=#{suite_id}")
+    end
+
+    def section_by_name(project_id, suite_id, section_name, ignore_case = true)
+      if ignore_case
+        sections(project_id, suite_id).find { |section| section['name'].casecmp(section_name) == 0 }
+      else
+        sections(project_id, suite_id).find { |section| section['name'] == section_name }
+      end
+    end
+
+    #
+    # Creates a new section.
+    #
+    # :project_id The ID of the project
+    #
+    def add_section(project_id, data)
+      post("add_section/#{project_id}", data)
+    end
+
+    #
+    # Updates an existing section (partial updates are supported, i.e. you can submit and update specific fields only).
+    #
+    # :section_id The ID of the section
+    #
+    def update_section(section_id, data)
+      post("update_section/#{section_id}", data)
+    end
+
+    #
+    # Updates an existing section (partial updates are supported, i.e. you can submit and update specific fields only).
+    # Please note: Deleting a section cannot be undone and also deletes all related test cases
+    # as well as active tests & results, i.e. tests & results that weren't closed (archived) yet.
+    #
+    # :section_id The ID of the section
+    #
+    def delete_section(section_id)
+      post("delete_section/#{section_id}")
+    end
+  end
+end

data/lib/testrail_api/client/statuses.rb

@@ -0,0 +1,19 @@
+module TestRail
+  class Client
+    # Methods for the Statuses API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-statuses
+    # Use the following API methods to request details about test statuses.
+
+    # Each status has a unique ID, a name (system name) as well as a label (display name).
+    # The color related fields specify the different colors used for a status and are RGB colors.
+    # The following system statuses are available by default.
+    # You can add additional custom statuses under Administration > Customizations in TestRail.
+
+    # @return a list of available_contexts test statuses.
+    # @see http://docs.gurock.com/testrail-api2/reference-statuses#get_statuses
+    def statuses
+      get('get_statuses')
+    end
+  end
+end

data/lib/testrail_api/client/suites.rb

@@ -0,0 +1,43 @@
+module TestRail
+  class Client
+    # Methods for the Suites API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-suites
+    # Use the following API methods to request details about test suites and to create or modify test suites.
+
+    #
+    # Returns an existing test suite.
+    #
+    # :suite_id	The ID of the test suite
+    #
+    def suite(suite_id)
+      get("get_suite/#{suite_id}")
+    end
+
+    def suite_by_name(project_id, suite_name, ignore_case = true)
+      if ignore_case
+        suites(project_id).find { |suite| suite['name'].casecmp(suite_name) == 0 }
+      else
+        suites(project_id).find { |suite| suite['name'] == suite_name }
+      end
+    end
+
+    #
+    # Returns a list of test suites for a project.
+    #
+    # :project_id	The ID of the project
+    #
+    def suites(project_id)
+      get("get_suites/#{project_id}")
+    end
+
+    #
+    # Creates a new test suite.
+    #
+    # :project_id	The ID of the project the test suite should be added to
+    #
+    def add_suite(project_id, data)
+      post("add_suite/#{project_id}", data)
+    end
+  end
+end

data/lib/testrail_api/client/tests.rb

@@ -0,0 +1,44 @@
+module TestRail
+  class Client
+    # Methods for the Tests API
+    # Use the following API methods to request details about tests.
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-tests
+    #
+    # Returns an existing test by its ID
+    ##
+    # @param [Integer, String] test_id  The ID of the test
+    # @return an existing test by its ID
+    # @see http://docs.gurock.com/testrail-api2/reference-runs#add_run
+    def test(test_id)
+      get("get_test/#{test_id}")
+    end
+
+    # TODO: add documentation
+    def test_by_title(run_id, test_title, ignore_case = true)
+      if ignore_case
+        tests(run_id).find { |test| test['title'].casecmp(test_title) == 0 }
+      else
+        tests(run_id).find { |test| test['title'] == test_title }
+
+      end
+    end
+
+    # TODO: add documentation
+    def test_id_by_title(run_id, test_title)
+      test_by_title(run_id, test_title)['id']
+    end
+
+    #
+    # Returns a list of tests for a test run.
+    #
+    # # TODO: finish method and documentation
+    # @param [Integer, String] run_id The ID of the test run
+    # @option [String] status_id
+    # @return an existing test by its ID
+    # @see http://docs.gurock.com/testrail-api2/reference-runs#add_run
+    def tests(run_id)
+      get("get_tests/#{run_id}")
+    end
+  end
+end

data/lib/testrail_api/client/users.rb

@@ -0,0 +1,32 @@
+module TestRail
+  class Client
+    # Methods for the Users API
+    #
+    # @see http://docs.gurock.com/testrail-api2/reference-users
+    #
+
+    # Returns an existing user.
+    #
+    # :user_id  The ID of the user
+    #
+    def user(user_id)
+      get("get_user/#{user_id}")
+    end
+
+    #
+    # Returns a list of users.
+    #
+    def users
+      get('get_users')
+    end
+
+    #
+    # Returns an existing user by his/her email address.
+    #
+    # :email  The email address to get the user for
+    #
+    def user_by_email(email)
+      get("get_user_by_email&email=#{email}")
+    end
+  end
+end

data/lib/testrail_api/endpoints.rb

@@ -0,0 +1,15 @@
+require 'testrail_api/client/case_fields'
+require 'testrail_api/client/case_types'
+require 'testrail_api/client/cases'
+require 'testrail_api/client/milestones'
+require 'testrail_api/client/plans'
+require 'testrail_api/client/priorities'
+require 'testrail_api/client/projects'
+require 'testrail_api/client/result_fields'
+require 'testrail_api/client/runs'
+require 'testrail_api/client/sections'
+require 'testrail_api/client/statuses'
+require 'testrail_api/client/suites'
+require 'testrail_api/client/suites'
+require 'testrail_api/client/tests'
+require 'testrail_api/client/users'

data/lib/testrail_api/version.rb

@@ -0,0 +1,3 @@
+module TestRail
+  VERSION = '0.1.1'.freeze
+end

data/testrail_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'testrail_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'testrail_api'
+  spec.version  = TestRail::VERSION
+  spec.platform = Gem::Platform::RUBY
+
+  spec.authors = ['Kirill Zhukov']
+  spec.email   = ['zhukov.kirill.96@gmail.com']
+
+  spec.summary     = 'Client for TestRail API v2'
+  spec.description = 'Wrapper for TestRail API v2'
+  spec.homepage    = 'https://github.com/kirillzh/testrail_api'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  # Dependencies
+  spec.add_development_dependency('bundler', '~> 1.10')
+  spec.add_development_dependency('rake', '~> 10.0')
+
+  spec.add_dependency('typhoeus', '~> 0.7.2')
+
+  spec.required_ruby_version     = '>= 1.9.2'
+  spec.required_rubygems_version = '>= 1.3.5'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testrail_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kirill Zhukov
@@ -60,7 +60,31 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
 - LICENSE
+- README.md
+- Rakefile
+- lib/testrail_api.rb
+- lib/testrail_api/client.rb
+- lib/testrail_api/client/case_fields.rb
+- lib/testrail_api/client/case_types.rb
+- lib/testrail_api/client/cases.rb
+- lib/testrail_api/client/milestones.rb
+- lib/testrail_api/client/plans.rb
+- lib/testrail_api/client/priorities.rb
+- lib/testrail_api/client/projects.rb
+- lib/testrail_api/client/result_fields.rb
+- lib/testrail_api/client/results.rb
+- lib/testrail_api/client/runs.rb
+- lib/testrail_api/client/sections.rb
+- lib/testrail_api/client/statuses.rb
+- lib/testrail_api/client/suites.rb
+- lib/testrail_api/client/tests.rb
+- lib/testrail_api/client/users.rb
+- lib/testrail_api/endpoints.rb
+- lib/testrail_api/version.rb
+- testrail_api.gemspec
 homepage: https://github.com/kirillzh/testrail_api
 licenses:
 - MIT