bullhorn-rest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df925ceec33ea8f68cab8201b075d54130cbaa15
+  data.tar.gz: 56a10614ebefb1208fbdee7096377bc19bf28cf0
+SHA512:
+  metadata.gz: 1d7e367a04e4ab26c17c228604f6bdaf4f2d24df9e117a180da947b5f7800dc867b24e173b6a130db131da6ff9139f6a59f1099fe3250752f8ec260b4febeb68
+  data.tar.gz: 5d2de081a563c8f72c52cf8d21d4b5e8cbeced42aec3c6621bd8fd481a2946da998dc9f61bc147a0e094925f398e6f29f0f14b95199cad43d96f56c26614699b

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bullhorn-rest.gemspec
+gemspec
+
+group :test, :development do
+  gem 'rspec'
+  gem 'vcr'
+  gem 'webmock', ['>= 1.8.0', '< 1.16']
+  gem 'multi_json'
+  gem 'awesome_print', :require => 'ap'
+  gem 'pry'
+  gem 'byebug'
+  gem 'maybe'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gordon L. Hempton
+
+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,117 @@
+# Bullhorn::Rest
+
+Ruby wrapper for the [Bullhorn REST API](http://developer.bullhorn.com/articles/getting_started). For additional information on the API itself, see the official [Bullhorn documentation](http://developer.bullhorn.com/documentation).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bullhorn-rest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bullhorn-rest
+
+## Usage
+
+```ruby
+require 'bullhorn/rest'
+
+client = Bullhorn::Rest::Client.new(username: '<USERNAME>', password: '<PASSWORD>', client_id: '<CLIENT_ID>', client_secret: '<CLIENT_SECRET>')
+
+# Returns all candidates
+client.candidates
+
+# Returns all candidates belonging to the current user
+client.user_candidates
+
+# Returns all candidates belonging to the user's department
+client.department_candidates
+
+# Get data for a particular candidate
+client.candidate(id)
+
+# Update a candidate
+client.update_candidate(id, attributes)
+
+# Create a candidate
+client.create_candidate(attributes)
+
+# Delete a candidate
+client.delete_candidate(id)
+
+# Query for candidates
+client.query_candidates(where: "email = 'brogrammer@bigco.com'")
+```
+
+The above api methods generalize to all entities in the system. E.g. for the `JobOrder` entity simple replace occurences of `candidate` with `job_order` in all of the above methods.
+
+### Entities
+
+The following entities are exposed via the API:
+
+* appointment
+* appointment_attendee
+* business_sector
+* candidate
+* candidate_certification
+* candidate_education
+* candidate_reference
+* candidate_work_history
+* category
+* client_contact
+* client_corporation
+* corporate_user
+* corporation_department
+* country
+* custom_action
+* job_order
+* job_submission
+* note
+* note_entity
+* placement
+* placement_change_request
+* placement_commission
+* sendout
+* skill
+* specialty
+* state
+* task
+* tearsheet
+* tearsheet_recipient
+* time_unit
+
+### User Entities
+
+Additionally, the following entities have `user_<entity>` and `department_<entity>` methods available:
+
+* candidate
+* client_contact
+* client_corporation
+* job_order
+* note
+* placement
+
+### Immutable Entities
+
+The following entities are immutable and do not have any of the update/create/delete methods available:
+
+* category
+* corporate_user
+* country
+* skill
+* specialty
+* state
+* time_unit
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/bullhorn-rest/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 @@
+require "bundler/gem_tasks"

data/bullhorn-rest.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bullhorn/rest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bullhorn-rest"
+  spec.version       = Bullhorn::Rest::VERSION
+  spec.authors       = ["Gordon L. Hempton"]
+  spec.email         = ["ghempton@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for the Bullhorn REST API}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/GroupTalent/bullhorn-rest"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "faraday"
+  spec.add_dependency "active_support"
+  spec.add_dependency "i18n"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/bullhorn/rest.rb

@@ -0,0 +1,8 @@
+require "bullhorn/rest/version"
+
+require "bullhorn/rest/client"
+
+module Bullhorn
+  module Rest
+  end
+end

data/lib/bullhorn/rest/authentication.rb

@@ -0,0 +1,79 @@
+module Bullhorn
+module Rest
+
+# http://supportforums.bullhorn.com/viewtopic.php?f=104&t=14542
+module Authentication
+
+  def auth_conn
+    @auth_conn ||= Faraday.new
+  end
+
+  def authorize
+    url = "https://auth.bullhornstaffing.com/oauth/authorize"
+    params = {
+      client_id: client_id,
+      username: username,
+      password: password,
+      action: 'Login',
+      response_type: 'code'
+    }
+    res = auth_conn.get url, params
+    location = res.headers['location']
+
+    @auth_code = CGI::parse(URI(location).query)["code"].first
+  end
+
+
+  def retrieve_tokens
+    url = "https://auth.bullhornstaffing.com/oauth/token"
+    params = {
+      grant_type: 'authorization_code',
+      code: auth_code,
+      client_id: client_id,
+      client_secret: client_secret
+    }
+    res = auth_conn.post url, params
+    hash = JSON.parse(res.body)
+
+    @access_token = hash['access_token']
+    @access_token_expires_in = hash['expires_in']
+    @refresh_token = hash['refresh_token']
+  end
+
+
+  def login
+    url = "https://rest.bullhornstaffing.com/rest-services/login"
+    params = {
+      version: '*',
+      access_token: access_token
+    }
+    response = auth_conn.get url, params
+    hash = JSON.parse(response.body)
+
+    @rest_token = hash['BhRestToken']
+    @rest_url = hash['restUrl']
+  end
+
+
+  def authenticate
+    unless rest_token
+      unless access_token
+        unless auth_code
+          authorize
+        end
+        retrieve_tokens
+      end
+      login
+    end
+  end
+
+
+  def authenticated?
+    # TODO: check expires
+    !!rest_token
+  end
+
+end
+
+end
+end

data/lib/bullhorn/rest/client.rb

@@ -0,0 +1,77 @@
+require 'faraday'
+
+require 'bullhorn/rest/authentication'
+
+require 'bullhorn/rest/entities/base'
+Dir[File.dirname(__FILE__) + '/entities/*.rb'].each {|file| require file }
+
+module Bullhorn
+module Rest
+
+class Client
+
+  include Bullhorn::Rest::Authentication
+  include Bullhorn::Rest::Entities::Appointment
+  include Bullhorn::Rest::Entities::AppointmentAttendee
+  include Bullhorn::Rest::Entities::BusinessSector
+  include Bullhorn::Rest::Entities::Candidate
+  include Bullhorn::Rest::Entities::CandidateCertification
+  include Bullhorn::Rest::Entities::CandidateEducation
+  include Bullhorn::Rest::Entities::CandidateReference
+  include Bullhorn::Rest::Entities::CandidateWorkHistory
+  include Bullhorn::Rest::Entities::Category
+  include Bullhorn::Rest::Entities::ClientContact
+  include Bullhorn::Rest::Entities::ClientCorporation
+  include Bullhorn::Rest::Entities::CorporateUser
+  include Bullhorn::Rest::Entities::CorporationDepartment
+  include Bullhorn::Rest::Entities::Country
+  include Bullhorn::Rest::Entities::CustomAction
+  include Bullhorn::Rest::Entities::JobOrder
+  include Bullhorn::Rest::Entities::JobSubmission
+  include Bullhorn::Rest::Entities::Note
+  include Bullhorn::Rest::Entities::NoteEntity
+  include Bullhorn::Rest::Entities::Placement
+  include Bullhorn::Rest::Entities::PlacementChangeRequest
+  include Bullhorn::Rest::Entities::PlacementCommission
+  include Bullhorn::Rest::Entities::Sendout
+  include Bullhorn::Rest::Entities::Skill
+  include Bullhorn::Rest::Entities::Specialty
+  include Bullhorn::Rest::Entities::State
+  include Bullhorn::Rest::Entities::Task
+  include Bullhorn::Rest::Entities::Tearsheet
+  include Bullhorn::Rest::Entities::TearsheetRecipient
+  include Bullhorn::Rest::Entities::TimeUnit
+
+  attr_reader :username, :password, :client_id, :client_secret, :auth_code, :access_token, :rest_token, :rest_url, :refresh_token
+
+  # Initializes a new Bullhorn REST Client
+  def initialize(options = {})
+
+    @username = options[:username]
+    @password = options[:password]
+    @client_id = options[:client_id]
+    @client_secret = options[:client_secret]
+    @auth_code = options[:auth_code]
+    @rest_url = options[:rest_url]
+    @rest_token = options[:rest_token]
+    @access_token = options[:access_token]
+    @refresh_token = options[:refresh_token]
+
+  end
+
+  def conn
+    if !authenticated?
+      authenticate
+    end
+
+    params = {
+      BhRestToken: rest_token
+    }
+
+    @conn ||= Faraday.new(url: rest_url, params: params)
+  end
+
+end
+
+end
+end

data/lib/bullhorn/rest/entities/appointment.rb

@@ -0,0 +1,13 @@
+module Bullhorn
+module Rest
+module Entities
+
+module Appointment
+  extend Base
+
+  define_methods
+end
+
+end
+end
+end

data/lib/bullhorn/rest/entities/appointment_attendee.rb

@@ -0,0 +1,13 @@
+module Bullhorn
+module Rest
+module Entities
+
+module AppointmentAttendee
+  extend Base
+
+  define_methods
+end
+
+end
+end
+end

data/lib/bullhorn/rest/entities/base.rb

@@ -0,0 +1,73 @@
+require 'active_support/all'
+
+module Bullhorn
+module Rest
+module Entities
+
+# http://developer.bullhorn.com/sites/default/files/BullhornRESTAPI_0.pdf
+module Base
+
+  def entity
+    @entity || self.name.demodulize.underscore
+  end
+
+  def define_methods(options={})
+    name = entity.to_s.classify
+    plural = entity.to_s.pluralize
+    name_plural = name.pluralize
+
+
+    if options[:owner_methods]
+      define_method("department_#{plural}") do |options={}|
+        params = {fields: '*'}.merge(options)
+        path = "department#{name_plural}"
+        conn.get path, params
+      end
+
+      define_method("user_#{plural}") do |options={}|
+        params = {fields: '*'}.merge(options)
+        path = "my#{name_plural}"
+        conn.get path, params
+      end
+
+      alias_method plural, "department_#{plural}"
+    else
+      # Don't see an "all" entities api call. Instead we
+      # use a criteria that is always true
+      define_method(plural) do |options={}|
+        send "query_#{plural}", where: "id IS NOT NULL"
+      end
+    end
+
+    define_method("query_#{plural}") do |options={}|
+      params = {fields: '*'}.merge(options)
+      path = "query/#{name}"
+      conn.get path, params
+    end
+
+    unless options[:immutable]
+
+      define_method("create_#{entity}") do |id, attributes={}|
+        path = "#{name}/#{id}"
+        conn.put path, attributes
+      end
+
+      define_method("update_#{entity}") do |id, attributes={}|
+        path = "#{name}/#{id}"
+        conn.post path, attributes
+      end
+
+      define_method("delete_#{entity}") do |id|
+        path = "#{name}/#{id}"
+        conn.delete path
+      end
+
+    end
+
+  end
+
+end
+
+end
+end
+end