chawk 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29d1fbfc067f4fb5c6e95997d265cc9764987467
+  data.tar.gz: 93a8956cbe1bf6d3a135285a537ea7c5539e8678
+SHA512:
+  metadata.gz: 0f78c30f040dbf79a534abe849a6aa4831965d1ca0e4b94dd5525e4ce1386795fb9b7ddeec299fbb608e565ec61c949a92770e1fb50895082a177b6bfa7b5b78
+  data.tar.gz: b72f8375b23223bdbef799936894acb72c99fee92932c023721c2d0a43153b54f45e214d06a075b0f910c4131bd82168c53ca116ce5bcf498a395239c9d4c0a0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sqlite3
+.DS_Store
+*.log

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+
+script: "rake test"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Scott Russell (queuetue@gmail.com / queuetue.com)
+
+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,148 @@
+# Chawk
+
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+[![Dependency Status][DS img]][Dependency Status]
+[![Code Climate][CC img]][Code Climate]
+
+[Gem Version]: https://rubygems.org/gems/chawk
+[Build Status]: https://travis-ci.org/queuetue/chawk-gem
+[travis pull requests]: https://travis-ci.org/queuetue/chawk-gem/pull_requests
+[Dependency Status]: https://gemnasium.com/queuetue/chawk-gem
+[Code Climate]: https://codeclimate.com/github/queuetue/chawk-gem
+
+[GV img]: https://badge.fury.io/rb/chawk-gem.png
+[BS img]: https://travis-ci.org/queuetue/chawk-gem.png
+[DS img]: https://gemnasium.com/queuetue/chawk-gem.png
+[CC img]: https://codeclimate.com/github/queuetue/chawk-gem.png
+[CS img]: https://coveralls.io/repos/queuetue/chawk/badge.png?branch=master
+
+## Description
+Chawk is a database agnostic time-series database written in Ruby.
+
+It tracks both both points (Integers) and values (String) in seperate datastores, and will eventually provide statistical and aggregate tools for numeric data.
+
+This is the gem that powers the server, [chawk-server](http://github.com/queuetue/chawk-server "chawk-server") 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chawk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chawk
+
+## Using Chawk
+
+Setup
+
+    require 'chawk'
+    Chawk.setup 'sqlite::memory:'
+
+DO NOT DO THIS ON AN EXISTING DATABASE, but the first time using a new database (Like this sqlite memory one that is destroyed at program exit) you should call: 
+
+    DataMapper.auto_upgrade!
+
+All Chawk data operations require an Agent.  This can be used as the main actor in your code, or can be a proxy for your own User, etc through the foreign_id property.
+
+    agent = Chawk::Models::Agent.first(name:"Steve Austin") || Chawk::Models::Agent.new(name:"Steve Austin")
+
+All data operations are performed through an Addr object.
+
+    addr = Chawk.addr(agent,"inventory/popcorn")
+
+The Addr object has two store objects - values and points.  **Points** are integers and allow mathematical and statistical operations. **Values** are strings and are intended for storing informational or serialized time series data.:
+
+    addr.values << "This is a test."
+    addr.values.last
+    =>  #<Chawk::Models::Value @id=...
+    		@observed_at=... 
+			@recorded_at=#<DateTime: ...> 
+			@meta=nil 
+			@value="This is a test." 
+			@node_id=... 
+			@agent_id=...>
+
+	addr.values << ["AND","SO","IS","THIS"]
+    addr.values.last
+	 => #<Chawk::Models::Value ... @value="THIS">
+	addr.values.last(10)
+	=> [#<Chawk::Models::Value ... @value="This is a test.">, 
+		#<Chawk::Models::Value ... @value="AND">, 
+		#<Chawk::Models::Value ... @value="SO">, 
+		#<Chawk::Models::Value ... @value="IS">, 
+		#<Chawk::Models::Value ... @value="THIS">]
+
+Addr can also return ranges from the past using the range method or the last method:
+
+	addr.values.range(Time.now-2000,Time.now-1000)
+	=> [#<Chawk::Models::Value ... @value="ROCK">, 
+		#<Chawk::Models::Value ... @value="AROUND">]
+
+	addr.values.since(Time.now-1000)
+	=> [#<Chawk::Models::Value ... @value="THE.">, 
+		#<Chawk::Models::Value ... @value="CLOCK">]
+
+These same methods also work for points:
+
+	addr.points << [10,9,8,7,6,5]
+	addr.points.last
+	=> #<Chawk::Models::Point ... @value=5>
+	addr.points.last(2)
+	=> [#<Chawk::Models::Point ... @value=6>, #<Chawk::Models::Point ... @value=5>]
+
+Points can also use the increment and decrement operators
+
+	addr.points.last
+	=> #<Chawk::Models::Point ... @value=5>
+	addr.points + 10
+	addr.pointslast
+	=> #<Chawk::Models::Point ... @value=15>
+
+As well as max and min
+
+	addr.points.max
+	=> 15
+	addr + 10
+	addr.points.last
+	=> 1
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/chawk/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 new Pull Request
+
+## License
+
+Copyright (c) 2014 Scott Russell (queuetue@gmail.com / queuetue.com)
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+end
+
+task :default => [:test]

data/chawk.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chawk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chawk"
+  spec.version       = Chawk::VERSION
+  spec.authors       = ["Scott Russell"]
+  spec.email         = ["queuetue@gmail.com"]
+  spec.summary       = %q{Time Series Storage Server}
+  spec.description   = %q{Time Series Storage Server}
+  spec.homepage      = ""
+  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_runtime_dependency "dm-sqlite-adapter", "1.2.0"
+  spec.add_runtime_dependency "dm-postgres-adapter","1.2.0"
+  spec.add_runtime_dependency "data_mapper", "1.2.0"
+  spec.add_runtime_dependency "dm-is-tree", "1.2.0"
+  spec.add_runtime_dependency "dm-aggregates", "1.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('minitest', '5.3.0')
+  spec.add_development_dependency('rack-test', "0.6.2")
+  spec.add_development_dependency('json', "1.8.1")
+  spec.add_development_dependency('coveralls', "0.7.0")
+  spec.add_development_dependency('fakeweb')
+
+end

data/lib/addr.rb

@@ -0,0 +1,89 @@
+require 'vaddr'
+require 'paddr'
+module Chawk
+	class Addr
+		attr_reader :path, :node, :agent
+		def initialize(agent,path)
+			@path = path
+			@agent = agent
+
+			unless path.is_a?(String)
+				#DataMapper.logger.debug "NOT A STRING"
+				raise ArgumentError
+			end
+
+			unless path =~ /^[\w\/\:\\]+$/
+				#DataMapper.logger.debug "BAD MATCH"
+				raise ArgumentError
+			end
+
+			@node = find_or_create_addr(path)
+
+			unless @node
+				#DataMapper.logger.debug "NOT A NODE"
+				raise ArgumentError
+			end
+		end
+
+		def address
+			@path
+		end
+
+
+		def values()
+			Chawk::Vaddr.new(self)
+		end
+
+		def points()
+			Chawk::Paddr.new(self)
+		end
+
+		def public_read=(value,options={})
+			value = value ? true : false
+			#DataMapper.logger.debug "MAKING #{@node.address} PUBLIC (#{value})"
+			@node.update(public_read:value)
+		end
+
+		def set_permissions(agent,read=false,write=false,admin=false)
+			#DataMapper.logger.debug "REVOKING #{@node.address} / #{@agent.name} "
+			@node.relations.all(agent:agent).destroy()
+			if read || write || admin
+				vals = {agent:agent,read:(read ? true : false),write:(write ? true : false),admin:(admin ? true : false)}
+				#DataMapper.logger.debug "SET PERMISSIONS #{@node.address} / #{vals} "
+				@node.relations.create(vals)
+			end
+			nil
+		end
+
+		def check_node_security(node)
+			if node.public_read
+				#DataMapper.logger.debug "NODE IS PUBLIC ACCESSABLE -- #{@agent.name} - #{@agent.id}"
+				return node
+			end
+			rel = node.relations.first(agent:@agent)
+			if (rel && (rel.read || rel.admin))
+				#DataMapper.logger.debug "NODE IS ACCESSABLE -- #{@agent.name} - #{@agent.id}"
+			return node
+			else
+				#DataMapper.logger.debug "NODE IS INACCESSABLE -- #{@agent.name} - #{@agent.id}"
+				raise SecurityError
+			end
+		end
+
+		def find_or_create_addr(addr)
+			#TODO also accept regex-tested string
+			raise ArgumentError unless addr.is_a?(String)
+
+			node = Chawk::Models::Node.first(address:self.address)
+			if node
+				node = check_node_security(node)
+			else
+				#DataMapper.logger.debug "NODE CREATED -- #{@agent.name} -- #{@agent.id}"
+				node = Chawk::Models::Node.create(address:self.address) if node.nil?
+				node.relations.create(agent:@agent,node:node,admin:true,read:true,write:true)
+				return node
+			end
+		end
+
+	end
+end

data/lib/chawk.rb

@@ -0,0 +1,46 @@
+require "chawk/version"
+require 'data_mapper'
+require 'dm-is-tree'
+require 'quantizer'
+require 'models'
+require 'addr'
+
+module Chawk
+
+	@@ready = nil
+
+	def self.addr(agent,path)
+		if @@ready.nil?
+			raise "Chawk has not been setup yet."
+		end
+
+		if agent.is_a?(Chawk::Models::Agent) && path.is_a?(String)
+			return Chawk::Addr.new(agent,path)
+		else
+			raise ArgumentError
+		end
+	end
+
+	def self.clear_all_data!
+		if @@ready.nil?
+			raise "Chawk has not been setup yet."
+		end
+
+		Chawk::Models::Agent.all.destroy!
+		Chawk::Models::Relation.all.destroy!
+		Chawk::Models::AgentTag.all.destroy!
+		Chawk::Models::Tag.all.destroy!
+		Chawk::Models::Node.all.destroy!
+		Chawk::Models::Point.all.destroy!
+		Chawk::Models::Value.all.destroy!
+	end
+
+
+	def self.setup(database_url)
+		@@ready = true
+		adapter = DataMapper.setup(:default, database_url)
+		DataMapper::Model.raise_on_save_failure = true
+		DataMapper.finalize
+		nil
+	end
+end

data/lib/chawk/version.rb

@@ -0,0 +1,3 @@
+module Chawk
+  VERSION = "0.1.10"
+end

data/lib/models.rb

@@ -0,0 +1,87 @@
+require 'data_mapper'
+require 'dm-aggregates'
+module Chawk
+	module Models
+
+		module Datum
+		    def self.included(base)
+		      base.class_eval do
+		        include DataMapper::Resource
+				before :create, :set_timestamp
+
+		        property :id, DataMapper::Property::Serial
+				property :observed_at, DataMapper::Property::Float
+				property :recorded_at, DataMapper::Property::DateTime
+				property :meta, DataMapper::Property::Text
+
+				belongs_to :node
+				belongs_to :agent
+
+				def set_timestamp
+					attribute_set(:recorded_at, DateTime.now )
+				end
+
+		      end
+		    end
+
+		end
+
+		class Agent
+			include DataMapper::Resource
+			property :id, Serial
+			property :foreign_id, Integer
+			property :name, String, length:200
+			has n, :tags
+			has n, :agent_tags
+			has n, :relations
+		end
+
+		class Relation
+			include DataMapper::Resource
+			property :id, Serial
+			property :admin, Boolean, default:false
+			property :read, Boolean, default:false
+			property :write, Boolean, default:false
+			belongs_to :agent
+			belongs_to :node
+		end
+
+		class AgentTag
+			include DataMapper::Resource
+			property :id, Serial
+			property :name, String, length:100
+			property :description, Text
+			property :managed, Boolean, default:false
+			belongs_to :agent
+		end
+
+		class Tag
+			include DataMapper::Resource
+			property :description, Text
+			property :id, Serial
+			property :name, String, length:100
+		end
+
+		class Node
+			include DataMapper::Resource
+			property :id, Serial
+			property :address, String, length:150
+			property :public_read, Boolean, default:false
+			property :public_write, Boolean, default:false
+
+			has n, :points
+			has n, :values
+			has n, :relations
+		end
+
+		class Point
+			include Chawk::Models::Datum
+			property :value, Integer
+		end
+
+		class Value
+			include Chawk::Models::Datum
+			property :value, Text
+		end
+	end
+end