bernard 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddba97c1717f871b71e0d8b206fa8a85e90896b2
-  data.tar.gz: ff3ed7b6f55f910966ed98348192031591382239
+  metadata.gz: cb3c234efb7347577546da62322f8e0be7f7e468
+  data.tar.gz: dfee53a17404e085fcdc7edfdac20dfcffeae862
 SHA512:
-  metadata.gz: 69dca033e296b405b6cd3ce4c80fcc43bd04d7e4aabf3bd5f2e3fb90dc9c1c1bb6ade7138bba859dd5b93b8c648ae2fe981f974e55f4b72033da7a28efbd82a5
-  data.tar.gz: a10ef9b2bf6074a2428b2172fe5690b214212312e3a1ca5b8b882d46497a4aae8f09c51dc93190b8b23168b1c5f9eab11107dea6fab95ea1ac35358f030487c2
+  metadata.gz: 20728ae23d447582f13da324337cbeb50d2469dba56fa2449306c3d8bdd1322935b518a51a92ca477db67959de33920f81d8106d06a75021b501d7be6d19e530
+  data.tar.gz: 848b93233a3010ace79c7680682638a92778326edfea34db3203d14546ae9f80ff02c0ecf86bdd787f743c40f03bebf3288b942e44b5f49e3259c80c3f1203e0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bernard (0.3.0)
+    bernard (0.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -33,7 +33,7 @@ GEM
     rspec-support (3.4.1)
     safe_yaml (1.0.4)
     slop (3.6.0)
-    webmock (1.24.2)
+    webmock (1.24.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff

data/README.md

@@ -2,6 +2,9 @@
 
 Sends event data to visualisation services.
 
+Currently supporting:
+- Keen.io
+
 ![bernard](http://dogkeg.com/wp-content/uploads/2015/10/saint_bernard__dog_keg_barrel-30-640x427-e1446127647535.jpg)
 
 
@@ -9,7 +12,7 @@ Sends event data to visualisation services.
 
 Add this line to your application's Gemfile:
 ```ruby
-gem 'bernard', '~> 0.2.0'
+gem 'bernard', '~> 0.4.0'
 ```
 
 And then execute:
@@ -17,7 +20,7 @@ And then execute:
 $ bundle
 ```
 
-## Setup
+## Basic setup
 To use Bernard you can either create an initializer or construct it as you need it.
 
 Create a new initializer `config/bernard.rb` in your application
@@ -25,6 +28,7 @@ Create a new initializer `config/bernard.rb` in your application
 Bernard::Keen::Client.configure do |client|
   client.config = {
     uri: URI('https://api.keen.io'),
+    application_name: '<YOUR APPLICATION NAME>',
     project_id: '<YOUR PROJECT ID>',
     write_key: '<YOUR WRITE KEY>',
     read_key: '<YOUR READ KEY>'
@@ -32,18 +36,6 @@ Bernard::Keen::Client.configure do |client|
 end
 ```
 
-OR
-
-Create a new client on the fly:
-```ruby
-client = Bernard::Keen::Client.new(
-  uri: URI('https://api.keen.io')
-  project_id: '<YOUR PROJECT ID>'
-  write_key: '<YOUR WRITE KEY>'
-  ready_key: '<YOUR READ KEY>'
-)
-```
-
 ## Usage
 
 ### Tick
@@ -67,6 +59,53 @@ Update an event to a new value.
 client.gauge('office_noise_level', '43')
 ```
 
+---
+
+## Advanced configuration
+
+### Easier way to make a client
+Instead of using an initializer you could create a new client on the fly:
+```ruby
+client = Bernard::Keen::Client.new(
+  uri: URI('https://api.keen.io')
+  application_name: '<YOUR APPLICATION NAME>'
+  project_id: '<YOUR PROJECT ID>'
+  write_key: '<YOUR WRITE KEY>'
+  ready_key: '<YOUR READ KEY>'
+)
+```
+
+### Run asynchronously
+
+Given that this Gem is making HTTP requests which can be slow, we'd advise using
+a worker like [Sidekiq](https://github.com/mperham/sidekiq).
+
+For example adding this to your applications's `workers/bernard_worker.rb` file:
+```ruby
+require 'bernard'
+
+class BernardWorker
+  include Sidekiq::Worker
+
+  def perform(event_type, event_name, value = 0)
+    case event_type.to_sym
+    when :tick then Bernard::Keen::Client.new.tick(event_name)
+    when :count then Bernard::Keen::Client.new.count(event_name, value)
+    when :gauge then Bernard::Keen::Client.new.gauge(event_name, value)
+    else
+    end
+  end
+end
+```
+
+and invoke using this worker instead to ensure it doesn't interrupt your application's processes:
+
+```ruby
+BernardWorker.perform_async(:tick, :vote)
+BernardWorker.perform_async(:count, :visitors, 3)
+BernardWorker.perform_async(:gauge, :temperature, 32.5)
+```
+
 ## License
 
 (c) 2016 The Dextrous Web Ltd. Released under the MIT license.

data/lib/bernard/keen/client.rb

@@ -14,6 +14,7 @@ module Bernard
         def config=(args)
           @config = {
             uri: args[:uri],
+            application_name: args[:application_name],
             project_id: args[:project_id],
             write_key: args[:write_key],
             read_key: args[:read_key]
@@ -23,12 +24,13 @@ module Bernard
 
       include Bernard::Keen::Methods
 
-      attr_reader :uri, :project_id, :write_key, :read_key
+      attr_reader :uri, :application_name, :project_id, :write_key, :read_key
 
       def initialize(args = {})
         config = config_from(args)
 
         @uri = config.fetch(:uri, nil)
+        @application_name = config.fetch(:application_name, nil)
         @project_id = config.fetch(:project_id, nil)
         @write_key = config.fetch(:write_key, nil)
         @read_key = config.fetch(:read_key, nil)
@@ -50,6 +52,11 @@ module Bernard
         @uri = value
       end
 
+      def application_name=(value)
+        raise(Bernard::ArgumentError, 'Missing application_name') unless value
+        @application_name = value
+      end
+
       def project_id=(value)
         raise(Bernard::ArgumentError, 'Missing project_id') unless value
         @project_id = value

data/lib/bernard/keen/methods.rb

@@ -14,14 +14,14 @@ module Bernard
       end
 
       def write(event, metadata)
-
         event = String(event).strip.downcase
+        payload = metadata.merge!(default_params).to_json
         uri.path = "/3.0/projects/#{project_id}/events/#{event}"
 
         request = Net::HTTP::Post.new(uri.path)
         request['Authorization'] = write_key
         request['Content-Type'] = 'application/json'
-        request.body = metadata.to_json
+        request.body = payload
 
         begin
           connection = Bernard::Connection.new(uri).call
@@ -30,6 +30,12 @@ module Bernard
           return false
         end
       end
+
+      private def default_params
+        {
+          application_name: application_name
+        }
+      end
     end
   end
 end

data/lib/bernard/version.rb

@@ -1,3 +1,3 @@
 module Bernard
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bernard
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tom Hipkin