bamboozled 0.1.0 → 0.2.0

data/.travis.yml

@@ -1,19 +1,18 @@
 language: ruby
 sudo: false
-cache: bundler
 rvm:
-  - 2.0.0
-  - 2.1
   - 2.2
+  - 2.3.0
+  - 2.4.0
   - ruby-head
   - jruby-head
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+
 matrix:
   fast_finish: true
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
-before_install: gem update --remote bundler && bundle --version
-install:
-  - bundle install --retry=3
-script:
-  - bundle exec rspec

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## master (unreleased)
+## develop (unreleased)
 
 ### New Features
 
@@ -8,6 +8,22 @@
 
 ### Bug Fixes
 
+## 0.2.0 (2019-03-01)
+
+### New Features
+
+* New method `Report#custom` allows fetching a custom report of employees. ([@artfuldodger][])
+* Make httpparty options configurable ([@ivanovv][])
+* Add time tracking api interface ([@nlively][])
+
+### Changes
+
+* Using github actions for linting and testing
+
+### Bug Fixes
+
+* Fix Metadata API calls. Fixes [Issue #38](https://github.com/Skookum/bamboozled/issues/36) and [Issue #5](https://github.com/Skookum/bamboozled/issues/5)
+
 ## 0.1.0 (2016-06-14)
 
 ### New Features
@@ -25,3 +41,8 @@
 [@enriikke]: https://github.com/Enriikke
 [@kylefdoherty]: https://github.com/kylefdoherty
 [@mjording]: https://github.com/mjording
+[@artfuldodger]: https://github.com/artfuldodger
+[@splybon]: https://github.com/splybon
+[@chrisman]: https://github.com/chrisman
+[@ivanovv]: https://github.com/ivanovv
+[@nlively]: https://github.com/nlively

data/CONTRIBUTING.md

@@ -7,7 +7,7 @@ below when doing so.
 ## Issue Reporting
 
 * Make sure the issue has not already been reported.
-* Check that the issue has not already been fixed in `master`.
+* Check that the issue has not already been fixed in `develop`.
 * Open a [new issue](https://github.com/Skookum/bamboozled/issues/new) with a
   clear and concise description of the problem.
 * Include any relevant code or error output in the issue summary.
@@ -15,7 +15,7 @@ below when doing so.
 ## Pull Request
 
 * Fork the project.
-* Create a new branch for your feature/bug.
+* Create a new branch for your feature/bug **off of develop**.
 * Get coding!
 * Write good tests. See [Testing](#testing).
 * Follow the same coding conventions as the rest of the project. See [Coding Style](#coding-style).

data/Dockerfile

@@ -0,0 +1,8 @@
+FROM ruby:2.5
+
+ENV APP_HOME /app
+RUN apt-get update -qq && apt-get install -y build-essential
+RUN mkdir $APP_HOME
+WORKDIR $APP_HOME
+ADD . $APP_HOME/
+RUN bundle install

data/Gemfile

@@ -9,7 +9,8 @@ group :development, :test do
   gem "listen", "3.0.7"
   gem "guard"
   gem "guard-rspec", require: false
-  gem "rubocop", require: false
-  gem "rubocop-rspec", require: false
   gem "guard-rubocop", require: false
+  gem "rubocop", "~> 0.63.1", require: false
+  gem "rubocop-rspec", require: false
+
 end

data/README.md

@@ -65,7 +65,8 @@ is allowed to access. Because BambooHR's API doesn't allow for specifying fields
 on the `/employees/directory` API endpoint, passing a list of fields to retrieve
 will be signifigantly slower than getting just the default fields since the gem
 will get the directory of employees, then request the data for each individual
-employee resulting in `employees.count + 1` API calls.
+employee resulting in `employees.count + 1` API calls. To get around this,
+consider using a custom report.
 
 ```ruby
 # Returns an array of all employees
@@ -121,6 +122,15 @@ client.time_off.whos_out(Time.now, "2014-12-31")
 
 ### Reports
 
+```ruby
+# Get a list of employees with specified fields
+# Send `:all` for `fields` to get all fields.
+# Note that this can get a list of employees with additional fields via a single
+# API request instead of one per employee when using the `employees` endpoint.
+client.report.custom(fields, format = "JSON")
+```
+
+
 ```ruby
 # Find a report by its number
 client.report.find(report_number, format = "JSON", fd = true)

data/bamboozled.gemspec

@@ -1,5 +1,5 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "bamboozled/version"
 
@@ -20,12 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "bundler", ">= 1.10"
   spec.add_development_dependency "rake", "~> 10.4"
   spec.add_development_dependency "rspec", "~> 3.1"
   spec.add_development_dependency "webmock", "~> 1.20"
 
   spec.add_dependency "httparty", "~> 0.13"
   spec.add_dependency "json", "~> 1.8"
-  spec.add_dependency "activesupport"
 end

data/lib/bamboozled.rb

@@ -7,16 +7,18 @@ require "bamboozled/base"
 require "bamboozled/errors"
 require "bamboozled/ext/yesno"
 require "bamboozled/api/base"
+require "bamboozled/api/field_collection"
 require "bamboozled/api/employee"
 require "bamboozled/api/report"
 require "bamboozled/api/time_off"
+require "bamboozled/api/time_tracking"
 require "bamboozled/api/meta"
 
 module Bamboozled
   class << self
     # Creates a standard client that will raise all errors it encounters
-    def client(subdomain: nil, api_key: nil)
-      Bamboozled::Base.new(subdomain: subdomain, api_key: api_key)
+    def client(subdomain: nil, api_key: nil, httparty_options: {})
+      Bamboozled::Base.new(subdomain: subdomain, api_key: api_key, httparty_options: httparty_options)
     end
   end
 end

data/lib/bamboozled/api/base.rb

@@ -1,81 +1,85 @@
 require 'json'
 require "time"
-require 'active_support/core_ext/hash/indifferent_access'
 
 module Bamboozled
   module API
     class Base
       attr_reader :subdomain, :api_key
 
-      def initialize(subdomain, api_key)
-        @subdomain, @api_key = subdomain, api_key
+      def initialize(subdomain, api_key, httparty_options = {})
+        @subdomain = subdomain
+        @api_key = api_key
+        @httparty_options = httparty_options || {}
       end
 
       protected
-        def request(method, path, options = {})
-          params = {
-            path:    path,
-            options: options,
-            method:  method
-          }
+      def request(method, path, options = {})
+        params = {
+          path:    path,
+          options: options,
+          method:  method
+        }
 
-          httparty_options = {
-            query:  options[:query],
-            body:   options[:body],
-            format: :plain,
-            basic_auth: auth,
-            headers: {
-              "Accept"       => "application/json",
-              "User-Agent"   => "Bamboozled/#{Bamboozled::VERSION}"
-            }.update(options[:headers] || {})
-          }
+        httparty_options = @httparty_options.merge({
+          query:  options[:query],
+          body:   options[:body],
+          format: :plain,
+          basic_auth: auth,
+          headers: {
+            "Accept"       => "application/json",
+            "User-Agent"   => "Bamboozled/#{Bamboozled::VERSION}"
+          }.update(options[:headers] || {})
+        })
 
-          response = HTTParty.send(method, "#{path_prefix}#{path}", httparty_options)
-          params[:response] = response.inspect.to_s
+        response = HTTParty.send(method, "#{path_prefix}#{path}", httparty_options)
+        params[:response] = response.inspect.to_s
 
-          case response.code
-          when 200..201
-            begin
-              if response.body.to_s.empty?
-                {"headers" => response.headers}.with_indifferent_access
-              else
-                JSON.parse(response.body).with_indifferent_access
-              end
-            rescue
-              MultiXml.parse(response, symbolize_keys: true)
+        case response.code
+        when 200..201
+          begin
+            if response.body.to_s.empty?
+              { "headers" => response.headers }
+            else
+              JSON.parse(response)
             end
-          when 400
-            raise Bamboozled::BadRequest.new(response, params, 'The request was invalid or could not be understood by the server. Resubmitting the request will likely result in the same error.')
-          when 401
-            raise Bamboozled::AuthenticationFailed.new(response, params, 'Your API key is missing.')
-          when 403
-            raise Bamboozled::Forbidden.new(response, params, 'The application is attempting to perform an action it does not have privileges to access. Verify your API key belongs to an enabled user with the required permissions.')
-          when 404
-            raise Bamboozled::NotFound.new(response, params, 'The resource was not found with the given identifier. Either the URL given is not a valid API, or the ID of the object specified in the request is invalid.')
-          when 406
-            raise Bamboozled::NotAcceptable.new(response, params, 'The request contains references to non-existent fields.')
-          when 409
-            raise Bamboozled::Conflict.new(response, params, 'The request attempts to create a duplicate. For employees, duplicate emails are not allowed. For lists, duplicate values are not allowed.')
-          when 429
-            raise Bamboozled::LimitExceeded.new(response, params, 'The account has reached its employee limit. No additional employees could be added.')
-          when 500
-            raise Bamboozled::InternalServerError.new(response, params, 'The server encountered an error while processing your request and failed.')
-          when 502
-            raise Bamboozled::GatewayError.new(response, params, 'The load balancer or web server had trouble connecting to the Bamboo app. Please try the request again.')
-          when 503
-            raise Bamboozled::ServiceUnavailable.new(response, params, 'The service is temporarily unavailable. Please try the request again.')
-          else
-            raise Bamboozled::InformBamboo.new(response, params, 'An error occurred that we do not now how to handle. Please contact BambooHR.')
+          rescue
+            typecast = options.fetch(:typecast_values, true)
+            MultiXml.parse(response,
+                           symbolize_keys: true,
+                           typecast_xml_value: typecast)
           end
+        when 400
+          raise Bamboozled::BadRequest.new(response, params, 'The request was invalid or could not be understood by the server. Resubmitting the request will likely result in the same error.')
+        when 401
+          raise Bamboozled::AuthenticationFailed.new(response, params, 'Your API key is missing.')
+        when 403
+          raise Bamboozled::Forbidden.new(response, params, 'The application is attempting to perform an action it does not have privileges to access. Verify your API key belongs to an enabled user with the required permissions.')
+        when 404
+          raise Bamboozled::NotFound.new(response, params, 'The resource was not found with the given identifier. Either the URL given is not a valid API, or the ID of the object specified in the request is invalid.')
+        when 406
+          raise Bamboozled::NotAcceptable.new(response, params, 'The request contains references to non-existent fields.')
+        when 409
+          raise Bamboozled::Conflict.new(response, params, 'The request attempts to create a duplicate. For employees, duplicate emails are not allowed. For lists, duplicate values are not allowed.')
+        when 429
+          raise Bamboozled::LimitExceeded.new(response, params, 'The account has reached its employee limit. No additional employees could be added.')
+        when 500
+          raise Bamboozled::InternalServerError.new(response, params, 'The server encountered an error while processing your request and failed.')
+        when 502
+          raise Bamboozled::GatewayError.new(response, params, 'The load balancer or web server had trouble connecting to the Bamboo app. Please try the request again.')
+        when 503
+          raise Bamboozled::ServiceUnavailable.new(response, params, 'The service is temporarily unavailable. Please try the request again.')
+        else
+          raise Bamboozled::InformBamboo.new(response, params, 'An error occurred that we do not now how to handle. Please contact BambooHR.')
         end
+      end
 
-        def auth
-          { username: api_key, password: "x" }
-        end
+      def auth
+        { username: api_key, password: "x" }
+      end
 
-        def path_prefix
-          "https://api.bamboohr.com/api/gateway.php/#{subdomain}/v1/"
-        end
+      def path_prefix
+        "https://api.bamboohr.com/api/gateway.php/#{subdomain}/v1/"
+      end
     end
   end
 end

data/lib/bamboozled/api/employee.rb

@@ -17,8 +17,7 @@ module Bamboozled
       end
 
       def find(employee_id, fields = nil)
-        fields = all_fields if fields == :all
-        fields = fields.join(',') if fields.is_a?(Array)
+        fields = FieldCollection.wrap(fields).to_csv
 
         request(:get, "employees/#{employee_id}?fields=#{fields}")
       end
@@ -44,10 +43,6 @@ module Bamboozled
         request(:get, "employees/#{employee_id}/time_off/calculator?end=#{end_date}")
       end
 
-      def all_fields
-        %w(address1 address2 age bestEmail birthday city country dateOfBirth department division eeo employeeNumber employmentHistoryStatus ethnicity exempt firstName flsaCode fullName1 fullName2 fullName3 fullName4 fullName5 displayName gender hireDate homeEmail homePhone id jobTitle lastChanged lastName location maritalStatus middleName mobilePhone nickname payChangeReason payGroup payGroupId payRate payRateEffectiveDate payType ssn sin state stateCode status supervisor supervisorId supervisorEId terminationDate workEmail workPhone workPhonePlusExtension workPhoneExtension zipcode photoUploaded rehireDate standardHoursPerWeek bonusDate bonusAmount bonusReason bonusComment commissionDate commisionDate commissionAmount commissionComment).join(',')
-      end
-
       def photo_binary(employee_id)
         request(:get, "employees/#{employee_id}/photo/small")
       end

data/lib/bamboozled/api/field_collection.rb

@@ -0,0 +1,107 @@
+module Bamboozled
+  module API
+    class FieldCollection
+      def self.wrap(fields)
+        fields = all_names if fields == :all
+        fields = fields.split(",") if fields.is_a?(String)
+        new(fields)
+      end
+
+      def self.all_names # rubocop:disable Metrics/MethodLength
+        %w[
+          address1
+          address2
+          age
+          bestEmail
+          birthday
+          bonusAmount
+          bonusComment
+          bonusDate
+          bonusReason
+          city
+          commisionDate
+          commissionAmount
+          commissionComment
+          commissionDate
+          country
+          dateOfBirth
+          department
+          displayName
+          division
+          eeo
+          employeeNumber
+          employmentHistoryStatus
+          ethnicity
+          exempt
+          firstName
+          flsaCode
+          fullName1
+          fullName2
+          fullName3
+          fullName4
+          fullName5
+          gender
+          hireDate
+          homeEmail
+          homePhone
+          id
+          includeInPayroll
+          isPhotoUploaded
+          jobTitle
+          lastChanged
+          lastName
+          location
+          maritalStatus
+          middleName
+          mobilePhone
+          originalHireDate
+          paidPer
+          payChangeReason
+          payFrequency
+          payGroup
+          payGroupId
+          payPer
+          payRate
+          payRateEffectiveDate
+          paySchedule
+          payScheduleId
+          payType
+          preferredName
+          sin
+          ssn
+          standardHoursPerWeek
+          state
+          stateCode
+          status
+          supervisor
+          supervisorEId
+          supervisorId
+          terminationDate
+          workEmail
+          workPhone
+          workPhoneExtension
+          workPhonePlusExtension
+          zipcode
+        ]
+      end
+
+      def initialize(fields)
+        self.fields = fields || []
+      end
+
+      def to_csv
+        fields.join(",")
+      end
+
+      def to_xml
+        "<fields>" +
+          fields.map { |field| "<field id=\"#{field}\" />" }.join +
+          "</fields>"
+      end
+
+      private
+
+      attr_accessor :fields
+    end
+  end
+end