liveqa 1.4.6 → 1.8.3

data/lib/liveqa/plugins/rails/middleware_data.rb

@@ -5,12 +5,8 @@ module LiveQA
 
         class << self
 
-          def store_data(request)
-            LiveQA::Store.bulk_set(
-              environement: ::Rails.env
-            )
-            store_request_data(request)
-            store_framework
+          def store_data(request = nil)
+            store_request_data(request) if request
           end
 
           private
@@ -24,18 +20,6 @@ module LiveQA
             )
           end
 
-          def store_framework
-            stack = LiveQA::Store.get(:stack) || []
-
-            LiveQA::Store.set(
-              :stack,
-              stack.push(
-                name: 'rails',
-                version: ::Rails.version
-              )
-            )
-          end
-
         end
 
       end

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

@@ -9,7 +9,7 @@ module LiveQA
       class ClientMiddleware
 
         def call(_worker_class, job, _queue, _redis_pool)
-          job['liveqa_store'] = LiveQA::Store.store
+          job['liveqa_session_tracker_id'] = LiveQA::Store.store[:session_tracker_id]
           yield
         end
 

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

@@ -9,7 +9,7 @@ module LiveQA
       class ServerMiddleware
 
         def call(_worker, job, _queue)
-          LiveQA::Store.load_from_hash(job['liveqa_store'])
+          LiveQA::Store.set(:session_tracker_id, job['liveqa_session_tracker_id'] || SecureRandom.uuid)
           store_worker_data(job)
           yield
         ensure
@@ -36,7 +36,7 @@ module LiveQA
         end
 
         def convert_to_iso8601(int_time)
-          Time.at(int_time).utc.iso8601
+          Time.at(int_time).utc.iso8601(3)
         rescue
           nil
         end

data/lib/liveqa/plugins.rb

@@ -7,6 +7,7 @@ if defined?(Rack)
   if defined?(Rails)
     require 'liveqa/plugins/rails/railtie'
     require 'liveqa/plugins/rails/middleware_data'
+    require 'liveqa/plugins/rails/data'
   end
 end
 

data/lib/liveqa/request.rb

@@ -60,6 +60,7 @@ module LiveQA
     def put
       @request = Net::HTTP::Put.new(uri.path)
 
+      set_header
       request.body = params[:payload]
 
       handle_request
@@ -76,6 +77,7 @@ module LiveQA
     def delete
       @request = Net::HTTP::Delete.new(uri.path)
 
+      set_header
       request.body = params[:payload]
 
       handle_request

data/lib/liveqa/store.rb

@@ -2,7 +2,7 @@ module LiveQA
   ##
   # == LiveQA \Store
   #
-  # Store environement data
+  # Store environment data
   #
   class Store
     class << self

data/lib/liveqa/util.rb

@@ -3,7 +3,30 @@ module LiveQA
     class << self
 
       DATE_FORMAT = '%Y/%m/%d'.freeze
-      OBFUSCATED  = '[HIDDEN]'.freeze
+      OBFUSCATED = '[HIDDEN]'.freeze
+      DEFAULT_OBJECT_DEF = %w[id name].freeze
+
+      ##
+      # Remove keys from a Hash
+      #
+      # @param [Hash] to be excepted
+      # @param [List[String]] to be excepted
+      #
+      # @return [Hash]
+      def except_keys(hash, *keys)
+        hash.dup.delete_if { |(key, _value)| keys.include?(key) }
+      end
+
+      ##
+      # Convert string to camelize
+      #
+      # @param [String]
+      #
+      # @example
+      #   camelize('my_model') => 'MyModel'
+      def camelize(string)
+        string.split('_').map(&:capitalize).join
+      end
 
       ##
       # Remove nil value from hash
@@ -128,6 +151,38 @@ module LiveQA
         end
       end
 
+      ##
+      # Convert object into Hash
+      #
+      # @params [Objects]
+      #
+      # @return [Hash]
+      def properties(*args)
+        params = extract_params!(args)
+
+        attributes = params.each_with_object({}) do |(key, value), hash|
+          hash[key] = extract_object(value)
+        end
+
+        attributes.merge(
+          args.each_with_object({}) do |object, hash|
+            key = object.class.name.downcase
+            next if key.nil?
+
+            hash[key] = extract_object(object)
+          end
+        )
+      end
+
+      ##
+      # Parse JSON without raise
+      #
+      def safe_json_parse(data)
+        JSON.parse(data.to_s)
+      rescue JSON::ParserError
+        {}
+      end
+
       private
 
       def deep_transform_keys_in_object(object, &block)
@@ -143,6 +198,31 @@ module LiveQA
         end
       end
 
+      def extract_object(object, custom_object_properties = LiveQA.configurations.custom_object_properties)
+        return unless object
+
+        object_name = object.class.name.downcase
+
+        columns =
+          custom_object_properties[object_name.to_sym] ||
+          custom_object_properties[object_name.to_s] ||
+          DEFAULT_OBJECT_DEF
+
+        params = columns.each_with_object({}) do |column, attributes|
+          attributes[column.to_s] = object.send(column) if object.respond_to?(column)
+        end
+
+        params.empty? ? object : params
+      end
+
+      def extract_params!(args)
+        if args.last.is_a?(Hash) && args.last.instance_of?(Hash)
+          args.pop
+        else
+          {}
+        end
+      end
+
     end
   end
 end

data/lib/liveqa/version.rb

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

data/lib/liveqa/watcher.rb

@@ -0,0 +1,15 @@
+module LiveQA
+  ##
+  # == LiveQA \Watcher
+  #
+  # Create and update groups
+  #
+  # @example: Usage
+  #
+  #   request = LiveQA::Watcher.create(template_flow: 'My Flow', expected_times: 42) #=> #<LiveQA::Response...>
+  #
+  class Watcher < APIResource
+    include LiveQA::APIOperation::Save
+    include LiveQA::APIOperation::Delete
+  end
+end

data/lib/liveqa.rb

@@ -3,6 +3,8 @@ require 'securerandom'
 require 'net/http'
 require 'ostruct'
 require 'json'
+require 'time'
+require 'cgi'
 
 # Async
 require 'liveqa/async_handlers/base'
@@ -21,9 +23,13 @@ require 'liveqa/message'
 
 # Operations
 require 'liveqa/api_operation/save'
+require 'liveqa/api_operation/delete'
 
 # Resources
 require 'liveqa/event'
+require 'liveqa/group'
+require 'liveqa/identity'
+require 'liveqa/watcher'
 
 # Plugins
 require 'liveqa/plugins'
@@ -42,7 +48,9 @@ module LiveQA
     #
     # @example Default configuration
     #   LiveQA.configure do |config|
-    #     config.api_key   = 'your-api-key'
+    #      config.account_token = 'acc_xx'
+    #      config.space_name = 'LiveQA'
+    #      config.environment_name = 'production'
     #   end
     def configure
       yield @configurations = LiveQA::Config.new
@@ -54,7 +62,6 @@ module LiveQA
     # 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
     #
@@ -64,8 +71,9 @@ module LiveQA
 
       payload[:type] = 'track'
       payload[:name] = name
+      LiveQA::Plugins::Rails::Data.store_data if defined?(LiveQA::Plugins::Rails::Data)
 
-      payload = Event.build_payload(payload)
+      payload = Message.extended.merge(payload)
 
       if configurations.async_handler
         return configurations.async_handler.enqueue('LiveQA::Event', 'create', payload, request_options)
@@ -89,8 +97,9 @@ module LiveQA
 
       payload[:type]    = 'identify'
       payload[:user_id] = user_id
+      LiveQA::Plugins::Rails::Data.store_data if defined?(LiveQA::Plugins::Rails::Data)
 
-      payload = Event.build_payload(payload)
+      payload = Message.extended.merge(payload)
 
       if configurations.async_handler
         return configurations.async_handler.enqueue('LiveQA::Event', 'create', payload, request_options)
@@ -101,5 +110,74 @@ module LiveQA
       event.successful?
     end
 
+    ##
+    # Send a create/update for a group
+    #
+    # @param [String] group id from your database
+    # @param [Hash] payload to be send
+    # @param [Hash] options for the request
+    #
+    # @return [LiveQA::Object] response from the server
+    def set_group(group_id, payload = {}, request_options = {})
+      return true unless configurations.enabled
+
+      payload = Message.base.merge(payload)
+
+      if configurations.async_handler
+        return configurations.async_handler.enqueue('LiveQA::Group', 'update', group_id, payload, request_options)
+      end
+
+      group = Group.update(group_id, payload, request_options)
+
+      group.successful?
+    end
+
+    ##
+    # Send a create/update for an identity
+    #
+    # @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 set_identity(user_id, payload = {}, request_options = {})
+      return true unless configurations.enabled
+
+      payload = Message.base.merge(payload)
+
+      if configurations.async_handler
+        return configurations.async_handler.enqueue('LiveQA::Identity', 'update', user_id, payload, request_options)
+      end
+
+      identity = Identity.update(user_id, payload, request_options)
+
+      identity.successful?
+    end
+
+    ##
+    # Send a create a watcher
+    #
+    # @param [String|Integer] template flow name or id
+    # @param [Hash] payload to be send
+    # @param [Hash] options for the request
+    #
+    # @return [LiveQA::Object] response from the server
+    def watch(id_or_name, payload = {}, request_options = {})
+      return true unless configurations.enabled
+
+      payload[:template_flow] = id_or_name
+      payload = Message.base.merge(payload)
+
+      payload.delete(:session_tracker_id) if payload.delete(:without_session)
+
+      if configurations.async_handler
+        return configurations.async_handler.enqueue('LiveQA::Watcher', 'create', payload, request_options)
+      end
+
+      watcher = Watcher.create(payload, request_options)
+
+      watcher.successful?
+    end
+
   end
 end

data/spec/lib/liveqa/api_resource_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe LiveQA::APIResource do
+
+  describe '#request' do
+    subject(:resource) { LiveQA::APIResource.request(:post, '/test') }
+
+    context 'valid request' do
+      let(:response) { double('response', code: '200', code_type: Net::HTTPOK, body: {}.to_json) }
+
+      context 'default payload' do
+        let(:expected_payload) {{
+          method:  :post,
+          url:     'http://localhost:4003/test',
+          payload: '{}',
+          use_ssl: false,
+          headers: {
+            accept:             'application/json',
+            content_type:       'application/json',
+            x_account_token:    'acc_xx',
+            x_space_name:       'LiveQA',
+            x_environment_name: 'test'
+          }
+        }}
+
+        after { resource }
+
+        it { expect(LiveQA::Request).to receive(:execute).with(expected_payload).and_return(response)  }
+      end
+
+      context 'with body and post' do
+        let(:expected_payload) {{
+          method:  :post,
+          url:     'http://localhost:4003/test',
+          payload: "{\"test\":true}",
+          use_ssl: false,
+          headers: {
+            accept:             'application/json',
+            content_type:       'application/json',
+            x_account_token:    'acc_xx',
+            x_space_name:       'LiveQA',
+            x_environment_name: 'test'
+          }
+        }}
+
+        after { LiveQA::APIResource.request(:post, '/test', { test: true }) }
+
+        it { expect(LiveQA::Request).to receive(:execute).with(expected_payload).and_return(response)  }
+      end
+
+      context 'with body and get' do
+        let(:expected_payload) {{
+          method:  :get,
+          url:     'http://localhost:4003/test?test=true',
+          payload: "{\"test\":true}",
+          use_ssl: false,
+          headers: {
+            accept:             'application/json',
+            content_type:       'application/json',
+            x_account_token:    'acc_xx',
+            x_space_name:       'LiveQA',
+            x_environment_name: 'test'
+          }
+        }}
+
+        after { LiveQA::APIResource.request(:get, '/test', { test: true }) }
+
+        it { expect(LiveQA::Request).to receive(:execute).with(expected_payload).and_return(response)  }
+      end
+
+      context 'with overwrite headers tokens' do
+        let(:expected_payload) {{
+          method:  :post,
+          url:     'http://localhost:4003/test',
+          payload: '{}',
+          use_ssl: false,
+          headers: {
+            accept:             'application/json',
+            content_type:       'application/json',
+            x_account_token:    'acc_42',
+            x_space_name:       'MySpace',
+            x_environment_name: 'staging'
+          }
+        }}
+
+        after { LiveQA::APIResource.request(:post, '/test', {}, account_token: 'acc_42', space_name: 'MySpace', environment_name: 'staging') }
+
+        it { expect(LiveQA::Request).to receive(:execute).with(expected_payload).and_return(response)  }
+      end
+    end
+
+    context 'with errors' do
+      before { allow(LiveQA::Request).to receive(:execute).and_raise(LiveQA::RequestError.new(response)) }
+
+      context 'with Net::HTTPUnprocessableEntity' do
+        let(:response) { double('response', code: '422', code_type: Net::HTTPUnprocessableEntity, body: {}.to_json, message: 'failed') }
+
+        it { expect { resource }.to_not raise_error }
+      end
+
+      context 'with Net::HTTPBadRequest' do
+        let(:response) { double('response', code: '400', code_type: Net::HTTPBadRequest, body: {}.to_json, message: 'failed') }
+
+        it { expect { resource }.to_not raise_error }
+      end
+    end
+  end
+
+end

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

@@ -10,10 +10,20 @@ describe LiveQA::AsyncHandlers::Base do
   end
 
   describe 'execute' do
-    let(:params) { ['LiveQA::Event', 'create', { test: true }] }
+    context 'default params' do
+      let(:params) { ['LiveQA::Event', 'create', { test: true }] }
 
-    after { base.execute(params) }
+      after { base.execute(params) }
 
-    it { expect(LiveQA::Event).to receive(:create).with({ test: true }, nil) }
+      it { expect(LiveQA::Event).to receive(:create).with({ test: true }) }
+    end
+
+    context 'more params params' do
+      let(:params) { ['LiveQA::Group', 'update', 42, { test: true }, { no_ssl: true }] }
+
+      after { base.execute(params) }
+
+      it { expect(LiveQA::Group).to receive(:update).with(42, { test: true }, { no_ssl: true }) }
+    end
   end
 end

data/spec/lib/liveqa/config_spec.rb

@@ -4,30 +4,32 @@ describe LiveQA::Config do
   subject(:config) { LiveQA::Config.new(params) }
 
   describe  '#initialize' do
-    let(:params) {{ api_key: SecureRandom.hex }}
+    let(:params) {{ account_token: 'acc_xx', space_name: 'LiveQA', environment_name: 'test' }}
 
     it { expect(config.valid!).to be_truthy }
 
-    %i[api_key api_host api_version].each do |field|
+    %i[account_token environment_name 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 => '')}
+        let(:params) {{ account_token: 'acc_xx', space_name: 'LiveQA', environment_name: 'test', 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] }}
+      let(:params) {{ account_token: 'acc_xx', space_name: 'LiveQA', environment_name: 'test', 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]) }
+      it { expect(config.obfuscated_fields).to match_array(%w[another_password password_confirmation password access_token api_key authenticity_token ccv credit_card_number cvv secret secret_token token]) }
     end
 
     context 'async_handler' do
       context 'sidekiq' do
         let(:params) {{
-          api_key: SecureRandom.hex,
+          account_token: 'acc_xx',
+          space_name: 'LiveQA',
+          environment_name: 'test',
           async_handler: :sidekiq
         }}
         before { config.valid! }

data/spec/lib/liveqa/event_spec.rb

@@ -2,35 +2,14 @@ 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: '') }
+    let(:response) { double('LiveQA::Request', body:  "{\"object\":\"event\",\"id\":41}") }
     before { expect(LiveQA::Request).to receive(:execute).and_return(response) }
 
     subject(:create) { LiveQA::Event.create(user_id: 42) }
 
     it { is_expected.to be_successful }
+    it { expect(create.id).to eq(41) }
   end
 
 end

data/spec/lib/liveqa/group_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe LiveQA::Group do
+
+  describe '#update' do
+    let(:response) { double('LiveQA::Request', body: "{\"object\":\"group\",\"id\":3,\"externalId\":\"41df8a48a68cb7c94e119ef7f1380537\",\"rawData\":{\"name\":\"Lubowitz, Cartwright and Davis\",\"email\":\"kenya_parker@batz.info\",\"plan\":\"premium\",\"address\":{\"street\":\"19222 Keyshawn Mountain\",\"city\":\"Rogahnmouth\",\"state\":\"Hawaii\",\"postal_code\":\"98441-4908\",\"country\":\"Singapore\"}}}") }
+    before { expect(LiveQA::Request).to receive(:execute).and_return(response) }
+
+    subject(:update) { LiveQA::Group.update('41df8a48a68cb7c94e119ef7f1380537', properties: { name: 'Lubowitz, Cartwright and Davis' }) }
+
+    it { is_expected.to be_successful }
+    it { expect(update.external_id).to eq('41df8a48a68cb7c94e119ef7f1380537') }
+  end
+
+end

data/spec/lib/liveqa/identity_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe LiveQA::Identity do
+
+  describe '#update' do
+    let(:response) { double('LiveQA::Request', body: "{\"object\":\"identity\",\"id\":1,\"externalId\":\"8b5439f2bc0bc5bc2b80817f29477f0d\",\"trackerIds\":[],\"rawData\":{\"name\":\"Runte, Macejkovic and Reinger\",\"email\":\"hardy@abernathy.com\",\"plan\":\"premium\",\"address\":{\"street\":\"680 Collins Branch\",\"city\":\"Holdenview\",\"state\":\"Alabama\",\"postal_code\":\"51094-2637\",\"country\":\"America\"}},\"devices\":{\"object\":\"list\",\"data\":[{\"object\":\"device\",\"bot\":false,\"botName\":null,\"brand\":null,\"browserName\":\"chrome\",\"fullVersion\":\"62.0.3202.94\",\"known\":true,\"name\":null,\"osFullVersion\":\"10.12.5\",\"osName\":\"mac\",\"osVersion\":\"10\",\"type\":\"desktop\",\"version\":\"62\",\"usedLastAt\":null}]}}") }
+    before { expect(LiveQA::Request).to receive(:execute).and_return(response) }
+
+    subject(:update) { LiveQA::Identity.update('8b5439f2bc0bc5bc2b80817f29477f0d', properties: { name: 'Runte, Macejkovic and Reinger' }) }
+
+    it { is_expected.to be_successful }
+    it { expect(update.external_id).to eq('8b5439f2bc0bc5bc2b80817f29477f0d') }
+  end
+
+end

data/spec/lib/liveqa/liveqa_object_spec.rb

@@ -5,7 +5,24 @@ describe LiveQA::LiveQAObject do
   let(:klass) { Class.new(LiveQA::LiveQAObject) }
   subject(:instance) { klass.new(id: 42, name: 'test', test: true) }
 
-  let(:api_response) { '' }
+  let(:api_response) {{
+    object: 'event',
+    id:     42,
+    other:  'other test'
+  }}
+
+  let(:api_responses) {{
+    object:     'list',
+    currentPage: 10,
+    data: [{
+      object: 'group',
+      id: 42,
+      other: 'other test'
+    }],
+    links: {
+      self: 'http://www.liveqa.io/test'
+    }
+  }}
 
   describe 'add attribute accessors' do
     it { expect(instance.id).to eq(42) }
@@ -62,10 +79,44 @@ describe LiveQA::LiveQAObject do
 
   describe '.initialize_from' do
     context 'with single object' do
-      subject(:instance) { klass.initialize_from(api_response) }
+      subject(:instance) { klass.initialize_from(api_response.to_json) }
 
       it { is_expected.to be_successful }
+      it { expect(instance.id).to eq(42) }
+      it { expect(instance.other).to eq('other test') }
+      it { expect { instance.name }.to raise_error(NameError) }
     end
+
+    context 'with array' do
+      subject(:instance) { klass.initialize_from(api_responses.to_json) }
+
+      it { is_expected.to be_successful }
+      it { expect(instance.data.size).to eq(1) }
+      it { expect(instance.data.first).to be_a(LiveQA::Group) }
+      it { expect(instance.current_page).to eq(10) }
+      it { expect(instance.links[:self]).to eq('http://www.liveqa.io/test') }
+    end
+
+    context 'with empty string' do
+      subject(:instance) { klass.initialize_from('') }
+
+      it { is_expected.to be_successful }
+    end
+
+    context 'with nil' do
+      subject(:instance) { klass.initialize_from(nil) }
+
+      it { is_expected.to be_successful }
+    end
+  end
+
+  describe '#update_from' do
+    before { instance.update_from(api_response) }
+
+    it { is_expected.to be_successful }
+    it { expect(instance.id).to eq(42) }
+    it { expect(instance.other).to eq('other test') }
+    it { expect { instance.name }.to raise_error(NameError) }
   end