lifen_fhir 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 444903207c6344dafb7a9fc38f6bec501fa136c4
-  data.tar.gz: 823d8c0d7bd31e27c15f6d39cc31ebdf8d2ecd35
+  metadata.gz: 4f268ed9c624f69baa94cf0c7b9ad04cf5778ffc
+  data.tar.gz: cfdeb52172b4385d3fce6a0a1f497931156669d2
 SHA512:
-  metadata.gz: 4bc7ee300eb9427f5100c08e996e406d2d14a4235b8e4340543c065c727a656dae4c610e731e174f532fe8bbbd67a9eb4f8605598ec2b3a14b4a81952f929001
-  data.tar.gz: c6a2b3e3baf246bc3494e1e7feff523b14563f31a325bfe8a743e6d391ea5912626c0a2a85bfcad28a90301c89efc7b844d53dfbaaaf900e65ed5636e68fa5bb
+  metadata.gz: '003841d9ab0e8df08ae247d1c5d7c9b05c42e095af4c6c298778e1de768527f0f697679f95249a516e39240093cfb79d0aa3e1e8711d0ea59c012bce2b6185d3'
+  data.tar.gz: f05094f969f7c04dd8b8b5ba7774c89c21c6e84870b44a291bcac42cf5a9e9c91c394389d733c662d5aa04306e381e29060fcbf0a5e663c610cd91f48299e007

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.5.0
+-----
+
+- Added custom logger and rails logger integration
+
 0.4.2
 -----
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifen_fhir (0.4.2)
+    lifen_fhir (0.5.0)
       faraday (>= 0.9)
       inflecto
       virtus (>= 1.0)

data/README.md

@@ -31,12 +31,14 @@ LifenFhir.configure do |config|
 
   # optionnal
   config.proxy_url                 = "http://my.proxy.fr/"
+  config.logger                    = Logger.new
 end
 ```
 
 Optionnal configuration:
 
-- `proxy_url`: enables you to route all your requests via a proxy
+- `proxy_url`: route all your requests via a proxy
+- `logger`: log all requests to a custom logger (on Rails, `Rails.logger` is selected automatically)
 
 ### Internal
 

data/lib/lifen_fhir/client.rb

@@ -1,6 +1,8 @@
 module LifenFhir
   class Client
 
+    LOGGED_INFO_STATUS = [200, 201]
+
     def request(mode, url, params = {})
       before_request
 
@@ -17,6 +19,7 @@ module LifenFhir
         req.body = JSON.generate(params)
       end
 
+      handle_logger(response)
       handle_errors(response, params)
 
       handle_response(response)
@@ -47,6 +50,14 @@ module LifenFhir
         end
       end
 
+      def handle_logger(response)
+        if LOGGED_INFO_STATUS.include? response.status
+          logger.info "*** [LIFEN] Success on #{response.env.method.upcase} '#{response.env.url}'"
+        else
+          logger.fatal "*** [LIFEN] #{response.status} Error on #{response.env.method.upcase} '#{response.env.url}'"
+        end
+      end
+
       def handle_response(response)
         if response.headers['Content-Type'].match "json"
           JSON.parse response.body
@@ -77,6 +88,10 @@ module LifenFhir
         LifenFhir.configuration.proxy_url
       end
 
+      def logger
+        LifenFhir.configuration.logger
+      end
+
       def before_request
       end
 

data/lib/lifen_fhir/configuration.rb

@@ -1,7 +1,19 @@
 module LifenFhir
   class Configuration
 
-    attr_accessor :site, :application_access_token, :proxy_url
+    attr_accessor :site
+
+    attr_accessor :application_access_token
+
+    attr_accessor :proxy_url
+
+    # Logger used by Lifen FHIR. In Rails, this is the Rails logger, otherwise
+    # Lifen FHIR provides its own LifenFhir::Logger.
+    attr_accessor :logger
+
+    def initialize
+      self.logger = ::LifenFhir::Logger.new(STDOUT)
+    end
 
     def site=(url)
       if !/(.*)\/$/.match(url)

data/lib/lifen_fhir/integrations/rails.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module LifenFhir
+  class Rails < ::Rails::Railtie
+
+    config.before_initialize do
+      LifenFhir.configuration.logger = ::Rails.logger
+    end
+
+  end
+end

data/lib/lifen_fhir/integrations/railties.rb

@@ -0,0 +1 @@
+require 'lifen_fhir/integrations/rails'

data/lib/lifen_fhir/logger.rb

@@ -0,0 +1,18 @@
+require 'logger'
+
+module LifenFhir
+  class Logger < ::Logger
+    LOG_PREFIX = "*** [LIFEN] ".freeze
+    PROGNAME   = "lifen_fhir".freeze
+
+    def initialize(*)
+      super
+      @level = ::Logger::INFO
+      original_formatter = ::Logger::Formatter.new
+      @default_formatter = proc do |severity, datetime, _progname, msg|
+        msg = "#{LOG_PREFIX}#{msg}"
+        original_formatter.call(severity, datetime, PROGNAME, msg)
+      end
+    end
+  end
+end

data/lib/lifen_fhir/version.rb

@@ -1,3 +1,3 @@
 module LifenFhir
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/lifen_fhir.rb

@@ -19,6 +19,7 @@ module LifenFhir
 
   require "lifen_fhir/version"
 
+  require 'lifen_fhir/logger'
   require 'lifen_fhir/error'
   require 'lifen_fhir/client'
   require 'lifen_fhir/user_authenticated_client'
@@ -41,4 +42,29 @@ module LifenFhir
 
   Virtus.finalize
 
+  AVAILABLE_INTEGRATIONS = %w(railties).freeze
+
+  class << self
+    extend Forwardable
+
+    def_delegators :logger
+
+    def inject
+      integrations_to_load = LifenFhir::AVAILABLE_INTEGRATIONS
+
+      integrations_to_load &= Gem.loaded_specs.keys
+      integrations_to_load.each do |integration|
+        load_integration(integration)
+      end
+    end
+
+    def load_integration(integration)
+      require "lifen_fhir/integrations/#{integration}"
+    rescue Exception => error
+      logger.warn "Unable to load lifen_fhir/integrations/#{integration}: #{error}"
+    end
+  end
+
 end
+
+LifenFhir.inject

data/spec/cassettes/logger/invalid.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://develop.lifen.fr/invalid
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      User-Agent:
+      - Faraday v0.11.0
+      Authorization:
+      - Bearer valid_application_access_token
+      Accept:
+      - application/pdf
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - nginx/1.6.2
+      Date:
+      - Wed, 05 Apr 2017 12:08:41 GMT
+      Content-Type:
+      - application/xml+fhir;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-B3-Sampled:
+      - '1'
+      X-B3-Spanid:
+      - fb30b5b1b27d94fe
+      X-B3-Traceid:
+      - fb30b5b1b27d94fe
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Cache-Control:
+      - no-cache, no-store, max-age=0, must-revalidate
+      Pragma:
+      - no-cache
+      Expires:
+      - '0'
+      X-Powered-By:
+      - HAPI FHIR 2.2 REST Server (FHIR Server; FHIR 1.0.2/DSTU2)
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: |-
+    http_version:
+  recorded_at: Wed, 05 Apr 2017 12:08:41 GMT
+recorded_with: VCR 3.0.3

data/spec/cassettes/logger/valid.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://develop.lifen.fr/valid
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      User-Agent:
+      - Faraday v0.11.0
+      Authorization:
+      - Bearer valid_application_access_token
+      Accept:
+      - application/pdf
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: Success
+    headers:
+      Server:
+      - nginx/1.6.2
+      Date:
+      - Wed, 05 Apr 2017 12:08:41 GMT
+      Content-Type:
+      - application/xml+fhir;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-B3-Sampled:
+      - '1'
+      X-B3-Spanid:
+      - fb30b5b1b27d94fe
+      X-B3-Traceid:
+      - fb30b5b1b27d94fe
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Cache-Control:
+      - no-cache, no-store, max-age=0, must-revalidate
+      Pragma:
+      - no-cache
+      Expires:
+      - '0'
+      X-Powered-By:
+      - HAPI FHIR 2.2 REST Server (FHIR Server; FHIR 1.0.2/DSTU2)
+      Access-Control-Allow-Credentials:
+      - 'true'
+    body:
+      encoding: UTF-8
+      string: |-
+    http_version:
+  recorded_at: Wed, 05 Apr 2017 12:08:41 GMT
+recorded_with: VCR 3.0.3

data/spec/logger_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe LifenFhir::Logger do
+
+  context "stand alone usage" do
+    it "logs to a given IO" do
+      stringio = StringIO.new
+      log = LifenFhir::Logger.new(stringio)
+
+      log.fatal("Une erreur est survenue")
+
+      expect(stringio.string).to end_with("FATAL -- lifen_fhir: *** [LIFEN] Une erreur est survenue\n")
+    end
+  end
+
+
+  context 'client usage' do
+
+    let(:client)    { LifenFhir::AppAuthenticatedClient.new }
+    let(:stringio)  { StringIO.new }
+
+    before do
+      LifenFhir.configure do |config|
+        config.logger = Logger.new(stringio)
+      end
+    end
+
+    it "logs to a given logger" do
+      begin
+        VCR.use_cassette "logger/invalid" do
+          client.get("/invalid")
+        end
+      rescue LifenFhir::Error => e
+
+      end
+
+      expect(stringio.string).to end_with("FATAL -- : *** [LIFEN] 404 Error on GET 'https://develop.lifen.fr/invalid'\n")
+    end
+
+    context 'with a success response' do
+
+      it "logs to a given logger with info level" do
+        VCR.use_cassette "logger/valid" do
+          client.get("/valid")
+        end
+
+        expect(stringio.string).to end_with("INFO -- : *** [LIFEN] Success on GET 'https://develop.lifen.fr/valid'\n")
+      end
+
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -31,6 +31,7 @@ RSpec.configure do |c|
     LifenFhir.configure do |config|
       config.site = "https://develop.lifen.fr/"
       config.application_access_token = "valid_application_access_token"
+      config.logger = Logger.new(nil)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lifen_fhir
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Leonard Sellam
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -210,6 +210,9 @@ files:
 - lib/lifen_fhir/content_string.rb
 - lib/lifen_fhir/element.rb
 - lib/lifen_fhir/error.rb
+- lib/lifen_fhir/integrations/rails.rb
+- lib/lifen_fhir/integrations/railties.rb
+- lib/lifen_fhir/logger.rb
 - lib/lifen_fhir/medium.rb
 - lib/lifen_fhir/patient.rb
 - lib/lifen_fhir/practitioner.rb
@@ -231,6 +234,8 @@ files:
 - spec/cassettes/communication_request/send/unknown_recipient.yml
 - spec/cassettes/communication_request/send/valid_attributes.yml
 - spec/cassettes/communication_request/send/valid_attributes_binary.yml
+- spec/cassettes/logger/invalid.yml
+- spec/cassettes/logger/valid.yml
 - spec/cassettes/patient/create/invalid_attributes.yml
 - spec/cassettes/patient/create/with_all_information.yml
 - spec/cassettes/patient/create/with_first_name_as_a_string.yml
@@ -246,6 +251,7 @@ files:
 - spec/cassettes/practitioner/find_by_rpps/wrong_rpps.yml
 - spec/category_spec.rb
 - spec/communication_request_spec.rb
+- spec/logger_spec.rb
 - spec/patient_spec.rb
 - spec/practitioner_spec.rb
 - spec/reference_spec.rb
@@ -290,6 +296,8 @@ test_files:
 - spec/cassettes/communication_request/send/unknown_recipient.yml
 - spec/cassettes/communication_request/send/valid_attributes.yml
 - spec/cassettes/communication_request/send/valid_attributes_binary.yml
+- spec/cassettes/logger/invalid.yml
+- spec/cassettes/logger/valid.yml
 - spec/cassettes/patient/create/invalid_attributes.yml
 - spec/cassettes/patient/create/with_all_information.yml
 - spec/cassettes/patient/create/with_first_name_as_a_string.yml
@@ -305,6 +313,7 @@ test_files:
 - spec/cassettes/practitioner/find_by_rpps/wrong_rpps.yml
 - spec/category_spec.rb
 - spec/communication_request_spec.rb
+- spec/logger_spec.rb
 - spec/patient_spec.rb
 - spec/practitioner_spec.rb
 - spec/reference_spec.rb