bamboozled 0.0.7 → 0.1.0

data/Readme.md

@@ -1,105 +0,0 @@
-# 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. Currently, this gem is **READ-ONLY**.
-
-# 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.
-
-```ruby
-# Returns an array of all employees
-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)
-
-# Tabular employee data
-client.employee.job_info(employee_id)
-client.employee.employment_status(employee_id)
-client.employee.compensation(employee_id)
-client.employee.dependents(employee_id)
-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
-
-```ruby
-# Get time off requests filtered by a number of parameters
-# :id - the ID of the time off request
-# :action - 
-# :employeeId - the ID of the employee you're looking for
-# :start - filter start date
-# :end - filter end date
-# :type - type of time off request
-# :status - must be one or more of the following: approved denied superceded requested canceled
-client.time_off.requests(:employeeId: employee_id, start: Time.now)
-
-# See who is out when.
-client.time_off.whos_out(Time.now, '2014-12-31')
-```
-
-# Reports
-
-```ruby
-# Find a report by its number
-client.report.find(report_number, format = 'JSON', fd = true)
-```
-
-# Metadata
-
-```ruby
-# Get fields
-client.meta.fields
-# Get lists
-client.meta.lists
-# Get tables
-client.meta.tables
-# Get users
-# Note: this is all uses in the system, whereas client.employee.all only gets active employees
-client.meta.users
-```
-
-## Todo:
-
-1. Write more tests!
-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
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Make some specs pass
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
-
-## License
-
-MIT. See the [LICENSE](/LICENSE) file.

data/spec/lib/bamboozled/employee_spec.rb

@@ -1,107 +0,0 @@
-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)
-
-    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)
-
-    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)
-
-    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)
-
-    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
-
-  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

data/spec/lib/bamboozled/hash_spec.rb

@@ -1,24 +0,0 @@
-require_relative '../../spec_helper'
-
-describe "HashWithIndifferentAccess" do
-
-  before do
-    @client = Bamboozled.client(subdomain:'x', api_key:'x')
-  end
-
-  it "Gets data in a hash with indifferent access" do
-    response = File.new('spec/fixtures/one_employee.json')
-    stub_request(:any, /.*api\.bamboohr\.com.*/).to_return(response)
-
-    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"
-
-    employee[:firstName].must_equal "John"
-    employee[:lastName].must_equal "Doe"
-  end
-
-end