akido_lib 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b8e6fcf27fb482c5a7a11574807f9b845b779115ee88b8c4df9942e5494fe82
+  data.tar.gz: 8328a4d17ac37d9514bf2326b4934d189b95e1b50494efbc83cae0883a5c55ca
+SHA512:
+  metadata.gz: 3ef0033896b726ebe9d6d404c9034758fe08b3276f917d94adcdb9de2def7e83b62ab9c7ec55dfc0c8a6b24f8f87eaa64bea72af6f1741c9b3df68c604b5ae4e
+  data.tar.gz: fcc636945b3a9bebb88c32bc1f8d5c2258f316d87609b8ed48b682eca02c3a15983170352125bc80d1554b34bc2b0f956f6072ec09923d1e9551fcc37ec63da1

data/README.md

@@ -0,0 +1,135 @@
+# AkidoLib
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'akido_lib'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install akido_lib
+```
+
+## Extra Classes/Methods
+### `AkidoLib::Bundle`
+We're liable to add some utility methods to `AkidoLib::Bundle`, since it's the
+main entry point into what comes back from the server.
+
+#### Methods
+* `#to_a`
+
+  `Bundle#to_a` works exactly as you'd expect: the full bundle is read from the 
+  server, and then turned into an array. Useful for when you want to call `#map` 
+  or `#select` on what gets returned in a bundle.
+
+
+
+### `AkidoLib::Query`
+`Query` exists to bridge the gap between `FHIR::Client` and ActiveRecord-y
+syntax, which most Rails developers seem to think in. Its syntax should be 
+familiar to those familiar with `ActiveRecord::Relation`, specifically `#all` 
+and `#where`. 
+
+#### Methods
+##### Class Methods
+* `.set_base_url!(base_url)`
+  
+  Ordinarily, new Queries reach back to `FHIR::Model.client` to get their base 
+  URL, but if it isn't set, or if you just want to overwrite it, you can do so.
+
+* `.new(resource, base_url)`
+
+  You probably won't call this method — most Queries will be created using
+  methods on `FHIR::Model`. 
+  
+  When a Query is created, it needs two things to be meaningful: a base URL to 
+  hit, and the name of a FHIR resource. This method takes both as arguments. The 
+  resource name is required, but `base_url` is optional — if `base_url` is set 
+  on `AkidoLib::Query`, that will be used, otherwise  it will default to the base 
+  URL set on `AkidoLib::Model.client`. 
+
+##### Instance Methods
+* `#where(conditions)`
+
+  The `where` method is the main entry point for adding constraints to the
+  query. It accepts all of the
+  [parameters](https://www.hl7.org/fhir/search.html#all) for FHIR searching,
+  with the caveat that parameter names should be written as Ruby-style symbols, without the
+  leading underscore and in `snake_case` instead of `camelCase` — e.g.
+  `_lastUpdated` becomes `:last_updated`. 
+
+
+* `#last_updated(date)`
+  
+  `#where` has the advantage of being able to set more than one property at a
+  time, but the disadvantage that it doesn't cast any of the values to be more
+  palatable to the server. Because of how precise FHIR servers can be about
+  their date requirements, `#last_updated` is a convenience method that lets you
+  pass a date, then sets `_lastUpdated` to the XML-encoded version of that date.
+
+* `#include(relation)`
+  
+  Shorthand for adding `_include=[Relation]` to your query. Takes a sting, e.g.
+  `'Encounter:Patient'`. Can take option after the name of the relation to
+  include. There is currenlty one option implemented: passing `:rev => true`
+  will insert the relation as a `_revinclude` instead of an `_include`.
+  ```
+  AkidoLib::Encounter.where(:last_updated =>2.weeks.ago).include("Encounter:Patient")
+  ```
+
+* `#custom(key, value)`
+
+  `#where` is prescriptive — it has opinions about how query keys should looks
+  (i.e. they should be preceded with an underscore, they should be camelCase,
+  etc.). `#custom` has no such prescriptions: whatever you pass in will be
+  assigned to the query as a key and a value.
+
+
+* `#fetch!`
+  
+  Intended to be the last method called on a chain of queries. Will execute the
+  query to which it is attached, and return the `AkidoLib::Bundle` that comes
+  back from the server. 
+  
+  _Note: one of two `Query` methods that doesn't itself return a `Query`
+  (returns an `AkidoLab::Bundle`)._
+
+* `#url`
+
+  Sometimes you just need to peer into the inner workings of `Query` and see
+  what it's doing, maybe to paste a URL into Postman or `curl`. This is
+  precisely that utility method. 
+
+  _Note: the second of two `Query` methods that doesn't return a `Query`
+  (returns a string)._ 
+
+### `AkidoLib::Model`
+
+`AkidoLib::Model` is another one of those classes that we'll periodically open
+up to add new functionality. For now, the main thing is adding methods that
+return `AkidoLib::Query` objects. 
+
+#### Methods
+* `#all`
+
+  When called on a FHIR model, `#all` will return an `AkidoLib::Query` object
+  pointed at the base level of that resource — e.g. `FHIR::Encounter.all` will 
+  return a `Query` with a URL of `<BaseURL>/Encounter`
+  
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AkidoLib'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/akido_lib.rb

@@ -0,0 +1,21 @@
+require 'fhir_client'
+require 'redis-objects'
+
+require_relative 'akido_lib/version'
+require_relative './ext/rest_client'
+
+require_relative './bundle'
+require_relative './caching'
+require_relative './query'
+
+module AkidoLib
+  include FHIR
+
+  def self.setup(base_url, server_config = {})
+    self::Model.client = AkidoLib::Client.new(base_url)
+
+    self::Model.client.default_format = FHIR::Formats::ResourceFormat::RESOURCE_XML_DSTU2
+
+    RestClient.set_config(server_config)
+  end
+end

data/lib/akido_lib/version.rb

@@ -0,0 +1,3 @@
+module AkidoLib
+  VERSION = '0.2.0'
+end

data/lib/bundle.rb

@@ -0,0 +1,9 @@
+module FHIR
+  class Bundle
+    def to_a
+      array = @entry.map(&:resource)
+      array += next_bundle if next_bundle
+      array
+    end
+  end
+end

data/lib/caching.rb

@@ -0,0 +1,42 @@
+module AkidoLib
+  module ReferenceInstanceExtensions
+    def read
+      model, id = reference.match(/(\D+)\/(\d+)/).captures
+      cached_models = Redis::HashKey.new(model)
+      if matching_cached_model = cached_models[id]
+        return "FHIR::#{model}".constantize.new(JSON.parse(matching_cached_model))
+      else
+        model = super
+        cached_models[model.id] = model.to_json
+        return model
+      end
+    end
+  end
+
+  module ModelClassExtensions
+    def cache!
+      model = self.to_s.demodulize
+      cache = Redis::HashKey.new(model)
+
+      records = self.search.to_a
+      records.each do |record|
+        cache[record.id] = record.to_json
+
+      end
+    end
+
+    def cached
+      model = self.class.to_s.demodulize
+
+      Redis::HashKey.new(model).values.map do |record|
+        self.new(JSON.parse(record))
+      end
+    end
+  end
+end
+
+class FHIR::Reference
+  prepend AkidoLib::ReferenceInstanceExtensions
+end
+
+FHIR::Model.singleton_class.prepend AkidoLib::ModelClassExtensions

data/lib/ext/rest_client.rb

@@ -0,0 +1,45 @@
+module RestClient
+  @@config = {}
+
+  def self.get_config
+    @@config
+  end
+
+  def self.set_config(**config)
+    config.each do |key, value|
+      @@config[key] = value unless key == :url || key == :method
+    end
+  end
+
+  def self.clear_config
+    @@config = {}
+  end
+
+  def self.get(url, headers={}, &block)
+    Request.execute(:method => :get, :url => url, :headers => headers, **@@config, &block)
+  end
+
+  def self.post(url, payload, headers={}, &block)
+    Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers, **@@config, &block)
+  end
+
+  def self.patch(url, payload, headers={}, &block)
+    Request.execute(:method => :patch, :url => url, :payload => payload, :headers => headers, **@@config, &block)
+  end
+
+  def self.put(url, payload, headers={}, &block)
+    Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers, **@@config, &block)
+  end
+
+  def self.delete(url, headers={}, &block)
+    Request.execute(:method => :delete, :url => url, :headers => headers, **@@config, &block)
+  end
+
+  def self.head(url, headers={}, &block)
+    Request.execute(:method => :head, :url => url, :headers => headers, **@@config, &block)
+  end
+
+  def self.options(url, headers={}, &block)
+    Request.execute(:method => :options, :url => url, :headers => headers, **@@config, &block)
+  end
+end

data/lib/generators/akido/setup_generator.rb

@@ -0,0 +1,12 @@
+module Akido
+  module Generators
+    class SetupGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def install_initializer
+        template 'initializer.rb', 'config/initializers/akido.rb'
+      end
+    end
+  end
+end
+

data/lib/generators/akido/templates/initializer.rb

@@ -0,0 +1,19 @@
+config = {
+  :ssl_ca_file => "#{Rails.root}/config/ssl/ca.cert.pem"
+}
+
+if (cert_path = ENV["SSL_CERT_PATH"]) && 
+    File.exist?("#{Rails.root}/#{cert_path}")
+  raw_cert = File.read("#{Rails.root}/#{cert_path}")
+  cert = OpenSSL::X509::Certificate.new(raw_cert)
+  config[:ssl_client_cert] = cert
+end
+
+if (key_path = ENV['SSL_KEY_PATH']) &&
+    File.exist?("#{Rails.root}/#{key_path}")
+  raw_key = File.read("#{Rails.root}/#{key_path}")
+  key = OpenSSL::PKey::RSA.new(raw_key, ENV['SSL_KEY_PASSPHRASE'])
+  config[:ssl_client_key] = key
+end
+
+AkidoLib.setup(ENV['PLATFORM_URL'], config)

data/lib/query.rb

@@ -0,0 +1,86 @@
+module AkidoLib
+  class Query
+    FILTERS = [
+      :content, 
+      :id, 
+      :last_updated, 
+      :profile, 
+      :query, 
+      :security, 
+      :tag,
+      :text,
+      :filter
+    ]
+
+    def initialize(resource, base_url)
+      @base_url = if base_url
+                    base_url
+                  elsif @@base_url
+                    @@base_url
+                  else
+                    AkidoLib::Model
+                      .client
+                      .full_resource_url(:resource => @model)
+                  end
+
+      @resource = resource
+      @query = []
+    end
+
+    def where(filters)
+      filters.each do |filter, value|
+        if FILTERS.include?(filter.to_s.underscore.downcase.to_sym)
+          @query.push({ "_#{filter.to_s.camelize(:lower)}".to_sym => value })
+        end
+      end
+
+      return self
+    end
+
+    def include(relation, options)
+      key = if options[:rev]
+              :_revinclude
+            else
+              :_include
+            end
+
+      @query.push({key => relation})
+    end
+
+    def last_updated(date)
+      @query.push({:_lastUpdated => date.xmlschema})
+    end
+
+    def custom(key, value)
+      @query.push({key => value})
+    end
+
+    def unset(key)
+      key = "_#{key.to_s.camelize(:lower)}".to_sym
+
+      @query.reject! do |param| 
+        param.keys.include?(key)
+      end
+    end
+
+    def url
+      "#{@base_url}/#{resource_name}?#{query_string}"
+    end
+
+    def fetch!
+    end
+    
+    def self.set_base_url!(base_url)
+      @@base_url = base_url
+    end
+
+    private
+    def resource_name
+      @resource.to_s.demodulize
+    end
+
+    def query_string
+      @query.map(&:to_query).join("&")
+    end
+  end
+end

data/lib/rest_client_config.rb

@@ -0,0 +1,45 @@
+module RestClient
+  @@config = {}
+
+  def self.get_config
+    @@config
+  end
+
+  def self.set_config(**config)
+    config.each do |key, value|
+      @@config[key] = value unless key == :url || key == :method
+    end
+  end
+
+  def self.clear_config
+    @@config = {}
+  end
+
+  def self.get(url, headers={}, &block)
+    Request.execute(:method => :get, :url => url, :headers => headers, **@@config, &block)
+  end
+
+  def self.post(url, payload, headers={}, &block)
+    Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers, **@@config, &block)
+  end
+
+  def self.patch(url, payload, headers={}, &block)
+    Request.execute(:method => :patch, :url => url, :payload => payload, :headers => headers, **@@config, &block)
+  end
+
+  def self.put(url, payload, headers={}, &block)
+    Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers, **@@config, &block)
+  end
+
+  def self.delete(url, headers={}, &block)
+    Request.execute(:method => :delete, :url => url, :headers => headers, **@@config, &block)
+  end
+
+  def self.head(url, headers={}, &block)
+    Request.execute(:method => :head, :url => url, :headers => headers, **@@config, &block)
+  end
+
+  def self.options(url, headers={}, &block)
+    Request.execute(:method => :options, :url => url, :headers => headers, **@@config, &block)
+  end
+end

data/lib/tasks/akido_lib_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :akido_lib do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: akido_lib
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Dean Tambling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+- !ruby/object:Gem::Dependency
+  name: fhir_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Description of AkidoLib.
+email:
+- dean.tambling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/akido_lib.rb
+- lib/akido_lib/version.rb
+- lib/bundle.rb
+- lib/caching.rb
+- lib/ext/rest_client.rb
+- lib/generators/akido/setup_generator.rb
+- lib/generators/akido/templates/initializer.rb
+- lib/query.rb
+- lib/rest_client_config.rb
+- lib/tasks/akido_lib_tasks.rake
+homepage: http://akidolabs.com
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Summary of AkidoLib.
+test_files: []