allscripts_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b23ffb52309d9ea984d58c79f4395ec31c2da8f
+  data.tar.gz: eebeb6cefe1d8405f58c8d9d0dc879aca52d5691
+SHA512:
+  metadata.gz: 001e96d778c6fae73d8ac958d5be9fb2c5734a0212420ee6d9932ba20d125ee36ab865062d79a04d5aa9dd6ce465bb4649cf67acc58137f8f30a5ab99c18ac9c
+  data.tar.gz: 35b052c6a01bd26cb9520e6aea5d9334dae1908d36b28250d7323f13e486640e93528a516c7a01700418a6f249b28efbcacc600d464ef43fce085af1a02d9ea5

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.vscode/
+
+/spec/fixtures/secrets.yml

data/.pryrc

@@ -0,0 +1,24 @@
+require "allscripts_api"
+require "yaml"
+
+begin
+  loaded = ENV["app_name"] && ENV["app_password"] && ENV["unity_url"] && ENV["app_username"]
+  unless loaded
+    secrets = YAML.safe_load(File.read("spec/fixtures/secrets.yml"))
+    secrets.map { |key_name, secret| ENV[key_name] = secret }
+  end
+rescue => exception
+  puts(exception)
+end
+
+def bc
+  client =
+    AllscriptsApi::Client.new(ENV["unity_url"],
+                              ENV["app_name"],
+                              ENV["app_username"],
+                              ENV["app_password"])
+  client.get_token
+  client.get_user_authentication("jmedici", "password01")
+
+  client
+end

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  Exclude:
+    - "bin/*"
+    - .pryrc
+    - "spec/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/AccessorMethodName:
+  Exclude:
+    - "lib/allscripts_api/client.rb"
+
+# Bumbing the max from 10 to 15 allows magic params to work nicely
+Metrics/MethodLength:
+  Max: 15
+# Bumbing the max from 5 to 7 allows magic params to work nicely
+Metrics/ParameterLists:
+  Max: 7

data/.simplecov

@@ -0,0 +1,7 @@
+require "simplecov"
+require "coveralls"
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+   add_filter "spec/helper.rb"
+end

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+  - 2.4.2
+  - 2.3.6
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in allscripts_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: .
+  specs:
+    allscripts_api (0.1.0)
+      faraday (>= 0.12.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    coderay (1.1.2)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    gitlab (4.0.0)
+      httparty
+      terminal-table (= 1.7.1)
+    hashdiff (0.3.7)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    json (2.1.0)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    octokit (4.7.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.12.1)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pronto (0.9.3)
+      gitlab (~> 4.0, >= 4.0.0)
+      httparty (>= 0.13.7, < 0.15)
+      octokit (~> 4.7, >= 4.7.0)
+      rainbow (~> 2.1)
+      rugged (~> 0.24, >= 0.23.0)
+      thor (~> 0.19.0)
+    pronto-rubocop (0.9.0)
+      pronto (~> 0.9.0)
+      rubocop (~> 0.38, >= 0.35.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    rugged (0.25.1.1)
+    safe_yaml (1.0.4)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    terminal-table (1.7.1)
+      unicode-display_width (~> 1.1.1)
+    thor (0.19.4)
+    tins (1.16.0)
+    unicode-display_width (1.1.3)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  allscripts_api!
+  bundler (~> 1.16)
+  coveralls
+  nokogiri
+  pronto
+  pronto-rubocop
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.3)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,23 @@
+
+Copyright (c) 2018 Avhana Health, Inc
+
+MIT License
+
+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,86 @@
+# AllscriptsApi, an Allscripts Unity Client
+
+[![Coverage Status](https://coveralls.io/repos/github/Avhana/allscripts_api/badge.svg?branch=master)](https://coveralls.io/github/Avhana/allscripts_api?branch=master)
+[![Build Status](https://travis-ci.org/Avhana/allscripts_api.svg?branch=master)](https://travis-ci.org/Avhana/allscripts_api)
+[![Inline docs](http://inch-ci.org/github/Avhana/allscripts_api.svg?branch=master&style=shields)](http://inch-ci.org/github/Avhana/allscripts_api)
+[![Dependency Status](https://gemnasium.com/badges/github.com/Avhana/allscripts_api.svg)](https://gemnasium.com/github.com/Avhana/allscripts_api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9889f5255914a5fcbeb5/maintainability)](https://codeclimate.com/github/Avhana/allscripts_api/maintainability)
+[![security](https://hakiri.io/github/Avhana/allscripts_api/master.svg)](https://hakiri.io/github/Avhana/allscripts_api/master)
+
+AllscriptsApi is a simple ruby wrapper around the [Allscripts Unity API](https://developer.allscripts.com/APIReference/). This gem specifically focuses on the JSON 
+functionality of the API and will not support SOAP. Additionally, `allscripts_api` focuses on being simple 
+to use and understand. There are no DSLs, or behind the scenes magic. The code aims to be well documented, 
+readable, and straightforward to use in your own application. The docs are available [here](http://www.rubydoc.info/github/Avhana/allscripts_api/master/AllscriptsApi)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'allscripts_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install allscripts_api
+
+## Usage
+The client can be used either with ahead of time configuration and instantiated with `AllscriptsApi.connect`, or by directly calling
+`AllscriptsApi::Client.new`, and passing your applications credentials.
+### Optional Configuration
+
+You may configure the client beforehand with the following config block. If you are using Rails,
+this will go in `cofig/initializers`. However, the code does not rely on ActiveSupport and can
+be configured ahead of time in and Ruby application.
+
+```ruby
+AllscriptsApi.configure do |config|
+  config.app_name = 'YOUR_APP_NAME_HERE'
+  config.app_username = 'YOUR_APP_USERNAME_HERE'
+  config.app_password = 'YOUR_APP_PASSWORD_HERE'
+  config.unity_url = 'CHOSEN_UNITY_URL'
+end
+```
+
+If you have configured you application ahead of time, you can test your set up now.
+```ruby
+client = AllscriptsApi.connect
+client.get_token
+```
+
+If this works, the client should set a token, and you should see it printed to the console. If it fails for any reason, it will raise [`GetTokenError`](https://github.com/Avhana/allscripts_api/blob/master/lib/allscripts_api.rb#L16), and dump the response body of the GetToken call to Unity.
+
+Assuming a successful call to GetToken, next authenticate the test user to that token.
+
+```ruby
+client.get_user_authentication("jmedici", "password01")
+```
+
+This call will return a [`MagicError`](https://github.com/Avhana/allscripts_api/blob/master/lib/allscripts_api.rb#L12) if it fails.
+
+### Directly Building the Client
+If you want to use the gem from the console, or without ahead of time configuration, you may do so as follows.
+```ruby
+  client =
+    AllscriptsApi::Client.new(unity_url, app_name, app_username, app_password)
+  client.get_token
+  client.get_user_authentication("jmedici", "password01")
+```
+As you can see, after the initial call, usage is the same. That is because `AllscriptsApi.connect` returns an instance of `AllscriptsApi::Client`. You can find the documentation for `AllscriptsApi.connect` [here](http://www.rubydoc.info/github/Avhana/allscripts_api/master/AllscriptsApi/Client).
+
+
+## Code of Conduct
+In order to have a more open and welcoming community of contributors and users, Avhana Health will enforce a [Code of Conduct](https://github.com/avhana/allscripts_api/blob/master/code-of-conduct.md), which follows v1.4 of the [Contributors Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/avhana/allscripts_api.
+
+## License
+
+This gem is provided as is under the [MIT license](https://github.com/avhana/allscripts_api/blob/master/LICENSE), Copyright (c) 2018 Avhana Health, Inc.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/allscripts_api.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "allscripts_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "allscripts_api"
+  spec.version       = AllscriptsApi::VERSION
+  spec.authors       = ["Chase"]
+  spec.email         = ["chase.gilliam@gmail.com"]
+
+  spec.summary       = "A simple, configurable wrapper around Allscripts APIs"
+  spec.description   = %(The allscripts_api gem wraps a set of Allscripts APIs, including
+                          but not limited to Unity. The gem focuses on JSON endpoints instead 
+                          of SOAP.)
+  spec.homepage      = "https://github.com/Avhana/allscripts_api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", ">= 0.12.2"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "pronto"
+  spec.add_development_dependency "pronto-rubocop"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "webmock", "~> 3.3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "allscripts_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/code-of-conduct.md

@@ -0,0 +1,73 @@
+# 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,
+education, socio-economic status, 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 [INSERT EMAIL ADDRESS]. 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://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/lib/allscripts_api.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "allscripts_api/configuration"
+require "allscripts_api/magic_params"
+require "allscripts_api/named_magic_methods"
+require "allscripts_api/client"
+require "allscripts_api/version"
+
+# Entry point for the AllscriptsApi gem.
+module AllscriptsApi
+  # Error wrapper of Unity or other Allscripts API errors.
+  class MagicError < RuntimeError
+  end
+
+  # Error raised whenever Unity's '/GetToken' call fails or returns an error.
+  class GetTokenError < RuntimeError
+  end
+
+  # Error raised if AllscriptsApi.connect is called without configuring
+  # the gem first
+  class NoConfigurationError < RuntimeError
+    # method to return a sample config block
+    #
+    # @return [String] a sample config block
+    def self.error_message
+      %(Please add the following to config/initializers and try again.
+        AllscriptsApi.configure do |config|
+          config.app_name = 'YOUR_APP_NAME_HERE'
+          config.app_username = 'YOUR_APP_USERNAME_HERE'
+          config.app_password = 'YOUR_APP_PASSWORD_HERE'
+          config.unity_url = 'CHOSEN_UNITY_URL'
+        end
+      )
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+    # a method that allows a configuration block to be passed
+    # to {AllscriptsApi::Configuration#new}
+    # @see AllscriptsApi::Configuration
+    def configure
+      self.configuration ||= AllscriptsApi::Configuration.new
+      yield(configuration)
+    end
+
+    # The main entry point for a pre-configured client
+    #
+    # @return [AllscriptsApi::Client, AllscriptsApi::NoConfigurationError]
+    # @see AllscriptsApi::Client
+    def connect
+      unless AllscriptsApi.configuration
+        raise NoConfigurationError, NoConfigurationError.error_message
+      end
+      unity_url = AllscriptsApi.configuration.unity_url
+      app_name = AllscriptsApi.configuration.app_name
+      app_username = AllscriptsApi.configuration.app_username
+      app_password = AllscriptsApi.configuration.app_password
+
+      Client.new(unity_url, app_name, app_username, app_password)
+    end
+  end
+end

data/lib/allscripts_api/client.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+module AllscriptsApi
+  # Client serves as an entry point for making calls
+  class Client
+    include AllscriptsApi::NamedMagicMethods
+    attr_reader :adapter, :unity_url, :app_name, :token
+    attr_writer :sso_token
+
+    # hardcoded to use the JSON endpoint
+    ENDPOINT = "/Unity/UnityService.svc/json".freeze
+
+    # Instantiation of the Client
+    #
+    # @param url [String] Allscripts URL to be used to make Unity API calls
+    # @param app_name [String] app name assigned by Allscripts
+    # @param app_username [String] the app username supplied by Allscripts
+    # @param app_password [String] the app password supplied by Allscripts
+    def initialize(url, app_name, app_username, app_password)
+      @unity_url = url
+      @app_name = app_name
+      @username = app_username
+      @password = app_password
+      @adapter = check_adapter
+    end
+
+    # Gets security token necessary in all workflows
+    # @return [String] security token
+    def get_token
+      full_path = build_request_path("/GetToken")
+      response = conn.post do |req|
+        req.url(full_path)
+        req.body = { Username: @username, Password: @password }.to_json
+      end
+
+      raise(GetTokenError, response.body) unless response.status == 200
+      @token = response.body
+    end
+
+    # Assign a security token from `get_token` to a specific Allscripts user.
+    # This creates a link on the Allscripts server that allows that token
+    # to be used in subsequent `magic` calls passed that user's username.
+    #
+    # @param username [String] the Allscripts user's username (from Allscripts)
+    # @param password [String] the Allscripts user's password (from Allscripts)
+    # @return [Hash] user permissions, etc.
+    def get_user_authentication(username, password)
+      @allscripts_username = username
+      params = MagicParams.format(user_id: username, parameter1: password)
+      response = magic("GetUserAuthentication", magic_params: params)
+      response["getuserauthenticationinfo"][0]
+    end
+
+    # Validate a token generated and passed by Allscripts during SSO
+    # Falls back and looks for sso_token on the client if not passed one
+    # Note that sso_token is not the token from `get_token``
+    #
+    # TODO: test and validate. Add error handling
+    #
+    # @param sso_token [String] the Allscripts SSO token (from Allscripts)
+    def validate_sso_token(sso_token = nil)
+      sso_token ||= @sso_token
+      params = MagicParams.format(parameter1: sso_token)
+      response = magic("GetTokenValidation", magic_params: params)
+      response["Table"][0]
+    end
+
+    # Main method for interacting with the Allscripts UNityAPI
+    #
+    # @param action [String] the API action to be performed
+    # @param magic_params [MagicParams] a params object
+    # used to build the Magic Action request body's user_id,
+    # patient_id, and magic parameters. The patient_id
+    # is sometimes oprional and the numbered
+    # params are generally optional, but must be sent
+    # as blank strings if unused.
+    # @return [Hash, MagicError] the parsed JSON response from Allscripts or
+    # a `MagicError` with the API error message(hopefully)
+    def magic(action, magic_params: MagicParams.format)
+      full_path = build_request_path("/MagicJson")
+      body = build_magic_body(action, magic_params)
+      response =
+        conn.post do |req|
+          req.url(full_path)
+          req.body = body
+        end
+
+      read_magic_response(response)
+    end
+
+    private
+
+    def check_adapter
+      @adapter ||=
+        if AllscriptsApi.configuration
+          AllscriptsApi.configuration.faraday_adapter
+        else
+          Faraday.default_adapter # make requests with Net::HTTP
+        end
+    end
+
+    def read_magic_response(response)
+      raise(MagicError, response.body) unless response.status == 200
+      response_body = JSON.parse(response.body)[0]
+      raise(MagicError, response_body["Error"]) if response_body.key?("Error")
+      response_body
+    end
+
+    def build_magic_body(action, params)
+      params.merge(
+        Action: action,
+        Appname: @app_name,
+        Token: @token
+      ).to_json
+    end
+
+    def build_request_path(path)
+      "#{ENDPOINT}#{path}"
+    end
+
+    def conn
+      @conn ||= Faraday.new(url: @unity_url) do |faraday|
+        faraday.headers["Content-Type"] = "application/json"
+        faraday.adapter(@adapter)
+      end
+    end
+  end
+end

data/lib/allscripts_api/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  # Configuration class to allow configuration on application
+  # initialization. Configuration should look like the following.
+  #
+  # AllscriptsApi.configure do |config|
+  #   config.app_name = 'YOUR_APP_NAME_HERE'
+  #   config.app_username = 'YOUR_APP_USERNAME_HERE'
+  #   config.app_password = 'YOUR_APP_PASSWORD_HERE'
+  #   config.unity_url = 'CHOSEN_UNITY_URL'
+  #   config.faraday_adapter = Faraday.some_adapter # default = Faraday.default_adapter
+  # end
+  class Configuration
+    attr_accessor :app_name, :app_password, :unity_url,
+                  :app_username, :faraday_adapter
+    # The initialize method may be passed a block, but defaults to fetching
+    # data from the environment
+    #
+    # @return [AllscriptsApi:Configuration] new instance of the config class
+    def initialize
+      @app_name = ENV["app_name"]
+      @app_password = ENV["app_password"]
+      @unity_url = ENV["unity_url"]
+      @app_username = ENV["app_username"]
+      @faraday_adapter = Faraday.default_adapter
+    end
+  end
+end

data/lib/allscripts_api/magic_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  # A simple formatter for Magic Action's numbered perameters
+  class MagicParams
+    # A method for formatting data for the body of {AllscriptsApi::Client#magic}
+    # calls. Magic Actions require all arguments to be present in the HTTP call
+    # and in the correct order.
+    #
+    # @param user_id [String] id or user name of the App/User making the call
+    # @param patient_id [String, Nil] the optional id of a patient 
+    # related to the Magic call
+    # @param parameter1 [String, Nil] the optional 1st argument of the Magic call
+    # @param parameter2 [String, Nil] the optional 2nd argument of the Magic call
+    # @param parameter3 [String, Nil] the optional 3rd argument of the Magic call
+    # @param parameter4 [String, Nil] the optional 4th argument of the Magic call
+    # @param parameter5 [String, Nil] the optional 5th argument of the Magic call
+    # @param parameter6 [String, Nil] the optional 6th argument of the Magic call
+    # @param data [Hash, Nil] the optional data argument of the Magic call
+    #
+    # @return [Hash] the method returns a formatted hash containing the
+    # passed parameters and empty values for unused params
+    # @example formatting params for SearchPatients as seen in {NamedMagicMethods#search_patients}
+    #   MagicParams.format(user_id: "YOUR_APP_USERNAME, parameter1: "Smith")
+    #   => {AppUserID: "YOUR_APP_USERNAME",
+    #     PatientID: "",
+    #     Parameter1: "Smith",
+    #     Parameter2: "",
+    #     Parameter3: "",
+    #     Parameter4: "",
+    #     Parameter5: "",
+    #     Parameter6: "",
+    #     Data: {}}
+    def self.format(user_id: "", patient_id: "", parameter1: "", parameter2: "", parameter3: "", parameter4: "", parameter5: "", parameter6: "", data: {})
+      {
+        AppUserID: user_id,
+        PatientID: patient_id,
+        Parameter1: parameter1,
+        Parameter2: parameter2,
+        Parameter3: parameter3,
+        Parameter4: parameter4,
+        Parameter5: parameter5,
+        Parameter6: parameter6,
+        Data: data
+      }
+    end
+  end
+end

data/lib/allscripts_api/named_magic_methods.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  # A collection of named convenience methods that map
+  # to Allscripts magic actions. These methods are included
+  # in `AllscriptsApi::Client` and can be accessed from
+  # instances of that class.
+  module NamedMagicMethods
+    # a wrapper around SearchPatients
+    #
+    # @param search_string [String] may be a name, birthdate
+    # partial address, or other PHI
+    # @return [Array<Hash>, Array, MagicError] a list of found patients,
+    # an empty array, or an error
+    def search_patients(search_string)
+      params =
+        MagicParams.format(
+          user_id: @allscripts_username,
+          parameter1: search_string
+        )
+      results = magic("SearchPatients", magic_params: params)
+      results["searchpatientsinfo"]
+    end
+
+    # gets the CCDA documents for the specified patient and encounter
+    #
+    # @param patient_id [String] patient id
+    # @param encounter_id [String] encounter id from which to generate the CCDA
+    # @param org_id [String] specifies the organization, by default Unity
+    # uses the organization for the specified user
+    # @param app_group [String] defaults to "TouchWorks"
+    # @param referral_text [String] contents of ReferralText are appended
+    # @param site_id [String] site id
+    # @param document_type [String] document type defaults to CCDACCD,
+    # CCDACCD (Default) - Returns the Continuity of Care Document. This
+    # is the default behavior if nothing is passed in.
+    # CCDASOC - Returns the Summary of Care Document
+    # CCDACS - Returns the Clinical Summary Document (Visit Summary).
+    # @return [String, AllscriptsApi::MagicError] ccda for patient
+    def get_ccda(patient_id,
+                 encounter_id,
+                 org_id = nil,
+                 app_group = nil,
+                 referral_text = nil,
+                 site_id = nil,
+                 document_type = "CCDACCD")
+      params =
+        MagicParams.format(
+          user_id: @allscripts_username,
+          patient_id: patient_id,
+          parameter1: encounter_id,
+          parameter2: org_id,
+          parameter3: app_group,
+          parameter4: referral_text,
+          parameter5: site_id,
+          parameter6: document_type
+        )
+      results = magic("GetCCDA", magic_params: params)
+      results["getccdainfo"][0]["ccdaxml"]
+    end
+
+    # gets data elements of a patient's history
+    #
+    # @param patient_id [String] patient id
+    # @param section [String] section
+    # if no section is specified than all sections wt data are returned
+    # list multiple sections by using a pipe-delimited list ex. "Vitals|Alerts"
+    # @param encounter_id [String] internal identifier for the encounter
+    # the EncounterID can be acquired with GetEncounterList
+    # @param verbose [String] XMLDetail
+    # verbose column will be Y or blank, when Y is provided there will be a
+    # piece of XML data that is specific to that element of the patient's chart
+    # @return [String, AllscriptsApi::MagicError] clinical summary for patient
+    def get_clinical_summary(patient_id,
+                             section = nil,
+                             encounter_id = nil,
+                             verbose = nil)
+      params =
+        MagicParams.format(
+          user_id: @allscripts_username,
+          patient_id: patient_id,
+          parameter1: section,
+          parameter2: encounter_id,
+          parameter3: verbose
+        )
+      results = magic("GetClinicalSummary", magic_params: params)
+      results["getclinicalsummaryinfo"]
+    end
+
+    # gets patient's demographic info, insurance, guarantor, and PCP info
+    #
+    # @param patient_id [String] patient id
+    # @param patient_number [String] PM patient number
+    # @return [String, AllscriptsApi::MagicError] patient demographics
+    def get_patient(patient_id,
+                    patient_number = nil)
+      params =
+        MagicParams.format(
+          user_id: @allscripts_username,
+          patient_id: patient_id,
+          parameter1: patient_number
+        )
+      results = magic("GetPatient", magic_params: params)
+      results["getpatientinfo"]
+    end
+
+    # a wrapper around GetPatientProblems
+    #
+    # @param patient_id [String] patient id
+    # @param show_by_encounter [String] Y or N (defaults to `N`)
+    # @param assessed [String]
+    # @param encounter_id [String] id for a specific patient encounter
+    # @param filter_on_id [String]
+    # @param display_in_progress [String]
+    # @return [Array<Hash>, Array, MagicError] a list of found problems,
+    # an empty array, or an error
+    def get_patient_problems(patient_id,
+                             show_by_encounter = "N",
+                             assessed = nil,
+                             encounter_id = nil,
+                             filter_on_id = nil,
+                             display_in_progress = nil)
+      params = MagicParams.format(
+        user_id: @allscripts_username,
+        patient_id: patient_id,
+        parameter1: show_by_encounter,
+        parameter2: assessed,
+        parameter3: encounter_id,
+        parameter4: filter_on_id,
+        parameter5: display_in_progress
+      )
+      results = magic("GetPatientProblems", magic_params: params)
+      results["getpatientproblemsinfo"]
+    end
+  end
+end

data/lib/allscripts_api/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module AllscriptsApi
+  # gem version declaration
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: allscripts_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chase
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+- !ruby/object:Gem::Dependency
+  name: pronto
+  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'
+- !ruby/object:Gem::Dependency
+  name: pronto-rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: "The allscripts_api gem wraps a set of Allscripts APIs, including\n                          but
+  not limited to Unity. The gem focuses on JSON endpoints instead \n                          of
+  SOAP."
+email:
+- chase.gilliam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".pryrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- allscripts_api.gemspec
+- bin/console
+- bin/setup
+- code-of-conduct.md
+- lib/allscripts_api.rb
+- lib/allscripts_api/client.rb
+- lib/allscripts_api/configuration.rb
+- lib/allscripts_api/magic_params.rb
+- lib/allscripts_api/named_magic_methods.rb
+- lib/allscripts_api/version.rb
+homepage: https://github.com/Avhana/allscripts_api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A simple, configurable wrapper around Allscripts APIs
+test_files: []