fyipe 3.0.11966.pre.qa → 3.0.12005.pre.qa

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 774c4c97683999c8ff9d578f0ebc59ac3471302cd96f947d5d9cc7aae8ba7ba6
-  data.tar.gz: e0308bbb878aa152d9da98fe5557c776a8ebb4d42d5ac72f8d913e2c7fc247aa
+  metadata.gz: c7cd6b2e3cef633df0aef32eea26122a53fe3690cd08211f6b8ee4f67fdb8fe6
+  data.tar.gz: 22bdd963c3ea45a6cdd56141fe13693c443a4afde2f62388af8c3ce381b180f6
 SHA512:
-  metadata.gz: e58ae5e662707293734ba9ed12eb904964958ad2353e43a3a95ec59b8b16b33d81f6109b83a22efa108cadc64f88022e74c9a5eee82fa6913ce0b16212a683e6
-  data.tar.gz: 3db98f004dca0d747219f9457cfbe32a2c67633bf92d721262391dfe76e45f04cc0821e0a73eb4c75f315d7d36a94f769425ee7f2299f171f2d2c6022d9cf359
+  metadata.gz: 48f334801cce2fde6c86191bd0b89611cafa3370e6f4188fb7673835d1981c9f27a76daf5d4b51c98f6a4c7257edc93f94d5257adf844df37c71339c4529f1e6
+  data.tar.gz: 21650569ea71ab49c9f00d7205e177430c08e225c45bd185a3f718fdec34a457d5c83f86aba4f3eb1e7af4176a0e30d136b063fe7a27fcc07687b8e55d8b8811

data/README.md

@@ -61,6 +61,35 @@ 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 error exception manually and sent to your fyipe dashboard
+begin
+    # your code logic
+    result = 5/0 # Should throw a division by zero error
+rescue => ex
+    tracker.captureException(ex)
+end
+
+```
+
 ## API Documentation
 
 Main API to send logs to the server.
@@ -71,11 +100,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 +167,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.11966-qa'
+    VERSION = '3.0.12005-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

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.11966.pre.qa
+  version: 3.0.12005.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