mints 0.0.28 → 0.0.29

data/lib/user/config/relationships.rb

@@ -1,138 +1,141 @@
+# frozen_string_literal: true
+
 module Relationships
-    ##
-    # == Relationships
-    #
-    
-    # === Get relationships available for.
-    # Get relationships available.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== Example
-    #     options = {
-    #       "objectType": "contacts"
-    #     }
-    #     @data = @mints_user.get_relationships_available_for(options)
-    def get_relationships_available_for(options)
-        @client.raw('get', "/config/relationships/available-for", options)
-    end
-    
-    # === Attach relationship.
-    # Attach a relationship.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     
-    def attach_relationship(data) #FIXME: Method doesn't work, RelationshipManager cannot access to id attribute.
-        @client.raw('post', "/config/relationships/attach", nil, data_transform(data))
-    end
+  ##
+  # == Relationships
+  #
+  # === Get relationships available for.
+  # Get relationships available.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     options = {
+  #       objectType: 'contacts'
+  #     }
+  #     @data = @mints_user.get_relationships_available_for(options)
+  def get_relationships_available_for(options)
+    @client.raw('get', '/config/relationships/available-for', options)
+  end
+
+  # === Attach relationship.
+  # Attach a relationship.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #
+  def attach_relationship(data)
+    # FIXME: Method doesn't work, RelationshipManager cannot access to id attribute.
+    @client.raw('post', '/config/relationships/attach', nil, data_transform(data))
+  end
+
+  # === Detach relationship.
+  # Detach a relationship.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #
+  def detach_relationship(data)
+    # FIXME: Method doesn't work, RelationshipManager cannot access to id attribute.
+    @client.raw('post', '/config/relationships/detach', nil, data_transform(data))
+  end
+
+  # === Relationship has objects.
+  # Get relationships that has objects.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Relationship id.
+  #
+  # ==== Example
+  #     @data = @mints_user.relationship_has_objects(1)
+  def relationship_has_objects(id)
+    @client.raw('get', "/config/relationships/#{id}/hasObjects")
+  end
 
-    # === Detach relationship.
-    # Detach a relationship.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     
-    def detach_relationship(data) #FIXME: Method doesn't work, RelationshipManager cannot access to id attribute.
-        @client.raw('post', "/config/relationships/detach", nil, data_transform(data))
-    end
-    
-    # === Relationship has objects.
-    # Get relationships that has objects.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Relationship id.
-    #
-    # ==== Example
-    #     @data = @mints_user.relationship_has_objects(1)
-    def relationship_has_objects(id)
-        @client.raw('get', "/config/relationships/#{id}/hasObjects")
-    end
-    
-    # === Get relationships.
-    # Get a collection of relationships.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_relationships
-    #
-    # ==== Second Example
-    #     options = { fields: "id" }
-    #     @data = @mints_user.get_relationships(options)
-    def get_relationships(options = nil)
-        @client.raw('get', "/config/relationships", options)
-    end
+  # === Get relationships.
+  # Get a collection of relationships.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_relationships
+  #
+  # ==== Second Example
+  #     options = { fields: 'id' }
+  #     @data = @mints_user.get_relationships(options)
+  def get_relationships(options = nil)
+    @client.raw('get', '/config/relationships', options)
+  end
 
-    # === Get relationship.
-    # Get a relationship info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Relationship id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_relationship(1)
-    #
-    # ==== Second Example
-    #     options = { fields: "id" }
-    #     @data = @mints_user.get_relationship(1, options)
-    def get_relationship(id, options = nil)
-        @client.raw('get', "/config/relationships/#{id}", options)
-    end
+  # === Get relationship.
+  # Get a relationship info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Relationship id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_relationship(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id' }
+  #     @data = @mints_user.get_relationship(1, options)
+  def get_relationship(id, options = nil)
+    @client.raw('get', "/config/relationships/#{id}", options)
+  end
 
-    # === Create relationship.
-    # Create a relationship with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "alias_1": "eventsCopy",
-    #       "alias_2": "ticketsCopy",
-    #       "object_model_1": "Story",
-    #       "object_model_2": "Product"
-    #     }
-    #     @data = @mints_user.create_relationship(data)
-    def create_relationship(data)
-        @client.raw('post', "/config/relationships", nil, data_transform(data))
-    end
+  # === Create relationship.
+  # Create a relationship with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       alias_1: 'eventsCopy',
+  #       alias_2: 'ticketsCopy',
+  #       object_model_1: 'Story',
+  #       object_model_2: 'Product'
+  #     }
+  #     @data = @mints_user.create_relationship(data)
+  def create_relationship(data)
+    @client.raw('post', '/config/relationships', nil, data_transform(data))
+  end
 
-    # === Update relationship.
-    # Update a relationship info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Relationship id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "alias_1": "eventsCopyModified",
-    #       "alias_2": "ticketsCopyModified",
-    #       "object_model_1": "Story",
-    #       "object_model_2": "Product"
-    #     }
-    #     @data = @mints_user.update_relationship(5, data)
-    def update_relationship(id, data)
-        @client.raw('put', "/config/relationships/#{id}", nil, data_transform(data))
-    end
+  # === Update relationship.
+  # Update a relationship info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Relationship id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       alias_1: 'eventsCopyModified',
+  #       alias_2: 'ticketsCopyModified',
+  #       object_model_1: 'Story',
+  #       object_model_2: 'Product'
+  #     }
+  #     @data = @mints_user.update_relationship(5, data)
+  def update_relationship(id, data)
+    @client.raw('put', "/config/relationships/#{id}", nil, data_transform(data))
+  end
 
-    # === Delete relationship.
-    # Delete a relationship.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Relationship id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_relationship(5)
-    def delete_relationship(id)
-        @client.raw('delete', "/config/relationships/#{id}")
-    end
-end
+  # === Delete relationship.
+  # Delete a relationship.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Relationship id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_relationship(5)
+  def delete_relationship(id)
+    @client.raw('delete', "/config/relationships/#{id}")
+  end
+end

data/lib/user/config/roles.rb

@@ -1,84 +1,81 @@
+# frozen_string_literal: true
+
 module Roles
-    ##
-    # == Roles
-    #
+  ##
+  # == Roles
+  #
+
+  # === Duplicate role.
+  # Duplicate a role.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Role id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { options: { name: 'Duplicated role' } }
+  #     @data = @mints_user.duplicate_role(1, data.to_json)
+  def duplicate_role(id, data)
+    @client.raw('post', "/config/roles/#{id}/duplicate", nil, data)
+  end
 
-    #def get_roles_permissions #FIXME: RoleController doesnt have getPermissions method
-    #  @client.raw('get', "/config/roles/get-permissions")
-    #end
+  # === Get roles.
+  # Get a collection of roles.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_roles
+  def get_roles
+    @client.raw('get', '/config/roles')
+  end
 
-    # === Duplicate role.
-    # Duplicate a role.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Role id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       options: [] 
-    #     }
-    #     @data = @mints_user.duplicate_role(1, data.to_json)
-    def duplicate_role(id, data)
-        @client.raw('post', "/config/roles/#{id}/duplicate", nil, data)
-    end
-    
-    # === Get roles.
-    # Get a collection of roles.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_roles
-    def get_roles
-        @client.raw('get', "/config/roles")
-    end
+  # === Get role.
+  # Get a role info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Role id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_role(1)
+  def get_role(id)
+    @client.raw('get', "/config/roles/#{id}")
+  end
 
-    # === Get role.
-    # Get a role info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Role id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_role(1)
-    def get_role(id)
-        @client.raw('get', "/config/roles/#{id}")
-    end
+  # === Create role.
+  # Create a role with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       name: 'new-role',
+  #       display_name: 'New Role',
+  #       description: 'Role description'
+  #     }
+  #     @data = @mints_user.create_role(data)
+  def create_role(data)
+    @client.raw('post', '/config/roles', nil, data_transform(data))
+  end
 
-    # === Create role.
-    # Create a role with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "name": "new-role",
-    #       "display_name": "New Role",
-    #       description: "Role description"
-    #     }
-    #     @data = @mints_user.create_role(data)
-    def create_role(data)
-        @client.raw('post', "/config/roles", nil, data_transform(data))
-    end
-    
-    # === Update role.
-    # Update a role info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Role id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "name": "new-role",
-    #       "display_name": "New Role Display Name Modified",
-    #       description: "Role description",
-    #       "permissions": 1
-    #     }
-    #     @data = @mints_user.update_role(8, data)
-    def update_role(id, data) #FIXME: This action is unauthorized
-        #TODO: Research permissions variable type. This would be the error's solution.
-        @client.raw('put', "/config/roles/#{id}", nil, data_transform(data))
-    end
-end
+  # === Update role.
+  # Update a role info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Role id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       name: 'new-role',
+  #       display_name: 'New Role Display Name Modified',
+  #       description: 'Role description',
+  #       permissions: 1
+  #     }
+  #     @data = @mints_user.update_role(8, data)
+  def update_role(id, data)
+    # FIXME: This action is unauthorized
+    # TODO: Research permissions variable type. This would be the error's solution.
+    @client.raw('put', "/config/roles/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/config/seeds.rb

@@ -1,54 +1,55 @@
-module Seeds
-    ##
-    # == Seeds
-    #
+# frozen_string_literal: true
 
-    # === Apply seeds.
-    # Apply seeds.
-    #
-    # ==== Example
-    #
-    def apply_seeds(data, async = false)
-        url = "/config/seeds"
-        url = "#{url}?async" if async
-        @client.raw('post', url, nil, data)
-    end
+module Seeds
+  ##
+  # == Seeds
+  #
+  # === Apply seeds.
+  # Apply seeds.
+  #
+  # ==== Example
+  #
+  def apply_seeds(data, async: false)
+    url = '/config/seeds'
+    url = "#{url}?async" if async
+    @client.raw('post', url, nil, data)
+  end
 
-    # === Get seed processes.
-    # Get a collection of seed processes.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_seed_processes
-    #
-    # ==== Second Example
-    #     options = {
-    #       fields: "id"
-    #     }
-    #     @data = @mints_user.get_seed_processes(options)
-    def get_seed_processes(options = nil)
-        @client.raw('post', "/config/seed-processes", options)
-    end
+  # === Get seed processes.
+  # Get a collection of seed processes.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_seed_processes
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id'
+  #     }
+  #     @data = @mints_user.get_seed_processes(options)
+  def get_seed_processes(options = nil)
+    @client.raw('post', '/config/seed-processes', options)
+  end
 
-    # === Get seed process.
-    # Get a seed process info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Story version id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_story_version(1)
-    #
-    # ==== Second Example
-    #     options = {
-    #       fields: 'id, title'
-    #     }
-    #     @data = @mints_user.get_seed_process(1, options)
-    def get_seed_process(id, options = nil)
-        @client.raw('get', "/config/seed-processes/#{id}", options)
-    end
-end
+  # === Get seed process.
+  # Get a seed process info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Seed process id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_seed_process(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @mints_user.get_seed_process(1, options)
+  def get_seed_process(id, options = nil)
+    @client.raw('get', "/config/seed-processes/#{id}", options)
+  end
+end

data/lib/user/config/system_settings.rb

@@ -1,53 +1,54 @@
+# frozen_string_literal: true
+
 module SystemSettings
-    ##
-    # == System Settings
-    #
+  ##
+  # == System Settings
+  #
+  # === Get settings by keys.
+  # Get a collection of settings using keys.
+  #
+  # ==== Example
+  #     options = {
+  #       setting_keys: 'email_transport_provider,email_template_provider,email_template_default_from_address'
+  #     }
+  #     @data = @mints_user.get_settings_by_keys(options)
+  def get_settings_by_keys(options)
+    @client.raw('get', '/config/settings/by-keys', options)
+  end
 
-    # === Get settings by keys.
-    # Get a collection of settings using keys.
-    #
-    # ==== Example
-    #     options = {
-    #       "setting_keys": "email_transport_provider,email_template_provider,email_template_default_from_address"
-    #     }
-    #     @data = @mints_user.get_settings_by_keys(options)
-    def get_settings_by_keys(options)
-        @client.raw('get', "/config/settings/by-keys", options)
-    end
-    
-    # === Get settings.
-    # Get a collection of settings.
-    #
-    # ====  Example
-    #     @data = @mints_user.get_settings
-    def get_settings
-        @client.raw('get', "/config/settings")
-    end      
+  # === Get settings.
+  # Get a collection of settings.
+  #
+  # ====  Example
+  #     @data = @mints_user.get_settings
+  def get_settings
+    @client.raw('get', '/config/settings')
+  end
 
-    # === Create setting.
-    # Create a setting title with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       title: "new_settings"
-    #     }
-    #     @data = @mints_user.create_setting(data)
-    def create_setting(data)
-        @client.raw('post', "/config/settings", nil, data_transform(data))
-    end
+  # === Create setting.
+  # Create a setting title with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'new_settings'
+  #     }
+  #     @data = @mints_user.create_setting(data)
+  def create_setting(data)
+    @client.raw('post', '/config/settings', nil, data_transform(data))
+  end
 
-    # === Clear tag.
-    # Clar a tag info.
-    #
-    # ==== Parameters
-    # tag:: (Integer) -- Tag id.
-    #
-    # ==== Example
-    #     @data = @mints_user.clear_tag(1)
-    def clear_tag(tag)
-        @client.raw('get', "/config/settings/tags/#{tag}/clear")
-    end
-end
+  # === Clear tag.
+  # Clear a tag info.
+  #
+  # ==== Parameters
+  # tag:: (Integer) -- Tag id.
+  #
+  # ==== Example
+  #     @data = @mints_user.clear_tag(1)
+  def clear_tag(tag)
+    @client.raw('get', "/config/settings/tags/#{tag}/clear")
+  end
+end