tazworks-api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7eb79fefb6c50c423aecdd1ab8fc00cf083525219d9fa3b5550e89a3b07c0c3
+  data.tar.gz: 142b6edf03ffa9ecb70076c7b947cd67add521d030da49d600fff3eee2a3c694
+SHA512:
+  metadata.gz: 612315964a2bbb3c44f5cc4ac75f594082488f1b28f8906fd07d832b139bcdaa96fde6bce548af0f5cc06dad07b772711c7c4afdd77a86af3a483eefb4875b57
+  data.tar.gz: b91feab1e5e90e188abdf3a4fa6b2c82aeac1ba1e9c9a3a4e4ea15bce0c46d98e8479e6a550cfe39dedebc4f0e0ac83dc741d44fb461c42c8b20de344e38f45d

data/.rubocop.yml

@@ -0,0 +1,228 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Naming/VariableName:
+  Enabled: false
+Naming/MethodParameterName:
+  Enabled: false
+Naming/MethodName:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+RSpec/InstanceVariable:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/BeforeAfterAll:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+
+
+
+
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantCurrentDirectoryInPath: # new in 1.53
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/SingleLineDoEndBlock: # new in 1.57
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true
+

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-18
+
+- Initial release

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 TODO: Write your email address. 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,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tazworks-api.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'simplecov'
+gem 'vcr'
+gem 'webmock'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Wayhome Services Co
+
+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,108 @@
+# Tazworks::Api
+
+Simple API wrapper implementation for Tazworks RESTful JSON Background/Credit Screening API version 2 found [here](https://docs.developer.tazworks.com/).
+
+This gem implements a very limited set of endpoints that we needed for our use case. PRs welcome for expanding the number of implemented endpoints!
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add tazworks-api
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install tazworks-api
+
+## Usage
+
+
+### Configuration
+
+Load the tazworks gem and set the configuration:
+
+```
+require 'tazworks'
+
+Tazworks.configure do |c|
+  c.api_key = 'your_api_key'
+
+  # set this to true if you want to use the sandbox host, otherwise, defaults to production
+  #c.sandbox = true 
+end
+```
+
+### Calls
+
+Tazworks utilize pascalCase. As this is only a lightweight wrapper, all parameters must be passed as pascalCasing instead of ruby idiomatic snake_casing.
+
+
+General Workflow:
+```ruby
+# querying client
+@clientGuid = 'MY_CLIENT_GUID'
+client=Tazworks::Client.find(@clientGuid)
+# OR
+client=Tazworks::Client.all.clients.first
+
+# view the client attributes
+client.attributes
+
+# querying the client products
+client_product = client.client_products.client_products.first
+
+# view the client_product attributes
+client_product.attributes
+
+# creating a new applicant
+applicant = client.create_applicant( { firstName: 'Bob', lastName: 'Smith', email: 'bob.smith@gmail.com' } )
+
+# view the applicant attributes
+applicant.attributes
+
+# submitting order
+order = client.submit_order({applicantGuid: applicant.applicantGuid, clientProductGuid: client_product.clientProductGuid, useQuickApp: true})
+
+# view the order attributes
+order.attributes
+
+# get the quickappApplicantLink
+order.quickappApplicantLink
+
+# checking order status
+order.order_status
+
+# getting pdf results for order (will only work after order goes to 'complete' status)
+order.results_as_pdf
+```
+
+Until rubydocs are written, the best bet is to look at the source for usage information, especially the specs folder where most of the implemented endpoints have been tested.
+
+
+## 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).
+
+To regenerate or record new [vcr](https://benoittgt.github.io/vcr/) cassettes, set the `TAZAPI_KEY` environment variable:
+
+```
+export TAZAPI_KEY=myfancykey
+
+bin/rspec
+``` 
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wayhomeservices/tazworks-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/wayhomeservices/tazworks-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 Tazworks::Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wayhomeservices/tazworks-api/blob/master/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/tazworks/applicant.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Tazworks
+  # Tazworks Applicants Model
+  class Applicant < Model
+    # https://docs.developer.tazworks.com/#097f5a2a-85f5-4bb7-b208-facc7e66b98f
+    def self.get(ids)
+      RestClient.get("/v1/clients/#{ids[:clientGuid]}/applicants/#{ids[:applicantGuid]}")
+    end
+
+    # https://docs.developer.tazworks.com/#8f16d1e6-7ec4-497b-bf89-161be35c53b7
+    def self.create(clientGuid, params)
+      required_params = %w[firstName lastName email]
+      required_params.each do |rp|
+        raise ArgumentError, "#{rp} is missing in params hash." unless params.key?(rp.to_sym)
+      end
+
+      response = RestClient.post("/v1/clients/#{clientGuid}/applicants", params)
+
+      applicant = Applicant.initialize_from_response({ clientGuid: }, response)
+      applicant.ids[:applicantGuid] = applicant.attributes[:applicantGuid]
+      applicant
+    end
+
+    def self.submit_order(params)
+      Tazworks::Order.create(clientGuid, params)
+    end
+
+    # https://docs.developer.tazworks.com/#a90fd0b6-2584-4ccd-b22c-f67e8bfa7ffa
+    def self.all(clientGuid, params = {})
+      raw_response = RestClient.get("/v1/clients/#{clientGuid}/applicants", { params: })
+      ApplicantPagedResponse.new(raw_response, { clientGuid: })
+    end
+
+    def applicantGuid
+      @ids[:applicantGuid]
+    end
+  end
+end

data/lib/tazworks/applicant_paged_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tazworks
+  # Handles pagination for Applicant responses such as GET All Applicants
+  class ApplicantPagedResponse < PagedResponse
+    def self.base_class
+      Applicant
+    end
+
+    def applicants
+      response_to_models
+    end
+
+    def map_individual_object_ids(ids, attributes)
+      ids[:applicantGuid] = attributes[:applicantGuid]
+      ids
+    end
+  end
+end

data/lib/tazworks/client.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Tazworks
+  # Tazworks Clients Model
+  class Client < Model
+    # https://docs.developer.tazworks.com/#3a09caba-349b-4969-a55a-1cbcaea0136c
+    # TODO: WARNING - UNTESTED - maintainer doesn't have a proper token for this endpoint!
+    def self.get(ids)
+      RestClient.get("/v1/clients/#{ids[:clientGuid]}")
+    end
+
+    # https://docs.developer.tazworks.com/#e008c159-b8d7-4843-a08f-ff483315a067
+    # tazapi defaults to params { page: 0, size: 30 }
+    def self.all(params = {})
+      raw_response = RestClient.get('/v1/clients', { params: })
+      ClientPagedResponse.new(raw_response, {})
+    end
+
+    # https://docs.developer.tazworks.com/#da4edfa1-a2b0-4015-a622-23998864b14c
+    def self.descendents(_clientGuid)
+      raise 'Unimplemented'
+    end
+
+    # https://docs.developer.tazworks.com/#31f1c04e-6cba-4e6d-9499-23d5dafe16f8
+    def self.ancestors(_clientGuid)
+      raise 'Unimplemented'
+    end
+
+    ## consider splitting these up into mixins if they get too big
+
+    # Orders/Applicants
+
+    def applicants(params = {})
+      Applicant.all(clientGuid, params)
+    end
+
+    def orders(params = {})
+      Order.all(clientGuid, params)
+    end
+
+    def client_products(params = {})
+      ClientProduct.all(clientGuid, params)
+    end
+
+    def create_applicant(params)
+      Tazworks::Applicant.create(clientGuid, params)
+    end
+
+    # https://docs.developer.tazworks.com/#097f5a2a-85f5-4bb7-b208-facc7e66b98f
+    def find_applicant(applicantGuid)
+      Tazworks::Applicant.find(ids: { clientGuid:, applicantGuid: })
+    end
+
+    def submit_order(params)
+      Order.create(clientGuid, params)
+    end
+
+    def ancestors
+      Client.ancestors(clientGuid)
+    end
+
+    def descendents(clientGuid)
+      Client.descendents(clientGuid)
+    end
+  end
+end

data/lib/tazworks/client_paged_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tazworks
+  # Handles pagination for Client Responses such as GET All Clients
+  class ClientPagedResponse < PagedResponse
+    def self.base_class
+      Client
+    end
+
+    def clients
+      response_to_models
+    end
+
+    def map_individual_object_ids(ids, attributes)
+      ids[:clientGuid] = attributes[:clientGuid]
+      ids
+    end
+  end
+end

data/lib/tazworks/client_product.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Tazworks
+  # Tazworks Clients Model
+  class ClientProduct < Model
+    # https://docs.developer.tazworks.com/#bc9ed960-33e3-4eed-9f25-7b052b0d4e6f
+    # tazapi defaults to params { page: 0, size: 30 }
+    def self.all(clientGuid, params = {})
+      raw_response = RestClient.get("/v1/clients/#{clientGuid}/products", { params: })
+      ClientProductPagedResponse.new(raw_response, { clientGuid: })
+    end
+
+    # TODO: WARNING - this method is untested; maintainer does not a key that is authorized to use this endpoint
+    def self.get(ids)
+      RestClient.get("/v1/clients/#{ids[:clientGuid]}/products/#{ids[:clientProductGuid]}")
+    end
+
+    def clientProductGuid
+      @ids[:clientProductGuid]
+    end
+  end
+end

data/lib/tazworks/client_product_paged_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tazworks
+  # Handles pagination for ClientProduct responses such as Get All ClientProducts
+  class ClientProductPagedResponse < PagedResponse
+    def self.base_class
+      ClientProduct
+    end
+
+    def client_products
+      response_to_models
+    end
+
+    def map_individual_object_ids(ids, attributes)
+      ids[:clientProductGuid] = attributes[:clientProductGuid]
+      ids
+    end
+  end
+end

data/lib/tazworks/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Tazworks
+  # Tazworks Set Configuration
+  class Config
+    DEFAULT_SANDBOX_HOST = 'https://api-sandbox.instascreen.net'
+    DEFAULT_PRODUCTION_HOST = 'https://api.instascreen.net'
+    DEFAULT_PORT = 443
+
+    attr_accessor :api_key, :sandbox, :host, :port
+
+    def base_uri
+      host = @host
+      host ||= @sandbox ? DEFAULT_SANDBOX_HOST : DEFAULT_PRODUCTION_HOST
+      URI.parse("#{host}:#{@port || DEFAULT_PORT}")
+    end
+  end
+end

data/lib/tazworks/model.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Tazworks
+  # Base model
+  class Model
+    attr_accessor :attributes, :ids
+    attr_reader :attributes_loaded
+
+    def self.find(ids)
+      initialize_from_response(ids, get(ids))
+    end
+
+    def self.get(_ids)
+      raise 'Must Implement Me in the Concrete Class'
+    end
+
+    def load_attributes
+      response = self.class.get(ids)
+      @attributes = JSON.parse(response.body, { symbolize_names: true })
+      @attributes_loaded = true
+    end
+
+    def initialize(ids:, attributes: {}, attributes_loaded: false)
+      @attributes = attributes
+      @ids = ids
+      @attributes_loaded = attributes_loaded
+    end
+
+    def self.initialize_from_response(ids, response)
+      json_response = JSON.parse(response.body, { symbolize_names: true })
+      new(ids:, attributes: json_response, attributes_loaded: true)
+    end
+
+    def attributes_loaded?
+      !!@attributes_loaded
+    end
+
+    def clientGuid
+      @ids[:clientGuid]
+    end
+
+    # ensures attributes are loaded from the server
+    def loaded_attributes
+      load_attributes unless attributes_loaded?
+      @attributes
+    end
+
+    def reload
+      load_attributes
+    end
+  end
+end

data/lib/tazworks/order.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Tazworks
+  # Tazworks Orders Model
+  class Order < Model
+    # https://docs.developer.tazworks.com/#cc17be7c-6b55-4329-991d-6414fad702de
+    def self.get(ids)
+      RestClient.get("/v1/clients/#{ids[:clientGuid]}/orders/#{ids[:orderGuid]}")
+    end
+
+    # https://docs.developer.tazworks.com/#7f41facc-fa45-4d09-a25a-9943d00bfb57
+    def self.all(clientGuid, params = {})
+      raw_response = RestClient.get("/v1/clients/#{clientGuid}/orders", { params: })
+      OrderPagedResponse.new(raw_response, { clientGuid: })
+    end
+
+    # https://docs.developer.tazworks.com/#494c3491-bb92-41a9-bee8-c1601fe957aa
+    def self.create(clientGuid, params)
+      required_params = %w[applicantGuid clientProductGuid]
+      required_params.each do |rp|
+        raise ArgumentError, "#{rp} is missing in params hash." unless params.key?(rp.to_sym)
+      end
+
+      response = RestClient.post("/v1/clients/#{clientGuid}/orders", params)
+
+      order = Order.initialize_from_response({ clientGuid: }, response)
+      order.ids[:orderGuid] = order.attributes[:orderGuid]
+      order
+    end
+
+    # https://docs.developer.tazworks.com/#16c2bff6-501c-432b-a89d-19141f277fc6
+    def order_status
+      response = RestClient.get("/v1/clients/#{clientGuid}/orders/#{orderGuid}/status")
+      JSON.parse(response.body)
+    end
+
+    # https://docs.developer.tazworks.com/#149663fc-2923-4836-a3c7-1dc62a293fba
+    def results_as_pdf
+      begin
+        response = RestClient.get("/v1/clients/#{clientGuid}/orders/#{orderGuid}/resultsAsPdf")
+      rescue ::RestClient::BadRequest => e
+        raise Error, e.response.body
+      end
+      json_parsed = JSON.parse(response.body, { symbolize_names: true })
+      json_parsed[:resultsUrl]
+    end
+
+    def orderGuid
+      @ids[:orderGuid]
+    end
+
+    def quickappApplicantLink
+      loaded_attributes[:quickappApplicantLink]
+    end
+  end
+end

data/lib/tazworks/order_paged_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tazworks
+  # Handles pagination for Order responses such as GET All Orders
+  class OrderPagedResponse < PagedResponse
+    def self.base_class
+      Order
+    end
+
+    def orders
+      response_to_models
+    end
+
+    def map_individual_object_ids(ids, attributes)
+      ids[:orderGuid] = attributes[:orderGuid]
+      ids
+    end
+  end
+end

data/lib/tazworks/paged_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Tazworks
+  # Paged Response Model to Handle Paginated Results
+  class PagedResponse
+    attr_accessor :raw_response, :ids
+
+    def initialize(response, ids)
+      @ids = ids
+      @raw_response = response
+    end
+
+    def self.base_class
+      raise 'Must Implement Me in the Concrete Class'
+    end
+
+    def raw_json_response
+      @raw_response.body
+    end
+
+    def response_to_models
+      return @collection if @collection
+
+      json_response = JSON.parse(raw_response.body, { symbolize_names: true })
+      @collection = json_response.map do |json_object|
+        self.class.base_class.new(ids: map_individual_object_ids(@ids, json_object), attributes: json_object,
+                                  attributes_loaded: true)
+      end
+    end
+
+    # this method is utilized to create proper ids for individual objects from the attributes
+    def map_individual_object_ids(_ids, _attributes)
+      raise 'Must Implement Me in the Concrete Class'
+    end
+
+    def next
+      # might be nice to have a way that automatically calls the next page with the parameters already known here.
+      raise 'Unimplemented'
+    end
+
+    def last
+      # might be nice to have a way that automatically calls the next page with the parameters already known here.
+      raise 'Unimplemented'
+    end
+
+    def response_links
+      @raw_response.headers[:link]&.split(',')
+    end
+
+    def next_page
+      return nil unless response_links
+
+      next_link = response_links.grep(/rel="next"/).first
+      return nil if next_link.nil?
+
+      # scary regex to pull the parameter off the url.
+      next_link[/.*page=(\d+)&.*/, 1].to_i
+    end
+
+    # pages seem to start with 0, so defaulting to 0 when there are only "1" page.
+    def total_number_of_pages
+      return 0 unless response_links
+
+      last_link = response_links.grep(/rel="last"/).first
+      return 0 if last_link.nil?
+
+      # scary regex to pull the parameter off the url.
+      last_link[/.*page=(\d+)&.*/, 1].to_i
+    end
+  end
+end

data/lib/tazworks/rest_client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+
+module Tazworks
+  # Wrapper for rest-client
+  class RestClient
+    def self.url(uri)
+      "#{Tazworks.config.base_uri}#{uri}"
+    end
+
+    def self.merged_headers(headers)
+      raise ArgumentError, 'api_key is not set in Tazworks configuration' unless Tazworks.config.api_key
+
+      default_headers = {
+        'Content-Type': 'application/json',
+        Authorization: "Bearer #{Tazworks.config.api_key}"
+      }
+      default_headers.merge(headers)
+    end
+
+    def self.get(uri, headers = {})
+      ::RestClient.get(url(uri), merged_headers(headers))
+    end
+
+    def self.post(uri, payload, headers = {})
+      ::RestClient.post(url(uri), payload.to_json, merged_headers(headers))
+    end
+  end
+end

data/lib/tazworks/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Tazworks Version
+module Tazworks
+  VERSION = '0.1.1'
+end

data/lib/tazworks.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'tazworks/version'
+require_relative 'tazworks/config'
+require_relative 'tazworks/model'
+require_relative 'tazworks/rest_client'
+require_relative 'tazworks/client'
+require_relative 'tazworks/client_product'
+require_relative 'tazworks/applicant'
+require_relative 'tazworks/order'
+
+require_relative 'tazworks/paged_response'
+require_relative 'tazworks/client_paged_response'
+require_relative 'tazworks/client_product_paged_response'
+require_relative 'tazworks/applicant_paged_response'
+require_relative 'tazworks/order_paged_response'
+
+# Tazworks Configuration
+module Tazworks
+  def configure(&)
+    config.tap(&)
+  end
+
+  def config
+    @config ||= Config.new
+  end
+
+  module_function :configure, :config
+
+  class Error < StandardError; end
+end

data/sig/tazworks/api.rbs

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

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: tazworks-api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Peyton Smith
+- Jonathan Chan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+- !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'
+description:
+email:
+- 19peytonsmith@gmail.com
+- jonathan@rentwayhome.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tazworks.rb
+- lib/tazworks/applicant.rb
+- lib/tazworks/applicant_paged_response.rb
+- lib/tazworks/client.rb
+- lib/tazworks/client_paged_response.rb
+- lib/tazworks/client_product.rb
+- lib/tazworks/client_product_paged_response.rb
+- lib/tazworks/config.rb
+- lib/tazworks/model.rb
+- lib/tazworks/order.rb
+- lib/tazworks/order_paged_response.rb
+- lib/tazworks/paged_response.rb
+- lib/tazworks/rest_client.rb
+- lib/tazworks/version.rb
+- sig/tazworks/api.rbs
+homepage: https://github.com/wayhomeservices/tazworks-api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/wayhomeservices/tazworks-api
+  source_code_uri: https://github.com/wayhomeservices/tazworks-api
+  changelog_uri: https://github.com/wayhomeservices/tazworks-api/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Ruby Wrapper for Tazworks background screening TazAPI.
+test_files: []