ganymed-client 0.1.0

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage/
+doc/
+ganymed.pid
+ganymed.profile*
+lib/bundler/man
+node_modules/
+old/
+pkg
+prof/
+rdoc
+spec/reports
+test.js
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper --color --format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3-p125@ganymed-client

data/.yardopts

@@ -0,0 +1 @@
+--protected --no-private

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+
+gemspec
+
+group :development, :test do
+  gem 'bundler'
+  gem 'debugger'
+  gem 'perftools.rb'
+  gem 'pry'
+  gem 'pry-doc'
+  gem 'redcarpet'
+  gem 'reek'
+  gem 'rspec'
+  gem 'ruby-prof'
+  gem 'ruby2ruby', '=1.3.0' # 1.3.1 is broken :(
+  gem 'simplecov'
+  gem 'yard'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Benedikt Böhm
+
+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,15 @@
+# Ganymed::Client
+
+A simple client library for [Ganymed](https://github.com/zenops/ganymed).
+
+## Usage
+
+TBD
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec]

data/ganymed-client.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ganymed/client/version"
+
+Gem::Specification.new do |s|
+  s.name = "ganymed-client"
+  s.version = Ganymed::Client::VERSION
+  s.authors = ["Benedikt Böhm"]
+  s.email = ["bb@xnull.de"]
+  s.homepage = "http://github.com/zenops/ganymed-client"
+  s.summary = %q{Client library for Ganymed}
+  s.description = %q{Client library for Ganymed}
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths    = ["lib"]
+
+  s.add_dependency "msgpack"
+end

data/lib/ganymed/client/version.rb

@@ -0,0 +1,6 @@
+module Ganymed
+  class Client
+    # @private
+    VERSION = '0.1.0'
+  end
+end

data/lib/ganymed/client.rb

@@ -0,0 +1,131 @@
+require 'socket'
+require 'msgpack'
+
+module Ganymed
+
+  ##
+  # The Client connects to the Sampler and/or Processor and emits samples
+  # and/or events respectively.
+  #
+  class Client
+
+    # The {ProcessorSocket Processor socket}.
+    attr_reader :processor
+
+    # The {SamplerSocket Sampler socket}.
+    attr_reader :sampler
+
+    # Create a new client instance.
+    #
+    # @param [Hash] opts  Client options.
+    # @option opts [Hash] :processor  Options passed to the {ProcessorSocket}.
+    # @option opts [Hash] :sampler  Options passed to the {SamplerSocket}.
+    def initialize(opts)
+      @processor = ProcessorSocket.new(opts[:processor]) if opts[:processor]
+      @sampler = SamplerSocket.new(opts[:sampler]) if opts[:sampler]
+    end
+
+    ##
+    # A simple UDPSocket wrapper.
+    #
+    class Socket
+
+      # Create a new Socket instance.
+      #
+      # @param [Hash] opts  Socket options.
+      # @option opts [String] :host  Host to connect to.
+      # @option opts [Fixnum] :port  Port to connect to.
+      # @option opts [String] :origin Origin of Samples/Events. Defaults to the
+      #                               fully-qualified hostname.
+      def initialize(opts)
+        @host, @port = opts[:host], opts[:port]
+        @socket = UDPSocket.new
+        @origin = opts[:origin] || ::Socket.gethostbyname(::Socket.gethostname).first
+      end
+
+      # Send data to the socket.
+      #
+      # @param [String] data  The data to send.
+      # @param [Fixnum] flags  Socket flags.
+      def send(data, flags=0)
+        @socket.send(data, flags, @host, @port)
+      end
+    end
+
+    ##
+    # A {Socket} that emits samples to a Sampler.
+    #
+    class SamplerSocket < Socket
+
+      # Emit a new sample.
+      #
+      # @param [String, Symbol] ds  Sample data source.
+      # @param [String] ns  Event namespace.
+      # @param [Fixnum, Float] value  Sample value.
+      # @param [Time] now  Sample timestamp.
+      def emit(ds, ns, value, now=Time.now.utc)
+        data = [ds.to_s, ns, @origin, now.to_f, value.to_f]
+        send(data.pack("Z*Z*Z*GG"))
+      end
+    end
+
+    ##
+    # A {Socket} that emits events to a Processor.
+    #
+    class ProcessorSocket < Socket
+
+      # Emit a new Event.
+      #
+      # @param [String] ns  Event namespace.
+      # @param [Object] value  Event value.
+      # @param [Hash] opts  Options
+      # @option opts [String] cf  Consolidation function used in this event.
+      # @option opts [Time] now  Event timestamp.
+      # @option opts [Fixnum] resolution  Event resolution.
+      # @option opts [String] origin  Event origin.
+      def event(ns, value, opts={})
+        opts = {
+          :cf => nil,
+          :now => Time.now.utc,
+          :resolution => 0,
+          :origin => @origin,
+        }.merge(opts)
+
+        {
+          :_type => :event,
+          :n => ns,
+          :c => opts[:cf],
+          :o => opts[:origin],
+          :t => opts[:now].to_i,
+          :r => opts[:resolution].to_i,
+          :v => value
+        }.tap do |data|
+          send(data.to_msgpack)
+        end
+      end
+
+      # Emit a metadata object to the Processor.
+      #
+      # A metadata object contains arbitrary data related to the origin. This
+      # can be queried by Websocket clients for displaying information about
+      # origins.
+      #
+      # @param [Hash] data  Metadata object.
+      # @param [Hash] opts  Options
+      # @option opts [String] origin  Metadata origin.
+      def metadata(data, opts={})
+        opts = {
+          :origin => @origin,
+        }.merge(opts)
+
+        {
+          :_type => :metadata,
+          :origin => opts[:origin],
+          :data => data,
+        }.tap do |data|
+          send(data.to_msgpack)
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--require spec_helper --color --format documentation

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+$:.unshift(File.join(File.expand_path("../..", __FILE__), 'lib'))
+
+require 'rspec'
+require 'debugger'
+require 'simplecov'
+SimpleCov.start
+
+RSpec.configure do |config|
+end

data/tasks/reek.rake

@@ -0,0 +1,5 @@
+require 'reek/rake/task'
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+end

data/tasks/rspec.rake

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run the specs"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--options', "spec/spec.opts"]
+end

data/tasks/yard.rake

@@ -0,0 +1,5 @@
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README.rdoc']
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: ganymed-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Benedikt Böhm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: &9787780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9787780
+description: Client library for Ganymed
+email:
+- bb@xnull.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ganymed-client.gemspec
+- lib/ganymed/client.rb
+- lib/ganymed/client/version.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/reek.rake
+- tasks/rspec.rake
+- tasks/yard.rake
+homepage: http://github.com/zenops/ganymed-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1972040912805276168
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1972040912805276168
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Client library for Ganymed
+test_files:
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: