algometrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49e202d1206158d5ab83bbc82603fed6420b49c8
+  data.tar.gz: 478425703e7a60280376b610d2b5d21be2a92c88
+SHA512:
+  metadata.gz: 2e8c44cb9885b502a57dabea34be3694836b3d4d45e08c3cb75aa6c485acf8fa111ea49a1577c32db4dffb6f0ea9919ae6c35906db5429cbc20d742a72e040b4
+  data.tar.gz: befffb7174dc1fc30ada19eaea24b013a1344baedc4d97473fb46f7c5b2d74dc3f8b1f6ce65ed5252acd0b6e26346569d5dc95cd1848874610447ef5c32bfcb8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.2
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 135
+StringLiterals:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in algometrics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Kurkin
+
+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.md

@@ -0,0 +1,58 @@
+# algometrics.io ruby client
+
+algometrics-gem is an official ruby client for event-tracking and real-time workflow monitoring and alerting platform [algometrics.io](https://algometrics.io/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'algometrics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install algometrics
+
+## Usage
+
+Quickest possible way to send events is the following:
+
+```
+client = Algometrics::Client.new(api_key: '...')
+client.track(event: 'Job - Started', actor: {type: 'Job', id: 123})
+client.track(event: 'Job - Completed', actor: {type: 'Job', id: 123})
+```
+
+This way, we'll be able to track events for actor `Job#123`.
+
+### Send events with status
+
+By default all events are sent with status `success`.
+
+You can explicitly send events with status `failure`, in this case any workflows associated with events will be immediately marked as failed and notifications will be sent.
+
+```
+client = Algometrics::Client.new(api_key: '...')
+client.track(event: 'Order Placed', actor: {type: 'Order', id: 123}, status: Algometrics::FAILURE)
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/algometricsio/algometrics-gem
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/algometrics.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'algometrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "algometrics"
+  spec.version       = Algometrics::VERSION
+  spec.authors       = ["Alex Kurkin"]
+  spec.email         = ["alex@algometrics.io"]
+
+  spec.summary       = "Algometrics API client for sending events to algometrics.io"
+  spec.description   = "Send events to algometrics.io and monitor your workflows in real-time."
+  spec.homepage      = "https://github.com/algometricsio/algometrics-gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.9.2'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "algometrics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/algometrics/client.rb

@@ -0,0 +1,114 @@
+require 'faraday'
+require 'uri'
+
+module Algometrics
+  class Client
+    extend Forwardable
+
+    def_delegators :connection,
+                   :get,
+                   :post,
+                   :head,
+                   :put,
+                   :delete,
+                   :build_url
+
+    DEFAULT_CONFIG = {
+      url: "https://algometrics.io",
+      api_version: "/v1"
+    }
+
+    attr_reader :api_key,
+                :url,
+                :api_version,
+                :adapter
+
+    def initialize(opts = {})
+      @api_key = opts[:api_key]
+
+      @api_version = opts[:api_version] || DEFAULT_CONFIG[:api_version]
+      @url = URI.join((opts[:url] || DEFAULT_CONFIG[:url]), @api_version).to_s
+
+      @adapter = opts[:adapter] || Faraday.default_adapter
+    end
+
+    def connection
+      @connection ||= Faraday::Connection.new(
+        url: url,
+        request: {
+          open_timeout: 30,
+          timeout: 30
+        }
+      ) do |f|
+        f.adapter adapter
+        f.use Algometrics::Middleware::ResponseHandler
+      end.tap do |transport|
+        transport.headers[:user_agent] = user_agent
+        transport.headers[:content_type] = 'application/json'
+        transport.headers[:x_api_key] = api_key
+      end
+    end
+
+    def user_agent
+      "algometrics-gem #{Algometrics::VERSION}"
+    end
+
+    def track(event:, actor:, status: Algometrics::SUCCESS)
+      unless valid_actor?(actor)
+        Algometrics::Client.logger.error("Incorrect method execution: invalid actor: '#{actor}'")
+        return
+      end
+
+      actor = parse_actor(actor)
+
+      data = {
+        event: event,
+        actor: actor,
+        status: [Algometrics::SUCCESS, Algometrics::FAILURE].include?(status) ? status : Algometrics::SUCCESS
+      }
+
+      connection.post("#{api_version}/events", data.to_json)
+    end
+
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def self.logger=(new_logger)
+      @logger = new_logger
+    end
+
+    private
+
+    def parse_actor(actor)
+      case actor
+      when String
+        type, id = actor.split("#")
+        { type: type, id: id }
+      when Hash
+        actor
+      end
+    end
+
+    def validate_actor_string(str)
+      !(str =~ /\A\w+#\w+\z/).nil?
+    end
+
+    def validate_actor_hash(hash)
+      return false unless ([:type, :id] & hash.keys).count > 0
+      validate_actor_string("#{hash[:type]}##{hash[:id]}")
+    end
+
+    def valid_actor?(actor)
+      case actor
+      when String
+        validate_actor_string(actor)
+      when Hash
+        validate_actor_hash(actor)
+      else
+        false
+      end
+    end
+
+  end
+end

data/lib/algometrics/middleware/response_handler.rb

@@ -0,0 +1,18 @@
+module Algometrics
+  module Middleware
+    class ResponseHandler < Faraday::Middleware
+
+      def call(request_env)
+        @app.call(request_env).on_complete do |response_env|
+          status = response_env.status
+
+          case status
+          when 401
+            Algometrics::Client.logger.error('Invalid Algometrics API key')
+          end
+        end
+      end
+
+    end # class ResponseHandler
+  end # module Middleware
+end # module Algometrics

data/lib/algometrics/version.rb

@@ -0,0 +1,3 @@
+module Algometrics
+  VERSION = "0.1.0"
+end

data/lib/algometrics.rb

@@ -0,0 +1,11 @@
+require "algometrics/version"
+require "json"
+require "logger"
+
+require "algometrics/client"
+require "algometrics/middleware/response_handler"
+
+module Algometrics
+  SUCCESS = 'success'.freeze
+  FAILURE = 'failed'.freeze
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: algometrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Kurkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send events to algometrics.io and monitor your workflows in real-time.
+email:
+- alex@algometrics.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- algometrics.gemspec
+- bin/console
+- bin/setup
+- lib/algometrics.rb
+- lib/algometrics/client.rb
+- lib/algometrics/middleware/response_handler.rb
+- lib/algometrics/version.rb
+homepage: https://github.com/algometricsio/algometrics-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Algometrics API client for sending events to algometrics.io
+test_files: []