greenhouse_io-gitlab 2.5.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51f9bbfcc363d99b8b8f920ff67c4141eb410e66809cd76ee1238e595ef7da02
+  data.tar.gz: 6a715a12268273408527ed832fe17e4327407ae9042a02d815aae449d46ff178
+SHA512:
+  metadata.gz: 2a379e7d14cd34c4f48064197c54d35ef581ba578553108e4a1ce739b72f4bbde670133846b6f38c49e0fa3a299385add1ed75ac092e601a312b8d47428e2343
+  data.tar.gz: adc5a9436b3becd331dfac6ba3cf1506dc82c7d67fd69ab3a9efaef8b2ec9f384d17e7cf85c93e0def5129c8fec1e2876861d75ec87a7bd7c44133b9fb887332

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+.ruby-*
+*.swp
+*.un~
+.tags

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.2
+  - 2.1
+
+script: rake spec
+
+sudo: false

data/CHANGES.md

@@ -0,0 +1,41 @@
+# greenhouse_io changelog
+
+This project follows [semantic versioning](http://semver.org/).  This changelog follows suggestions from [keepachangelog.com](http://keepachangelog.com/).
+
+## Version 2.5.0
+Released 2016-05-31.  Contributed by [@theshanx](https://github.com/theshanx).  Thanks!  :)
+
+#### Added
+- Added methods for retrieving offers for an application: `current_offer_for_application` and `offers_for_application`
+
+## Version 2.4.0
+Released 2016-04-20.  Contributed by [@mariochavez](https://github.com/mariochavez) -- thank you!
+
+#### Added
+- Exposed `link` HTTP header in `GreenhouseIo::Client`.
+
+#### Removed
+- Removed dependency on `multi_json` in favor of Ruby's `json` module.
+
+## Version 2.3.1
+Released 2016-04-20.  In retrospect, this should've been a minor version bump instead of a minor version since this added functionality, not a bug fix.
+
+#### Added
+- Added method `create_candidate_note`.  Thanks for contributing, [@jleven](https://github.com/jleven)!
+
+## Version 2.3.0
+Released 2016-02-13.
+
+##### Added
+- Added support for listing all scorecards belonging to an organization: `all_scorecards`.  Thanks, [@bcoppersmith](https://github.com/bcoppersmith)!
+
+## Version 2.2.0
+Released 2016-02-03.
+
+##### Added
+- Added support for listing Offers and retrieving them by ID
+- Added support for filtering with `job_id` parameter
+
+##### Changed
+- Upgraded dependencies: `multi_json` (now ~>1.11.2), and development gems
+- Added version dependency for `httmultiparty`: ``'~> 0.3.16'``

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem "codeclimate-test-reporter", group: :test, require: nil
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adrian Bautista
+
+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,200 @@
+# Greenhouse IO
+
+[![Gem
+Version](https://badge.fury.io/rb/greenhouse_io.png)](http://badge.fury.io/rb/greenhouse_io)
+[![Build Status](https://travis-ci.org/grnhse/greenhouse_io.svg?branch=master)](https://travis-ci.org/grnhse/greenhouse_io)
+[![Test Coverage](https://codeclimate.com/github/grnhse/greenhouse_io/badges/coverage.svg)](https://codeclimate.com/github/grnhse/greenhouse_io/coverage)
+[![Dependency Status](https://gemnasium.com/grnhse/greenhouse_io.svg)](https://gemnasium.com/grnhse/greenhouse_io)
+
+A Ruby interface to
+[Greenhouse.io's](https://app.greenhouse.io/jobboard/jsonp_instructions)
+API (requires Ruby 1.9.3 or greater).
+
+## Installation
+
+Add the gem to your application's Gemfile:
+
+    gem 'greenhouse_io'
+
+Or install it yourself as:
+
+    $ gem install
+
+## API Documentation
+
+Documentation for the Harvest and Job Board web APIs can be found at [developers.greenhouse.io](https://developers.greenhouse.io).
+    
+## Configuration
+
+You can assign default configuration values when using this gem.  
+Here is an example `config/initializers/greenhouse_io.rb` file used in a Rails application:
+
+```ruby
+GreenhouseIo.configure do |config|
+	config.symbolize_keys = true # set response keys as strings or symbols, default is false
+	config.organization = 'General Assembly'
+	config.api_token = ENV['GREENHOUSE_API_TOKEN']
+end
+```
+
+## Usage
+
+Greenhouse's two APIs, **[Harvest](https://app.greenhouse.io/configure/dev_center/harvest)** and **[Job Board](https://app.greenhouse.io/configure/dev_center/api_documentation)**, can now be accessed through the gem. The [`GreenhouseIo::JobBoard`](#greenhouseiojobboard) is nearly identical to the old `GreenhouseIo::API` class. [`GreenhouseIo::Client`](#greenhouseioclient) connects to the new Harvest API.
+
+### GreenhouseIo::JobBoard
+
+Creating an instance of the JobBoard client:
+```ruby
+gh = GreenhouseIo::JobBoard.new("api_token", organization: "your_organization")
+```
+
+If you've configured the gem with a default `organization` and `api_token`, then you can just instantiate the class.
+```ruby
+gh = GreenhouseIo::JobBoard.new
+```
+
+`api_token` is only required for `#apply_to_job` and `organization` is also optional during initialization if an organization is passed in during method requests.
+
+#### Fetching Office Data
+```ruby
+gh.offices
+gh.offices(organization: 'different_organization')
+# returns a hash containing all of the organization's department and jobs grouped by office
+```
+
+```ruby
+gh.office(id)
+gh.office(id, organization: 'different_organization')
+# returns a hash containing the departments and jobs of a specific office
+```
+
+#### Fetching Department Data
+```ruby
+gh.departments
+gh.departments(organization: 'different_organizaton')
+```
+
+```ruby
+gh.department(id)
+gh.department(id, organization: 'different_organization')
+```
+
+#### Fetching Job Data
+```ruby
+gh.jobs
+gh.jobs(content: 'true')
+# includes the job description in the response
+gh.jobs(organization: 'different_organization')
+```
+
+```ruby
+gh.job(id)
+gh.job(id, questions: true)
+# returns the specified job and the array of questions on the application
+gh.job(id, organization: 'different_organization')
+```
+
+#### Submitting a Job Application
+This is the only API method that **requires** an API token from Greenhouse
+```ruby
+gh.apply_to_job(form_parameter_hash)
+
+# form_parameter_hash should match the questions array of a given job opening
+# there should be a hidden input with name id in your form that
+# has the value of the job ID on Greenhouse.io
+```
+
+### GreenhouseIo::Client
+
+Creating an instance of the API client:
+```ruby
+gh_client = GreenhouseIo::Client.new("api_token")
+```
+
+If you've configured the gem with a default `api_token`, then you can just instantiate the class.
+```ruby
+gh_client = GreenhouseIo::Client.new
+```
+
+#### Listing candidates
+
+```ruby
+gh_client.candidates
+```
+
+#### Creating a candidate note
+Use this method to attach a new note to a candidate.
+
+```ruby
+candidate_id = 4567
+author_id = 123 # ID of the user who wrote this note
+note = {
+  :user_id => 123,
+  :message => "This candidate has very strong opinions about Node.JS.",
+  :visibility => "public"
+}
+
+gh_client.create_candidate_note(candidate_id, note, author_id)
+```
+
+#### Throttling
+
+Rate limit and rate limit remaining are available after making an API request with an API client:
+
+```ruby
+gh_client.rate_limit # => 20
+gh_client.rate_limit_remaining  # => 20
+```
+
+#### Pagination
+
+All `GreenhouseIo::Client` API methods accept `:page` and `:per_page` options to get specific results of a paginated response from Greenhouse.
+
+```ruby
+gh_client.offices(id, page: 1, per_page: 2)
+```
+
+You can determine the last page and next page by looking at the `link` header from the last response:
+
+```ruby
+gh_client.link
+
+# => '<https://harvest.greenhouse.io/v1/candidates?page=2&per_page=100>; rel="next",<https://harvest.greenhouse.io/v1/candidates?page=142&per_page=100>; rel="last"'
+```
+
+You'll need to manually parse the `next` and `last` links to tell what the next or final page number will be.
+
+#### Available methods
+
+Methods for which an `id` is optional:
+
+* `offices`
+* `departments`
+* `candidates`
+* `applications`
+* `jobs`
+* `users`
+* `sources`
+* `all_scorecards`
+* `offers`
+
+Methods for which an `id` is **required**:
+
+* `activity_feed` *(requires a candidate ID)*
+* `scorecards` *(requires an application ID)*
+* `scheduled_interviews` *(requires an application ID)*
+* `offers_for_application` *(requires an application ID)*
+* `current_offer_for_application` *(requires an application ID)*
+* `stages` *(requires a job ID)*
+* `job_post` *(requires a job ID)*
+* `create_candidate_note` *(requires a candidate ID)*
+
+## 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. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Contributions are always welcome!

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+task :default => :spec
+desc "Run all spec tests"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+end

data/greenhouse_io.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'greenhouse_io/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "greenhouse_io-gitlab"
+  spec.version       = GreenhouseIo::VERSION
+  spec.authors       = ["Greenhouse Software", "Adrian Bautista"]
+  spec.email         = ["support@greenhouse.io", "adrianbautista8@gmail.com"]
+  spec.description   = %q{Ruby bindings for the greenhouse.io Harvest API and Job Board API}
+  spec.summary       = %q{Ruby bindings for the greenhouse.io Harvest API and Job Board API}
+  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/grnhse/greenhouse_io"
+
+  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('httmultiparty', '~> 0.3.16')
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.4.0"
+  spec.add_development_dependency "webmock", "~> 1.22.6"
+  spec.add_development_dependency "vcr", "~> 3.0.1"
+end

data/lib/greenhouse_io.rb

@@ -0,0 +1,9 @@
+require 'httmultiparty'
+require 'json'
+
+require "greenhouse_io/version"
+require "greenhouse_io/error"
+require "greenhouse_io/configuration"
+require "greenhouse_io/api"
+require "greenhouse_io/api/job_board"
+require "greenhouse_io/api/client"

data/lib/greenhouse_io/api.rb

@@ -0,0 +1,19 @@
+module GreenhouseIo
+  module API
+    def get_response(url, options)
+      self.class.get(url, options)
+    end
+
+    def post_response(url, options)
+      self.class.post(url, options)
+    end
+
+    def parse_json(response)
+      JSON.parse(response.body, symbolize_names: GreenhouseIo.configuration.symbolize_keys)
+    end
+
+    def basic_auth
+      { :username => self.api_token }
+    end
+  end
+end

data/lib/greenhouse_io/api/client.rb

@@ -0,0 +1,145 @@
+module GreenhouseIo
+  class Client
+    include HTTMultiParty
+    include GreenhouseIo::API
+
+    PERMITTED_OPTIONS = [:page, :per_page, :job_id]
+    PERMITTED_OPTIONS_PER_ENDPOINT = {
+      'offers' => [:status, :resolved_after],
+      'candidates' => [:updated_after, :email]
+    }
+
+    attr_accessor :api_token, :rate_limit, :rate_limit_remaining, :link
+    base_uri 'https://harvest.greenhouse.io/v1'
+
+    def initialize(api_token = nil)
+      @api_token = api_token || GreenhouseIo.configuration.api_token
+    end
+
+    def offices(id = nil, options = {})
+      get_from_harvest_api "/offices#{path_id(id)}", options
+    end
+
+    def offers(id = nil, options = {})
+      get_from_harvest_api "/offers#{path_id(id)}", options, "offers"
+    end
+
+    def departments(id = nil, options = {})
+      get_from_harvest_api "/departments#{path_id(id)}", options
+    end
+
+    def candidates(id = nil, options = {})
+      get_from_harvest_api "/candidates#{path_id(id)}", options, "candidates"
+    end
+
+    def activity_feed(id, options = {})
+      get_from_harvest_api "/candidates/#{id}/activity_feed", options
+    end
+
+    def create_candidate_note(candidate_id, note_hash, on_behalf_of)
+      post_to_harvest_api(
+        "/candidates/#{candidate_id}/activity_feed/notes",
+        note_hash,
+        { 'On-Behalf-Of' => on_behalf_of.to_s }
+      )
+    end
+
+    def applications(id = nil, options = {})
+      get_from_harvest_api "/applications#{path_id(id)}", options
+    end
+
+    def offers_for_application(id, options = {})
+      get_from_harvest_api "/applications/#{id}/offers", options
+    end
+
+    def current_offer_for_application(id, options = {})
+      get_from_harvest_api "/applications/#{id}/offers/current_offer", options
+    end
+
+    def scorecards(id, options = {})
+      get_from_harvest_api "/applications/#{id}/scorecards", options
+    end
+
+    def all_scorecards(id = nil, options = {})
+      get_from_harvest_api "/scorecards/#{id}", options
+    end
+
+    def scheduled_interviews(id, options = {})
+      get_from_harvest_api "/applications/#{id}/scheduled_interviews", options
+    end
+
+    def jobs(id = nil, options = {})
+      get_from_harvest_api "/jobs#{path_id(id)}", options
+    end
+
+    def stages(id, options = {})
+      get_from_harvest_api "/jobs/#{id}/stages", options
+    end
+
+    def job_post(id, options = {})
+      get_from_harvest_api "/jobs/#{id}/job_post", options
+    end
+
+    def users(id = nil, options = {})
+      get_from_harvest_api "/users#{path_id(id)}", options
+    end
+
+    def sources(id = nil, options = {})
+      get_from_harvest_api "/sources#{path_id(id)}", options
+    end
+
+    private
+
+    def path_id(id = nil)
+      "/#{id}" unless id.nil?
+    end
+
+    def permitted_options(options)
+      options.select { |key, value| PERMITTED_OPTIONS.include? key }
+    end
+
+    def permitted_options_for_endpoint(options, endpoint)
+      options.select { |key, value| PERMITTED_OPTIONS_PER_ENDPOINT[endpoint].include? key }
+    end
+
+    def get_from_harvest_api(url, options = {}, endpoint = nil)
+      all_permitted_options = permitted_options(options)
+      all_permitted_options.merge!(permitted_options_for_endpoint(options, endpoint)) if endpoint
+
+      response = get_response(url, {
+        :query => all_permitted_options,
+        :basic_auth => basic_auth
+      })
+
+      set_headers_info(response.headers)
+
+      if response.code == 200
+        parse_json(response)
+      else
+        raise GreenhouseIo::Error.new(response.code)
+      end
+    end
+
+    def post_to_harvest_api(url, body, headers)
+      response = post_response(url, {
+        :body => JSON.dump(body),
+        :basic_auth => basic_auth,
+        :headers => headers
+      })
+
+      set_headers_info(response.headers)
+
+      if response.code == 200
+        parse_json(response)
+      else
+        raise GreenhouseIo::Error.new(response.code)
+      end
+    end
+
+    def set_headers_info(headers)
+      self.rate_limit = headers['x-ratelimit-limit'].to_i
+      self.rate_limit_remaining = headers['x-ratelimit-remaining'].to_i
+      self.link = headers['link'].to_s
+    end
+  end
+end