latticehris 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b169eb6fdae407e489088bcce6d77bedc91efec8b80db2cb9c71a5bedf6f93be
+  data.tar.gz: 6f6bf967eca451146a758dd8c5237ad3a2d921b86adbd1f82179875f2b9b15cc
+SHA512:
+  metadata.gz: f7f5e011da590fa7b3d60fd8e3ac002da52751cedf0e485fd9ce88fb62306c5031a20fa117b31b7a9b636b5c7ba9cdc6ff10487240a768e6612d26d5581340b7
+  data.tar.gz: 85ed5d15cc3e26ca7dfb0250840448117b693eb4022cc1cd0cd3ce82f68f54ba21a3be6cca2340a73dfdc42891eb4dbd600af7d67e4570e4f5fed42cd10ca4a8

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [0.1.2] - 2025-05-06
+- Rename gem name from `lattice` to `lattice-hris`
+
+## [0.1.1] - 2025-05-06
+
+- Endpoints for reading the employees: `Lattice::Employees.all` and `Lattice::Employees.find(employee_id)`
+
+## [0.1.0] - 2025-05-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Lien Van Den Steen
+
+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,58 @@
+# Lattice
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add latticehris
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install latticehris
+```
+
+## Usage
+
+First you will have to confige the gem. You need to work with Lattice to receive a `client_id` and `client_secret` to access the API. Once you've retrieved that, you are ready:
+
+```ruby
+Lattice.configure do |config|
+  config.client_id = 'your-client-id'
+  config.client_secret = 'your-client-secret'
+  config.scope = 'the scopes you enabled for this' 
+end
+```
+
+Note: the `scope` needs to be a string with the different scopes separate by a space. So for example:
+
+```ruby
+config.scope = 'employees:personal.read employees:personal.write'
+```
+
+Then once you have the client setup, you can call the API. Some examples:
+
+```ruby
+Lattice::Employees.all
+Lattice::Employees.find(employee_id)
+```
+
+## 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 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/[USERNAME]/lattice. 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/[USERNAME]/lattice/blob/main/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 Lattice project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lattice/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/lattice/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "rest-client"
+require "json"
+
+module Lattice
+  class Client
+    TOKEN_URL = "https://api-auth.latticehq.com/oauth2/token"
+    BASE_URL = "https://api.latticehq.com/v2"
+
+    def self.get(path, params = {})
+      url = build_url(path, params)
+      response = RestClient.get(url, headers)
+      JSON.parse(response.body)
+    end
+
+    def self.build_url(path, params)
+      url = "#{BASE_URL}#{path}"
+      url += "?#{URI.encode_www_form(params)}" unless params.empty?
+      url
+    end
+
+    def self.headers
+      {
+        Accept: "application/json",
+        Authorization: "Bearer #{access_token}"
+      }
+    end
+
+    def self.access_token
+      params = {
+        grant_type: "client_credentials",
+        client_id: Lattice.client_id,
+        client_secret: Lattice.client_secret,
+        scope: Lattice.scope
+      }
+      response = RestClient.post(TOKEN_URL, params, { content_type: :x_www_form_urlencoded })
+      JSON.parse(response.body)["access_token"]
+    end
+  end
+end

data/lib/lattice/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Lattice
+  module Configuration
+    VALID_OPTIONS_KEYS = %i[client_id client_secret scope].freeze
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def config
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Resets all configuration options to the defaults.
+    def reset
+      self.client_id = nil
+      self.client_secret = nil
+      self.scope = nil
+    end
+  end
+end

data/lib/lattice/employees.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This module defines the `Lattice::Employees` class, which provides methods
+# to interact with the employee endpoints in the Lattice API.
+module Lattice
+  class Employees < Client
+    # Retrieves a list of all employees from Lattice.
+    #
+    # @return [Array<Hash>] An array of employee data hashes.
+    # @example
+    #   employees = Lattice::Employees.all``
+    #   puts employees.first["name"]
+    def self.all
+      get("/employees")["data"]
+    end
+
+    # Retrieves a specific employee's details from Lattice by their ID.
+    #
+    # @param id [String, Integer] The unique identifier of the employee.
+    # @return [Hash] A hash containing the employee's data.
+    # @example
+    #   employee = Lattice::Employees.find(123)
+    #   puts employee["personal"]
+    def self.find(id)
+      get("/employees/#{id}")["data"]
+    end
+  end
+end

data/lib/lattice/version.rb

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

data/lib/lattice.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "lattice/version"
+require_relative "lattice/configuration"
+require_relative "lattice/client"
+require_relative "lattice/employees"
+
+module Lattice
+  extend Configuration
+
+  class Error < StandardError; end
+end

data/lib/latticehris.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "lattice"

data/sig/lattice.rbs

@@ -0,0 +1,4 @@
+module Lattice
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: latticehris
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Lien Van Den Steen
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+email:
+- lien@monarchmoney.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lattice.rb
+- lib/lattice/client.rb
+- lib/lattice/configuration.rb
+- lib/lattice/employees.rb
+- lib/lattice/version.rb
+- lib/latticehris.rb
+- sig/lattice.rbs
+homepage: https://github.com/monarchmoney/lattice
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/monarchmoney/lattice
+  source_code_uri: https://github.com/monarchmoney/lattice
+  changelog_uri: https://github.com/monarchmoney/lattice/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Wrapper for the Lattice API
+test_files: []