linr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcef053de65df1f4d261265f2bda9580f189d1a4
+  data.tar.gz: 266287b7ecdf66623a5eb8604b504778a776ea98
+SHA512:
+  metadata.gz: d8f00681cb50cad889a4d2e72f176ab91ca951672f175432d75de041d54cbddd7ef8d2c1c70f5577f351a8e3d696ed6d9d9c652437aab4d6195161776d29250a
+  data.tar.gz: b23d48e01425fadb19117929e12ca9e0c71a3a6804634e3d800bf687f83a1e451bb66ce62776a8057d95232fe0705be671d0305e6928442170f929dbffeec687

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Allow fresh games
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - "test/**/*"

data/.ruby-gemset

@@ -0,0 +1 @@
+linr

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+sudo: false
+before_install: gem install bundler -v 1.10.6
+rvm:
+  - "2.2"
+  - "2.1"
+  - "2.0"
+  - "1.9.3"
+  - ruby-head
+  - rbx-2
+  - jruby-19mode
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jonas Thiel
+
+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 @@
+# linr
+
+[![Gem Version](https://badge.fury.io/rb/linr.svg)](https://rubygems.org/gems/linr)
+[![Build Status](https://travis-ci.org/jnbt/linr.svg?branch=master)](https://travis-ci.org/jnbt/linr)
+[![Coverage Status](https://coveralls.io/repos/jnbt/linr/badge.svg?branch=master)](https://coveralls.io/r/jnbt/linr?branch=master)
+[![Code Climate](https://codeclimate.com/github/jnbt/linr/badges/gpa.svg)](https://codeclimate.com/github/jnbt/linr)
+[![Gemnasium](https://img.shields.io/gemnasium/jnbt/linr.svg?style=flat)](https://gemnasium.com/jnbt/linr)
+[![Inline docs](http://inch-ci.org/github/jnbt/linr.svg?branch=master)](http://inch-ci.org/github/jnbt/linr)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg?style=flat)](http://www.rubydoc.info/github/jnbt/linr/master)
+
+A simple UDP client for [InfluxDB](https://influxdb.com)
+
+:construction: :warning:
+**This project is in very stage. Things will change!**
+
+## Install
+
+    $ [sudo] gem install linr
+
+Or add it to your Gemfile, etc.
+
+## Usage
+
+Connect to a InfluxDB host via
+[UDP](https://influxdb.com/docs/v0.9/write_protocols/udp.html)
+and send a series:
+
+```ruby
+require "linr"
+
+client = Linr::Client.new(host: "127.0.0.1", port: 8836)
+client.write(
+ measurement: "cpu_load_short",
+ tags: { host: "server01", region: "us-west" },
+ fields: { value: 0.64 },
+ timestamp: 1434055562
+)
+```
+
+## References
+
+* [Line Protocol Syntax](https://influxdb.com/docs/v0.9/write_protocols/write_syntax.html)
+* [InfluxDB UDP](https://influxdb.com/docs/v0.9/write_protocols/udp.html)
+
+## Testing
+
+Just run
+
+    $ rake
+
+
+## Contributing
+
+1. Fork it ( https://github.com/jnbt/linr/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,13 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/lib/linr.rb

@@ -0,0 +1,11 @@
+require "linr/version"
+require "linr/config"
+require "linr/client"
+require "linr/data"
+require "linr/encoder"
+require "linr/connection"
+require "linr/logger"
+
+# A simple UDP client for InfluxDB
+module Linr
+end

data/lib/linr/client.rb

@@ -0,0 +1,60 @@
+module Linr
+  # Simple UDP-based InfluxDB client
+  # @example
+  #   client = Client.new(host: "127.0.0.1", port: 8063)
+  #   client.write(
+  #     measurement: "cpu_load_short",
+  #     tags: { host: "server01", region: "us-west" },
+  #     fields: { value: 0.64 },
+  #     timestamp: 1434055562
+  #   )
+  class Client
+    attr_reader :config
+
+    # Initialize a new client.
+    # @param opts [Hash] See {Config} for opts
+    # @see Config
+    def initialize(opts = {})
+      @config = Config.new(opts)
+      connect!
+    end
+
+    # Write one or more series to the InfluxDB connection
+    # @param series [Array<Hash>] see {Data} for values
+    def write(*series)
+      payload = build_payload(series)
+      send(payload)
+    end
+
+    private
+
+    def connect!
+      @connection = Connection::UDP.new(config.host, config.port)
+      info("Connected to #{config.host}:#{config.port}")
+    end
+
+    def build_payload(series)
+      series.map do |serie|
+        data = Data.new(serie)
+        encode(data)
+      end.join("\n")
+    end
+
+    def send(payload)
+      debug(payload)
+      @connection.send(payload)
+    end
+
+    def encode(data)
+      config.encoder.dump(data)
+    end
+
+    def info(matter)
+      config.logger.info("Linr") { matter }
+    end
+
+    def debug(matter)
+      config.logger.debug("Linr") { matter }
+    end
+  end
+end

data/lib/linr/config.rb

@@ -0,0 +1,24 @@
+module Linr
+  # Holds the config of a {Client}
+  # @example
+  #   Config.new(host: "db.domain.com", logger: Logger.new($stdout))
+  class Config
+    attr_reader :host
+    attr_reader :port
+    attr_reader :logger
+    attr_reader :encoder
+
+    # Build a config based on opts
+    # @param opts [Hash] the options to create the config
+    # @option opts [String] :host
+    # @option opts [Fixnum] :port
+    # @option opts [::Logger] :logger
+    # @option opts [Object] :encoder
+    def initialize(opts = {})
+      @host    = opts.fetch(:host, "127.0.0.1")
+      @port    = opts.fetch(:port, 8089)
+      @logger  = opts.fetch(:logger, Logger::Null.new)
+      @encoder = opts.fetch(:encoder, Encoder::Line.new)
+    end
+  end
+end

data/lib/linr/connection.rb

@@ -0,0 +1 @@
+require "linr/connection/udp"

data/lib/linr/connection/udp.rb

@@ -0,0 +1,30 @@
+require "socket"
+
+module Linr
+  module Connection
+    # Connects to a InfluxDB UDP port
+    # @see https://influxdb.com/docs/v0.9/write_protocols/udp.html
+    # @example
+    #   UDP.new("localhost", 8089).send("series a=0.51")
+    class UDP
+      # Use non-custom flags
+      SEND_FLAGS = 0
+
+      # Establishes a connection
+      # @param host [String]
+      # @param port [Fixnum]
+      def initialize(host, port)
+        @socket = UDPSocket.new
+        @socket.connect(host, port)
+      end
+
+      # Send data over the UDP connection. Should be encoded using the Line
+      # Protocol.
+      # @see Encoder::Line
+      # @param data [String]
+      def send(data)
+        @socket.send(data, SEND_FLAGS)
+      end
+    end
+  end
+end

data/lib/linr/data.rb

@@ -0,0 +1,24 @@
+module Linr
+  # Describes series send to InfluxDB
+  # @see https://influxdb.com/docs/v0.9/guides/writing_data.html
+  # @example
+  #   Data.new(
+  #     measurement: cpu_load_short,
+  #     tags: { host: "server01", region: "us-west" },
+  #     fields: { value: 0.64 },
+  #     timestamp: 1434055562
+  #   )
+  class Data
+    attr_reader :measurement
+    attr_reader :fields
+    attr_reader :tags
+    attr_reader :timestamp
+
+    def initialize(source)
+      @measurement = source.fetch(:measurement)
+      @fields      = source.fetch(:fields)
+      @tags        = source[:tags]
+      @timestamp   = source[:timestamp]
+    end
+  end
+end

data/lib/linr/encoder.rb

@@ -0,0 +1 @@
+require "linr/encoder/line"

data/lib/linr/encoder/line.rb

@@ -0,0 +1,81 @@
+module Linr
+  module Encoder
+    # Encodes data entry into the InfluxDB line format.
+    # @see https://influxdb.com/docs/v0.9/write_protocols/write_syntax.html
+    # @example Encode a data series
+    #   Line.new.dump(Data.new(measurement: "series", fields: { a: 0.5 }))
+    class Line
+      # Encodes data into the line syntax
+      # @param data [Data]
+      # @return [String]
+      def dump(data)
+        [
+          dump_measurement(data.measurement),
+          dump_tags(data.tags),
+          dump_fields(data.fields),
+          dump_timestamp(data.timestamp)
+        ].compact.join
+      end
+
+      private
+
+      def dump_measurement(measurement)
+        escape_key(measurement)
+      end
+
+      def dump_tags(tags)
+        dump_collection(tags, ",") do |key, value|
+          "#{escape_key(key)}=#{escape_value(value)}"
+        end
+      end
+
+      def dump_fields(fields)
+        dump_collection(fields) do |key, value|
+          "#{escape_key(key)}=#{encode_field_value(value)}"
+        end
+      end
+
+      def dump_timestamp(timestamp)
+        " #{timestamp}" if timestamp
+      end
+
+      def dump_collection(data, prefix = " ", &block)
+        return unless data && !data.empty?
+        prefix + data.map(&block).join(",")
+      end
+
+      def encode_field_value(value)
+        case value
+        when Numeric
+          encode_numberic(value)
+        when TrueClass, FalseClass
+          value.to_s
+        else
+          escape_qoute(escape_value(value))
+        end
+      end
+
+      def encode_numberic(value)
+        "#{value}i" if value.is_a?(Fixnum)
+        value
+      end
+
+      def escape_value(input)
+        input.to_s
+          .gsub(/\s/, '\ ')
+          .gsub(",", '\,')
+          .gsub('"', '\"')
+      end
+
+      def escape_qoute(input)
+        %("#{input}")
+      end
+
+      def escape_key(input)
+        input.to_s
+          .gsub(/\s/, '\ ')
+          .gsub(",", '\,')
+      end
+    end
+  end
+end

data/lib/linr/logger.rb

@@ -0,0 +1 @@
+require "linr/logger/null"

data/lib/linr/logger/null.rb

@@ -0,0 +1,15 @@
+require "logger"
+
+module Linr
+  module Logger
+    # A simple null logger without any output
+    # @api private
+    class Null < ::Logger
+      def initialize(*_args)
+      end
+
+      def add(*_args, &_block)
+      end
+    end
+  end
+end

data/lib/linr/version.rb

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

data/linr.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "linr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "linr"
+  spec.version       = Linr::VERSION
+  spec.authors       = ["Jonas Thiel"]
+  spec.email         = ["jonas@thiel.io"]
+
+  spec.summary       = "A simple UDP client for InfluxDB"
+  spec.description   = "A simple UDP client for InfluxDB"
+  spec.homepage      = "https://github.com/jnbt/linr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "inch", "~> 0.7"
+  spec.add_development_dependency "rubocop", "~> 0.35"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: linr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonas Thiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+description: A simple UDP client for InfluxDB
+email:
+- jonas@thiel.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/linr.rb
+- lib/linr/client.rb
+- lib/linr/config.rb
+- lib/linr/connection.rb
+- lib/linr/connection/udp.rb
+- lib/linr/data.rb
+- lib/linr/encoder.rb
+- lib/linr/encoder/line.rb
+- lib/linr/logger.rb
+- lib/linr/logger/null.rb
+- lib/linr/version.rb
+- linr.gemspec
+homepage: https://github.com/jnbt/linr
+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.1
+signing_key: 
+specification_version: 4
+summary: A simple UDP client for InfluxDB
+test_files: []
+has_rdoc: