del 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e16364d1ebe1f3488a79c52b5c6b02a56d67280c76b75c4f22edf17b84b007cd
-  data.tar.gz: 814184969ee5e5eb6506da65922354a840fc377f71cd02b132a160b7d308e83e
+  metadata.gz: 00ed0cb25e7f6f172d5eec3b782825e2c94c1c0923027e34283cd12dfd092d74
+  data.tar.gz: e11839f4721601d972425ba8dae2a7cacd6ec896c7c804505ff37f1c99703afd
 SHA512:
-  metadata.gz: 9f83cd17cabc1de409cf471b4158a58a661fc06216e51ff5263cc4606fb0db3a314adc998576d1bcc2731c88535f1aec03a87c0dbf156908bdca5c2cce11dc07
-  data.tar.gz: 03a42d1386bafd92c9e945ed547c5fd41115c1ffee2c7180447ca4f5c43ca6462fce4f96cd3d52df95a175bbdc95c081902326b4519b3ef531db92f4f1578893
+  metadata.gz: faa133b35a808632dd1b122765ea40d1e416446fdf2ac69bb344ca8143a17c14e8f3bf9814390aea1017aae8a02bfc6a7c6fe88f62e0884f086418b1d0d7121b
+  data.tar.gz: 3dce21f46839881060e79546e75c91837160b4e1b9f8c63440357b397db57aeb07fc532b0ed6bbb1892859171f5133bc7cfba859623a21006542065360528d7b

data/.gitlab-ci.yml

@@ -0,0 +1,11 @@
+image: ruby:2.5
+
+before_script:
+  - apt-get update && apt-get install -y locales
+  - echo "en_US.UTF-8 UTF-8" > /etc/locale.gen
+  - locale-gen
+  - export LC_ALL=en_US.UTF-8
+
+ci:
+  script:
+    - bin/cibuild

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  Exclude:
+    - 'coverage/**/*'
+    - 'pkg/**/*'
+    - 'spec/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.5
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHeredoc:
+  EnforcedStyle: active_support
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'Rakefile'
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
   - 2.5.1
-before_install: gem install bundler -v 1.16.1
+before_install: gem install bundler
+script:
+  - bin/cibuild

data/Gemfile

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

data/README.md

@@ -24,6 +24,14 @@ Run the setup command.
 
     $ del setup
 
+By default all configuration is stored in a yaml file in your $HOME
+directory named `.delrc`. E.g. `~/.delrc`
+
+The setup will ask you for your XMPP password. If you are uncomfortable
+storing your password in the `.delrc` you may skip that prompt. If you
+choose not to store your password in `.delrc` then Del will prompt you
+for your password each time you interact with Del.
+
 Start the chat server:
 
     $ del server
@@ -36,20 +44,46 @@ Start the server with a remote file:
 
     $ del server https://gist.githubusercontent.com/mokhan/15882e15908273f7880eaeaa336d12d9/raw/a54db41e7824315b63b3e4e88df5c2f74ce27e30/routes.rb
 
-Once the server is started, you may use the client to send messages
-through it.
+Once the server is started, you may use the client to issue different commands:
+
+Send a message to another user:
 
     $ del message 1_79@chat.btf.hipchat.com "Hello, World!"
 
-See the help for additional information:
+Change your status:
+
+    $ del status busy "I am on a WebEx call"
+
+Print your profile information:
+
+    $ del whoami
+
+Print the profile information of another user:
+
+    $ del whois <jid>
+
+Print all users:
+
+    $ del users
+
+Interact with Del using a REPL:
+
+    $ del console
+    irb(main):001:0> Del.bot.busy!("I am really, really busy!")
+    irb(main):002:0> Del.bot.online!
+
+See help for additional information:
 
     $ del help
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bin/cibuild` to run the tests and linters.
+
+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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,13 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'bundler/audit/task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+Bundler::Audit::Task.new
 
-task :default => :spec
+task default: :spec
+task lint: [:rubocop, 'bundle:audit']

data/bin/cibuild

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# script/cibuild: Setup environment for CI to run tests. This is primarily
+#                 designed to run on the continuous integration server.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+echo [$(date "+%H:%M:%S")] "==> Started at…"
+
+# GC customizations
+export RUBY_GC_MALLOC_LIMIT=79000000
+export RUBY_GC_HEAP_INIT_SLOTS=800000
+export RUBY_HEAP_FREE_MIN=100000
+export RUBY_HEAP_SLOTS_INCREMENT=400000
+export RUBY_HEAP_SLOTS_GROWTH_FACTOR=1
+
+ruby -v
+gem install bundler --no-ri --no-rdoc --conservative
+bin/test
+bin/lint

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "del"
+require 'bundler/setup'
+require 'del'
 
 # 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.
@@ -10,9 +11,9 @@ require "del"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 
-settings = YAML.load(IO.read(Pathname.new(Dir.home).join(".delrc")))
-settings.merge!(start_server: false)
+settings = YAML.safe_load(IO.read(Pathname.new(Dir.home).join('.delrc')))
+settings[:start_server] = false
 Del.start(settings)
 IRB.start(__FILE__)

data/bin/lint

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+
+echo [$(date "+%H:%M:%S")] "==> Running linters…"
+bundle exec rake lint

data/bin/publish

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+
+bin/cibuild
+bundle exec rake release

data/bin/test

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+# script/test: Run test suite for application. Optionally pass in a path to an
+#              individual test file to run a single test.
+
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+[ -z "$DEBUG" ] || set -x
+
+echo [$(date "+%H:%M:%S")] "==> Running setup…"
+bin/setup
+
+echo [$(date "+%H:%M:%S")] "==> Running tests…"
+bundle exec rake spec

data/del.gemspec

@@ -1,29 +1,36 @@
 
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "del/version"
+require 'del/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "del"
+  spec.name          = 'del'
   spec.version       = Del::VERSION
-  spec.authors       = ["mo"]
-  spec.email         = ["mo@mokhan.ca"]
+  spec.authors       = ['mo']
+  spec.email         = ['mo@mokhan.ca']
 
-  spec.summary       = %q{Del is a funky robosapien.}
-  spec.description   = %q{Del is a funky robosapien.}
-  spec.homepage      = "https://www.mokhan.ca"
-  spec.license       = "MIT"
+  spec.summary       = 'Del is a funky robosapien.'
+  spec.description   = 'Del is a funky robosapien.'
+  spec.homepage      = 'https://www.mokhan.ca'
+  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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.add_dependency "xmpp4r", "~> 0.5"
-  spec.add_dependency "thor", "~> 0.20"
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'bundler-audit', '~> 0.6'
+  spec.add_dependency 'net-hippie', '~> 0.1'
+  spec.add_dependency 'rubocop', '~> 0.55'
+  spec.add_dependency 'thor', '~> 0.20'
+  spec.add_dependency 'xmpp4r', '~> 0.5'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 end

data/exe/del

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "del/cli"
+require 'del/cli'
 
 Del::CLI.start(ARGV)

data/lib/del.rb

@@ -1,25 +1,34 @@
-require "json"
-require "logger"
-require "open3"
-require "socket"
-require "xmpp4r"
-require "xmpp4r/muc/helper/mucbrowser"
-require "xmpp4r/muc/helper/simplemucclient"
-require "xmpp4r/roster/helper/roster"
-require "yaml"
+# frozen_string_literal: true
 
-require "del/configuration"
-require "del/connection"
-require "del/default_router"
-require "del/message"
-require "del/repository"
-require "del/robot"
-require "del/socket_connection"
-require "del/socket_server"
-require "del/source"
-require "del/user"
-require "del/version"
+require 'json'
+require 'logger'
+require 'net/hippie'
+require 'open3'
+require 'socket'
+require 'tempfile'
+require 'xmpp4r'
+require 'xmpp4r/muc/helper/mucbrowser'
+require 'xmpp4r/muc/helper/simplemucclient'
+require 'xmpp4r/roster/helper/roster'
+require 'yaml'
 
+require 'del/configuration'
+require 'del/default_router'
+require 'del/message'
+require 'del/repository'
+require 'del/robot'
+require 'del/send_message'
+require 'del/shell_command'
+require 'del/socket_connection'
+require 'del/socket_message'
+require 'del/socket_server'
+require 'del/source'
+require 'del/tron'
+require 'del/user'
+require 'del/version'
+require 'del/xmpp_connection'
+
+# Del the funky robosapien.
 module Del
   def self.start(settings)
     @configuration = Configuration.new(settings)

data/lib/del/cli.rb

@@ -1,77 +1,121 @@
-require "del"
-require "pathname"
-require "thor"
+# frozen_string_literal: true
+
+require 'del'
+require 'pathname'
+require 'thor'
 
 module Del
   class CLI < Thor
-    DEFAULT_RC=Pathname.new(Dir.home).join(".delrc")
-    class_option :configuration_file, default: ENV.fetch("DELRC", DEFAULT_RC)
+    DEFAULT_RC = Pathname.new(Dir.home).join('.delrc')
+    class_option :configuration_file, default: ENV.fetch('DELRC', DEFAULT_RC)
     class_option :socket_file, default: Del::Configuration::SOCKET_FILE
-    class_option :log_level, default: ENV.fetch("LOG_LEVEL", Logger::INFO).to_i
+    class_option :log_level, default: ENV.fetch('LOG_LEVEL', Logger::INFO).to_i
 
-    desc "server <routes.rb>", "start server"
+    desc 'server <routes.rb>', 'start server'
     def server(startup_file = nil)
-      settings = YAML.load(IO.read(options[:configuration_file]))
-      settings.merge!(log_level: options[:log_level])
-      settings.merge!(socket_file: options[:socket_file])
-      settings.merge!(start_server: true)
-      settings.merge!(startup_file: startup_file)
-
-      Del.start(settings)
+      Del.start(load_settings(start_server: true, startup_file: startup_file))
     rescue Errno::ENOENT => error
       say error.message, :red
       say "run 'del setup'", :yellow
     end
 
-    desc "console <config.rb>", "start read-eval-print-loop"
+    desc 'console <config.rb>', 'start read-eval-print-loop'
     def console(startup_file = nil)
-      require "irb"
+      require 'irb'
 
-      settings = YAML.load(IO.read(options[:configuration_file]))
-      settings.merge!(log_level: options[:log_level])
-      settings.merge!(socket_file: options[:socket_file])
-      settings.merge!(start_server: false)
-      settings.merge!(startup_file: startup_file)
-
-      Del.start(settings)
+      Del.start(load_settings(start_server: false, startup_file: startup_file))
       ARGV.clear
       IRB.start
+    rescue Errno::ENOENT => error
+      say error.message, :red
+      say "run 'del setup'", :yellow
     end
 
-    desc "message <jid> <message>", "send a message to the Jabber ID"
+    desc 'message <jid> <message>', 'send a message to the Jabber ID'
     def message(jid, message)
-      socket = UNIXSocket.new(options[:socket_file])
-      socket.puts(JSON.generate(command: :send_message, jid: jid, message: message))
-      say socket.readline, :green
-    rescue EOFError => error
-      say error.message, :red
-    rescue Errno::ECONNREFUSED => error
-      say error.message, :red
-      say "You must start the del server first.", :yellow
+      SendMessage.new(
+        self,
+        socket_file: options[:socket_file]
+      ).run(jid, message)
+    end
+
+    desc 'status <status> <message>', 'status to online, away, or busy'
+    def status(status, message = nil)
+      socket = SocketMessage.new(self, socket_file: options[:socket_file])
+      socket.deliver(command: :change_status, status: status, message: message)
+      say(socket.listen, :green)
     ensure
-      socket&.close
+      socket.close
     end
 
-    desc "setup", "setup your $HOME/.delrc"
-    def setup
-      settings = {
-        host: ask("Where is your xmpp server? (E.g. 'chat.hipchat.com')"),
-        jid: ask("What is your jabber Id?"),
-        muc_domain: ask("What is your MUC domain? (E.g. 'conf.hipchat.com')"),
-        full_name: ask("What is your name?"),
-        password: ask("What is your password?", echo: false),
-      }
+    desc 'whoami', 'send a whoami message to the local del server'
+    def whoami
+      socket = SocketMessage.new(self, socket_file: options[:socket_file])
+      socket.deliver(command: :whoami)
+      say(socket.listen, :green)
+    ensure
+      socket.close
+    end
 
-      say ""
-      say "Writing your configuration to: #{options[:configuration_file]}", :green
-      yaml = YAML.dump(settings)
+    desc 'whois <jid>', 'whois a specific user'
+    def whois(jid)
+      socket = SocketMessage.new(self, socket_file: options[:socket_file])
+      socket.deliver(command: :whois, q: jid)
+      say(socket.listen, :green)
+    ensure
+      socket.close
+    end
+
+    desc 'users', 'list all users'
+    def users
+      socket = SocketMessage.new(self, socket_file: options[:socket_file])
+      socket.deliver(command: :users)
+      say(socket.listen, :green)
+    ensure
+      socket.close
+    end
+
+    desc 'setup', 'setup your $HOME/.delrc'
+    def setup
+      yaml = YAML.dump(new_settings)
       IO.write(options[:configuration_file], yaml)
-      File.chmod(0600, options[:configuration_file])
+      File.chmod(0o600, options[:configuration_file])
+      say ''
+      say "Configuration saved to: #{options[:configuration_file]}", :green
     end
 
-    desc "version", "Print the version of this gem"
+    desc 'version', 'Print the version of this gem'
     def version
       say Del::VERSION, :green
     end
+
+    private
+
+    def new_settings
+      {
+        'host' => ask("XMPP server: (E.g. 'chat.hipchat.com')"),
+        'jid' => ask('Jabber Id:'),
+        'muc_domain' => ask("MUC domain: (E.g. 'conf.hipchat.com')"),
+        'full_name' => ask('Name:'),
+        'password' => ask('Password:', echo: false)
+      }
+    end
+
+    def load_settings(additional_settings)
+      settings = YAML.safe_load(
+        IO.read(options[:configuration_file]),
+        symbolize_names: true
+      )
+      if blank?(settings[:password])
+        settings[:password] = ask('Password:', echo: false)
+      end
+      settings[:log_level] = options[:log_level]
+      settings[:socket_file] = options[:socket_file]
+      settings.merge(additional_settings)
+    end
+
+    def blank?(string)
+      string.nil? || string.length.zero?
+    end
   end
 end