serialbar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00293fd411b0ce3c80444a09c28fa28795c017fd
+  data.tar.gz: b8f93a2ea2cb6501426436f846630a867541bc24
+SHA512:
+  metadata.gz: a4304f21fad39ea00df12213924c91286dcf3151820df1cd1acf568cd279b5440e000b4258c56bb980073a22715ed368a03f81415ec4e5e4a0271db2c041d6cd
+  data.tar.gz: a000a0095d0738b287562fad4bc7ce0f57ce5c38593db4357569854f4feb61f84fd94f2f693de0fea36441b9e2a2ff891bd86086f5c089e0d3b93b29385e7b2d

data/.gitignore

@@ -0,0 +1,9 @@
+*~
+serialbox.sublime-project
+serialbox.sublime-workspace
+mongoid.yml
+spec/mongoid.yml
+doc
+dummy
+*.gem
+.yardoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gemspec
+
+#ruby '2.1.1'
+
+#gem 'serialport'
+#gem 'mongoid'
+#gem 'json'
+#gem 'awesome_print'

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    serialbar (0.0.1)
+      serialport (~> 1.3, >= 1.3.0)
+      thor (~> 0.19, >= 0.19.1)
+      timers (~> 3.0, >= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.18)
+      activesupport (= 3.2.18)
+      builder (~> 3.0.0)
+    activesupport (3.2.18)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    diff-lcs (1.2.5)
+    hitimes (1.2.1)
+    i18n (0.6.9)
+    mongoid (3.1.6)
+      activemodel (~> 3.2)
+      moped (~> 1.4)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.29)
+    moped (1.5.2)
+    multi_json (1.10.1)
+    origin (1.1.0)
+    rake (0.9.6)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    serialport (1.3.0)
+    thor (0.19.1)
+    timers (3.0.0)
+      hitimes
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mongoid (~> 3.1, >= 3.1.6)
+  rake (~> 0)
+  rspec (~> 3.0, >= 3.0.0)
+  serialbar!

data/README.rdoc

@@ -0,0 +1,42 @@
+= \Serialbox
+
+* http://github.com/jonbramble/serialbar
+
+== DESCRIPTION: 
+
+# Work in progress, not ready for use
+
+Serialbar acts as an intermediary between serial port data and database based storage
+
+This was part of a project to save data from scientific instruments in a mongodb database but was made to be extendable
+
+== FEATURES:
+
+Generators are available to create a bearbones program
+
+You still need to know the instrument response and how to parse the serialport data and pass that to data objects
+
+== TODO:
+
+A server component will be added in the future for quick data visualisation
+More adapters need to be written and will be based on Active Model 
+Configuration file for projects
+
+== SYNOPSIS
+
+	#todo
+
+== INSTALL
+
+* gem install serialbar  (not available just yet)
+
+
+== LICENSE:
+
+Copyright (C) 2014 Jonathan Bramble
+
+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,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/bin/serialbar

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'serialbar/cli'
+
+Serialbar::CLI.start

data/lib/serialbar/adapter.rb

@@ -0,0 +1,36 @@
+module Serialbar
+ module Adapter
+  module InstanceMethods
+  end
+
+  	module ClassMethods
+
+  		def foo
+    	end
+
+    	def configure_adapter(type,classname="DataFile")
+    		base = const_get classname
+			  load_adapter(base,type)
+		end
+
+		def load_adapter(base,type)
+			# load module based on type
+			case type
+				when :mongoid
+          require 'serialbar/adapters/mongoid'
+          mod = Mongoid::Document
+        when :filesystem	
+          require 'serialbar/adapters/file_system'	
+			end
+  			base.send :include, mod	
+  		end
+
+  	end 	
+
+  	def self.included(base)
+    	base.extend(ClassMethods)
+    	base.send :include, InstanceMethods   	
+  	end
+
+ end
+end

data/lib/serialbar/adapters/file_system.rb

@@ -0,0 +1,9 @@
+puts "filesystem adapter"
+
+module Serialbox
+  module Adapters
+   module FileSystem
+    
+   end
+  end
+end

data/lib/serialbar/adapters/mongoid.rb

@@ -0,0 +1,14 @@
+begin
+  require 'mongoid' unless defined?(::Mongoid)
+rescue LoadError
+  puts "Mongoid is not installed. Please, do '$gem install mongoid', or add mongoid to your Gemfile"
+end
+
+#sets up the mongoid connection
+Mongoid.load!("mongoid.yml", :production)	# will need to be able to configure this from the main file
+
+module Serialbox
+  module Adapters
+    
+  end
+end

data/lib/serialbar/cli.rb

@@ -0,0 +1,89 @@
+require 'thor'
+require 'serialbar/generators/boiler_plate'
+
+module Serialbar
+
+	class CLI < Thor
+		include Thor::Actions
+
+		default_task :usage
+
+		def self.source_root
+    		File.dirname(__FILE__)
+  		end
+
+  		desc "list_adapters", "list the currently available adapters"
+  		def list_adapters
+  			say "Currently available adapters"
+  			say "\tmongoid"
+  		end
+
+  		option :adapter, aliases: "-d", desc: "set the adapter type", required: true	
+		desc "new NAME", "create a new serialbar project"
+  		def new(name)
+    			say "creating a new serialbar project #{name}", :green 
+    			readme(name) # create readme file in project dir
+
+    			case options[:adapter]
+    				when "mongoid"
+    					say 'Using mongoid adapter', :green
+    					insert_mongoid(name)
+    					insert_data_file(name,"mongoid")
+    				else 
+    					say 'Adapter type unknown', :red
+    					#invoke(:list_adapters,"")
+    			end
+
+    			insert_listener(name)
+  		end
+
+  		desc "help", "serialbar help"
+  		def usage
+  			puts <<-DES
+Usage: Serialbox help [command]
+
+Description:  A simple app to create a database or file based storage adapter for serial port data
+
+  			DES
+  			help
+  		end
+
+
+  		no_commands do
+ 			def readme(name)
+  				#create readme file and insert the contents
+  				#str = "text to read"
+  				#copy_file "generators/README", "#{name}/README"
+  				#insert_into_file "#{name}/README", str
+  			end
+
+  			def insert_mongoid(name)
+  				copy_file "generators/mongoid_example.yml", "#{name}/mongoid_example.yml"
+  				#append specific instructions to readme
+  			end
+
+  			def insert_data_file(name,adapter)
+  				create_file "#{name}/data_file.rb" do
+  					Serialbar::BoilerPlate.data_file_class
+				end
+
+				str = Serialbar::BoilerPlate.config_adapter_string(adapter)
+				insert_into_file "#{name}/data_file.rb", str , :after => "include Serialbox::Adapters\n"
+
+  			end
+
+  			def insert_listener(name)
+  				create_file "#{name}/listener.rb" do
+  					Serialbar::BoilerPlate.listener_class
+				end
+  			end
+
+  			#when developed
+  			def insert_file_system
+  				#append instructions to readme
+  			end
+  		end
+
+
+  	end
+end

data/lib/serialbar/exceptions.rb

@@ -0,0 +1,7 @@
+module Serialbar
+	module Exceptions
+		class NoParseMethodError < NoMethodError; end
+		class PortNotInitialized < StandardError; end
+	# can we put our customised messages in here?
+	end
+end

data/lib/serialbar/generators/README

@@ -0,0 +1 @@
+Serialbox project 

data/lib/serialbar/generators/boiler_plate.rb

@@ -0,0 +1,37 @@
+module Serialbox
+ module BoilerPlate
+
+  def self.listener_class
+    "require 'serialbox'\n"+
+    "require_relative 'data_file'\n\n"+
+  	"class Listener\n"+
+  	"\tinclude Serialbox::Listener\n"+
+  	"\tdef parse(string)\n"+
+  	"\t#TODO: implement your parser here\n"+
+  	"\tend\n"+
+  	"end\n"+
+  	"\n\n"+
+    "ln = Listener.new\n"+
+	"ln.setup(serialport params)\n"+
+	"ln.run\n"
+  end
+
+  def self.data_file_class
+  	"class DataFile\n"+
+  	"\tinclude Serialbox::Adapter\n"+
+  	"\tstore_in session: 'default'\n"+
+  	"\t#TODO: add your data variables here\n"+
+  	"\t#field :time\n"+
+  	"\t#field :experiment\n"+
+  	"end\n\n"+
+  	"#Subclass DataFile for specific data points"
+  	"class DataPoint < DataFile\n"+
+  	"\t#field :temp\n"+
+  	"end"
+  end
+
+  def self.config_adapter_string(adapter)
+  	"\tconfigure_adapter :#{adapter.to_sym}\n"
+  end
+ end
+end

data/lib/serialbar/generators/mongoid_example.yml

@@ -0,0 +1,24 @@
+#mongoid v3.~
+production: 
+  sessions:
+    default:
+      # URI allows for easy replica-set connection setup. 
+      # Use environment variables or a config file to keep your credentials safe.
+      database: name
+      username: user
+      password: password
+      hosts:
+        - localhost:27017
+      options: 
+        # Default consistency is :eventual, which reads from secondary first. Strong forces reads to primary.
+        # You should use strong consistency if you need the freshest data available.
+        consistency: :strong
+        # max_retries specifies the number of times your driver will attempt an operation before giving up.
+        max_retries: 30
+        # retry_interval specifies the number of seconds to wait before retrying a single operation.
+        retry_interval: 1
+        # timeout is the time in seconds for the driver to wait for an operation.
+        # A value of 30 allows for plenty of time for DNS slowness/network blips. 
+        # Note that if you have a long-running query (over 30 seconds), it will timeout.
+        # Use Queryable#no_timeout for long queries: http://mongoid.org/en/origin/docs/options.html.
+        timeout: 1 

data/lib/serialbar/generators/test.rb

@@ -0,0 +1 @@
+test text

data/lib/serialbar/helpers.rb

@@ -0,0 +1,7 @@
+module Serialbar
+	module Helpers
+		def time
+			return Time.now
+		end
+	end
+end

data/lib/serialbar/listener.rb

@@ -0,0 +1,124 @@
+require 'serialport'
+require 'timers'
+
+module Serialbar
+	module Listener
+
+		# Setup the serial port
+		def setup(port, baud=9600, data_bits=8, stop_bits=1, parity=1)
+			@portname = port
+			@sp = SerialPort.new(@portname,baud,data_bits,stop_bits,parity)
+			@setup = true
+		end
+
+		# Direct access to the serialport serial port object
+		def serial_port
+			return @sp if port_initialized?
+		end
+
+		# Trigger listening on setup serial port
+		# 
+		# simply reads each line from the port and passes it as string to implemented parse method
+		def run
+			#is the serial port setup?
+			puts "Listening on serial port #{@portname}"
+			if port_initialized?
+				@sp.flush_input
+    			begin 
+ 				while data = @sp.readline
+ 					parse(data)
+ 				end
+ 	  			rescue Interrupt
+  					puts "Exiting"	
+  				end
+  			end
+		end
+
+		# Poll device by sending string 
+		#
+		# ==== Attributes
+		#
+		# * +send+ - string to send to the serial port
+		# * +lines+ - number of lines to read back
+		#
+		# ==== Examples
+		# 
+		# 		data = listener.poll("#001\\n")
+		# 
+		# read lines not implemented yet
+		def poll(send,lines=1)
+			if port_initialized?
+				begin
+					@sp.write(send)
+					data = @sp.readline
+				rescue Interrupt
+  					puts "Exiting"	
+  				end
+  				parse(data)
+  			end
+		end
+
+		# Poll device with a timer
+		# could use clever missing_method stuff here
+		#
+		# data is passed as an argument to parse
+		#
+		# ==== Attributes
+		#
+		# * +send+ - string to send to the serial port
+		# * +lines+ - number of lines to read back
+		# * +n+ - number of seconds between each poll of the device
+		#
+		def poll_every_n_seconds(send,lines=1,n=1)
+			timer = Timers.new
+			every_seconds = timer.every(n) { parse(poll(send,lines)) }
+			loop { timers.wait } 
+		end
+	
+		# Poll device with a timer
+		# could use clever missing_method stuff here
+		# 
+		# data is passed as an argument to parse
+		#
+		# ==== Attributes
+		#
+		# * +send+ - string to send to the serial port
+		# * +lines+ - number of lines to read back
+		# * +n+ - number of minutes between each poll of the device
+		#
+		def poll_every_n_minutes(send,lines=1,n=1)
+			timer = Timers.new
+			every_seconds = timer.every(60*n) { parse(poll(send,lines)) }
+			loop { timers.wait } 
+		end
+
+		# Using method missing to check for the inclusion of the subclass implementation of parse
+		# 
+		def method_missing(id, *args) #:nodoc:
+			if id.to_s.eql?("parse")    		
+				raise Serialbar::Exceptions::NoParseMethodError, "Parse method not implemented"     
+			else
+				raise NoMethodError
+			end
+ 		end
+
+ 		def listener? #:nodoc: Testing method for class inclusion
+			return true  #testing method
+		end
+
+		def parse_missing? #:nodoc: Testing method for presence of parse
+			parse("test string")
+		end
+
+		def port_initialized?
+			if @sp.nil?
+				raise Serialbar::Exceptions::PortNotInitialized, "Call setup on listener class to initialize serial port"     
+			else
+				return true
+			end
+
+		end
+
+end
+
+end

data/lib/serialbar/scratch.rb

@@ -0,0 +1,41 @@
+ # module DataPoint
+    #extend Mongoid::Document
+
+  	
+
+  #  module ClassMethods
+
+		
+ #   end
+	
+ #   module InstanceMethods
+      
+		
+ #   end
+
+ #  def self.included(receiver)
+ #    receiver.extend         ClassMethods
+ #    receiver.send :include, InstanceMethods
+ #  end
+
+ # end
+
+
+      	  c_name = "#{adapter_name.to_s.capitalize}"
+	  doc = Serialbox::Adapters.const_get(c_name).constants 
+	  adpstr = c_name+"::"+doc[0].to_s
+	  @adapter = adpstr.constantize
+
+
+  #module DataPoint
+
+     #def adapter
+
+     #end
+     # include Mongoid::Document  # what if we want alternative configurable data end points
+
+     # what other attributes might the general datapoint have
+     # unique id is included with mongoid
+     # field :time
+
+  #end

data/lib/serialbar/version.rb

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

data/lib/serialbar.rb

@@ -0,0 +1,6 @@
+require 'serialbar/version'
+require 'serialbar/exceptions'
+require 'serialbar/cli'
+require 'serialbar/listener'
+require 'serialbar/helpers'
+require 'serialbar/adapter'

data/serialbar.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serialbar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serialbar"
+  spec.version       = Serialbar::VERSION
+  spec.date          = '2014-06-20'
+  spec.summary       = "An adapter gem between incomming serial port data and storage"
+  spec.description   = "Parse and save incoming data to storage, default mongodb"
+  spec.authors       = ["Jonathan Bramble"]
+  spec.email         = ["jbramble82@hotmail.com"]
+  spec.homepage      = 'https://github.com/jonbramble/serialbar/'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+  spec.add_development_dependency "mongoid", "~> 3.1", '>= 3.1.6'
+
+  spec.add_runtime_dependency "serialport", '~> 1.3', '>= 1.3.0'
+  spec.add_runtime_dependency "thor", '~> 0.19', '>= 0.19.1'
+  spec.add_runtime_dependency "timers", '~> 3.0', '>= 3.0.0'
+end

data/serialbar.sublime-project

@@ -0,0 +1,9 @@
+{
+	"folders":
+	[
+		{
+			"follow_symlinks": true,
+			"path": "."
+		}
+	]
+}