loginator 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4579d7d89bec5884c7cdee42ae1abdc70b5ef2ff
-  data.tar.gz: 85ad6d2d9da2a039caac07fd85dddfee2b238dbf
+  metadata.gz: 91060765e2db9b3bda7305d9e35365c019402fdc
+  data.tar.gz: f69a1dffa54c696d0d6e29990b15c57dde489fa3
 SHA512:
-  metadata.gz: c8223b4590399f9ac81f20bdf63ebc28efa118dd20397c83ae65cb649577504967f59b6e2967c0f94f801553f8b32d98888f6b74e1c8173932692495dc2181f7
-  data.tar.gz: 60c7cb9407284a7eeedeadb9e3c6c1fed232d29b1b4dfbe19511888e3e3c169ab10645beefb1e89ab645e8ff5dfc77e50021b6d5a1b943841e7dbdf042407078
+  metadata.gz: 021d3256f1411a92381614f8e9e00d3eae892b6336e5c5e81ac8c0a54262d333a92c94fd63df9f24809e89d2940ffdd5c9573d2b2bbf3adf654e66534b5466c8
+  data.tar.gz: cc65834d3daebe8fc759971de1e440e013b572d2aa0152f8ac31c0a86f939f1af0c8e9557b97aa55885b5e1877c34a958ed900370878cd6aad52c09c0c091803

data/README.md

@@ -1,6 +1,7 @@
 # Loginator
 
-TODO: Write a gem description
+Loginator is a gem for standardizing the logging of requests and responses for
+remote APIs.
 
 ## Installation
 
@@ -18,7 +19,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Remote APIs (be they HTTP or otherwise) follow a pattern fairly similar to that
+of a common HTTP API. 
+
+### Requests
+
+A request is typically made to a path with request parameters. We attach
+metadata to this request in order to track it throughout a distributed system.
+This metadata includes a unique identifier and a UTC timestamp.
+
+### Responses
+
+A response is typically yielded to requests. It includes the same metadata
+as a request, but also a response typically has associated with it a status
+code indicating success or failure of some kind (we have chosen to standardize
+around HTTP status codes -- or some interpretation thereof). Like a request,
+a response typically also contains a body.
 
 ## Contributing
 
@@ -31,8 +47,6 @@ TODO: Write usage instructions here
 
 ## Testing
 
-TODO: Add information specific to your gem's test suite.
-
 The Rakefile comes with several convenience tasks for running tests as well. By rake task:
 
   + `spec`: Runs all rspec tests in the spec directory.

data/lib/loginator/version.rb

@@ -1,4 +1,4 @@
 # Increment when releasing.
 module Loginator
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/loginator.gemspec

@@ -4,10 +4,10 @@
 require File.expand_path('../lib/loginator/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['SET ME']
-  gem.email         = ['SET ME']
-  gem.description   = 'I am an application stub'
-  gem.summary       = 'app stub'
+  gem.authors       = ['Greg Poirier']
+  gem.email         = ['grep@gray.industries']
+  gem.description   = 'Standardized logging of API requests/responses'
+  gem.summary       = 'Loginator is a mechanism for standardizing the logging of API requests and responses.'
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: loginator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
-- SET ME
+- Greg Poirier
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -248,9 +248,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: I am an application stub
+description: Standardized logging of API requests/responses
 email:
-- SET ME
+- grep@gray.industries
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -306,7 +306,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: app stub
+summary: Loginator is a mechanism for standardizing the logging of API requests and
+  responses.
 test_files:
 - spec/acceptance/lib/loginator/.gitignore
 - spec/fixtures.rb