icims 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b628fb625d9fb38ab0447e3ed58a4beec30fdf27
+  data.tar.gz: 5ca56ef7f805e2e7a6231190197b946597a28269
+SHA512:
+  metadata.gz: 3a68d0aefb3a4d201cc6d07a8c495652889a8730c88afc91f3da6ed76db90b40a47b75e59a77a6ce6c91e1499c87de1b1871461cb9148181d32f3ef27ca8ab71
+  data.tar.gz: 089c78f4279dcc152b1458a04b0fd972da159f0abc78fed58c1d47df7c2735d181159d6d79f131fd4b98e77e9369ede484ad7d78261510a4b800e88e17f8d033

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,66 @@
+# iCIMS API Integration
+
+Simple wrapper around iCIMS API to avoid technicalities around their workflow.
+
+Read more on iCIMS API here: [http://developer.icims.com/REST-API/Object-Types-Commands/Search-API](http://developer.icims.com/REST-API/Object-Types-Commands/Search-API)
+
+## Getting Started
+
+Create an initializer file to setup iCIMS credentials. I suggest using DotEnv to keep it secret.
+
+```
+# config/initializers/icims.rb
+ICIMS.setup do |config|
+  config.username    = ENV['ICIMS_API_USER']
+  config.password    = ENV['ICIMS_API_PASS']
+  config.customer_id = ENV['ICIMS_API_CUSTOMER']
+
+  # Value for job.postedto to fetch approved job offers only
+  # You may want to include more than one portal. This number changes from one implementation to another.
+  config.portal_ids  = ['1']
+end
+```
+
+## Usage
+
+### Find single record
+
+`ICIMS::Job.find(123)` where 123 is iCIMS record id and will return a ICIMS::Job instance.
+Optional `fields` parameter
+
+### Approved jobs
+
+`ICIMS::Job.approved` returns approved and posted jobs
+
+### Search for jobs
+
+`ICIMS::Job.search(fields)` relies on iCIMS query interface to define filters.
+
+```
+filters = [
+            {
+              name: "job.folder",
+              value: ['C14567'],
+              operator: "="
+            },
+            {
+              name: "job.postedto",
+              value: ['3'],
+              operator: "="
+            }
+          ]
+ICIMS::Job.search(filters)
+```
+
+## Contributing
+
+Once you've made your great commits:
+
+- Fork icims
+- Create a topic branch - git checkout -b my_branch
+- Push to your branch - git push origin my_branch
+- Create an Issue with a link to your branch
+- That's it!
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Icims'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/icims.rb

@@ -0,0 +1,30 @@
+require 'icims/requestable'
+require 'icims/get_request'
+require 'icims/search_request'
+require 'icims/job'
+
+module ICIMS
+  require 'net/https'
+  require 'uri'
+  require 'openssl'
+  require 'json'
+  require 'httparty'
+  require 'active_support/all'
+
+  mattr_accessor :username
+  mattr_accessor :password
+  mattr_accessor :customer_id
+  mattr_accessor :portal_ids
+
+  def self.setup
+    yield self
+  end
+
+  def self.logger
+    @logger ||= begin
+      log_file = defined?(Rails) ? [Rails.root, 'log', 'icims.log'].join('/') : 'icims.log'
+      Logger.new(log_file)
+    end
+  end
+
+end

data/lib/icims/get_request.rb

@@ -0,0 +1,47 @@
+module ICIMS
+  class GetRequest
+
+    include Requestable
+
+    def initialize url
+      @url = url
+    end
+
+    def call
+      request = get_request_object
+      ICIMS.logger.info "#{request.method} #{uri.to_s}"
+      response = ssl_connection.request(request)
+      parsed_response = JSON.parse(response.body)
+      ICIMS.logger.info parsed_response
+      parsed_response
+    end
+
+    class << self
+
+      def perform(url)
+        new(url).call
+      end
+
+    end
+
+    private
+
+    def uri
+      URI.parse(customer_url + @url)
+    end
+
+    def ssl_connection
+      connection = Net::HTTP.new(uri.host, uri.port)
+      connection.use_ssl = true
+      connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      connection
+    end
+
+    def get_request_object
+      request_object = Net::HTTP::Get.new(uri.request_uri)
+      request_object.basic_auth(ICIMS.username, ICIMS.password)
+      request_object
+    end
+
+  end
+end

data/lib/icims/job.rb

@@ -0,0 +1,59 @@
+module ICIMS
+
+  require 'ostruct'
+
+  class Job < OpenStruct
+
+    DEFAULT_FIELDS = %w(id updateddate folder jobtitle positioncategory positiontype joblocation additionallocations overview)
+
+    class << self
+
+      def find job_id, fields: []
+        fields = DEFAULT_FIELDS unless fields.any?
+        if job_id.is_a?(Array)
+          fetch_records(job_id, fields)
+        else
+          fetch_single(job_id, fields)
+        end
+      end
+
+      def search filters, fields: []
+        fields = DEFAULT_FIELDS unless fields.any?
+        ids = fetch_ids(filters)
+        fetch_records(ids, fields)
+      end
+
+      def approved portal_ids: [], fields: []
+        portal_ids = ICIMS.portal_ids unless portal_ids.any?
+        portal_ids.map do |id|
+          search([
+            { name: "job.folder",   value: ['D31001'], operator: "=" },
+            { name: "job.postedto", value: [id],       operator: "=" }
+          ], fields: fields)
+        end.flatten
+      end
+
+      private
+
+      def fetch_ids filters
+        params = {filters: filters}
+        response = ICIMS::SearchRequest.perform(:jobs, params)
+        return [] unless response['searchResults'].present?
+        response['searchResults'].map{|job_hash| job_hash['id']}
+      end
+
+      def fetch_records ids, fields
+        ids.map{|id| fetch_single(id, fields)}
+      end
+
+      def fetch_single id, fields
+        url = "/jobs/#{id}"
+        url << "?fields=#{fields.join(',')}"
+        attributes = ICIMS::GetRequest.perform(url)
+        new(attributes)
+      end
+
+    end
+
+  end
+end

data/lib/icims/requestable.rb

@@ -0,0 +1,13 @@
+module ICIMS
+  module Requestable
+
+    BASE_URL = "https://api.icims.com/customers/"
+
+    private
+
+    def customer_url
+      BASE_URL + ICIMS.customer_id
+    end
+
+  end
+end

data/lib/icims/search_request.rb

@@ -0,0 +1,34 @@
+module ICIMS
+  class SearchRequest
+
+    include Requestable
+
+    def initialize endpoint, filters
+      @body = filters.to_json
+      @url = customer_url + "/search/#{endpoint}"
+    end
+
+    def call
+      ICIMS.logger.info "POST #{@url} #{@body}"
+      response = post_request
+      ICIMS.logger.info response
+      if response['errors'].present?
+        raise Net::HTTPBadResponse, response['errors']
+      end
+      response
+    end
+
+    class << self
+      def perform(endpoint, filters)
+        new(endpoint, filters).call
+      end
+    end
+
+    private
+
+    def post_request
+      HTTParty.post(@url, body: @body, verify: false, basic_auth: {username: ICIMS.username, password: ICIMS.password}, headers: {'Content-Type' => 'application/json'})
+    end
+
+  end
+end

data/lib/icims/version.rb

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: icims
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mathieu Gagné
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-26 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: Ruby library for API requests with iCIMS Applicant Tracking System
+email:
+- gagne.mathieu@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/icims.rb
+- lib/icims/get_request.rb
+- lib/icims/job.rb
+- lib/icims/requestable.rb
+- lib/icims/search_request.rb
+- lib/icims/version.rb
+homepage: https://github.com/mathieugagne/icims
+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.4.5
+signing_key: 
+specification_version: 4
+summary: iCIMS API Integration
+test_files: []