binnacle 0.4.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac88903228fc74fc1b88017ad2b8a5c61432bb5d
+  data.tar.gz: 5faf3822abed8fe7e29efc915821fd376015476f
+SHA512:
+  metadata.gz: e1fdc27769de722bf9f258b42aadca2cf4ce4497a01a7caa156b067ddc890f7ce1f0e2e556dbf90ea2d72e87614fd6e53d39e43a7a7965ba751ce76efd33ffc8
+  data.tar.gz: f06922bca53b26e5e60b27b923665d6a1a517036f8ec0fedb353b424c461c0adc28cba825c74b459dbad2beb3ef781f171b2d2d20c1e642e83e9977d960638e2

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.DS_Store
+coverage/

data/.ruby-gemset

@@ -0,0 +1 @@
+binnacle-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+source 'https://rails-assets.org'
+
+source 'https://rails-assets.org' do
+  gem 'rails-assets-binnacle', '>= 0.2.5'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: .
+  specs:
+    binnacle (0.4.8)
+      addressable (~> 2.5)
+      colorize (~> 0.8.1)
+      faraday (~> 0.11)
+      faye-websocket (~> 0.10, >= 0.10.4)
+      httpclient (~> 2.8, >= 2.8.0)
+      rack-timeout (~> 0.4, >= 0.4.2)
+      trollop (~> 2.1, >= 2.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  remote: https://rails-assets.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
+    colorize (0.8.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    daemons (1.2.4)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    ethon (0.10.1)
+      ffi (>= 1.3.0)
+    eventmachine (1.2.3)
+    excon (0.55.0)
+    faraday (0.12.0.1)
+      multipart-post (>= 1.2, < 3)
+    faye-websocket (0.10.7)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    ffi (1.9.18)
+    fivemat (1.3.3)
+    hashdiff (0.3.2)
+    http (2.2.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (1.0.1)
+    http_parser.rb (0.6.0)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    httpclient (2.8.3)
+    json (2.0.4)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    patron (0.8.0)
+    public_suffix (2.0.5)
+    rack (2.0.1)
+    rack-timeout (0.4.2)
+    rails-assets-atmosphere (2.3.2)
+    rails-assets-base64 (1.0.0)
+    rails-assets-binnacle (0.2.5)
+      rails-assets-atmosphere (= 2.3.2)
+      rails-assets-base64 (= 1.0.0)
+      rails-assets-firebase (= 3.7.1)
+      rails-assets-moment (= 2.18.0)
+    rails-assets-firebase (3.7.1)
+    rails-assets-moment (2.18.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-collection_matchers (1.1.3)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rspec-wait (0.0.9)
+      rspec (>= 3, < 4)
+    safe_yaml (1.0.4)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thin (1.7.0)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    trollop (2.1.2)
+    typhoeus (1.1.2)
+      ethon (>= 0.9.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.3)
+    vcr (3.0.3)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  binnacle!
+  bundler (~> 1.10)
+  codeclimate-test-reporter (~> 1.0, >= 1.0.7)
+  ethon (~> 0.10)
+  excon (~> 0.55)
+  fivemat (~> 1.3, >= 1.3.2)
+  http (~> 2.2)
+  httparty (~> 0.14)
+  patron (~> 0.8)
+  rack (~> 2.0)
+  rails-assets-binnacle (>= 0.2.5)!
+  rake (~> 10.5)
+  rspec (~> 3.5, >= 3.2.0)
+  rspec-collection_matchers (~> 1.1, >= 1.1.2)
+  rspec-wait (~> 0.0.9)
+  simplecov (~> 0.14)
+  thin (~> 1.7)
+  typhoeus (~> 1.1)
+  vcr (~> 3.0)
+  webmock (~> 2.3)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brian Sam-Bodden
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.asc

@@ -0,0 +1,264 @@
+== Binnacle Ruby Client
+
+#### Ruby Client for the RESTful Multi-channel Push Service Binnacle (see binnacle.io)
+
+....
+__/\\\______________________________________________________________________________/\\\\\\____________________
+_\/\\\_____________________________________________________________________________\////\\\____________________
+_\/\\\__________/\\\__________________________________________________________________\/\\\____________________
+_\/\\\_________\///____/\\/\\\\\\_____/\\/\\\\\\_____/\\\\\\\\\_________/\\\\\\\\_____\/\\\_________/\\\\\\\\__
+_\/\\\\\\\\\____/\\\__\/\\\////\\\___\/\\\////\\\___\////////\\\______/\\\//////______\/\\\_______/\\\/////\\\_
+_\/\\\////\\\__\/\\\__\/\\\__\//\\\__\/\\\__\//\\\____/\\\\\\\\\\____/\\\_____________\/\\\______/\\\\\\\\\\\__
+_\/\\\__\/\\\__\/\\\__\/\\\___\/\\\__\/\\\___\/\\\___/\\\/////\\\___\//\\\____________\/\\\_____\//\\///////___
+_\/\\\\\\\\\___\/\\\__\/\\\___\/\\\__\/\\\___\/\\\__\//\\\\\\\\/\\___\///\\\\\\\\___/\\\\\\\\\___\//\\\\\\\\\\_
+_\/////////____\///___\///____\///___\///____\///____\////////\//______\////////___\/////////_____\//////////__
+....
+
+## Overview
+
+Send events and log messages to Binnacle
+
+Drop in replacement for Ruby's Logger (See http://www.ruby-doc.org/stdlib-2.2.0/libdoc/logger/rdoc/Logger.html)
+
+### Status
+
+image:https://www.codeship.io/projects/495e6480-8fb0-0132-ebb3-32b8c1ae92e1/status?branch=master[CI Status]
+image:https://codeclimate.com/repos/560031456956807b70002199/badges/ffe8465d2f620cea4d4e/gpa.svg[
+"Code Climate",link="https://codeclimate.com/repos/560031456956807b70002199/feed"]
+image:https://codeclimate.com/repos/560031456956807b70002199/badges/ffe8465d2f620cea4d4e/coverage.svg[
+"Test Coverage",link="https://codeclimate.com/repos/560031456956807b70002199/coverage"]
+
+## Building
+
+- Pull the JS assets (after bundling) from Rails Assets (https://rails-assets.org/#/?query=binnacle)
+  - `rake binnacle:install_binnacle_js`
+- Build the Gem: `gem build binnacle.gemspec`
+- Install the Gem Locally: `gem install ./binnacle-M.m.P.gem`
+
+## Installation
+
+### Rails 3.x/4.x/5.x
+
+Add the binnacle gem to your Gemfile.  In Gemfile:
+
+```
+gem 'binnacle'
+```
+
+Then from your project's RAILS_ROOT, and in your development environment, run:
+
+```
+bundle install
+rails generate binnacle
+```
+
+The generator creates a file under `config/initializers/binnacle.rb`. Although you
+can configure all aspects of the binnacle client via this initializer we recommend
+that you configure any credentials and account/app/channel ids via Environment
+variables (using something like the dotenv gem in development and ENV values in
+production/staging)
+
+## Configuration
+
+### Rails 3.x
+
+In config/environments/production.rb:
+
+```
+RailsApplication::Application.configure do
+  config.logger = Binnacle::Logging.build(API_KEY, API_SECRET, BINNACLE_URL, BINNACLE_APP_LOG_CHANNEL)
+end
+```
+
+### In Rails 4.x - 5.x
+
+The Binnacle Ruby client integrate seamlessly with the Ruby on Rails to:
+
+- Provide a Pub-Sub client to interact with Binnacle's Push Service
+- Intercepts Rails Logger to log to a Binnacle Channel
+- Intercepts Errors and Exceptions and logs them to a Binnacle Channel
+
+```
+# ==============================================================================
+# Binnacle Configuration
+# ==============================================================================
+# Available parameters (some are also configurable via ENV variables, see parens):
+# ==============================================================================
+# - url:                     The Binnacle Endpoint URL (BINNACLE_URL)
+# - logging_channel:         The application logger Binnacle Channel (BINNACLE_APP_LOG_CHANNEL)
+# - error_channel:           The application error Binnacle Channel (BINNACLE_APP_ERR_CHANNEL)
+# - api_key:                 An approved publisher API key for the App (BINNACLE_API_KEY)
+# - api_secret:              The API secret for the given API key (BINNACLE_API_SECRET)
+# - intercept_rails_logging: Redirect rails logging to logging_channel in Binnacle (BINNACLE_RAILS_LOG)
+# - report_exceptions:       Trap exceptions are log them to error_channel (BINNACLE_REPORT_EXCEPTIONS)
+# - ignored_exceptions:      List of Exceptions that do not get reported to Binnacle (BINNACLE_IGNORED_EXCEPTIONS)
+# - ignore_cascade_pass:     Whether to skip reporting exceptions where the headers['X-Cascade'] is set to 'pass'.
+#                            In Rails typically it means route was not found (404 error).
+# ==============================================================================
+Binnacle.configure do |config|
+  config.intercept_rails_logging = true
+  config.report_exceptions = true
+end
+```
+
+## Usage
+
+### Rails
+
+Once configured the Binnacle client is available to send signals. In the example
+below from a Rails controller:
+
+```
+def create
+  logger.info "PostsController#create"
+  @post = Post.new(post_params)
+  if @post.save
+    client = Binnacle::Client.new(publisher.api_key, publisher.api_secret)
+    client.signal_asynch('channel', 'event_name', 'new_post', 'rails-app', session.id, 'INFO', [], @post.to_json)
+  end
+end
+```
+
+Available methods are: signal, signal_asynch, recents, report_exception
+
+### Direct Via Ruby Client
+
+Build an instance of Logging Adapter passing the following Binnacle configuration
+values (get them from you App page on the Binnacle Website):
+
+```
+require 'binnacle'
+
+client = Binnacle::Client.new(api_key, api_secret, endpoint)
+client.signal('5ujzd7gwk8ikmvnqv1w7', 'event_from_client', 'binnacle-ruby', '001', 'INFO')
+```
+
+Parameters to Client.new:
+
+- api_key: An approved publisher API key for the App (`BINNACLE_API_KEY`)
+- api_secret: The API secret for the given API key (`BINNACLE_API_SECRET`)
+- endpoint: The Binnacle Endpoint (host) (`BINNACLE_ENDPOINT`)
+
+All these values can be configured as ENV variables (variable name in parenthesis)
+
+Parameters to signal:
+
+- channel_id: Your default Binnacle Channel ID
+- event_name: The name of the event
+- client_id: Use for system/subsystem/component id/name
+- session_id: Use to track a user session across requests/processes
+- log_level: UNKNOWN, FATAL, ERROR, WARN, INFO, DEBUG
+- tags (optional): An Array of tags, e.g. `['accounts', 'refunds', 'dispute']`
+- json (optional): A Ruby Hash, e.g. `{ message: "there you are!" }`
+
+### Via Ruby/Rails Logging
+
+Build an instance of Logging Adapter (which wraps the Binnacle Client):
+
+```
+require 'binnacle'
+
+logger = Binnacle::Logging.build(API_KEY, API_SECRET, '5ujzd7gwk8ikmvnqv1w7', 'localhost')
+
+logger.info("This is an info message")
+logger.debug("This is an debug message")
+```
+
+Parameters to Logging.new:
+
+- api_key: An approved publisher API key for the App (`BINNACLE_API_KEY`)
+- api_secret: The API secret for the given API key (`BINNACLE_API_SECRET`)
+- logging_channel_id: A Binnacle Channel ID
+- endpoint: The Binnacle Endpoint (host) (`BINNACLE_ENDPOINT`)
+
+The following log statement:
+
+```
+logger.info("hey")
+```
+
+results in the following message being sent to Binnacle:
+
+```
+{
+  "channelId": "5ujzd7gwk8ikmvnqv1w7",
+  "sessionId": "",
+  "clientEventTime": "2015-01-31T08:55:19-0700",
+  "eventName": "log",
+  "clientId": "",
+  "logLevel": "INFO",
+  "tags": [],
+  "json": {"message":"hey"}
+}
+```
+
+#### Switching channel and passing other parameters
+
+We override Ruby's logger 'progname' parameter to pass a Hash where you can specify
+Binnacle's signal remaining parameters (session_id, event_name, client_id, tags)
+
+For example, the following log statement:
+
+```
+logger.info(channel_id: 'xxx', session_id: '8675309', event_name: 'failed_transfer') { 'transfer failed, bad RTN' }
+```
+
+Will post to Binnacle under the event name `failed_transfer`, to the channel with id `xxx`
+and with `session_id` equal to `8675309`.
+
+In the hash you can pass `channel_id`, `session_id`, `event_name`, `client_id`, `tags`, `json`
+
+If instead of a Hash you pass a String the `event_name` will be assigned its value.
+
+## Binnacle Executable
+
+Installing the client gem provides the `binnacle` executable which provides the following features:
+
+### Live Tail
+
+Use `tail -f` (follow) subcommand to live tail a binnacle channel or app.
+
+```
+binnacle tail -f --host=localhost --channel=ylhcn28x7skv6av8q93m --api-key=jzr5d5kgj4j3l8fm90tr --api-secret=bz3e3w44o3323dypp8d7 --encrypted=false
+```
+
+The tail subcommand has the following options:
+
+```
+SUBCOMMAND
+      tail -- listen to a Binnacle channel or app
+
+Usage:
+   binnacle tail
+
+where [options] are:
+  -h, --host=<s>                     Binnacle Host (default: localhost)
+  -c, --channel=<s>                  Binnacle Channel
+  -a, --app=<s>                      Binnacle App
+  -u, --api-key=<s>                  Binnacle API Key
+  -p, --api-secret=<s>               Binnacle API Secret
+  -f, --follow                       Monitors a Binnacle Channel or App
+  -n, --lines=<i>                    Get the last n events on the Channel
+  -s, --since=<i>                    Number of minutes in the past to search for events
+  -e, --encrypted, --no-encrypted    Use SSL/HTTPS (default: true)
+  -l, --help                         Show this message
+```
+
+### Recent Events
+
+Use `tail -n` subcommand to get the last N events in the last M minutes'
+
+`lines` : maximum number of events to retrieve
+`since` : number of minutes in the past (defaults to 5 minutes)
+
+```
+binnacle tail -n 2 -s 60 --host=localhost --channel=ylhcn28x7skv6av8q93m --api-key=jzr5d5kgj4j3l8fm90tr --api-secret=bz3e3w44o3323dypp8d7 --no-encrypted
+```
+
+## Testing
+
+We use RSpec. When developing outgoing HTTP logging adaptors you can pass SERVE_TEST_ASSETS=true to rspec to run an embedded thin server to server test files:
+
+```
+SERVE_TEST_ASSETS=true rspec
+```