liveqa 1.8.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eedcd2fa28e813d0ebde999b52507b9dd8517668
-  data.tar.gz: a7739558d0b587260136c1d9a364dead5c283d43
+  metadata.gz: 9e2af9cc4ebfb7e97a8330c769db5ffb49989ec9
+  data.tar.gz: 4261ba5bbe8cbebd535f876fe9f8762e460286cf
 SHA512:
-  metadata.gz: fd51dba298a81bc4f67a98db6ec8a2adc0cb418f9c474f787c39b6ffa9ed57393dff40c4d1e333f9afdebac25003872c9cbac51e34c53dddb754e18bde58eeb1
-  data.tar.gz: ecbb7fa596f45776d43abb4b7fc3c2e1f2d5b4e2853b6702da72a045c22d963a32a964e108c7075fe228dbbd09715130b4eb4147c4820fc640d1ac86d1ad78bf
+  metadata.gz: 0f5fc2bd622bdf4e98573f3205ced2fce4ae9b569e398ab28633654cffaf2a3c1e2532c63da9f8352bcc74482d787fd6958104d0c02d52afe83baf3596374595
+  data.tar.gz: 7e2fccdb0c9a117a852989f3ab3e7744b958a0f31f3014cff519614492b3d3cdc862956e375ef6f715c747908170674708ca034a2b578d41201b3c9034f84a91

data/.rubocop.yml

@@ -22,7 +22,13 @@ Layout/EmptyLinesAroundBlockBody:
 
 Style/FrozenStringLiteralComment:
   Enabled: false
-Style/MethodMissing:
+Style/MissingRespondToMissing:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
   Enabled: false
 
 Documentation:
@@ -32,7 +38,7 @@ Bundler/DuplicatedGem:
   Enabled: false
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.2
   Exclude:
     - 'spec/**/*'
   Exclude:

data/.travis.yml

@@ -1,7 +1,6 @@
 cache: bundler
 language: ruby
 rvm:
-  - 2.1
   - 2.2
   - 2.3
   - 2.4

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2018- LiveQA, Inc. (https://www.liveqa.com)
+
+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

@@ -1,127 +1,20 @@
 # LiveQA
 
-[![Build Status](https://travis-ci.org/arkes/liveqa-ruby.svg?branch=master)](https://travis-ci.org/arkes/liveqa-ruby)
+[![Build Status](https://travis-ci.org/LiveQA/liveqa-ruby.svg?branch=master)](https://travis-ci.org/LiveQA/liveqa-ruby)
 
-LiveQA ruby integration for [LiveQA](https://www.liveqa.io)
-
-## Installation
-
-```sh 
-gem install liveqa
-```
-
-For Rails in your Gemfile
-
-```ruby
-gem 'liveqa'
-```
-
-## Configuration
-
-```ruby
-LiveQA.configure do |config|
-  ## 
-  # Account token can be found inside your environment settings
-  config.account_token = 'acc_xx'
-
-  ##
-  # The name of your space
-  config.space_name = 'LiveQA'
-
-  ##
-  # The name of your environement
-  config.environment_name = 'production'
-  
-  ## 
-  # If you use a proxy.
-  # default: nil
-  # config.proxy_url = ENV['HTTP_PROXY']
-
-  ## 
-  # If enabled is set to false nothing is send to the server
-  # default: true
-  # config.enabled = true
-
-  ## 
-  # Extra attributes to be obfuscated
-  # default: []
-  # config.obfuscated_fields = ['credit_card_number']
-
-  ## 
-  # Use an async handler to send data to the liveqa to
-  # avoid slowing down your application
-  # available option: :sidekiq
-  # default: nil
-  # config.async_handler = :sidekiq
-
-  ##
-  # Options to be passed to the async handler
-  # default: {}
-  # config.async_options = { queue: 'liveqa' }
+[LiveQA](https://www.liveqa.io) Ruby library
 
-  ##
-  # Metadata is passed with every request to the server
-  # default: nil
-  # config.metadata = {
-  #.  customer: -> { current_customer.id},
-  #.  version: 42
-  # }
-  #
-end
-```
+Our Ruby library let's you interact easily with our API. All the request will go to our servers and will be display processed and display inside our debugger.
 
-## Usage
+## Setup
 
-### Track
+- [Start by creating an account](https://www.liveqa.io/register)
+- Follow the [Quick Start Guide](https://docs.liveqa.io/docs/quick-start) to get set up 
+- Use our [Ruby Library](https://docs.liveqa.io/docs/ruby) to install and configure LiveQA for your platform.
 
-Track an event
 
-Attributes:
+## Documentation & Usage
 
-* `String` event name
-* `Hash` event attributes
+Documentation is available at [docs.liveqa.io/docs/ruby](https://docs.liveqa.io/docs/ruby)
 
-```ruby
-LiveQA.track('my event',
-  user_id: 42,
-  properties: {
-      order_id: 84 
-  }
-);
-```
-
-### Identify
-
-Identify a user
-
-Attributes:
-
-* `String` user id from your database
-* `Hash` user attributes
-
-```ruby
-LiveQA.identify(42,
-  properties: {
-    name: 'John Doe' 
-  }
-);
-```
-
-### Watch
-
-Create a watcher
-
-Attributes:
-
-* `String|Integer` template flow name or id
-* `Hash` watcher attributes
-
-```ruby
-LiveQA.watch('My Flow',
-  expected_times: 42
-);
-```
-
-## Issues
-
-If you have any issue you can report them on github, or contact support@liveqa.io
+LiveQA ruby integration for [LiveQA](https://www.liveqa.io)

data/lib/liveqa/api_resource.rb

@@ -60,7 +60,9 @@ module LiveQA
       #
       # @return [Hash] response
       # @raise [LiveQA::RequestError] if the request is invalid
+      # rubocop:disable Metrics/AbcSize
       def request(method, path, payload = {}, options = {})
+        payload[:sent_at] = Time.now.utc.iso8601(3)
         payload    = Util.deep_obfuscate_value(payload, configurations.obfuscated_fields)
         url_params = Util.encode_parameters(payload) if method == :get
         uri        = build_endpoint_url(path, url_params)
@@ -76,7 +78,9 @@ module LiveQA
         Request.execute(request_options).body
       rescue LiveQA::RequestError => error
         return error.http_body if error.http_status == 422
+        raise
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -99,7 +103,7 @@ module LiveQA
         return {} unless configurations.http_secure
         {
           ca_file:     File.expand_path(File.dirname(__FILE__) + '/../../vendor/cacert.pem'),
-          verify_mode: OpenSSL::SSL::VERIFY_PEER
+          verify_mode: OpenSSL::SSL::VERIFY_PEER,
         }
       end
 
@@ -110,8 +114,8 @@ module LiveQA
             content_type: 'application/json',
             x_account_token: options.delete(:account_token) || configurations.account_token,
             x_space_name: options.delete(:space_name) || configurations.space_name,
-            x_environment_name: options.delete(:environment_name) || configurations.environment_name
-          }
+            x_environment_name: options.delete(:environment_name) || configurations.environment_name,
+          },
         }
       end
 

data/lib/liveqa/batch.rb

@@ -0,0 +1,18 @@
+module LiveQA
+  ##
+  # == LiveQA \Batch
+  #
+  # Accepted Methods:
+  #
+  # * create
+  #
+  # @example: Usage
+  #
+  #   request = LiveQA::Batch.create(...) #=> #<LiveQA::Response...>
+  #
+  class Batch < APIResource
+    @resource_name = 'batches'
+
+    include LiveQA::APIOperation::Save
+  end
+end

data/lib/liveqa/config.rb

@@ -5,13 +5,6 @@ module LiveQA
   # Represent the LiveQA configuration for the API
   class Config
 
-    ASYNC_HANDLERS = {
-      sidekiq: {
-        class:   'LiveQA::AsyncHandlers::Sidekiq',
-        require: 'liveqa/async_handlers/sidekiq'
-      }
-    }.freeze
-
     DEFAULT_OBFUSCATED_FIELDS = %w[
       password
       password_confirmation
@@ -63,12 +56,8 @@ module LiveQA
     attr_accessor :obfuscated_fields
 
     ##
-    # @return [Null|Symbol|Proc] asynchronous handler
-    attr_accessor :async_handler
-
-    ##
-    # @return [Hash] options for asynchronous handler
-    attr_accessor :async_options
+    # @return [Boolean] send
+    attr_accessor :async
 
     ##
     # @return [Hash] custom object properties
@@ -78,6 +67,14 @@ module LiveQA
     # @return [Hash] metadata to be attach to the payload
     attr_accessor :metadata
 
+    ##
+    # @return [Boolean] enable the logger
+    attr_accessor :log
+
+    ##
+    # @return [Logger] logger
+    attr_accessor :logger
+
     ##
     # @param [Hash{Symbol=>Object}]
     # Initialize and validate the configuration
@@ -93,10 +90,11 @@ module LiveQA
       self.http_secure = options[:http_secure] || true
       self.enabled = options[:enabled] || true
       self.obfuscated_fields = options[:obfuscated_fields] || []
-      self.async_handler = options[:async_handler]
-      self.async_options = options[:async_options] || {}
+      self.async = options[:async] || true
       self.custom_object_properties = options[:custom_object_properties] || {}
       self.metadata = options[:metadata]
+      self.log = options[:log] || true
+      self.logger = FormatedLogger.build(options[:logger])
     end
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
@@ -121,15 +119,9 @@ module LiveQA
     # Format configuration fields
     #
     # * Set obfuscated_fields to string
-    # * Change to the class for async handler
     #
     def format!
       self.obfuscated_fields = (obfuscated_fields.map(&:to_s) + DEFAULT_OBFUSCATED_FIELDS).uniq
-
-      return unless ASYNC_HANDLERS[async_handler]
-
-      require ASYNC_HANDLERS[async_handler][:require]
-      self.async_handler = Object.const_get(ASYNC_HANDLERS[async_handler][:class]).new(async_options)
     end
 
     def validate_presence(field)

data/lib/liveqa/event.rb

@@ -4,7 +4,7 @@ module LiveQA
   #
   # Accepted Methods:
   #
-  # * update
+  # * create
   #
   # @example: Usage
   #

data/lib/liveqa/formated_logger.rb

@@ -0,0 +1,45 @@
+module LiveQA
+  ##
+  # Display formated log
+  class FormatedLogger
+
+    class << self
+
+      def build(logger)
+        return new(logger) if logger
+        return new(Rails.logger) if defined?(Rails)
+
+        new(::Logger.new(STDOUT))
+      end
+
+    end
+
+    attr_reader :logger
+
+    PREFIX = '[LiveQA]'.freeze
+    METHODS = %i[debug info warn error].freeze
+
+    def initialize(logger)
+      @logger = logger
+    end
+
+    METHODS.each do |method|
+      define_method(method) do |message|
+        log(method, message)
+      end
+    end
+
+    private
+
+    def log(type, message)
+      return unless configurations.log
+
+      logger.send(type, "#{PREFIX} #{message}")
+    end
+
+    def configurations
+      LiveQA.configurations
+    end
+
+  end
+end

data/lib/liveqa/message.rb

@@ -37,7 +37,7 @@ module LiveQA
         {
           name: LiveQA::LIBRARY_NAME,
           language: 'ruby',
-          version: LiveQA::VERSION
+          version: LiveQA::VERSION,
         }
       end
 
@@ -45,7 +45,7 @@ module LiveQA
         {
           host: Socket.gethostname,
           pid: Process.pid,
-          software: LiveQA::Store.get(:server_software)
+          software: LiveQA::Store.get(:server_software),
         }
       end
 
@@ -56,7 +56,7 @@ module LiveQA
           if value.is_a?(Proc)
             begin
               hash[key] = value.call
-            rescue
+            rescue StandardError => _e
               nil
             end
             next

data/lib/liveqa/plugins/rack/middleware.rb

@@ -90,7 +90,7 @@ module LiveQA
           uri.merge(
             "?#{::Rack::Utils.build_query(params)}"
           ).to_s
-        rescue
+        rescue StandardError => _e
           ''
         end
 
@@ -99,7 +99,7 @@ module LiveQA
             request.send(type),
             LiveQA.configurations.obfuscated_fields
           )
-        rescue
+        rescue StandardError => _e
           {}
         end
 
@@ -125,7 +125,7 @@ module LiveQA
             headers,
             LiveQA.configurations.obfuscated_fields
           )
-        rescue
+        rescue StandardError => _e
           {}
         end
 

data/lib/liveqa/plugins/sidekiq/server_middleware.rb

@@ -37,7 +37,7 @@ module LiveQA
 
         def convert_to_iso8601(int_time)
           Time.at(int_time).utc.iso8601(3)
-        rescue
+        rescue StandardError => _e
           nil
         end
 

data/lib/liveqa/processor/async.rb

@@ -0,0 +1,48 @@
+module LiveQA
+  module Processor
+    class Async
+
+      def initialize
+        @max_queue_size = 10_000
+        @queue = Queue.new
+        @worker = Worker.new(@queue)
+        @worker_mutex = Mutex.new
+
+        at_exit do
+          @worker_thread && @worker_thread[:should_exit] = true
+        end
+      end
+
+      def enqueue(attributes)
+        return false if @queue.length > @max_queue_size
+
+        @queue << attributes
+        ensure_worker_running
+
+        true
+      end
+
+      def flush
+        while !@queue.empty? || @worker.is_requesting?
+          ensure_worker_running
+          sleep(0.1)
+        end
+      end
+
+      private
+
+      def ensure_worker_running
+        return if worker_running?
+        @worker_mutex.synchronize do
+          return if worker_running?
+          @worker_thread = Thread.new { @worker.run }
+        end
+      end
+
+      def worker_running?
+        @worker_thread && @worker_thread.alive?
+      end
+
+    end
+  end
+end

data/lib/liveqa/processor/batch.rb

@@ -0,0 +1,81 @@
+module LiveQA
+  module Processor
+    class Batch
+
+      attr_reader :messages
+
+      MAX_BYTES = 204_800 # 200Kb
+      MAX_MESSAGES = 100
+      MAX_MESSAGE_BYTES = 32_768 # 32Kb
+
+      MAX_RETRY = 10
+      RETRY_MAP = {
+        1 => 2,
+        2 => 5,
+        3 => 10,
+        4 => 20,
+        5 => 30,
+        6 => 30,
+        7 => 30,
+        8 => 30,
+        9 => 30,
+        10 => 30,
+      }.freeze
+
+      def initialize
+        @retry_count = 0
+        @total_bytes = 0
+        @messages = []
+      end
+
+      def <<(message)
+        message_json_size = message.to_json.bytesize
+
+        if max_message_reached?(message_json_size)
+          LiveQA.configurations.logger.error('Message is too big to be send')
+          return false
+        end
+
+        @total_bytes += message_json_size
+
+        @messages << message
+
+        true
+      end
+
+      def full?
+        max_messages_reached? || max_size_reached?
+      end
+
+      def update_retry
+        @retry_count += 1
+        @retry_at = Time.now + (RETRY_MAP[@retry_count] || 120)
+      end
+
+      def can_run?
+        return true if @retry_count.zero?
+
+        Time.now >= @retry_at
+      end
+
+      def can_retry?
+        @retry_count < MAX_RETRY
+      end
+
+      private
+
+      def max_messages_reached?
+        @messages.length >= MAX_MESSAGES
+      end
+
+      def max_size_reached?
+        @total_bytes >= MAX_BYTES
+      end
+
+      def max_message_reached?(message_json_size)
+        message_json_size > MAX_MESSAGE_BYTES
+      end
+
+    end
+  end
+end

data/lib/liveqa/processor/worker.rb

@@ -0,0 +1,66 @@
+module LiveQA
+  module Processor
+    class Worker
+
+      DEFAULT_WAIT_TIME = 2
+
+      attr_reader :queue
+      attr_reader :lock
+      attr_reader :batches
+
+      def initialize(queue)
+        @queue = queue
+        @lock = Mutex.new
+        @batches = []
+      end
+
+      def run
+        until Thread.current[:should_exit]
+          return if queue.empty? && batches.empty?
+
+          sleep(DEFAULT_WAIT_TIME) if queue.empty?
+
+          create_new_batch unless queue.empty?
+
+          send_batches
+        end
+      end
+
+      private
+
+      def create_new_batch
+        batch = Batch.new
+        lock.synchronize do
+          batch << queue.pop until batch.full? || queue.empty?
+        end
+        batches.push(batch)
+      end
+
+      def send_batches
+        batches.dup.each do
+          batch = batches.pop
+
+          unless batch.can_run?
+            batches.push(batch)
+            next
+          end
+
+          begin
+            LiveQA::Batch.create(Message.base.merge(data: batch.messages))
+          rescue LiveQA::RequestError => error
+            return LiveQA.configurations.logger.error(error.message) if [401, 404].include?(error.http_status)
+            batch_retry(batch)
+          rescue Errno::ECONNREFUSED => _error
+            batch_retry(batch)
+          end
+        end
+      end
+
+      def batch_retry(batch)
+        batch.update_retry
+        batches.push(batch) if batch.can_retry?
+      end
+
+    end
+  end
+end

data/lib/liveqa/util.rb

@@ -94,7 +94,7 @@ module LiveQA
         deep_transform_keys_in_object(hash_object) do |key|
           begin
             underscore(key).to_sym
-          rescue
+          rescue StandardError => _e
             key
           end
         end
@@ -110,7 +110,7 @@ module LiveQA
         deep_transform_keys_in_object(hash_object) do |key|
           begin
             key.to_s
-          rescue
+          rescue StandardError => _e
             key
           end
         end
@@ -126,7 +126,7 @@ module LiveQA
         deep_transform_keys_in_object(hash_object) do |key|
           begin
             key.to_sym
-          rescue
+          rescue StandardError => _e
             key
           end
         end

data/lib/liveqa/version.rb

@@ -1,3 +1,3 @@
 module LiveQA # :nodoc:
-  VERSION = '1.8.3'.freeze
+  VERSION = '1.9.0'.freeze
 end