mirah-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b06a0f1fe231e4a3f490563bcaed279296715cf4e4b97647f9fd3810b769d66f
+  data.tar.gz: 0e182f930e9b7478aa8e020dda8eace77c5cf40e7dcd7ca93df1ab5a75f5ad67
+SHA512:
+  metadata.gz: 23e8b43f19e52ee63413a5988c1185013e80eeb869ad83ee514cd4baa666847a5cf6b8ab9813b0207d91f329bb8dae44053a247f1998279fb4df840de31667cd
+  data.tar.gz: 90acff70c6cb89897c4b86483bb44b118ae019fcefd57a94a83e866b4972459fc96bd8d9a7b6d362b4590e6bb0532a820c033bf8f421f41c17459085ee663a41

data/.circleci/config.yml

@@ -0,0 +1,93 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  test24:
+    docker:
+      - image: circleci/ruby:2.4.6-stretch-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=1.16.6' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: Tests
+          command: bundle exec rake spec
+  test25:
+    docker:
+      - image: circleci/ruby:2.5-stretch-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=1.16.6' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: Tests
+          command: bundle exec rake spec
+  test26:
+    docker:
+      - image: circleci/ruby:2.6-stretch-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=2.1.4' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: Tests
+          command: bundle exec rake spec
+  test27:
+    docker:
+      - image: circleci/ruby:2.7-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=2.1.4' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: Tests
+          command: bundle exec rake spec
+
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - test24
+      - test25
+      - test26
+      - test27
+
+      

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+.overcommit_gems.rb.lock

data/.overcommit.yml

@@ -0,0 +1,48 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+gemfile: .overcommit_gems.rb
+
+PreCommit:
+  Brakeman:
+    enabled: true
+  BundleAudit:
+    enabled: true
+  FixMe:
+    enabled: true
+    on_fail: warn
+  # TODO: enable
+  # ForbiddenBranches:
+  #   enabled: true
+  #   branch_patterns: ['master', 'qa']
+  HardTabs:
+    enabled: true
+    exclude: ['spec/fixtures/**/*', 'Makefile']
+  RuboCop:
+    enabled: true
+    command: ['rubocop']
+    flags: ['--format=emacs', '--force-exclusion', '--display-cop-names', '--config=.rubocop.yml']
+
+# TODO: enable
+# PrePush:
+#   ForbiddenBranches:
+#     enabled: true
+#     branch_patterns: ['master', 'qa']
+
+# PreRebase:
+#   MergedCommits:
+#     enabled: true
+#     branches: ['master', 'qa']

data/.overcommit_gems.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'brakeman', '>= 4.8.1'
+gem 'bundler-audit', '>= 0.6.1'
+gem 'overcommit'
+gem 'rubocop'
+gem 'rubocop-rspec'

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,54 @@
+require:
+  - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.4
+  DefaultFormatter: progress
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+   - 'bin/*'
+   - '*.md'
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'mirah-ruby.gemspec'
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - io
+    - id
+    - to
+    - by
+    - 'on'
+    - in
+    - at
+    - ip
+    - db
+    - tz
+    - el
+    - e
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 7
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/.yardopts

@@ -0,0 +1 @@
+--no-private

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 ben@benjones.io. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mirah-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ben Jones
+
+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,187 @@
+# Mirah Ruby Integration Library
+
+This gem provides convenience methods to allow EHRs and other systems of record to access and update a variety of Mirah endpoints. It is intended for use in the following circumstances
+
+## Getting Started
+
+This gem is intended for use for existing Mirah customers only. To get started, ask your account representative for a technical contact, who will provide you with the following for both staging and production:
+
+ - An `API_USER_ID` which is your unique user. This is provided at the system level and does not correspond to an individual.
+ - An `API_KEY` as a secret key.
+ - An `API_HOST` which is the URL of the API.
+
+There are different endpoints for production and staging. They will be configured below as part of installation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mirah-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mirah-ruby
+
+Configure your environments so that you use the correct credentials for each environment. For example, in rails you can edit `db/secrets.yml`:
+
+    production:
+      mirah_api_host: <%= ENV["MIRAH_API_HOST"] %>
+      mirah_api_user_id: <%= ENV["MIRAH_API_USER_ID"] %>
+      mirah_api_token: <%= ENV["MIRAH_API_KEY"] %>
+
+Finally, ensure `MIRAH_API_HOST`, `MIRAH_API_USER_ID` and `MIRAH_API_KEY` are present in environment variables to be used.
+
+## Supported Ruby Versions
+
+This library supports the following Ruby implementations:
+
+ * Ruby 2.4
+ * Ruby 2.5
+ * Ruby 2.6
+ * Ruby 2.7
+
+## Usage
+
+To begin, let's instantiate our client:
+
+    # Or otherwise provided by your secrets. Do not store these credentials in source code.
+    host = Rails.application.secrets.mirah_api_host
+    user_id = Rails.application.secrets.mirah_api_user_id
+    token = Rails.application.secrets.mirah_api_key
+    client = Mirah::Client.new(host: host, user_id: user_id, access_token: token) # => #<Mirah::Client:0x00007fdf9d698d70....>
+
+There are three kinds of end points in this library:
+
+ * 'Push' methods for sending new or updated data to Mirah - e.g. 'push_patient'.
+ * 'Find' methods for single items
+ * 'Query' methods for multiple items - e.g. `query_patients`. These can support filters and will paginate.
+
+Let's start by creating a new patient:
+
+    result = client.push_patient(external_id: 'mrn001', given_name: 'Henry', family_name: 'Jones', birth_date: Date.parse('1983-03-20')) # => #<Mirah::PushResult:... @given_name="Henry", @family_name="Jones", @birth_date=#<Date: 1983-03-20>
+
+You should get an object with the newly created patient:
+
+    result.status # => "CREATED"
+    result.result # => #<Mirah::Data::Patient ... @given_name="Henry", @family_name="Jones" ... >
+
+If you send the same message back, you'll notice the status is 'UPDATED'.
+
+    result = client.push_patient(external_id: 'mrn001', given_name: 'Henry', family_name: 'Jones', birth_date: Date.parse('1983-03-20')) # => #<Mirah::PushResult:... @given_name="Henry", @family_name="Jones", @birth_date=#<Date: 1983-03-20>
+    result.status # => "UPDATED"
+
+You can even do a partial update:
+
+    partial = client.push_patient(external_id: 'mrn001', phone_number: '555-555-5555') # => #<Mirah::PushResult:... @given_name="Henry", @family_name="Jones", @birth_date=#<Date: 1983-03-20>
+
+Now let's move onto querying.
+
+    patient_collection = client.query_patients #  => #<Mirah::Collection:0x00007fc4b8943480 @results=[...] >
+
+You can read more about each below, but for now, we can examine the first page of the patient results:
+
+    patient_collection.results.length # => 10
+    patient_collection.results.first # => #<Mirah::Data::Patient:0x00007fc4b6aa2850 @id="3046af39-0560-4add-9881-2e004ecdb042", @given_name="Test", @family_name="Patient", @birth_date=#<Date: 1991-01-01)>>
+
+Let's pluck out the first result's id, and then fetch the data directly:
+
+    patient_id = patient_collection.results.first.id # => "3046af39-0560-4add-9881-2e004ecdb042"
+    patient = client.find_patient(patient_id) # => #<Mirah::Data::Patient ....>
+
+You may also fetch directly by your own identifier:
+
+    my_patient = client.find_patient_by_external_id('mrn0001') # => #<Mirah::Data::Patient ....>
+
+If you want to find more than one record at a time, you may do so by specifying a filter as part of a normal patient query:
+
+    matching_patients = client.query_patients(external_ids: ['mrn0001', 'mrn0002']) # => #<Mirah::Collection:0x00007fc4b8943480 @results=[...] >
+
+To see the full documentation, see documentation for {Mirah::Client}
+
+
+### Find methods
+
+ - e.g. {Mirah::Client#find_patient}, {Mirah::Client#find_patient_by_external_id}. These are used to get a single record and do not support pagination or filtering. You must know the identifier (either Mirah or your own) of the record in order to access it.
+
+
+## Use of identifiers
+
+This API mixes resources where it is likely that users are the system of record (e.g. Patient information), with records where Mirah is the originator (e.g. assessment records). All items in this API contain an `id` field, which corresponds to the Mirah internal identifier.
+
+Some classes also contain an extra `identifiers` field that describes the rest of the identifiers that Mirah knows about. This includes:
+
+ - An `assigner` which corresponds to which system assigned the identifier. In most circumstances where you are the only system of record, this will be `default`.
+ - A `value` which is the actual record identifier.
+
+## Error Handling
+
+All errors raised will be a subclass of {Mirah::Error}. You can rescue from these as follows to maintain safe code:
+
+    begin
+      client.query_patients
+    rescue Mirah::Error => e
+      # 
+    end
+
+The expected kinds of errors will vary on the basis of whether you are using query methods or updating data. Unexpected errors - connectivity, etc, will be raised as a {Mirah::Errors::ClientError}.
+
+### Query methods
+
+The most common errors will come from supply invalid data to queries. For example, {Mirah::Filters::AppointmentFilters} allows you to supply a `status` variable which needs to be of the correct type.
+
+    client.query_appointments(status: 'INVALID') # => Mirah::Errors::ServerError: Unknown error from Mirah server: Variable $status of type [AppointmentStatus!] was provided invalid value for 0 (Expected "INVALID" to be one of: PROPOSED, PENDING, BOOKED, ARRIVED, FULFILLED, CANCELED, NOSHOW)
+
+### Push methods
+
+Push methods wrap their errors into an error type. You should always inspect the result for success:
+
+    result = client.push_appointment(external_id: 'mynewappointment', status: 'NOTVALIDSTATUS', external_patient_id: 'doesnotexist')
+    if result.status == 'ERROR'
+      result.errors.map { |e| e['message'] } # ["Variable $input of type CreateOrUpdateAppointmentInput! was provided invalid value for status (Expected \"BOOKEDS\" to be one of: PROPOSED, PENDING, BOOKED, ARRIVED, FULFILLED, CANCELED, NOSHOW)"]
+    else
+      # SUCCESS
+    end
+
+## 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).
+
+## Documentation
+
+To run the documentation server locally:
+
+    bundle exec yard server --reload
+
+## Testing
+
+To run the test suite:
+
+    bundle exec rake spec
+
+We use VCR to supply real API responses during internal testing. To set this up in `mirah_server`, you may run a convenience task to make a specially configured site with exactly the same data:
+
+    bundle exec rake integration:create_gem_institute # in mirah_server
+
+By default, any requests from the API which cause a request which has not been recorded will cause an error. To enable fetching of real request data, you must supply environment variables:
+
+    VCR_HOST=http://localhost:3000 VCR_USER_ID=ABC VCR_TOKEN=XYZ bundle exec rake spec
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mirah_tech/mirah-ruby. 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/mirah_tech/mirah-ruby/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 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mirah_tech/mirah-ruby/blob/master/CODE_OF_CONDUCT.md).