jenga 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5cccb7a63c6e4aa010829aad4f62559aaa11eac
+  data.tar.gz: 5be313bdfc42a7dfe893fb854def9c7c79aa9cdf
+SHA512:
+  metadata.gz: 4820d415da486e94f0ff38b072267c506c85abd3486868fa03840fe83c5065c554ff2ff9dffb428108460e96c7c01dacb3e5fbb90d6e6c092e7a5537406b4ae4
+  data.tar.gz: 87611883975f89c3fde0024cb4502c0c268bbe789005d024e65ff604ddc6ad695816736d77b978cda9172881bb7968bed00df2d114543dda05e1ac8998ef7aa1

data/.gitignore

@@ -0,0 +1,2 @@
+.ruby-*
+.idea/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    jenga (0.1.0)
+      bson_ext
+      mongo (~> 2.1)
+      redis
+      serialport (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bson (3.2.6)
+    bson_ext (1.5.1)
+    diff-lcs (1.2.5)
+    mongo (2.1.2)
+      bson (~> 3.0)
+    rake (10.5.0)
+    redis (3.3.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    serialport (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  jenga!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-expectations
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ricardo Carrasco Cursach
+
+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_gem.md

@@ -0,0 +1,36 @@
+# Jenga
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jenga`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jenga'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jenga
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jenga.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jenga"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jenga.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jenga/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jenga"
+  spec.version       = Jenga::VERSION
+  spec.authors       = ["Ricardo Carrasco Cursach"]
+  spec.email         = ["rccursach@gmail.com"]
+  spec.licenses      = ['MIT']
+  spec.summary       = "Jenga is a tool for building applications based on XBee radio devices and the internet"
+  spec.description   = "Useful for receiving data from small WSNs based on XBee/ZigBee devices and enable them to access the internet"
+  spec.homepage      = "https://github.com/rccursach/jenga"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "serialport", "~> 1.3"
+  spec.add_runtime_dependency "mongo", "~> 2.1"
+  spec.add_runtime_dependency "bson_ext"
+  spec.add_runtime_dependency "redis"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-expectations"
+end

data/lib/jenga.rb

@@ -0,0 +1,12 @@
+require "jenga/version"
+require "jenga/front"
+
+# need to require the rest of the gang through a config file
+# but only the ones that are required to do the job
+# as specified in the config file
+#
+# but.. where is that config file anyways??
+
+module Jenga
+  @front = SamFront::Front.new [1,2,3]
+end

data/lib/jenga/base.rb

@@ -0,0 +1,36 @@
+
+module SamFront
+
+  class Base
+    @forward = false
+    @name    = nil
+    @next    = nil
+
+    def initialize
+      @name = self.class.to_s
+    end
+
+    def forward _next
+      @next = _next
+      @forward = true
+    end
+
+    def set_config conf
+      raise "Not a valid conf for #{@name}" unless conf.is_a? Hash
+    end
+
+    def task data
+    end
+
+    def run_task data
+      data = task(data)
+      #@next.run_task(data) if @forward
+      if @forward
+        puts "Running next: #{@next.class.to_s}"
+        @next.run_task(data)
+      end
+    end
+
+  end
+
+end

data/lib/jenga/boostraper.rb

@@ -0,0 +1,64 @@
+
+##
+# Load components
+# see http://stackoverflow.com/questions/1849699
+# TODO: decide between load or require!!
+Dir["#{File.dirname(__FILE__)}/components/**/*.rb"].each { |f| load(f) }
+
+module SamFront
+  
+  class Boostraper
+    
+    @hash = nil
+    @first = nil
+
+    def initialize arr
+      @hash = arr
+      not_a_hash if not arr.is_a? Array
+    end
+
+    def get_first
+      set_chain
+    end
+
+    private 
+
+    def self.not_a_hash
+      msg = "Boostraper received #{@hash.class}, expected Hash"
+      raise msg
+    end
+
+    ##
+    # check:
+    # http://stackoverflow.com/questions/5924495
+    def set_chain
+      components = []
+      #load each component
+      @hash.each do |c|       
+        # Get component class
+        clazz = nil
+        if c[:class].include? "::"
+          clazz = c[:class].split('::').inject(Object) {|o,c| o.const_get c}
+        else
+          clazz = Object.const_get(c[:class])
+        end
+
+        # Instantiate components
+        comp = clazz.new
+        comp.set_config c[:config]
+
+        # Add component to list
+        components << comp
+      end
+
+      # Set chain sequence
+      last = components.length - 1
+      components.each_with_index do |c, idx|
+        c.forward components[idx+1] unless idx == last
+      end
+      # return the first on the chain
+      return components.first
+    end
+
+  end
+end

data/lib/jenga/components/component_one.rb

@@ -0,0 +1,13 @@
+require 'jenga/base'
+
+module SamFront
+  class ComponentOne < Base
+
+    def task data
+      data += 1
+      puts "#{@name}: Data is now #{data}"
+      return data
+    end
+
+  end
+end

data/lib/jenga/components/component_three.rb

@@ -0,0 +1,13 @@
+require 'jenga/base'
+
+module SamFront
+  class ComponentThree < Base
+
+    def task data
+      data = "Number #{data}"
+      puts "#{@name}: Data is now #{data}"
+      return data
+    end
+
+  end
+end

data/lib/jenga/components/component_two.rb

@@ -0,0 +1,13 @@
+require 'jenga/base'
+
+module SamFront
+  class ComponentTwo < Base
+
+    def task data
+      data = data.to_s
+      puts "#{@name}: Data is now #{data}"
+      return data
+    end
+
+  end
+end

data/lib/jenga/front.rb

@@ -0,0 +1,20 @@
+require 'jenga/boostraper'
+
+module SamFront
+
+  class Front
+
+    def initialize env
+      hash = [
+        { class: 'SamFront::ComponentOne', config: {} },
+        { class: 'SamFront::ComponentTwo', config: {} },
+        { class: 'SamFront::ComponentThree', config: {} }
+      ]
+      b = SamFront::Boostraper.new(hash)
+      entry_point = b.get_first
+      entry_point.run_task 1
+    end
+
+  end
+
+end

data/lib/jenga/parsers/parse_kv_text.rb

@@ -0,0 +1,20 @@
+require 'jenga/parsers/parser'
+
+module SamFront
+  module Parsers
+
+    class Parse_kv_text < SamFront::Parsers::Parser
+
+      def initialize
+        super
+        puts 'parser of key:values loaded!'
+      end
+
+      def call env
+        return env
+      end
+
+    end
+
+  end
+end

data/lib/jenga/parsers/parser.rb

@@ -0,0 +1,17 @@
+module SamFront
+  module Parsers
+
+    class Parser
+
+      def initialize
+        puts 'Parser child initialized:'
+      end
+
+      def call env
+        return env
+      end
+
+    end
+
+  end
+end

data/lib/jenga/serial_adapters/serial.rb

@@ -0,0 +1,30 @@
+module SamFront
+  module SerialAdapters
+
+    class Serial
+
+      @observer
+
+      def initialize
+        # heat the serial engines, then go for a run.
+        # but first tell someone to watch this race!
+        # hint: with #observe_me
+      end
+
+
+      def run
+        # just silly stuff
+        sleep 8
+        observer.notify "msg:this is text;should:be parsed;"
+      end
+
+      ##
+      # Registers an observer who will be notified
+      # everytime we will have data to send
+      def observe_me observer
+        @observer = observer
+      end
+    end
+
+  end
+end

data/lib/jenga/serial_adapters/serial_gets.rb

@@ -0,0 +1,19 @@
+require 'jenga/serial_adapters/serial'
+
+module SamFront
+  module SerialAdapters
+
+    class SerialGetS < SamFront::SerialAdapters::Serial
+
+      def initialize
+        super
+      end
+
+      def run
+        # need to inject a block here or something??
+        super.run
+      end
+
+    end
+  end
+end

data/lib/jenga/version.rb

@@ -0,0 +1,3 @@
+module Jenga
+  VERSION = "0.1.0"
+end

data/readme.md

@@ -0,0 +1,51 @@
+
+-- This project is currently a draft --
+# Jenga
+
+Copyright (c) 2016 Ricardo Carrasco Cursach.
+Under MIT Licence, See [LICENCE](https://github.com/rccursach/sam_serial_front/blob/master/LICENSE)
+
+## Jenga is a tool for building applications based on XBee radio devices 
+
+### Its use is intended for receiving data from small WSNs based on XBee/ZigBee devices and enable them to access the internet
+
+(It's kind of a "rack" for serial)
+
+The following Asumptions/Escenarios will be taken in care:
+
+As from source:
+
+* Serial data comes in form of "Packages"
+* Packages can come from:
+  * Raw serial as bytes
+  * Strings from serial as lines
+  * XBee/ZigBee plain text from datagram's body/payload
+  * XBee/ZigBee binary data from datagram's payload
+
+As for format:
+
+* Package might contain key:value pairs array
+* Package might contain an only values array
+  * as text delimited by token
+  * as binary string to be decoded
+* Only-values packages needs a parser
+* Package can be an array of packages, we call it a Stream
+
+As for other middleware:
+
+* More middleware components can be added, some examples could be:
+  * Database storage
+  * Pub/Sub services
+  * Caching data
+  * logging
+  * Validate/Discard Packages
+* Middleware components should not block:
+  * For example: Storage should be preceded by caching/queuing in some way.
+
+As for configuration:
+
+* An instance will need to know what kind of source will be received.
+  * Also will need to know serial configuration data as port, speed, etc. (This behaviour will be inherited from its abstract parent interface)
+* An instance will need to know the number, names and order of filters for package format
+* An instance will need to know the number, names and order of other middleware components
+* An instance will need a list of components to be injected as dependencies

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: jenga
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ricardo Carrasco Cursach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Useful for receiving data from small WSNs based on XBee/ZigBee devices
+  and enable them to access the internet
+email:
+- rccursach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README_gem.md
+- Rakefile
+- bin/console
+- bin/setup
+- jenga.gemspec
+- lib/jenga.rb
+- lib/jenga/base.rb
+- lib/jenga/boostraper.rb
+- lib/jenga/components/component_one.rb
+- lib/jenga/components/component_three.rb
+- lib/jenga/components/component_two.rb
+- lib/jenga/front.rb
+- lib/jenga/parsers/parse_kv_text.rb
+- lib/jenga/parsers/parser.rb
+- lib/jenga/serial_adapters/serial.rb
+- lib/jenga/serial_adapters/serial_gets.rb
+- lib/jenga/version.rb
+- readme.md
+homepage: https://github.com/rccursach/jenga
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: Jenga is a tool for building applications based on XBee radio devices and
+  the internet
+test_files: []