ibm_tools-people

IMPORTANT

Comunicate 1

Due to the new mandatory change regarding the new Tokenization of the API we launch the version 1.1, now aside from the default parameters, we will have to request your token via boarding process and then use it with the API, details regarding the api usage, were updated, but if you want to know more about the tokenization, check the FAQ.

Comunicate 2

Due to the case-2022-05-05-1450 opened by the CSIRT team we had to migrate from the Public Github to the Github Enterprise, this change forced us to change the name of the gem.

Since the ruby does require the name of the gem to be used as the name of the class. Check below what changed:

Action 1 - Gemfile

Change the name of the gem to the new one in your Gemfile file and hit bundle install on your terminal.

# From
gem 'rails_ibm-uprofile', '~> 0.3.2', require: 'rails_ibm/uprofile'

# To
gem 'ibm_tools-people', '~> 1.0.0', require: 'ibm_tools/people'

Action 2 - Usage

Change everywhere you have within your application from the old class name to the new one.

# From
RailsIbm::Uprofile.info

# To
IbmTools::People.info

From now on it should be transparent and require no other action.

---

IBM Tools

Welcome to your Rais IBM Tools module! This gem intend to provide you some fetures used on IBM Web applications *.

* IBM VPN is required

IBM Tools\People

Fetch data from the user based on search params.

IBM Tools\SSO

Feature to come.

Code of Conduct

Everyone interacting in the IbmTools::People project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Table of Contents

• Installation
• Usage
• Method: info
• Method: skills
• Method: teams
• Method: all
• Contributing
• License

Installation

Add this line to your application's Gemfile:

gem 'ibm_tools-people'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install ibm_tools-people

IbmTools::People

This module allow you to fetch information from Profile directory (using the Unified-profile).

Usage

This module have different methods to search the users and provide different data:

#Info(args*: value[, options])

This module allos you to search one or more entries at time, it will return the information about the employee(s)

require 'ibm_tools/people'

IbmTools::People.info(uid: '000000000')

Args*

Since there are different kind of ways to search the user and to ensure readability we split it in several alternatives. It is important to know that at least one of these args are required.

name	value	Usage
uid	String	IbmTools::People.info(uid: '000000000')
uids	Array	IbmTools::People.info(uids: ['000000000', '111111111'])
email	String	IbmTools::People.info(email: '[e-mail]')
emails	Array	IbmTools::People.info(emails: ['[e-mail]', '[e-mail]'])
query	String	IbmTools::People.info(query: 'John Doe')
token	String	token: nbvcsw23456yhbvfrt6789olkmnhyu8i9olkmnhgtrdf*

Token can be used as a argument of the module, but it will also look for the environment variable IBM_PEOPLE_API_KEY

Options (optional)

Attribure	Type	Default	Purpose
parsed	Boolean	true	Returns a Parsed Object if false Return a PeopleUnifiedProfileAPI Object
remap	Boolean	false	Returns a Remapped Object. This option is ignored if parsed is true
serial	String	'000000'	Will increase the performance of the search by fetching first entries that are peers from the serial informed. Only available for query arg.
limit	Number	10	Will limit the result of the API in the number specified. Only available for query arg.
start	Number	0	Will start from this position of the list (common used for pagination). Only available for query arg.
array	Boolean	true	The result will be an array instead of an object. Only available for query arg. This option is ignored if detailed is false.

Schemas

These are the following models available in this API.

Parsed Object

UID

{
    :"uid_#{query}": PeopleUnifiedProfileAPI.content
}

# Ex.:
#    $ IbmTools::People.info(uid: '000000000')
#    $ => { uid_000000000: PeopleUnifiedProfileAPI.content }

Email

{
    :"#{query}": PeopleUnifiedProfileAPI.content
}

# Ex.:
#    $ IbmTools::People.info(email: '[e-mail]')
#    $ => { [e-mail]: PeopleUnifiedProfileAPI.content }

Remapped Object

It will rewrite the object to a DefaultTemplate used by this module (preferred for authentications)

DefaultTemplate

{
    uid: PeopleUnifiedProfileAPI.content.uid,
    name: PeopleUnifiedProfileAPI.content.nameFull,
    email: PeopleUnifiedProfileAPI.content.preferredIdentity,
    shortname: PeopleUnifiedProfileAPI.content.nameDisplay || PeopleUnifiedProfileAPI.content.nameFull
}

UID

{
    :"uid_#{query}": DefaultTemplate
}

# Ex.:
#    $ IbmTools::People.info(uid: '000000000')
#    $ => { uid_000000000: ShortDataUserObject }

Email

{
    :"#{query}": DefaultTemplate
}

# Ex.:
#    $ IbmTools::People.info(email: '[e-mail]')
#    $ => { [e-mail]: ShortDataUserObject }

#Skills(args*: value)

This method only allows one search at time and it will return the skill set information of the employee.

require 'ibm_tools/people'

IbmTools::People.skills(uid: '000000000')

This module have 2 variations, you can check the details below:

Args*

Since there are different kind of ways to search the user and to ensure readability we split it in several alternatives. It is important to know that at least one of these args are required.

name	value	Usage
uid	String	IbmTools::People.info(uid: '000000000')
email	String	IbmTools::People.info(email: '[e-mail]')
token	String	token: nbvcsw23456yhbvfrt6789olkmnhyu8i9olkmnhgtrdf*

Token can be used as a argument of the module, but it will also look for the environment variable IBM_PEOPLE_API_KEY

Schemas

There are no special remapping or parsing for this results, the schema can be checked on PeopleUnifiedProfileAPI docs

#Teams(args*: value)

This method only allows one search at time and it will return the peers and hierarchical tree of the employee (Inside and Outside the country)

require 'ibm_tools/people'

IbmTools::People.skills(uid: '000000000')

This module have 2 variations, you can check the details below:

Args*

Since there are different kind of ways to search the user and to ensure readability we split it in several alternatives. It is important to know that at least one of these args are required.

name	value	Usage
uid	String	IbmTools::People.info(uid: '000000000')
email	String	IbmTools::People.info(email: '[e-mail]')
token	String	token: nbvcsw23456yhbvfrt6789olkmnhyu8i9olkmnhgtrdf*

Token can be used as a argument of the module, but it will also look for the environment variable IBM_PEOPLE_API_KEY

Schemas

There are no special remapping or parsing for this results, the schema can be checked on PeopleUnifiedProfileAPI docs

#all(args*: value)

This method only allows one search at time and it will return the peers and hierarchical tree of the employee (Inside and Outside the country)

require 'ibm_tools/people'

IbmTools::People.skills(uid: '000000000')

This module have 2 variations, you can check the details below:

Args*

Since there are different kind of ways to search the user and to ensure readability we split it in several alternatives. It is important to know that at least one of these args are required.

name	value	Usage
uid	String	IbmTools::People.info(uid: '000000000')
email	String	IbmTools::People.info(email: '[e-mail]')
token	String	token: nbvcsw23456yhbvfrt6789olkmnhyu8i9olkmnhgtrdf*

Token can be used as a argument of the module, but it will also look for the environment variable IBM_PEOPLE_API_KEY

Schemas

There are no special remapping or parsing for this results, the schema can be checked on PeopleUnifiedProfileAPI docs

Tests

I'm in shame to do this, but since I was in a hurry, we got some testers to verify this project, and I know I should implement some automated tests. But this module were created for a project and because of this I had to do this way.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.ibm.com/thiagogs/ibm_tools-people. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.