bobhr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3a576e62ca3b77d88283be9e4a13b77c4196c99ae9d4a1eab96373fe09bdcae
-  data.tar.gz: fe774f30c3c845d81dfbe8f0da3857cc1055f9938539fe3abd43b18898a279be
+  metadata.gz: e749360430dece90bd974b8089dcab5df02e67c6bacb2d6357d233fbc7f32bad
+  data.tar.gz: a92067aaa2464ce1687bf8291920af2887106a2d3bce4da4fb5f393bbac8bfdf
 SHA512:
-  metadata.gz: d4812690e91027a4afd886da2fc6b6eba6f743018ba05a86a909d6ed209c8847967a1b9a4b2fbdeb2f1744e1508913449f7d2fbaebe3f511c521402c87598060
-  data.tar.gz: dce2b58367cf53b8d263c911e475d174dff6b4d071ce845d7b4dbbef4c6cfbaee44f447f61557e2a4b6c3fae030ba71f2e15987c547789af32e23f3b1e66ae75
+  metadata.gz: 6f821ab2f568e5ebc2850b83d3523cbcb85c738045b689c8ec7963aee8b5a002e7d55cadc619f4bc6ad9bc53c934ece7780adcc1141f56aa32aa083584f7bfff
+  data.tar.gz: 5b539cc092cb32b00f728e2a02531da12b50a554aee9f14427e726a351e362da35d30072eacb175edd5cb10de3f6e103986e5f7fbf5fcc400a84cc2d980500cc

data/.rubocop.yml

@@ -1,5 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
 AllCops:
   TargetRubyVersion: 3.0
   NewCops: enable

data/.rubocop_todo.yml

@@ -1,11 +1,38 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-11-17 13:12:47 UTC using RuboCop version 1.23.0.
+# on 2021-11-22 15:47:01 UTC using RuboCop version 1.23.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+Bundler/OrderedGems:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 2
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
+  Exclude:
+    - 'spec/api_spec.rb'
+    - 'spec/employees_spec.rb'
+
+# Offense count: 1
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 2
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/api_spec.rb'
+    - 'spec/employees_spec.rb'
+
 # Offense count: 1
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?

data/Gemfile

@@ -10,3 +10,5 @@ gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 
 gem 'rubocop', '~> 1.7'
+gem 'rubocop-rspec', require: false
+gem 'rubocop-rake', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bobhr (0.1.0)
+    bobhr (0.1.1)
       json
       rest-client (~> 2.0)
 
@@ -56,6 +56,10 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     unf (0.1.4)
       unf_ext
@@ -70,6 +74,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
-   2.2.22
+   2.2.31

data/README.md

@@ -1,12 +1,14 @@
 # Bob
 
-Bob is a Ruby wrapper and CLI for the [Bob API](https://apidocs.hibob.com/).
+Bob is a Ruby wrapper and CLI for the [Bob API](https://apidocs.hibob.com/). To interact with this Ruby gem you need
+access to Bob. 
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'bob'
+gem 'bobhr'
 ```
 
 And then execute:
@@ -15,16 +17,19 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install bob
+    $ gem install bobhr
 
 ## Usage
 
+Create a Service User in Bob and use the ID and token to configure the client.
+
 Configuration example:
 
 ```ruby
 
 Bob.configure do |config|
   config.access_token = 'your-access-token'
+  config.access_user_name = 'your-access-user-name'
 end
 ```
 
@@ -33,7 +38,8 @@ Usage examples:
 ```ruby
 
 Bob.access_token = 'your-access-token'
-
+employee = Bob::Employees.find(1)
+employee_trainings = Bob::Employees::Trainings.all(1)
 ```
 
 ## Development

data/lib/bob/api.rb

@@ -15,12 +15,37 @@ module Bob
       JSON.parse(response.body)
     end
 
+    def self.post(endpoint, params = {})
+      url = build_url(endpoint)
+      response = RestClient.post(url, params.to_json, headers.merge(content_headers))
+      response.code
+    end
+
+    def self.delete(endpoint)
+      url = build_url(endpoint)
+      response = RestClient.delete(url)
+      response.code
+    end
+
+    def self.put(endpoint, params = {})
+      url = build_url(endpoint)
+      response = RestClient.put(url, params.to_json, headers.merge(content_headers))
+      response.code
+    end
+
     def self.headers
       {
         Authorization: "Basic #{Base64.strict_encode64("#{Bob.access_user_name}:#{Bob.access_token}")}"
       }
     end
 
+    def self.content_headers
+      {
+        Accept: 'application/json',
+        'Content-Type': 'application/json'
+      }
+    end
+
     def self.build_url(endpoint, params = {})
       url = "#{BASE_URL}/#{Bob.api_version}/#{endpoint}"
       url += "?#{URI.encode_www_form(params)}" unless params.empty?

data/lib/bob/employee/documents.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bob
+  module Employee
+    class Documents < API
+      def self.add_public_document(employee_id, params = {})
+        post("docs/people/#{employee_id}/shared", params)
+      end
+
+      def self.add_private_document(employee_id, params = {})
+        post("docs/people/#{employee_id}/confidential", params)
+      end
+    end
+  end
+end

data/lib/bob/employee/equity_grants.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Bob
+  module Employee
+    class EquityGrants < API
+      def self.all(employee_id)
+        get("people/#{employee_id}/equities")
+      end
+
+      def self.create(employee_id, params = {})
+        post("people/#{employee_id}/equities", params)
+      end
+
+      def self.remove(employee_id, entry_id)
+        delete("people/#{employee_id}/salaries/#{entry_id}")
+      end
+    end
+  end
+end

data/lib/bob/employee/invites.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bob
+  module Employee
+    class Invites < API
+      def self.send(employee_id, wizard_id)
+        post("employees/#{employee_id}/invitations", { welcomeWizardId: wizard_id })
+      end
+
+      def self.revoke(employee_id)
+        post("employees/#{employee_id}/uninvite")
+      end
+    end
+  end
+end

data/lib/bob/employee/salaries.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Bob
+  module Employee
+    class Salaries < API
+      def self.all(employee_id)
+        get("people/#{employee_id}/salaries")
+      end
+
+      def self.create(employee_id, params = {})
+        post("people/#{employee_id}/salaries", params)
+      end
+
+      def self.remove(employee_id, salary_id)
+        delete("people/#{employee_id}/salaries/#{salary_id}")
+      end
+    end
+  end
+end

data/lib/bob/employee/trainings.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Bob
+  module Employee
+    class Trainings < API
+      def self.all(employee_id)
+        get("people/#{employee_id}/training")
+      end
+
+      def self.create(employee_id, params = {})
+        post("people/#{employee_id}/training", params)
+      end
+
+      def self.remove(employee_id, training_id)
+        delete("people/#{employee_id}/training/#{training_id}")
+      end
+    end
+  end
+end

data/lib/bob/employee/variable_payments.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bob
+  module Employee
+    class VariablePayments < API
+      def self.all(employee_id)
+        get("people/#{employee_id}/variable")
+      end
+
+      def self.create(employee_id, params = {})
+        post("people/#{employee_id}/variable", params)
+      end
+    end
+  end
+end

data/lib/bob/employees.rb

@@ -1,13 +1,28 @@
 # frozen_string_literal: true
 
+require_relative 'employee/invites'
+require_relative 'employee/trainings'
+require_relative 'employee/salaries'
+require_relative 'employee/equity_grants'
+require_relative 'employee/documents'
+
 module Bob
   class Employees < API
     def self.all(params = {})
       get('people', params)
     end
 
-    def self.find(id_or_email)
-      get("people/#{id_or_email}")
+    def self.find(employee_id_or_email)
+      get("people/#{employee_id_or_email}")
+    end
+
+    # start date needs to be in ISO format
+    def self.update_start_date(employee_id, start_date)
+      post("employees/#{employee_id}", { startDate: start_date })
+    end
+
+    def self.update_email(employee_id, email)
+      put("people/#{employee_id}/email", { email: email })
     end
   end
 end

data/lib/bob/metadata/company_fields.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Bob
+  module MetaData
+    class CompanyFields < API
+      def self.all
+        get('company/people/fields')
+      end
+
+      def self.create(params = {})
+        post('company/people/fields', params)
+      end
+
+      def self.update(field_id, params = {})
+        put("company/people/fields/#{field_id}", params)
+      end
+
+      def self.remove(field_id)
+        delete("company/people/fields/#{field_id}")
+      end
+    end
+  end
+end

data/lib/bob/metadata/company_lists.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Bob
+  module MetaData
+    class CompanyLists < API
+      def self.all
+        get('company/named-lists')
+      end
+
+      def self.find(list_name)
+        get("company/named-lists/#{list_name}")
+      end
+
+      def self.add_item(list_name, params = {})
+        post("company/named-lists/#{list_name}", params)
+      end
+
+      def self.update_item(list_name, item_id, params = {})
+        put("company/named-lists/#{list_name}/#{item_id}", params)
+      end
+
+      def self.remove_item(list_name, item_id)
+        delete("company/named-lists/#{list_name}/#{item_id}")
+      end
+    end
+  end
+end

data/lib/bob/metadata.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'metadata/company_lists'

data/lib/bob/onboarding_wizards.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bob
+  class OnboardingWizards < API
+    def self.all
+      get('onboarding/wizards')
+    end
+  end
+end

data/lib/bob/time_off.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Bob
+  class TimeOff < API
+    def self.all_changed_since(since)
+      get('timeoff/requests/changes', { since: since })
+    end
+
+    def self.today
+      get('timeoff/outtoday')
+    end
+  end
+end

data/lib/bob/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bob
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/bob.rb

@@ -4,6 +4,9 @@ require_relative 'bob/version'
 require_relative 'bob/configuration'
 require_relative 'bob/api'
 require_relative 'bob/employees'
+require_relative 'bob/time_off'
+require_relative 'bob/onboarding_wizards'
+require_relative 'bob/metadata'
 
 module Bob
   extend Configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bobhr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lien Van Den Steen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -60,13 +60,23 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- bob-0.1.0.gem
 - bob.gemspec
 - exe/bob
 - lib/bob.rb
 - lib/bob/api.rb
 - lib/bob/configuration.rb
+- lib/bob/employee/documents.rb
+- lib/bob/employee/equity_grants.rb
+- lib/bob/employee/invites.rb
+- lib/bob/employee/salaries.rb
+- lib/bob/employee/trainings.rb
+- lib/bob/employee/variable_payments.rb
 - lib/bob/employees.rb
+- lib/bob/metadata.rb
+- lib/bob/metadata/company_fields.rb
+- lib/bob/metadata/company_lists.rb
+- lib/bob/onboarding_wizards.rb
+- lib/bob/time_off.rb
 - lib/bob/version.rb
 homepage: https://github.com/lienvdsteen/bob
 licenses:
@@ -88,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: Ruby gem for Bob API