bobhr 0.3.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90881d623b810aaf7a5469ea86edbad348cf430961b4f166667c30931881a054
-  data.tar.gz: bfc0f96e9a49e0c11ebeb326a006ea5a2c03dafc8b9d3ae50be63171b93abd8f
+  metadata.gz: 7802322c3f4a72dbd2ce8b8c91a5e9a1505c4cb597ffc599c77316b4e40a1909
+  data.tar.gz: a037d12cbce500ccbf53affc99eceb321481dafad72503e98681a11176b8b8b7
 SHA512:
-  metadata.gz: c68aa05573becd8c2532b7150161c86fc32a791173ec8f63edbc4461cab734f929ee6c535d2cf10813b634958f1b6f455e22182356b15198c0a080a2a96bd1f7
-  data.tar.gz: 18735135af683b46d6b17ac7d27f8426ee43e8815db6dfea552072d71a3e0851dd6e5c5569c939b545f5fa45abce466de5931083caa9b56796403c9d6339ca6e
+  metadata.gz: 2d9b871d2cb78cf68e75ca628b499237740950e95f0484c9ad1ee40ea909eccbbcad128f5730f728f01b95f832edb8e06b20cb693c27da6931bbc6ef54ab94d4
+  data.tar.gz: b58cb07c4851cc7d8ce37a36ff13fa99def9122efffff45cbe13054db24c6a9a4dfd4690fa4e53256ba55bfaf621e7990996f5c6126777dd64302db672d2b3ef

data/README.md

@@ -40,6 +40,7 @@ Usage examples:
 
 Bob.access_token = 'your-access-token'
 employee = Bob::Employees.find(1)
+employee.department
 employee_trainings = Bob::Employees::Trainings.all(1)
 ```
 
@@ -51,7 +52,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hibob. 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.com/[USERNAME]/hibob/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/lienvdsteen/hibob. 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.com/lienvdsteen/hibob/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -59,4 +60,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Hibob project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hibob/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Hibob project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lienvdsteen/hibob/blob/master/CODE_OF_CONDUCT.md).

data/lib/bob/{api.rb → api/api.rb}

@@ -10,7 +10,7 @@ module Bob
   class API
     BASE_URL = 'https://api.hibob.com'
 
-    def self.get(endpoint, params = {}, csv_response = false)
+    def self.get(endpoint, params = {}, csv_response: false)
       url = build_url(endpoint, params)
       response = RestClient.get(url, headers)
       return create_csv(response.body) if csv_response
@@ -56,17 +56,19 @@ module Bob
       url
     end
 
-    private
-
     def self.create_csv(content)
-      content.gsub!("\r", '').gsub!("", '')
+      file_name = SecureRandom.alphanumeric(15)
+
+      content.gsub!("\r", '').gsub!('', '')
       splitted = content.split("\n")
-      CSV.open("response.csv", "wb") do |csv|
+      CSV.open("tmp/#{file_name}.csv", 'wb') do |csv|
         csv << splitted.shift.split(',')
         splitted.each do |row|
-          csv << row.split(',')
+          csv << CSV.parse_line(row)
         end
       end
+
+      "tmp/#{file_name}.csv"
     end
   end
 end

data/lib/bob/{employee → api/employee}/equity_grants.rb

@@ -4,7 +4,8 @@ module Bob
   module Employee
     class EquityGrants < API
       def self.all(employee_id)
-        get("people/#{employee_id}/equities")
+        response = get("people/#{employee_id}/equities")
+        EquityGrantParser.new(response).equity_grants
       end
 
       def self.create(employee_id, params = {})

data/lib/bob/{employee → api/employee}/salaries.rb

@@ -4,7 +4,8 @@ module Bob
   module Employee
     class Salaries < API
       def self.all(employee_id)
-        get("people/#{employee_id}/salaries")
+        response = get("people/#{employee_id}/salaries")
+        SalaryParser.new(response).salaries
       end
 
       def self.create(employee_id, params = {})

data/lib/bob/{employee → api/employee}/trainings.rb

@@ -4,7 +4,8 @@ module Bob
   module Employee
     class Trainings < API
       def self.all(employee_id)
-        get("people/#{employee_id}/training")
+        response = get("people/#{employee_id}/training")
+        TrainingParser.new(response).trainings
       end
 
       def self.create(employee_id, params = {})

data/lib/bob/{employee → api/employee}/variable_payments.rb

@@ -4,7 +4,8 @@ module Bob
   module Employee
     class VariablePayments < API
       def self.all(employee_id)
-        get("people/#{employee_id}/variable")
+        response = get("people/#{employee_id}/variable")
+        VariablePaymentParser.new(response).variable_payments
       end
 
       def self.create(employee_id, params = {})

data/lib/bob/{employees.rb → api/employees.rb}

@@ -5,20 +5,23 @@ require_relative 'employee/trainings'
 require_relative 'employee/salaries'
 require_relative 'employee/equity_grants'
 require_relative 'employee/documents'
+require_relative 'employee/variable_payments'
 
 module Bob
   class Employees < API
-    def self.all(params = {})
-      get('people', params)['employees']
+    def self.all(params = { includeHumanReadable: true })
+      response = get('people', params)
+      EmployeeParser.new(response).employees
     end
 
-    def self.find(employee_id_or_email)
-      get("people/#{employee_id_or_email}")
+    def self.find(employee_id_or_email, params: { includeHumanReadable: true })
+      response = get("people/#{employee_id_or_email}", params)
+      EmployeeParser.new(response).employee
     end
 
-    def self.find_by(field:, value:)
-      all.find do |employee|
-        employee[field] == value
+    def self.find_by(field:, value:, params: { includeHumanReadable: true })
+      all(params).find do |employee|
+        employee.send(field) == value
       end
     end
 

data/lib/bob/{metadata → api/metadata}/company_fields.rb

@@ -4,7 +4,8 @@ module Bob
   module MetaData
     class CompanyFields < API
       def self.all
-        get('company/people/fields')
+        response = get('company/people/fields')
+        CompanyFieldParser.new(response).fields
       end
 
       def self.create(params = {})

data/lib/bob/{metadata → api/metadata}/company_lists.rb

@@ -4,11 +4,13 @@ module Bob
   module MetaData
     class CompanyLists < API
       def self.all
-        get('company/named-lists')
+        response = get('company/named-lists')
+        CompanyListParser.new(response).lists
       end
 
       def self.find(list_name)
-        get("company/named-lists/#{list_name}")
+        response = get("company/named-lists/#{list_name}")
+        CompanyListParser.new(response).list
       end
 
       def self.add_item(list_name, params = {})

data/lib/bob/{onboarding_wizards.rb → api/onboarding_wizards.rb}

@@ -3,7 +3,8 @@
 module Bob
   class OnboardingWizards < API
     def self.all
-      get('onboarding/wizards')
+      response = get('onboarding/wizards')
+      OnboardingWizardParser.new(response).wizards
     end
   end
 end

data/lib/bob/api/reports.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'net/sftp'
+
+module Bob
+  class Reports < API
+    def self.all
+      get('company/reports')
+    end
+
+    def self.read(report_id)
+      get("company/reports/#{report_id}/download?format=csv", {}, csv_response: true)
+    end
+
+    def self.sftp_upload(sftp_details:, report_id:)
+      file_name = read(report_id)
+      uri = URI.parse("sftp://#{sftp_details[:host]}")
+
+      Net::SFTP.start(uri.host, sftp_details[:user], password: sftp_details[:password]) do |sftp|
+        sftp.upload!(file_name, sftp_details[:remote_file_path])
+      end
+
+      true
+    end
+  end
+end

data/lib/bob/api/time_off.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bob
+  class TimeOff < API
+    def self.all_changed_since(since)
+      response = get('timeoff/requests/changes', { since: since })['changes']
+      TimeOffParser.new({ 'outs' => response }).events
+    end
+
+    def self.today
+      response = get('timeoff/outtoday')
+      TimeOffParser.new(response).events
+    end
+
+    def self.find_for_employee(employee_id, request_id)
+      response = get("timeoff/employees/#{employee_id}/requests/#{request_id}")
+      TimeOffParser.new(response).event
+    end
+  end
+end

data/lib/bob/models/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Models
+  class Base
+    def initialize(raw)
+      attributes = Bob::Util.underscorize_hash(raw)
+
+      attributes.each do |k, v|
+        instance_variable_set("@#{k}", v.is_a?(Hash) ? Models::Base.new(v) : v)
+        self.class.send(:define_method, k, proc { instance_variable_get("@#{k}") })
+        self.class.send(:define_method, "#{k}=", proc { |val| instance_variable_set("@#{k}", val) })
+      end
+    end
+  end
+end

data/lib/bob/models/company_field.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Models
+  class CompanyField < Models::Base
+  end
+end

data/lib/bob/models/company_list.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Models
+  class CompanyList < Models::Base
+  end
+end

data/lib/bob/models/employee.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Models
+  class Employee < Models::Base
+    def manager?
+      work.is_manager
+    end
+
+    def job_title
+      human_readable.work.title
+    end
+
+    def start_date
+      work.start_date
+    end
+
+    def department
+      work.department
+    end
+
+    def division
+      human_readable.work.custom_columns.column_1629151319875
+    end
+
+    def team
+      human_readable.work.custom_columns.column_1642024758438
+    end
+
+    def entity
+      human_readable.work.custom_columns.column_1633980105047
+    end
+
+    def city
+      address.site_city || address.city
+    end
+
+    def role_level
+      human_readable.work.custom_columns.column_1629151373898
+    end
+
+    def manager
+      work.reports_to
+    end
+  end
+end

data/lib/bob/models/equity_grant.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Models
+  class EquityGrant < Models::Base
+  end
+end

data/lib/bob/models/onboarding_wizard.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Models
+  class OnboardingWizard < Models::Base
+  end
+end

data/lib/bob/models/salary.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Models
+  class Salary < Models::Base
+    def change_reason
+      custom_columns.column_1629237637766
+    end
+  end
+end

data/lib/bob/models/time_off.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Models
+  class TimeOff < Models::Base
+    def employee
+      @employee ||= Bob::Employees.find(employee_id)
+    end
+
+    def parental_leave?
+      policy_type_display_name == 'Parental Leave'
+    end
+
+    def created?
+      change_type == 'Created'
+    end
+
+    def return_date
+      @return_date = Date.parse(end_date) + 1.day
+    end
+  end
+end

data/lib/bob/models/training.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Models
+  class Salary < Models::Base
+  end
+end

data/lib/bob/models/variable_payment.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Models
+  class VariablePayment < Models::Base
+  end
+end

data/lib/bob/models.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'models/base'
+require_relative 'models/employee'
+require_relative 'models/equity_grant'
+require_relative 'models/salary'
+require_relative 'models/training'
+require_relative 'models/variable_payment'
+require_relative 'models/time_off'
+require_relative 'models/company_list'
+require_relative 'models/company_field'
+require_relative 'models/onboarding_wizard'

data/lib/bob/parsers/base_parser.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class BaseParser
+  attr_reader :json_response
+
+  def initialize(json_response)
+    @json_response = json_response
+  end
+end

data/lib/bob/parsers/company_field_parser.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class CompanyFieldParser < BaseParser
+  def fields
+    json_response.map { |attributes| Models::CompanyField.new(attributes) }
+  end
+end

data/lib/bob/parsers/company_list_parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CompanyListParser < BaseParser
+  def list
+    Models::CompanyList.new(json_response)
+  end
+
+  def lists
+    json_response.map { |_key, attributes| Models::CompanyList.new(attributes) }
+  end
+end

data/lib/bob/parsers/employee_parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class EmployeeParser < BaseParser
+  def employee
+    Models::Employee.new(json_response)
+  end
+
+  def employees
+    json_response['employees'].map { |attributes| Models::Employee.new(attributes) }
+  end
+end

data/lib/bob/parsers/equity_grant_parser.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class EquityGrantParser < BaseParser
+  def equity_grants
+    json_response['values'].map { |attributes| Models::EquityGrant.new(attributes) }
+  end
+end

data/lib/bob/parsers/onboarding_wizard_parser.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class OnboardingWizardParser < BaseParser
+  def wizards
+    json_response['values'].map { |attributes| Models::OnboardingWizard.new(attributes) }
+  end
+end

data/lib/bob/parsers/salary_parser.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class SalaryParser < BaseParser
+  def salaries
+    json_response['values'].map { |attributes| Models::Salary.new(attributes) }
+  end
+end

data/lib/bob/parsers/time_off_parser.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class TimeOffParser < BaseParser
+  def event
+    Models::TimeOff.new(json_response)
+  end
+
+  def events
+    json_response['outs'].map { |attributes| Models::TimeOff.new(attributes) }
+  end
+end

data/lib/bob/parsers/training_parser.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class TrainingParser < BaseParser
+  def trainings
+    json_response['values'].map { |attributes| Models::Training.new(attributes) }
+  end
+end

data/lib/bob/parsers/variable_payment_parser.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class VariablePaymentParser < BaseParser
+  def variable_payments
+    json_response['values'].map { |attributes| Models::VariablePayment.new(attributes) }
+  end
+end

data/lib/bob/parsers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'parsers/base_parser'
+require_relative 'parsers/employee_parser'
+require_relative 'parsers/equity_grant_parser'
+require_relative 'parsers/salary_parser'
+require_relative 'parsers/training_parser'
+require_relative 'parsers/variable_payment_parser'
+require_relative 'parsers/time_off_parser'
+require_relative 'parsers/company_list_parser'
+require_relative 'parsers/company_field_parser'
+require_relative 'parsers/onboarding_wizard_parser'

data/lib/bob/util.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Credits to https://github.com/myponto/ponto-ruby/blob/master/lib/ponto/util.rb
+module Bob
+  module Util
+    def self.underscorize_hash(attributes)
+      attributes.keys.each_with_object({}) do |key, result|
+        result[underscore(key)] = attributes[key]
+      end
+    end
+
+    def self.underscore(camel_cased_word)
+      return camel_cased_word unless camel_cased_word =~ /[A-Z-]/
+
+      word = camel_cased_word.to_s.gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!('-', '_')
+      word.downcase!
+      word
+    end
+  end
+end

data/lib/bob/version.rb

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

data/lib/bob.rb

@@ -2,13 +2,16 @@
 
 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'
-require_relative 'bob/reports'
+require_relative 'bob/api/api'
+require_relative 'bob/api/employees'
+require_relative 'bob/api/time_off'
+require_relative 'bob/api/onboarding_wizards'
+require_relative 'bob/api/metadata'
+require_relative 'bob/api/reports'
 require_relative 'bob/webhooks'
+require_relative 'bob/models'
+require_relative 'bob/parsers'
+require_relative 'bob/util'
 
 module Bob
   extend Configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bobhr
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Lien Van Den Steen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-15 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -48,21 +62,44 @@ files:
 - LICENSE.txt
 - README.md
 - lib/bob.rb
-- lib/bob/api.rb
+- lib/bob/api/api.rb
+- lib/bob/api/employee/documents.rb
+- lib/bob/api/employee/equity_grants.rb
+- lib/bob/api/employee/invites.rb
+- lib/bob/api/employee/salaries.rb
+- lib/bob/api/employee/trainings.rb
+- lib/bob/api/employee/variable_payments.rb
+- lib/bob/api/employees.rb
+- lib/bob/api/metadata.rb
+- lib/bob/api/metadata/company_fields.rb
+- lib/bob/api/metadata/company_lists.rb
+- lib/bob/api/onboarding_wizards.rb
+- lib/bob/api/reports.rb
+- lib/bob/api/time_off.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/reports.rb
-- lib/bob/time_off.rb
+- lib/bob/models.rb
+- lib/bob/models/base.rb
+- lib/bob/models/company_field.rb
+- lib/bob/models/company_list.rb
+- lib/bob/models/employee.rb
+- lib/bob/models/equity_grant.rb
+- lib/bob/models/onboarding_wizard.rb
+- lib/bob/models/salary.rb
+- lib/bob/models/time_off.rb
+- lib/bob/models/training.rb
+- lib/bob/models/variable_payment.rb
+- lib/bob/parsers.rb
+- lib/bob/parsers/base_parser.rb
+- lib/bob/parsers/company_field_parser.rb
+- lib/bob/parsers/company_list_parser.rb
+- lib/bob/parsers/employee_parser.rb
+- lib/bob/parsers/equity_grant_parser.rb
+- lib/bob/parsers/onboarding_wizard_parser.rb
+- lib/bob/parsers/salary_parser.rb
+- lib/bob/parsers/time_off_parser.rb
+- lib/bob/parsers/training_parser.rb
+- lib/bob/parsers/variable_payment_parser.rb
+- lib/bob/util.rb
 - lib/bob/version.rb
 - lib/bob/webhooks.rb
 - lib/bobhr.rb
@@ -86,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Ruby gem for Bob API

data/lib/bob/reports.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Bob
-  class Reports < API
-    def self.all
-      get('company/reports')
-    end
-
-    def self.read(report_id)
-      get("company/reports/#{report_id}/download?format=csv", {}, true)
-    end
-  end
-end

data/lib/bob/time_off.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Bob
-  class TimeOff < API
-    def self.all_changed_since(since)
-      get('timeoff/requests/changes', { since: since })['changes']
-    end
-
-    def self.today
-      get('timeoff/outtoday')
-    end
-
-    def self.find_for_employee(employee_id, request_id)
-      get("timeoff/employees/#{employee_id}/requests/#{request_id}")
-    end
-  end
-end