ps_pabx_listener 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1341c8e3a69ebeabad3b3f4c263a94bba9d866da
+  data.tar.gz: ceb997c422563e562f68802572a4fb5a87ea89c7
+SHA512:
+  metadata.gz: b92e9a25b16b0cb0378f02a58905095284653a2a70c01156ae39bfd4143b80b7ae48779acf6560760bb31d1520cd0ebf9d23e6d742a2ed1357905e6d6bdfe651
+  data.tar.gz: 446572ceb032cc5f127cdd26faa6a75af9c345678d02ac492d25a0c07f6baa1a1e21f72e48d8fcbaedad7f8e10a9155b566a9a5626639a819d9b1b7ad0e8cc49

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.pid
+*.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,37 @@
+# PsPabxListener
+A command line utility which connects to a Panasonic PABX via *telnet* and retrieve calling information. It doesn't parse the responses to any popular format. Instead, it just filters valuable content while keeping the original fixed-space format. Parsing to formats such as *csv*, as well as further instructions regarding Panasonic's default format, shall be included in the future. And a list of working devices, off course.
+
+## Tested Devices:
+* Panasonic KX-TDA 200.
+
+## Environment:
+* Ubuntu Linux (trusty or newer);
+* Ruby 2.2.0.
+
+It's possible that the utility works on different environments, but since I haven't tested it on such conditions, I can't promise anything. If you do, please let me know, and I will include both the information and your name as a contributor.
+
+## Install
+Simply,
+
+      gem install ps_pabx_listener
+
+## Using the command line utility
+
+* Listem for useful information for 30 seconds:
+
+      ps_pabx -s <pabx ip address or hostname> -u <username> -p <password>
+
+* Listem for useful information for 10 seconds:
+
+      ps_pabx -s <pabx ip address or hostname> -u <username> -p <password> -t 10
+
+* Listem continuously for data and store it in a given directory:
+
+      ps_pabx -s <pabx ip address or hostname> -u <username> -p <password> -d <store directory>
+
+## What else?
+Developed by Lucas Vieira <lucas@vieira.io>, June 2016.
+
+If you noticed a problem whatsoever, please, let me know.
+
+Also, accepting PRs for better spec tests and anything else, really.

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 "ps_pabx_listener"
+
+# 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/exe/ps_pabx

@@ -0,0 +1,67 @@
+require 'ps_pabx_listener'
+require 'getoptlong'
+
+module PsPabxListener
+  class Robot
+    def initialize
+      @get_time = 30
+      load_options
+      load_arguments
+      @main = PsPabxListener::Main.new(host: @host,
+                              user: @user,
+                              password: @password,
+                              timeout: 1)
+    end
+
+    def run
+      if @daemonize
+        @main.each_data do |data|
+          puts data
+          store_data(data, generate_filename)
+        end
+      else
+        @main.get_data(@get_time) {|data| puts data}
+      end
+    end
+
+    private
+
+    def load_options
+      @args = GetoptLong.new(
+        ['--host', '-s', GetoptLong::REQUIRED_ARGUMENT],
+        ['--user', '-u', GetoptLong::REQUIRED_ARGUMENT],
+        ['--password', '-p', GetoptLong::REQUIRED_ARGUMENT],
+        ['--get-time', '-t', GetoptLong::OPTIONAL_ARGUMENT],
+        ['--daemonize', '-d', GetoptLong::OPTIONAL_ARGUMENT]
+      )
+    end
+
+    def load_arguments
+      @args.each do |opt, arg|
+        case opt
+          when '--host' then @host = arg
+          when '--user' then @user = arg
+          when '--password' then @password = arg
+          when '--get-time' then @get_time = arg.to_i
+          when '--daemonize'
+            @daemonize = true
+            @store_dir = arg
+        end
+      end
+    end
+
+    def store_data data, filename
+      File.open(File.join(@store_dir,filename), 'a') do |f|
+        f.puts data
+      end
+    end
+
+    def generate_filename
+      Time.now.strftime("%Y%m%d") + (Time.now.hour / 12).to_s + ".txt"
+    end
+
+  end
+end
+
+robot = PsPabxListener::Robot.new
+robot.run

data/lib/ps_pabx_listener/listener.rb

@@ -0,0 +1,86 @@
+module PsPabxListener
+  class Listener
+
+    attr_reader :connection, :started
+
+    def initialize(host, user, password, timeout=false)
+      @host, @user, @password, @timeout = host, user, password, timeout
+      validate_attributes
+    end
+
+    def start
+      unless @started
+        @started = true
+        connect_to_pabx
+      end
+    end
+
+    def stop
+      if @started
+        @started = false
+        disconnect_from_pabx
+      end
+    end
+
+    def get
+      if @started
+        if @authenticated
+          get_more_data
+        else
+          authenticate_and_start_getting_data
+        end
+      else
+        raise "No connection."
+      end
+    end
+
+    private
+
+    def validate_attributes
+      raise 'Invalid host' unless @host.is_a? String
+      raise 'Invalid user' unless @user.is_a? String
+      raise 'Invalid password' unless @password.is_a? String
+      raise 'Invalid timeout' unless @timeout.is_a? FalseClass or @timeout.is_a? Numeric
+    end
+
+    def connect_to_pabx
+      @connection = Net::Telnet.new({
+        "Host" => @host,
+        "Port" => 2300,
+        "Prompt" => /(\n|\r)/,
+        "Timeout" => false,
+        "Waittime" => @timeout
+        })
+    end
+
+    def disconnect_from_pabx
+      @connection.close
+      @authenticated = false
+    end
+
+    # authenticate and get a first chunk of data
+    def authenticate_and_start_getting_data
+      response = @connection.waitfor(/(-|Rejected)/)
+      raise "Connection rejected." if response.include? 'Rejected'
+      response += @connection.cmd({
+        "String" => @user,
+        "Match" => /[Pp]ass(?:word|phrase)[:]*\z/n
+        })
+      response += @connection.cmd(@password)
+      @authenticated = true
+      filtered response.split(/\n|\r/)
+    end
+
+    # get more chunks of data
+    def get_more_data
+      response = @connection.waitfor({"Match" => /(\n|\r)/}).split(/(\n|\r)/)
+      filtered response
+    end
+
+    # filter relevant data
+    def filtered raw_data
+      raw_data.map { |line| line if line =~ /\A\d{2}\/\d{2}\/\d{2}/ }.compact
+    end
+
+  end
+end

data/lib/ps_pabx_listener/main.rb

@@ -0,0 +1,49 @@
+module PsPabxListener
+  class Main
+
+    attr_reader :args, :listener
+    attr_accessor :run
+
+    def initialize *args
+      @args = args.first
+      @args[:timeout] ||= false
+      @listener = PsPabxListener::Listener.new(@args[:host],
+                                      @args[:user],
+                                      @args[:password],
+                                      @args[:timeout])
+    end
+
+    # disconnects listener after given timeout is reached
+    def get_data timeout, &block
+      @listener.start
+      start_time = Time.now
+      runner = Thread.new do
+        loop do
+          @listener.get.each {|data| yield data}
+        end
+      end
+      sleep 1 while Time.now - start_time < timeout
+      runner.exit
+      @listener.stop
+    end
+
+    # keeps getting data kind of forever and process the data
+    def each_data &block
+      @listener.start
+      @run = true
+
+      Signal.trap("INT") {@run = false}
+
+      runner = Thread.new do
+        loop do
+          @listener.get.each {|data| yield data}
+        end
+      end
+
+      sleep 1 while(@run)
+      runner.exit
+      @listener.stop
+    end
+
+  end
+end

data/lib/ps_pabx_listener/version.rb

@@ -0,0 +1,3 @@
+module PsPabxListener
+  VERSION = "1.0.0"
+end

data/lib/ps_pabx_listener.rb

@@ -0,0 +1,4 @@
+require "net/telnet"
+require "ps_pabx_listener/version"
+require "ps_pabx_listener/listener"
+require "ps_pabx_listener/main"

data/ps_pabx_listener.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ps_pabx_listener/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ps_pabx_listener"
+  spec.version       = PsPabxListener::VERSION
+  spec.authors       = ["Lucas Vieira"]
+  spec.email         = ["lucas@vieira.io"]
+
+  spec.summary       = %q{Command line utility which connects to a Panasonic PABX via telnet and retrieve calling information.}
+  spec.description   = %q{A command line utility which connects to a Panasonic PABX via *telnet* and retrieve calling information. Filters valuable content while keeping the original fixed-space format.}
+  spec.homepage      = "http://vieira.io"
+
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0"
+  spec.add_development_dependency "factory_girl", "~> 4.7"
+  spec.add_dependency "net-telnet"
+  spec.add_dependency "daemons"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: ps_pabx_listener
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lucas Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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-mocks
+  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_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: net-telnet
+  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: daemons
+  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'
+description: A command line utility which connects to a Panasonic PABX via *telnet*
+  and retrieve calling information. Filters valuable content while keeping the original
+  fixed-space format.
+email:
+- lucas@vieira.io
+executables:
+- ps_pabx
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/ps_pabx
+- lib/ps_pabx_listener.rb
+- lib/ps_pabx_listener/listener.rb
+- lib/ps_pabx_listener/main.rb
+- lib/ps_pabx_listener/version.rb
+- ps_pabx_listener.gemspec
+homepage: http://vieira.io
+licenses: []
+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: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Command line utility which connects to a Panasonic PABX via telnet and retrieve
+  calling information.
+test_files: []