bamboozled 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 413da1e61f882da4c661b84e0f2c4931e3a801b9
-  data.tar.gz: 653872c670f8bb189795b0331970ad23ab4f48f4
+  metadata.gz: 333a236b91544f4f2156c2ea5ec3c794e7663917
+  data.tar.gz: c1ce8926265f3759330b4d8748160310b5a926de
 SHA512:
-  metadata.gz: 1d9ffe7eaa01a46b34eaff800e3fdf54c1c5f7b41a0c14b4b687ce5670f0c8368a9f18752fdd2eef3b265e12c4a2e26f17b69efb362741dbcdc87633d82a24bb
-  data.tar.gz: fec918fcd77a836434326718d8e29a49dfab47abd0c90e3010650f2fd46cd047e095f1152c55e77b2cccfc26abbb0ba34471aef80770a18129ac07191370ac8c
+  metadata.gz: 8fd3b75c4297435a56f2fe43cc1093a218adb97841d03b0ba3dd152c006eb6285e92e029e18e32676913ef614d1fddcd1e99c98f2911a90cd6f69d5d12119344
+  data.tar.gz: efa608beb9591e5fc316d4449bb138862b884e890783592458bf0c1bc4c50707fdd2ed3af623b7c9cefb684f85fc3f830650785adda7f77f29d578865f3dbe65

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bamboozled (0.0.3)
+    bamboozled (0.0.4)
       httparty
       json
 

data/Rakefile

@@ -6,3 +6,8 @@ Rake::TestTask.new do |t|
 end
 
 task :default => :test
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r bamboozled.rb"
+end

data/Readme.md

@@ -21,7 +21,7 @@ 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)
 
@@ -34,6 +34,11 @@ client.employee.contacts(employee_id)
 
 # Time off estimate for employee. Requires end date in Date or Time format or YY-MM-DD string.
 client.employee.time_off_estimate(employee_id, end_date)
+
+# Photos for an employee
+client.employee.photo_url(employee_work_email)
+client.employee.photo_url(employee_id)
+client.employee.photo_binary(employee_id)
 ```
 
 ### Time off data
@@ -76,10 +81,10 @@ client.meta.users
 
 ## Todo:
 
-1. Write tests!
+1. Write more tests!
 2. Implement CRUD so the gem is not read-only any more.
-2. Implement photos endpoints.
-3. Implement metadata endpoints.
+2. ~~Implement photos endpoints.~~
+3. ~~Implement metadata endpoints.~~
 4. Implement last change information endpoints.
 
 ## Contributing

data/lib/bamboozled/api/employee.rb

@@ -16,11 +16,11 @@ module Bamboozled
         end
       end
 
-      def find(id, fields = nil)
+      def find(employee_id, fields = nil)
         fields = all_fields if fields == :all
         fields = fields.join(',') if fields.is_a?(Array)
 
-        request(:get, "employees/#{id}?fields=#{fields}")
+        request(:get, "employees/#{employee_id}?fields=#{fields}")
       end
 
       # Tabular data
@@ -30,14 +30,30 @@ module Bamboozled
         end
       end
 
-      def time_off_estimate(id, end_date)
+      def time_off_estimate(employee_id, end_date)
         end_date = end_date.strftime("%F") unless end_date.is_a?(String)
-        request(:get, "employees/#{id}/time_off/calculator?end=#{end_date}")
+        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
+
+      def photo_url(employee)
+        if (Float(employee) rescue false)
+          e = find(employee, ['workEmail', 'homeEmail'])
+          employee = e['workEmail'].nil? ? e['homeEmail'] : e['workEmail']
+        end
+
+        digest = Digest::MD5.new
+        digest.update(employee.strip.downcase)
+        "http://#{@subdomain}.bamboohr.com/employees/photos/?h=#{digest}"
+      end
+
     end
   end
 end

data/lib/bamboozled/version.rb

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

data/spec/fixtures/employee_emails.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,
+  "workEmail":"me@here.com",
+  "homeEmail":"me@there.com"
+}

data/spec/lib/bamboozled/employee_spec.rb

@@ -2,12 +2,15 @@ require_relative '../../spec_helper'
 
 describe "Employees" do
 
+  before do
+    @client = Bamboozled.client(subdomain:'x', api_key:'x')
+  end
+
   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 = @client.employee.all
 
     employees.is_a?(Array).must_equal true
     employees.first.count.must_equal 7
@@ -17,8 +20,7 @@ describe "Employees" 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 = @client.employee.find(1234)
 
     employee.is_a?(Hash).must_equal true
     employee.count.must_equal 3
@@ -30,8 +32,7 @@ describe "Employees" 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 = @client.employee.job_info(1234)
 
     info.is_a?(Hash).must_equal true
     info[:table][:row].first[:employeeId].must_equal "100"
@@ -55,9 +56,8 @@ describe "Employees" 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)
+    estimate = @client.employee.time_off_estimate(1234, future)
 
     puts estimate
 
@@ -67,4 +67,41 @@ describe "Employees" do
     estimate['estimates']['estimate'].first.keys.must_equal ['timeOffType', 'name', 'units', 'balance']
   end
 
+  it 'returns binary data for an employee email' do
+
+  end
+
+  it 'returns the proper url using employee email address' do
+
+    hashed = '4fdce145bab6d27d69e34403f99fd11c' # Hash of me@here.com
+    required_url = "http://x.bamboohr.com/employees/photos/?h=#{hashed}"
+
+    # Normal
+    url = @client.employee.photo_url('me@here.com')
+    url.must_equal required_url
+
+    # Email with spaces
+    url = @client.employee.photo_url(' me@here.com ')
+    url.must_equal required_url
+
+    # Uppercase emails
+    url = @client.employee.photo_url('ME@HERE.COM')
+    url.must_equal required_url
+  end
+
+  it 'returns the proper url using employee id' do
+    response = File.new('spec/fixtures/employee_emails.json')
+    stub_request(:any, /.*api\.bamboohr\.com.*/).to_return(response)
+
+    hashed = '4fdce145bab6d27d69e34403f99fd11c'
+    required_url = "http://x.bamboohr.com/employees/photos/?h=#{hashed}"
+
+    url = @client.employee.photo_url(123)
+    url.must_equal required_url
+  end
+
+  # TODO - Figure out how to test this with webmock
+  # it 'returns binary data for an employee photo' do
+  # end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bamboozled
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Mark Rickert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -63,6 +63,7 @@ files:
 - lib/bamboozled/ext/yesno.rb
 - lib/bamboozled/version.rb
 - spec/fixtures/all_employees.json
+- spec/fixtures/employee_emails.json
 - spec/fixtures/job_info.xml
 - spec/fixtures/one_employee.json
 - spec/fixtures/time_off_estimate.json
@@ -94,6 +95,7 @@ specification_version: 4
 summary: A Ruby Wrapper for the BambooHR API http://www.bamboohr.com/
 test_files:
 - spec/fixtures/all_employees.json
+- spec/fixtures/employee_emails.json
 - spec/fixtures/job_info.xml
 - spec/fixtures/one_employee.json
 - spec/fixtures/time_off_estimate.json