bamboozled 0.0.7 → 0.1.0

data/Rakefile

@@ -1,13 +1,11 @@
-require 'rake/testtask'
+require "bundler/gem_tasks"
 
-Rake::TestTask.new do |t|
-  t.test_files = FileList['spec/lib/bamboozled/*_spec.rb']
-  t.verbose = true
-end
-
-task :default => :test
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
 
 desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -I lib -r bamboozled.rb"
 end
+
+task default: :spec

data/bamboozled.gemspec

@@ -1,25 +1,31 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bamboozled/version'
+require "bamboozled/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "bamboozled"
   spec.version       = Bamboozled::VERSION
   spec.authors       = ["Mark Rickert"]
   spec.email         = ["mjar81@gmail.com"]
-  spec.summary       = "A Ruby Wrapper for the BambooHR API http://www.bamboohr.com/"
+  spec.summary       = "A Ruby wrapper for the BambooHR API http://www.bamboohr.com/"
   spec.description   = "Bamboozled wraps the BambooHR API without the use of Rails dependencies."
   spec.homepage      = "http://github.com/Skookum/bamboozled"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  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.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = ">= 2.0"
 
-  spec.add_runtime_dependency('httparty')
-  spec.add_runtime_dependency('json')
-  spec.add_runtime_dependency('activesupport')
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "webmock", "~> 1.20"
+
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "activesupport"
 end

data/lib/bamboozled.rb

@@ -1,14 +1,16 @@
-require 'httparty'
-require 'json'
-require 'uri'
+require "httparty"
+require "json"
+require "uri"
 
-require_relative './bamboozled/ext/yesno'
-
-require_relative './bamboozled/version'
-require_relative './bamboozled/errors'
-require_relative './bamboozled/base'
-
-%w(base employee report time_off meta).each {|a| require_relative "./bamboozled/api/#{a}"}
+require "bamboozled/version"
+require "bamboozled/base"
+require "bamboozled/errors"
+require "bamboozled/ext/yesno"
+require "bamboozled/api/base"
+require "bamboozled/api/employee"
+require "bamboozled/api/report"
+require "bamboozled/api/time_off"
+require "bamboozled/api/meta"
 
 module Bamboozled
   class << self

data/lib/bamboozled/api/base.rb

@@ -1,4 +1,5 @@
 require 'json'
+require "time"
 require 'active_support/core_ext/hash/indifferent_access'
 
 module Bamboozled
@@ -35,7 +36,11 @@ module Bamboozled
           case response.code
           when 200..201
             begin
-              JSON.parse(response).with_indifferent_access
+              if response.body.to_s.empty?
+                {"headers" => response.headers}.with_indifferent_access
+              else
+                JSON.parse(response.body).with_indifferent_access
+              end
             rescue
               MultiXml.parse(response, symbolize_keys: true)
             end

data/lib/bamboozled/api/employee.rb

@@ -23,6 +23,15 @@ module Bamboozled
         request(:get, "employees/#{employee_id}?fields=#{fields}")
       end
 
+      def last_changed(date = "2011-06-05T00:00:00+00:00", type = nil)
+        query = Hash.new
+        query[:since] = date.respond_to?(:iso8601) ? date.iso8601 : date
+        query[:type] = type unless type.nil?
+
+        response = request(:get, "employees/changed", query: query)
+        response["employees"]
+      end
+
       # Tabular data
       [:job_info, :employment_status, :compensation, :dependents, :contacts].each do |action|
         define_method(action.to_s) do |argument_id|
@@ -54,6 +63,29 @@ module Bamboozled
         "http://#{@subdomain}.bamboohr.com/employees/photos/?h=#{digest}"
       end
 
+      def add(employee_details)
+        details = generate_xml(employee_details)
+        options = {body: details}
+
+        request(:post, "employees/", options)
+      end
+
+      def update(bamboo_id, employee_details)
+        details = generate_xml(employee_details)
+        options = { body: details }
+
+        request(:post, "employees/#{bamboo_id}", options)
+      end
+
+      private
+
+      def generate_xml(employee_details)
+        "".tap do |xml|
+          xml << "<employee>"
+          employee_details.each { |k, v| xml << "<field id='#{k}'>#{v}</field>" }
+          xml << "</employee>"
+        end
+      end
     end
   end
 end

data/lib/bamboozled/api/time_off.rb

@@ -1,9 +1,8 @@
 module Bamboozled
   module API
     class TimeOff < Base
-
       def requests(options = {})
-        allowed_parameters = [:id, :action, :employeeId, :start, :end, :type, :status]
+        allowed_parameters = %i(id action employeeId start end type status)
         options = options.keep_if { |k,_| allowed_parameters.include? k }
 
         # Convert non string dates to strings.
@@ -14,7 +13,9 @@ module Bamboozled
         # Make sure all statuses are allowed
         if options[:status]
           allowed_statuses = %w(approved denied superceded requested canceled)
-          options[:status] = Array(options[:status]).keep_if { |v| allowed_statuses.include? v }.join(",")
+          options[:status] = Array(options[:status])
+                             .keep_if { |v| allowed_statuses.include? v }
+                             .join(",")
         end
 
         request(:get, "time_off/requests?#{URI.encode_www_form(options)}")

data/lib/bamboozled/errors.rb

@@ -12,20 +12,22 @@ module Bamboozled
     end
 
     def to_s
-      "#{self.class.to_s} : #{response.code} #{response.body}" + (hint ? "\n#{hint}" : "")
+      "#{self.class} : #{response.code} #{response.body}".tap do |msg|
+        msg << "\n#{hint}" if hint
+      end
     end
   end
 
-  class BadRequest < HTTPError; end #400
-  class Unauthorized < HTTPError ; end #
-  class AuthenticationFailed < HTTPError ; end #
-  class Forbidden < HTTPError ; end # 403
-  class NotFound < HTTPError; end # 404
-  class NotAcceptable < HTTPError; end # 406
-  class Conflict < HTTPError; end # 409
-  class LimitExceeded < HTTPError; end # 429
-  class InternalServerError < HTTPError; end # 500
-  class GatewayError < HTTPError; end # 502
-  class ServiceUnavailable < HTTPError; end # 503
+  class BadRequest < HTTPError; end
+  class Unauthorized < HTTPError; end
+  class AuthenticationFailed < HTTPError; end
+  class Forbidden < HTTPError; end
+  class NotFound < HTTPError; end
+  class NotAcceptable < HTTPError; end
+  class Conflict < HTTPError; end
+  class LimitExceeded < HTTPError; end
+  class InternalServerError < HTTPError; end
+  class GatewayError < HTTPError; end
+  class ServiceUnavailable < HTTPError; end
   class InformBamboo < HTTPError; end
 end

data/lib/bamboozled/version.rb

@@ -1,3 +1,3 @@
 module Bamboozled
-  VERSION = "0.0.7"
+  VERSION = "0.1.0".freeze
 end

data/logos/skookum_mark_black.svg

@@ -0,0 +1,175 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 18.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 808 808" enable-background="new 0 0 808 808" xml:space="preserve">
+<g enable-background="new    ">
+	<g>
+		<defs>
+			<rect id="SVGID_1_" x="120" y="163" width="570" height="486"/>
+		</defs>
+		<clipPath id="SVGID_2_">
+			<use xlink:href="#SVGID_1_"  overflow="visible"/>
+		</clipPath>
+		<g clip-path="url(#SVGID_2_)">
+			<defs>
+				<rect id="SVGID_3_" width="808" height="808"/>
+			</defs>
+			<clipPath id="SVGID_4_">
+				<use xlink:href="#SVGID_3_"  overflow="visible"/>
+			</clipPath>
+			<g clip-path="url(#SVGID_4_)">
+				<defs>
+					<path id="SVGID_5_" d="M593.3,648.6H423.4c-2.9,0-5.3-2.4-5.3-5.3l-0.1-269.1c0-1.2,1.4-1.3,1.6-0.1l13.7,91.6
+						c4.7,31,27.7,70.5,52.2,89.9l109.9,86.6C600.1,645.7,599.1,648.6,593.3,648.6"/>
+				</defs>
+				<clipPath id="SVGID_6_">
+					<use xlink:href="#SVGID_5_"  overflow="visible"/>
+				</clipPath>
+				<g clip-path="url(#SVGID_6_)">
+					<defs>
+						<rect id="SVGID_7_" width="808" height="808"/>
+					</defs>
+					<clipPath id="SVGID_8_">
+						<use xlink:href="#SVGID_7_"  overflow="visible"/>
+					</clipPath>
+					<rect x="413.1" y="368.2" clip-path="url(#SVGID_8_)" width="190.3" height="285.4"/>
+				</g>
+			</g>
+		</g>
+		<g clip-path="url(#SVGID_2_)">
+			<defs>
+				<rect id="SVGID_9_" width="808" height="808"/>
+			</defs>
+			<clipPath id="SVGID_10_">
+				<use xlink:href="#SVGID_9_"  overflow="visible"/>
+			</clipPath>
+			<g clip-path="url(#SVGID_10_)">
+				<defs>
+					<path id="SVGID_11_" d="M388.7,374.1l-13.8,91.6c-4.7,31-27.7,70.5-52.2,89.9l-109.9,86.6c-4.6,3.6-3.6,6.5,2.2,6.5h169.9
+						c2.9,0,5.3-2.4,5.3-5.3l0.1-269.1C390.2,373,388.8,372.9,388.7,374.1"/>
+				</defs>
+				<clipPath id="SVGID_12_">
+					<use xlink:href="#SVGID_11_"  overflow="visible"/>
+				</clipPath>
+				<g clip-path="url(#SVGID_12_)">
+					<defs>
+						<rect id="SVGID_13_" width="808" height="808"/>
+					</defs>
+					<clipPath id="SVGID_14_">
+						<use xlink:href="#SVGID_13_"  overflow="visible"/>
+					</clipPath>
+					<rect x="204.9" y="368.2" clip-path="url(#SVGID_14_)" width="190.3" height="285.4"/>
+				</g>
+			</g>
+		</g>
+		<g clip-path="url(#SVGID_2_)">
+			<defs>
+				<rect id="SVGID_15_" width="808" height="808"/>
+			</defs>
+			<clipPath id="SVGID_16_">
+				<use xlink:href="#SVGID_15_"  overflow="visible"/>
+			</clipPath>
+			<g clip-path="url(#SVGID_16_)">
+				<defs>
+					<path id="SVGID_17_" d="M686.3,484.6L497,167.7c-1.4-2.3-4.6-4.1-7.3-4.1h-170c-2.6,0-5.9,1.9-7.3,4.1l-189,316.8
+						c-2.9,4.9-0.9,7.4,4.5,5.7L283.5,440c12.8-4.1,28-18.9,32.6-31.6l63.8-178.1c1-2.7,4.1-5,7-5h34.8c2.9,0,6.1,2.3,7,5
+						l63.8,178.1c4.6,12.7,19.8,27.5,32.6,31.6l156.8,50.4C687.2,492,689.2,489.5,686.3,484.6"/>
+				</defs>
+				<clipPath id="SVGID_18_">
+					<use xlink:href="#SVGID_17_"  overflow="visible"/>
+				</clipPath>
+				<g clip-path="url(#SVGID_18_)">
+					<defs>
+						<rect id="SVGID_19_" width="808" height="808"/>
+					</defs>
+					<clipPath id="SVGID_20_">
+						<use xlink:href="#SVGID_19_"  overflow="visible"/>
+					</clipPath>
+					<rect x="117.2" y="158.6" clip-path="url(#SVGID_20_)" width="575.4" height="337.2"/>
+				</g>
+			</g>
+		</g>
+		<g clip-path="url(#SVGID_2_)">
+			<defs>
+				<rect id="SVGID_21_" width="808" height="808"/>
+			</defs>
+			<clipPath id="SVGID_22_">
+				<use xlink:href="#SVGID_21_"  overflow="visible"/>
+			</clipPath>
+			<g clip-path="url(#SVGID_22_)">
+				<defs>
+					<path id="SVGID_23_" d="M347.4,461.4l13.6-90.2c0.2-1.3-1.5-2-2-0.5l-16.7,47.2c-7.4,20.7-29.5,42.1-50.2,48.8l-162.5,52.5
+						c-3.1,1-4.2,4-2.4,6.8l59.2,94c1.7,2.7,5.2,3.3,7.7,1.3l111.5-87.8C324.5,518.5,343.7,485.5,347.4,461.4"/>
+				</defs>
+				<clipPath id="SVGID_24_">
+					<use xlink:href="#SVGID_23_"  overflow="visible"/>
+				</clipPath>
+				<g clip-path="url(#SVGID_24_)">
+					<defs>
+						<rect id="SVGID_25_" width="808" height="808"/>
+					</defs>
+					<clipPath id="SVGID_26_">
+						<use xlink:href="#SVGID_25_"  overflow="visible"/>
+					</clipPath>
+					<rect x="121.2" y="364.9" clip-path="url(#SVGID_26_)" width="244.8" height="262.6"/>
+				</g>
+			</g>
+		</g>
+		<g clip-path="url(#SVGID_2_)">
+			<defs>
+				<rect id="SVGID_27_" width="808" height="808"/>
+			</defs>
+			<clipPath id="SVGID_28_">
+				<use xlink:href="#SVGID_27_"  overflow="visible"/>
+			</clipPath>
+			<g clip-path="url(#SVGID_28_)">
+				<defs>
+					<path id="SVGID_29_" d="M678.9,519.1l-162.5-52.5c-20.8-6.7-42.8-28.2-50.2-48.8l-16.7-47.2c-0.5-1.5-2.2-0.8-2,0.5l13.5,90.2
+						c3.7,24,22.8,57.1,41.9,72l111.5,87.8c2.5,2,6,1.4,7.7-1.3l59.3-94C683,523.2,681.9,520.1,678.9,519.1"/>
+				</defs>
+				<clipPath id="SVGID_30_">
+					<use xlink:href="#SVGID_29_"  overflow="visible"/>
+				</clipPath>
+				<g clip-path="url(#SVGID_30_)">
+					<defs>
+						<rect id="SVGID_31_" width="808" height="808"/>
+					</defs>
+					<clipPath id="SVGID_32_">
+						<use xlink:href="#SVGID_31_"  overflow="visible"/>
+					</clipPath>
+					<rect x="442.4" y="364.9" clip-path="url(#SVGID_32_)" width="244.7" height="262.6"/>
+				</g>
+			</g>
+		</g>
+		<g clip-path="url(#SVGID_2_)">
+			<defs>
+				<rect id="SVGID_33_" width="808" height="808"/>
+			</defs>
+			<clipPath id="SVGID_34_">
+				<use xlink:href="#SVGID_33_"  overflow="visible"/>
+			</clipPath>
+			<g clip-path="url(#SVGID_34_)">
+				<defs>
+					<path id="SVGID_35_" d="M590.5,246.3c0-9.2,7.3-16.8,16.2-16.8s16.2,7.6,16.2,16.8s-7.3,16.8-16.2,16.8
+						S590.5,255.5,590.5,246.3z M586,246.3c0,11.8,9.3,21.3,20.7,21.3c11.5,0,20.7-9.5,20.7-21.3c0-11.8-9.3-21.3-20.7-21.3
+						C595.3,225,586,234.5,586,246.3z M610.2,242c0,3.2-2.9,3.4-6.9,3.4v-6.6C608.4,238.8,610.2,239.1,610.2,242z M616.8,258
+						l-6.7-9.5c3-1,4.6-3.8,4.6-6.6c0-4.8-2.8-6.8-11.2-6.8h-4.6V258h4.4v-9.3h1.5l6.7,9.3H616.8z"/>
+				</defs>
+				<clipPath id="SVGID_36_">
+					<use xlink:href="#SVGID_35_"  overflow="visible"/>
+				</clipPath>
+				<g clip-path="url(#SVGID_36_)">
+					<defs>
+						<rect id="SVGID_37_" width="808" height="808"/>
+					</defs>
+					<clipPath id="SVGID_38_">
+						<use xlink:href="#SVGID_37_"  overflow="visible"/>
+					</clipPath>
+					<rect x="581" y="220" clip-path="url(#SVGID_38_)" fill="#393939" width="51.5" height="52.7"/>
+				</g>
+			</g>
+		</g>
+	</g>
+</g>
+</svg>

data/relnotes/v0.1.0.md

@@ -0,0 +1,13 @@
+### 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][])
+
+[@kylefdoherty]: https://github.com/kylefdoherty
+[@mjording]: https://github.com/mjording

data/spec/fixtures/add_employee_details.json

@@ -0,0 +1,7 @@
+{
+  "firstName": "Bruce",
+  "lastName": "Wayne",
+  "workEmail": "bruce.wayne@gmail.com",
+  "jobTitle": "Batman",
+  "city": "Gotham"
+}

data/spec/fixtures/add_employee_response.json

@@ -0,0 +1,4 @@
+HTTP/1.1 200 OK
+content-type: application/json; charset=utf-8
+date: Tue, 17 Jun 2014 19:25:35 UTC
+location: https://api.bamboohr.com/api/gateway.php/alphasights/v1/employees/44259

data/spec/fixtures/add_employee_xml.yml

@@ -0,0 +1,8 @@
+body:
+  <employee><field id='firstName'>Bruce</field><field id='lastName'>Wayne</field><field id='workEmail'>bruce.wayne@gmail.com</field><field id='jobTitle'>Batman</field><field id='city'>Gotham</field></employee>
+headers:
+  Accept:
+  - application/json
+  User-Agent:
+  - Bamboozled/0.0.7
+

data/spec/fixtures/last_changed.json

@@ -0,0 +1,28 @@
+HTTP/1.1 200 OK
+content-type: application/json; charset=utf-8
+date: Tue, 17 Jun 2014 19:25:35 UTC
+
+{
+  "employees": {
+    "3": {
+      "id":"3",
+      "action":"Inserted",
+      "lastChanged":"2011-06-02T19:26:23+00:00"
+    },
+    "4": {
+      "id":"4",
+      "action":"Updated",
+      "lastChanged":"2011-06-02T19:26:23+00:00"
+    },
+    "5": {
+      "id":"5",
+      "action":"Deleted",
+      "lastChanged":"2011-06-02T19:26:23+00:00"
+    },
+    "10": {
+      "id":"10",
+      "action":"Inserted",
+      "lastChanged":"2011-05-31T22:57:10+00:00"
+    }
+  }
+}