ibm_tools-people 1.0.4 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b028aef66c16115dd938f4845197bfa185a04d9fe7d436385027958fe837c11b
-  data.tar.gz: 30fb23190bd601f7bf7dc43c72b3cedb8c204e6b0c7b05fb266d2d71dd6342dc
+  metadata.gz: 51f4d6a531af302ea58c562547649c271bb6c7d516aae5499850c75cd10d9dc0
+  data.tar.gz: 923ef485df6bfa6edfa82fdc385f3d8213a26e80a2739b17073c42f3bde0c318
 SHA512:
-  metadata.gz: 23fb1a3369fbe2c0624c430739a05355506e9e1f947dbae8050e63c4fec09777df09dadc97df0371b65a4248e9d71fafa28b19cde545691125692f72c8e4b8ea
-  data.tar.gz: 19cf5ae6bd5f1e00cc2a0f82c653e05489a0be9df5a08eea84ac3dfe955ce33cea9a7730dbb2138ae7f65d551f48217cffc90b9c6cf497b1379a03be56aab6db
+  metadata.gz: 4a2493f5506e630bc8f187640ecab57f892fce875d4c4230c0445530d03f7a7e8f9b04ecdb0e53c7931387b0ee7415fce40774c04aaff96d350e535ce537b773
+  data.tar.gz: 4386b1dac3ecd4e44681ba76a4ec30f863a25f6038586a56298733eea3ab345ba6cff48cc7849b58895f604176aa6cb83ab365561df5e9dd428baf349ceead06

data/README.md

@@ -1,9 +1,17 @@
 # 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](https://w3.ibm.com/w3publisher/w3/people/unified-profile-apis/api-key-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
+### 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
@@ -13,7 +21,8 @@ gem 'rails_ibm-uprofile', '~> 0.3.2', require: 'rails_ibm/uprofile'
 gem 'ibm_tools-people', '~> 1.0.0', require: 'ibm_tools/people'
 ```
 
-## Action 2 - Usage
+### Action 2 - Usage
+
 Change everywhere you have within your application from the old class name to the new one.
 ```ruby
 # From
@@ -27,6 +36,8 @@ 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 __*__.
@@ -102,6 +113,9 @@ Since there are different kind of ways to search the user and to ensure readabil
 | 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')`
+| 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`)
 
@@ -201,6 +215,9 @@ Since there are different kind of ways to search the user and to ensure readabil
 | --- | --- | ---
 | uid | String | `IbmTools::People.info(uid: '000000000')`
 | email | String | `IbmTools::People.info(email: 'johndoe@ibm.com')`
+| 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
 
@@ -226,6 +243,10 @@ Since there are different kind of ways to search the user and to ensure readabil
 | --- | --- | ---
 | uid | String | `IbmTools::People.info(uid: '000000000')`
 | email | String | `IbmTools::People.info(email: 'johndoe@ibm.com')`
+| 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
 
@@ -251,6 +272,9 @@ Since there are different kind of ways to search the user and to ensure readabil
 | --- | --- | ---
 | uid | String | `IbmTools::People.info(uid: '000000000')`
 | email | String | `IbmTools::People.info(email: 'johndoe@ibm.com')`
+| 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
 

data/ibm_tools-people.gemspec

@@ -36,4 +36,7 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
+
+  # For troubleshooting:
+  # rm -rf gem_name-version.gem && gem build gem_name.gemspec && gem install ./gem_name-version.gem
 end

data/lib/ibm_tools/people/arguments.rb

@@ -15,6 +15,7 @@ module IbmTools
         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 SyntaxError.new description: "Missing TOKEN argument. #{DOC_LINK}" if missing_token
         raise TypeError.new description: "Invalid Argument type. #{DOC_LINK}" if invalid_type || unmatch_type
 
         true
@@ -30,6 +31,11 @@ module IbmTools
         value == nil
       end
 
+      def missing_token
+        return false if @options.keys.include?(:query)
+        @options[:token] == nil
+      end
+
       def multiple
         allowed = %i[uid uids email emails query]
         @options.keys.select { |k| allowed.include?(k) }.size > 1

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

@@ -6,8 +6,9 @@ module IbmTools
   module People
     module Profile
       class Fetch
-        def initialize(uri:)
+        def initialize(uri:, token:)
           @uri = uri
+          @token = token
         end
 
         def execute(query:)
@@ -44,6 +45,7 @@ module IbmTools
 
         def headers
           {
+            'X-UP-API-KEY': @token,
             'Content-Type': 'application/json',
             accept: 'application/json'
           }

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

@@ -10,10 +10,10 @@ module IbmTools
       class Search < Mapper
         class IbmTools::People::Profile::SearchError < StandardError; end
 
-        def initialize(query)
+        def initialize(query, token = nil)
           @query = [query].flatten
 
-          fetch = IbmTools::People::Profile::Fetch.new(uri: IbmTools::People::BLUEPAGES_V3_URI)
+          fetch = IbmTools::People::Profile::Fetch.new(uri: IbmTools::People::BLUEPAGES_V3_URI, token: token)
           @response = fetch.execute(query: @query)
         end
 

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

@@ -5,7 +5,8 @@ module IbmTools
   module People
     module Profile
       class Skills < Search
-        def initialize(query)
+        def initialize(query, token = nil)
+          @token = token
           @response = HTTParty.get(uri(query: query), header: headers)
         end
 
@@ -21,6 +22,7 @@ module IbmTools
 
         def headers
           {
+            'X-UP-API-KEY': @token,
             'Content-Type': 'application/json',
             accept: 'application/json'
           }

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

@@ -5,7 +5,8 @@ module IbmTools
   module People
     module Profile
       class Teams < Search
-        def initialize(query)
+        def initialize(query, token = nil)
+          @token = token
           @response = HTTParty.get(uri(query: query), header: headers)
         end
 
@@ -21,6 +22,7 @@ module IbmTools
 
         def headers
           {
+            'X-UP-API-KEY': @token,
             'Content-Type': 'application/json',
             accept: 'application/json'
           }

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

@@ -6,8 +6,9 @@ module IbmTools
   module People
     module Profile
       class Typeahead < Search
-        def initialize(query, serial: '000000', limit: 10, start: 0)
+        def initialize(query, token = nil, serial: '000000', limit: 10, start: 0)
           uri = "#{IbmTools::People::BLUEPAGES_V1_URI}?userId=#{serial}&rows=#{limit}&start=#{start}&query=#{query}&searchConfig=typeahead_search"
+          @token = token
           @response = HTTParty.get(uri, header: headers, format: :plain)
         end
 
@@ -19,6 +20,7 @@ module IbmTools
 
         def headers
           {
+            'X-UP-API-KEY': @token,
             'Content-Type': 'application/json',
             accept: 'application/json'
           }

data/lib/ibm_tools/people/version.rb

@@ -2,7 +2,7 @@
 
 module IbmTools
   module People
-    VERSION = "1.0.4"
+    VERSION = "1.1.1"
     BLUEPAGES_V3_URI = "https://w3-unifiedprofile-api.dal1a.cirrus.ibm.com/v3/profiles"
     BLUEPAGES_V1_URI = "https://w3-unifiedprofile-search.dal1a.cirrus.ibm.com/search"
     EMAIL_REGEX = %r{\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z}i

data/lib/ibm_tools/people.rb

@@ -15,30 +15,31 @@ module IbmTools
     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 = {})
+      options[:token] = options[:token] || ENV['IBM_PEOPLE_API_KEY']
       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]))
+        IbmTools::People::Profile::Email.new([options[:emails] || options[:email]].flatten, options[:token]).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]))
+        IbmTools::People::Profile::Uid.new([options[:uids] || options[:uid]].flatten, options[:token]).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]))
+        IbmTools::People::Profile::Typeahead.new(options[:query], options[:token], **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
+      IbmTools::People::Profile::Skills.new(options[:uid] || options[:email], options[:token]).results
     end
 
     def self.teams(options = {})
       args = verify(options, single: true)
-      IbmTools::People::Profile::Teams.new(options[:uid] || options[:email]).results
+      IbmTools::People::Profile::Teams.new(options[:uid] || options[:email], options[:token]).results
     end
 
     def self.all(options = {})
       args = verify(options, single: true)
-      IbmTools::People::Profile::All.new(options[:uid] || options[:email]).results
+      IbmTools::People::Profile::All.new(options[:uid] || options[:email], options[:token]).results
     end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibm_tools-people
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.1
 platform: ruby
 authors:
 - Thiago Silva
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: IBM Module - Profile