loginator 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -4
- data/lib/loginator/version.rb +1 -1
- data/loginator.gemspec +4 -4
- metadata +6 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 91060765e2db9b3bda7305d9e35365c019402fdc
|
|
4
|
+
data.tar.gz: f69a1dffa54c696d0d6e29990b15c57dde489fa3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 021d3256f1411a92381614f8e9e00d3eae892b6336e5c5e81ac8c0a54262d333a92c94fd63df9f24809e89d2940ffdd5c9573d2b2bbf3adf654e66534b5466c8
|
|
7
|
+
data.tar.gz: cc65834d3daebe8fc759971de1e440e013b572d2aa0152f8ac31c0a86f939f1af0c8e9557b97aa55885b5e1877c34a958ed900370878cd6aad52c09c0c091803
|
data/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# Loginator
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Loginator is a gem for standardizing the logging of requests and responses for
|
|
4
|
+
remote APIs.
|
|
4
5
|
|
|
5
6
|
## Installation
|
|
6
7
|
|
|
@@ -18,7 +19,22 @@ Or install it yourself as:
|
|
|
18
19
|
|
|
19
20
|
## Usage
|
|
20
21
|
|
|
21
|
-
|
|
22
|
+
Remote APIs (be they HTTP or otherwise) follow a pattern fairly similar to that
|
|
23
|
+
of a common HTTP API.
|
|
24
|
+
|
|
25
|
+
### Requests
|
|
26
|
+
|
|
27
|
+
A request is typically made to a path with request parameters. We attach
|
|
28
|
+
metadata to this request in order to track it throughout a distributed system.
|
|
29
|
+
This metadata includes a unique identifier and a UTC timestamp.
|
|
30
|
+
|
|
31
|
+
### Responses
|
|
32
|
+
|
|
33
|
+
A response is typically yielded to requests. It includes the same metadata
|
|
34
|
+
as a request, but also a response typically has associated with it a status
|
|
35
|
+
code indicating success or failure of some kind (we have chosen to standardize
|
|
36
|
+
around HTTP status codes -- or some interpretation thereof). Like a request,
|
|
37
|
+
a response typically also contains a body.
|
|
22
38
|
|
|
23
39
|
## Contributing
|
|
24
40
|
|
|
@@ -31,8 +47,6 @@ TODO: Write usage instructions here
|
|
|
31
47
|
|
|
32
48
|
## Testing
|
|
33
49
|
|
|
34
|
-
TODO: Add information specific to your gem's test suite.
|
|
35
|
-
|
|
36
50
|
The Rakefile comes with several convenience tasks for running tests as well. By rake task:
|
|
37
51
|
|
|
38
52
|
+ `spec`: Runs all rspec tests in the spec directory.
|
data/lib/loginator/version.rb
CHANGED
data/loginator.gemspec
CHANGED
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
require File.expand_path('../lib/loginator/version', __FILE__)
|
|
5
5
|
|
|
6
6
|
Gem::Specification.new do |gem|
|
|
7
|
-
gem.authors = ['
|
|
8
|
-
gem.email = ['
|
|
9
|
-
gem.description = '
|
|
10
|
-
gem.summary = '
|
|
7
|
+
gem.authors = ['Greg Poirier']
|
|
8
|
+
gem.email = ['grep@gray.industries']
|
|
9
|
+
gem.description = 'Standardized logging of API requests/responses'
|
|
10
|
+
gem.summary = 'Loginator is a mechanism for standardizing the logging of API requests and responses.'
|
|
11
11
|
|
|
12
12
|
gem.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
|
|
13
13
|
gem.executables = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
|
metadata
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: loginator
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
|
-
-
|
|
7
|
+
- Greg Poirier
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
@@ -248,9 +248,9 @@ dependencies:
|
|
|
248
248
|
- - ">="
|
|
249
249
|
- !ruby/object:Gem::Version
|
|
250
250
|
version: '0'
|
|
251
|
-
description:
|
|
251
|
+
description: Standardized logging of API requests/responses
|
|
252
252
|
email:
|
|
253
|
-
-
|
|
253
|
+
- grep@gray.industries
|
|
254
254
|
executables: []
|
|
255
255
|
extensions: []
|
|
256
256
|
extra_rdoc_files: []
|
|
@@ -306,7 +306,8 @@ rubyforge_project:
|
|
|
306
306
|
rubygems_version: 2.2.2
|
|
307
307
|
signing_key:
|
|
308
308
|
specification_version: 4
|
|
309
|
-
summary:
|
|
309
|
+
summary: Loginator is a mechanism for standardizing the logging of API requests and
|
|
310
|
+
responses.
|
|
310
311
|
test_files:
|
|
311
312
|
- spec/acceptance/lib/loginator/.gitignore
|
|
312
313
|
- spec/fixtures.rb
|