buschtelefon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58f0e2bba934f20c2e27a56e2d5109ea3c924834
+  data.tar.gz: f7608312630b99fe86315b002a556fae92f48d3a
+SHA512:
+  metadata.gz: c2347c888c76585598c99413da4e0ceb583cc0d7271c82a7e27a373d5172cc7de1f6b7673f9589389cb888997f25e8d377a046b9a880edecba782a092c024d08
+  data.tar.gz: 8770936ae6a8454e69f6fb5d8a5d908ca1ba6fd8e4ff994034afebc4775ebdfdfc2de4a4faa176233287a606702c13da532b97cdb8899cca48e8cdbbefb27ed6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.8

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in buschtelefon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Josua Schmid
+
+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,64 @@
+# Buschtelefon
+
+With *buschtelefon* you can setup a gossiping meshnet.
+All of it should behave just like human beings tattling at a
+coffee party.
+
+There basically are two features:
+* Nodes make coffee klatsch available between each other automatically.
+* Nodes can be asked about stale information to fight FOMO.
+
+Communication happens via UDP. Autodiscovery of nodes is not
+implemented (yet).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'buschtelefon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install buschtelefon
+
+## Usage
+
+You can setup your tattling meshnet the following way:
+
+```ruby
+include Buschtelefon
+
+aunt_may = NetTattler.new(port: 1337)
+aunt_ruth = RemoteTattler.new(host: 'example.com', port: 1337) 
+aunt_may.connect(aunt_ruth)
+
+aunt_may.feed(Gossip.new('Renuo can do blockchain consulting!'))
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bin/check` 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/renuo/buschtelefon>.
+
+## License
+
+The gem is available as open source under the terms of
+the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:cucumber)
+
+task default: %i[spec cucumber]

data/bin/check

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+bundle exec rake

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'buschtelefon'
+
+# 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(__FILE__)

data/bin/run

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+Thread.abort_on_exception = true
+
+require_relative '../lib/buschtelefon'
+
+include Buschtelefon
+
+# A
+# ↕
+# B ↔ D ↔ E
+# ↓   ↑
+# C → F
+
+tattlers = {
+  A: Tattler.new,
+  B: Tattler.new,
+  C: Tattler.new,
+  D: Tattler.new,
+  E: Tattler.new,
+  F: Tattler.new
+}
+
+tattlers[:A].connect(tattlers[:B])
+tattlers[:B].connect(tattlers[:A])
+
+tattlers[:B].connect(tattlers[:C])
+tattlers[:C].connect(tattlers[:F])
+tattlers[:F].connect(tattlers[:D])
+
+tattlers[:B].connect(tattlers[:D])
+tattlers[:D].connect(tattlers[:B])
+
+tattlers[:D].connect(tattlers[:E])
+tattlers[:E].connect(tattlers[:D])
+
+puts 'Feeding locals'
+tattlers[:A].feed(Gossip.new('Tezos'))
+
+josua = NetTattler.new(port: 9999)
+simon = NetTattler.new(port: 9998)
+remote_simon = RemoteTattler.new(host: 'localhost', port: 9998)
+
+josua.connect(remote_simon)
+
+Thread.new { josua.listen }
+Thread.new { simon.listen }
+
+remote_simon.feed(Gossip.new('Antshare'))
+puts 'gach'

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/buschtelefon.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'buschtelefon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'buschtelefon'
+  spec.version       = Buschtelefon::VERSION
+  spec.authors       = ['Josua Schmid']
+  spec.email         = ['josua.schmid@renuo.ch']
+
+  spec.summary       = %q{Library for meshnet gossip}
+  spec.description   = %q{Buschtelefon can be used to share information in a between Ruby clients over a network}
+  spec.homepage      = 'https://github.com/schmijos/buschtelefon'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'cucumber', '~> 3.0'
+  spec.add_development_dependency 'factory_bot', '~> 4.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+end

data/lib/buschtelefon/brain.rb

@@ -0,0 +1,31 @@
+module Buschtelefon
+  class Brain
+    attr_reader :capacity
+
+    def initialize(capacity = 100)
+      @capacity = capacity
+      @gossip_sink = []
+    end
+
+    def <<(gossip)
+      @gossip_sink << gossip
+      reorganize
+    end
+
+    def contains?(gossip)
+      @gossip_sink.include?(gossip)
+    end
+
+    def to_a
+      @gossip_sink
+    end
+
+    private
+
+    def reorganize
+      @gossip_sink.sort! { |x, y| y.created_at <=> x.created_at }
+      @gossip_sink.uniq!(&:message)
+      @gossip_sink.slice!(capacity..-1) # only keep the newest
+    end
+  end
+end

data/lib/buschtelefon/gossip.rb

@@ -0,0 +1,20 @@
+module Buschtelefon
+  class Gossip
+    attr_reader :created_at, :message
+
+    def initialize(message)
+      @created_at = unix_timestamp_ms
+      @message = message
+    end
+
+    def ==(other)
+      @message == other.message
+    end
+
+    private
+
+    def unix_timestamp_ms
+      (Time.now.to_f * 1000).to_i
+    end
+  end
+end

data/lib/buschtelefon/net_tattler.rb

@@ -0,0 +1,28 @@
+require 'socket'
+require_relative 'tattler'
+
+module Buschtelefon
+  class NetTattler < Tattler
+    def initialize(port: 9999, &interceptor)
+      super()
+      @port = port
+    end
+
+    def listen(&_block)
+      puts "Started UDP server on #{@port}..."
+
+      Socket.udp_server_loop(@port) do |message, message_source|
+        yield(message)
+        handle_incoming_message(message)
+        puts "Got \"#{message}\" from #{message_source}"
+      end
+    end
+
+    private
+
+    def handle_incoming_message(message)
+      feed(Gossip.new(message))
+    end
+  end
+end
+

data/lib/buschtelefon/remote_tattler.rb

@@ -0,0 +1,17 @@
+require 'socket'
+
+module Buschtelefon
+  # No need to inherit from Tattler in Ruby
+  class RemoteTattler
+    def initialize(host:, port:)
+      @host = host
+      @port = port
+      @outbound_socket = UDPSocket.new
+    end
+
+    def feed(gossip)
+      @outbound_socket.send(gossip.message, 0, @host, @port)
+      puts "Sent \"#{gossip.message}\" to #{@host}:#{@port}"
+    end
+  end
+end

data/lib/buschtelefon/tattler.rb

@@ -0,0 +1,23 @@
+module Buschtelefon
+  class Tattler
+    attr_reader :connections
+
+    def initialize
+      @connections = []
+      @brain = Brain.new
+    end
+
+    def connect(tattler)
+      @connections << tattler
+      @connections.uniq!
+    end
+
+    def feed(gossip)
+      old_gossip = @brain.contains?(gossip)
+      @brain << gossip # refresh memory
+      return if old_gossip
+
+      @connections.each { |tattler| tattler.feed(gossip) }
+    end
+  end
+end

data/lib/buschtelefon/version.rb

@@ -0,0 +1,3 @@
+module Buschtelefon
+  VERSION = '0.1.0'
+end

data/lib/buschtelefon.rb

@@ -0,0 +1,9 @@
+require_relative 'buschtelefon/version'
+require_relative 'buschtelefon/brain'
+require_relative 'buschtelefon/gossip'
+require_relative 'buschtelefon/net_tattler'
+require_relative 'buschtelefon/remote_tattler'
+require_relative 'buschtelefon/tattler'
+
+module Buschtelefon
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: buschtelefon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josua Schmid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Buschtelefon can be used to share information in a between Ruby clients
+  over a network
+email:
+- josua.schmid@renuo.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check
+- bin/console
+- bin/run
+- bin/setup
+- buschtelefon.gemspec
+- lib/buschtelefon.rb
+- lib/buschtelefon/brain.rb
+- lib/buschtelefon/gossip.rb
+- lib/buschtelefon/net_tattler.rb
+- lib/buschtelefon/remote_tattler.rb
+- lib/buschtelefon/tattler.rb
+- lib/buschtelefon/version.rb
+homepage: https://github.com/schmijos/buschtelefon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Library for meshnet gossip
+test_files: []