ibm_tools-people 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2debfa9c940c4182b2962f1b9485c78ea6b9efec873c8bceae18c5d5e27fb723
+  data.tar.gz: b59431afe705a591f2ff3d4176780f424cbe881a2aa4b910f82f6de92c68d8f0
+SHA512:
+  metadata.gz: d42baeba070d06277968661e2bd3f2fecba81f2c029655302ba9aea6b693962764cb5a9f06f7d0d68a06fd10dfbaf2fd75e24903071565ead1a971f687bcf476
+  data.tar.gz: e135ee2e3bb8b84a7e39f7a8ccc69a0c4cd9c96e44305d604d73e39f36cd134ae8186a038d9c967f9e5d0b13e7181a27ff9602cdf9faf8214ae1366488ad13ae

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.byebug_history
+ibm_tools-people*.gem
+.DS_Store
+Gemfile.lock

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at thiagogs@br.ibm.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ibm_tools-people.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Thiago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Thiago Silva
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,269 @@
+# IMPORTANT
+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.
+```ruby
+# From
+gem 'rails_ibm-uprofile', '~> 0.3.2', require: 'rails_ibm/uprofile'
+
+# To
+gem 'ibm_tools-people', '~> 0.0.2', require: 'ibm_tools/people'
+```
+
+## Action 2 - Usage
+Change everywhere you have within your application from the old class name to the new one.
+```ruby
+# From
+RailsIbm::Uprofile.info
+
+# To
+IbmTools::People.info
+```
+
+From now on it should be transparent and require no other action.
+_________
+<br><br>
+
+# 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](https://github.ibm.com/thiagogs/ibm_tools-people/blob/master/CODE_OF_CONDUCT.md).
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Method: info](#method-info)
+- [Method: skills](#method-skills)
+- [Method: teams](#method-teams)
+- [Method: all](#method-all)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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](https://w3.ibm.com/w3publisher/bluepages-ui-support)).
+
+## Usage
+
+This module have different methods to search the users and provide different data:
+
+### <a id="method-info"></a>#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)
+
+```ruby
+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: 'johndoe@ibm.com')`
+| emails | Array | `IbmTools::People.info(emails: ['johndoe@ibm.com', 'janedoe@ibm.com'])`
+| query | String | `IbmTools::People.info(query: 'John Doe')`
+
+#### Options (`optional`)
+
+| Attribure | Type | Default | Purpose
+| --- | --- | --- | ---
+| parsed | Boolean | true | Returns a [Parsed Object](#parsed-object)<br><sup>if __false__ Return a [PeopleUnifiedProfileAPI](https://unified-profile-api.us-south-k8s.intranet.ibm.com/v3/api/) Object</sup>
+| remap | Boolean | false | Returns a [Remapped Object](#remapped-object).<br><sup>This option is ignored if `parsed` is __true__</sup>
+| serial | String | '000000' | Will increase the performance of the search by fetching first entries that are peers from the serial informed.<br><sup>Only available for __query__ arg.</sup>
+| limit | Number | 10 | Will limit the result of the API in the number specified.<br><sup>Only available for __query__ arg.</sup>
+| start | Number | 0 | Will start from this position of the list (common used for pagination).<br><sup>Only available for __query__ arg.</sup>
+| array | Boolean | true | The result will be an array instead of an object.<br><sup>Only available for __query__ arg.</sup><br><sup>This option is ignored if `detailed` is __false__.</sup>
+
+#### Schemas
+
+These are the following models available in this API.
+
+##### Parsed Object
+
+###### UID
+```ruby
+{
+    :"uid_#{query}": PeopleUnifiedProfileAPI.content
+}
+
+# Ex.:
+#    $ IbmTools::People.info(uid: '000000000')
+#    $ => { uid_000000000: PeopleUnifiedProfileAPI.content }
+```
+>
+
+###### Email
+```ruby
+{
+    :"#{query}": PeopleUnifiedProfileAPI.content
+}
+
+# Ex.:
+#    $ IbmTools::People.info(email: 'johndoe@ibm.com')
+#    $ => { johndoe@ibm.com: PeopleUnifiedProfileAPI.content }
+```
+
+##### Remapped Object
+
+It will rewrite the object to a DefaultTemplate used by this module (preferred for authentications)
+
+###### DefaultTemplate
+
+```ruby
+{
+    uid: PeopleUnifiedProfileAPI.content.uid,
+    name: PeopleUnifiedProfileAPI.content.nameFull,
+    email: PeopleUnifiedProfileAPI.content.preferredIdentity,
+    shortname: PeopleUnifiedProfileAPI.content.nameDisplay || PeopleUnifiedProfileAPI.content.nameFull
+}
+```
+
+###### UID
+```ruby
+{
+    :"uid_#{query}": DefaultTemplate
+}
+
+# Ex.:
+#    $ IbmTools::People.info(uid: '000000000')
+#    $ => { uid_000000000: ShortDataUserObject }
+```
+>
+
+###### Email
+```ruby
+{
+    :"#{query}": DefaultTemplate
+}
+
+# Ex.:
+#    $ IbmTools::People.info(email: 'johndoe@ibm.com')
+#    $ => { johndoe@ibm.com: ShortDataUserObject }
+```
+
+### <a id="method-skills"></a>#Skills(args*: value)
+
+This method only allows one search at time and it will return the skill set information of the employee.
+
+```ruby
+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: 'johndoe@ibm.com')`
+
+#### Schemas
+
+There are no special remapping or parsing for this results, the schema can be checked on [PeopleUnifiedProfileAPI](https://unified-profile-api.us-south-k8s.intranet.ibm.com/v3/api/) docs
+
+### <a id="method-teams"></a>#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)
+
+```ruby
+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: 'johndoe@ibm.com')`
+
+#### Schemas
+
+There are no special remapping or parsing for this results, the schema can be checked on [PeopleUnifiedProfileAPI](https://unified-profile-api.us-south-k8s.intranet.ibm.com/v3/api/) docs
+
+### <a id="method-all"></a>#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)
+
+```ruby
+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: 'johndoe@ibm.com')`
+
+#### Schemas
+
+There are no special remapping or parsing for this results, the schema can be checked on [PeopleUnifiedProfileAPI](https://unified-profile-api.us-south-k8s.intranet.ibm.com/v3/api/) 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](https://github.ibm.com/thiagogs/ibm_tools-people/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails_ibm/uprofile"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ibm_tools-people.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/ibm_tools/people/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ibm_tools-people"
+  spec.version       = IbmTools::People::VERSION
+  spec.authors       = ["Thiago Silva"]
+  spec.email         = ["thiagogs@br.ibm.com"]
+
+  spec.summary       = "IBM Module - Profile"
+  spec.description   = "This module Allow the user to retrieve information from the IBM unified profile program."
+  spec.homepage      = "https://github.ibm.com/thiagogs/ibm_tools-people"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "https://github.ibm.com/thiagogs/ibm_tools-people"
+  # spec.metadata["changelog_uri"] = "https://github.ibm.com/thiagogs/ibm_tools-people/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "lib/ibm_tools/people/profile"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'httparty', '~> 0.18.1'
+  spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/ibm_tools/people/arguments.rb

@@ -0,0 +1,64 @@
+require 'httparty'
+
+module IbmTools
+  module People
+    class Arguments
+      def initialize(options)
+        @options = options
+      end
+
+      def filter(allowed, options = nil)
+        (options || @options).select {|k,v| allowed.include?(k) }
+      end
+
+      def validate
+        raise SyntaxError.new description: "Invalid Argument. #{DOC_LINK}" if invalid_options
+        raise SyntaxError.new description: "More than one required Argument. #{DOC_LINK}" if multiple
+        raise SyntaxError.new description: "Missing required Argument. #{DOC_LINK}" if missing
+        raise TypeError.new description: "Invalid Argument type. #{DOC_LINK}" if invalid_type || unmatch_type
+
+        true
+      end
+
+      private
+
+      def value
+        @options[:uids] || @options[:emails] || @options[:uid] || @options[:email] || @options[:query]
+      end
+
+      def missing
+        value == nil
+      end
+
+      def multiple
+        allowed = %i[uid uids email emails query]
+        @options.keys.select { |k| allowed.include?(k) }.size > 1
+      end
+
+      def invalid_type
+        config = { type: Array, value: value }
+        config[:type] = String if @options.include?(:uid) || @options.include?(:email) || @options.include?(:query)
+
+        !config[:value].is_a?(config[:type])
+      end
+
+       def unmatch_type
+        entry = value
+        entry = value.first if value.is_a? Array
+
+        return is_valid_email?(entry) if @options.include?(:uid) || @options.include?(:uids)
+        return !is_valid_email?(entry) if @options.include?(:email) || @options.include?(:emails)
+        false
+      end
+
+      def invalid_options
+        !@options.is_a? Hash
+      end
+
+      def is_valid_email?(email)
+        (email =~ IbmTools::People::EMAIL_REGEX) != nil
+      end
+
+    end
+  end
+end

data/lib/ibm_tools/people/async.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+
+module IbmTools
+  module People
+    module Async
+      def self.Requests(uris, headers)
+        threads = []
+        responses = []
+
+        [uris].flatten.each do |uri|
+          threads << Thread.new do
+            responses << HTTParty.get(uri, headers: headers)
+          end
+        end
+
+        # wait for threads to finish before ending program.
+        threads.each { |t| t.join }
+        OpenStruct.new(body: "[#{responses.map(&:body).join(",")}]", code: 200)
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/profile/all.rb

@@ -0,0 +1,39 @@
+require_relative 'search'
+require_relative "../version"
+
+module IbmTools
+  module People
+    module Profile
+      class All < Search
+        def initialize(query)
+          @response = HTTParty.get(uri(query: query), header: headers)
+        end
+
+        def results
+          search_results
+        end
+
+        private
+
+        def uri(query:)
+          "#{IbmTools::People::BLUEPAGES_V3_URI}/#{query}/profile_combined"
+        end
+
+        def headers
+          {
+            'Content-Type': 'application/json',
+            accept: 'application/json'
+          }
+        end
+
+        def search_type
+          'all'
+        end
+
+        def search_results
+          JSON.parse @response.body, symbolize_names: true
+        end
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/profile/email.rb

@@ -0,0 +1,24 @@
+require_relative 'search'
+
+module IbmTools
+  module People
+    module Profile
+      class Email < Search
+        def search_type
+          'email'
+        end
+
+        def search_results(parsed:, remap:)
+          return JSON.parse @response.body, symbolize_names: true unless parsed
+          results = {}
+
+          @query.compact.each do |query_term|
+            results.merge!(query_term.to_sym => result_for(query_term, remap))
+          end
+
+          results
+        end
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/profile/fetch.rb

@@ -0,0 +1,54 @@
+require 'httparty'
+require_relative 'mapper'
+require_relative '../async'
+
+module IbmTools
+  module People
+    module Profile
+      class Fetch
+        def initialize(uri:)
+          @uri = uri
+        end
+
+        def execute(query:)
+          @query = query
+
+          return HTTParty.get("#{@uri}/#{uri_params(query)}", headers: headers) unless multiple_search
+          IbmTools::People::Async.Requests chunks(query).map { |c| "#{@uri}/#{uri_params(c)}" }, headers
+        end
+
+        private
+
+        def multiple_search
+          @query.is_a?(Array) && @query.size >= 2
+        end
+
+        def uri_params(users)
+          return users.join(',') if multiple_search
+          "#{users.first}/profile"
+        end
+
+        def encode_uri(users)
+          "#{@uri}/#{ERB::Util.url_encode(uri_params(users))}"
+        end
+
+        def chunks(users)
+          partial = [[]]
+          users.each do |u|
+            partial.last.push(u)
+            partial.push([]) if encode_uri(partial.last).length > 5000
+          end
+
+          partial
+        end
+
+        def headers
+          {
+            'Content-Type': 'application/json',
+            accept: 'application/json'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/profile/mapper.rb

@@ -0,0 +1,36 @@
+module IbmTools
+  module People
+    module Profile
+      class Mapper
+        private
+
+        def parse_user(response, dig_params, remap: true)
+          return nil if response.nil?
+
+          user_info = response.dig(*dig_params)
+          return nil if user_info.nil?
+
+          if user_info.is_a?(Array)
+            user_info.map { |user| remap_obj(data: user, remap: remap) }
+          else
+            remap_obj(data: user_info, remap: remap)
+          end
+        end
+
+        def remap_obj(data:, remap: true)
+          return data unless remap
+
+          user = {
+            uid: data[:uid],
+            name: data[:nameFull],
+            email: data[:preferredIdentity],
+            shortname: data[:nameDisplay] || data[:nameFull]
+          }
+
+          user[:is_manager] = data[:employeeType][:isManager] if data[:employeeType] != nil && data[:employeeType][:isManager] != nil
+          user
+        end
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/profile/search.rb

@@ -0,0 +1,65 @@
+require 'httparty'
+require_relative 'mapper'
+require_relative 'fetch'
+require_relative "../version"
+
+# Class responsible for making calls to retrieve user information from the Unified Profile API
+module IbmTools
+  module People
+    module Profile
+      class Search < Mapper
+        class IbmTools::People::Profile::SearchError < StandardError; end
+
+        def initialize(query)
+          @query = [query].flatten
+
+          fetch = IbmTools::People::Profile::Fetch.new(uri: IbmTools::People::BLUEPAGES_V3_URI)
+          @response = fetch.execute(query: @query)
+        end
+
+        def search_type
+          raise StandardError.new description: "#search_type should be overriden by #{self.class}"
+        end
+
+        def results(parsed: true, remap: false)
+          search_results(parsed: parsed, remap: remap)
+        end
+
+        private
+
+        def search_results(parsed:, remap:)
+          raise StandardError.new description: "#search_results should be overriden by #{self.class}"
+        end
+
+        def result_for(query_term, remap)
+          parsed_users(remap).select { |parsed_user| parsed_user&.values&.include? query_term }.first
+        rescue Exception => e
+          raise IbmTools::People::Profile::SearchError, e.message
+        end
+
+        def response_valid?
+          @response.code >= 200 && @response.code <= 399
+        end
+
+        def parsed_users(remap)
+          return [] unless response_valid?
+
+          parsed_results = JSON.parse @response.body, symbolize_names: true
+          parsed_results = parse_multiple_profiles([parsed_results]) if multiple_search
+
+          [parsed_results].flatten.map { |result| parse_user result, %i[content], remap: remap }
+        rescue JSON::ParserError
+          []
+        end
+
+        def multiple_search
+          @query.is_a?(Array) && @query.size >= 2
+        end
+
+        def parse_multiple_profiles(data)
+          data.flatten.map { |p| p[:profiles] }.flatten
+        end
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/profile/skills.rb

@@ -0,0 +1,39 @@
+require_relative 'search'
+require_relative "../version"
+
+module IbmTools
+  module People
+    module Profile
+      class Skills < Search
+        def initialize(query)
+          @response = HTTParty.get(uri(query: query), header: headers)
+        end
+
+        def results
+          search_results
+        end
+
+        private
+
+        def uri(query:)
+          "#{IbmTools::People::BLUEPAGES_V3_URI}/#{query}/profile_extended"
+        end
+
+        def headers
+          {
+            'Content-Type': 'application/json',
+            accept: 'application/json'
+          }
+        end
+
+        def search_type
+          'typeahead'
+        end
+
+        def search_results
+          JSON.parse @response.body, symbolize_names: true
+        end
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/profile/teams.rb

@@ -0,0 +1,39 @@
+require_relative 'search'
+require_relative "../version"
+
+module IbmTools
+  module People
+    module Profile
+      class Teams < Search
+        def initialize(query)
+          @response = HTTParty.get(uri(query: query), header: headers)
+        end
+
+        def results
+          search_results
+        end
+
+        private
+
+        def uri(query:)
+          "#{IbmTools::People::BLUEPAGES_V3_URI}/#{query}/teamResolved"
+        end
+
+        def headers
+          {
+            'Content-Type': 'application/json',
+            accept: 'application/json'
+          }
+        end
+
+        def search_type
+          'team'
+        end
+
+        def search_results
+          JSON.parse @response.body, symbolize_names: true
+        end
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/profile/typeahead.rb

@@ -0,0 +1,46 @@
+require_relative 'search'
+require_relative 'email'
+require_relative "../version"
+
+module IbmTools
+  module People
+    module Profile
+      class Typeahead < Search
+        def initialize(query, serial: '000000', limit: 10, start: 0)
+          uri = "#{IbmTools::People::BLUEPAGES_V1_URI}?userId=#{serial}&rows=#{limit}&start=#{start}&query=#{query}&searchConfig=typeahead_search"
+          @response = HTTParty.get(uri, header: headers, format: :plain)
+        end
+
+        def results(options)
+          search_results(options)
+        end
+
+        private
+
+        def headers
+          {
+            'Content-Type': 'application/json',
+            accept: 'application/json'
+          }
+        end
+
+        def search_type
+          'typeahead'
+        end
+
+        def search_results(options)
+          results = JSON.parse @response, symbolize_names: true
+          return [] if results == nil
+
+          return results unless default_values(options)[:parsed]
+          parse_user results, %i[results], remap: default_values(options)[:remap]
+        end
+
+        def default_values(options)
+          default_params = { parsed: true, detailed: false, remap: false, array: true }
+          default_params.merge(options)
+        end
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/profile/uid.rb

@@ -0,0 +1,24 @@
+require_relative 'search'
+
+module IbmTools
+  module People
+    module Profile
+      class Uid < Search
+        def search_type
+          'uid'
+        end
+
+        def search_results(parsed:, remap:)
+          return JSON.parse @response.body, symbolize_names: true unless parsed
+          results = {}
+
+          @query.compact.each do |query_term|
+            results.merge!("uid_#{query_term}".to_sym => result_for(query_term, remap))
+          end
+
+          results
+        end
+      end
+    end
+  end
+end

data/lib/ibm_tools/people/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module IbmTools
+  module People
+    VERSION = "1.0.0"
+    BLUEPAGES_V3_URI = "https://unified-profile-api.us-south-k8s.intranet.ibm.com/v3/profiles"
+    BLUEPAGES_V1_URI = "https://unified-profile-search-service.us-south-k8s.intranet.ibm.com/search"
+    EMAIL_REGEX = %r{\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z}i
+  end
+end

data/lib/ibm_tools/people.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'people/version'
+require_relative 'people/profile/email'
+require_relative 'people/profile/uid'
+require_relative 'people/profile/typeahead'
+require_relative 'people/profile/skills'
+require_relative 'people/profile/teams'
+require_relative 'people/profile/all'
+require_relative 'people/arguments'
+
+module IbmTools
+  module People
+    class Error < StandardError; end
+    DOC_LINK = "Please refer to 'https://github.com/niightly/rails_ibm-uprofile/blob/master/README.md#usage' for more details.'".freeze
+
+    def self.info(options = {})
+      args = verify(options)
+
+      if options.include?(:emails) || options.include?(:email)
+        IbmTools::People::Profile::Email.new([options[:emails] || options[:email]].flatten).results(**args.filter(%i[parsed remap]))
+      elsif options.include?(:uids) || options.include?(:uid)
+        IbmTools::People::Profile::Uid.new([options[:uids] || options[:uid]].flatten).results(**args.filter(%i[parsed remap]))
+      elsif options.include?(:query)
+        IbmTools::People::Profile::Typeahead.new(options[:query], **default_params(options)).results(**args.filter(%i[parsed remap detailed array]))
+      end
+    end
+
+    def self.skills(options = {})
+      args = verify(options, single: true)
+      IbmTools::People::Profile::Skills.new(options[:uid] || options[:email]).results
+    end
+
+    def self.teams(options = {})
+      args = verify(options, single: true)
+      IbmTools::People::Profile::Teams.new(options[:uid] || options[:email]).results
+    end
+
+    def self.all(options = {})
+      args = verify(options, single: true)
+      IbmTools::People::Profile::All.new(options[:uid] || options[:email]).results
+    end
+
+    private
+
+    def self.verify(options, single: false)
+      args = IbmTools::People::Arguments.new(params(options, single))
+      args.validate
+
+      args
+    end
+
+    def self.default_params(options)
+      { serial: options[:serial] || '000000', limit: options[:limit] || 10, start: options[:start] || 0 }
+    end
+
+    def self.params(options, single)
+      return options unless single
+      options.tap { |hs| %i[uids emails].each { |k| hs.delete(k) } }
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ibm_tools-people
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thiago Silva
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+description: This module Allow the user to retrieve information from the IBM unified
+  profile program.
+email:
+- thiagogs@br.ibm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ibm_tools-people.gemspec
+- lib/ibm_tools/people.rb
+- lib/ibm_tools/people/arguments.rb
+- lib/ibm_tools/people/async.rb
+- lib/ibm_tools/people/profile/all.rb
+- lib/ibm_tools/people/profile/email.rb
+- lib/ibm_tools/people/profile/fetch.rb
+- lib/ibm_tools/people/profile/mapper.rb
+- lib/ibm_tools/people/profile/search.rb
+- lib/ibm_tools/people/profile/skills.rb
+- lib/ibm_tools/people/profile/teams.rb
+- lib/ibm_tools/people/profile/typeahead.rb
+- lib/ibm_tools/people/profile/uid.rb
+- lib/ibm_tools/people/version.rb
+homepage: https://github.ibm.com/thiagogs/ibm_tools-people
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- lib/ibm_tools/people/profile
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.8
+signing_key:
+specification_version: 4
+summary: IBM Module - Profile
+test_files: []