peoplehr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d043bf00a8109b47e0b671655cc900e9aad877c
+  data.tar.gz: 67300a4f44692dfaf471b694097ad7af62695459
+SHA512:
+  metadata.gz: 009ff7796532e3f85df70fc7cfefa938f0c3b6ac61be5c9bd079c504846188e4fb13216162a9192f24831a7bfd5c265173f2922657c1b7220c15a4ddaccd0a7a
+  data.tar.gz: 93ade2de5056d07615f7b443881704c105bf4b8c6813534197107647f3dc6b45f63000519dbc3f35f87145b2df8770ec3524d9fccb53a73772e974c1ef30f424

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+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 peoplehr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rob Miller
+
+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,68 @@
+# peoplehr
+
+[PeopleHR](http://www.peoplehr.com/) is an online system for managing
+your organisation’s HR issues.
+
+It offers an API for manipulating that information — either to pull
+information out of it, or to modify what’s there. This can be useful for
+things like creating telephone directories, pulling employees’ birthday
+dates into a calendar, and lots of other things besides.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'peoplehr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install peoplehr
+
+## Usage
+
+At the moment, the library can be used only to fetch employee data.
+
+The `Employees` class functions as a repository, with finder methods to
+restrict the data returned. Use `Employees.all` to get data for all
+employees:
+
+	api = API.new(api_key: "abc123abc123")
+	employees = Employees.new(api)
+
+	employees.all
+
+This returns an array of `Employee` objects, each of which contains the
+information stored in PeopleHR for that particular employee.
+
+## 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/[USERNAME]/peoplehr. 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 "peoplehr"
+
+# 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/lib/peoplehr.rb

@@ -0,0 +1,10 @@
+require "peoplehr/version"
+
+require "addressable/uri"
+require "faraday"
+require "transproc"
+require "virtus"
+
+require "peoplehr/api"
+require "peoplehr/employee"
+require "peoplehr/employees"

data/lib/peoplehr/api.rb

@@ -0,0 +1,49 @@
+require "json"
+
+module PeopleHR
+  class API
+    API_ROOT = Addressable::URI.parse("https://api.peoplehr.net/")
+
+    class APIError < StandardError; end
+    class BadResponse < APIError; end
+
+    def initialize(api_key:, connection: nil)
+      @api_key = api_key
+      @connection = connection ||
+        Faraday.new(url: API_ROOT) do |faraday|
+          faraday.request :url_encoded
+          faraday.adapter Faraday.default_adapter
+        end
+    end
+
+    def request(action, params = {})
+      request = {
+        "APIKey" => api_key,
+        "Action" => action,
+      }
+
+      payload = params.merge(request)
+      payload = JSON.generate(payload)
+
+      response = connection.post do |req|
+        req.url "/"
+        req.headers["Content-Type"] = "application/json"
+        req.body = payload
+      end
+
+      response = JSON.parse(response.body)
+
+      if !response || response["isError"]
+        fail APIError
+      end
+
+      response
+    rescue JSON::ParserError
+      fail BadResponse
+    end
+
+    private
+
+    attr_reader :connection, :api_key
+  end
+end

data/lib/peoplehr/employee.rb

@@ -0,0 +1,23 @@
+module PeopleHR
+  class Employee
+    include Virtus.value_object
+
+    values do
+      attribute :id,            String
+      attribute :title,         String
+      attribute :first_name,    String
+      attribute :last_name,     String
+      attribute :email,         String
+      attribute :start_date,    Date
+      attribute :date_of_birth, Date
+      attribute :job_role,      String
+      attribute :company,       String
+      attribute :location,      String
+      attribute :department,    String
+    end
+
+    def full_name
+      "#{first_name} #{last_name}"
+    end
+  end
+end

data/lib/peoplehr/employees.rb

@@ -0,0 +1,86 @@
+module PeopleHR
+  class Employees
+    def initialize(api:)
+      @api = api
+    end
+
+    def all
+      transformation =
+        t(:extract_result) >>
+        t(
+          :map_array,
+          t(
+            :map_values,
+            t(:extract_display_value)
+          )
+        ) >>
+        t(
+          :map_array,
+          t(
+            :accept_keys,
+            [
+              "EmployeeId",
+              "FirstName",
+              "LastName",
+              "Title",
+              "EmailId",
+              "StartDate",
+              "DateOfBirth",
+              "JobRole",
+              "Company",
+              "Location",
+              "Department",
+            ]
+          ) >>
+          t(
+            :map_keys,
+            -> k {
+              k.gsub(/::/, '/')
+                .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+                .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+                .tr("-", "_")
+                .downcase
+            }
+          ) >>
+          t(:symbolize_keys) >>
+          t(:rename_keys, { employee_id: :id }) >>
+          t(:convert_to_employee)
+        )
+
+      transformation.call(api_data)
+    end
+
+    private
+
+    attr_reader :api
+
+    def api_data
+      api.request("GetAllEmployeeDetail", "IncludeLeavers" => false)
+    end
+
+    def t(*args)
+      Transformations[*args]
+    end
+
+    module Transformations
+      extend Transproc::Registry
+
+      import Transproc::HashTransformations
+      import Transproc::ArrayTransformations
+
+      def self.extract_result(hash)
+        hash["Result"]
+      end
+
+      def self.extract_display_value(hash)
+        if hash.is_a?(Hash)
+          hash["DisplayValue"]
+        end
+      end
+
+      def self.convert_to_employee(hash)
+        Employee.new(hash)
+      end
+    end
+  end
+end

data/lib/peoplehr/version.rb

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

data/peoplehr.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'peoplehr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "peoplehr"
+  spec.version       = PeopleHR::VERSION
+  spec.authors       = ["Rob Miller"]
+  spec.email         = ["rob@bigfish.co.uk"]
+
+  spec.summary       = %q{A library for interacting with the PeopleHR API}
+  spec.description   = %q{A library for interacting with the PeopleHR API to export and manipulate employee and other information.}
+  spec.homepage      = "https://github.com/robmiller/peoplehr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "addressable", "~> 2.3"
+  spec.add_runtime_dependency "faraday", "~> 0.9.1"
+  spec.add_runtime_dependency "transproc", "~> 0.3.0"
+  spec.add_runtime_dependency "virtus", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: peoplehr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Miller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: transproc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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: 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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library for interacting with the PeopleHR API to export and manipulate
+  employee and other information.
+email:
+- rob@bigfish.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/peoplehr.rb
+- lib/peoplehr/api.rb
+- lib/peoplehr/employee.rb
+- lib/peoplehr/employees.rb
+- lib/peoplehr/version.rb
+- peoplehr.gemspec
+homepage: https://github.com/robmiller/peoplehr
+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.8
+signing_key: 
+specification_version: 4
+summary: A library for interacting with the PeopleHR API
+test_files: []