bernard 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd466e27be29274756368250e35c489fd65c4a37
-  data.tar.gz: 14875501d58f8ffafd0f611488695162d4f75b64
+  metadata.gz: 1960eb4876f61e949ae9a22b0ee62b0122033ed1
+  data.tar.gz: e1062af9819a7ccd7ddaadbde2b8c49b606cd6e0
 SHA512:
-  metadata.gz: 11a5fe4879d483b4e5f536a05076f1b9cbd83c87d2a48f20f996ce197c3f9cb9c22a4b6bce89447cce271652f1d404631c347dcf2eac6e6e692a9db8c0433176
-  data.tar.gz: 14776960c759e3e69ba0e3de42222a5e573b275f90270f24146825ceae653e8925192480bb9d7f210f4fd87a1b9ecc3d76ef488d3d2877b75a60489abed8e5ff
+  metadata.gz: 01787a42c7823b47fcd35b8d43cf3eb032f6c91d69cb2ceaa65b51433b118c2228b7bd425153ac147d1292e2d0c9ce634c842b67a4a5cd6156c141e04f0e7069
+  data.tar.gz: 94fe2d382009a6bf7cecfd2bbfc313b92678da488bbe81cedd0e8e5b3d9ef3c667798e812c6cce1542f5f191f518f0ae60799220fac4105e0107fdd4c273e28b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bernard (0.0.0)
+    bernard (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -43,10 +43,10 @@ PLATFORMS
 
 DEPENDENCIES
   bernard!
-  pry
-  rake
-  rspec
-  webmock
+  pry (= 0.10.3)
+  rake (= 11.1.2)
+  rspec (= 3.4.0)
+  webmock (= 1.24.2)
 
 BUNDLED WITH
-   1.12.2
+   1.12.3

data/README.md

@@ -4,6 +4,62 @@ Sends event data to visualisation services.
 
 ![bernard](http://dogkeg.com/wp-content/uploads/2015/10/saint_bernard__dog_keg_barrel-30-640x427-e1446127647535.jpg)
 
+
+## Install
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'bernard', '~> 0.2.0'
+```
+
+And then execute:
+```sh
+$ bundle
+```
+
+## 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
+```ruby
+Bernard::Keen::Client.configure do |client|
+  client.config = {
+    uri: URI('https://api.keen.io'),
+    project_id: '<YOUR PROJECT ID>',
+    write_key: '<YOUR WRITE KEY>',
+    read_key: '<YOUR READ KEY>'
+  }
+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
+
+Increment an event that has occurred by 1.
+```ruby
+client.tick('foo')
+```
+
+### Gauge
+
+Update an event to a new value.
+```ruby
+client.gauge('office_noise_level', '43')
+```
+
 ## License
 
 (c) 2016 The Dextrous Web Ltd. Released under the MIT license.

data/bernard.gemspec

@@ -5,7 +5,7 @@ require 'bernard/version'
 Gem::Specification.new do |gem|
   gem.name          = 'bernard'
   gem.version       = Bernard::VERSION
-  gem.date          = '2016-05-11'
+  gem.date          = '2016-05-17'
   gem.summary       = 'Sends event data to visualisation services'
   gem.description   = 'Sends event data to visualisation services.'
   gem.authors       = ['Tom Hipkin', 'Robert Lee-Cann']

data/lib/bernard/connection.rb

@@ -0,0 +1,21 @@
+module Bernard
+  class Connection
+    def initialize(uri)
+      unless uri && uri.kind_of?(URI)
+        raise(Bernard::ArgumentError, 'could not parse URI')
+      end
+      @uri = uri
+    end
+
+    def call
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.open_timeout = 5
+      http.read_timeout = 5
+      http.use_ssl = true
+      http
+    end
+
+  private
+    attr_reader :uri
+  end
+end

data/lib/bernard/exception.rb

@@ -1,3 +1,4 @@
-class Bernard
+module Bernard
   class Exception < StandardError; end
+  class ArgumentError < StandardError; end
 end

data/lib/bernard/keen/client.rb

@@ -0,0 +1,93 @@
+require 'bernard/connection'
+
+module Bernard
+  module Keen
+    class Client
+
+      class << self
+        attr_reader :config
+
+        def configure
+          yield self
+        end
+
+        def config=(args)
+          @config = {
+            uri: args[:uri],
+            project_id: args[:project_id],
+            write_key: args[:write_key],
+            read_key: args[:read_key]
+          }
+        end
+      end
+
+      attr_reader :uri, :project_id, :write_key, :read_key
+
+      def initialize(args = {})
+        config = config_from(args)
+
+        @uri = config.fetch(:uri, nil)
+        @project_id = config.fetch(:project_id, nil)
+        @write_key = config.fetch(:write_key, nil)
+        @read_key = config.fetch(:read_key, nil)
+      end
+
+      private def config_from(args)
+        if !args.empty?
+          args
+        elsif Bernard::Keen::Client.config
+          Bernard::Keen::Client.config
+        else
+          {}
+        end
+      end
+
+      def uri=(value)
+        raise(Bernard::ArgumentError, 'Missing URI') unless value
+        raise(Bernard::ArgumentError, 'Invalid URI') unless value.kind_of?(URI)
+        @uri = value
+      end
+
+      def project_id=(value)
+        raise(Bernard::ArgumentError, 'Missing project_id') unless value
+        @project_id = value
+      end
+
+      def write_key=(value)
+        raise(Bernard::ArgumentError, 'Missing write_key') unless value
+        @write_key = value
+      end
+
+      def read_key=(value)
+        @read_key = value
+      end
+
+      def tick(event)
+        write(:tick, type: event, count: 1)
+      end
+
+      def gauge(event, value)
+        write(:gauge, type: event, value: Float(value))
+      end
+
+      def write(event, metadata)
+
+        event = String(event).strip.downcase
+        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
+
+        begin
+          connection = Bernard::Connection.new(uri).call
+          response = connection.request(request)
+          # puts "Bernards #{event} response was #{response.code}"
+        rescue Timeout::Error
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/bernard/schema.rb

@@ -1,5 +1,4 @@
-class Bernard
+module Bernard
   class Schema
-
   end
 end

data/lib/bernard/version.rb

@@ -1,3 +1,3 @@
-class Bernard
-  VERSION = '0.1.0'.freeze
+module Bernard
+  VERSION = '0.2.0'.freeze
 end

data/lib/bernard.rb

@@ -1,59 +1,12 @@
 require 'bernard/exception'
 require 'bernard/schema'
 require 'bernard/version'
+require 'bernard/connection'
+require 'bernard/keen/client'
 
 require 'json'
 require 'net/https'
 require 'uri'
 
-class Bernard
-  BASE_URI = 'https://api.keen.io'
-
-  attr_reader :project_id, :write_key
-
-  def project_id=(id)
-    project_id = String(id).strip.downcase
-    raise Bernard::Exception unless !!(project_id =~ /\A[0-9a-f]{24}\Z/)
-
-    @project_id = project_id
-  end
-
-  def write_key=(key)
-    write_key = String(key).strip.downcase
-    raise Bernard::Exception unless !!(write_key =~ /\A[0-9a-f]{192}\Z/)
-
-    @write_key = write_key
-  end
-
-  def publish(event, metadata)
-    event = String(event).strip.downcase
-
-    uri = URI.parse(BASE_URI)
-
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.open_timeout = 5
-    http.read_timeout = 5
-    http.use_ssl = true
-
-    request = Net::HTTP::Post.new("/3.0/projects/#{project_id}/events/#{event}")
-    request['Authorization'] = write_key
-    request['Content-Type'] = 'application/json'
-    request.body = metadata.to_json
-
-    begin
-      response = http.request(request)
-    rescue Timeout::Error
-      return false
-    end
-
-    response.code == '201'
-  end
-
-  def tick(event)
-    publish(:tick, type: event, count: 1)
-  end
-
-  def gauge(event, value)
-    publish(:gauge, type: event, value: Float(value))
-  end
+module Bernard
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bernard
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Hipkin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,10 +87,12 @@ files:
 - bin/.keep
 - lib/bernard.rb
 - lib/bernard/.keep
+- lib/bernard/connection.rb
 - lib/bernard/exception.rb
+- lib/bernard/keen/.keep
+- lib/bernard/keen/client.rb
 - lib/bernard/schema.rb
 - lib/bernard/version.rb
-- test/.keep
 homepage: http://rubygems.org/gems/bernard
 licenses:
 - MIT