clinch-talent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b5486316763cbab65df5a15009613e813ba2952
+  data.tar.gz: d6943caad4eaa320c306eb644d9cfbb29ba17400
+SHA512:
+  metadata.gz: 003c861644586a07cad13ea769185eb0c7bd8d43178ce1378282e4de1ffc81434935d12075b2ad074d6bdfcff6e227aad363e98b8179fa12f72ba9fc21e10d92
+  data.tar.gz: 65aa448502cd2fd3d2caace83b4c9033e9a5ae58a9205216549a56055080d9371e753a7bd1c43b0915a02102771222dbe98bb1c176e13d5c9e320301fe28afbf

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.idea/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'rake'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    clinch-talent (0.1)
+      json_api_client (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    builder (3.2.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    hashdiff (0.2.3)
+    i18n (0.7.0)
+    json (1.8.3)
+    json_api_client (1.0.1)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      addressable (~> 2.2)
+      faraday (>= 0.8.0)
+      faraday_middleware (~> 0.9)
+    metaclass (0.0.4)
+    minitest (5.8.3)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multipart-post (2.0.0)
+    rake (10.4.2)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.22.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  clinch-talent!
+  mocha (~> 1.1)
+  rake
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,38 @@
+# clinch-talent-ruby
+A ruby client for the Clinch Talent API. Glues the json-api-client gem with HMAC signing and predefined models.
+
+[![Build Status](https://travis-ci.org/ClinchIO/clinch-ruby-client.svg)](https://travis-ci.org/ClinchIO/clinch-ruby-client)
+
+##Getting Started
+
+This Ruby client allows developers to connect to the Clinch Talent API to access their data. In order to use the client you must have a valid Clinch Talent account and valid API keys. The steps to obtain keys can be found in the [developer documentation](http://dev.clinch.io/docs/api_getting_started).
+
+##Using the Gem
+
+Install the gem:
+
+```
+
+gem install clinch-talent
+
+```
+
+Require the gem:
+
+```ruby
+
+require 'clinch-talent'
+
+```
+
+Use the gem to get candidate data:
+
+```ruby
+
+ClinchTalent::Base.config("YOUR-KEY", "YOUR-SECRET")
+ClinchTalent::Candidate.all # Get data for the collection of candidates
+ClinchTalent::Candidate.find('candidate-id') # Get data for an individual candidate using the candidate's ID
+
+```
+
+Run these tests with rake test

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.pattern = 'test/clinch_talent/*_test.rb'
+end

data/clinch-talent.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'clinch-talent'
+  s.version     = '0.1'
+  s.date        = '2015-12-11'
+  s.summary     = 'A ruby client for the Clinch Talent API'
+  s.description = 'A ruby client for the Clinch Talent API. Requests are HMAC signed. Responses are in JSON API format (https://jsonapi.org). See https://dev.clinch.io/v1.0/docs/api_getting_started'
+  s.authors     = ['Damien Glancy', 'Peter Keogh', 'Steve Quinlan']
+  s.email       = 'damien@clinch.io'
+  s.homepage    = 'http://rubygems.org/gems/clinch-talent'
+  s.license       = 'MIT'
+  s.add_dependency 'json_api_client', '~> 1.0'
+  s.add_development_dependency 'mocha', '~> 1.1'
+  s.add_development_dependency 'webmock'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/lib/clinch-talent.rb

@@ -0,0 +1 @@
+require 'clinch_talent'

data/lib/clinch_talent.rb

@@ -0,0 +1,7 @@
+require 'json_api_client'
+require 'faraday'
+
+require 'clinch_talent/hmac_signing_middleware'
+require 'clinch_talent/base'
+require 'clinch_talent/candidate'
+require 'clinch_talent/social_profile'

data/lib/clinch_talent/base.rb

@@ -0,0 +1,10 @@
+module ClinchTalent
+  class Base < ::JsonApiClient::Resource
+    def self.config(access_id, secret, options = {})
+      self.site = options[:site] || 'https://api.clinchtalent.com/v1/'
+      self.connection do |connection|
+        connection.use HmacSigningMiddleware, {access_id: access_id, secret: secret}
+      end
+    end
+  end
+end

data/lib/clinch_talent/candidate.rb

@@ -0,0 +1,5 @@
+module ClinchTalent
+  class Candidate < Base
+
+  end
+end

data/lib/clinch_talent/hmac_signing_middleware.rb

@@ -0,0 +1,93 @@
+module ClinchTalent
+  class HmacSigningMiddleware < Faraday::Middleware
+    def initialize(app, options, &block)
+      super(app)
+      @options = options
+      @block = block
+    end
+
+    def call(env)
+      env.request_headers['Content-MD5'] = calculated_md5(env)
+      env.request_headers['DATE'] = Time.now.utc.httpdate
+      env.request_headers['Authorization'] = "APIAuth #{@options[:access_id]}:#{hmac_signature(env, @options[:secret])}"
+      @app.call(env)
+    end
+private
+    def calculated_md5(env)
+      # if env.request.body
+      #   body = env.request.body
+      # else
+      #  body = ''
+      # end
+      #excluding the body as part of the md5'ing
+      md5_base64digest('')
+    end
+
+    def md5_base64digest(string)
+      if Digest::MD5.respond_to?(:base64digest)
+        Digest::MD5.base64digest(string)
+      else
+        b64_encode(Digest::MD5.digest(string))
+      end
+    end
+
+    def b64_encode(string)
+      if Base64.respond_to?(:strict_encode64)
+        Base64.strict_encode64(string)
+      else
+        # Fall back to stripping out newlines on Ruby 1.8.
+        Base64.encode64(string).gsub(/\n/, '')
+      end
+    end
+
+    def fetch_headers(env)
+      capitalize_keys env.request_headers
+    end
+
+    def capitalize_keys(hsh)
+      capitalized_hash = {}
+      hsh.each_pair {|k,v| capitalized_hash[k.to_s.upcase] = v }
+      capitalized_hash
+    end
+
+    def hmac_signature(env, secret_key)
+      canonical_string = canonical_string(env)
+      digest = OpenSSL::Digest.new('sha1')
+      b64_encode(OpenSSL::HMAC.digest(digest, secret_key, canonical_string))
+    end
+
+    def canonical_string(env)
+      [ content_type(env),
+        content_md5(env),
+        parse_uri(env.url.to_s),
+        timestamp(env)
+      ].join(',')
+    end
+
+    def timestamp(env)
+      value = find_header(env, %w(DATE HTTP_DATE))
+      value.nil? ? '' : value
+    end
+
+    def content_type(env)
+      value = find_header(env, %w(CONTENT-TYPE CONTENT_TYPE HTTP_CONTENT_TYPE))
+      value.nil? ? '' : value
+    end
+
+    def content_md5(env)
+      value = find_header(env, %w(CONTENT-MD5 CONTENT_MD5 HTTP-CONTENT-MD5 HTTP_CONTENT_MD5))
+      value.nil? ? '' : value
+    end
+
+    def find_header(env, keys)
+      keys.map {|key| env.request_headers[key] }.compact.first
+    end
+
+    def parse_uri(uri)
+      uri_without_host = uri.gsub(/https?:\/\/[^(,|\?|\/)]*/, '')
+      return '/' if uri_without_host.empty?
+      uri_without_host
+    end
+
+  end
+end

data/lib/clinch_talent/social_profile.rb

@@ -0,0 +1,5 @@
+module ClinchTalent
+  class SocialProfile < Base
+
+  end
+end

data/test/clinch_talent/candidate_test.rb

@@ -0,0 +1,22 @@
+require_relative '../test_helper'
+
+module ClinchTalent
+  class CandidateTest < Minitest::Test
+    def test_signing
+      Time.stubs(:now).returns(Time.new(2014, 01, 01, 01, 01, 01))
+
+      # Having problem stubbing the body response, so not doing this now
+
+      stub_request(:get, 'https://api.clinchtalent.com/v1/candidates?include=social_profile').
+        with(:headers => {'Accept' => 'application/vnd.api+json',
+                          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                          'Authorization' => 'APIAuth access_id:mCPWePkgbJo3G9JSDrtdtQrKGek=',
+                          'Content-Md5' => '1B2M2Y8AsgTpgAmY7PhCfg==',
+                          'Content-Type' => 'application/vnd.api+json',
+                          'Date' => 'Wed, 01 Jan 2014 01:01:01 GMT',
+                          'User-Agent' => 'Faraday v0.9.2'})
+      ClinchTalent::Base.config('access_id', 'secret')
+      ClinchTalent::Candidate.includes(:social_profile).all
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require_relative '../lib/clinch_talent'
+require 'faraday'
+require 'json_api_client'
+require 'mocha'
+require 'minitest/autorun'
+require 'mocha/mini_test'
+require 'json'
+require 'webmock/minitest'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: clinch-talent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Damien Glancy
+- Peter Keogh
+- Steve Quinlan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby client for the Clinch Talent API. Requests are HMAC signed. Responses
+  are in JSON API format (https://jsonapi.org). See https://dev.clinch.io/v1.0/docs/api_getting_started
+email: damien@clinch.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- clinch-talent.gemspec
+- lib/clinch-talent.rb
+- lib/clinch_talent.rb
+- lib/clinch_talent/base.rb
+- lib/clinch_talent/candidate.rb
+- lib/clinch_talent/hmac_signing_middleware.rb
+- lib/clinch_talent/social_profile.rb
+- test/clinch_talent/candidate_test.rb
+- test/test_helper.rb
+homepage: http://rubygems.org/gems/clinch-talent
+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.1
+signing_key: 
+specification_version: 4
+summary: A ruby client for the Clinch Talent API
+test_files:
+- test/clinch_talent/candidate_test.rb
+- test/test_helper.rb