fyipe 3.0.11437
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +5 -0
- data/Gemfile +5 -0
- data/LICENSE +18 -0
- data/README.md +137 -0
- data/fyipe.gemspec +30 -0
- metadata +163 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: d95186e5e6f0d7a500ff341fb773262e9e2fc1c33e3c487413fd5b2633677b8c
|
4
|
+
data.tar.gz: 252085e0ff805fbe142919609b54fe94e5028247d920939ced0158a8d42316a1
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f99442798aaf0d14956d870fa8959d70b7a1a1ec4b3c3e948eb87546925ed957112f255be570dfe17de43f7c00a9717e17b246ff38364bd2e507493ce56a76c4
|
7
|
+
data.tar.gz: 91ed8b2b1feeafaab9f2b73eb2f17f4befbe4837fbac531cadf5aa700be0b0980c71ffed14e03d072d69f5e6f4ea682f13836781709047037b7e9033714ae263
|
data/CHANGELOG.md
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
MIT License
|
2
|
+
Copyright (c) 2020 Lokalise team, Ilya Bodrov
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
The above copyright notice and this permission notice shall be
|
11
|
+
included in all copies or substantial portions of the Software.
|
12
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
13
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
14
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
15
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
16
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
17
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
18
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,137 @@
|
|
1
|
+
# Fyipe SDK
|
2
|
+
|
3
|
+
A fyipe sdk for application logger that can be used to send logs about your applications created on your fypie dashboard which can also used for error tracking
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
### Gem Install
|
8
|
+
|
9
|
+
Via Gem
|
10
|
+
|
11
|
+
```
|
12
|
+
gem install fyipe
|
13
|
+
```
|
14
|
+
|
15
|
+
<a name="module_api"></a>
|
16
|
+
|
17
|
+
## Basic Usage for Logging
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
# TODO require properly
|
21
|
+
|
22
|
+
# constructor
|
23
|
+
logger = FyipeLogger.new(
|
24
|
+
'API_URL', # https://fyipe.com/api
|
25
|
+
'APPLICATION_LOG_ID',
|
26
|
+
'APPLICATION_LOG_KEY'
|
27
|
+
)
|
28
|
+
|
29
|
+
|
30
|
+
# Sending a string log to the server
|
31
|
+
item = 'This is a simple log'
|
32
|
+
|
33
|
+
response = logger.log(item)
|
34
|
+
|
35
|
+
# response after logging a request
|
36
|
+
puts response
|
37
|
+
|
38
|
+
|
39
|
+
# Sending an object log to the server
|
40
|
+
item = {
|
41
|
+
"name" => "Tony Lewinsky",
|
42
|
+
"location" => "Liverpool"
|
43
|
+
}
|
44
|
+
|
45
|
+
response = logger.log(item)
|
46
|
+
# response after logging a request
|
47
|
+
puts response
|
48
|
+
|
49
|
+
# alternatively, tags can be added to the logged item.
|
50
|
+
item = 'This is a simple log'
|
51
|
+
# using a tag string
|
52
|
+
tag = 'server-side-error'
|
53
|
+
response = logger.log(item, tag)
|
54
|
+
# response after logging a request
|
55
|
+
puts response
|
56
|
+
|
57
|
+
# Using an array of strings
|
58
|
+
tags = ['error', 'server']
|
59
|
+
response = logger.log(item, tags)
|
60
|
+
# response after logging a request
|
61
|
+
puts response
|
62
|
+
```
|
63
|
+
|
64
|
+
## API Documentation
|
65
|
+
|
66
|
+
Main API to send logs to the server.
|
67
|
+
|
68
|
+
**Author**: HackerBay, Inc.
|
69
|
+
|
70
|
+
- [Fyipe SDK](#fyipe-sdk)
|
71
|
+
- [Installation](#installation)
|
72
|
+
- [Gem Install](#gem-install)
|
73
|
+
- [Basic Usage for Logging](#basic-usage-for-logging)
|
74
|
+
- [API Documentation](#api-documentation)
|
75
|
+
- [FyipeLogger.new(apiUrl, applicationId, applicationKey)](#fyipeloggernewapiurl-applicationid-applicationkey)
|
76
|
+
- [logger.log(log, \tags)](#loggerloglog-tags)
|
77
|
+
- [logger.warning(warning, \tags)](#loggerwarningwarning-tags)
|
78
|
+
- [logger.error(error, \tags)](#loggererrorerror-tags)
|
79
|
+
- [Contribution](#contribution)
|
80
|
+
|
81
|
+
<a name="logger_api--logger"></a>
|
82
|
+
|
83
|
+
### FyipeLogger.new(apiUrl, applicationId, applicationKey)
|
84
|
+
|
85
|
+
Create a constructor from the class, which will be used to send logs to the server.
|
86
|
+
|
87
|
+
**Kind**: Constructor
|
88
|
+
**Returns**: <code>null</code>
|
89
|
+
|
90
|
+
| Param | Type | Description |
|
91
|
+
| --------------- | ------------------- | ------------------------ |
|
92
|
+
| \apiUrl | <code>string</code> | The Server URL. |
|
93
|
+
| \applicationId | <code>string</code> | The Application Log ID. |
|
94
|
+
| \applicationKey | <code>string</code> | The Application Log Key. |
|
95
|
+
|
96
|
+
#### logger.log(log, \tags)
|
97
|
+
|
98
|
+
Logs a request of type `info` to the server.
|
99
|
+
|
100
|
+
**Kind**: method of [<code>FyipeLogger.new</code>](#logger_api--logger)
|
101
|
+
**Returns**: <code>Object</code> - An object response of a success or failure.
|
102
|
+
|
103
|
+
| Param | Type | Description |
|
104
|
+
| ----- | ------------------------------------------ | ----------------------------------------------------------- |
|
105
|
+
| \log | <code>string</code> \| <code>Object</code> | The content to the logged on the server. |
|
106
|
+
| \tags | <code>string</code> \| <code>Array</code> | The tag(s) to be attached to the logged item on the server. |
|
107
|
+
|
108
|
+
#### logger.warning(warning, \tags)
|
109
|
+
|
110
|
+
Logs a request of type `warning` to the server.
|
111
|
+
|
112
|
+
**Kind**: method of [<code>FyipeLogger.new</code>](#logger_api--logger)
|
113
|
+
**Returns**: <code>Object</code> - An object response of a success or failure.
|
114
|
+
|
115
|
+
| Param | Type | Description |
|
116
|
+
| -------- | ------------------------------------------ | ----------------------------------------------------------- |
|
117
|
+
| \warning | <code>string</code> \| <code>Object</code> | The content to the logged on the server. |
|
118
|
+
| \tags | <code>string</code> \| <code>Array</code> | The tag(s) to be attached to the logged item on the server. |
|
119
|
+
|
120
|
+
#### logger.error(error, \tags)
|
121
|
+
|
122
|
+
Logs a request of type `error` to the server.
|
123
|
+
|
124
|
+
**Kind**: method of [<code>FyipeLogger.new</code>](#logger_api--logger)
|
125
|
+
**Returns**: <code>Object</code> - An object response of a success or failure.
|
126
|
+
|
127
|
+
| Param | Type | Description |
|
128
|
+
| ------ | ------------------------------------------ | ----------------------------------------------------------- |
|
129
|
+
| \error | <code>string</code> \| <code>Object</code> | The content to the logged on the server. |
|
130
|
+
| \tags | <code>string</code> \| <code>Array</code> | The tag(s) to be attached to the logged item on the server. |
|
131
|
+
|
132
|
+
## Contribution
|
133
|
+
|
134
|
+
- Clone repository
|
135
|
+
- run `cd ruby-sdk/fyipe`
|
136
|
+
- run `bundle install` to install dependencies
|
137
|
+
- run `bundle exec rspec` to run tests
|
data/fyipe.gemspec
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
require File.expand_path('lib/fyipe/version', __dir__)
|
2
|
+
|
3
|
+
Gem::Specification.new do |spec|
|
4
|
+
|
5
|
+
spec.name = 'fyipe'
|
6
|
+
spec.version = Fyipe::VERSION
|
7
|
+
spec.authors = ['HackerBay, Inc.']
|
8
|
+
spec.email = ['hello@hackerbay.io']
|
9
|
+
spec.summary = 'Fyipe for Logging and Tracking'
|
10
|
+
spec.description = 'Fyipe is a ruby package that tracks error event and send logs from your applications to your fyipe dashboard.'
|
11
|
+
spec.homepage = 'https://github.com/Fyipe/ruby-sdk'
|
12
|
+
spec.license = 'MIT'
|
13
|
+
spec.platform = Gem::Platform::RUBY
|
14
|
+
spec.required_ruby_version = '>= 2.5.0'
|
15
|
+
spec.files = Dir['README.md', 'LICENSE',
|
16
|
+
'CHANGELOG.md', 'ruby-sdk/**/*.rb',
|
17
|
+
'ruby-sdk/**/*.rake',
|
18
|
+
'fyipe.gemspec', '.github/*.md',
|
19
|
+
'Gemfile', 'Rakefile']
|
20
|
+
spec.extra_rdoc_files = ['README.md']
|
21
|
+
spec.add_dependency 'httparty', '~> 0.17'
|
22
|
+
spec.add_dependency 'gem-release'
|
23
|
+
spec.add_development_dependency 'dotenv', '~> 2.5'
|
24
|
+
spec.add_development_dependency 'rspec', '~> 3.6'
|
25
|
+
spec.add_development_dependency 'rubocop', '~> 0.60'
|
26
|
+
spec.add_development_dependency 'rubocop-performance', '~> 1.5'
|
27
|
+
spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
|
28
|
+
spec.add_development_dependency 'faker', '~> 2.18'
|
29
|
+
|
30
|
+
end
|
metadata
ADDED
@@ -0,0 +1,163 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fyipe
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 3.0.11437
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- HackerBay, Inc.
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-06-07 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: httparty
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.17'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.17'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: gem-release
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: dotenv
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '2.5'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '2.5'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.6'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.6'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rubocop
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0.60'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0.60'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rubocop-performance
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '1.5'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '1.5'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rubocop-rspec
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '1.37'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '1.37'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: faker
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - "~>"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '2.18'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - "~>"
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '2.18'
|
125
|
+
description: Fyipe is a ruby package that tracks error event and send logs from your
|
126
|
+
applications to your fyipe dashboard.
|
127
|
+
email:
|
128
|
+
- hello@hackerbay.io
|
129
|
+
executables: []
|
130
|
+
extensions: []
|
131
|
+
extra_rdoc_files:
|
132
|
+
- README.md
|
133
|
+
files:
|
134
|
+
- CHANGELOG.md
|
135
|
+
- Gemfile
|
136
|
+
- LICENSE
|
137
|
+
- README.md
|
138
|
+
- fyipe.gemspec
|
139
|
+
homepage: https://github.com/Fyipe/ruby-sdk
|
140
|
+
licenses:
|
141
|
+
- MIT
|
142
|
+
metadata: {}
|
143
|
+
post_install_message:
|
144
|
+
rdoc_options: []
|
145
|
+
require_paths:
|
146
|
+
- lib
|
147
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
148
|
+
requirements:
|
149
|
+
- - ">="
|
150
|
+
- !ruby/object:Gem::Version
|
151
|
+
version: 2.5.0
|
152
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
153
|
+
requirements:
|
154
|
+
- - ">="
|
155
|
+
- !ruby/object:Gem::Version
|
156
|
+
version: '0'
|
157
|
+
requirements: []
|
158
|
+
rubyforge_project:
|
159
|
+
rubygems_version: 2.7.6
|
160
|
+
signing_key:
|
161
|
+
specification_version: 4
|
162
|
+
summary: Fyipe for Logging and Tracking
|
163
|
+
test_files: []
|