conduit-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b1523f3b4dd9019a07e73f39320df07cbf79d58
+  data.tar.gz: 880a5e757a3bfb43b1ab53b3accfb4f25fd84db8
+SHA512:
+  metadata.gz: 832552cea615906e25bdf00a1e2cd0abb2601bd9a3adcaa082bc0ba65a1bda81bfd0a21c21b7ddf13349146cc57c7798af1108d858ff21c427da7d75081df5b1
+  data.tar.gz: 31ce006881e556c5535fd3c6cdd6bc09a559df0d67c55bbe36922e38240325eaa037544e1c6375527ca78028fe4fcc847e5531f649ae75cacfe45fd75c436892

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Joe Bellus
+
+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.md

@@ -0,0 +1,122 @@
+# Ruby SDK for Conduit
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'conduit-sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install conduit-sdk
+
+## Usage
+
+### Create a client
+
+To create a client you will need an administrative access key and key name. These can be generated from the conduit CLI on the server.
+
+```ruby
+    Conduit::Client.new(hostAddress, keyName, keySecret)
+```
+
+### Register a mailbox
+
+```ruby
+    client = Conduit::Client.new(hostAddress, keyName, keySecret)
+    client.register("my.mailbox.name")
+```
+
+This will register a new mailbox with the server, it will raise Conduit::APIError on failure.
+
+### Deregister a mailbox
+
+```ruby
+    client = Conduit::Client.new(hostAddress, keyName, keySecret)
+    client.deregister("my.mailbox.name")
+```
+
+This will delete a mailbox and purge its messages, it will raise Conduit::APIError on failure.
+
+### Getting system statistics
+
+The system_stats method will return a number of metrics.
+
+```ruby
+    client = Conduit::Client.new(hostAddress, keyName, keySecret)
+    stats = client.system.stats
+    puts stats[:field]
+```
+
+#### Fields
+
+* _totalMailboxes_ - The total number of mailboxes registered in the system.
+* _messageCount_ - The total number of messages that have passed through the system.
+* _pendingMessages_ - The current number of messages waiting to be delivered.
+* _connectedClients_ - The current number of clients that are connected to the server.
+* _dbVersion_ - The server database version.
+* _threads_ - The number of active threads the server is using.
+* _cpuCount_ - The number of CPUs available to the server.
+* _memory_ - The total allocated memory the server is currently using.
+* _filesCount_ - The total number of script assets stored on the server.
+* _filesSize_ - The size on disk of all script assets the server is holding.
+
+### Getting client statistics
+
+The system_stats method will return a number of metrics.
+
+```ruby
+    client = Conduit::Client.new(hostAddress, keyName, keySecret)
+    stats = client.client_stats.clients.each do |client|
+        puts client[:field]
+    end
+```
+
+#### Fields
+
+* _version_ - The client's last reported Conduit version.
+* _online_ - True if the client is currently connected.
+* _mailbox_ - The client's mailbox name.
+* _lastSeenAt_ - A date/time string when the client last checked for messages.
+* _host_ - The IP address of the client.
+
+### Listing deployments
+
+```ruby
+    client = Conduit::Client.new(hostAddress, keyName, keySecret)
+    client.list_deployments(_options_).deployments.each do |d|
+        puts d[:field]
+    end
+```
+
+#### Options
+
+* _deploymentId_ - The name of a specific deployment. If specified the response will contain a :responses array which will contain information on the client responses to the deployment.
+* _nameSearch_ - A glob pattern for searching deployment names (ex: "Upgrade*").
+* _keySearch_ - A glob pattern for searching for deployments based on the keyname that deployed them (ex: ops.*).
+* _count_ - The number of deployments to return.
+
+#### Fields
+
+* _name_ - The name of the deployment
+* _createdAt_ A date string representing the creation time of the deployment.
+* _pendignMessages_ - The number of messages that have not been picked up.
+* _totalMessages_ - The total number of messages deployed.
+* _responseCount_ - The number of responses received
+* _responses_ - An array of hashses for the client responses to the deployments. Each has has the follwoing keys: Mailbox, Response, RespondedAt, and IsError. This value is only present if a specific deploymentId was specifeid.
+* _deployedBy_ - The access key name used to create the deployment.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/conduit-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/conduit.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'conduit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "conduit-sdk"
+  spec.version       = Conduit::VERSION
+  spec.authors       = ["Joe Bellus"]
+  spec.email         = ["joe@5sigma.io"]
+  spec.summary       = %q{Ruby bindings for Conduit.}
+  spec.description   = %q{An API SDK for communicating with a Conduit server.}
+  spec.homepage      = "http://conduit.5sigma.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/conduit.rb

@@ -0,0 +1,89 @@
+#require "conduit/version"
+require "openssl"
+require "base64"
+require "net/http"
+require "json"
+require 'securerandom'
+require 'uri'
+
+module Conduit
+
+  class ApiError < StandardError; end
+
+  class ApiClient
+    attr_accessor :host, :access_key_name, :access_key_secret
+    def initialize(host, key_name, key_secret)
+      @host = host
+      @access_key_name = key_name
+      @access_key_secret = key_secret
+    end
+
+    def sign!(request)
+      request[:requestTime] = Time.new.strftime("%Y-%m-%dT%H:%M:%S%:z")
+      request[:token] = SecureRandom.uuid
+      data = request[:token] + request[:requestTime]
+      hmac =  OpenSSL::HMAC.digest("sha256", @access_key_secret, data)
+      request[:keyName] = @access_key_name
+      request[:signature] = Base64.encode64(hmac)
+    end
+
+    def request(endpoint, request)
+      uri = URI("http://#{@host}/#{endpoint}")
+      req = Net::HTTP::Post.new(uri)
+      req.content_type = 'application/json'
+      sign! request
+      req.body = JSON.generate(request)
+      res = Net::HTTP.new(uri.hostname, uri.port).start {|h| h.request(req) }
+      if res.code == "200"
+        return JSON.parse(res.body)
+      end
+      if res.code == "404"
+        raise ApiError, "Endpoint not found"
+      end
+      if res.code == "400"
+        raise ApiError, JSON.parse(res.body)[:error]
+      end
+      puts res.code
+    end
+
+    def register(mailbox_name)
+      request "register", {mailbox: mailbox_name}
+    end
+
+    def deregister(mailbox_name)
+      request "deregister", {mailbox: mailbox_name}
+    end
+
+    def get_message()
+      request "get", {mailbox: mailbox_name}
+    end
+
+    def system_stats()
+      request "stats", {}
+    end
+
+    def client_stats()
+      request "stats/clients", {}
+    end
+
+    def list_deployments(opts = {})
+      request = {}
+      request[:deploymentId] = opts[:id] || ""
+      request[:nameSearch] = opts[:name] || ""
+      request[:keySearch] = opts[:keyName] || ""
+      request[:count] = opts[:count] || 10
+      request "deploy/list", request
+    end
+
+    def deploy(mailboxes, script, opts = {})
+      request = {body: script}
+      request[:mailboxes] = mailboxes if mailboxes.is_a Array
+      request[:pattern] = mailboxes if mailboxes.is_a String
+      request[:deploymentName] = opts[:name] if opts[:name]
+      request[:asset] = opts[:asset] if opts[:asset]
+      request "put", request
+    end
+
+  end
+
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Conduit
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: conduit-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joe Bellus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: An API SDK for communicating with a Conduit server.
+email:
+- joe@5sigma.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- conduit.gemspec
+- lib/conduit.rb
+- lib/version.rb
+homepage: http://conduit.5sigma.io
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for Conduit.
+test_files: []
+has_rdoc: