psychometric 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ab5ab210acd9d806c972dc385a4b1ff2f322468
+  data.tar.gz: 4337cc2c2e865b321080233f2f5d557647dbbaa3
+SHA512:
+  metadata.gz: 8dee1dc17cc3746c5d624f38b64ac117cd615a3d7634df14971b9c9d29575aaf341c1a05b657b78ad3a25884e6497e3ec68208b9de9b3daa1e35a34082b8c108
+  data.tar.gz: 9abc82d90902dbe3bf6aee9f44a46660885e9fce0d39d5109fcded87c3e472801696cc5f4778265a3cc9b148a3a6ec3d40038e66b3050fd53700f1d853cd2b8b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/vendor/bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/runner
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.1.0
+#### 20 February 2019
+
+- Initial commit

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at michael.prins@me.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    psychometric (0.1.0)
+      httparty (~> 0.16.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  psychometric!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Michael Prins
+
+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,70 @@
+# Psychometric
+
+This gem attempts to create a simple uniform structure for results of
+psychometric assessments from various providers. It also implements methods to
+request those results from the providers' APIs.
+
+Persisting the results is left to the consumer.
+
+It has been extracted from the [Leaply](https://leap.ly) recruitment platform.
+
+### Currently Supported Providers
+
+* [Top Talent Solutions](https://www.tts-talent.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'psychometric'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install psychometric
+
+## Usage
+
+* Require the gem and the provider(s) you need.
+* Provide your authentication and assessment requirements.
+* Request the results.
+
+```ruby
+# All providers are not required by default
+require "psychometric"
+require "psychometric/providers/top_talent_solutions"
+
+# Create an instance of the Provider
+provider = Psychometric::Providers::TopTalentSolutions.new username: 'psycho@metric.com', password: 'insecure'
+# Authenticate the instance (most will need this step)
+provider.authenticate!
+# Indicate which Assessment (params needed specific to provider)
+assessment = Psychometric::Providers::TopTalentSolutions.assessment project_id: 1234, model_id: 5678
+# Fetch the results
+results = provider.results assessment
+
+results #=> [#<Psychometric::Result subject: "#<Psychometric::Subject name: "John Doe" identity: "8801235111088">" values: {"Numbers"=>"5", "Letters"=>"7", "Shapes"=>"3"}>]
+```
+
+## 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/Leaply/psychometric. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Psychometric project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Leaply/psychometric/blob/master/CODE_OF_CONDUCT.md).

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 "psychometric"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/psychometric.rb

@@ -0,0 +1,10 @@
+require 'psychometric/version'
+
+require 'psychometric/assessment'
+require 'psychometric/provider'
+require 'psychometric/result'
+require 'psychometric/subject'
+
+module Psychometric
+  class Error < StandardError; end
+end

data/lib/psychometric/assessment.rb

@@ -0,0 +1,27 @@
+module Psychometric
+  # # Assessment
+  #
+  # This represents the various assessments a Subject can undertake with a
+  # Provider. Since different providers have different ways of identifying and
+  # organizing their assessments, we give them a dynamic identity.
+  class Assessment
+    class IdentityError < StandardError
+      def message
+        'Incorrect or missing identity, check the Provider configuration'
+      end
+    end
+    class ProviderError < StandardError
+      def message
+        'Assessment needs a subclass of Provider as the first argument for identity checking'
+      end
+    end
+
+    attr_reader :identity
+
+    def initialize(provider, identity = {})
+      raise IdentityError if identity.empty?
+      raise ProviderError unless provider.ancestors.include? Psychometric::Provider
+      @identity = identity
+    end
+  end
+end

data/lib/psychometric/provider.rb

@@ -0,0 +1,33 @@
+require 'psychometric/assessment'
+
+module Psychometric
+  # # Provider
+  #
+  # This is the standardized API that individual provider implementations
+  # must conform to. It abstracts the constructs from the provider into those
+  # used by Psychometric.
+  class Provider
+    class AuthenticationError < StandardError; end
+    # raise NotImplementedError, 'Subclasses must define `resolved?`.'
+
+    def initialize(authentication)
+      raise AuthenticationError unless authentication.keys.to_set == @@authentication_keys.to_set
+      @authentication = authentication
+    end
+
+    def self.assessment(identity)
+      raise Assessment::IdentityError unless identity.keys.to_set == @@assessment_identifiers.to_set
+      Assessment.new self, identity
+    end
+
+    protected
+
+    def self.authenticate_with(*args)
+      @@authentication_keys = args
+    end
+
+    def self.assessments_identified_with(*args)
+      @@assessment_identifiers = args
+    end
+  end
+end

data/lib/psychometric/providers/top_talent_solutions.rb

@@ -0,0 +1,100 @@
+require 'httparty'
+require 'psychometric/provider'
+
+module Psychometric
+  module Providers
+    class TopTalentSolutions < Psychometric::Provider
+      # Configuration
+      authenticate_with :username, :password
+      assessments_identified_with :project_id, :model_id
+
+      # API Implementation
+      include HTTParty
+      base_uri 'https://www.tts-assess.com/api'
+      # base_uri(ENV['RACK_ENV'] == 'production' ? 'https://www.tts-assess.com/api' : 'https://www.tts-assessments.com/api')
+
+      def authenticate!
+        response = self.class.post '/generateToken', headers: { 'Accept' => 'application/json' }, body: { 'username' => @authentication[:username], 'password' => @authentication[:password] }.to_json
+
+        # Response Code - 401 {"result": "error", "errors": "Bad credentials exception!"}
+        raise response['errors'].to_json if response['result'] == 'error'
+
+        # Response Code - 200 { "result": "success", "token": "YknYEjMRjVMaIGUTJQ8cWO9xAXSyK0awlQzGpk6_nzhM0n140dUMn-Ja- S9BYKbWc5HIj8LA" }
+        @token = response['token'] if response.code == 200 && response['result'] == 'success'
+      end
+
+      def authenticated?
+        !@token.nil? && !@token.empty?
+      end
+
+      # Returns assessments linked to this account once authenticated
+      #
+      # NOTE: This is not currently possible with the TTS API
+      def assessments
+        raise Psychometric::Provider::AuthenticationError.new('You need to authenticate first') unless authenticated?
+        raise NotImplementedError # API does not expose Model IDs
+
+        response = self.class.get '/getProjectList/en_ZA', headers: { 'Authorization' => "Bearer #{@token}", 'Accept' => 'application/json' }
+
+        # Response Code - 401 {'result': "error", 'errors': {"Not enough permission for this request."}}
+        raise response['errors'].to_json if response['result'] == 'error'
+
+        # Response Code - 200 { 'result': "success", 'data': [{ 'id': 5, 'internalName': "Internal Project Name 1", 'completedCandidate': 10, 'status': "In Progress", 'costcode': "free" }]
+        if response.code == 200 && response['result'] == 'success'
+          response['data'].map do |hash|
+            # hash
+          end
+        else
+          raise 'Unknown error'
+        end
+      end
+
+      # Given an Assessment returns the Results recorded for that Assessment
+      def results(assessment)
+        raise Psychometric::Provider::AuthenticationError.new('You need to authenticate first') unless authenticated?
+
+        response = self.class.post '/getDataExtract', headers: { 'Authorization' => "Bearer #{@token}", 'Accept' => 'application/json' }, body: {
+          'projectId' => assessment.identity[:project_id],
+          'modelId' => assessment.identity[:model_id],
+          'locale' => 'en_ZA',
+        }.to_json
+
+        # Response Code - 400 { 'result': 'error', 'errors': ['No instrument norm combination found']}
+        raise response['errors'].to_json if response['result'] == 'error'
+
+        # Response Code - 200 { 'result': 'success', 'data': [{ 'participantId': 12, 'name': "john", 'surname': "doe", 'testCompleted': "05 July 2016 14:25:00", 'variable1': 2, 'variable2': 4, 'variable3': 5 }, ...] }
+        if response['result'] == 'success'
+          response['data'].map do |item|
+            Psychometric::Result.new.tap do |result|
+              result.subject = Psychometric::Subject.new(
+                country: 'ZA',
+                identity: item['participantId'],
+                email: item['email'],
+                name: "#{item['name']} #{item['surname']}",
+                gender: item['Gender|gender|Raw|Raw score'],
+                title: item['Title|title|Raw|Raw score'],
+              )
+
+              values = item.reject do |key, _v|
+                [
+                  'participantGUID',
+                  'participantId',
+                  'email',
+                  'name',
+                  'surname',
+                  'Gender|gender|Raw|Raw score',
+                  'Title|title|Raw|Raw score',
+                  'OverAll',
+                ].include? key
+              end
+
+              result.values = Hash[values.map { |k, v| [k.split('|').first, v] }]
+            end
+          end
+        else
+          raise 'Unknown error'
+        end
+      end
+    end
+  end
+end

data/lib/psychometric/result.rb

@@ -0,0 +1,17 @@
+module Psychometric
+  # # Result
+  #
+  # A Result respresents a Subject undergoing an Assessment by a Provider and
+  # will typically contain one or more Values.
+  class Result
+    attr_accessor :values, :subject, :assessment
+
+    def initialize(values = {})
+      @values = values
+    end
+
+    def to_s
+      "\#<Psychometric::Result subject: \"#{@subject}\" values: #{@values}>"
+    end
+  end
+end

data/lib/psychometric/subject.rb

@@ -0,0 +1,23 @@
+module Psychometric
+  # # Subject
+  #
+  # This represents someone who undergoes the psychometric assessment. Since
+  # different providers identify subjects differently this class can be used
+  # to map subjects to your users.
+  class Subject
+    attr_accessor :country, :identity, :email, :name, :gender, :title
+
+    def initialize(args)
+      @country = args[:country]
+      @identity = args[:identity]
+      @email = args[:email]
+      @name = args[:name]
+      @gender = args[:gender]
+      @title = args[:title]
+    end
+
+    def to_s
+      "\#<Psychometric::Subject name: \"#{@name}\" identity: \"#{@identity}\">"
+    end
+  end
+end

data/lib/psychometric/version.rb

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

data/psychometric.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "psychometric/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "psychometric"
+  spec.version       = Psychometric::VERSION
+  spec.authors       = ["Michael Prins"]
+  spec.email         = ["michael.prins@me.com"]
+
+  spec.summary       = %q{Uniform psychometric assessment results}
+  spec.description   = %q{A tool to abstract API access to psychometric providers and return uniform results for use in candidate reviews.}
+  spec.homepage      = "https://github.com/Leaply/psychometric"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "http://mygemserver.com"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Leaply/psychometric"
+    spec.metadata["changelog_uri"] = "https://github.com/Leaply/psychometric/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.16.4"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: psychometric
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Prins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A tool to abstract API access to psychometric providers and return uniform
+  results for use in candidate reviews.
+email:
+- michael.prins@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/psychometric.rb
+- lib/psychometric/assessment.rb
+- lib/psychometric/provider.rb
+- lib/psychometric/providers/top_talent_solutions.rb
+- lib/psychometric/result.rb
+- lib/psychometric/subject.rb
+- lib/psychometric/version.rb
+- psychometric.gemspec
+homepage: https://github.com/Leaply/psychometric
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Leaply/psychometric
+  source_code_uri: https://github.com/Leaply/psychometric
+  changelog_uri: https://github.com/Leaply/psychometric/blob/master/CHANGELOG.md
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Uniform psychometric assessment results
+test_files: []