tng-gtk-utils 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 49c965e9e3a31a115b50d4e553c9b287e9289e9cc0de312882ef5fa762254ede
-  data.tar.gz: 290a0a066ee706e752791a5c748c6338b6f14a7889dec2398a17168c11a7c546
+SHA1:
+  metadata.gz: 4d95e0157be5e4a3b5b90f31492a469ab218b13b
+  data.tar.gz: c60b428906b6bed69e473067b36976ed178c82f5
 SHA512:
-  metadata.gz: 1677767e5d19e1ff4990a7c98a8e8ed96c1b37dfd72eab55a3c322cccc52edc1424af9456ead6fd4e839af6f81acc9c34d14fdba7bdc3951c379296774c1a2a7
-  data.tar.gz: 82eb5dc8ff9b5f67f0232854f90e429f95af431ec48df5222a28263ac7f7e51cd2362191b251571ccbfe02fc48fc73845285a5203bccf702305fb20eb1d0449c
+  metadata.gz: d7de031d9e209a0f98a00191636145d9594d7464597b8eb52830920f9136a652dc1b13c82f8f7fd87620e4f32633cc1515e0c8783b193956063096e16797e14e
+  data.tar.gz: 84d72ce21457caf7e09e9250b4f7f55e43fd41cdd33c2a2b30bc8e465435fdb035445096af3ceaeb321d6abb9f459ab08075784203e112b67ea5ea796e8dfbbc

data/lib/tng/gtk/utils/application_controller.rb

@@ -41,8 +41,6 @@ module Tng
       class ApplicationController < Sinatra::Base
         LOGGER=Tng::Gtk::Utils::Logger
         LOGGED_COMPONENT=self.name
-        @@began_at = Time.now.utc
-        LOGGER.info(component:LOGGED_COMPONENT, operation:'initializing', start_stop: 'START', message:"Started at #{@@began_at}")
   
         register Sinatra::ConfigFile
         register Sinatra::CrossOrigin
@@ -54,7 +52,6 @@ module Tng
         set :environment, ENV.fetch('RACK_ENV', :development)
   
         before { content_type :json}
-        LOGGER.info(component:LOGGED_COMPONENT, operation:'initializing', start_stop: 'STOP', message:"Ended at #{Time.now.utc}", time_elapsed:"#{Time.now.utc-began_at}")
       end
     end
   end

data/lib/tng/gtk/utils/cache.rb

@@ -75,28 +75,23 @@ module Tng
         class << self; attr_accessor :strategy; end
 
         self.strategy = ENV['REDIS_URL'] ? STRATEGIES[:redis] : STRATEGIES[:memory]
-        LOGGER.info(start_stop: 'START', component:LOG_COMPONENT, operation:'class definition', message:"Strategy used: #{self.strategy}") 
 
         def self.cache(record)
           unless record.key?(:uuid)
             LOGGER.error(component: LOG_COMPONENT, operation:__method__.to_s, message:"key :uuid is missing in record #{record}") 
             return nil
           end
-          LOGGER.info(component: LOG_COMPONENT, operation:__method__.to_s, message:"key '#{CACHE_PREFIX}:#{record[:uuid]}' with value '#{record}' (strategy #{self.strategy})") 
           self.strategy.set("#{CACHE_PREFIX}:#{record[:uuid]}", record.to_json)
           record
         end
         def self.cached?(key)
-          LOGGER.info(component: LOG_COMPONENT, operation:__method__.to_s, message:"key '#{CACHE_PREFIX}:#{key}' (strategy #{self.strategy})")
           data = self.strategy.get("#{CACHE_PREFIX}:#{key}")
           return '' if data.nil?
           JSON.parse(data, symbolize_names: :true) 
         end
         def self.clear(key)
-          LOGGER.info(component: LOG_COMPONENT, operation:__method__.to_s, message:"key '#{key}' (strategy #{self.strategy})")
           self.strategy.del(key)
         end
-        LOGGER.info(start_stop: 'STOP', component:LOG_COMPONENT, operation:'class definition', message:"Strategy used: #{self.strategy}") 
       end
     end
   end

data/lib/tng/gtk/utils/fetch.rb

@@ -49,7 +49,6 @@ module Tng
         def self.call(params)
           msg=self.name+'#'+__method__.to_s
           began_at=Time.now.utc
-           LOGGER.info(start_stop: 'START', component:self.name, operation:__method__.to_s, message:"params=#{params} site=#{self.site}")
           original_params = params.dup
           begin
             if params.key?(:uuid)
@@ -66,21 +65,16 @@ module Tng
               uri = URI.parse(self.site)
               uri.query = URI.encode_www_form(sanitize(params))
             end
-             LOGGER.debug(component:self.name, operation:__method__.to_s, message:"uri=#{uri}")
             request = Net::HTTP::Get.new(uri)
             request['content-type'] = 'application/json'
             response = Net::HTTP.start(uri.hostname, uri.port) {|http| http.request(request)}
-             LOGGER.debug(component:self.name, operation:__method__.to_s, message:"response=#{response.inspect}")
             case response
             when Net::HTTPSuccess
               body = response.read_body
-               LOGGER.debug(component:self.name, operation:__method__.to_s, message:"body=#{body}", status: '200')
               result = JSON.parse(body, quirks_mode: true, symbolize_names: true)
               cache_result(result)
-               LOGGER.info(start_stop: 'STOP', component:self.name, operation:__method__.to_s, message:"result=#{result} site=#{self.site}", time_elapsed: Time.now.utc - began_at)
               return result
             when Net::HTTPNotFound
-               LOGGER.info(start_stop: 'STOP', component:self.name, operation:__method__.to_s, message:"body=#{body}", status:'404', time_elapsed: Time.now.utc - began_at)
               return {} unless uuid.nil?
               return []
             else
@@ -101,15 +95,11 @@ module Tng
         end
   
         def self.cache_result(result)
-           LOGGER.debug(component:self.name, operation:__method__.to_s, message:"result=#{result}")
           if result.is_a?(Hash)      
-            LOGGER.info(component:self.name, operation:__method__.to_s, message:"Caching #{result}")
             Tng::Gtk::Utils::Cache.cache(result)
             return
           end
-           LOGGER.info(component:self.name, operation:__method__.to_s, message:"#{result} is not an Hash")
           result.each do |record|
-             LOGGER.info(component:self.name, operation:__method__.to_s, message:"Caching #{record}")
             Tng::Gtk::Utils::Cache.cache(record)
           end
         end

data/lib/tng/gtk/utils/functions.rb

@@ -37,11 +37,11 @@ require 'tng/gtk/utils/application_controller'
 require 'tng/gtk/utils/logger'
 require 'tng/gtk/utils/fetch'
 
-LOGGER=Tng::Gtk::Utils::Logger
 
 class FetchVNFDsService < Tng::Gtk::Utils::Fetch
   NO_CATALOGUE_URL_DEFINED_ERROR='The CATALOGUE_URL ENV variable needs to defined and pointing to the Catalogue where to fetch functions'
   LOGGED_COMPONENT=self.name
+  LOGGER=Tng::Gtk::Utils::Logger
   
   CATALOGUE_URL = ENV.fetch('CATALOGUE_URL', '')
   if CATALOGUE_URL == ''
@@ -49,61 +49,41 @@ class FetchVNFDsService < Tng::Gtk::Utils::Fetch
     raise ArgumentError.new(NO_CATALOGUE_URL_DEFINED_ERROR) 
   end
   self.site=CATALOGUE_URL+'/vnfs'
-  LOGGER.info(component:LOGGED_COMPONENT, operation:'site definition', message:"self.site=#{self.site}")
 end
 
 class FunctionsController < Tng::Gtk::Utils::ApplicationController
 
   ERROR_FUNCTION_NOT_FOUND="No function with UUID '%s' was found"
   LOGGED_COMPONENT=self.name
-  @@began_at = Time.now.utc
-  LOGGER.info(component:LOGGED_COMPONENT, operation:'initializing', start_stop: 'START', message:"Started at #{@@began_at}")
   
   get '/?' do 
     msg='#get (many)'
-    began_at = Time.now.utc
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'START', message:"Started at #{began_at}")
     captures=params.delete('captures') if params.key? 'captures'
-    LOGGER.debug(component:LOGGED_COMPONENT, operation:msg, message:"params=#{params}")
     result = FetchVNFDsService.call(symbolized_hash(params))
-    LOGGER.debug(component:LOGGED_COMPONENT, operation:msg, message:"result=#{result}")
     if result.to_s.empty? # covers nil
-      LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '404', time_elapsed:"#{Time.now.utc-began_at}")
       halt 404, {}, {error: "No functions fiting the provided parameters ('#{params}') were found"}.to_json
     end
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '200', time_elapsed:"#{Time.now.utc-began_at}")
     halt 200, {}, result.to_json
   end
   
   get '/:function_uuid/?' do 
     msg='#get (single)'
-    began_at = Time.now.utc
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'START', message:"Started at #{began_at}")
     captures=params.delete('captures') if params.key? 'captures'
-    LOGGER.debug(component:LOGGED_COMPONENT, operation:msg, message:"params['function_uuid']='#{params['function_uuid']}'")
     result = FetchVNFDsService.call(uuid: params['function_uuid'])
-    LOGGER.debug(component:LOGGED_COMPONENT, operation:msg, message:"result=#{result}")
     if result == {}
-      LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '404', time_elapsed:"#{Time.now.utc-began_at}")
       halt 404, {}, {error: ERROR_FUNCTION_NOT_FOUND % params['function_uuid']}.to_json
     end
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '200', time_elapsed:"#{Time.now.utc-began_at}")
     halt 200, {}, result.to_json
   end
   
   options '/?' do
     msg='#options'
-    began_at = Time.now.utc
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'START', message:"Started at #{began_at}")
     response.headers['Access-Control-Allow-Origin'] = '*'
     response.headers['Access-Control-Allow-Methods'] = 'GET,DELETE'      
     response.headers['Access-Control-Allow-Headers'] = 'Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With'
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '200', time_elapsed:"#{Time.now.utc-began_at}")
     halt 200
   end
   
-  LOGGER.info(component:LOGGED_COMPONENT, operation:'initializing', start_stop: 'STOP', message:"Ending at #{Time.now.utc}", time_elapsed: Time.now.utc - @@began_at)
-  
   private
   def uuid_valid?(uuid)
     return true if (uuid =~ /[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}/) == 0

data/lib/tng/gtk/utils/logger.rb

@@ -39,7 +39,6 @@ module Tng
       class Logger
         LOGFILE = ENV.fetch('LOGFILE', STDOUT)
         LOGLEVEL = ENV.fetch('LOGLEVEL', 'info')
-        #LOGGER_LEVELS = ['debug', 'info', 'warn', 'error', 'fatal', 'unknown'].freeze
         LOGGER_LEVELS = ['D', 'I', 'W', 'E', 'F', 'U'].freeze
         
         class << self
@@ -66,13 +65,13 @@ module Tng
           def generic(type:, start_stop:, component:, operation:, message:, status:, time_elapsed:) 
             message = {
               type: type,                 # mandatory, can be I(nfo), W(arning), D(ebug), E(rror), F(atal) or U(nknown)
-              timestamp: Time.now.utc, # mandatory
-              start_stop: start_stop,                    # optional, can be empty, 'START' or 'STOP'
-              component: component,             # mandatory
-              operation: operation,          # mandatory
-              message: message,      # mandatory
-              status: status,                        # optional, makes sense for start_stop='END'
-              time_elapsed: time_elapsed              # optional, makes sense for start_stop='END'
+              app_timestamp: Time.now.utc.strftime("%Y-%m-%e %H:%M:%S.%6N %Z" ), # mandatory, with miliseconds
+              start_stop: start_stop,     # optional, can be empty, 'START' or 'STOP'
+              component: component,       # mandatory
+              operation: operation,       # mandatory
+              message: message,           # mandatory
+              status: status,             # optional, makes sense for start_stop='END'
+              time_elapsed: time_elapsed  # optional, makes sense for start_stop='END'
             }
             LOGFILE.puts "#{message.to_json}" if log?(type)
             message
@@ -86,47 +85,3 @@ module Tng
     end
   end
 end
-=begin
-LOGLEVEL
-Unknown: a message that should always be logged, whatever the logging level set;
-Fatal: an unhandleable error ocurred;
-Error: a handleable error occurred. The service the component delivers should not be interrupted (i.e., it should be able to recover from the error);
-Warning: a warning message;
-Info: a generic (but useful) information about system operation;
-Debug: a low-level information for developers;
-
-{
-  "type": "I",                 # mandatory, can be I(nfo), W(arning), D(ebug), E(rror), F(atal) or U(nknown)
-  "timestamp": "2018-10-18 15:49:08 UTC", # mandatory
-  "start_stop": "END",                    # optional, can be empty, 'START' or 'STOP'
-  "component": "tng-api-gtw",             # mandatory
-  "operation": "package upload",          # mandatory
-  "message": "package uploaded 201",      # mandatory
-  "status": "201",                        # optional, makes sense for start_stop='END'
-  "time_elapsed": "00:01:20"              # optional, makes sense for start_stop='END'
-}
-
-  LOGGER_LEVELS = ['debug', 'info', 'warn', 'error', 'fatal', 'unknown'].freeze
-  FORMAT = %{%s - %s [%s] "%s %s%s %s" %d %s %0.4f\n}
-  
-  def initialize(app, options = {})
-    @app = app
-    @error_io = options[:logger_io]
-    @logger = Logger.new(@error_io)
-    @error_io.sync = true
-    @logger_level = LOGGER_LEVELS.find_index(options[:logger_level].downcase ||= 'debug')
-  end
-  
-
-  def call(env)
-    msg = self.class.name+'#'+__method__.to_s
-    env['5gtango.error']=@error_io
-    env['5gtango.logger']=@logger
-    @logger.info(msg) {"Called"}
-
-    status, headers, body = @app.call(env)
-    @logger.info(msg) {"Finishing with status #{status}"}
-    [status, headers, body]
-  end
-
-=end

data/lib/tng/gtk/utils/services.rb

@@ -40,11 +40,10 @@ require 'tng/gtk/utils/application_controller'
 require 'tng/gtk/utils/logger'
 require 'tng/gtk/utils/fetch'
 
-LOGGER=Tng::Gtk::Utils::Logger
-
 class FetchNSDService < Tng::Gtk::Utils::Fetch
   NO_CATALOGUE_URL_DEFINED_ERROR='The CATALOGUE_URL ENV variable needs to defined and pointing to the Catalogue where to fetch services'
   LOGGED_COMPONENT=self.name
+  LOGGER=Tng::Gtk::Utils::Logger
   
   CATALOGUE_URL = ENV.fetch('CATALOGUE_URL', '')
   if CATALOGUE_URL == ''
@@ -52,7 +51,6 @@ class FetchNSDService < Tng::Gtk::Utils::Fetch
     raise ArgumentError.new(NO_CATALOGUE_URL_DEFINED_ERROR) 
   end
   self.site=CATALOGUE_URL+'/network-services'
-  LOGGER.info(component:LOGGED_COMPONENT, operation:'site definition', message:"self.site=#{self.site}")
 end
 
 class ServicesController < Tng::Gtk::Utils::ApplicationController
@@ -60,55 +58,35 @@ class ServicesController < Tng::Gtk::Utils::ApplicationController
   ERROR_SERVICE_NOT_FOUND="No service with UUID '%s' was found"
   LOGGER=Tng::Gtk::Utils::Logger
   LOGGED_COMPONENT=self.name
-
-  @@began_at = Time.now.utc
-  LOGGER.info(component:LOGGED_COMPONENT, operation:'initializing', start_stop: 'START', message:"Started at #{@@began_at}")
   
   get '/?' do 
     msg='#get (many)'
-    began_at = Time.now.utc
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'START', message:"Started at #{began_at}")
     captures=params.delete('captures') if params.key? 'captures'
-    LOGGER.debug(component:LOGGED_COMPONENT, operation:msg, message:"params=#{params}")
     result = FetchNSDService.call(symbolized_hash(params))
-    LOGGER.debug(component:LOGGED_COMPONENT, operation:msg, message:"result=#{result}")
     if result.to_s.empty? # covers nil
-      LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '404', time_elapsed:"#{Time.now.utc-began_at}")
       halt 404, {}, {error: "No packages fiting the provided parameters ('#{params}') were found"}.to_json
     end
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '200', time_elapsed:"#{Time.now.utc-began_at}")
     halt 200, {}, result.to_json
   end
   
   get '/:uuid/?' do 
     msg='#get (single)'
-    began_at = Time.now.utc
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'START', message:"Started at #{began_at}")
     captures=params.delete('captures') if params.key? 'captures'
-    LOGGER.debug(component:LOGGED_COMPONENT, operation:msg, message:"params['uuid']='#{params['uuid']}'")
     result = FetchNSDService.call(symbolized_hash(params))
-    LOGGER.debug(component:LOGGED_COMPONENT, operation:msg, message:"result=#{result}")
     if result.to_s.empty? # covers nil
-      LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '404', time_elapsed:"#{Time.now.utc-began_at}")
       halt 404, {}, {error: ERROR_SERVICE_NOT_FOUND % params[:uuid]}.to_json
     end
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '200', time_elapsed:"#{Time.now.utc-began_at}")
     halt 200, {}, result.to_json
   end
   
   options '/?' do
     msg='#options'
-    began_at = Time.now.utc
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'START', message:"Started at #{began_at}")
     response.headers['Access-Control-Allow-Origin'] = '*'
     response.headers['Access-Control-Allow-Methods'] = 'GET,DELETE'      
     response.headers['Access-Control-Allow-Headers'] = 'Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With'
-    LOGGER.info(component:LOGGED_COMPONENT, operation:msg, start_stop: 'STOP', message:"Ended at #{Time.now.utc}", status: '200', time_elapsed:"#{Time.now.utc-began_at}")
     halt 200
   end
   
-  LOGGER.info(component:LOGGED_COMPONENT, operation:'initializing', start_stop: 'STOP', message:"Ending at #{Time.now.utc}", time_elapsed: Time.now.utc - @@began_at)
-  
   private
   def uuid_valid?(uuid)
     return true if (uuid =~ /[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}/) == 0

data/lib/tng/gtk/utils/version.rb

@@ -1,7 +1,7 @@
 module Tng
   module Gtk
     module Utils
-      VERSION = "0.4.1"
+      VERSION = "0.5.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tng-gtk-utils
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - José Bonnet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: A small library with utility features for 5GTANGO Gatekeeper