bamboozled 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 635d6d1db5b169bb515d7f4d40a392fcc92e93db
-  data.tar.gz: ddaa342918519a1c1e084b6b887c75996ed3ae2a
+  metadata.gz: ddafc1d234e711cb5b4d541c04aa244e1b3dd77c
+  data.tar.gz: 7a0e3308d1c4d1e7c9f4a76ace3d4a51c5eb11ae
 SHA512:
-  metadata.gz: c0f19e374b5c96fe7e0a52b3fbef85a26d53858aaa79aec1f76f924ee04e8459b66baa8e93101a327f6afa68ed6645302f5408b34895fee5fcf76fa2919e0996
-  data.tar.gz: 48691b174853d721d92ecf5a7e7d235c0a0f55639e4c42fa3ffbdf8d17003cd9be82b7f3d64884b45e8541788fe8bcc442747d824b7f9fdb07e94918b4348978
+  metadata.gz: aa12f8cb8b8418f8a3326fb4060c526da85a2321992c0c7daf72d8bbec504b97d70e8db909a6d00e6e8803216615ff047ddc1d949f95929db363d380f76c17ab
+  data.tar.gz: 68a54ef43b03808b854c268e786e96aaa8b812aafa57b1be7a64d83ea6bfb8d4740bbda62d9558fa8315d2547572cefca4cd38c52410b4b1ac6b96c6b5a389f9

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -4,5 +4,7 @@ gemspec
 
 group :development, :test do
   gem 'bundler', '>= 1.6.2'
+  gem 'webmock'
+  gem 'turn'
   gem 'rake'
 end

data/Gemfile.lock

@@ -8,12 +8,24 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.3.6)
+    ansi (1.4.3)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     httparty (0.13.1)
       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)
+    turn (0.9.7)
+      ansi
+      minitest (~> 4)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
@@ -22,3 +34,5 @@ DEPENDENCIES
   bamboozled!
   bundler (>= 1.6.2)
   rake
+  turn
+  webmock

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/bamboozled/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/Readme.md

@@ -1,22 +1,27 @@
 # Bamboozled
 
-[![Gem Version](https://badge.fury.io/rb/bamboozled.svg)](http://badge.fury.io/rb/bamboozled) [![Code Climate](https://codeclimate.com/github/Skookum/bamboozled.png)](https://codeclimate.com/github/Skookum/bamboozled)
+[![Gem Version](https://badge.fury.io/rb/bamboozled.svg)](http://badge.fury.io/rb/bamboozled) [![Code Climate](https://codeclimate.com/github/Skookum/bamboozled.png)](https://codeclimate.com/github/Skookum/bamboozled) [![Build Status](https://travis-ci.org/Skookum/bamboozled.svg?branch=master)](https://travis-ci.org/Skookum/bamboozled)
 
-Bamboozled wraps the BambooHR API without the use of Rails dependencies.
+Bamboozled wraps the BambooHR API without the use of Rails dependencies. Currently, this gem is **READ-ONLY**.
 
 # Usage:
 
 ```ruby
 # Create the client:
-client = Bamboozled.client('your_subdomain', 'your_api_key')
+client = Bamboozled.client(subdomain: 'your_subdomain', api_key: 'your_api_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.
+
 ```ruby
 # Returns an array of all employees
-client.employee.all
-
+client.employee.all # Gets all employees with default fields
+client.employee.all(:all) # Gets all fields for all employees
+client.employee.all(['hireDate', 'displayName'])
+client.employee.all('hireDate,displayName')
+```
 # Returns a hash of a single employee
 client.employee.find(employee_id, fields = nil)
 
@@ -58,9 +63,10 @@ client.report.find(report_number, format = 'JSON', fd = true)
 ## Todo:
 
 1. Write tests!
-2. Implement photos endpoints
-3. Implement metadata endpoints
-4. Implement last change information endpoints
+2. Implement CRUD so the gem is not read-only any more.
+2. Implement photos endpoints.
+3. Implement metadata endpoints.
+4. Implement last change information endpoints.
 
 ## Contributing
 

data/lib/bamboozled/api/base.rb

@@ -34,7 +34,7 @@ module Bamboozled
           case response.code
           when 200..201
             begin
-              JSON.load(response, nil)
+              JSON.parse(response)
             rescue
               MultiXml.parse(response, symbolize_keys: true)
             end

data/lib/bamboozled/api/employee.rb

@@ -3,15 +3,21 @@ module Bamboozled
     class Employee < Base
 
       def all(fields = nil)
-        fields = all_fields if fields.nil?
-        fields = fields.join(',') if fields.is_a?(Array)
-
-        response = request(:get, "employees/directory?fields=#{fields}")
-        response['employees']
+        response = request(:get, "employees/directory")
+
+        if fields.nil? || fields == :default
+          Array(response['employees'])
+        else
+          employees = []
+          response['employees'].map{|e| e['id']}.each do |id|
+            employees << find(id, fields)
+          end
+          employees
+        end
       end
 
       def find(id, fields = nil)
-        fields = all_fields if fields.nil?
+        fields = all_fields if fields == :all
         fields = fields.join(',') if fields.is_a?(Array)
 
         request(:get, "employees/#{id}?fields=#{fields}")
@@ -29,10 +35,6 @@ module Bamboozled
         request(:get, "employees/#{id}/time_off/calculator?end=#{end_date}")
       end
 
-      def default_fields
-        %w(displayName firstName lastName jobTitle workPhone mobilePhone workEmail department location photoUploaded photoUrl canUploadPhoto).join(',')
-      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

data/lib/bamboozled/errors.rb

@@ -16,7 +16,6 @@ module Bamboozled
     end
   end
 
-  # 400
   class BadRequest < HTTPError; end #400
   class Unauthorized < HTTPError ; end #
   class Forbidden < HTTPError ; end # 403

data/lib/bamboozled/version.rb

@@ -1,3 +1,3 @@
 module Bamboozled
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/fixtures/all_employees.json

@@ -0,0 +1,58 @@
+HTTP/1.1 200 OK
+content-type: application/json; charset=utf-8
+date: Tue, 17 Jun 2014 19:25:35 UTC
+
+{
+  "fields": [
+    {
+      "id": "displayName",
+      "type": "text",
+      "name": "Display Name"
+    },
+    {
+      "id": "firstName",
+      "type": "text",
+      "name": "First Name"
+    },
+    {
+      "id": "lastName",
+      "type": "text",
+      "name": "Last Name"
+    },
+    {
+      "id": "jobTitle",
+      "type": "list",
+      "name": "Job Title"
+    },
+    {
+      "id": "workPhone",
+      "type": "text",
+      "name": "Work Phone"
+    },
+    {
+      "id": "workPhoneExtension",
+      "type": "text",
+      "name": "Work Extension"
+    }
+  ],
+  "employees": [
+    {
+      "id":123,
+      "displayName":"John Doe",
+      "firstName":"John",
+      "lastName":"Doe",
+      "jobTitle":"Customer Service Representative",
+      "workPhone":"555-555-5555",
+      "workPhoneExtension":null
+    },
+    {
+      "id":124,
+      "displayName":"John Doe",
+      "firstName":"John",
+      "lastName":"Doe",
+      "jobTitle":"Customer Service Representative",
+      "workPhone":"555-555-5555",
+      "workPhoneExtension":null
+    }
+  ]
+}

data/spec/fixtures/job_info.xml

@@ -0,0 +1,22 @@
+HTTP/1.1 200 OK
+content-type: application/xml; charset=utf-8
+date: Tue, 17 Jun 2014 19:25:35 UTC
+
+<table>
+  <row id="1" employeeId="100">
+    <field id="date">2010-06-01</field>
+    <field id="location">New York Office</field>
+    <field id="division">Sprockets</field>
+    <field id="department">Research and Development</field>
+    <field id="jobTitle">Machinist</field>
+    <field id="reportsTo">John Smith</field>
+  </row>
+  <row id="2" employeeId="100">
+    <field id="date">2009-03-01</field>
+    <field id="location">New York Office</field>
+    <field id="division">Sprockets</field>
+    <field id="department">Sales</field>
+    <field id="jobTitle">Salesman</field>
+    <field id="reportsTo">Jane Doe</field>
+  </row>
+</table>

data/spec/fixtures/one_employee.json

@@ -0,0 +1,9 @@
+HTTP/1.1 200 OK
+content-type: application/json; charset=utf-8
+date: Tue, 17 Jun 2014 19:25:35 UTC
+
+{
+  "id":123,
+  "firstName":"John",
+  "lastName":"Doe"
+}

data/spec/fixtures/time_off_estimate.json

@@ -0,0 +1,23 @@
+HTTP/1.1 200 OK
+content-type: application/json; charset=utf-8
+date: Tue, 17 Jun 2014 19:25:35 UTC
+
+{
+  "estimates": {
+    "end": "2014-08-31",
+    "estimate": [
+      {
+        "timeOffType" : "64",
+        "name" : "Conference Time Off",
+        "units" : "days",
+        "balance" : "5.0"
+      },
+      {
+        "timeOffType" : "65",
+        "name" : "PTO-Standard",
+        "units" : "hours",
+        "balance" : "85.0"
+      }
+    ]
+  }
+}

data/spec/lib/bamboozled/employee_spec.rb

@@ -0,0 +1,70 @@
+require_relative '../../spec_helper'
+
+describe "Employees" do
+
+  it "Gets all employees" do
+    response = File.new('spec/fixtures/all_employees.json')
+    stub_request(:any, /.*api\.bamboohr\.com.*/).to_return(response)
+
+    client = Bamboozled.client(subdomain:'x', api_key:'x')
+    employees = client.employee.all
+
+    employees.is_a?(Array).must_equal true
+    employees.first.count.must_equal 7
+  end
+
+  it "Gets one employee" do
+    response = File.new('spec/fixtures/one_employee.json')
+    stub_request(:any, /.*api\.bamboohr\.com.*/).to_return(response)
+
+    client = Bamboozled.client(subdomain:'x', api_key:'x')
+    employee = client.employee.find(1234)
+
+    employee.is_a?(Hash).must_equal true
+    employee.count.must_equal 3
+    employee['firstName'].must_equal "John"
+    employee['lastName'].must_equal "Doe"
+  end
+
+  it "Gets employee job info" do
+    response = File.new('spec/fixtures/job_info.xml')
+    stub_request(:any, /.*api\.bamboohr\.com.*/).to_return(response)
+
+    client = Bamboozled.client(subdomain:'x', api_key:'x')
+    info = client.employee.job_info(1234)
+
+    info.is_a?(Hash).must_equal true
+    info[:table][:row].first[:employeeId].must_equal "100"
+    info[:table][:row].first[:field].each do |f|
+      case f[:id]
+      when 'location'
+        f[:__content__].must_equal "New York Office"
+      when 'division'
+        f[:__content__].must_equal "Sprockets"
+      when 'department'
+        f[:__content__].must_equal "Research and Development"
+      when 'jobTitle'
+        f[:__content__].must_equal "Machinist"
+      when 'reportsTo'
+        f[:__content__].must_equal "John Smith"
+      end
+    end
+  end
+
+  it "Gets an employee's time off estimate" do
+    response = File.new('spec/fixtures/time_off_estimate.json')
+    stub_request(:any, /.*api\.bamboohr\.com.*/).to_return(response)
+
+    client = Bamboozled.client(subdomain:'x', api_key:'x')
+    future = Time.now + (60 * 60 * 24 * 180)
+    estimate = client.employee.time_off_estimate(1234, future)
+
+    puts estimate
+
+    estimate.is_a?(Hash).must_equal true
+    estimate['estimates'].keys.must_equal ['end', 'estimate']
+    estimate['estimates']['estimate'].count.must_equal 2
+    estimate['estimates']['estimate'].first.keys.must_equal ['timeOffType', 'name', 'units', 'balance']
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require_relative '../lib/bamboozled'
+
+#dependencies
+require 'minitest/autorun'
+require 'webmock/minitest'
+
+require 'turn'
+
+Turn.config do |c|
+ # :outline  - turn's original case/test outline mode [default]
+ c.format  = :outline
+ # turn on invoke/execute tracing, enable full backtrace
+ c.trace   = true
+ # use humanized test names (works only with :outline format)
+ c.natural = true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bamboozled
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mark Rickert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -46,8 +46,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- Rakefile
 - Readme.md
 - bamboozled.gemspec
 - lib/bamboozled.rb
@@ -59,6 +61,12 @@ files:
 - lib/bamboozled/errors.rb
 - lib/bamboozled/ext/yesno.rb
 - lib/bamboozled/version.rb
+- spec/fixtures/all_employees.json
+- spec/fixtures/job_info.xml
+- spec/fixtures/one_employee.json
+- spec/fixtures/time_off_estimate.json
+- spec/lib/bamboozled/employee_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/Skookum/bamboozled
 licenses:
 - MIT
@@ -83,5 +91,10 @@ rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: A Ruby Wrapper for the BambooHR API http://www.bamboohr.com/
-test_files: []
-has_rdoc: 
+test_files:
+- spec/fixtures/all_employees.json
+- spec/fixtures/job_info.xml
+- spec/fixtures/one_employee.json
+- spec/fixtures/time_off_estimate.json
+- spec/lib/bamboozled/employee_spec.rb
+- spec/spec_helper.rb