lever_postings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cca75eb1f6af1ad679a7ca2b6cc7ecfa747de8e
+  data.tar.gz: c1bd31b5aacfe15d12f4fb4214d0370f930b7a20
+SHA512:
+  metadata.gz: 94fd707ca31acd9e29fa7207240fdc3abd9a11ef52217f9a424f4f86aec8f93c708fd3300bdf84a8a9616ad1d686ba79ffcd9f6dd6d57eb8404925ad6bdb0657
+  data.tar.gz: e049222ae6b8437fc3731e7d23bf3d14dd0daeb89a5d2f25e4d301b79299872835afa4bd1783f6aa8502112d201228546ef419f666224d732418677abc792c85

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,16 @@
+Style/StringLiterals:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100
+
+# Allow for commas at the end of multi-line literals.
+#
+# Example:
+# {
+#   body: "Hello World",
+# }
+#
+# This style protects against forgetting to add a comma and makes git diffs
+# smaller.
+TrailingComma:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sean Abrahams
+
+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,152 @@
+# Lever Postings API
+
+A Ruby client for [Lever.co's Postings API](https://github.com/lever/postings-api). This gem is limited to the functionality of Lever.co's Postings API (which is separate from their more comprehensive Lever API) and is intended to be used for the display of, and application to, jobs from your own web site. For more information see: https://github.com/lever/postings-api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lever_postings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lever_postings
+
+## Usage
+
+### Get Job Postings
+
+Job postings for a company:
+```ruby
+LeverPostings.postings "<site name, ex: leverdemo>"
+```
+
+Individual job posting:
+```ruby
+LeverPostings.postings "<site name, ex: leverdemo>", id: "<specific job posting ID>"
+```
+
+Job postings for a company with query parameters:
+```ruby
+LeverPostings.postings "<site name, ex: leverdemo>", team: "Engineering", location: "San Francisco"
+```
+
+| Query parameter | Description                   |
+| --------------- | ----------------------------- |
+| mode            | The rendering output mode. json or html. Default is json. |
+| skip            | skip N from the start |
+| limit           | only return at most N results |
+| location        | Filter postings by location |
+| commitment      | Filter postings by commitment. |
+| team            | Filter postings by team. |
+| level           | Filter postings by level. |
+| group           | May be one of `location`, `commitment`, or `team`. Returns results grouped by category |
+
+
+#### Postings Result Example
+
+JSON results are parsed and converted into Hashie::Mash objects for property style access to data (posting.text instead of posting[:text]).
+
+| Field       | Description                   |
+| ----------- | ----------------------------- |
+| id          | Unique Job ID
+| text        | Posting name
+| categories  | Object with location, commitment and team
+| description | Job description
+| lists       | Extra lists of things like requirements from the job posting. This is a list of `{text:NAME, content:"unstyled HTML of list elements"}`
+| additional  | Optional closing content for the job posting. May be an empty string.
+| id          | Unique Job ID
+| hostedUrl   | A URL which points to lever's hosted job posting page. [Example](https://jobs.lever.co/leverdemo/5ac21346-8e0c-4494-8e7a-3eb92ff77902)
+| applyUrl    | A URL which points to lever's hosted application form to apply to the job posting. [Example](https://jobs.lever.co/leverdemo/5ac21346-8e0c-4494-8e7a-3eb92ff77902/apply)
+
+```ruby
+posting = LeverPostings.postings("<site name, ex: leverdemo>")[0]
+posting.id # => "5ac21346-8e0c-4494-8e7a-3eb92ff77902"
+posting.text # => "Account Executive"
+posting.description # => "Be a foundational member on a fast-growing sales team..."
+posting.lists # => [
+  # { text => "WITHIN ONE MONTH YOU WILL:"
+  #   content => "<li>Thoroughly know our customers, their needs, and ..." },
+  # { text => "WITHIN 3 MONTHS YOU WILL:"
+  #   content => "<li>Master a consultative strategy to sell Lever’s..." },
+  # { text => "WITHIN 6 MONTHS YOU WILL:"
+  #   content => "<li>Shape, iterate, and scale our sales strategy..." }
+  # ]
+posting.lists[0].text # => "WITHIN ONE MONTH YOU WILL:"
+posting.created_at # => 1380917667108
+posting.hostedUrl # => "https://jobs.lever.co/leverdemo/5ac21346-8e0c-4494-8e7a-3eb92ff77902"
+posting.applyUrl # => "https://jobs.lever.co/leverdemo/5ac21346-8e0c-4494-8e7a-3eb92ff77902/apply"
+posting.categories # => { team => "Sales"
+#     location => "Mountain View"
+#     commitment => "Full-time" }
+# ]
+posting.categories.team # => "Sales"
+```
+
+### Apply to a job posting
+
+This enables you to add job applicants via a custom form on your site.
+
+The API is modeled off Lever's hosted jobs form. If in doubt about custom
+fields, look at any job application form on jobs.lever.co, [for example
+here](https://jobs.lever.co/leverdemo/491029da-9b63-4208-83f6-c976b6fe2ac5/apply).
+
+To use the POST API you need an API key. For now, this must be configured by a Lever employee. Contact support and they can set you up.
+
+```ruby
+LeverPostings.apply "<site name, ex: leverdemo>", "<API key>", {
+  posting_id: "<specific job posting ID>",
+  name: "Spock",
+  email: "spock@yourcompany.com",
+  resume: File.open("/path/to/resume.ext"),
+  phone: "415-555-5555",
+  org: "United Federation of Planets",
+  urls: {
+    github: "https://github.com/spock",
+    twitter: "https://twitter.com/spock" },
+  comments: "LLAP",
+  silent: true
+}
+```
+
+When testing be aware that Lever de-duplicates candidates using their email address. You won't see duplicate testing candidates appear on hire.lever.co.
+
+The candidate will be emailed after they apply to the job, unless the `silent` field is set to true
+
+
+| Field             | Description                   |
+| ----------------- | ----------------------------- |
+| `name` (*required*) | Candidate's named |
+| `email` (*required*)| Email address |
+| `resume`            | Résumé data. Must be a file.
+| `phone`             | Phone number
+| `org`               | Current company / organization
+| `urls`              | Hash of URLs for sites (Github, Twitter, LinkedIn, Portfolio, Other, etc): `{ github: "https://github.com/lever", twitter: "https://twitte.com/lever" }`
+| `comments`          | Additional information from the candidate
+| `silent`            | Disables confirmation email sent to candidates upon application
+
+The server will respond with JSON object.
+
+- On success, **200 OK** and a body of `{ok:true, applicationId: '...'}`
+- The applicationId returned can be used to view the candidate profile in Lever at the url: `https://hire.lever.co/search/application/{applicationId}`. Note that only users logged in to Lever will be able to access that page.
+- On error, Lever will send the appropriate HTTP error code and a body of `{ok:false, error:<error string>}`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/otelic/lever_postings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lever"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lever_postings.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lever_postings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lever_postings"
+  spec.version       = LeverPostings::VERSION
+  spec.authors       = ["Sean Abrahams"]
+  spec.email         = ["abrahams@gmail.com"]
+
+  spec.summary       = %q(Ruby library for accessing Lever.co's Postings API)
+  spec.description   = %q(Ruby library for accessing Lever.co's Postings API)
+  spec.homepage      = "https://github.com/otelic/lever_postings"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "multi_json", "~> 1.10"
+  spec.add_dependency "hashie", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "vcr", "~> 2.9"
+end

data/lib/lever_postings.rb

@@ -0,0 +1,29 @@
+require "faraday"
+require "hashie"
+require "multi_json"
+
+require "lever_postings/client"
+require "lever_postings/error"
+require "lever_postings/posting"
+require "lever_postings/version"
+
+module LeverPostings
+  def self.apply(account, api_key, params)
+    postings_api = LeverPostings::Client.new("postings", account)
+    posting_id = params[:posting_id]
+    results = postings_api.post(posting_id, { api_key: api_key }, params)
+    results
+  end
+
+  def self.postings(account, params = {})
+    params[:mode] ||= "json"
+    postings_api = LeverPostings::Client.new("postings", account)
+    results = postings_api.get(params.delete(:id), params)
+
+    if params.key?(:mode) && params[:mode] == "html"
+      results
+    else
+      Posting.from_json(results)
+    end
+  end
+end

data/lib/lever_postings/client.rb

@@ -0,0 +1,47 @@
+module LeverPostings
+  class Client
+    attr_accessor :account, :api, :connection
+
+    def initialize(api, account)
+      @api = api
+      @account = account
+      @connection = Faraday.new url: "https://api.lever.co/v0/" do |conn|
+        # POST/PUT params encoders:
+        conn.request :multipart
+        conn.request :url_encoded
+        conn.adapter :net_http
+      end
+    end
+
+    def get(path, params = {})
+      request :get, path, {}, params
+    end
+
+    def post(path, options = {}, params = {})
+      request :post, path, options, params
+    end
+
+    def request(method, path, options = {}, params = {})
+      path = path && path != "" ? "/#{path}" : nil
+      url = "#{api}/#{account}#{path}"
+      url += "?key=#{options[:api_key]}" if options.key?(:api_key)
+
+      if method == :post
+        response = connection.post(url, params)
+        response
+      else
+        connection.params = params
+        response = connection.send(method, url)
+        if response.status == 200
+          if params[:mode] == "json"
+            MultiJson.load(response.body, symbolize_keys: true)
+          else
+            response.body
+          end
+        else
+          fail LeverPostings::Error.new("#{response.status}: #{response.body}", response.status)
+        end
+      end
+    end
+  end
+end

data/lib/lever_postings/error.rb

@@ -0,0 +1,10 @@
+module LeverPostings
+  class Error < StandardError
+    attr_reader :code
+
+    def initialize(message, code = nil)
+      super message
+      @code = code
+    end
+  end
+end

data/lib/lever_postings/posting.rb

@@ -0,0 +1,17 @@
+module LeverPostings
+  class Posting
+    def self.from_json(json)
+      if json[0]
+        postings = []
+        json.each do |posting|
+          postings << ::Hashie::Mash.new(posting)
+        end
+        postings
+      elsif json != []
+        ::Hashie::Mash.new(json)
+      else
+        json
+      end
+    end
+  end
+end

data/lib/lever_postings/version.rb

@@ -0,0 +1,3 @@
+module LeverPostings
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: lever_postings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Abrahams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Ruby library for accessing Lever.co's Postings API
+email:
+- abrahams@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lever_postings.gemspec
+- lib/lever_postings.rb
+- lib/lever_postings/client.rb
+- lib/lever_postings/error.rb
+- lib/lever_postings/posting.rb
+- lib/lever_postings/version.rb
+homepage: https://github.com/otelic/lever_postings
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Ruby library for accessing Lever.co's Postings API
+test_files: []