keypay_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae27176b2300faa27427e573494b72a188ad3864f3edd54cdcceff911f0e9f88
+  data.tar.gz: 3f4469b387e83f476e855af79643d4e7d1b24a45b2a88a934ecf86286bc15fa4
+SHA512:
+  metadata.gz: c6088c51555b83f76ec05eaa1ca1720b6f1a88aed33550fa926587189a5347f4c02f019be792646ecdde655ae43697cb62501f2888fb0bebedde6ef579e94307
+  data.tar.gz: 104ff9e1bcf3f1b25eba027de365aaec9c52dc90713fb056c4102c3d54352684c16e77434ee25ae9be118d609047f566cb6f1ba59ea5187dce3e6dca83549654

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at matt@didcoe.id.au. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in keypay_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    keypay_api (0.1.0)
+      activesupport
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.1)
+    concurrent-ruby (1.1.8)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    minitest (5.14.4)
+    multi_xml (0.6.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rubocop (1.8.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  keypay_api!
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Matt Didcoe
+
+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 @@
+# KeyPay API
+
+This is a Ruby gem client for accessing the [KeyPay](https://www.keypay.com.au) API, specifically developed for use in the Australian version of the API.
+
+Documentation for the KeyPay API can be found at https://api.keypay.com.au/australia/reference
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keypay_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install keypay_api
+
+## Usage
+
+First, initialise a client using your API key
+
+```ruby
+client = KeyPayAPI::Client.new("KEYPAY_API_TOKEN")
+```
+
+or, you can set an environment variable `ENV['KEYPAY_API_TOKEN']`, in whih case initialise as follows
+
+```ruby
+client = KeyPayAPI::Client.new
+```
+
+Then call the relevant method
+
+```ruby
+client.list_businesses
+```
+
+### List of available methods
+```ruby
+client.list_businesses
+client.list_employees
+client.show_employee(businessId, employeeId)
+client.create_employee(businessId, options)
+client.onboard_employee(businessId, options)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/mattman/keypay_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mattman/keypay_api/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 KeypayApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mattman/keypay_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "keypay_api"
+
+# 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/keypay_api.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/keypay_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "keypay_api"
+  spec.version       = KeyPayAPI::VERSION
+  spec.authors       = ["Matt Didcoe"]
+  spec.email         = ["matt@mattdidcoe.com"]
+
+  spec.summary       = "Client for the KeyPay (YourPayroll) API"
+  spec.homepage      = "https://github.com/mattman/keypay_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mattman/keypay_api"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "httparty"
+  spec.add_dependency "activesupport"
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency "bundler"
+end

data/lib/keypay_api.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash'
+require 'httparty'
+
+require_relative "keypay_api/version"
+require_relative "keypay_api/resource"
+require_relative "keypay_api/resource_collection"
+require_relative "keypay_api/client"
+
+# Access to the Australian KeyPay API
+# @version 2.0
+module KeyPayAPI
+  class Error < StandardError; end
+end

data/lib/keypay_api/client.rb

@@ -0,0 +1,24 @@
+require_relative 'client/connection'
+require 'base64'
+
+require_relative 'client/business'
+require_relative 'client/employee'
+
+module KeyPayAPI
+  class Client
+    include HTTParty
+    include KeyPayAPI::Client::Connection
+    include KeyPayAPI::Client::Employee
+    include KeyPayAPI::Client::Business
+    
+    base_uri 'https://api.yourpayroll.com.au/api/v2'
+    format :json
+
+    def initialize(api_key = nil)
+      api_key ||= ENV["KEYPAY_API_KEY"]
+      raise KeyPayAPI::Error('Must pass an API key') if api_key.nil?
+      enc_key = Base64.encode64(api_key + ':').gsub(/\n/,'')
+      self.class.default_options.merge!(headers: {'Authorization': "Basic #{enc_key}", 'Content-Type': 'application/json'})
+    end
+  end
+end

data/lib/keypay_api/client/business.rb

@@ -0,0 +1,12 @@
+module KeyPayAPI
+  class Client
+    module Business
+      # List businesses attached to current KeyPay account
+      #
+      # @return [ResourceCollection, Resource] either single resource object if one business, else collection
+      def list_businesses
+        get("/business")
+      end
+    end
+  end
+end

data/lib/keypay_api/client/connection.rb

@@ -0,0 +1,45 @@
+module KeyPayAPI
+  class Client
+    module Connection
+
+      def get(path, options = {})
+        request :get, path, options
+      end
+
+      def post(path, options = {})
+        request :post, path, options
+      end
+
+      def put(path, options = {})
+        request :put, path, options
+      end
+
+      def delete(path, options = {})
+        request :delete, path, options
+      end
+
+      private
+
+      def request(http_method, path, options)
+        response = self.class.send(http_method, path, { body: options })
+        raise KeyPayAPI::Error.new response.message if !response.success?
+        data = response.parsed_response
+        parse_data(data)
+      end
+
+      def parse_data(original_data)
+        return unless original_data
+
+        data = original_data.length == 1 ? original_data.first : original_data  
+
+        case data
+        when Hash  then Resource.new(self, data)
+        when Array then ResourceCollection.new(self, data)
+        when nil   then nil
+        else data
+        end
+      end
+
+    end
+  end
+end

data/lib/keypay_api/client/employee.rb

@@ -0,0 +1,62 @@
+module KeyPayAPI
+  class Client
+    module Employee
+      # List employees attached to business
+      #
+      # @param businessId [String] the KeyPay business ID
+      # @return [ResourceCollection] list of employees
+      def list_employees(businessId)
+        get("/business/#{businessId}/employee/unstructured")
+      end
+      
+      # Get a specific employee using their KeyPay employee ID
+      #
+      # @param businessId [String] the KeyPay business ID employee is working for
+      # @param employeeId [String] the KeyPay employee ID you want to return
+      # @return [Resource] a Resource object with the employee data
+      def get_employee(businessId, employeeId)
+        get("/business/#{businessId}/employee/unstructured/#{employeeId}")
+      end
+      
+      # Get a specific employee using their external ID
+      #
+      # @param businessId [String] the KeyPay business ID employee is working for
+      # @param externalId [String] the external ID of the employee you want to return
+      # @return [Resource] a Resource object with the employee data
+      def get_employee_external_id(businessId, externalId)
+        get("/business/#{businessId}/employee/unstructured/externalid/#{externalId}")
+      end      
+
+      # Create a new employee in KeyPay
+      #
+      # @param businessId [String] the business you want to employ them under's KeyPay id
+      # @param options [Hash] a hash of all relevant fields to create the employee (as per the KeyPay API docs), minimum list below to create an "Incomplete" employee
+      # @option options [String] :taxFileNumber An Australian Tax File Number, can be '000000000' if you don't have it
+      # @option options [String] :firstName The employee's first name
+      # @option options [String] :surname The employee's surname / family name
+      # @option options [String] :startDate Start date for the employment
+      # @option options [String] :employmentType The employee's employment type, e.g. 'Casual'
+      def create_employee(businessId,  options)
+        post("/business/#{businessId}/employee/unstructured", options.to_json)
+      end
+
+      # Onboard an employee using the Onboard self service tool
+      #
+      # @param base Keypay::Base
+      # @param businessId [String] the KeyPay business ID to employ under
+      # @param options [Hash] Attributes to use for onboarding, must be in key/value pairs per KeyPay API Docs
+      # @option options [String] :email The email address the employee has on file (or will update record if id supplied)
+      # @option options [Boolean] :emergencyContactDetailsRequired
+      # @option options [String] :firstName The employee's first name
+      # @option options [String] :id The employee's existing KeyPay employeeId if already in system and just wanting to trigger onboard, otherwise ''
+      # @option options [String] :mobile The employee's mobile phone number
+      # @option options [Boolean] :qualificationsRequired
+      # @option options [String] :surname The employee's surname / family name
+      #
+      # @return [nil] the API currently returns nothing if the employee is onboarded successfully
+      def onboard_employee(businessId, options)
+        post("/business/#{businessId}/employeeonboarding/initiateselfservice", options.to_json)
+      end
+    end
+  end
+end

data/lib/keypay_api/resource.rb

@@ -0,0 +1,25 @@
+module KeyPayAPI
+  class Resource
+    attr_reader :data
+
+    def initialize(client, data)
+      data = {} unless data.is_a?(Hash)
+
+      @client = client
+
+      data = data.with_indifferent_access
+
+      @data   = OpenStruct.new(data.with_indifferent_access)
+
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if @data.respond_to?(method_sym)
+        @data.send(method_sym)
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/keypay_api/resource_collection.rb

@@ -0,0 +1,27 @@
+module KeyPayAPI
+  class ResourceCollection < Resource
+    include Enumerable
+
+    attr_reader :options
+
+    def initialize(client, data, options = {})
+      @client = client
+
+      collection = Array(data).map do |item|
+        Resource.new(client, item)
+      end
+
+      @data = OpenStruct.new(collection: collection)
+      @options = options.with_indifferent_access
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      collection.each { |item| yield item }
+
+      return self
+    end
+
+  end
+end

data/lib/keypay_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KeyPayAPI
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: keypay_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Didcoe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 
+email:
+- matt@mattdidcoe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keypay_api.gemspec
+- lib/keypay_api.rb
+- lib/keypay_api/client.rb
+- lib/keypay_api/client/business.rb
+- lib/keypay_api/client/connection.rb
+- lib/keypay_api/client/employee.rb
+- lib/keypay_api/resource.rb
+- lib/keypay_api/resource_collection.rb
+- lib/keypay_api/version.rb
+homepage: https://github.com/mattman/keypay_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mattman/keypay_api
+  source_code_uri: https://github.com/mattman/keypay_api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.5
+signing_key: 
+specification_version: 4
+summary: Client for the KeyPay (YourPayroll) API
+test_files: []