bamboozled 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f769aff89651d9999ec0a648411f64d02e0090e
-  data.tar.gz: 6ae8d5acd58d839a6a81109b342ae86b3e6361fd
+  metadata.gz: f8a9416ada8eceac7ea3e04dff8fc289b33a49c6
+  data.tar.gz: a59005a19d6941995bc4d896b82529ebe9ebcefb
 SHA512:
-  metadata.gz: 599ff90163cbb09bd46757e2ae6d38adcddf8aab803459acbf25128c685fb401b69f3c0f58bf42422b38003ef2d5c539d89f86b591e826b42b563d23f0b192bc
-  data.tar.gz: ade50b34d1f0289eef1b9faaf64033ac5d602dc7c1cfda6946b75c567a52e5323f319959c810d8cd4771534c473e515ce49dfdd68e5f1bde4cde29bba48774d3
+  metadata.gz: e1d43d4bc115a83e706c8d58998488287b938f7bd82ff9074964b6d844fbae029accf3f7d73f5e2f1e9a4a826b74f4697865cb5c860f96baf1602a858ef257a1
+  data.tar.gz: 8e9e7b24da7477331518467fae8a88e35143a430fa2e01ebddd0f61e4d9ea340f61059baa5235bc76f8d5bd37175fa7043644347c203f615887cc80dc886c2e6

data/.gitignore

@@ -1,14 +1,36 @@
-# rdoc generated
-rdoc
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
 
-# yard generated
-doc
-.yardoc
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
 
-# bundler
-.bundle
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
 
-# jeweler generated
-pkg
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
 
-*.gem
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,37 @@
+# require: rubocop-rspec
+
+Rails:
+  Enabled: false
+
+Style/AlignHash:
+  Enabled: true
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/OptionHash:
+  Enabled: true
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: true
+
+RSpec/FilePath:
+  Enabled: false

data/.travis.yml

@@ -1,3 +1,19 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
   - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+  - jruby-head
+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

@@ -0,0 +1,27 @@
+# Changelog
+
+## master (unreleased)
+
+### New Features
+
+### Changes
+
+### Bug Fixes
+
+## 0.1.0 (2016-06-14)
+
+### New Features
+
+* New method `Employee#add` allows client to create new employees. ([@kylefdoherty][])
+* New method `Employee#update` allows client to update new employees. ([@kylefdoherty][])
+
+### Changes
+
+### Bug Fixes
+
+* Added missing documentation for `Employee#add`. ([@mjording][])
+
+[@markrickert]: https://github.com/markrickert
+[@enriikke]: https://github.com/Enriikke
+[@kylefdoherty]: https://github.com/kylefdoherty
+[@mjording]: https://github.com/mjording

data/CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing
+
+Contributions are always welcome! If you discover issues or have ideas for
+improvements, report them or submit pull requests. Please follow the guidelines
+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`.
+* 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.
+
+## Pull Request
+
+* Fork the project.
+* Create a new branch for your feature/bug.
+* Get coding!
+* Write good tests. See [Testing](#testing).
+* Follow the same coding conventions as the rest of the project. See [Coding Style](#coding-style).
+* Squash related commits when needed and write good commit messages.
+* Add an entry to the [Changelog](CHANGELOG.md) accordingly. See [Changelog Entries](#changelog-entries).
+* Make sure the test suite is passing and that there are no style violations
+  before pushing your code.
+* Pull requests should be related to a single subject.
+* Open a pull request until you are happy with your contribution.
+
+### Testing
+
+Always include tests with you code. Bamboozled uses [RSpec](https://github.com/rspec/rspec)
+for testing. We like to follow the recommendations listed in [Better Specs](http://betterspecs.org/).
+
+```sh
+# Run the entire test suite.
+bundle exec rspec
+
+# Run specific test files.
+bundle exec rspec spec/lib/bamboozled/lib/employee_spec.rb
+```
+
+Alternatively, the `Gemfile` includes [Guard](https://github.com/guard/guard), a
+file watcher that will automatically run `rspec` when a file is saved. This is
+not a requirement but we encourage running `bundle exec guard` before starting
+development so that you are able to catch failed tests as you code away :-).
+
+### Coding Style
+
+Bamboozled leverages [Hound](https://houndci.com/) to maintain the code style
+consistent. Hound uses [rubocop](https://github.com/bbatsov/rubocop), which you
+can run locally:
+
+```sh
+# Run for the entire codebase.
+bundle exec rubocop
+
+# Run for a specific file.
+bundle exec rubocop lib/bamboozled.rb
+```
+
+Just like with tests, `guard` will automatically run `rubocop` when a file is
+saved (unless a test fails). Once again, we would like to encourage running
+`bundle exec guard` before starting development.
+
+Hound will comment on pull requests with style violations, and pull requests
+won't be merged until violations are corrected.
+
+### Changelog Entries
+
+* Use [Markdown syntax](http://daringfireball.net/projects/markdown/syntax).
+* The entry line should start with a bullet point `*`.
+* If the change has a related GitHub issue, include a link to it as
+  `[#1](https://github.com/Skookum/bamboozled/issues/1):`.
+* Provide a brief summary of the change.
+* At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.
+* If this is your first contribution, add a link definition for the implicit
+  link to the bottom of the changelog as `[@username]:
+  https://github.com/username`.
+
+Here are a few examples:
+
+```
+* [#3](https://github.com/Skookum/bamboozled/issues/3): Added `HashWithIndifferentAccess` to to fix inconsistencies when accessing data. ([@markrickert][])
+* New method `Employee#add` allows client to create new employees. ([@kylefdoherty][])
+```
+
+---
+
+<p align="center">
+  <img src="logos/skookum_mark_black.png" alt="Skookum" width="100" />
+</p>

data/Gemfile

@@ -1,10 +1,15 @@
 source "http://rubygems.org"
-
 gemspec
 
+group :test do
+  gem "coveralls", require: false
+end
+
 group :development, :test do
-  gem 'bundler', '>= 1.6.2'
-  gem 'webmock'
-  gem 'turn'
-  gem 'rake'
+  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
 end

data/Guardfile

@@ -0,0 +1,21 @@
+group :tdd, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec" do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, all_on_start: false, cmd: "rubocop --require rubocop-rspec" do
+    watch(%r{.+\.rb$}) { |m| m[0] }
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -0,0 +1,160 @@
+[![Gem Version](https://img.shields.io/gem/v/bamboozled.svg)][rubygems]
+[![Build Status](https://img.shields.io/travis/Skookum/bamboozled.svg)][travis]
+[![Code Climate](https://img.shields.io/codeclimate/github/Skookum/bamboozled.svg)][codeclimate]
+[![Coverage Status](https://img.shields.io/coveralls/Skookum/bamboozled.svg)][coveralls]
+[![Inline Docs](http://inch-ci.org/github/Skookum/bamboozled.svg?style=shields)][inchdocs]
+
+[rubygems]: https://rubygems.org/gems/bamboozled
+[travis]: https://travis-ci.org/Skookum/bamboozled
+[codeclimate]: https://codeclimate.com/github/Skookum/bamboozled
+[coveralls]: https://coveralls.io/r/Skookum/bamboozled
+[inchdocs]: http://inch-ci.org/github/Skookum/bamboozled
+
+---
+
+<p align="center">
+  <img src="logos/bamboozled_logo_black.png" alt="Bamboozled" />
+</p>
+
+Bamboozled is a Ruby wrapper for the [BambooHR API](http://www.bamboohr.com/api/documentation/).
+
+## Versioning
+
+Bamboozled follows [Semantic Versioning 2.0.0](http://semver.org/). Make sure to
+always bound the major version when installing if you want to avoid breaking
+changes.
+
+## Documentation
+
+This documentation tracks the latest changes in the `master` branch of this
+repo. Some of the features described might not be available in older versions of
+the gem (including the current stable version). Please consult the relevant git
+tag (e.g. v0.0.7) if you need documentation for a specific Bamboozled version.
+
+## Installation
+
+Bamboozled's installation follows the standard gem installation process:
+
+```sh
+$ gem install bamboozled
+```
+
+If you prefer to install Bamboozled through `bundler` then add it to your
+`Gemfile`:
+
+```ruby
+gem "bamboozled"
+```
+
+## Usage
+
+Create a `client` and provide it with your BambooHR subdomain and an API key:
+
+```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".
+
+### 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")
+
+# Get the employee records which have changed since a given date
+client.employee.last_changed("2015-01-01T00:00:00-08:00", :updated)
+client.employee.last_changed("2015-01-01T00:00:00-08:00", :inserted)
+client.employee.last_changed("2015-01-01T00:00:00-08:00", :deleted)
+client.employee.last_changed("2015-01-01T00:00:00-08:00") # Return all changes
+
+# Returns a hash of a single employee
+client.employee.find(employee_id, fields = nil)
+
+# Adds an employee
+client.employee.add(employee_details_hash)
+
+# 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
+```
+
+## Contributing
+
+Thank you for contributing! We always welcome bug reports and/or pull requests.
+Please take the time to go through our [contribution guidelines](CONTRIBUTING.md).
+
+Special thanks to all the awesome people who have helped make this gem better.
+You can see a list of them [here](https://github.com/Skookum/bamboozled/graphs/contributors).
+
+## License
+
+This project is licensed under the terms of the MIT license. See the
+[LICENSE](/LICENSE) file.
+
+---
+
+<p align="center">
+  <img src="logos/skookum_mark_black.png" alt="Skookum" width="100" />
+</p>