mints 0.0.27 → 0.0.29

data/lib/user/config/tags.rb

@@ -1,63 +1,61 @@
-module Tags
-    ##
-    # == Tags
-    #
+# frozen_string_literal: true
 
-    # === Get tags.
-    # Get a collection of tags.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_tags
-    def get_tags
-        @client.raw("get", "/config/tags")
-    end
+module Tags
+  ##
+  # == Tags
+  #
+  # === Get tags.
+  # Get a collection of tags.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_tags
+  def get_tags
+    @client.raw('get', '/config/tags')
+  end
 
-    # === Get tag.
-    # Get a tag info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Tag id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_tag(1)
-    def get_tag(id)
-        @client.raw("get", "/config/tags/#{id}")
-    end
+  # === Get tag.
+  # Get a tag info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tag id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_tag(1)
+  def get_tag(id)
+    @client.raw('get', "/config/tags/#{id}")
+  end
 
-    # === Create tag.
-    # Create a tag with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "tag": "new-tag",
-    #       "is_visible": true
-    #     }
-    #     @data = @mints_user.create_tag(data.to_json)
-    def create_tag(data)
-        @client.raw("post", "/config/tags", nil, data)
-    end
+  # === Create tag.
+  # Create a tag with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       tag: 'new-tag',
+  #       is_visible: true
+  #     }
+  #     @data = @mints_user.create_tag(data)
+  def create_tag(data)
+    @client.raw('post', '/config/tags', nil, data_transform(data))
+  end
 
-    # === Update tag.
-    # Update a tag info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Tag id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "tag": {
-    #         "tag": "new-tag",
-    #         "slug": "new-tag",
-    #         "is_visible": false
-    #       }
-    #     }
-    #     @data = @mints_user.update_tag(54, data.to_json)
-    def update_tag(id, data)
-        #TODO: Inform TagController.update method has been modified
-        @client.raw("put", "/config/tags/#{id}", nil, data)
-    end
-end
+  # === Update tag.
+  # Update a tag info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Tag id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       tag: 'new-tag',
+  #       slug: 'new-tag',
+  #       is_visible: false
+  #     }
+  #     @data = @mints_user.update_tag(54, data)
+  def update_tag(id, data)
+    @client.raw('put', "/config/tags/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/config/taxonomies.rb

@@ -1,124 +1,120 @@
+# frozen_string_literal: true
+
 module Taxonomies
-    ##
-    # == Taxonomies
-    #
+  ##
+  # == Taxonomies
+  #
+  # === Sync taxonomies for object.
+  # Sync taxonomies for object.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       object_type: 'contacts',
+  #       object_id: 1
+  #     }
+  #     @data = @mints_user.sync_taxonomies_for_object(data)
+  def sync_taxonomies_for_object(data)
+    @client.raw('put', '/config/taxonomies/sync_taxonomies_for_object', nil, data_transform(data))
+  end
+
+  # === Get taxonomies for object.
+  # Get taxonomies for object.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     options = {
+  #       object_type: "contacts",
+  #       object_id: 1
+  #     }
+  #     @data = @mints_user.get_taxonomies_for_object(options)
+  def get_taxonomies_for_object(options)
+    @client.raw('get', '/config/taxonomies/get_taxonomies_for_object', options)
+  end
+
+  # === Get taxonomies support data.
+  # Get support data used in taxonomies.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_taxonomies_support_data
+  def get_taxonomies_support_data
+    @client.raw('get', '/config/taxonomies/support-data')
+  end
 
-    # === Sync taxonomies for object.
-    # Sync taxonomies for object.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "object_type": "contacts",
-    #       "object_id": 1
-    #     }
-    #     @data = @mints_user.sync_taxonomies_for_object(data)
-    def sync_taxonomies_for_object(data)
-        @client.raw("put", "/config/taxonomies/sync_taxonomies_for_object", nil, data_transform(data))
-    end
+  # === Get taxonomies.
+  # Get a collection of taxonomies.
+  #
+  # ==== 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_taxonomies
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_user.get_taxonomies(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_user.get_taxonomies(options, false)
+  def get_taxonomies(options = nil, use_post = true)
+    get_query_results('/config/taxonomies', options, use_post)
+  end
 
-    # === Get taxonomies for object.
-    # Get taxonomies for object.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== Example
-    #     options = {
-    #       "object_type": "contacts",
-    #       "object_id": 1
-    #     }
-    #     @data = @mints_user.get_taxonomies_for_object(options)
-    def get_taxonomies_for_object(options)
-        @client.raw("get", "/config/taxonomies/get_taxonomies_for_object", options)
-    end
-    
-    # === Get taxonomies support data.
-    # Get support data used in taxonomies.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_taxonomies_support_data
-    def get_taxonomies_support_data
-        @client.raw("get", "/config/taxonomies/support-data")
-    end
-    
-    #FIXME: Method doesnt exist in TaxonomyController.getUISupportData
-    #def get_ui_taxonomy(id)
-    #  @client.raw("get", "/config/taxonomies/ui-taxonomies/#{id}")
-    #end
-    
-    # === Get taxonomies.
-    # Get a collection of taxonomies.
-    #
-    # ==== 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_taxonomies
-    #
-    # ==== Second Example
-    #     options = { "fields": "title" }
-    #     @data = @mints_user.get_taxonomies(options)
-    #
-    # ==== Third Example
-    #     options = { "fields": "title" }
-    #     @data = @mints_user.get_taxonomies(options, false)
-    def get_taxonomies(options = nil, use_post = true)
-        return get_query_results("/config/taxonomies", options, use_post)
-    end
+  # === Get taxonomy.
+  # Get a taxonomy info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Taxonomy id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_taxonomy(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_user.get_taxonomy(1, options)
+  def get_taxonomy(id, options = nil)
+    @client.raw('get', "/config/taxonomies/#{id}", options)
+  end
 
-    # === Get taxonomy.
-    # Get a taxonomy info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Taxonomy id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_taxonomy(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "title" }
-    #     @data = @mints_user.get_taxonomy(1, options)
-    def get_taxonomy(id, options = nil)
-        @client.raw("get", "/config/taxonomies/#{id}", options)
-    end
+  # === Create taxonomy.
+  # Create a taxonomy with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Taxonomy',
+  #       slug: 'new-taxonomy',
+  #       object_type: 'contacts'
+  #     }
+  #     @data = @mints_user.create_taxonomy(data)
+  def create_taxonomy(data, options = nil)
+    @client.raw('post', '/config/taxonomies', options, data_transform(data))
+  end
 
-    # === Create taxonomy.
-    # Create a taxonomy with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Taxonomy",
-    #       "slug": "new-taxonomy",
-    #       "object_type": "contacts"
-    #     }
-    #     @data = @mints_user.create_taxonomy(data)
-    def create_taxonomy(data, options = nil)
-        @client.raw("post", "/config/taxonomies", options, data_transform(data))
-    end
-    
-    # === Update taxonomy.
-    # Update a taxonomy info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Taxonomy id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Taxomony Modified",
-    #       "slug": "new-taxonomy",
-    #       "object_type": "contacts"
-    #     }
-    #     @data = @mints_user.update_taxonomy(104, data)
-    def update_taxonomy(id, data, options = nil)
-        @client.raw("put", "/config/taxonomies/#{id}", options, data_transform(data))
-    end
-end
+  # === Update taxonomy.
+  # Update a taxonomy info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Taxonomy id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: "New Taxonomy Modified",
+  #       slug: "new-taxonomy",
+  #       object_type: "contacts"
+  #     }
+  #     @data = @mints_user.update_taxonomy(104, data)
+  def update_taxonomy(id, data, options = nil)
+    @client.raw('put', "/config/taxonomies/#{id}", options, data_transform(data))
+  end
+end

data/lib/user/config/teams.rb

@@ -1,70 +1,71 @@
+# frozen_string_literal: true
+
 module Teams
-    ##
-    # == Teams
-    #
-    
-    # === Get team types.
-    # Get a collection of team types.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_team_types
-    def get_team_types
-        @client.raw("get", "/config/teams/team-types")
-    end
-    
-    # === Get teams.
-    # Get a collection of teams.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_teams
-    def get_teams
-        @client.raw("get", "/config/teams")
-    end
-    
-    # === Get team.
-    # Get a team info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Team id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_team(1)
-    def get_team(id)
-        @client.raw("get", "/config/teams/#{id}")
-    end
+  ##
+  # == Teams
+  #
+  # === Get team types.
+  # Get a collection of team types.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_team_types
+  def get_team_types
+    @client.raw('get', '/config/teams/team-types')
+  end
+
+  # === Get teams.
+  # Get a collection of teams.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_teams
+  def get_teams
+    @client.raw('get', '/config/teams')
+  end
+
+  # === Get team.
+  # Get a team info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Team id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_team(1)
+  def get_team(id)
+    @client.raw('get', "/config/teams/#{id}")
+  end
+
+  # === Create team.
+  # Create a team with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Team',
+  #       team_type_enum: 1
+  #     }
+  #     @data = @mints_user.create_team(data)
+  def create_team(data)
+    @client.raw('post', '/config/teams', nil, data_transform(data))
+  end
 
-    # === Create team.
-    # Create a team with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Team",
-    #       "team_type_enum": 1
-    #     }
-    #     @data = @mints_user.create_team(data)
-    def create_team(data)
-        @client.raw("post", "/config/teams", nil, data_transform(data))
-    end
-    
-    # === Update team.
-    # Update a team info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Team id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Team Modified",
-    #       "team_type_enum": 1,
-    #       "members": []
-    #     }
-    #     @data = @mints_user.update_team(5, data)
-    def update_team(id, data)
-        @client.raw("put", "/config/teams/#{id}", nil, data_transform(data))
-    end
-end
+  # === Update team.
+  # Update a team info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Team id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Team Modified',
+  #       team_type_enum: 1,
+  #       members: []
+  #     }
+  #     @data = @mints_user.update_team(5, data)
+  def update_team(id, data)
+    @client.raw('put', "/config/teams/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/config/users.rb

@@ -1,76 +1,77 @@
+# frozen_string_literal: true
+
 module Users
-    ##
-    # == Users
-    #
+  ##
+  # == Users
+  #
+  ##
+  # === Can Users Coach.
+  # Determine if users can coach.
+  #
+  # ==== Example
+  #     @data = @mints_user.can_users_coach
+  def can_users_coach
+    @client.raw('get', '/config/users/can_coach')
+  end
 
-    ##
-    # === Can Users Coach.
-    # Determine if users can coach.
-    #
-    # ==== Example
-    #     @data = @mints_user.can_users_coach
-    def can_users_coach
-        @client.raw("get", "/config/users/can_coach")
-    end
+  # === Get users.
+  # Get a collection of users.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_users
+  def get_users(options)
+    @client.raw('get', '/config/users', options)
+  end
 
-    # === Get users.
-    # Get a collection of users.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_users
-    def get_users
-        @client.raw("get", "/config/users")
-    end
+  # === Get user.
+  # Get an user info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- User id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_user(8)
+  def get_user(id)
+    @client.raw('get', "/config/users/#{id}")
+  end
 
-    # === Get user.
-    # Get an user info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- User id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_user(8)
-    def get_user(id)
-        @client.raw("get", "/config/users/#{id}")
-    end
-    
-    # === Create user.
-    # Create an user with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "name": "New User Name",
-    #       "email": "new_user_email@example.com",
-    #       "is_confirmed": false,
-    #       "set_password": true, 
-    #       "password": "123456",
-    #       "is_coach": false
-    #     }
-    #     @data = @mints_user.create_user(data)
-    def create_user(data)
-        @client.raw("post", "/config/users", nil, data_transform(data))
-    end
+  # === Create user.
+  # Create an user with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       name: 'New User Name',
+  #       email: 'new_user_email@example.com',
+  #       is_confirmed: false,
+  #       set_password: true,
+  #       password: '123456',
+  #       is_coach: false
+  #     }
+  #     @data = @mints_user.create_user(data)
+  def create_user(data)
+    @client.raw('post', '/config/users', nil, data_transform(data))
+  end
 
-    # === Update user.
-    # Update an user info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- User id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "name": "New User Name Modified",
-    #       "email": "new_user_name@example.com",
-    #       "is_active": true,
-    #       "is_confirmed": false,
-    #       "roles": ""
-    #     }
-    #     @data = @mints_user.update_user(14, data)
-    def update_user(id, data)
-        @client.raw("put", "/config/users/#{id}", nil, data_transform(data))
-    end
-end
+  # === Update user.
+  # Update an user info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- User id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       name: 'New User Name Modified',
+  #       email: 'new_user_name@example.com',
+  #       is_active: true,
+  #       is_confirmed: false,
+  #       roles: ''
+  #     }
+  #     @data = @mints_user.update_user(14, data)
+  def update_user(id, data)
+    @client.raw('put', "/config/users/#{id}", nil, data_transform(data))
+  end
+end