easyqa_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0371eb9f0345eb50e8f5b65420cbc1dbd57b6b3f
-  data.tar.gz: 4569839ea9c35f3bed033f1eadc18f7cd77751d0
+  metadata.gz: f14e18926cb681afd1078762ae72921b5d0bf2c9
+  data.tar.gz: 506e20189751e61f39b9a6f1e71444ca8ec9a4cb
 SHA512:
-  metadata.gz: cc38d44ee7a6bb4d2a2130bf336dd4efc6bdf0a0aca22540b2a2d068470dc65ddbb49c0ecac8465f629ade6efd70be321e4c4a1d1304f708c6777e6cd9441c80
-  data.tar.gz: 3a020b5d1e5b7018b95dd1758daa6b7fb869ae568510581758052e040c01b9b7b0e9bf0e4fee0c7c9eb9f271d6c60301a486c214d5f32aedd6a12727dff7eb6a
+  metadata.gz: bab41da387c667eb73694fa39c286d5dc2641ad46cb592bd5a1f69633f955367c44059894efb6b48740ca857eed8bb2e2d8952f6eaf8555475ea84d17d31bef7
+  data.tar.gz: e94fe47f43326ca3b3b43ed4d8eb6ad8df8b952a000cf542caeb6c8c09172543359bebc394b19372e08f903a20dd9856c001d8670eb689eeda2aa5404128ba46

data/lib/easyqa_api/configuration.rb

@@ -1,8 +1,14 @@
+# Simple gem for EasyQA api
 module EasyqaApi
+  # Saves the default config of gem
   class Configuration
     class << self
       attr_accessor :url, :api_version
 
+      # Generate the valid api path for this api_version
+      # @return [String] api path
+      # @example
+      #   EasyqaApi.configuration.api_path #=> '/api/v1/'
       def api_path
         "/api/v#{@api_version}/"
       end
@@ -18,6 +24,12 @@ module EasyqaApi
 
   @configuration = Configuration
 
+  # Setup your params.
+  # @example You can change default params
+  #   EasyqaApi.setup do |config|
+  #     config.url = 'http://app.geteasyqa.com/'
+  #     config.api_version = 1
+  #   end
   def self.setup
     yield @configuration
   end

data/lib/easyqa_api/exceptions.rb

@@ -1,29 +1,46 @@
 module EasyqaApi
-  class NotFoundError < StandardError
-  end
+  # Class for processing exceptions
+  class Exception
+    # Exception for 404 response status
+    class NotFoundError < StandardError
+    end
 
-  class PermissionError < StandardError
-  end
+    # Exception for 403 response status
+    class PermissionError < StandardError
+    end
 
-  class RequestError < StandardError
-  end
+    # Exception for 400 response status
+    class RequestError < StandardError
+    end
 
-  class ValidationError < StandardError
-  end
+    # Exception for 422 response status
+    class ValidationError < StandardError
+    end
 
-  class Exception
+    # Constant for quickly find exception class by response status
     EXCEPTIONS = {
-      404 => EasyqaApi::NotFoundError,
-      403 => EasyqaApi::PermissionError,
-      400 => EasyqaApi::RequestError,
-      422 => EasyqaApi::ValidationError
+      404 => NotFoundError,
+      403 => PermissionError,
+      400 => RequestError,
+      422 => ValidationError
     }.freeze
 
+    # Check response status
+    # @param response [Faraday::Response] the response of your request
+    # @raise [NotFoundError] if status eql 404
+    # @raise [PermissionError] if status eql 403
+    # @raise [RequestError] if status eql 400
+    # @raise [ValidationError] if status eql 422
+    # @see EXCEPTIONS
     def self.check_response_status!(response)
       raise EXCEPTIONS[response.status], response.body['message'] || retrieve_mess(response.body) \
         if EXCEPTIONS[response.status]
     end
 
+    # Retrieve message by response body
+    # @param response_boddy [Hash]
+    # @example
+    #   EasyqaApi::Exception.retrieve_mess({ title: ["can`t be blank"]}) #=> "title: can`t be blank"
     def self.retrieve_mess(response_boddy)
       response_boddy.each_with_object('') do |(key, values), result_message|
         result_message << "#{key}: #{values.join('; ')}\n"

data/lib/easyqa_api/helpers/class_methods_settable.rb

@@ -1,7 +1,18 @@
 module EasyqaApi
+  # This module provides extends instance methods to class
   module ClassMethodsSettable
+    # List of allowed instance methods
     METHODS = [:create, :show, :update, :delete].freeze
 
+    # Provide instance methods to class
+    # @param options [Hash] options for install class methods
+    # @option options [Array] :only only few methods from METHODS constant
+    # @option options [Array] :except except few methods from METHODS constant
+    # @see METHODS
+    # @example With only params
+    #   install_class_methods! only: [:update, :delete]
+    # @example With except params
+    #   install_class_methods! except: [:create]
     def install_class_methods!(options = {})
       METHODS.each do |method_name|
         define_singleton_method method_name do |*attrs|

data/lib/easyqa_api/item.rb

@@ -1,9 +1,51 @@
 require 'faraday_middleware'
 
+# @!macro project_token_param
+#   @param project_token [String] token of project
+
+# @!macro id_param
+#   @param id [String] item id
+
+# @!macro auth_user_param
+#   @param user [Easyqapi::User] authenticated user in EasyQA
+
+# @!macro see_default_user
+#   @see @@default_user
+
+# @!macro item_action_return
+#   Have a class method analog
+#   @macro auth_user_param
+#   @return [Hash] item attribtues on EasyQA website
+#   @see EasyqaApi::ClassMethodsSettable
+#   @macro see_default_user
+
+# @!macro item_action_return_with_attrs
+#   @macro item_action_return
+#   @param attrs [Hash] attributes for action
+#   @option attrs [String] :project_token (@project_token) Project token on EasyQA
+
+# @!macro item_action_return_with_attrs_and_id
+#   @macro item_action_return_with_attrs
+#   @option attrs [Fixnum] :id (@id) uniq item identeficator
+
+# @!macro default_attributes
+#   @!attribute [rw] id
+#     @return [Fixnum] The uniq identeficator item on EasyQA website
+#   @!attribute [rw] attributes
+#     @return [Hash] item attributes from response body in your requests
+
+# @!macro default_attributes_with_project_token
+#   @macro default_attributes
+#   @!attribute [rw] project_token
+#     @return [String] your project token
 module EasyqaApi
+  # The class for representation EasyQA objects
   class Item
     extend ClassMethodsSettable
 
+    # constant for Faradat connection by content type
+    # @see EasyqaApi::Item.json_connection
+    # @see EasyqaApi::Item.multipart_connection
     CONNECTION = {
       json: {
         instance: -> { json_connection },
@@ -15,7 +57,14 @@ module EasyqaApi
       }
     }.freeze
 
+    # Deafult user in EasyqaApi Items.
+    #   If you set this attributes you can use any methods without set user in all methods
+    # @see User#set_default!
+    @@default_user = nil
+
     class << self
+      # retrieve or create Faraday json connection
+      # @return [Faraday::Connection] Faraday json connection
       def json_connection
         @json_connection ||= Faraday.new(url: EasyqaApi.configuration.url) do |faraday|
           faraday.request :json
@@ -24,6 +73,8 @@ module EasyqaApi
         end
       end
 
+      # retrieve or create Faraday multipart connection
+      # @return [Faraday::Connection] Faraday multipart connection
       def multipart_connection
         @multipart_connection ||= Faraday.new(url: EasyqaApi.configuration.url) do |faraday|
           faraday.request :multipart
@@ -32,6 +83,26 @@ module EasyqaApi
         end
       end
 
+      # Send request to EasyQA api within default configuration
+      # @param url [String] url for method
+      # @param html_method [Symbol] html method for request
+      # @param type [Symbol] type of request
+      # @yield faraday request config
+      # @example
+      #   send_request('projects', :post) do |req|
+      #     req.body = {
+      #       project: {
+      #         title: 'Test Project'
+      #       },
+      #       organization_id: 1,
+      #       auth_token: 'IcdHzYZXDlX8SsjoOC5MV59lPVPzbaEUuUgZly3ESmopojMaN5pNlzOJCAV2_Rfe'
+      #     }
+      #   end
+      # @return [Hash] response body
+      # @raise [NotFoundError, PermissionError, RequestError, ValidationError] if request fail
+      # @see EasyqaApi::Exception.check_response_status!
+      # @see CONNECTION
+      # @see EasyqaApi::Configuration
       def send_request(url, html_method, type = :json, &block)
         response = EasyqaApi::Item::CONNECTION[type][:instance].call.send(html_method) do |req|
           req.url EasyqaApi.configuration.api_path + url
@@ -42,6 +113,11 @@ module EasyqaApi
         operation_status(response)
       end
 
+      # Processing response
+      # @param response [Faraday::Response] response of your request
+      # @raise [NotFoundError, PermissionError, RequestError, ValidationError] if response not valid
+      # @return [Hash] response body
+      # @see EasyqaApi::Exception.check_response_status!
       def operation_status(response)
         EasyqaApi::Exception.check_response_status!(response)
         response.body
@@ -51,8 +127,8 @@ module EasyqaApi
     def initialize(*_args)
     end
 
-    @@default_user = nil
-
+    # Install variables for Item instance if key in attribute has a valid setter in instance
+    # @param arguments [Hash]
     def install_variables!(arguments)
       allowed_methods = retrive_allowed_methods
       arguments.each do |key, value|

data/lib/easyqa_api/items/issue.rb

@@ -1,9 +1,41 @@
+# @!macro [new] issue_attributes_simple
+#   @macro item_action_return_with_attrs_and_id
+#   @option attrs [Fixnum] :id_in_project uniq issue identeficator in project
+
+# @!macro [new] issue_attributes
+#   @macro item_action_return
+#   @param [Hash] attrs attributes for action
+#   @option attrs [String] :project_token (@project_token) token of Project on EasyQA
+#   @option attrs [String] :summary issue summary. This options required for create issue
+#   @option attrs [Fixnum] :test_object_id test object uniq identefiactor on EasyQA
+#   @option attrs [String] :description issue description
+#   @option attrs [String] :issue_type Issue type.
+#     Can be in 'no_type', 'documentation', 'task', 'feature', 'usability_problem', 'bug', 'crash'
+#   @option attrs [String] :priority Issue priority.
+#     Can be in 'low', 'medium', 'high', 'critical'
+#   @option attrs [Fixnum] :assigner_id Issue assigner uniq identeficator on EasyQA
+#   @option attrs [Array<Faraday::UploadIO>] :attachments Array of attachments
+#   @see EasyqaApi::TestObject
 module EasyqaApi
+  # The class for representation EasyQA Issue object
   class Issue < Item
+    # @!attribute [rw] id
+    #   @return [Fixnum] The uniq identeficator issue in EasyQA website
+    #   @return [String] The uniq identeficator issue in yuor project.
+    #     In format "pid_your_id_"
+    # @!attribute [rw] attributes
+    #   @return [Hash] attributes item from response body in your requests
+    # @!attribute [rw] project_token
+    #   @return [String] your project token
     attr_accessor :id, :attributes, :project_token
 
     install_class_methods!
 
+    # Retrieve all issues in project
+    # @macro project_token_param
+    # @macro auth_user_param
+    # @return [Array] list of issues on EasyQA website
+    # @macro see_default_user
     def self.all(project_token, user = @@default_user)
       send_request('issues', :get) do |req|
         req.params = {
@@ -13,16 +45,21 @@ module EasyqaApi
       end
     end
 
+    # Create new issue on EasyQA website.
+    # @!macro issue_attributes
     def create(attrs, user = @@default_user)
       attrs = { project_token: @project_token }.merge(attrs)
       @attributes = send_request('projects/issues/create', :post, :multipart) do |req|
         req.body = {
           token: attrs[:project_token],
-          auth_token: user.auth_token,
-        }.merge(attrs.except(:project_token))
+          auth_token: user.auth_token
+        }.merge(attrs.except(:project_token, :attachments))
+         .merge(retrieve_attachments(attrs[:attachments]))
       end
     end
 
+    # Show issue attributes on EasyQA website.
+    # @!macro issue_attributes_simple
     def show(attrs = {}, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       attrs[:id] = "pid#{attrs.delete(:id_in_project)}" if attrs[:id_in_project]
@@ -34,6 +71,10 @@ module EasyqaApi
       end
     end
 
+    # Update issue on EasyQA website.
+    # @!macro issue_attributes
+    # @option attrs [Fixnum] :id_in_project uniq issue identeficator in project
+    # @option attrs [Fixnum] :id uniq issue identeficator on EasyQA
     def update(attrs, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       attrs[:id] = "pid#{attrs.delete(:id_in_project)}" if attrs[:id_in_project]
@@ -45,6 +86,8 @@ module EasyqaApi
       end
     end
 
+    # Delete issue on EasyQA website.
+    # @!macro issue_attributes_simple
     def delete(attrs = {}, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       attrs[:id] = "pid#{attrs.delete(:id_in_project)}" if attrs[:id_in_project]
@@ -55,5 +98,14 @@ module EasyqaApi
         }
       end
     end
+
+    private
+
+    def retrieve_attachments(attachments)
+      iterator = 1
+      attachments.each_with_object({}) do |attachment, hash|
+        hash["attachment#{iterator += 1}"] = attachment
+      end
+    end
   end
 end

data/lib/easyqa_api/items/issue_attachment.rb

@@ -1,9 +1,19 @@
 module EasyqaApi
+  # Representation Issue attachment on EasyQA
   class IssueAttachment < Item
+    # @macro default_attributes_with_project_token
+    # @!attribute [rw] issue_id
+    #   @return [Fixnum] The uniq identeficator issue in EasyQA website
+    #   @return [String] The uniq identeficator issue in yuor project.
+    #     In format "pid_your_id_"
     attr_accessor :id, :attributes, :project_token, :issue_id
 
     install_class_methods! only: [:create, :delete]
 
+    # Create attachment on EasyQA website.
+    # @macro item_action_return_with_attrs
+    # @option attrs [Fixnum] :issue_id (@id) uniq issue identeficator
+    # @option attrs [Fixnum] :issue_id_in_project (@id) uniq issue identeficator in project
     def create(attrs, user = @@default_user)
       attrs = { project_token: @project_token, issue_id: @issue_id }.merge(attrs)
       attrs[:issue_id] = "pid#{attrs.delete(:issue_id_in_project)}" if attrs[:issue_id_in_project]
@@ -15,6 +25,8 @@ module EasyqaApi
       end
     end
 
+    # Delete attachment on EasyQA website.
+    # @macro item_action_return_with_attrs_and_id
     def delete(attrs = {}, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       @attributes = send_request("attachments/#{attrs[:id]}", :delete) do |req|

data/lib/easyqa_api/items/organization.rb

@@ -1,9 +1,26 @@
+# @!macro organization_with_attrs
+#   @macro item_action_return
+#   @param attrs [Hash] attributes for action
+#   @option attrs [String] :title title of organization
+#   @option attrs [String] :description description of organization
+
+# @!macro organization_without_attrs
+#   @macro item_action_return
+#   @param id [Fixnum] organization id on EasyQA website
 module EasyqaApi
+  # Organization representation from EasyQA
   class Organization < Item
-    attr_accessor :title, :description, :id, :attributes
+    # @macro default_attributes
+    # @!attribute [rw] title
+    #   @return [String] Title of organization on EasyQA
+    attr_accessor :title, :id, :attributes
 
     install_class_methods!
 
+    # Retrieve all organizations from user
+    # @macro auth_user_param
+    # @return [Array] list of organizations on EasyQA website
+    # @macro see_default_user
     def self.all(user = @@default_user)
       send_request('organizations', :get) do |req|
         req.params = {
@@ -12,6 +29,8 @@ module EasyqaApi
       end
     end
 
+    # Create organization on EasyQA website
+    # @!macro organization_with_attrs
     def create(attrs, user = @@default_user)
       @attributes = send_request('organizations', :post) do |req|
         req.body = {
@@ -21,6 +40,8 @@ module EasyqaApi
       end
     end
 
+    # Show a organization on EasyQA website
+    # @!macro organization_without_attrs
     def show(id = @id, user = @@default_user)
       @attributes = send_request("organizations/#{id}", :get) do |req|
         req.params = {
@@ -29,6 +50,9 @@ module EasyqaApi
       end
     end
 
+    # Update organization on EasyQA website
+    # @!macro organization_with_attrs
+    # @option attrs [Fixnum] :id (@id) organization id on EasyQA website
     def update(attrs, user = @@default_user)
       attrs = { id: @id }.merge(attrs)
       @attributes = send_request("organizations/#{attrs[:id]}", :put) do |req|
@@ -39,6 +63,8 @@ module EasyqaApi
       end
     end
 
+    # Delete organization on EasyQA website
+    # @!macro organization_without_attrs
     def delete(id = @id, user = @@default_user)
       @attributes = send_request("organizations/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/project.rb

@@ -1,9 +1,25 @@
+# @!macro project_with_attrs
+#   @macro item_action_return
+#   @param attrs [Hash] attributes for action
+#   @option attrs [String] :title title of organization
+
+# @!macro project_without_attrs
+#   @macro item_action_return
+#   @param id [Fixnum] project id on EasyQA website
 module EasyqaApi
+  # Project representation from EasyQA
   class Project < Item
+    # @macro default_attributes
+    # @!attribute [rw] title
+    #   @return [String] Project title on EasyQA website
     attr_accessor :title, :id, :attributes
 
     install_class_methods!
 
+    # Retrieve all projects from user
+    # @macro auth_user_param
+    # @return [Array] list of projects on EasyQA website
+    # @macro see_default_user
     def self.all(user = @@default_user)
       send_request('projects', :get) do |req|
         req.params = {
@@ -12,6 +28,9 @@ module EasyqaApi
       end
     end
 
+    # Create project on EasyQA.
+    # @macro project_with_attrs
+    # @option attrs [String] :organization_id organization id on EasyQA website
     def create(attrs, user = @@default_user)
       @attributes = send_request('projects', :post) do |req|
         req.body = {
@@ -22,6 +41,8 @@ module EasyqaApi
       end
     end
 
+    # Show project from EasyQA.
+    # @macro project_without_attrs
     def show(id = @id, user = @@default_user)
       @attributes = send_request("projects/#{id}", :get) do |req|
         req.params = {
@@ -30,6 +51,9 @@ module EasyqaApi
       end
     end
 
+    # Update project on EasyQA.
+    # @macro project_with_attrs
+    # @option attrs [String] :id project id on EasyQA website
     def update(attrs, user = @@default_user)
       attrs = { id: @id }.merge(attrs)
       @attributes = send_request("projects/#{attrs[:id]}", :put) do |req|
@@ -40,6 +64,8 @@ module EasyqaApi
       end
     end
 
+    # Delete project on EasyQA.
+    # @macro project_without_attrs
     def delete(id = @id, user = @@default_user)
       @attributes = send_request("projects/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/role.rb

@@ -1,9 +1,28 @@
+# @!macro role_with_attrs
+#   @macro item_action_return
+#   @param attrs [Hash] action attributes
+#   @option attrs [String] :role role name
+
+# @!macro role_without_attrs
+#   @macro item_action_return
+#   @param id [String] role id on EasyQA website
 module EasyqaApi
+  # Role representation from EasyQA website
+  #   Project role can be 'developer', 'tester', 'viewer' or 'project_manager'
+  #   Organization role can be 'user' or 'admin'
   class Role < Item
+    # @macro default_attributes
+    # @!attribute [rw] role
+    #   @return [String] Role user in currentproject or organization
     attr_accessor :role, :id, :attributes
 
     install_class_methods!
 
+    # Retrieve all roles from organization
+    # @macro auth_user_param
+    # @param organization_id [Fixnum] Organization id on EasyQA website
+    # @return [Array] list of organization roles on EasyQA website
+    # @macro see_default_user
     def self.all(organization_id, user = @@default_user)
       send_request("organizations/#{organization_id}/roles", :get) do |req|
         req.params = {
@@ -12,6 +31,11 @@ module EasyqaApi
       end
     end
 
+    # Create role on EasyQA website.
+    # @!macro role_with_attrs
+    # @option attrs [Fixnum] :organization_id organization id on EasyQA website
+    # @option attrs [Fixnum] :user_id user id on EasyQA website.
+    # @option attrs [String] :project_token Project token on EasyQA. Add this option if you want create project role
     def create(attrs, user = @@default_user)
       @attributes = send_request("organizations/#{attrs[:organization_id]}/roles", :post) do |req|
         req.body = {
@@ -20,6 +44,8 @@ module EasyqaApi
       end
     end
 
+    # Show role from EasyQA website.
+    # @macro role_without_attrs
     def show(id = @id, user = @@default_user)
       @attributes = send_request("roles/#{id}", :get) do |req|
         req.params = {
@@ -28,6 +54,9 @@ module EasyqaApi
       end
     end
 
+    # Update role on EasyQA website.
+    # @macro role_without_attrs
+    # @param role [Fixnum] role name on EasyQA website
     def update(role, id = @id, user = @@default_user)
       @attributes = send_request("roles/#{id}", :put) do |req|
         req.body = {
@@ -37,6 +66,8 @@ module EasyqaApi
       end
     end
 
+    # Delete role on EasyQA website.
+    # @macro role_without_attrs
     def delete(id = @id, user = @@default_user)
       @attributes = send_request("roles/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/status.rb

@@ -1,9 +1,26 @@
+# @!macro status_with_attrs
+#   @macro item_action_return_with_attrs_and_id
+#   @option attrs [String] :name status name
+
+# @!macro status_without_attributes
+#   @macro item_action_return
+#   @param id [Fixnum] status id on EasyQA website
+#   @param project_token [Fixnum] project token on EasyQA website
 module EasyqaApi
+  # Status representation on EasyQA website
   class Status < Item
+    # @macro default_attributes_with_project_token
+    # @!attribute [rw] name
+    #   @return [String] Status name on EasyQA
     attr_accessor :name, :id, :attributes, :project_token
 
     install_class_methods!
 
+    # Retrieve all issues in project
+    # @macro project_token_param
+    # @macro auth_user_param
+    # @return [Array] list of statuses on EasyQA website
+    # @macro see_default_user
     def self.all(project_token, user = @@default_user)
       send_request('statuses', :get) do |req|
         req.params = {
@@ -13,6 +30,8 @@ module EasyqaApi
       end
     end
 
+    # Create status on EasyQA website
+    # @macro status_with_attrs
     def create(attrs, user = @@default_user)
       attrs = { project_token: @project_token }.merge(attrs)
       @attributes = send_request('statuses', :post) do |req|
@@ -24,6 +43,8 @@ module EasyqaApi
       end
     end
 
+    # Show status from EasyQA website
+    # @macro status_without_attributes
     def show(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("statuses/#{id}", :get) do |req|
         req.params = {
@@ -33,6 +54,9 @@ module EasyqaApi
       end
     end
 
+    # Update status on EasyQA website
+    # @macro status_with_attrs
+    # @option attrs [Fixnum] :id (@id) status id on EasyQA website
     def update(attrs, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       @attributes = send_request("statuses/#{attrs[:id]}", :put) do |req|
@@ -44,6 +68,8 @@ module EasyqaApi
       end
     end
 
+    # Delete status on EasyQA website
+    # @macro status_without_attributes
     def delete(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("statuses/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/test_case.rb

@@ -1,9 +1,37 @@
+# @!macro test_case_with_attrs
+#   @macro item_action_return_with_attrs
+#   @option attrs [String] :title test case title on EasyQA website
+#   @option attrs [String] :pre_steps test case pre steps
+#   @option attrs [String] :steps Test Case steps.
+#   @option attrs [String] :expected_result Test Case expected result.
+#   @option attrs [String] :case_type Type of test case.
+#     Can be 'positive', 'negative', 'boundary', 'integration', 'ui' or 'localization'
+#   @see EasyqaApi::TestModule
+
+# @!macro test_case_without_attrs
+#   @macro item_action_return
+#   @macro project_token_param
+#   @!macro id_param
 module EasyqaApi
+  # Test case representation from EasyQA website
   class TestCase < Item
+    # @macro default_attributes_with_project_token
+    # @!attribute [rw] title
+    #   @return [String] Test case title on EasyQA
+    # @!attribute [rw] module_id
+    #   @return [String] Test module id on EasyQA
     attr_accessor :title, :id, :attributes, :project_token, :module_id
 
     install_class_methods!
 
+    # List of all test cases
+    # @param attrs [Hash] attributes for action
+    # @option attrs [String] :project_token project_token on EasyQA website
+    # @option attrs [String] :parent_name Can be "test_plan" or "test_module".
+    # @option attrs [Fixnum] :parent_id Id of test plan and test module according
+    # @macro auth_user_param
+    # @return [Array] list of test_cases on EasyQA website
+    # @macro see_default_user
     def self.all(attrs, user = @@default_user)
       send_request("#{attrs[:parent_name]}/#{attrs[:parent_id]}/test_cases", :get) do |req|
         req.params = {
@@ -13,6 +41,9 @@ module EasyqaApi
       end
     end
 
+    # Create test case on EasyQA website.
+    # @macro test_case_with_attrs
+    # @option attrs [Fixnum] :test_module_id Test module id
     def create(attrs, user = @@default_user)
       attrs = { project_token: @project_token, module_id: @module_id }.merge(attrs)
       @attributes = send_request("test_modules/#{attrs[:module_id]}/test_cases", :post) do |req|
@@ -24,6 +55,8 @@ module EasyqaApi
       end
     end
 
+    # Show Test Case from EasyQA website.
+    # @!macro test_case_without_attrs
     def show(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_cases/#{id}", :get) do |req|
         req.params = {
@@ -33,6 +66,9 @@ module EasyqaApi
       end
     end
 
+    # Update Test Case on EasyQA website.
+    # @!macro test_case_with_attrs
+    # @option attrs [Fixnum] :id (@id) item id
     def update(attrs, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       @attributes = send_request("test_cases/#{attrs[:id]}", :put) do |req|
@@ -44,6 +80,8 @@ module EasyqaApi
       end
     end
 
+    # Delete Test Case on EasyQA website.
+    # @!macro test_case_without_attrs
     def delete(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_cases/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/test_module.rb

@@ -1,9 +1,33 @@
+# @!macro test_module_with_attrs
+#   @macro item_action_return_with_attrs
+#   @option attrs [String] :title test module title on EasyQA website
+#   @option attrs [String] :description test module description
+#   @option attrs [Fixnum] :parent_id id of parent test module.
+#     If you give this parameter, this test module will be nested in parent test module.
+#   @see EasyqaApi::TestPlan
+
+# @!macro test_module_without_attrs
+#   @macro item_action_return
+#   @macro project_token_param
+#   @!macro id_param
 module EasyqaApi
+  # Test module representation from EasyQA website
   class TestModule < Item
+    # @macro default_attributes_with_project_token
+    # @!attribute [rw] title
+    #   @return [String] Test module title on EasyQA
+    # @!attribute [rw] test_plan_id
+    #   @return [String] Test plan id on EasyQA
     attr_accessor :title, :id, :attributes, :project_token, :test_plan_id
 
     install_class_methods!
 
+    # List of all test modules
+    # @param test_plan_id [Fixnum] Test plan id on EasyQA website
+    # @macro project_token_param
+    # @macro auth_user_param
+    # @return [Array] list of test modules on EasyQA website
+    # @macro see_default_user
     def self.all(project_token, test_plan_id, user = @@default_user)
       send_request("test_plans/#{test_plan_id}/test_modules", :get) do |req|
         req.params = {
@@ -13,6 +37,9 @@ module EasyqaApi
       end
     end
 
+    # Create test module on EasyQA website.
+    # @macro test_module_with_attrs
+    # @option attrs [Fixnum] :test_plan_id (@test_plan_id) Test plan id
     def create(attrs, user = @@default_user)
       attrs = { project_token: @project_token, test_plan_id: @test_plan_id }.merge(attrs)
       @attributes = send_request("test_plans/#{attrs[:test_plan_id]}/test_modules", :post) do |req|
@@ -24,6 +51,8 @@ module EasyqaApi
       end
     end
 
+    # Show Test Case from EasyQA website.
+    # @!macro test_module_without_attrs
     def show(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_modules/#{id}", :get) do |req|
         req.params = {
@@ -33,6 +62,9 @@ module EasyqaApi
       end
     end
 
+    # Update Test Case on EasyQA website.
+    # @!macro test_module_with_attrs
+    # @option attrs [Fixnum] :id (@id) item id
     def update(attrs, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       @attributes = send_request("test_modules/#{attrs[:id]}", :put) do |req|
@@ -44,6 +76,8 @@ module EasyqaApi
       end
     end
 
+    # Delete Test Case on EasyQA website.
+    # @!macro test_module_without_attrs
     def delete(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_modules/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/test_object.rb

@@ -1,9 +1,20 @@
+# @!macro test_object_params
+#   @macro item_action_return
+#   @macro project_token_param
+#   @macro id_param
 module EasyqaApi
+  # Test object representation from EasyQA website
   class TestObject < Item
+    # @macro default_attributes_with_project_token
     attr_accessor :id, :attributes, :project_token
 
     install_class_methods! except: [:update]
 
+    # List of all test objects
+    # @macro auth_user_param
+    # @macro project_token_param
+    # @return [Array] list of test objects on EasyQA website
+    # @macro see_default_user
     def self.all(project_token, user = @@default_user)
       send_request('test_objects', :get) do |req|
         req.params = {
@@ -13,6 +24,10 @@ module EasyqaApi
       end
     end
 
+    # Create test object on EasyQA website
+    # @macro item_action_return_with_attrs
+    # @option attrs [String] :link link to your webiste for web object on EasyQA website
+    # @option attrs [Faraday::UploadIO] :file your apk or ipa file
     def create(attrs, user = @@default_user)
       attrs = { project_token: @project_token }.merge(attrs)
       @attributes = send_request('test_objects', :post, :multipart) do |req|
@@ -23,6 +38,8 @@ module EasyqaApi
       end
     end
 
+    # Show test object from EasyQA website
+    # @macro test_object_params
     def show(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_objects/#{id}", :get) do |req|
         req.params = {
@@ -32,6 +49,8 @@ module EasyqaApi
       end
     end
 
+    # Delete test object on EasyQA website
+    # @macro test_object_params
     def delete(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_objects/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/test_plan.rb

@@ -1,9 +1,27 @@
+# @!macro test_plan_with_attrs
+#   @macro item_action_return_with_attrs
+#   @option attrs [String] :title test plan title on EasyQA website
+#   @option attrs [String] :description test case pre steps
+
+# @!macro test_plan_without_attrs
+#   @macro item_action_return
+#   @macro project_token_param
+#   @macro id_param
 module EasyqaApi
+  # Test plan representation from EasyQA website
   class TestPlan < Item
+    # @macro default_attributes_with_project_token
+    # @!attribute [rw] title
+    #   @return [String] Test plan title on EasyQA
     attr_accessor :title, :id, :attributes, :project_token
 
     install_class_methods!
 
+    # List of all test plans in project
+    # @macro auth_user_param
+    # @macro project_token_param
+    # @return [Array] list of test plans on EasyQA website
+    # @macro see_default_user
     def self.all(project_token, user = @@default_user)
       send_request('test_plans', :get) do |req|
         req.params = {
@@ -13,6 +31,8 @@ module EasyqaApi
       end
     end
 
+    # Create test plan on EasyQA website.
+    # @macro test_plan_with_attrs
     def create(attrs, user = @@default_user)
       attrs = { project_token: @project_token }.merge(attrs)
       @attributes = send_request('test_plans', :post) do |req|
@@ -24,6 +44,8 @@ module EasyqaApi
       end
     end
 
+    # Show test plan from EasyQA website.
+    # @macro test_plan_without_attrs
     def show(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_plans/#{id}", :get) do |req|
         req.params = {
@@ -33,6 +55,9 @@ module EasyqaApi
       end
     end
 
+    # Update test plan on EasyQA website.
+    # @macro test_plan_with_attrs
+    # @option attrs [Fixnum] :id (@id) test plan id on EasyQA website
     def update(attrs, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       @attributes = send_request("test_plans/#{attrs[:id]}", :put) do |req|
@@ -44,6 +69,8 @@ module EasyqaApi
       end
     end
 
+    # Delete test plan on EasyQA website.
+    # @macro test_plan_without_attrs
     def delete(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_plans/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/test_run.rb

@@ -1,9 +1,36 @@
+# @!macro test_run_with_attrs
+#   @macro item_action_return
+#   @param [Hash] attrs
+#     * :project_token (String) [@project_token] Project token on EasyQA
+#     * :title (String) test run title on EasyQA website
+#     * :assigner_id (Fixnum) test run assigner id on EasyQA website
+#     * :test_plan_id (Fixnum) test plan id on EasyQA website
+#     * :description (String) test run description on EasyQA website
+#     * :test_run_result_attributes (Array<Hash>) attributes of test run results.
+#       * :test_plan_id (Fixnum) id of test plan
+#       * :test_case_id (Fixnum) test case id
+#       * :id (Fixnum) test run result id
+#       * :_destroy (TrueClass, FalseClass) if you set this
+#         attribute true with attribute id, this test run result will be deleted
+#   @note If you add test plan id to tes_run_result_attributes all test cases from this test plan
+#     has been included to your test run
+
+# @!macro test_run_without_attrs
+#   @macro item_action_return
+#   @macro project_token_param
+#   @macro id_param
 module EasyqaApi
+  # Test Run representation from EasyQA website
   class TestRun < Item
     attr_accessor :title, :id, :attributes, :project_token
 
     install_class_methods!
 
+    # List of all test runs in project
+    # @macro auth_user_param
+    # @macro project_token_param
+    # @return [Array] list of test runs on EasyQA website
+    # @macro see_default_user
     def self.all(project_token, user = @@default_user)
       send_request('test_runs', :get) do |req|
         req.params = {
@@ -13,6 +40,8 @@ module EasyqaApi
       end
     end
 
+    # Create test run on EasyQA website.
+    # @macro test_run_with_attrs
     def create(attrs, user = @@default_user)
       attrs = { project_token: @project_token }.merge(attrs)
       @attributes = send_request('test_runs', :post) do |req|
@@ -24,6 +53,8 @@ module EasyqaApi
       end
     end
 
+    # Show test run from EasyQA website.
+    # @!macro test_run_without_attrs
     def show(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_runs/#{id}", :get) do |req|
         req.params = {
@@ -33,6 +64,9 @@ module EasyqaApi
       end
     end
 
+    # Update test run on EasyQA website.
+    # @macro test_run_with_attrs
+    # @option attrs [Fixnum] :id (@id) test run id
     def update(attrs, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       @attributes = send_request("test_runs/#{attrs[:id]}", :put) do |req|
@@ -44,6 +78,8 @@ module EasyqaApi
       end
     end
 
+    # Delete test run on EasyQA website.
+    # @!macro test_run_without_attrs
     def delete(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_runs/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/test_run_result.rb

@@ -1,9 +1,23 @@
+# @!macro test_run_results_without_attrs
+#   @macro item_action_return
+#   @macro project_token_param
+#   @macro id_param
 module EasyqaApi
+  # Test run result representation from EasyQA website
   class TestRunResult < Item
+    # @macro default_attributes_with_project_token
+    # @!attribute [rw] test_run_id
+    #   @return [String] Test run id on EasyQA
     attr_accessor :id, :attributes, :project_token, :test_run_id
 
     install_class_methods!
 
+    # List of all test run results in test run
+    # @macro auth_user_param
+    # @macro project_token_param
+    # @param test_run_id [Fixnum] test run id on EasyQA website
+    # @return [Array] list of test run results
+    # @macro see_default_user
     def self.all(project_token, test_run_id, user = @@default_user)
       send_request("test_runs/#{test_run_id}/test_run_results", :get) do |req|
         req.params = {
@@ -13,17 +27,8 @@ module EasyqaApi
       end
     end
 
-    def create(attrs, user = @@default_user)
-      attrs = { project_token: @project_token, test_run_id: @test_run_id }.merge(attrs)
-      @attributes = send_request("test_runs/#{attrs[:test_run_id]}/test_run_results", :post) do |req|
-        req.body = {
-          test_run_result: attrs.except(:project_token, :test_run_id),
-          token: attrs[:project_token],
-          auth_token: user.auth_token
-        }
-      end
-    end
-
+    # Show test run result from EasyQA website
+    # @macro test_run_results_without_attrs
     def show(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_run_results/#{id}", :get) do |req|
         req.params = {
@@ -33,6 +38,10 @@ module EasyqaApi
       end
     end
 
+    # @macro item_action_return_with_attrs_and_id
+    # @option attrs [Fixnum] :test_case_id test case id on EasyQA website
+    # @option attrs [String] :result_status test run result status
+    # @note test_run_result_status can be 'pass', 'block', 'untested' or 'fail'
     def update(attrs, user = @@default_user)
       attrs = { id: @id, project_token: @project_token }.merge(attrs)
       @attributes = send_request("test_run_results/#{attrs[:id]}", :put) do |req|
@@ -44,6 +53,8 @@ module EasyqaApi
       end
     end
 
+    # Delete test run result on EasyQA website
+    # @macro test_run_results_without_attrs
     def delete(project_token = @project_token, id = @id, user = @@default_user)
       @attributes = send_request("test_run_results/#{id}", :delete) do |req|
         req.params = {

data/lib/easyqa_api/items/user.rb

@@ -1,7 +1,18 @@
 module EasyqaApi
+  # User representation from EasyQA website
   class User < Item
+    # @!attribute [rw] auth_token
+    #   @return [String] user auth_token on EasyQA website
+    # @!attribute [rw] name
+    #   @return [String] user name on EasyQA website
     attr_accessor :auth_token, :name
 
+    # @param attrs [Hash] param for action
+    # @option attrs [String] :email user email
+    # @option attrs [String] :password user password
+    # @note If you give user email and password you will be already signed on EasyQA.
+    # @see auth_token
+    # @see sign_in
     def initialize(attrs = {})
       super
       install_variables!(
@@ -9,6 +20,11 @@ module EasyqaApi
       )
     end
 
+    # Sign in user on EasyQA website
+    # @param email [String] Email user on EasyQA
+    # @param password [String] password user on EasyQA
+    # @return [Hash] user attributes on EasyQA webiste
+    # @see auth_token
     def sign_in(email, password)
       send_request('sign_in', :post) do |req|
         req.body = {
@@ -20,12 +36,18 @@ module EasyqaApi
       end
     end
 
+    # Sign out user on EasyQA website
+    # @return [Hash] user attributes on EasyQA webiste
+    # @see auth_token
     def sign_out
       send_request('sign_out', :delete) do |req|
-        req.body = { auth_token: auth_token || @auth_token }
+        req.body = { auth_token: @auth_token }
       end
     end
 
+    # Set default user on EasyqaApi
+    # @return [EasyqaApi::User] current user
+    # @see EasyqaApi::Item::@@default_user
     def set_default!
       @@default_user = self
     end

data/lib/easyqa_api/version.rb

@@ -1,3 +1,4 @@
 module EasyqaApi
-  VERSION = '0.0.2'
+  # EasyqaApi gem version
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easyqa_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Thinkmobiles
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler