resurfaceio-logger 1.7.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e0ed89c6f3304584c60bb686d5c20de7f0cd341
+  data.tar.gz: 32d7eef540733c228600ef0868160be0a2f83f5f
+SHA512:
+  metadata.gz: d527e29d631b95cf34831079fefb95b52cf5c40e0d2b40d249c47a10aa8606b3d6b7be588878d318446fa7192be0203312a6633838b4a4e3c7321c096f52fc17
+  data.tar.gz: 95942bc79f0877a8ff7e5d6f07d4390d4cc492f1f8b69f197cab4e07d5da3a5066fd578a860382c6d869b0d8d8cbe6f36c097f9dd00991c43c91e19dff6c0c01

data/lib/resurfaceio/all.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+# © 2016-2017 Resurface Labs LLC
+
+require 'resurfaceio/base_logger'
+require 'resurfaceio/http_logger'
+require 'resurfaceio/http_logger_for_rack'
+require 'resurfaceio/http_logger_for_rails'
+require 'resurfaceio/http_request_impl'
+require 'resurfaceio/http_response_impl'
+require 'resurfaceio/usage_loggers'
+
+module Resurfaceio
+
+  class BaseLogger < HttpLogger
+  end
+
+  class HttpLogger < HttpLogger
+  end
+
+  class HttpLoggerForRack < HttpLoggerForRack
+  end
+
+  class HttpLoggerForRails < HttpLoggerForRails
+  end
+
+  class HttpRequestImpl < HttpRequestImpl
+  end
+
+  class HttpResponseImpl < HttpResponseImpl
+  end
+
+  class UsageLoggers < UsageLoggers
+  end
+
+end

data/lib/resurfaceio/base_logger.rb

@@ -0,0 +1,104 @@
+# coding: utf-8
+# © 2016-2017 Resurface Labs LLC
+
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'resurfaceio/usage_loggers'
+
+class BaseLogger
+
+  def initialize(agent, options={})
+    @agent = agent
+    @version = BaseLogger.version_lookup
+
+    # set options in priority order
+    if options.respond_to?(:fetch) && options.respond_to?(:has_key?)
+      @enabled = options.fetch(:enabled, true)
+      if options.has_key?(:queue)
+        @queue = options[:queue]
+      elsif options.has_key?(:url)
+        url = options[:url]
+        if url.nil?
+          @url = UsageLoggers.url_by_default
+        elsif url.eql?('DEMO')
+          @url = UsageLoggers.url_for_demo
+        else
+          @url = url
+        end
+        @enabled = false if url.nil?
+      else
+        @url = UsageLoggers.url_by_default
+        @enabled = false if @url.nil?
+      end
+    elsif options.respond_to?(:to_s)
+      @url = options.to_s
+      @enabled = @url.nil? ? false : true
+    else
+      @enabled = false
+    end
+
+    # validate url when present
+    unless @url.nil?
+      begin
+        raise Exception unless URI.parse(@url).scheme.include?('http')
+      rescue Exception
+        @url = nil
+        @enabled = false
+      end
+    end
+  end
+
+  def agent
+    @agent
+  end
+
+  def disable
+    @enabled = false
+    self
+  end
+
+  def enable
+    @enabled = true unless @queue.nil? && @url.nil?
+    self
+  end
+
+  def enabled?
+    @enabled && UsageLoggers.enabled?
+  end
+
+  def submit(json)
+    if !enabled?
+      true
+    elsif @queue
+      @queue << json
+      true
+    else
+      begin
+        @url_parsed ||= URI.parse(@url)
+        @url_connection ||= Net::HTTP.new(@url_parsed.host, @url_parsed.port)
+        @url_connection.use_ssl = @url.include?('https')
+        request = Net::HTTP::Post.new(@url_parsed.path)
+        request.body = json
+        response = @url_connection.request(request)
+        response.code.to_i == 200
+      rescue SocketError
+        @url_connection = nil
+        false
+      end
+    end
+  end
+
+  def url
+    @url
+  end
+
+  def version
+    @version
+  end
+
+  def self.version_lookup
+    Gem.loaded_specs['resurfaceio-logger'].version.to_s
+  end
+
+end

data/lib/resurfaceio/http_logger.rb

@@ -0,0 +1,89 @@
+# coding: utf-8
+# © 2016-2017 Resurface Labs LLC
+
+require 'json'
+require 'resurfaceio/base_logger'
+
+class HttpLogger < BaseLogger
+
+  AGENT = 'http_logger.rb'
+
+  def initialize(options={})
+    super(AGENT, options)
+  end
+
+  def format(request, request_body, response, response_body, now=Time.now.to_i.to_s)
+    message = []
+    append_value message, 'request_method', request.request_method
+    append_value message, 'request_url', request.url
+    append_value message, 'response_code', response.status
+    append_request_headers message, request
+    append_response_headers message, response
+    append_value message, 'request_body', request_body.nil? ? request.body : request_body
+    append_value message, 'response_body', response_body.nil? ? response.body : response_body
+    message << ['agent', @agent]
+    message << ['version', @version]
+    message << ['now', now]
+    JSON.generate message
+  end
+
+  def log(request, request_body, response, response_body)
+    !enabled? || submit(format(request, request_body, response, response_body))
+  end
+
+  protected
+
+  def append_request_headers(message, request)
+    respond_to_env = request.respond_to?(:env)
+    if respond_to_env || request.respond_to?(:headers)
+      headers = respond_to_env ? request.env : request.headers
+      headers.each do |name, value|
+        unless value.nil?
+          if name =~ /^CONTENT_TYPE/
+            message << ['request_header.content-type', value]
+          end
+          if name =~ /^HTTP_/
+            message << ["request_header.#{name[5..-1].downcase.tr('_', '-')}", value]
+          end
+        end
+      end
+    end
+  end
+
+  def append_response_headers(message, response)
+    found_content_type = false
+    if response.respond_to?(:headers)
+      response.headers.each do |name, value|
+        unless value.nil?
+          name = name.downcase
+          found_content_type = true if name =~ /^content-type/
+          message << ["response_header.#{name}", value]
+        end
+      end
+    end
+    unless found_content_type || response.content_type.nil?
+      message << ['response_header.content-type', response.content_type]
+    end
+  end
+
+  def append_value(message, key, value=nil)
+    unless key.nil?
+      unless value.nil?
+        case value
+          when Array
+            message << [key, value.join]
+          when String
+            message << [key, value]
+          else
+            if value.respond_to?(:read)
+              message << [key, value.read]
+            else
+              message << [key, value.to_s]
+            end
+        end
+      end
+    end
+    message
+  end
+
+end

data/lib/resurfaceio/http_logger_for_rack.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+# © 2016-2017 Resurface Labs LLC
+
+require 'rack'
+require 'resurfaceio/http_logger'
+
+class HttpLoggerForRack # http://rack.rubyforge.org/doc/SPEC.html
+
+  def initialize(app, options={})
+    @app = app
+    @logger = HttpLogger.new(options)
+  end
+
+  def call(env)
+    status, headers, body = @app.call(env)
+    if @logger.enabled? && status == 200
+      response = Rack::Response.new(body, status, headers)
+      if string_content_type?(response.content_type)
+        request = Rack::Request.new(env)
+        @logger.log(request, nil, response, nil)
+      end
+    end
+    [status, headers, body]
+  end
+
+  protected
+
+  def string_content_type?(s)
+    !s.nil? && s =~ /^(text\/(html|plain|xml))|(application\/(json|soap|xml|x-www-form-urlencoded))/i
+  end
+
+end

data/lib/resurfaceio/http_logger_for_rails.rb

@@ -0,0 +1,17 @@
+# coding: utf-8
+# © 2016-2017 Resurface Labs LLC
+
+require 'resurfaceio/http_logger'
+
+class HttpLoggerForRails
+
+  def initialize(options={})
+    @logger = HttpLogger.new(options)
+  end
+
+  def around(controller)
+    yield
+    @logger.log(controller.request, nil, controller.response, nil)
+  end
+
+end

data/lib/resurfaceio/http_request_impl.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+# © 2016-2017 Resurface Labs LLC
+
+class HttpRequestImpl
+
+  def initialize
+    @headers = Hash.new
+    @raw_body = nil
+  end
+
+  def add_header(key, value)
+    unless value.nil?
+      existing = @headers[key]
+      if existing.nil?
+        @headers[key] = value
+      else
+        @headers[key] = "#{existing}, #{value}"
+      end
+    end
+  end
+
+  def body
+    @raw_body ? StringIO.new(@raw_body) : nil
+  end
+
+  def content_type
+    @headers['CONTENT_TYPE']
+  end
+
+  def content_type=(content_type)
+    @headers['CONTENT_TYPE'] = content_type
+  end
+
+  def headers
+    @headers
+  end
+
+  attr_accessor :raw_body
+  attr_accessor :request_method
+  attr_accessor :url
+
+end

data/lib/resurfaceio/http_response_impl.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+# © 2016-2017 Resurface Labs LLC
+
+class HttpResponseImpl
+
+  def initialize
+    @headers = Hash.new
+    @raw_body = nil
+  end
+
+  def add_header(key, value)
+    unless value.nil?
+      existing = @headers[key]
+      if existing.nil?
+        @headers[key] = value
+      else
+        @headers[key] = "#{existing}, #{value}"
+      end
+    end
+  end
+
+  def body
+    @raw_body ? [@raw_body] : nil
+  end
+
+  def content_type
+    @headers['Content-Type']
+  end
+
+  def content_type=(content_type)
+    @headers['Content-Type'] = content_type
+  end
+
+  def headers
+    @headers
+  end
+
+  attr_accessor :raw_body
+  attr_accessor :status
+
+end

data/lib/resurfaceio/usage_loggers.rb

@@ -0,0 +1,30 @@
+# coding: utf-8
+# © 2016-2017 Resurface Labs LLC
+
+class UsageLoggers
+
+  @@DISABLED = 'true'.eql?(ENV['USAGE_LOGGERS_DISABLE'])
+
+  @@disabled = @@DISABLED
+
+  def self.disable
+    @@disabled = true
+  end
+
+  def self.enable
+    @@disabled = false unless @@DISABLED
+  end
+
+  def self.enabled?
+    !@@disabled
+  end
+
+  def self.url_by_default
+    ENV['USAGE_LOGGERS_URL']
+  end
+
+  def self.url_for_demo
+    'https://demo-resurfaceio.herokuapp.com/messages'
+  end
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: resurfaceio-logger
+version: !ruby/object:Gem::Version
+  version: 1.7.5
+platform: ruby
+authors:
+- RobDickinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rack
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: Library for usage logging
+email:
+- resurfacelabs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/resurfaceio/all.rb
+- lib/resurfaceio/base_logger.rb
+- lib/resurfaceio/http_logger.rb
+- lib/resurfaceio/http_logger_for_rack.rb
+- lib/resurfaceio/http_logger_for_rails.rb
+- lib/resurfaceio/http_request_impl.rb
+- lib/resurfaceio/http_response_impl.rb
+- lib/resurfaceio/usage_loggers.rb
+homepage: https://github.com/resurfaceio/logger-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Library for usage logging
+test_files: []