sendxmpp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a0e5fe224abe1427c9c2523e9ad3b0e86422f8d
+  data.tar.gz: 0e22571caec9351c6467c9fdc9435933f3d68755
+SHA512:
+  metadata.gz: 8ca65c1302527956fba6ade6e5b8127b98fb04e0604aac0d2b66cb5d152f1cb9b1b878a4dad2ed7e92d5207582d453a2db38e762d070da783f65a3cc7646dd71
+  data.tar.gz: 50dbad308aaca2a54628e63743d006f9caea03f34e33176312094248dbe96af041bde843fce035da23d378ab573d191be0a638cf23ed431894cbbc49a45c275b

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+local/
+settings.ini
+Makefile

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - ruby-head
+
+notifications:
+  disabled: true
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    sendxmpp (0.0.1)
+      hashr
+      inifile (~> 2.0)
+      thor (~> 0.19, >= 0.19.1)
+      xmpp4r (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    hashr (0.0.22)
+    inifile (2.0.2)
+    rake (10.3.1)
+    thor (0.19.1)
+    xmpp4r (0.5.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 10.1)
+  sendxmpp!

data/bin/sendxmpprb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'sendxmpp'
+Sendxmpp::CLI.start

data/lib/sendxmpp.rb

@@ -0,0 +1,8 @@
+require 'logger'
+module Sendxmpp
+  require 'sendxmpp/version'
+  require 'sendxmpp/config'
+  require 'sendxmpp/log'
+  require 'sendxmpp/message'
+  require 'sendxmpp/cli'
+end

data/lib/sendxmpp/cli.rb

@@ -0,0 +1,120 @@
+require 'thor'
+require 'inifile'
+
+module Sendxmpp
+
+  # Class CLI
+  #
+  # Input via STDIN or -m option:
+  #
+  # Examples
+  #   sendxmpprb -m "server down notification" user mosny@jabber.org
+  #   echo "server down"|sendxmpprb user mosny@jabber.org
+  #   ...
+  #
+  class CLI < Thor
+    include Config
+
+    class_option :server, default: "", type: :string, aliases: "-s", required: false
+    class_option :port, default: 5222, type: :numeric, aliases: "-p", required: false
+    class_option :tls, default: true, type: :boolean, aliases: "-t", required: false
+    class_option :tls_verify_peer, default: true, type: :boolean, required: false
+    class_option :tls_ca, default: "", type: :string, required: false
+    class_option :resource, default: "Sendxmpp", type: :string, required: false
+    class_option :password, default: "", type: :string, required: false
+    class_option :message, default: "", type: :string, aliases: '-m', required: false
+    class_option :jid, default: "", type: :string, required: false
+    class_option :config, default: "#{ENV['HOME']}/.sendxmpprbrc", type: :string, aliases: "-c", required: false
+    class_option :logfile, default: nil, aliases: '-l', required: false
+
+    # Public: logger
+    attr_reader :log
+
+    # Public: Initialize a new Object from CLI
+    #
+    # args - Arguments, passed to Thor
+    #
+    # Raises IniFile::Error on invalid configuration
+    # Raises ArgumentError if the main hash key was not found
+    def initialize(*args)
+      super
+      if File.exists?(options[:config])
+        conf = IniFile.load(options[:config])["sendxmpp"]
+        if conf.nil? || conf.empty?
+          raise ArgumentError, "No [sendxmpp] section in ini file found!"
+        end
+        local_conf = options.dup
+        local_conf.delete_if{|k,v|v.nil?||(v.kind_of?(String) && v.empty?)}
+        conf.merge!(local_conf)
+        update_config(conf)
+      end
+      Log.logger.debug("finished loading configuration.")
+      $stdout.sync = true
+    end
+
+    desc "user [USER1],[USER2],...", "send a message to jabber users"
+    # Public: Send a message to multiple users.
+    #         Message will be sent to each user seperately
+    #
+    # jids - Receipient(s) can be one or more
+    #
+    # Examples
+    #   user(["mosny@jabber.org"])
+    #   user(["mosny@jabber.org", "someone@jabber.org"])
+    #   ...
+    #
+    # Returns 0 or 1 exit codes
+    def user(*jids)
+      Log.logger.debug("Received call for user method")
+      unless jids.kind_of?(Array)
+        Log.logger.error("Throwing ArgumentError because Jids is not an array.")
+        raise ArgumentError, "Jids needs to be an Array got #{jids.class}"
+      end
+
+      if options.message.empty?
+        Log.logger.error("No message to send. Exiting.")
+        Log.logger.error("See https://github.com/nirnanaaa/sendxmpprb/wiki/Sending-messages for available message formats.")
+        exit 1
+      end
+
+      Message.batch do
+        jids.each do |jid|
+          Message.message_to_user(jid)
+        end
+      end
+    end
+
+    desc "chat [CHAT1],[CHAT2],...", "send a message to multiple multi user chats"
+    # Public: Send a message to a single/multiple multi user chatrooms.
+    #         Messages will be sent to each chat seperately
+    #
+    # jids - Array of MUC(Multi user chat) jids.
+    #
+    # Examples
+    #   chat(["edv@conference.jabber.org"])
+    #   chat(["edv@conference.jabber.org", "staff@conference.jabber.org"])
+    #
+    # Returns 0 or 1 exit codes
+    def chat(*jids)
+      Log.logger.debug("Received call for chat method")
+      unless jids.kind_of?(Array)
+        Log.logger.error("Throwing ArgumentError because Jids is not an array.")
+        raise ArgumentError, "Jids needs to be an Array got #{jids.class}"
+      end
+
+      if options.message.empty?
+        Log.logger.error("No message to send. Exiting.")
+        Log.logger.error("See https://github.com/nirnanaaa/sendxmpprb/wiki/Sending-messages for available message formats.")
+        exit 1
+      end
+
+      Message.batch do
+        jids.each do |jid|
+          Message.message_to_room(jid)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/sendxmpp/config.rb

@@ -0,0 +1,49 @@
+require 'hashr'
+module Sendxmpp
+
+  # Private: This class provides access to the main configuration
+  #
+  # Should not be used without Config module
+  class InternalConfiguration < Hashr
+
+    # Public: Static singleton
+    #
+    # Gets a singleton object
+    def self.config
+      @conf ||= self.new
+    end
+
+    # Public: Merge new configuration
+    #
+    # Use Config.update_config instead!
+    #
+    # Returns nothing
+    def self.merge_config(newconfig)
+      @conf = self.new(newconfig)
+    end
+  end
+
+  # Public: Configuration module. Should be included
+  #
+  # Usage
+  #   include Config
+  #
+  #   def some_method
+  #     config.configbla
+  #   end
+  module Config
+
+    # Public: Gets the configuration from InternalConfiguration
+    #
+    # Returns a singleton object of InternalConfiguration
+    def config
+      InternalConfiguration.config
+    end
+
+    # Public: Updates the configuration of InternalConfiguration
+    #
+    def update_config(new)
+      InternalConfiguration.merge_config(new)
+    end
+  end
+end

data/lib/sendxmpp/log.rb

@@ -0,0 +1,20 @@
+require 'logger'
+module Sendxmpp
+  class Log < Logger
+    include Config
+    attr_accessor :logger_ins
+
+    def self.logger
+      @logger ||= self.new
+    end
+
+    def initialize
+      if config.logfile
+        super(config.logfile)
+      else
+        super(STDOUT)
+      end
+      self.level = config.loglevel.to_i || 2
+    end
+  end
+end

data/lib/sendxmpp/message.rb

@@ -0,0 +1,172 @@
+require 'xmpp4r/client'
+module Sendxmpp
+
+  # Public: Message class
+  #
+  # requires an initialized Config class.
+  #
+  class Message
+    include Config
+    include ::Jabber
+
+    # Public: Getter for the batch status
+    attr_reader :batch
+
+    # Public: Getter / Setter for the jabber client
+    attr_accessor :client
+
+    # Public: Getter for receipients
+    #
+    # Returns an Array
+    def receipients
+      @receipients ||= []
+    end
+
+    # Public: Initializer
+    #
+    #
+    def initialize
+      @batch=false
+      if config.jid.nil? || config.jid.empty?
+        raise ArgumentError, <<-RAISE
+        \rJID is not configured. Please use the configuration file or specify the
+        \r-j option.
+        RAISE
+      end
+
+      jid = JID.new(config.jid)
+      Log.logger.debug("Initializing a new Jabber client instance.")
+      self.client = Client.new(jid)
+      Log.logger.debug("Initialized a new Jabber client instance.")
+
+      Log.logger.debug("Connecting to Jabber server.")
+      client.connect(config.server, config.port)
+      Log.logger.debug("Connected to Jabber server.")
+
+      Log.logger.debug("Authenticating with Jabber server.")
+      client.auth(config.password)
+      Log.logger.debug("Authenticating with Jabber server.")
+    end
+
+    # Public: Singleton object getter
+    def self.myself
+      @self ||= self.new
+    end
+
+    # Public: Batch relay
+    def self.batch(&block)
+      myself.process_batch(&block)
+    end
+
+    # Public: Send a message to a user
+    #
+    # user - Receipient
+    #
+    def self.message_to_user(user)
+      myself.message(type: :user, user: user)
+    end
+
+    # Public: Send a message to a chatroom
+    #
+    # room - Room to send message to
+    #
+    def self.message_to_room(room)
+      myself.message(type: :group, user: room)
+    end
+
+    # Public: Split a special formatted JID into the following
+    #         parts:
+    #         JID - normal XMPP JID
+    #         Password - XMPP room password
+    #
+    # user - JID to split up
+    #
+    # Returns an Array of 2 elements
+    def split_password(user)
+      user.split(":")
+    end
+
+    # Public: Send a message
+    #
+    # options - Message hash options
+    #
+    # Examples
+    #   message(type: :user, user: "jid@server.com")
+    #   message(type: :group, user: "jid@conference.server.com:password")
+    #
+    def message(options)
+      return if config.message.empty?
+      if batch == true
+        receipients << options
+      else
+        if options[:type] == :user
+          send_message(config.message, options[:user])
+        else
+          group, password = split_password(options[:user])
+          send_muc_message(config.message, group, password)
+        end
+      end
+    end
+
+    # Public: Enables batch procession for this session
+    #
+    # block - Block to execute as a batch
+    #
+    # Returns false
+    def process_batch(&block)
+      Log.logger.info("Batch procession started.")
+      unless block_given?
+        raise ArgumentError, "Do not use this function without a block"
+      end
+      @batch=true
+      yield
+      send_batch
+      @batch=false
+    end
+
+    # Public: Send a message to a single user
+    #
+    # user - JID of the receipient
+    #
+    # Returns nothing
+    def send_message(user)
+      Log.logger.debug("sending message to user %s" % user)
+      m = Jabber::Message.new(user, config.message)
+      client.send(m)
+      Log.logger.debug("sent message")
+    end
+
+    # Public: Send a message to a MUC (Multi User Chat)
+    #
+    # room - Room to send the message to
+    # password - Password for the chatroom if required
+    #
+    # Returns nothing
+    def send_muc_message(room, password=nil)
+      Log.logger.debug("including file xmpp4r/muc")
+      require 'xmpp4r/muc'
+      m = Jabber::Message.new(room, config.message)
+      muc = MUC::MUCClient.new(client)
+      if !muc.active?
+        Log.logger.info("Joining room %s" % room)
+        muc.join(JID.new(room + '/' + config.resource), password)
+        Log.logger.info("Joined room %s" % room)
+      end
+      muc.send m
+    end
+
+    # Public: Send the batch out
+    def send_batch
+      receipients.flatten.each do |rcpt|
+        user, password = split_password(rcpt[:user])
+        if rcpt[:type] == :user
+          send_message(user)
+        elsif rcpt[:type] == :group
+          send_muc_message(user, password)
+        end
+        Log.logger.debug("Removing item %p from queue" % rcpt)
+        receipients.delete(rcpt)
+      end
+    end
+  end
+end

data/lib/sendxmpp/version.rb

@@ -0,0 +1,5 @@
+  module Sendxmpp
+
+    # Public: version number
+    VERSION="0.0.1"
+  end

data/sendxmpp.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sendxmpp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sendxmpp"
+  s.version     = Sendxmpp::VERSION
+  s.authors     = ["Florian Kasper"]
+  s.email       = ["florian.kasper@corscience.de"]
+  s.homepage    = "http://git.er.corscience.de"
+  s.summary     = %q{Send messages from the console to a XMPP server}
+  s.description = %q{Send messages from the console to a XMPP server}
+
+  s.rubyforge_project = "sendxmpp"
+  s.license = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+
+  s.add_runtime_dependency "thor", "~> 0.19", '>= 0.19.1'
+  s.add_runtime_dependency "inifile", "~> 2.0"
+  s.add_runtime_dependency "xmpp4r", "~> 0.5"
+  s.add_dependency "hashr"
+
+  s.add_development_dependency "rake", "~> 10.1"
+end

data/settings.ini.sample

@@ -0,0 +1,42 @@
+[sendxmpp]
+
+# The JID of the sending user
+# Default: ""
+jid=bla@jabberdomain.example.com
+
+# The Password of the sending user
+# Default: ""
+# password=
+
+# The Resource to send messages from
+# Default: Sendxmpp
+# resource=YODA
+
+# Use TLS
+# Default: true
+# tls=true
+
+# Port of the Jabber Server
+# Default: 5222
+# port=5222
+
+# Server to send messages over. If no server is provided DNS SRV record from jid will be used
+# Default: ""
+# server=jabber.org
+
+# Verify TLS identity.
+# Default: true
+# tls_verify_peer=true
+
+# Logfile to log in to
+# Default: STDOUT
+# logfile = "/var/log/sendxmpp.log"
+
+# Loglevel
+# VALUES:
+#   err   - 3
+#   warn  - 2
+#   info  - 1
+#   debug - 0
+# Default: 2
+loglevel = 2

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: sendxmpp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Florian Kasper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: xmpp4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: hashr
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: Send messages from the console to a XMPP server
+email:
+- florian.kasper@corscience.de
+executables:
+- sendxmpprb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- TODO.md
+- bin/sendxmpprb
+- lib/sendxmpp.rb
+- lib/sendxmpp/cli.rb
+- lib/sendxmpp/config.rb
+- lib/sendxmpp/log.rb
+- lib/sendxmpp/message.rb
+- lib/sendxmpp/version.rb
+- sendxmpp.gemspec
+- settings.ini.sample
+homepage: http://git.er.corscience.de
+licenses:
+- MIT
+metadata: {}
+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: sendxmpp
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Send messages from the console to a XMPP server
+test_files: []