fyipe 3.0.11963.pre.qa → 3.0.12011.pre.qa

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f16a8e61b9c2a934cdfdedc8b9eb1a7b839d15b3f44165d3eea3b61f6c71319
-  data.tar.gz: 4be203758307e72ff3b1696cfd77e45eed79e9c0d4b5ee1619138a3e95d37f59
+  metadata.gz: f8d3bba726a8b48899ca39958b0dc269f9298893e26a145dfcfbc3dae4c56819
+  data.tar.gz: fc43cc610d3821ea7d896e41422e8cc7ddd318e4b79daf1d4af87911b4c473fb
 SHA512:
-  metadata.gz: 87fa1d4d960e01c97af88a8827233b035888d5e1035151eaed197e3e6e35c68f923fc4376d1653c09ddbb47f938a4e6836518a30e5f1aa59501f084e8cd23791
-  data.tar.gz: 2ea235a44d88f2fe5649f82aa172087760a7827464df398d65af2ab6af1cd9b8b9b1ff2dd8b0c956cb7840f3d60981e2604e2cb06e7082a20d0e3843f208824c
+  metadata.gz: 5a82dd49932cdb64d345be1e1ee9be2b61d65a1862c93b214730f7c4056242a2d9be69ca00fac395a9cc6240f861c715527bb13bcb79ed0796cb348a8f31d213
+  data.tar.gz: 4ab5b065b55c44ce7ff3685442cabcaf07479135e223176ba06efa718c7b13d615779abac03a5547be4fd222372cf7c2ff63c62b33706bf795c5a8625b2a3b94

data/README.md

@@ -61,6 +61,72 @@ response = logger.log(item, tags)
 puts response
 ```
 
+## Basic Usage for Tracking
+
+```ruby
+require 'fyipe'
+
+# constructor
+
+# set up tracking configurations
+options = {
+    "maxTimeline": 50,
+    "captureCodeSnippet": true
+}
+tracker = FyipeLogger.new(
+    'API_URL', # https://fyipe.com/api
+    'ERROR_TRACKER_ID',
+    'ERROR_TRACKER_KEY',
+    options # optional
+)
+
+# capturing a timeline manually
+timelineContent = {}
+
+timelineContent["account"] = "debit"
+timelineContent["amount"] = "6000.00"
+timelineContent["userId"] = 471
+tracker.addToTimeline('payment', timelineContent, 'info')
+
+# setting custom tags
+tracker.setTag('category', 'QA Tester') # a single tag
+
+# multiple tags
+tags = []
+
+# create two tags
+tagOne = {}
+tagOne["key"] = 'type'
+tagOne["value"] = 'notification'
+tagTwo = {}
+tagTwo["key"] = 'location'
+tagTwo["value"] = 'Oslo'
+
+# add the two items to the array
+tags = [tagOne, tagTwo]
+
+# setting the array of tags
+tracker.setTags(tags)
+
+
+# all error exception captured are sent to your fyipe dashboard
+
+# capturing errors in a begin and rescue
+begin
+    # some code that might fail
+    result = 5/0 # Should throw a division by zero error
+rescue => ex
+    tracker.captureException(ex)
+end
+
+# capturing errors using the message signature
+tracker.captureMessage('some error text')
+
+# capturing errors authomatically
+NonExistingMethod() # calling this will trigger an error and its sent to your fyipe dashboard
+
+```
+
 ## API Documentation
 
 Main API to send logs to the server.
@@ -71,11 +137,20 @@ Main API to send logs to the server.
     -   [Installation](#installation)
         -   [Gem Install](#gem-install)
     -   [Basic Usage for Logging](#basic-usage-for-logging)
+    -   [Basic Usage for Tracking](#basic-usage-for-tracking)
     -   [API Documentation](#api-documentation)
         -   [FyipeLogger.new(apiUrl, applicationId, applicationKey)](#fyipeloggernewapiurl-applicationid-applicationkey)
             -   [logger.log(log, \tags)](#loggerloglog-tags)
             -   [logger.warning(warning, \tags)](#loggerwarningwarning-tags)
             -   [logger.error(error, \tags)](#loggererrorerror-tags)
+        -   [FyipeTracker.new(apiUrl, errorTrackerId, errorTrackerKey)](#fyipetrackernewapiurl-errortrackerid-errortrackerkey)
+            -   [options](#options)
+            -   [tracker.setTag(key, value)](#trackersettagkey-value)
+            -   [tracker.setTags([{key, value}])](#trackersettagskey-value)
+            -   [tracker.setFingerprint(fingerprint)](#trackersetfingerprintfingerprint)
+            -   [tracker.addToTimeline(category, content, type)](#trackeraddtotimelinecategory-content-type)
+            -   [tracker.captureMessage(message)](#trackercapturemessagemessage)
+            -   [tracker.captureException(error)](#trackercaptureexceptionerror)
     -   [Contribution](#contribution)
 
 <a name="logger_api--logger"></a>
@@ -129,6 +204,99 @@ Logs a request of type `error` to the server.
 | \error | <code>string</code> \| <code>Object</code> | The content to the logged on the server.                    |
 | \tags  | <code>string</code> \| <code>Array</code>  | The tag(s) to be attached to the logged item on the server. |
 
+<a name="tracker_api--tracker"></a>
+
+### FyipeTracker.new(apiUrl, errorTrackerId, errorTrackerKey)
+
+Create a constructor from the class, which will be used to track errors sent to the server.
+
+**Kind**: Constructor
+**Returns**: <code>null</code>
+
+| Param           | Type                | Description                                 |
+| --------------- | ------------------- | ------------------------------------------- |
+| apiUrl          | <code>string</code> | The Server URL.                             |
+| errorTrackerId  | <code>string</code> | The Error Tracker ID.                       |
+| errorTrackerKey | <code>string</code> | The Error Tracker Key.                      |
+| option          | <code>object</code> | The options to be considred by the tracker. |
+
+#### options
+
+| Param              | Type                 | Description                                                                                           |
+| ------------------ | -------------------- | ----------------------------------------------------------------------------------------------------- |
+| maxTimeline        | <code>int</code>     | The total amount of timeline that should be captured, defaults to 5                                   |
+| captureCodeSnippet | <code>boolean</code> | When set as `true` stack traces are automatically attached to all error sent to your fyipe dashboard. |
+
+#### tracker.setTag(key, value)
+
+Set tag for the error to be sent to the server.
+
+**Kind**: method of [<code>FyipeTracker</code>](#tracker_api--tracker)
+**Returns**: <code>null</code>
+
+| Param | Type                | Description            |
+| ----- | ------------------- | ---------------------- |
+| key   | <code>string</code> | The key for the tag.   |
+| value | <code>string</code> | The value for the tag. |
+
+#### tracker.setTags([{key, value}])
+
+Set multiple tags for the error to be sent to the server. Takes in a list
+
+**Kind**: method of [<code>FyipeTracker</code>](#tracker_api--tracker)
+**Returns**: <code>null</code>
+
+| Param | Type                | Description            |
+| ----- | ------------------- | ---------------------- |
+| key   | <code>string</code> | The key for the tag.   |
+| value | <code>string</code> | The value for the tag. |
+
+#### tracker.setFingerprint(fingerprint)
+
+Set fingerprint for the next error to be captured.
+
+**Kind**: method of [<code>FyipeTracker</code>](#tracker_api--tracker)
+**Returns**: <code>null</code>
+
+| Param       | Type                                                | Description                                                   |
+| ----------- | --------------------------------------------------- | ------------------------------------------------------------- |
+| fingerprint | <code>string</code> \| <code>list of strings</code> | The set of string used to group error messages on the server. |
+
+#### tracker.addToTimeline(category, content, type)
+
+Add a custom timeline element to the next error to be sent to the server
+
+**Kind**: method of [<code>FyipeTracker</code>](#tracker_api--tracker)
+**Returns**: <code>null</code>
+
+| Param    | Type                                       | Description                         |
+| -------- | ------------------------------------------ | ----------------------------------- |
+| category | <code>string</code>                        | The category of the timeline event. |
+| content  | <code>string</code> \| <code>object</code> | The content of the timeline event.  |
+| type     | <code>string</code>                        | The type of timeline event.         |
+
+#### tracker.captureMessage(message)
+
+Capture a custom error message to be sent to the server
+
+**Kind**: method of [<code>FyipeTracker</code>](#tracker_api--tracker)
+**Returns**: <code>Promise</code>
+
+| Param   | Type                | Description                           |
+| ------- | ------------------- | ------------------------------------- |
+| message | <code>string</code> | The message to be sent to the server. |
+
+#### tracker.captureException(error)
+
+Capture a custom error object to be sent to the server
+
+**Kind**: method of [<code>FyipeTracker</code>](#tracker_api--tracker)
+**Returns**: <code>Promise</code>
+
+| Param | Type                          | Description                                |
+| ----- | ----------------------------- | ------------------------------------------ |
+| error | <code>Exception object</code> | The Error Object to be sent to the server. |
+
 ## Contribution
 
 -   Clone repository

data/lib/fyipe.rb

@@ -0,0 +1,2 @@
+require_relative 'fyipeLogger'
+require_relative 'fyipeTracker'

data/lib/fyipe/version.rb

@@ -1,4 +1,4 @@
 module Fyipe
     NAME = 'fyipe'
-    VERSION = '3.0.11963-qa'
+    VERSION = '3.0.12011-qa'
 end

data/lib/fyipeTracker.rb

@@ -4,7 +4,7 @@ require_relative 'fyipe/fyipeTransport'
 require File.expand_path('./fyipe/version', __dir__)
 
 class FyipeTracker
-    # FyipeLogger constructor.
+    # FyipeTracker constructor.
     # @param string apiUrl
     # @param string errorTrackerId
     # @param string errorTrackerKey
@@ -27,7 +27,7 @@ class FyipeTracker
         setEventId()
         @listenerObj = FyipeListener.new(getEventId(), @options)
         @apiTransport = FyipeTransport.new(@apiUrl)
-        # setUpExceptionHandlerListener()
+        setUpExceptionHandlerListener()
     end
 
     def setApiUrl(apiUrl)

data/spec/fyipe_logger_spec.rb

@@ -1,5 +1,5 @@
 # spec/fyipe_logger_spec.rb
-require_relative '../lib/fyipeLogger'
+require_relative '../lib/fyipe'
 require_relative 'helper'
 
 RSpec.configure do |config|
@@ -55,7 +55,7 @@ RSpec.describe FyipeLogger do
         logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
         response = logger.log(log)
         expect(response['content']).to eql log
-        expect(response['content'].class.to_s).to eql "String"
+        expect(response['content']).to be_an_instance_of(String)
         expect(response['type']).to eql "info"
     end
     it 'test_valid_object_content_of_type_info_is_logged' do
@@ -66,7 +66,7 @@ RSpec.describe FyipeLogger do
         logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
         response = logger.log(log)
         expect(response['content']["location"]).to eql log["location"]
-        expect(response['content'].class.to_s).to eql "Hash"
+        expect(response['content']).to be_an_instance_of(Hash)
         expect(response['type']).to eql "info"
     end
     it 'test_valid_string_content_of_type_error_is_logged' do
@@ -74,7 +74,7 @@ RSpec.describe FyipeLogger do
         logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
         response = logger.error(log)
         expect(response['content']).to eql log
-        expect(response['content'].class.to_s).to eql "String"
+        expect(response['content']).to be_an_instance_of(String)
         expect(response['type']).to eql "error"
     end
     it 'test_valid_object_content_of_type_warning_is_logged' do
@@ -85,7 +85,7 @@ RSpec.describe FyipeLogger do
         logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
         response = logger.warning(log)
         expect(response['content']["location"]).to eql log["location"]
-        expect(response['content'].class.to_s).to eql "Hash"
+        expect(response['content']).to be_an_instance_of(Hash)
         expect(response['type']).to eql "warning"
     end
     it 'test_valid_object_content_of_type_warning_with_one_tag_is_logged' do
@@ -97,9 +97,9 @@ RSpec.describe FyipeLogger do
         logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
         response = logger.warning(log, tag)
         expect(response['content']["location"]).to eql log["location"]
-        expect(response['content'].class.to_s).to eql "Hash"
+        expect(response['content']).to be_an_instance_of(Hash)
         expect(response['type']).to eql "warning"
-        expect(response['tags'].class.to_s).to eql "Array"
+        expect(response['tags']).to be_an_instance_of(Array)
         expect(response['tags'].find { |item| item == tag }).to_not be_nil
     end
     it 'test_valid_object_content_of_type_error_with_no_tag_is_logged' do
@@ -107,10 +107,8 @@ RSpec.describe FyipeLogger do
         logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
         response = logger.error(log)
         expect(response['content']).to eql log
-        expect(response['content'].class.to_s).to eql "String"
+        expect(response['content']).to be_an_instance_of(String)
         expect(response['type']).to eql "error"
-        expect(response['tags'].class.to_s).to eql "Array"
-        expect(response['tags']).to eql []
     end
     it 'test_valid_object_content_of_type_warning_with_four_tags_is_logged' do
         log = {
@@ -121,9 +119,9 @@ RSpec.describe FyipeLogger do
         logger = FyipeLogger.new($apiUrl, $applicationLog["_id"], $applicationLog["key"])
         response = logger.warning(log, tags)
         expect(response['content']["location"]).to eql log["location"]
-        expect(response['content'].class.to_s).to eql "Hash"
+        expect(response['content']).to be_an_instance_of(Hash)
         expect(response['type']).to eql "warning"
-        expect(response['tags'].class.to_s).to eql "Array"
+        expect(response['tags']).to be_an_instance_of(Array)
         tags.each {
             |tag| expect(response['tags'].find { |item| item == tag }).to_not be_nil
         }

data/spec/fyipe_tracker_spec.rb

@@ -1,5 +1,5 @@
 # spec/fyipe_tracker_spec.rb
-require_relative '../lib/fyipeTracker'
+require_relative '../lib/fyipe'
 require_relative 'helper'
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fyipe
 version: !ruby/object:Gem::Version
-  version: 3.0.11963.pre.qa
+  version: 3.0.12011.pre.qa
 platform: ruby
 authors:
 - HackerBay, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -154,6 +154,7 @@ files:
 - README.md
 - RakeFile
 - fyipe.gemspec
+- lib/fyipe.rb
 - lib/fyipe/fyipeListener.rb
 - lib/fyipe/fyipeTransport.rb
 - lib/fyipe/logtype.rb