bamboohr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5f7339f6b13eaba99aaf7ea8a99ad035acbc007
+  data.tar.gz: fd9a98c93818903b09b32f1a9613d67b8632a89a
+SHA512:
+  metadata.gz: 26bf4f568c31f27cdeba6450db4f811ca956d688873fa10b34068f8856b143ca79d2c217c3e790db696189d1aee926b91a25db4e0d9e03d6e72e97ab76158540
+  data.tar.gz: 169b992ed49b7fa4aa37daacc11b03ba3b4d98cd54cb765fa85e57f280c1ae7dbc18ea7a995bf4f986af98e1e66cc70e1ce59169c03cd5c906e45fd583c1a1b6

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bamboohr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Padilla
+
+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

@@ -0,0 +1,44 @@
+# BambooHR
+
+Consume [BambooHR's API](http://www.bamboohr.com/api/documentation/) in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bamboohr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bamboohr
+
+## Usage
+
+Create an instance of the client
+
+    @client = BambooHR::Client.new
+
+Set your company's subdomain
+
+    @client.subdomain = "crowdint"
+
+Set your API key
+
+    @client.key = "SOME_RANDOM_GIBBERISH"
+
+Consume, returns JSON
+
+    employee_list = @client.employee_list
+
+
+## Contributing
+
+1. Fork it ( http://github.com/crowdint/bamboohr/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "cucumber/rake/task"
+require 'rake/testtask'
+
+Cucumber::Rake::Task.new
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task(default: [:test, :cucumber])

data/bamboohr.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bamboohr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bamboohr"
+  spec.version       = BambooHR::VERSION
+  spec.authors       = ["David Padilla"]
+  spec.email         = ["david@crowdint.com"]
+  spec.summary       = %q{Consume BambooHR's API}
+  spec.description   = %q{Consume BambooHR's API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.13.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rr", "~> 1.1.2"
+  spec.add_development_dependency "cucumber", "~> 1.3.12"
+  spec.add_development_dependency "vcr", "~> 2.8.0"
+  spec.add_development_dependency "webmock"
+end

data/features/authentication.feature

@@ -0,0 +1,8 @@
+Feature: Authentication
+
+  @vcr
+  Scenario: Basic Authentication
+    Given I create an instance of the client
+    And I set an API key
+    And I set the company subdomain
+    Then I should be able to authenticate

data/features/step_definitions/api_settings_steps.rb

@@ -0,0 +1,7 @@
+Given(/^I set an API key$/) do
+  @client.key = "API_TOKEN"
+end
+
+Given(/^I set the company subdomain$/) do
+  @client.subdomain = "crowdint"
+end

data/features/step_definitions/authentication_steps.rb

@@ -0,0 +1,3 @@
+Then(/^I should be able to authenticate$/) do
+  assert_equal 200, @client.employee_list!.code
+end

data/features/step_definitions/client_steps.rb

@@ -0,0 +1,3 @@
+Given(/^I create an instance of the client$/) do
+  @client = BambooHR::Client.new
+end

data/features/support/env.rb

@@ -0,0 +1,19 @@
+# env.rb
+#
+require 'bamboohr'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'features/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+  c.default_cassette_options =  { record: :none }
+
+  # Set your API token to record cassettes, use this option
+  # to replace the token with something else
+  #
+  # c.filter_sensitive_data('API_TOKEN') { '' }
+end
+
+VCR.cucumber_tags do |t|
+  t.tag '@vcr', use_scenario_name: true
+end

data/features/vcr_cassettes/Authentication/Basic_Authentication.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://API_TOKEN:x@api.bamboohr.com/api/gateway.php/crowdint/v1/employees/directory
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 18 Mar 2014 22:06:47 GMT
+      Server:
+      - Apache
+      Vary:
+      - User-Agent
+      Connection:
+      - close
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"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"},{"id":"mobilePhone","type":"text","name":"Mobile Phone"},{"id":"workEmail","type":"email","name":"Work
+        Email"},{"id":"department","type":"list","name":"Department"},{"id":"location","type":"list","name":"Location"},{"id":"division","type":"list","name":"Division"},{"id":"photoUploaded","type":"bool","name":"Employee
+        photo exists"},{"id":"photoUrl","type":"url","name":"Employee photo url"},{"type":"bool","name":"","id":"canUploadPhoto"}],"employees":[{"id":"1","displayName":"Cyan
+        Aguirre","firstName":"Cyan","lastName":"Mendoza","jobTitle":"Intern","workPhone":null,"workPhoneExtension":null,"mobilePhone":"312-134-7689","workEmail":"cyan@crowd.com","department":"Development","location":"Colima","division":null,"photoUploaded":false,"photoUrl":"https:\/\/crowdint.bamboohr.com\/images\/photo_placeholder.gif","canUploadPhoto":1}
+        ]}'
+    http_version:
+  recorded_at: Tue, 18 Mar 2014 22:06:48 GMT
+recorded_with: VCR 2.8.0

data/lib/bamboohr.rb

@@ -0,0 +1,6 @@
+require "bamboohr/version"
+
+require "bamboohr/client"
+
+module BambooHR
+end

data/lib/bamboohr/client.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+
+module BambooHR
+  class Client
+    include HTTParty
+    format :json
+
+    base_uri "https://api.bamboohr.com"
+
+    attr_accessor :key
+    attr_accessor :subdomain
+
+    def employee_list!
+      self.class.get("/api/gateway.php/#{subdomain}/v1/employees/directory", basic_auth: auth, headers: headers)
+    end
+
+    def employee_list
+      JSON.parse employee_list!.body
+    end
+
+    private
+    def headers
+      { 'Accept' => 'application/json' }
+    end
+
+    def auth
+      { username: key, password: "x" }
+    end
+  end
+end

data/lib/bamboohr/version.rb

@@ -0,0 +1,3 @@
+module BambooHR
+  VERSION = "0.0.1"
+end

data/test/bamboohr/client_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class BambooHR::ClientTest < Test::Unit::TestCase
+  def setup
+    @subject           = BambooHR::Client.new
+    @subject.subdomain = "crowdint"
+    @subject.key       = "API_TOKEN"
+  end
+
+  def test_employee_list!
+    VCR.use_cassette('Authentication/Basic_Authentication') do
+      response = @subject.employee_list!
+
+      assert_equal true, response.class == HTTParty::Response
+      assert_equal 200, response.code
+    end
+  end
+
+  def test_employee_list
+    json = {}
+    stub(@subject).employee_list!.mock!.body() { "RESPONSE" }
+    mock(JSON).parse("RESPONSE") { json }
+
+    assert_equal json, @subject.employee_list
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler'
+require 'test/unit'
+require 'rr'
+require 'vcr'
+
+Bundler.require
+
+require 'bamboohr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'features/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+  c.default_cassette_options =  { record: :none }
+
+  # Set your API token to record cassettes, use this option
+  # to replace the token with something else
+  #
+  # c.filter_sensitive_data('API_TOKEN') { '' }
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: bamboohr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Padilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.12
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Consume BambooHR's API
+email:
+- david@crowdint.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bamboohr.gemspec
+- features/authentication.feature
+- features/step_definitions/api_settings_steps.rb
+- features/step_definitions/authentication_steps.rb
+- features/step_definitions/client_steps.rb
+- features/support/env.rb
+- features/vcr_cassettes/Authentication/Basic_Authentication.yml
+- lib/bamboohr.rb
+- lib/bamboohr/client.rb
+- lib/bamboohr/version.rb
+- test/bamboohr/client_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Consume BambooHR's API
+test_files:
+- features/authentication.feature
+- features/step_definitions/api_settings_steps.rb
+- features/step_definitions/authentication_steps.rb
+- features/step_definitions/client_steps.rb
+- features/support/env.rb
+- features/vcr_cassettes/Authentication/Basic_Authentication.yml
+- test/bamboohr/client_test.rb
+- test/test_helper.rb