bamboozled 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 333a236b91544f4f2156c2ea5ec3c794e7663917
-  data.tar.gz: c1ce8926265f3759330b4d8748160310b5a926de
+  metadata.gz: 668dff469da070d2244365922ea2b08b672950a5
+  data.tar.gz: 65187b5ad022be606cb96e3937271dca98791f2f
 SHA512:
-  metadata.gz: 8fd3b75c4297435a56f2fe43cc1093a218adb97841d03b0ba3dd152c006eb6285e92e029e18e32676913ef614d1fddcd1e99c98f2911a90cd6f69d5d12119344
-  data.tar.gz: efa608beb9591e5fc316d4449bb138862b884e890783592458bf0c1bc4c50707fdd2ed3af623b7c9cefb684f85fc3f830650785adda7f77f29d578865f3dbe65
+  metadata.gz: 7ae98a06e25bcdcf96afd5ec831eba302bf310dbbbeb70ff053a34de8b424aba6b9d764a271b4ba0841fce535dc8528e734750ce4bcc6575ea4fd0a3fe4e16bf
+  data.tar.gz: 876e2b38e4ca11d4bf4ecaae42afdf0e60f6692cc645b6bcd0f119043d6d3dc3b61064f580c80c8627f7d4e7105c7dfe004294ac31c4db579827993c69c42148

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bamboozled (0.0.4)
+    bamboozled (0.0.6)
       httparty
       json
 
@@ -12,18 +12,18 @@ GEM
     ansi (1.4.3)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
-    httparty (0.13.1)
+    httparty (0.13.3)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
     json (1.8.1)
     minitest (4.7.5)
     multi_xml (0.5.5)
     rake (10.3.2)
-    safe_yaml (1.0.3)
+    safe_yaml (1.0.4)
     turn (0.9.7)
       ansi
       minitest (~> 4)
-    webmock (1.18.0)
+    webmock (1.20.4)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
 

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark Rickert & Skookum Digital Works
+
+MIT License
+
+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

@@ -6,11 +6,15 @@ Bamboozled wraps the BambooHR API without the use of Rails dependencies. Current
 
 # Usage:
 
+Install the gem with `gem install bamboozled` or add this to your `Gemfile`: `gem 'bamboozled'`
+
 ```ruby
 # Create the client:
 client = Bamboozled.client(subdomain: 'your_subdomain', api_key: 'your_api_key')
 ```
 
+> TIP! Create an API key by logging into your BambooHR account, then click your image in the upper right corner and select "API Keys". Then click "Add A New Key".
+
 ### Employee related data:
 
 You can pass an array of fields to `all` or `:all` to get all fields your user 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.
@@ -96,3 +100,6 @@ client.meta.users
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
 
+## License
+
+MIT. See the [LICENSE](/LICENSE) file.

data/examples/employees_over_time.rb

@@ -0,0 +1,53 @@
+# File: employees_over_time.rb
+# Date Created: 2014-08-07
+# Author(s): Mark Rickert (mjar81@gmail.com) / Skookum Digital Works (http://skookum.com)
+#
+# Description: This example script grabs all the historical users in BambooHR
+# and determines how many employees there were at the end of each of the
+# previous 12 months.
+#
+# Run this script with: ruby employees_over_time.rb
+
+require '../lib/bamboozled/'
+require 'active_support'
+require 'active_support/core_ext/integer'
+require 'active_support/core_ext/date'
+
+@subdomain = 'your_subdomain'
+@api_key   = 'your_api_key'
+
+def main
+  client = Bamboozled.client(subdomain:@subdomain, api_key:@api_key)
+
+  # Get all users in the system. Even terminated employees.
+  # Calling client.employee.all only gets active users.
+  employee_data = client.meta.users.map do |e|
+    # Sometimes employees are in the system but don't have an emaployee ID.
+    # This makes them unqueryable and they're usually a duplicate or admin user.
+    next unless e[:employeeId]
+
+    # Get each employee's start_date and termination date
+    client.employee.find(e[:employeeId], %w(displayName department hireDate terminationDate))
+  end.compact.reject{|e| e['hireDate'] == '0000-00-00'}
+
+  # Start from today and go back 12 months and print out how many employees were
+  # at the company on that date.
+  d = (Date.today - 1.month).end_of_month
+  12.times do
+    d = (d - 1.month).end_of_month
+    puts "#{d},#{employees_on_date(employee_data, d)}"
+  end
+
+end
+
+# Simple method to compare hire and termination dates and get the count of employees
+# who were with the company on that day.
+def employees_on_date(employees, date)
+  employees.map do |e|
+    hire_date = Date.parse(e["hireDate"]) rescue nil
+    termination_date = Date.parse(e["terminationDate"]) rescue nil
+    (hire_date <= date && (termination_date.nil? || termination_date >= date)) ? 1 : 0
+  end.inject(:+)
+end
+
+main

data/lib/bamboozled.rb

@@ -2,13 +2,13 @@ require 'httparty'
 require 'json'
 require 'uri'
 
-require 'bamboozled/ext/yesno'
+require_relative './bamboozled/ext/yesno'
 
-require 'bamboozled/version'
-require 'bamboozled/errors'
-require 'bamboozled/base'
+require_relative './bamboozled/version'
+require_relative './bamboozled/errors'
+require_relative './bamboozled/base'
 
-%w(base employee report time_off meta).each {|a| require "bamboozled/api/#{a}"}
+%w(base employee report time_off meta).each {|a| require_relative "./bamboozled/api/#{a}"}
 
 module Bamboozled
   class << self

data/lib/bamboozled/errors.rb

@@ -18,6 +18,7 @@ module Bamboozled
 
   class BadRequest < HTTPError; end #400
   class Unauthorized < HTTPError ; end #
+  class AuthenticationFailed < HTTPError ; end #
   class Forbidden < HTTPError ; end # 403
   class NotFound < HTTPError; end # 404
   class NotAcceptable < HTTPError; end # 406

data/lib/bamboozled/version.rb

@@ -1,3 +1,3 @@
 module Bamboozled
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bamboozled
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Mark Rickert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -49,9 +49,11 @@ files:
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - Rakefile
 - Readme.md
 - bamboozled.gemspec
+- examples/employees_over_time.rb
 - lib/bamboozled.rb
 - lib/bamboozled/api/base.rb
 - lib/bamboozled/api/employee.rb
@@ -89,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A Ruby Wrapper for the BambooHR API http://www.bamboohr.com/