chawk 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e45b7bfdb83f83bc57e9fd40b1ca45d1e7f8093
-  data.tar.gz: 58a5800c07914a2ba330d8fc487a4e9dd0976c48
+  metadata.gz: 8e4af3f3f47d72453ac226d2f5645f8288c38843
+  data.tar.gz: 4c5cdc1405311d4b03e67540f0fd55c1eb4997af
 SHA512:
-  metadata.gz: f8db6cfd8327facfe80afab263fb7826cfbf97b537975aa5715ff750c3bf01845034ec78339c8fb27d0ae165252c139ca2b7cf35924d3abb09191ff39ff265d8
-  data.tar.gz: 1598c3c209cd5590fb187aaa3ae5bea1a224d2b5754c51cb914d96f0489933b17e71c5c397c3120c308a5337227e5b67b8964e771e6e19465d2d11842e3be25d
+  metadata.gz: e276cefee3bc31f2bd0c3e1fd668a67336935abde8f17624f901d672e85fc03f22b61777bc9f4d166d1bcf6fcaeb451fe54702de8b166e0ffc722e78991cb696
+  data.tar.gz: c373b9799df4768f20851298ce7a083cfe16174a24b73e29769b48920e034273ff91a5df75509ca6f941c20cd232be6bb079e1eb9652ed214646f6fea490499f

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.env
 .bundle
 .config
 .yardoc

data/.pryrc

@@ -0,0 +1,10 @@
+$:.unshift('lib')
+
+require 'active_record'
+require 'hirb'
+require 'chawk'
+
+
+Hirb.enable
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Base.establish_connection ENV["TEST_DATABASE_URL"]

data/.travis.yml

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

data/CHANGES

@@ -0,0 +1,5 @@
+
+-- 0.1.15 --
+Added "append" method and redirected << into it (Apparently, << is magic and won't take 2 parameters)
+-- 0.1.16 --
+Switched to ActiveRecord, removed DataMapper

data/chawk.gemspec

@@ -18,15 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  #spec.add_runtime_dependency "dm-postgres-adapter","1.2.0"
-  spec.add_runtime_dependency "data_mapper", "1.2.0"
+  spec.add_runtime_dependency('activerecord',"4.0.4")
   
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency('minitest', '5.3.0')
+  spec.add_development_dependency('minitest', '5.3.1')
   spec.add_development_dependency('rack-test', "0.6.2")
   spec.add_development_dependency('json', "1.8.1")
-  spec.add_development_dependency('simplecov')
-  spec.add_development_dependency "dm-sqlite-adapter", "1.2.0"
-
+  spec.add_development_dependency('simplecov', "0.8.2")
+  spec.add_development_dependency('pg', "0.17.1")
+  spec.add_development_dependency('sqlite3', "1.3.9")
 end

data/lib/chawk.rb

@@ -1,35 +1,65 @@
 require "chawk/version"
-require 'data_mapper'
 require 'quantizer'
 require 'models'
-require 'addr'
 
 # Chawk is a gem for storing and retrieving time seris data.
 module Chawk
+	def self.check_node_security(agent,node)
 
-	# Has Chawk been setup yet?
-	@@ready = nil
+		if node.public_read
+			return node
+		end
+
+		rel = node.relations.where(agent_id:agent.id).first
+
+		if (rel && (rel.read || rel.admin))
+			return node
+		else
+			raise SecurityError,"You do not have permission to access this node. #{agent} #{rel}"
+		end
+	end
+
+	def self.find_or_create_node(agent,key)
+		#TODO also accept regex-tested string
+		raise(ArgumentError,"Key must be a string.") unless key.is_a?(String)
+
+		node = Chawk::Models::Node.where(key:key).first
+		if node
+			node = check_node_security(agent,node)
+		else
+			node = Chawk::Models::Node.create(key:key) if node.nil?
+			node.relations.create(agent:agent,node:node,admin:true,read:true,write:true)
+			return node
+		end
+	end
 
 	# @param agent [Chawk::Agent] the agent whose permission will be used for this request 
-	# @param path [String] the string address this addr can be found in the database.
+	# @param key [String] the string address this addr can be found in the database.
 	# @return [Chawk::Addr]
-	# The primary method for retrieving an Addr.  If a path does not exist, it will be created 
+	# The primary method for retrieving an Addr.  If a key does not exist, it will be created 
 	# and the current agent will be set as an admin for it.
-	def self.addr(agent,path)
-		if @@ready.nil?
-			raise "Chawk has not been setup yet."
+	def self.addr(agent,key)
+
+		unless key =~ /^[\w\:\$\!\@\*\[\]\~\(\)]+$/
+			raise ArgumentError, "Key can only contain [A-Za-z0-9_:$!@*[]~()] (#{key})"
 		end
 
 		unless agent.is_a?(Chawk::Models::Agent) 
 			raise ArgumentError, 'Agent must be a Chawk::Models::Agent instance'
 		end
 
-		unless path.is_a?(String)
-			raise ArgumentError, 'Path must be a string.'
+		unless key.is_a?(String)
+			raise ArgumentError, 'key must be a string.'
 		end
 
-		return Chawk::Addr.new(agent,path)
+		node = find_or_create_node(agent,key)
+
+		unless node
+			raise ArgumentError,"No node was returned."
+		end
 
+		node.agent = agent
+		return node
 	end
 
 	# @param agent [Chawk::Agent] the agent whose permission will be used for this request 
@@ -40,34 +70,17 @@ module Chawk
 		data.keys.each do |key|
 			dset = data[key]
 			daddr = addr(agent,key)
-			daddr.points << dset
+			daddr.add_points dset
 		end
 	end
 
 
 	# Deletes all data in the database.  Very dangerous.  Backup often!
 	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
-
-
-	# @param database_url [String]
-	# Startup routine for Chawk, requires a database URL in DataMapper's standard format.
-	def self.setup(database_url)
-		@@ready = true
-		adapter = DataMapper.setup(:default, database_url)
-		DataMapper::Model.raise_on_save_failure = true
-		DataMapper.finalize
-		nil
+		Chawk::Models::Agent.destroy_all
+		Chawk::Models::Relation.destroy_all
+		Chawk::Models::Node.destroy_all
+		Chawk::Models::Point.destroy_all
+		Chawk::Models::Value.destroy_all
 	end
 end

data/lib/chawk/migration.rb

@@ -0,0 +1,92 @@
+## ~~~- Created via -~~~
+
+# ActiveRecord::Base.establish_connection ENV["TEST_DATABASE_URL"]
+# File.open(schema_file, "w") do |file|
+# 	ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+# end
+
+# create_table "chawk_g_users", force: true do |t|
+#   t.string  "google_id",    limit: 120
+#   t.string  "google_email", limit: 120
+#   t.string  "email",        limit: 120
+#   t.string  "handle",       limit: 30
+#   t.string  "name",         limit: 40
+#   t.string  "family_name",  limit: 20
+#   t.text    "image"
+#   t.text    "secret"
+#   t.string  "api_key",      limit: 200
+#   t.integer "reset_token"
+#   t.integer "access_token"
+#   t.integer "agent_id"
+# end
+# add_index "chawk_g_users", ["agent_id"], name: "index_chawk_g_users_agent", using: :btree
+
+#require 'active_record'
+#ActiveRecord::Base.logger = Logger.new(STDOUT)
+#ActiveRecord::Base.establish_connection ENV["TEST_DATABASE_URL"]
+
+ActiveRecord::Migration.verbose = false
+class CreateChawkBase < ActiveRecord::Migration
+	def up
+		create_table "chawk_agents", force: true do |t|
+			t.integer "foreign_id"
+			t.string  "name",       limit: 200
+			t.timestamps
+		end
+
+		create_table "chawk_nodes", force: true do |t|
+			t.string  "key",     		limit: 150
+			t.text  "decription"
+			t.boolean "public_read",              default: false
+			t.boolean "public_write",             default: false
+		end
+
+		create_table "chawk_points", force: true do |t|
+			t.float    "observed_at"
+			t.datetime "recorded_at"
+			t.text     "meta"
+			t.integer  "value"
+			t.integer  "node_id",     null: false
+		end
+
+		add_index "chawk_points", ["node_id"], name: "index_chawk_points_node", using: :btree
+
+		create_table "chawk_values", force: true do |t|
+			t.float    "observed_at"
+			t.datetime "recorded_at"
+			t.text     "meta"
+			t.text     "value"
+			t.integer  "node_id",     null: false
+		end
+
+		add_index "chawk_values", ["node_id"], name: "index_chawk_values_node", using: :btree
+
+		create_table "chawk_relations", force: true do |t|
+			t.boolean "admin",    default: false
+			t.boolean "read",     default: false
+			t.boolean "write",    default: false
+			t.integer "agent_id",                 null: false
+			t.integer "node_id",                  null: false
+		end
+
+		add_index "chawk_relations", ["agent_id"], name: "index_chawk_relations_agent", using: :btree
+		add_index "chawk_relations", ["node_id"], name: "index_chawk_relations_node", using: :btree
+	end
+
+	def down
+		drop_table "chawk_agents"
+		drop_table "chawk_nodes"
+		drop_table "chawk_points"
+		drop_table "chawk_values"
+		drop_table "chawk_relations"
+	end
+
+end
+
+#CreateChawkBase.migrate :down
+CreateChawkBase.migrate :up
+
+File.open('./test/schema.rb', "w") do |file|
+	ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+end
+

data/lib/chawk/version.rb

@@ -1,4 +1,4 @@
 module Chawk
 	# The current version of Chawk
-	VERSION = "0.1.15"
+	VERSION = "0.1.16"
 end

data/lib/models.rb

@@ -1,102 +1,167 @@
-require 'data_mapper'
-require 'dm-aggregates'
+require 'active_record'
 module Chawk
-	# Models used in Chawk.  Most are DataMapper classes.
+	# Models used in Chawk.  ActiveRecord classes.
 	module Models
 
-		# Base stored item, imported into other DataMapper classes.
-		module Datum
-
-			protected
-
-		    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
-
-		# Agent DataMapper classes.
 		# Contains a foreign_id for use as a proxy to another table.
-		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
+		class Agent < ActiveRecord::Base
+			self.table_name_prefix = "chawk_"
+			has_many :tags
+			has_many :agent_tags
+			has_many :relations
 		end
 
-		# Agent Relation DataMapper classes, with permission flags.
-		class Relation
-			include DataMapper::Resource
-			property :id, Serial
-			property :admin, Boolean, default:false
-			property :read, Boolean, default:false
-			property :write, Boolean, default:false
+		# Agent Relation classes, with permission flags.
+		class Relation < ActiveRecord::Base
+			self.table_name_prefix = "chawk_"
 			belongs_to :agent
 			belongs_to :node
 		end
 
-		# Agent Tags.
-		# Not implimented yet.
-		class AgentTag
-			include DataMapper::Resource
-			property :id, Serial
-			property :name, String, length:100
-			property :description, Text
-			property :managed, Boolean, default:false
+		# The Node, where most Chawk:Addr information is persisted..
+		class Node < ActiveRecord::Base
+			attr_accessor :agent
+			after_initialize :init
+			self.table_name_prefix = "chawk_"
 			belongs_to :agent
-		end
+			has_many :points
+			has_many :values
+			has_many :relations			
+
+			def init
+				@agent = nil
+			end
+
+			def _insert_point(val,ts,options={})
+				values = {value:val,observed_at:ts.to_f}
+				values[:meta] = options[:meta] if options[:meta]
+				self.points.create(values)
+			end
+
+			def _insert_point_hash(item,ts,options)
+				if item['v'] && item['v'].is_a?(Integer)
+					if item['t']
+						_insert_point item['v'],item['t'], options
+					else
+						_insert_point item['v'],ts, options
+					end
+				else
+					raise ArgumentError, "Hash must have 'v' key set to proper type.. #{item.inspect}"
+				end
+			end
 
-		# Item Tags.
-		# Not implimented yet.
-		class Tag
-			include DataMapper::Resource
-			property :description, Text
-			property :id, Serial
-			property :name, String, length:100
-		end
+			def _insert_point_array(item,options)
+				if item.length == 2 && item[0].is_a?(Integer)
+					_insert_point item[0],item[1], options
+				else
+					raise ArgumentError, "Array Items must be in [value,timestamp] format. #{item.inspect}"
+				end
+			end
+
+			def point_recognizer(item, dt, options={})
+				case 
+				when item.is_a?(Integer)
+					_insert_point item,dt, options
+				when item.is_a?(Array)
+					_insert_point_array(item, options)
+				when item.is_a?(Hash)
+					_insert_point_hash(item,dt,options)
+				else
+					raise ArgumentError, "Can't recognize format of data item. #{item.inspect}"
+				end
+			end
+
+			# @param args [Object, Array of Objects]
+			# @param options [Hash] You can also pass in :meta and :timestamp 
+			# Add an item or an array of items (one at a time) to the datastore.
+			def add_points(args,options={})
+				options[:observed_at] ? dt = options[:observed_at] : dt = Time.now
+				if args.is_a?(Array)
+					args.each do |arg|
+						point_recognizer(arg, dt, options)
+					end
+				else
+					point_recognizer(args, dt, options)
+				end
+			end
+
+			def increment(value=1, options={})
+				if value.is_a?(Integer)
+					last = self.points.last
+					add_points last.value + value,options 
+				else 
+					raise ArgumentError, "Value must be an Integer"
+				end
+			end
+
+			def decrement(value=1, options={})
+				if value.is_a?(Integer)
+					increment (-1) * value, options
+				else 
+					raise ArgumentError, "Value must be an Integer"
+				end
+			end
+
+			def max()
+				points.maximum('value') || 0
+			end
+
+			def min()
+				points.minimum('value') || 0
+			end
+
+			# Returns items whose observed_at times fit within from a range.
+			# @param dt_from [Time::Time] The start time.
+			# @param dt_to [Time::Time] The end time.
+			# @return [Array of Objects] 
+			def points_range(dt_from, dt_to,options={})
+				vals = points.where("observed_at >= :dt_from AND  observed_at <= :dt_to",{dt_from:dt_from.to_f,dt_to:dt_to.to_f}, limit:1000,order:"observed_at asc, id asc")
+				return vals
+			end
+
+			# Returns items whose observed_at times fit within from a range ending now.
+			# @param dt_from [Time::Time] The start time.
+			# @return [Array of Objects] 
+			def points_since(dt_from)
+				self.points_range(dt_from,Time.now)
+			end
+
+			# Sets public read flag for this address 
+			# @param value [Boolean] true if public reading is allowed, false if it is not.
+			def set_public_read(value)
+				value = value ? true : false
+				self.public_read = value
+				save
+			end
+
+			# Sets permissions flag for this address, for a specific agent.  The existing Chawk::Relationship will be destroyed and 
+			# a new one created as specified.  Write access is not yet checked.
+			# @param agent [Chawk::Agent] the agent to give permission.
+			# @param read [Boolean] true/false can the agent read this address.
+			# @param write [Boolean] true/false can the agent write this address. (Read acces is required to write.)
+			# @param admin [Boolean] does the agent have ownership/adnim rights for this address. (Read and write are granted if admin is as well.)
+			def set_permissions(agent,read=false,write=false,admin=false)
+				relations.where(agent_id:agent.id).destroy_all
+				if read || write || admin
+					vals = {agent:agent,read:(read ? true : false),write:(write ? true : false),admin:(admin ? true : false)}
+					relations.create(vals)
+				end
+				nil
+			end
 
-		# The Node, where most Chawk:Addr information is persisted..
-		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
 
 		# The Node, where most Chawk point information is persisted..
-		class Point
-			include Chawk::Models::Datum
-			property :value, Integer
+		class Point < ActiveRecord::Base
+			self.table_name_prefix = "chawk_"
+			belongs_to :node
 		end
 
 		# The Node, where most Chawk value information is persisted..
-		class Value
-			include Chawk::Models::Datum
-			property :value, Text
+		class Value < ActiveRecord::Base
+			self.table_name_prefix = "chawk_"
+			belongs_to :node
 		end
+
 	end
 end