lifen_fhir 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1db22fe4077504ea3f23585828eb697f22763c39
+  data.tar.gz: 5fcccdd90ef76bea15800c296280788d02c3f168
+SHA512:
+  metadata.gz: 392a47b43059e7eb3f844f7ab5244290697b815734db38403c895f2acba03d52f75bd45e52ae91732535be5d6a84e22da3e2e8b4cb362acbc5120a7c2f2ce2d0
+  data.tar.gz: 6ca727e4b24cdbeda29c4b00ade9223700109dfc3e2904f7ff366ac460c0966e5ada293439a0956ef702dce97ad23df74febc81ffadef47d66781750685adf75

data/.gitignore

@@ -0,0 +1,17 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+0.1.1
+-----
+
+- Fixed incorrect domain name
+
+0.1.0
+-----
+
+- Lifen is on FHIR !

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    lifen_fhir (0.1.1)
+      faraday (>= 0.9)
+      inflecto
+      virtus (>= 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    awesome_print (1.7.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    faraday (0.12.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.4)
+    ice_nine (0.11.2)
+    inflecto (0.0.2)
+    multipart-post (2.0.0)
+    public_suffix (2.0.5)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.6)
+    vcr (3.0.3)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.12)
+  lifen_fhir!
+  rake (~> 10.5)
+  rspec (~> 3.5)
+  vcr (~> 3.0)
+  webmock (~> 1.24)
+
+BUNDLED WITH
+   1.14.6

data/License.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Honestica
+
+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,131 @@
+# Lifen
+
+Lifen is a Ruby client for [Lifen](http://developers.lifen.fr/) FHIR API (over JSON).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lifen_fhir'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lifen_fhir
+
+## Usage
+
+### Configuration
+
+Lifen can be configured (ideally inside an initializer) like so:
+
+```ruby
+LifenFhir.configure do |config|
+  config.site                      = "https://demo.lifen.fr/"
+  config.application_access_token  = "application_access_token"
+
+  # optionnal
+  config.proxy_url                 = "http://my.proxy.fr/"
+end
+```
+
+Optionnal configuration:
+
+- `proxy_url`: enables you to route all your requests via a proxy
+
+### Internal
+
+#### Managing a Binary
+
+```ruby
+binary = LifenFhir::Binary.new(uuid: "b7c7dae671b93e951ce6a4f530736276")
+binary.download
+```
+
+### Communication Request
+
+```ruby
+sender = LifenFhir::Practitioner.find_by_rpps("899900018483")
+
+recipient = LifenFhir::Practitioner.find_by_rpps("899900018484")
+channel = recipient.channels.first
+
+binary = LifenFhir::Binary.new(uuid: "b7c7dae671b93e951ce6a4f530736276")
+
+communication_request = LifenFhir::CommunicationRequest.new(sender: sender, recipient: recipient, channel: channel, binary: binary, patient: patient, category: category)
+
+communication_request.send
+
+```
+
+#### Communication Request with multiple recipients
+
+```ruby
+sender = LifenFhir::Practitioner.find_by_rpps("899900018483")
+
+recipient = LifenFhir::Practitioner.find_by_rpps("899900018484")
+medium = LifenFhir::Medium(uuid: recipient.channels.first.uuid)
+
+other_recipient = LifenFhir::Practitioner.find_by_rpps("899900018484")
+other_medium = LifenFhir::Medium(uuid: other_recipient.channels.first.uuid)
+
+binary = LifenFhir::Binary.new(uuid: "b7c7dae671b93e951ce6a4f530736276")
+
+communication_request_request = LifenFhir::CommunicationRequest.new(sender: sender, recipients: [recipient, other_recipient], medium: [medium, other_medium], binary: binary, patient: patient, category: category)
+
+communication_request_request.send
+
+```
+
+#### Custom Channels management
+
+```ruby
+recipient = LifenFhir::Practitioner.new(uuid: "valid-user-uuid")
+
+# To create a new mailing address channel
+channel = recipient.create_address(type: "address", lines: ["39 rue Aboukir"], city: "Paris", postal_code: "75002", country: "France")
+
+# To create a new telecom channel fax
+channel = recipient.create_telecom(type: "telecom", system: "fax", value: "+33102030405")
+```
+
+## Deploying to Rubygems
+
+Once the new version is validated, the deployment follows those steps :
+
+1. update `lib/lifen/version.rb`
+2. run `bundle install` to update `Gemfile.lock`
+3. update `CHANGELOG.md` with the additional features of the new version
+4. commit changes to Github
+5. build the gem using `gem build lifen_fhir.gemspec`
+6. publish the gem using `gem publish lifen_fhir-X.X.X.gem`
+7. run `bundle update lifen` in related projects :)
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016-2017 Honestica
+
+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/lib/lifen_fhir/app_authenticated_client.rb

@@ -0,0 +1,38 @@
+module LifenFhir
+
+  class AppAuthenticatedClient < Client
+
+    private
+
+      def handle_errors(response, params)
+        super(response, params)
+
+        case response.status
+        when 400
+          raise Error, "Error 400, Unknown error, #{response_error(response, params)}"
+        when 401
+          raise InvalidSecretTokenError, "Error 401, Invalid app bearer, #{response_error(response, params)}"
+        when 403
+          raise UserAlreadyExistingError, "Error 403, User already existing, #{response_error(response, params)}"
+        when 404
+          raise Error, "Error 404, Page not found, #{response_error(response, params)}"
+        when 422
+          json = JSON.parse response.body
+
+          diagnostic = json["issue"][0]["diagnostics"]
+
+          raise Error, "Error 422, Unprocessable Entity, Diagnostic: '#{diagnostic}', #{response_error(response, params)}"
+        end
+
+      end
+
+      def response_error(response, params)
+        "App Client, #{super(response, params)}"
+      end
+
+      def bearer
+        LifenFhir.configuration.application_access_token
+      end
+
+  end
+end

data/lib/lifen_fhir/attachment.rb

@@ -0,0 +1,26 @@
+module LifenFhir
+
+  class Attachment < Base
+
+    attribute :title, String
+    attribute :path, String
+    attribute :content_type, String
+
+    def fhir_payload
+      {
+        contentAttachment: {
+          data: base_64_encoded_content,
+          title: title,
+          contentType: "{#{content_type}}"
+        }
+      }
+    end
+
+    private
+
+      def base_64_encoded_content
+        Base64.encode64(File.open(path, "rb").read)
+      end
+
+  end
+end

data/lib/lifen_fhir/base.rb

@@ -0,0 +1,7 @@
+module LifenFhir
+  class Base
+
+    include Virtus.model
+
+  end
+end

data/lib/lifen_fhir/binary.rb

@@ -0,0 +1,29 @@
+module LifenFhir
+  class Binary < Base
+
+    attribute :uuid, String
+
+    def fhir_payload
+      {
+        contentReference: {
+          reference: reference
+        }
+      }
+    end
+
+    def download
+      application_client.get("fhir/#{reference}", { accept: "application/pdf" })
+    end
+
+    private
+
+      def application_client
+        @application_client ||= AppAuthenticatedClient.new
+      end
+
+      def reference
+        "Binary/#{uuid}"
+      end
+
+  end
+end

data/lib/lifen_fhir/category.rb

@@ -0,0 +1,26 @@
+module LifenFhir
+  class Category < Base
+
+    CODES = ["MEDICAL_REPORT", "MESSAGE", "MEDICATION_ORDER", "REFERRAL_REQUEST", "OTHER"]
+
+    attribute :code, String, default: "MEDICAL_REPORT"
+
+    def fhir_payload
+      raise LifenFhir::Error, "Invalid category: code must be in the authorized values" if !valid?
+
+      {
+        coding: [
+           {
+              system: "http://honestica.com/fhir/communication/category",
+              code: code
+           }
+        ]
+      }
+    end
+
+    def valid?
+      CODES.include? code
+    end
+
+  end
+end

data/lib/lifen_fhir/channel.rb

@@ -0,0 +1,31 @@
+module LifenFhir
+  class Channel < Base
+
+    attribute :uuid, String
+    attribute :type, String
+    attribute :value, String
+
+    def fhir_payload(user)
+      raise LifenFhir::Error, "Invalid channel: an UUID is required" if !valid?
+
+      {
+        id: user.uuid,
+        resourceType: "Practitioner",
+        type => [
+          {
+            id: uuid
+          }
+        ]
+      }
+    end
+
+    def valid?
+      uuid and uuid.length != 0
+    end
+
+    def self.from_json(json, type = nil)
+      new(uuid: json["id"], type: type, value: json["value"] || "#{Array(json["line"]).join(", ")}, #{json["postalCode"]} #{json["city"]}")
+    end
+
+  end
+end

data/lib/lifen_fhir/client.rb

@@ -0,0 +1,107 @@
+module LifenFhir
+  class Client
+
+    def request(mode, url, params = {})
+      before_request
+
+      response = faraday_client.send(mode) do |req|
+        req.url url
+
+        req.headers['Authorization']      = "Bearer #{bearer}"
+        req.headers['Accept']             =  use_and_remove_accept(params)
+
+        if mode == :post
+          req.headers['Content-Type']     = "application/json"
+        end
+
+        req.body = JSON.generate(params)
+      end
+
+      handle_errors(response, params)
+
+      handle_response(response)
+    end
+
+    def post(url, params = {})
+      request(:post, url, params)
+    end
+
+    def put(url, params = {})
+      request(:put, url, params)
+    end
+
+    def get(url, params = {})
+      request(:get, url, params)
+    end
+
+    private
+
+      def handle_errors(response, params)
+        if response.status == 500
+
+          json = JSON.parse response.body
+
+          trace_id = json.fetch("X-B3-TraceId", "unknown")
+
+          raise Error, "Error 500, Internal server error (trace ID: #{trace_id}), #{response_error(response, params)}"
+        end
+      end
+
+      def handle_response(response)
+        if response.headers['Content-Type'].match "json"
+          JSON.parse response.body
+        else
+          response.body
+        end
+      end
+
+      def faraday_client
+        @faraday_client ||= Faraday.new(faraday_options) do |faraday|
+          faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        end
+      end
+
+      def faraday_options
+        options = {url: site}
+
+        options[:proxy] = proxy_url if !proxy_url.nil?
+
+        options
+      end
+
+      def site
+        LifenFhir.configuration.site
+      end
+
+      def proxy_url
+        LifenFhir.configuration.proxy_url
+      end
+
+      def before_request
+      end
+
+      def response_error(response, params)
+        params[:payload] = "filtered" if params.is_a?(Hash) and params.has_key? :payload
+
+        "#{response.env.method.upcase} '#{response.env.url}' with params '#{params.inspect}' and bearer '#{trucanted_bearer}'"
+      end
+
+      def trucanted_bearer
+        if m = /^(.{24})(.*)$/.match(bearer)
+          "#{m[1]}#{"*" * m[2].length}"
+        else
+          bearer
+        end
+      end
+
+      def bearer
+        raise "A bearer method must be defined"
+      end
+
+      def use_and_remove_accept(params)
+        return params.delete :accept if params.is_a?(Hash) and params.has_key? :accept
+
+        "application/json"
+      end
+  end
+end

data/lib/lifen_fhir/communication_request.rb

@@ -0,0 +1,67 @@
+module LifenFhir
+  class CommunicationRequest < Base
+
+    attribute :uuid, String
+    attribute :number_communications, Integer
+
+    attribute :sender, LifenFhir::Practitioner
+    attribute :recipients, [LifenFhir::Practitioner]
+
+    attribute :category, LifenFhir::Category, default: LifenFhir::Category.new
+    attribute :medium, [LifenFhir::Medium]
+    attribute :patient, LifenFhir::Patient
+    attribute :attachment, LifenFhir::Attachment
+    attribute :binary, LifenFhir::Binary
+    attribute :content_string, LifenFhir::ContentString
+
+    def send
+      json = application_client.post("fhir/CommunicationRequest", fhir_payload)
+
+      self.uuid = json["id"]
+      self.number_communications = Array(json["issue"]).length
+
+      self
+    end
+
+  private
+
+    def fhir_payload
+
+      payload = {
+        resourceType: "CommunicationRequest",
+        sender: [ sender.fhir_payload ],
+        recipient: recipients.map(&:fhir_payload),
+        contained: [],
+        medium: medium.map(&:fhir_payload) ,
+        category: [ category.fhir_payload],
+        payload: [ document_content ]
+      }
+
+      if patient
+        payload[:contained] << patient.fhir_payload
+        payload[:subject] = [
+          {reference: "patient"}
+        ]
+      end
+
+      if content_string
+        payload[:payload] << content_string.fhir_payload
+      end
+
+      payload
+    end
+
+    def document_content
+      if !attachment.nil?
+        attachment.fhir_payload
+      else
+        binary.fhir_payload
+      end
+    end
+
+    def application_client
+      @application_client ||= AppAuthenticatedClient.new
+    end
+
+  end
+end

data/lib/lifen_fhir/configuration.rb

@@ -0,0 +1,22 @@
+module LifenFhir
+  class Configuration
+
+    attr_accessor :site, :application_access_token, :proxy_url
+
+    def site=(url)
+      if !/(.*)\/$/.match(url)
+        raise LifenFhir::Error, "Invalid 'site' provided in configuration: '#{url}', a trailing slash is missing"
+      end
+
+      @site = url
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+end

data/lib/lifen_fhir/content_string.rb

@@ -0,0 +1,15 @@
+module LifenFhir
+
+  class ContentString < Base
+
+    attribute :text, String
+
+    def fhir_payload
+      {
+        contentString: text
+
+      }
+    end
+
+  end
+end

data/lib/lifen_fhir/error.rb

@@ -0,0 +1,27 @@
+module LifenFhir
+
+  class Error < StandardError
+  end
+
+  class UnauthorizedError < Error
+  end
+
+  class InvalidCredentialsError < Error
+  end
+
+  class InvalidParamsError < Error
+  end
+
+  class InvalidSecretTokenError < Error
+  end
+
+  class InvalidTokenError < Error
+  end
+
+  class UserAlreadyExistingError < Error
+  end
+
+  class CantRefreshTokenError < Error
+  end
+
+end

data/lib/lifen_fhir/medium.rb

@@ -0,0 +1,15 @@
+module LifenFhir
+  class Medium < Base
+
+    attribute :uuid, String
+
+    def fhir_payload
+      {
+        coding:[{
+          id: uuid
+        }]
+      }
+    end
+
+  end
+end