polyseerio 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8358926a5d67bc28c9bc79a638d5095d8c69c33c
+  data.tar.gz: d208509a37081b80f9fdd863b87d086f45ee6f16
+SHA512:
+  metadata.gz: 34422281004974f2fa7197f75523651cc32483cc042b724ec6d72fdb81c180c8923a8747c27686374b9238b0ede340917bc5df44b708ec1e6d564a27a94176fe
+  data.tar.gz: 4980c3839bd68d77c8267ef361e4962c8a1b29938ab385f261fbe18b44d27624ef3869162d50e91d43c5737b15f36017879f9a76d1f26d3474e5304251d2debb

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/ExtraSpacing:
+  AllowForAlignment: true
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 100
+Metrics/AbcSize:
+  Max: 50
+Style/AccessModifierIndentation:
+  Enabled: false
+Metrics/BlockLength:
+  Max: 100

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec development_group: :dev

data/HISTORY.md

@@ -0,0 +1,3 @@
+0.0.0 / 2016-00-00
+==================
+ * pending initial release

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kognizant
+
+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/Makefile

@@ -0,0 +1,43 @@
+BUILD_ENV?=development
+
+all: install test build
+
+install:
+	bundle install
+
+lint:
+ifeq ($(BUILD_ENV),ci)
+	rubocop
+else
+	rubocop
+endif
+
+unit-test:
+ifeq ($(BUILD_ENV),ci)
+	rspec ./spec/unit
+else
+	rspec ./spec/unit
+endif
+
+integration-test:
+ifeq ($(BUILD_ENV),ci)
+	rspec ./spec/integration
+else
+	rspec ./spec/integration
+endif
+
+validation-test:
+ifeq ($(BUILD_ENV),ci)
+	rspec ./spec/validation
+else
+	rspec ./spec/validation
+endif
+
+test: lint unit-test integration-test validation-test
+
+build:
+	rm -f polyseerio-*.gem
+	gem build polyseerio.gemspec
+	gem install polyseerio-*.gem
+
+.PHONY: install lint unit-test integration-test validation-test build

data/README.md

@@ -0,0 +1,307 @@
+![Alt text](/asset/polyseerio_sdk_ruby.png?raw=true "Polyseer.io SDK for Ruby.")
+
+# Polyseer.io SDK for Ruby
+
+The official Polyseer.io SDK for Ruby. Detailed API information can be found at (https://polyseer.io/documentation).
+
+## Requirements
+  - Ruby
+  - gem
+
+## Installation
+
+To install, run:
+
+    gem install polyseerio
+
+To add to your project Gemfile, insert:
+
+    gem 'polyseerio'
+
+## Example
+
+Examples are available in /example
+
+## Environment Variables
+
+Certain values can be set in environment variables:
+
+  * POLYSEERIO_TOKEN access-token used for API calls
+  * RAILS_ENV        the current environment
+
+## Usage
+
+The SDK provides an agent that allows for immediate integration as well as
+direct platform interactions.
+
+Example: (Quick start)
+
+    include 'polyseerio'
+
+    client = Polyseerio.start
+    client.instance.fact('foo', 'bar').execute.value
+
+Example: (SDK)
+
+    include 'polyseerio'
+
+    client = Polyseerio.make
+    client.Event.create(name: 'Testing').execute.value
+
+## Design
+
+All Polyseer.io SDK's make use of Promises for async calls. Promises allow for 
+delaying and chaining async work.
+
+  * Provides direct platform calls as well as a Polyseer.io Ruby agent.
+  * All client SDK calls return a Concurrent::Promise.
+  * Supports functional style programming.
+  * Supports object-oriented style programming.
+    * ORM style instances. E.g. environment.save(), alert.trigger();
+  * A resources environment can be deduced or explicitly passed to SDK calls through the options param.
+  * API calls made using the https:// protocol.
+
+## Example
+
+Examples are available in /example
+
+## SDK Resources
+
+Use of the SDK starts with the creation of a client. To construct a client 
+instance, you may call either Polyseerio.start or Polyseerio.make. Once a
+client has been created you may use any of its resources.
+
+### Polyseerio
+
+  * Polyseerio
+    * .`start(options = {}) ⇒ Polyseerio::Client`
+      * Create a client and start an Agent.
+      * `options (Hash)`
+        - `:env`        environment variable that holds the current environment
+        - `:token`      an api token
+        - `:token_env`  if no token is provided, this environment variable will be checked
+        - `:agent`      a hash that will be used when starting this client's agent
+        - `:upsert_env` if an environment cannot be found it will be created
+        - `:version`    api version to use
+        - `:timeout`    integer containing number of ms to wait for server responses
+        - `:deduce`     if the environment should be deduced when not supplied
+    * .`make(options = {}) ⇒ Polyseerio::Client`
+      * Create a client.
+      * `options (Hash)` see Polyseerio.start options.
+    * `::Enum`
+      * `::Color (Hash)` platform color values
+      * `::Determiner (Hash)` expectation deteriner types
+      * `::Direction (Hash)` instance direction types
+      * `::Icon (Hash)` platform icon types
+      * `::Protocol (Hash)` alert protocol types
+      * `::Strategy (Hash)` instance attachment strategies
+      * `::Subtype (Hash)` instance subtypes
+      * `::Type (Hash)` resource types
+
+### Polyseerio::Client
+
+  * client
+    * `.current_environment ⇒ client.Environment`
+      * Resolves the current environment **IF** it has been deduced.
+    * `.start_agent(options = {}) ⇒ Polyseerio::Client`  
+      * Starts the Polyseer.io agent. Will use passed options or config.agent from client construction.
+    * `.Alert`
+    * `.Channel`
+    * `.Environment`
+    * `.Event`
+    * `.Expectation`
+    * `.Instance`
+    * `.LogicBlock`
+    * `.Member`
+    * `.Settings`
+    * `.Task`
+    
+### Alert
+
+  * .Alert
+    * `.create(attributes = {}, options = {})`
+    * `.find(query = {}, options = {})`
+    * `.find_by_id(id, options = {})`
+    * `.find_by_name(name, options = {})`
+    * `.new(attributes = {}) ⇒ client.Alert`
+      * `.remove()`
+      * `.save()`
+      * `.trigger(payload = {})`
+    * `.remove(id, options = {})`
+    * `.trigger(id, payload, options = {})`
+    * `.update(id, updates, options = {})`
+
+### Channel
+
+  * .Channel
+    * `.create(attributes = {}, options = {})`
+    * `.find(query = {}, options = {})`
+    * `.find_by_id(id, options = {})`
+    * `.find_by_name(name, options = {})`
+    * `.message(id, content, options = {})`
+    * `.new(attributes = {}) ⇒ client.Channel`
+      * `.message(content)`
+      * `.remove()`
+      * `.save()`
+    * `.remove(id, options = {})`
+    * `.update(id, updates, options = {})`
+
+### Environment
+
+  * .Environment
+    * `.create(attributes = {}, options = {})`
+    * `.find(query = {}, options = {})`
+    * `.find_by_id(id, options = {})`
+    * `.find_by_name(name, options = {})`
+    * `.message(id, content, options = {})`
+    * `.new(attributes = {}) ⇒ client.Environment`
+      * `.message(content)`
+      * `.remove()`
+      * `.save()`
+    * `.remove(id, options = {})`
+    * `.update(id, payload = {}, options = {})`
+
+### Event
+
+  * .Event
+    * `.create(attributes = {}, options = {})`
+    * `.find(query = {}, options = {})`
+    * `.find_by_id(id, options = {})`
+    * `.new(attributes = {}) ⇒ client.Event`
+      * `.save()`
+
+### Expectation
+
+  * .Expectation
+    * `.check(id, options = {})`
+    * `.create(attributes = {}, options = {})`
+    * `.find(query = {}, options = {})`
+    * `.find_by_id(id, options = {})`
+    * `.find_by_name(name, options = {})`
+    * `.new(attributes = {}) ⇒ client.Expectation`
+      * `.check()`
+      * `.remove()`
+      * `.save()`
+    * `.remove(id, options = {})`
+    * `.update(id, updates, options = {})`
+
+### Instance
+
+  * .Instance
+    * `.attach(options = {})`
+    * `.create(attributes = {}, options = {})`
+    * `.find(query = {}, options = {})`
+    * `.find_by_id(id, options = {})`
+    * `.find_by_name(name, options = {})`
+    * `.new(attributes = {}) ⇒ client.Instance`
+      * `.add_fact(key, resolver)`
+        * Add a fact to the attach monitoring loop.
+        * `key (symbol)`
+        * `resolver (string|number|block)`
+      * `.add_gauge(key, resolver)`
+        * Add a gauge to the attach monitoring loop.
+        * `key (symbol)`
+        * `resolver (string|number|block)`
+      * `.attach()`
+        * Start inbound monitoring.
+      * `.detach()`
+        * Terminate inbound monitoring.
+      * `.fact(key, value)`
+        * Send a one-off fact.
+      * `.gauge(key, value)`
+        * Send a one-off gauge metric.
+      * `.remove()`
+      * `.save()`
+    * `.remove(id, options = {})`
+    * `.update(id, updates, options = {})`
+
+### Logic Block
+
+  * .LogicBlock
+    * `.create(attributes = {}, options = {})`
+    * `.execute(id, options = {})`
+    * `.find(query = {}, options = {})`
+    * `.find_by_id(id, options = {})`
+    * `.find_by_name(name, options = {})`
+    * `.new(attributes = {}) ⇒ client.LogicBlock`
+      * `.execute()`
+      * `.remove()`
+      * `.save()`
+    * `.remove(id, options = {})`
+    * `.update(id, updates, options = {})`
+
+### Member
+
+  * .Member
+    * `.create(attributes = {}, options = {})`
+    * `.find(query = {}, options = {})`
+    * `.find_by_id(id, options = {})`
+    * `.new(attributes = {}) ⇒ client.Member`
+      * `.remove()`
+      * `.save()`
+    * `.remove(id, options = {})`
+    * `.update(id, updates, options = {})`
+
+### Settings
+
+  * .Settings
+    * `.retrieve()`
+    * `.update(updates, options = {})`
+
+### Task
+
+  * .Task
+    * `.create(attributes = {}, options = {})`
+    * `.find(query = {}, options = {})`
+    * `.find_by_id(id, options = {})`
+    * `.new(attributes = {}) ⇒ client.Task`
+      * `.remove()`
+      * `.save()`
+    * `.remove(id, options = {})`
+    * `.update(id, updates = {}, options = {})`
+
+## Building
+
+To test, build, and install locally:
+
+    make
+
+To build and install:
+
+    make build
+
+## Testing
+
+Testing requires:
+
+  - Make
+
+Install gems locally by running:
+
+    make install
+
+Then run a command below based on what test suite you need to run.
+
+### Lint
+
+    make lint
+
+### Unit
+
+    make unit-test
+
+### Integration
+
+    make integration-test
+
+### Validation
+
+Requires the environment to have a root level access-token defined as:
+
+    export POLYSEERIO_TOKEN=a-test-root-key
+
+    make validation-test
+
+### All
+
+    make test

data/lib/agent/agent.rb

@@ -0,0 +1,35 @@
+require 'agent/executor'
+
+module Polyseerio
+  module Agent
+    # Polyseer.io Ruby agent.
+    class Agent
+      attr_accessor :client, :instance
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Starts the agent.
+      def start(*args)
+        Executor.setup(client, *args)
+                .then do |instance|
+                  @instance = instance
+
+                  client
+                end
+      end
+
+      # Stops the agent.
+      def stop
+        Executor.teardown(client, instance).then do
+          @instance = nil
+        end
+      end
+
+      private
+
+      attr_writer :client, :instance
+    end
+  end
+end

data/lib/agent/default_config.rb

@@ -0,0 +1,51 @@
+require 'enum'
+
+# Default agent configuration.
+module Polyseerio
+  module Agent
+    DEFAULT_CONFIG = {
+      attach: true,
+      attach_strategy: Polyseerio::Enum::Strategy::FALLBACK,
+      token: nil,
+      name: nil,
+      description: 'Created by the Polyseer.io Ruby agent.',
+      group: 'agent-created',
+      environment: 'development',
+      upsert_environment: false,
+      env: 'NODE_ENV',
+      direction: Polyseerio::Enum::Direction::INBOUND,
+      subtype: Polyseerio::Enum::Subtype::LONG_RUNNING,
+      heartbeats_till_death: nil,
+      heartbeat_ttl: nil,
+      on_start: [],
+      on_error: [],
+      on_exit: [],
+      expectation: {
+        is_alive: true
+      },
+      fact: {
+        pid: true,
+        gid: true
+      },
+      metric: {
+        memory: true,
+        cpu: true,
+        uptime: true
+      },
+      event: {
+        start: true
+      },
+      process_event: {
+        exit: true,
+        warning: true,
+        uncaughtException: true,
+        unhandledRejection: true
+      },
+      process_signal: {
+        SIGHUP: true,
+        SIGINT: true,
+        SIGTERM: true
+      }
+    }.freeze
+  end
+end