meshchat 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fca3ee7e9b96b4f3c908452a8431b30439f677af
-  data.tar.gz: c83a3c29a2e306b82ac9eeec85a92012001cf010
+  metadata.gz: 3b78573438d48db0c4e67092319332d045ca76b2
+  data.tar.gz: 07de08af6980a361b232fc659b38863b32c49608
 SHA512:
-  metadata.gz: 18c8c043f8ac60af265de57719d76ff2bf6aea30d6474f9d9a6d6621f6a49768a646b5b2d97c4342b09203e56e98e2bd1129492c86f7bbec39c6da6cb19b3243
-  data.tar.gz: 1213ce77facbfb2263afd1a5b89a3288a2ded7074c05fdb3996e0631d25eaac79fe3b5435ff7d7f4c10d267aab3eec1e2b83364f9fa4985f23fa59013f74dfd7
+  metadata.gz: 2273a362c088cc1eb3898f97d7c8c175d2ab62892093d0030f53fe0ec91f5927e51acf018396344ece8caa05c0c0d49143a5fa95cbf74e28dae65fad11d92c9c
+  data.tar.gz: 3336359fe0a01a70974f0d17b4ffc444303ec88f6d71a3ccd5b1b2f09420805ba16bd8c00244b67f5fde7f647797f521a9a471d29b5cc99b3d1f9f6cb6817bdb

data/README.md

@@ -1,22 +1,50 @@
-#MeshChat (Ruby) [![Build Status](https://travis-ci.org/NullVoxPopuli/meshchat.svg)](https://travis-ci.org/NullVoxPopuli/meshchat) [![Code Climate](https://codeclimate.com/github/NullVoxPopuli/meshchat/badges/gpa.svg)](https://codeclimate.com/github/NullVoxPopuli/meshchat) [![Test Coverage](https://codeclimate.com/github/NullVoxPopuli/meshchat/badges/coverage.svg)](https://codeclimate.com/github/NullVoxPopuli/meshchat/coverage)
+#Meshchat Core [![Build Status](https://travis-ci.org/NullVoxPopuli/meshchat.svg)](https://travis-ci.org/NullVoxPopuli/meshchat) [![Code Climate](https://codeclimate.com/github/NullVoxPopuli/meshchat/badges/gpa.svg)](https://codeclimate.com/github/NullVoxPopuli/meshchat) [![Test Coverage](https://codeclimate.com/github/NullVoxPopuli/meshchat/badges/coverage.svg)](https://codeclimate.com/github/NullVoxPopuli/meshchat/coverage)
 
-This is the core functionality for implementing a [mesh-chat](https://github.com/neuravion/mesh-chat) compatible client in ruby
+This is the core functionality for implementing a [mesh-chat](https://github.com/neuravion/mesh-chat-protocol) compatible client in ruby
+
+[Documentation](http://nullvoxpopuli.github.io/meshchat/)
 
 #Usage
 
-See [Spiced Rumby](https://github.com/NullVoxPopuli/spiced_rumby)
+See [Spiced Rumby](https://github.com/NullVoxPopuli/spiced_rumby) (GUI wrapper around this gem)
 
-In order to use meshchat with your own interface, you only need to pass in your own implementations of `Display::Base` and `CLI::Base`
+In order to use meshchat with your own interface, you only need to pass in your own implementation of `Display::Base`
 
 Optionally, you may pass in a notifier to have the mesh-chat trigger notifications for your system
 
 ```ruby
-MeshChat.start(
-  client_name: NAME, # name of your client
-  client_version: VERSION, # version of your client
-  display: ui, # your class implementing `Display::Base`
-  input: input, # your class implementing `CLI::Base`
-  notifier: notifier, # your class implementing `Notifier::Base`
-  on_display_start: ->{ MeshChat::CLI.check_startup_settings } # optional
+Meshchat.start(
+  # name of your client
+  client_name: Meshchat.name,
+  # version of your client
+  client_version: Meshchat::VERSION,
+  # your class implementing `Meshchat::Ui::Display::Base`
+  display: Meshchat::Ui::Display::Base,
+  # your class implementing `Meshchat::Ui::CLI::Base`
+  input: Meshchat::Ui::CLI::KeyboardLineInput,
+  # (optional) your class implementing `Notifier::Base`
+  # typically, this hooks in to libnotify on *nix
+  notifier: Meshchat::Ui::Notifier::Base,
 )
 ```
+For a lightweight, runnable sample for how to invoke this, see the included `run` script.
+
+# Development
+
+### Running
+
+```bash
+./run
+```
+
+### Tests
+
+```bash
+rspec
+```
+
+### Line Count
+
+```bash
+loco
+```

data/lib/meshchat.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # required standard libs
 require 'openssl'
 require 'socket'
@@ -5,45 +6,38 @@ require 'json'
 require 'date'
 require 'colorize'
 require 'io/console'
-require "readline"
+require 'readline'
 require 'logger'
 
 # required gems
 require 'awesome_print'
 require 'sqlite3'
 require 'active_record'
-require 'curb'
-require 'thin'
+require 'eventmachine'
+require 'i18n'
 
 # active support extensions
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/try'
 
-# local files for meshchat
 require 'meshchat/version'
-require 'meshchat/database'
-require 'meshchat/instance'
-require 'meshchat/encryption'
-require 'meshchat/display'
-require 'meshchat/display/manager'
-require 'meshchat/notifier/base'
-require 'meshchat/models/entry'
-require 'meshchat/config/hash_file'
-require 'meshchat/config/settings'
-require 'meshchat/net/request'
-require 'meshchat/net/client'
-require 'meshchat/net/listener/request'
-require 'meshchat/net/listener/request_processor'
-require 'meshchat/net/listener/server'
-require 'meshchat/cli'
-require 'meshchat/message'
 
-module MeshChat
-  NAME = 'MeshChat'
-  Settings = Config::Settings
-  Node = Models::Entry
-  Cipher = Encryption
+# debug logging....
+# ^ at least util 'all' scenarios are captured via tests
+# TODO: look in to how Active Support does logging
+require 'meshchat/debug'
+
+module Meshchat
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :Encryption
+    autoload :Ui
+    autoload :Node, 'meshchat/models/node'
+    autoload :Network
+    autoload :Configuration
+  end
 
   module_function
 
@@ -51,25 +45,37 @@ module MeshChat
   # @option overrides [Proc] on_display_start what to do upon start of the display manager
   # @option overrides [class] display the display ui to use inherited from Display::Base
   def start(overrides = {})
-    defaults = {
-      display: Display::Base,
-      client_name: NAME,
-      client_version: VERSION,
-      input: CLI::Base,
-      notifier: Notifier::Base
-    }
-    options = defaults.merge(overrides)
+    app_config = Configuration::AppConfig.new(overrides)
+    app_config.validate
 
-    # before doing anything, ensure we have a place to store data
-    Database.setup_storage
+    # if everything is configured correctly, boot the app
+    # this handles all of the asyncronous stuff
+    EventMachine.run do
+      bootstrap_runloop(app_config)
+    end
+  end
 
-    # set up the notifier (if there is one)
-    const_set(:Notify, options[:notifier])
+  def bootstrap_runloop(app_config)
+    # 1. hook up the display / output 'device'
+    #    - responsible for notifications
+    #    - created in Configuration
+    display = Display
 
-    # set the options / overrides!
-    Instance.start(options)
-  end
+    # 2. create the message dispatcher
+    #    - boots the local and relay network connections
+    #    - sends the messages out to the network
+    #    - tries p2p first, than uses the relays
+    message_dispatcher = Network::Dispatcher.new
+
+    # 3. hook up the keyboard / input 'device'
+    #    - tesponsible for parsing input
+    input_receiver = Ui::CLI.new(
+      message_dispatcher,
+      message_dispatcher._message_factory,
+      display)
 
-  def name; Instance.client_name; end
-  def version; Instance.client_version; end
+    # by default the app_config[:input] is
+    # Meshchat::Cli::KeyboardLineInput
+    EM.open_keyboard(app_config[:input], input_receiver)
+  end
 end

data/lib/meshchat/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Meshchat
+  module Configuration
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :Database
+      autoload :HashFile
+      autoload :Settings
+      autoload :Identity
+      autoload :AppConfig
+    end
+  end
+end

data/lib/meshchat/configuration/app_config.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+module Meshchat
+  module Configuration
+    class AppConfig
+      DEFAULTS = {
+        display: Ui::Display::Base,
+        client_name: Meshchat.name,
+        client_version: Meshchat::VERSION,
+        input: Ui::CLI::KeyboardLineInput,
+        notifier: Ui::Notifier::Base
+      }.freeze
+
+      attr_reader :_options
+
+      def initialize(options)
+        @_options = DEFAULTS.merge(options)
+        @_options[:user] = Configuration::Settings.new
+
+        locale_path = 'lib/meshchat/locale/'
+        # I18n.load_path = Dir[locale_path + '*.yml']
+        I18n.backend.store_translations(:en,
+          YAML.load(File.read(locale_path + 'en.yml')))
+
+        Meshchat.const_set(:Notify, options[:notifier])
+
+        # The display has to be created right away so that
+        # we can start outputting to it
+        manager = Ui::Display::Manager.new(options[:display])
+        Meshchat.const_set(:Display, manager)
+        Meshchat.const_set(:APP_CONFIG, self)
+
+        Meshchat::Display.start
+      end
+
+      def validate
+        # Check user config, go through initial setup if we haven't done so already.
+        # This should only need to be done once per user.
+        #
+        # This will also generate a whatever-alias-you-choose.json that the user
+        # can pass around to someone gain access to the network.
+        #
+        # Personal settings are stored in settings.json. This should never be
+        # shared with anyone.
+        Identity.check_or_create
+
+        # setup the storage - for keeping track of nodes on the network
+        Database.setup_storage
+      end
+
+      def [](key)
+        _options[key]
+      end
+
+      def []=(key, value)
+        _options[key] = value
+      end
+
+      def user
+        _options[:user]
+      end
+    end
+  end
+end

data/lib/meshchat/configuration/database.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module Meshchat
+  module Configuration
+    module Database
+      module_function
+
+      # Upon initial startup, instantiated the database
+      # this is used for storing the information of every node
+      # on the network
+      def setup_storage
+        ActiveRecord::Base.establish_connection(
+          adapter: 'sqlite3',
+          database: 'meshchat.sqlite3',
+          pool: 128
+        )
+
+        create_database
+      end
+
+      def create_database
+        ActiveRecord::Migration.suppress_messages do
+          ActiveRecord::Schema.define do
+            unless data_source_exists? :nodes
+              create_table :nodes do |table|
+                table.column :alias_name, :string
+                table.column :uid, :string
+                table.column :public_key, :string
+
+                table.column :location_on_network, :string
+                table.column :location_of_relay, :string
+
+                table.column :on_local_network, :boolean, default: true, null: false
+                table.column :on_relay, :boolean, default: false, null: false
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/meshchat/{config → configuration}/hash_file.rb

@@ -1,12 +1,13 @@
-module MeshChat
-  module Config
+# frozen_string_literal: true
+module Meshchat
+  module Configuration
     class HashFile
       attr_accessor :_hash
 
-      DEFAULT_SETTINGS = {}
+      DEFAULT_SETTINGS = {}.freeze
 
       def initialize
-        self._hash = default_settings
+        self._hash = default_settings.dup
         exists? ? load : save
       end
 
@@ -22,7 +23,7 @@ module MeshChat
         f = read_file
         begin
           self._hash = JSON.parse(f)
-        rescue Exception => e
+        rescue => e
           Display.alert e.message
           self._hash = default_settings
           Display.warning 'writing defaults...'
@@ -64,7 +65,7 @@ module MeshChat
 
       def filename
         return @filename if @filename
-        fail 'filename must be set'
+        raise 'filename must be set'
       end
 
       def default_settings

data/lib/meshchat/configuration/identity.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+module Meshchat
+  module Configuration
+    module Identity
+      module_function
+
+      def check_or_create(overwrite = false, auto_confirm = false)
+        # if setup is complete, we don't need to do anything.
+        # it's likely the user already went through the setup process
+        return if setup_is_completed? && !overwrite
+
+        generate! if auto_confirm || confirm?(I18n.t('identity.settings_not_detected'))
+        # if everything is good, the app can boot
+        return APP_CONFIG.user.save if setup_is_completed?
+
+        # if something has gone wrong, we'll ask if they want to try again
+        return check_or_create(true, true) if confirm? I18n.t('identity.unknown_error_try_again')
+
+        # we failed, and don't want to continue
+        alert_and_exit
+      end
+
+      def alert_and_exit
+        Display.alert I18n.t('identity.settings_are_invalid')
+        exit(1)
+      end
+
+      def setup_is_completed?
+        APP_CONFIG.user.is_complete?
+      end
+
+      def generate!
+        confirm_uid
+        confirm_alias
+        confirm_keys
+        # TODO: port and ip?
+      end
+
+      def confirm_uid
+        if APP_CONFIG.user.uid_exists?
+          APP_CONFIG.user.generate_uid if confirm? I18n.t('identity.confirm_uid_replace')
+        else
+          APP_CONFIG.user.generate_uid
+        end
+      end
+
+      def confirm_alias
+        if APP_CONFIG.user['alias'].present?
+          Display.add_line I18.t('idenity.current_alias', name: APP_CONFIG.user['alias'])
+          ask_for_alias if confirm? I18n.t('identity.confirm_alias_replace')
+        else
+          ask_for_alias
+        end
+      end
+
+      def confirm_keys
+        if APP_CONFIG.user.keys_exist?
+          APP_CONFIG.user.generate_keys if confirm? I18n.t('identity.confirm_key_replace')
+        else
+          APP_CONFIG.user.generate_keys
+        end
+      end
+
+      def ask_for_alias
+        Display.add_line I18n.t('identity.ask_for_alias')
+        response = gets
+        response = response.chomp
+        APP_CONFIG.user['alias'] = response
+      end
+
+      def confirm?(msg)
+        Display.warning msg + I18n.t(:confirm_options)
+        response = gets
+        response = response.chomp
+        [I18n.t(:confirm_yes), I18n.t(:confirm_y)].include?(response.downcase)
+      end
+    end
+  end
+end

data/lib/meshchat/{config → configuration}/settings.rb

@@ -1,31 +1,23 @@
-module MeshChat
-  module Config
+# frozen_string_literal: true
+module Meshchat
+  module Configuration
     class Settings < HashFile
       FILENAME = 'settings.json'
 
       DEFAULT_SETTINGS = {
-        'alias' => 'alias',
-        'port' => '2008',
+        'alias' => '',
+        'port' => '8009',
         'ip' => 'localhost',
-        'uid' => '1',
-        'publickey' => 'replace this'
-      }
-
-      class << self
-        delegate :valid?, :errors,
-          :[], :[]=, :display, :as_hash, :save, :set,
-          :location, :identity, :keys_exist?, :public_key,
-          :private_key, :generate_keys, :share, :key_pair,
-          :uid_exists?, :generate_uid, :debug?, :identity_as_json,
-          to: :instance
-
-        def instance
-          @instance ||= new
-        end
-      end
+        'uid' => '',
+        'publickey' => '',
+        'relays' => [
+          'wss://mesh-relay-in-us-1.herokuapp.com',
+          'wss://mesh-relay-us-2.herokuapp.com'
+        ]
+      }.freeze
 
       def debug?
-        ['true', '1', 'yes', 'y', 't'].include?(self['debug'].try(:downcase))
+        %w(true 1 yes y t).include?(self['debug'].try(:downcase))
       end
 
       def identity_as_json
@@ -41,7 +33,7 @@ module MeshChat
         data = identity_as_json.to_json
 
         filename = "#{identity_as_json['alias']}.json"
-        File.open(filename, 'w'){ |f| f.syswrite(data) }
+        File.open(filename, 'w') { |f| f.syswrite(data) }
         Display.info "#{filename} written..."
       end
 
@@ -101,12 +93,16 @@ module MeshChat
 
       def errors
         messages = []
-        messages << 'must have an alias' if !self['alias']
-        messages << 'must have ip set' if !self['ip']
-        messages << 'must have port set' if !self['port']
-        messages << 'must have uid set' if !self['uid']
+        messages << 'must have an alias' unless self['alias'].present?
+        messages << 'must have ip set' unless self['ip'].present?
+        messages << 'must have port set' unless self['port'].present?
+        messages << 'must have uid set' unless self['uid'].present?
         messages
       end
+
+      def is_complete?
+        valid? && self['privatekey'] && self['publickey']
+      end
     end
   end
 end