liveqa 1.4.6

data/lib/liveqa.rb

@@ -0,0 +1,105 @@
+# Lib
+require 'securerandom'
+require 'net/http'
+require 'ostruct'
+require 'json'
+
+# Async
+require 'liveqa/async_handlers/base'
+
+# Base
+require 'liveqa/version'
+require 'liveqa/library_name'
+require 'liveqa/util'
+require 'liveqa/config'
+require 'liveqa/errors'
+require 'liveqa/liveqa_object'
+require 'liveqa/request'
+require 'liveqa/api_resource'
+require 'liveqa/store'
+require 'liveqa/message'
+
+# Operations
+require 'liveqa/api_operation/save'
+
+# Resources
+require 'liveqa/event'
+
+# Plugins
+require 'liveqa/plugins'
+
+##
+# Implementation of the LiveQA
+module LiveQA
+  class << self
+
+    ##
+    # @return [LiveQA::Config] configurations
+    attr_reader :configurations
+
+    ##
+    # Configures the LiveQA API
+    #
+    # @example Default configuration
+    #   LiveQA.configure do |config|
+    #     config.api_key   = 'your-api-key'
+    #   end
+    def configure
+      yield @configurations = LiveQA::Config.new
+
+      LiveQA.configurations.valid!
+    end
+
+    ##
+    # Send a track event to the server
+    #
+    # @param [String] event name
+    # @param [String] user id from your database
+    # @param [Hash] payload to be send
+    # @param [Hash] options for the request
+    #
+    # @return [LiveQA::Object] response from the server
+    def track(name, payload = {}, request_options = {})
+      return true unless configurations.enabled
+
+      payload[:type] = 'track'
+      payload[:name] = name
+
+      payload = Event.build_payload(payload)
+
+      if configurations.async_handler
+        return configurations.async_handler.enqueue('LiveQA::Event', 'create', payload, request_options)
+      end
+
+      event = Event.create(payload, request_options)
+
+      event.successful?
+    end
+
+    ##
+    # Send an identify event to the server
+    #
+    # @param [String] user id from your database
+    # @param [Hash] payload to be send
+    # @param [Hash] options for the request
+    #
+    # @return [LiveQA::Object] response from the server
+    def identify(user_id, payload = {}, request_options = {})
+      return true unless configurations.enabled
+
+      payload[:type]    = 'identify'
+      payload[:user_id] = user_id
+
+      payload = Event.build_payload(payload)
+
+      if configurations.async_handler
+        return configurations.async_handler.enqueue('LiveQA::Event', 'create', payload, request_options)
+      end
+
+      event = Event.create(payload, request_options)
+
+      event.successful?
+    end
+
+  end
+end

data/liveqa.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'liveqa/version'
+require 'liveqa/library_name'
+
+Gem::Specification.new do |s|
+  s.name          = LiveQA::LIBRARY_NAME
+  s.version       = LiveQA::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ['LiveQA']
+  s.email         = ['support@liveqa.io']
+  s.homepage      = 'https://github.com/arkes/liveqa-ruby'
+  s.summary       = 'LiveQA ruby integration'
+  s.description   = 'LiveQA ruby integration'
+
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+
+  s.add_development_dependency 'faker', '~> 1.8.4'
+  s.add_development_dependency 'rake', '>= 0.9.0'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rspec', '~> 3.5'
+  s.add_development_dependency 'rubocop', '= 0.49.1'
+end

data/spec/lib/liveqa/async_handlers/base_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe LiveQA::AsyncHandlers::Base do
+  subject(:base) { LiveQA::AsyncHandlers::Base.new }
+
+  describe '#enqueue' do
+    subject(:enqueue) { base.enqueue('Event', 'create', test: true) }
+
+    it { expect { enqueue }.to raise_error(LiveQA::MissingImplementation) }
+  end
+
+  describe 'execute' do
+    let(:params) { ['LiveQA::Event', 'create', { test: true }] }
+
+    after { base.execute(params) }
+
+    it { expect(LiveQA::Event).to receive(:create).with({ test: true }, nil) }
+  end
+end

data/spec/lib/liveqa/async_handlers/sidekiq_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'liveqa/async_handlers/sidekiq'
+
+describe LiveQA::AsyncHandlers::Sidekiq do
+  let(:params) {{}}
+  subject(:sidekiq) { LiveQA::AsyncHandlers::Sidekiq.new(params) }
+
+  describe '#initialize' do
+    it { expect(sidekiq.options['queue']).to eq('liveqa') }
+    it { expect(sidekiq.options['class']).to eq(LiveQA::AsyncHandlers::Sidekiq) }
+
+    context 'with options' do
+      let(:params) {{
+        queue: 'default'
+      }}
+
+      it { expect(sidekiq.options['queue']).to eq('default') }
+    end
+  end
+
+  describe '#enqueue' do
+    after { sidekiq.enqueue('Event', 'create', test: true) }
+
+    let(:expected_params) {{
+      'queue' => 'liveqa',
+      'class' => LiveQA::AsyncHandlers::Sidekiq,
+      'args' => ['Event', 'create', { test: true }]
+    }}
+
+    it { expect(::Sidekiq::Client).to receive(:push).with(expected_params) }
+  end
+
+  describe 'perform' do
+    let(:expected_params) { ['LiveQA::Event', 'create', { test: true }] }
+
+    after { sidekiq.perform(*expected_params) }
+
+    it { expect(sidekiq).to receive(:execute).with(expected_params) }
+  end
+end

data/spec/lib/liveqa/config_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe LiveQA::Config do
+  subject(:config) { LiveQA::Config.new(params) }
+
+  describe  '#initialize' do
+    let(:params) {{ api_key: SecureRandom.hex }}
+
+    it { expect(config.valid!).to be_truthy }
+
+    %i[api_key api_host api_version].each do |field|
+      context "validate #{field}" do
+        let(:params) {{ api_key: 'api-key', api_host: 'host', api_version: 'v1'  }.merge(field => '')}
+
+        it { expect { config.valid! }.to raise_error(LiveQA::ConfigurationError, "#{field} can't be blank") }
+      end
+    end
+
+    context 'format obfuscated_fields' do
+      let(:params) {{ api_key: SecureRandom.hex, obfuscated_fields: %i[another_password password_confirmation] }}
+
+      before { config.valid! }
+
+      it { expect(config.obfuscated_fields).to match_array(%w[another_password password_confirmation password access_token api_key ccv credit_card_number cvv secret secret_token token]) }
+    end
+
+    context 'async_handler' do
+      context 'sidekiq' do
+        let(:params) {{
+          api_key: SecureRandom.hex,
+          async_handler: :sidekiq
+        }}
+        before { config.valid! }
+
+        it { expect(config.async_handler).to be_a(LiveQA::AsyncHandlers::Sidekiq) }
+      end
+    end
+
+  end
+end

data/spec/lib/liveqa/event_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe LiveQA::Event do
+
+  describe '.build_payload' do
+    before { LiveQA::Store.set(:tracker_id, '41') }
+
+    let(:expected) {{
+      library: {
+        name: "liveqa",
+        language: "ruby",
+        version: kind_of(String)
+      },
+      server: {
+        host: kind_of(String),
+        pid: kind_of(Numeric)
+      },
+      message_id: kind_of(String),
+      timestamp: kind_of(String),
+      tracker_id: '42',
+      session_tracker_id: kind_of(String)
+    }}
+
+    it { expect(LiveQA::Event.build_payload(tracker_id: '42')).to match(expected) }
+  end
+
+  describe '.create' do
+    let(:response) { double('LiveQA::Request', body: '') }
+    before { expect(LiveQA::Request).to receive(:execute).and_return(response) }
+
+    subject(:create) { LiveQA::Event.create(user_id: 42) }
+
+    it { is_expected.to be_successful }
+  end
+
+end

data/spec/lib/liveqa/liveqa_object_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe LiveQA::LiveQAObject do
+
+  let(:klass) { Class.new(LiveQA::LiveQAObject) }
+  subject(:instance) { klass.new(id: 42, name: 'test', test: true) }
+
+  let(:api_response) { '' }
+
+  describe 'add attribute accessors' do
+    it { expect(instance.id).to eq(42) }
+    it { expect(instance.name).to eq('test') }
+    it { expect(instance.test).to be_truthy }
+    it { expect(instance.test?).to be_truthy }
+  end
+
+  describe 'add array attribute' do
+    it { expect(instance[:id]).to eq(42) }
+    it { expect(instance[:name]).to eq('test') }
+    it { expect(instance[:test]).to be_truthy }
+  end
+
+  describe 'set array attribute' do
+    before { instance[:id] = 84 }
+
+    it { expect(instance.id).to eq(84) }
+    it { expect(instance[:id]).to eq(84) }
+  end
+
+  describe 'method missing' do
+    before { instance.card = '42' }
+
+    it { expect(instance.card).to eq('42') }
+    it { expect { instance.other }.to raise_error(NameError) }
+  end
+
+  describe '#keys' do
+    it { expect(instance.keys).to match_array([:id, :name, :test]) }
+  end
+
+  describe '#to_hash' do
+    it { expect(instance.to_hash).to eq(id: 42, name: 'test', test: true) }
+  end
+
+  describe '#to_json' do
+    it { expect(instance.to_json).to eq(JSON.generate(id: 42, name: 'test', test: true)) }
+  end
+
+  describe '#add_data' do
+    before { instance.add_data(:test) }
+
+    it { expect(instance.data).to match_array([:test]) }
+  end
+
+  describe '#update_attributes' do
+    before { instance.update_attributes(id: 84, other: 'other test') }
+
+    it { expect(instance.id).to eq(84) }
+    it { expect(instance.other).to eq('other test') }
+    it { expect(instance.name).to eq('test') }
+  end
+
+  describe '.initialize_from' do
+    context 'with single object' do
+      subject(:instance) { klass.initialize_from(api_response) }
+
+      it { is_expected.to be_successful }
+    end
+  end
+
+
+end

data/spec/lib/liveqa/message_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe LiveQA::Message do
+  subject(:base) { LiveQA::Message }
+
+  describe '#to_h' do
+    let(:expected_hash) {{
+      tracker_id: kind_of(String),
+      message_id: kind_of(String),
+      timestamp: kind_of(String),
+      session_tracker_id: kind_of(String),
+      library: {
+        name: "liveqa",
+        language: "ruby",
+        version: kind_of(String)
+      },
+      server: {
+        host: kind_of(String),
+        pid: kind_of(Numeric)
+      }
+    }}
+
+    it { expect(base.to_h).to match(expected_hash) }
+
+    context 'with store' do
+      before do
+       LiveQA::Store.set(:tracker_id, 'hello')
+       LiveQA::Store.set(:request,
+        url:        'http://www.test.com/',
+        ssl:        true,
+        host:       'www.test.com',
+        port:       4242,
+        path:       '/',
+        referrer:   'http://www.google.com/',
+        method:     'GET',
+        xhr:        false,
+        user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36',
+        ip:         '127.0.0.1',
+      )
+      LiveQA::Store.set(:worker,
+        name: 'sidekiq',
+        version: '5.0.4',
+        queue: 'chameleon',
+        class: 'LiveQA::AsyncHandlers::Sidekiq',
+        id: '106a61579bc0e7e3d18e3b1c',
+        created_at: '2017-12-15T03:45:10Z',
+        process_at: '2017-12-15T03:45:10Z',
+        args: ['LiveQA::Event']
+      )
+
+      LiveQA::Store.bulk_set(
+        environement:    'production',
+        server_software: 'WEBrick/1.3.1 (Ruby/2.2.7/2017-03-28)'
+      )
+     end
+
+      let(:expected_hash) {{
+        tracker_id: 'hello',
+        message_id: kind_of(String),
+        timestamp: kind_of(String),
+        session_tracker_id: 'hello',
+        library: {
+          name: 'liveqa',
+          language: 'ruby',
+          version: kind_of(String)
+        },
+        server: {
+          host: kind_of(String),
+          pid: kind_of(Numeric),
+          software: 'WEBrick/1.3.1 (Ruby/2.2.7/2017-03-28)'
+        },
+        request: {
+          url:        'http://www.test.com/',
+          ssl:        true,
+          host:       'www.test.com',
+          port:       4242,
+          path:       '/',
+          referrer:   'http://www.google.com/',
+          method:     'GET',
+          xhr:        false,
+          user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36',
+          ip:         '127.0.0.1',
+        },
+        worker: {
+          name: 'sidekiq',
+          version: '5.0.4',
+          queue: 'chameleon',
+          class: 'LiveQA::AsyncHandlers::Sidekiq',
+          id: '106a61579bc0e7e3d18e3b1c',
+          created_at: '2017-12-15T03:45:10Z',
+          process_at: '2017-12-15T03:45:10Z',
+          args: ['LiveQA::Event']
+        },
+        environement: 'production'
+      }}
+
+      it { expect(base.to_h).to match(expected_hash) }
+    end
+  end
+
+end

data/spec/lib/liveqa/plugins/rack/middleware_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'rack'
+require 'liveqa/plugins/rack/middleware'
+
+describe LiveQA::Plugins::Rack::Middleware do
+
+  let(:app) { RackApp.new }
+  let(:middleware) { LiveQA::Plugins::Rack::Middleware.new(app) }
+
+  context 'reset the store' do
+    before do
+      2.times { middleware.call({}) }
+    end
+
+    it { expect(app.last_value).to eq(1) }
+    it { expect(LiveQA::Store.store).to eq({}) }
+  end
+
+  it 'reset the store with error' do
+    expect { middleware.call(error: true) }.to raise_error(RuntimeError)
+
+    expect(LiveQA::Store.store).to eq({})
+  end
+
+end

data/spec/lib/liveqa/plugins/rails/middleware_data_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'rails'
+require 'liveqa/plugins/rails/middleware_data'
+
+describe LiveQA::Plugins::Rails::MiddlewareData do
+
+  let(:middleware) { LiveQA::Plugins::Rails::MiddlewareData }
+
+  describe '#store_data' do
+    let(:request) do
+      double('request',
+        env: {
+          'action_dispatch.request_id' => '42a'
+        }
+      )
+    end
+
+    context 'blank store' do
+      before { middleware.store_data(request) }
+
+      let(:expected) {{
+        environement: kind_of(String),
+        request: {
+          id: '42a'
+        },
+        stack: [
+          {
+            name: 'rails',
+            version: kind_of(String)
+          }
+        ]
+      }}
+
+      it { expect(LiveQA::Store.store).to match(expected) }
+    end
+
+    context 'update the store' do
+      before do
+        LiveQA::Store.set(:request, { xhr: false })
+        LiveQA::Store.set(:stack, [{ name: 'rack' }])
+      end
+      before { middleware.store_data(request) }
+
+      let(:expected) {{
+        environement: kind_of(String),
+        request: {
+          id: '42a',
+          xhr: false
+        },
+        stack: [
+          {
+            name: 'rack'
+          },
+          {
+            name: 'rails',
+            version: kind_of(String)
+          }
+        ]
+      }}
+
+      it { expect(LiveQA::Store.store).to match(expected) }
+    end
+
+
+  end
+
+end

data/spec/lib/liveqa/plugins/sidekiq/client_middleware_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'sidekiq'
+require 'liveqa/plugins/sidekiq/client_middleware'
+
+describe LiveQA::Plugins::Sidekiq::ClientMiddleware do
+
+  let(:middleware) { LiveQA::Plugins::Sidekiq::ClientMiddleware.new }
+
+  describe '#call' do
+    before { LiveQA::Store.set(:tracker_id, 1) }
+
+    it { expect { middleware.call('MyWorker', {}, 'default', {}) {} }.to_not raise_error }
+  end
+
+end

data/spec/lib/liveqa/plugins/sidekiq/server_middleware_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'sidekiq'
+require 'liveqa/plugins/sidekiq/server_middleware'
+
+describe LiveQA::Plugins::Sidekiq::ServerMiddleware do
+
+  let(:middleware) { LiveQA::Plugins::Sidekiq::ServerMiddleware.new }
+
+  describe '#call' do
+    let(:job_attr) {{
+       'class' => 'MyWorker',
+       'args' => ['42'],
+       'retry' => 3,
+       'queue' => 'default',
+       'jid' => '24cc849f71325b62ef470901',
+       'created_at' => 1513299839.2563882,
+       'liveqa_store' =>  {
+          'tracker_id' => '06a09f70-6219-4860-babc-18aa47a62f7f',
+          'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36',
+          'ip' => '127.0.0.1'
+        },
+       'enqueued_at' => 1513300328.8271549,
+       'error_message' => 'exit',
+       'error_class' => 'SystemExit',
+       'failed_at' => 1513300166.646098,
+       'retry_count' => 1,
+       'retried_at' => 1513300238.6037261
+    }}
+
+    context 'expected to be clean at the end' do
+      before { middleware.call('MyWorker', job_attr, 'default') {} }
+
+      it { expect(LiveQA::Store.store).to be_empty }
+    end
+
+    context 'expected to be clean at the end' do
+      before { allow(LiveQA::Store).to receive(:clear!).and_return(true) }
+      before { middleware.call('MyWorker', job_attr, 'default') {} }
+
+      let(:expected) {{
+        tracker_id: '06a09f70-6219-4860-babc-18aa47a62f7f',
+        user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36',
+        ip: '127.0.0.1',
+        worker:  {
+          name: 'sidekiq',
+          version: kind_of(String),
+          queue: 'default',
+          class: 'MyWorker',
+          id: '24cc849f71325b62ef470901',
+          created_at: '2017-12-15T01:03:59Z',
+          process_at: '2017-12-15T01:12:08Z',
+          args: ['42'],
+          retried: true,
+          retry_number: 1,
+          failed_at: '2017-12-15T01:09:26Z'
+        }
+      }}
+
+      it { expect(LiveQA::Store.store).to match(expected) }
+    end
+  end
+
+end