noyo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c5e14f7a5c861abe208d64f6809ae2f13c6b09305183729916fe6460891371a
+  data.tar.gz: 6e29ece08bd7d66756b75372ac490dd61469b4feb151e0e430ad441e66913320
+SHA512:
+  metadata.gz: 90cf7274e4020311659116d82d1d2df4fca1a25fa325a9b8dccbbb650c6d8aa2cbd98c96a74a3876524ff4b5eb62c1a5997c1210f41f60172e7ff1e2444e2365
+  data.tar.gz: e85c579d6b38e6bbe8b4b426e023bdda0293f69ff22673488f3e34ac4d31536efff84cffb007fcbdeff20eb46981a4d8384b4700e3314cc594648499e31bf1dc

data/.circleci/config.yml

@@ -0,0 +1,57 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.6.3
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            CI=TRUE bundle exec rspec
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+      - run:
+          name: Upload Coverage
+          command: |
+            bash <(curl -s https://codecov.io/bash) \
+              -f ./coverage/.resultset.json

data/.codecov.yml

@@ -0,0 +1,13 @@
+codecov:
+  token: 0cb82650-767d-4502-90fa-ed6f4b932ffc
+
+coverage:
+  status:
+    project:
+      default:
+        enabled: yes
+        target: 80%
+    patch:
+      default:
+        enabled: yes
+        target: 65%

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,73 @@
+AllCops:
+  TargetRubyVersion: 2.3.8
+  TargetRailsVersion: 5.0.7
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%w": '[]'
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/NegatedIf:
+  Enabled: false
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: space
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 20

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

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 eng-admin@gonoyo.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 noyo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    noyo (0.1.0)
+      factory_bot (~> 5.0.2)
+      faker (~> 1.9.3)
+      httparty (~> 0.17.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    codecov (0.1.14)
+      json
+      simplecov
+      url
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    factory_bot (5.0.2)
+      activesupport (>= 4.2.0)
+    faker (1.9.6)
+      i18n (>= 0.7)
+    hashdiff (0.3.9)
+    httparty (0.17.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    public_suffix (3.0.3)
+    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.3)
+      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)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    url (0.3.2)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17.3)
+  codecov (~> 0.1.14)
+  noyo!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.16.1)
+  webmock (~> 3.5.1)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,176 @@
+# Noyo Fulfillment Ruby Library
+
+A Ruby client for Noyo's Fulfillment Service API
+
+[![CircleCI](https://circleci.com/gh/noyo-technologies/noyo-ruby.svg?style=svg&circle-token=4841c7717865a43b4417109b30d016452dc08951)](https://circleci.com/gh/noyo-technologies/noyo-ruby)
+
+[![codecov](https://codecov.io/gh/noyo-technologies/noyo-ruby/branch/master/graph/badge.svg?token=QRT59Dq2kq)](https://codecov.io/gh/noyo-technologies/noyo-ruby)
+
+## Ruby Version
+
+This client was written to target Ruby 2.6.3. Other version support not yet guaranteed.
+
+## Noyo API Docs
+
+While using this client library, [the Noyo API docs](https://docs.noyoconnect.com) should be referenced for wider context. This
+will also give you a reference for things like validation and schemas, which this client library
+typically does not provide.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'noyo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install noyo
+
+## REPL
+
+During development of this library, run `./bin/console` for an irb REPL with this module included.
+
+## Usage
+
+### Configuration
+
+Once you have a client ID and secret for your organization from Noyo, you can use it to configure
+your Noyo connection similar to the sample below. A sample tweak assuming you're running Rails is
+used below to give you an idea of a common usage.
+
+```
+NoyoApi::Api.configure do |config|
+  config.client_id = "" # your Noyo client ID
+  config.client_secret = "" # your Noyo client secret
+
+  if not Rails.env.production?
+    # For experimental development
+    config.fulfillment_base_uri = 'https://fulfillment-sandbox.noyoconnect.com'
+  end
+end
+```
+
+If you'd like to debug the API calls being made, add a `config.verbose = true` to the
+configuration block. This will give you information on the underlying HTTPS calls being made.
+
+### Querying
+
+#### #all
+
+You can find all resources for a given model using the `all` class method:
+
+```
+groups = NoyoFulfillment::Group.all
+```
+
+This will return a `ApiResourceCollection`. This is a paginated collection. You can get the next
+page of data easily:
+
+```
+more_groups = groups.next_page
+```
+
+#### #find
+
+You can also just find one record for a model by ID:
+
+```
+group = NoyoFulfillment::Group.find('065f876d-d557-4019-8607-439b19235fa0')
+```
+
+#### Nested Resources
+
+You can find nested resources using model helpers:
+
+```
+locations = group.locations # returns an ApiResourceCollection of locations
+```
+
+This is just syntactical sugar for:
+
+```
+locations = NoyoFulfillment::Location.all(group_id: group.id)
+```
+
+### Creating data during development
+
+You can take advantage of the [FactoryBot](https://github.com/thoughtbot/factory_bot) factories built into this library, in order to speed up development time.
+
+#### Create an employee
+
+```
+# Boilerplate to bring in factories. Could be used in a spec_helper,
+# or other initialization code during the development phase.
+require 'factory_bot'
+FactoryBot.find_definitions
+require 'faker'
+
+groups = NoyoFulfillment::Group.all
+group = groups.records.first # Find an appropriate group using this collection
+locations = group.locations
+location = locations.records.first
+employee = FactoryBot.build(:employee, group_id: group.id, location_id: location.id)
+employee = employee.create
+```
+
+All employee values not specified will be faked using the [faker gem](https://github.com/stympy/faker).
+
+#### Create a dependent
+
+Given an employee object returned from the API:
+
+```
+dependent = FactoryBot.build(:dependent, employee_id: employee.id)
+dependent = dependent.create
+```
+
+#### Create a new hire request
+
+Once an employee is created, you can use the model to enroll that employee into coverages:
+
+```
+new_hire = FactoryBot.build(:new_hire, employee_id: employee.id, carrier_id: '5d9cf3ac-ea6d-4035-a478-3b9839866a7b', dental_plan_id: 'bd90742f-f019-4a4b-b1d6-3038921e936b', vision_plan_id: 'bd90742f-f019-4a4b-b1d6-3038921e936b')
+new_hire_request = employee.create_new_hire_request(new_hire.attributes)
+```
+
+#### Create a termination request
+
+Given an employee object returned from the API:
+
+```
+termination = FactoryBot.build(:termination, employee_id: employee.id)
+termination_request = employee.create_termination_request(termination.attributes)
+```
+
+#### Create a demographic change request
+
+Given an employee object returned from the API:
+
+```
+demographic_change = FactoryBot.build(:demographic_change, member_type: 'employee', employee_id: employee.id)
+demographic_change_request = employee.create_demographic_change_request(demographic_change.attributes)
+```
+
+#### Create an open enrollment request
+
+Given an employee object returned from the API:
+
+```
+open_enrollment = FactoryBot.build(:open_enrollment, member_type: 'employee', employee_id: employee.id, carrier_id: '5d9cf3ac-ea6d-4035-a478-3b9839866a7b', dental_plan_id: 'bd90742f-f019-4a4b-b1d6-3038921e936b', vision_plan_id: 'bd90742f-f019-4a4b-b1d6-3038921e936b')
+open_enrollment_request = employee.create_open_enrollment_request(open_enrollment.attributes)
+```
+
+#### Create a qualifying life event request
+
+Given an employee object returned from the API:
+
+```
+qualifying_life_event = FactoryBot.build(:qualifying_life_event, member_type: 'employee', employee_id: employee.id, carrier_id: '5d9cf3ac-ea6d-4035-a478-3b9839866a7b', dental_plan_id: 'bd90742f-f019-4a4b-b1d6-3038921e936b', vision_plan_id: 'bd90742f-f019-4a4b-b1d6-3038921e936b')
+qualifying_life_event_request = employee.create_qualifying_life_event_request(qualifying_life_event.attributes)
+```