elastix 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmY3ZWE4YzIzZjcwZTk3OGUzOTczYzM3NmQ2NGIwYjYwYzkzOTNjMg==
+  data.tar.gz: !binary |-
+    OWZmMjIyOTZiODkyNTMyNWI4NjI1NjRmN2JjMzAzNzBlYWMwNDBkNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDgzMTgyOTQ4ODA4NjdkNzJmODZlNjQ5MzMzZDExMzViYjdjODc4OTUwYzFh
+    N2UyNTNlYmNjMDQ5YmY3NzZmYjQ2NjY3OTViZDg0ZGNhNDZiM2NmOTVlZTcy
+    ODBmMjU2Nzg1MTkzMjI3OGVhZWM0NDllM2QzYjlkN2U4NDdjOGU=
+  data.tar.gz: !binary |-
+    YzU2ZTUxMGU2MWQ1ZTc4NzgyNjVjNTcxNDZlMjE4NjM4ZDNjNzM1MDA2MWI2
+    ZDVlZjMzZjJiYzhjMDRhOGEyNzVhNjhhNGE5YmQ5YjQ4MmMyYTI5N2RhNzQ0
+    ZmEwZDZhNDFjNDlhMzhlMzdkMTkyYTg4ZTEzZGE4ZjEyZWY2YTk=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elastix.gemspec
+gemspec
+gem 'rspec'
+gem "factory_girl", "~> 4.0"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Hahn
+
+MIT License
+
+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,51 @@
+# Elastix
+
+This rubygem is an integration of the Elastix Call Center Module. So far it only includes functionality for managing extensions. It was built on top of ruby mechanize and for some reason I was having issues with symbols in the hashes so in the meantime you must use strings in the hashes passed into these methods. I apologize if this is inconvenient.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'elastix'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elastix
+
+## Usage
+
+This gem models the Active Record implementation. If you are familiar with Active Record
+this gem should come pretty easy to you. For instance:
+
+    options = {
+        "extension" => "4555", "sipname" => "3333",
+        "outboundcid" => "3333333333", "name" => "David Hahn", "devinfo_secret" => "secret"
+      }
+    Elastix::Base.establish_connection "192.168.1.253", "user", "password"
+    ext = Elastix::Extension.new options
+    ext.save
+    e = Elastix::Extension.find options["extension"]
+    e.destroy
+    Elastix::Base.close_connection
+
+Here is a list of methods that have been implemented:
+  * create
+  * save
+  * find
+  * destroy
+  * all
+  * ==
+  * to\_hash
+  * update\_attributes
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/elastix.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elastix/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elastix"
+  spec.version       = Elastix::VERSION
+  spec.authors       = ["David Hahn"]
+  spec.email         = ["dhahn@ctatechs.com"]
+  spec.description   = %q{ A wrapper of the Elastix Call Center Module that deals primarily with extension management.}
+  spec.summary       = %q{ Elastix is a gem that simplifies the process of creating, removing and changing extensions in the elastix web interface.}
+  spec.homepage      = "https://github.com/CTA/elastix"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'mechanize', '~> 2.7' 
+end

data/lib/elastix.rb

@@ -0,0 +1,7 @@
+require "elastix/version"
+require "elastix/base"
+require "elastix/extension"
+
+module Elastix
+  # Your code goes here...
+end

data/lib/elastix/base.rb

@@ -0,0 +1,25 @@
+require 'mechanize'
+module Elastix
+  attr_accessor :elastix
+  class Base
+    def self.establish_connection( ip, username, password)
+      $elastix = Mechanize.new
+      $elastix.agent.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      $base_address = "https://#{ip}"
+      $elastix.get($base_address) 
+      login_form = $elastix.page.forms[0]
+      login_form.input_user = username
+      login_form.input_pass = password
+      $elastix.submit(login_form,login_form.button_with("submit_login"))
+    end
+
+    def self.close_connection
+      $base_address = nil
+      $elastix = nil
+    end
+
+    def self.reload
+      $elastix.get("#{$base_address}/config.php?handler=reload")
+    end
+  end
+end

data/lib/elastix/extension.rb

@@ -0,0 +1,117 @@
+module Elastix
+  class Extension
+    attr_accessor :extension, :name, :sipname, :outboundcid, :devinfo_secret
+
+    def initialize(params)
+      params.each_pair{|key,value| instance_variable_set "@#{key}", value}
+    end
+    
+    def destroy
+      $elastix.get("#{$base_address}/config.php?type=setup&display=extensions&extdisplay=#{self.extension}&action=del")
+      Base.reload
+    end
+    
+    def save
+      raise "Extension already exists" if Extension.exist? self.extension
+      Extension.new_extension_object(self.to_hash)
+      Base.reload
+    end
+    
+    def self.create(params)
+      e = Extension.new(params)
+      e.save
+      e
+    end
+
+    def self.all
+      #TODO abstract this method
+      page = $elastix.get("#{$base_address}/index.php?menu=pbxconfig")
+      extensions = []
+      page.links.each do |link|
+        extensions << Extension.find(get_extension_from_link_text(link.text)) if href_is_acceptable? link.href
+      end
+      extensions
+    end
+
+    def update_attributes!(params)
+      params[:extension] = self.extension
+      Extension.update_extension_object(params)
+      Base.reload
+    end
+
+    def self.find(extension)
+     get_extension_object(extension) if exist?(extension)
+    end
+
+    def ==(extension)
+      self.to_hash == extension.to_hash
+    end
+    
+    def to_hash
+      Hash[self.instance_variables.map{|var| [var.to_s.delete("@"), self.instance_variable_get(var)]}]
+      #my_hash.symbolize_keys
+    end
+    
+    private
+      def self.get_extension_object(extension)
+        Extension.new(get_extension_attributes(get_extension_display_page(extension).forms.first))
+      end
+      
+      def self.update_extension_object(params)
+        page = get_extension_display_page(params[:extension])
+        update_and_submit_form(page, params)
+      end
+
+      def self.new_extension_object(params)
+        page = get_extension_display_page(params[:extension])
+        #This is necessary for new objects. It would be nice to figure out why.
+        page.encoding = "utf-8"
+        form = page.form("frm_extensions")
+        page = form.submit(form.button_with("Submit"))
+        update_and_submit_form(page, params)
+      end
+
+      def self.update_and_submit_form(page, params)
+        form = page.form("frm_extensions")
+        form.encoding = "utf-8"
+        params.each{|key,value| form[key.to_s] = value unless value.nil?}
+        $elastix.submit(form, form.button_with("Submit"))
+      end
+
+      def self.get_extension_display_page(extension)
+        $elastix.get "#{$base_address}/config.php?type=setup&display=extensions&extdisplay=#{extension}"
+      end
+
+      def self.get_extension_attributes(form)
+        Hash[form.fields.map{|field| [field.name, field.value] if is_a_class_attribute(field.name) and not field.value.empty?}]
+      end
+
+      def self.is_a_class_attribute attr
+        Extension.instance_methods.grep(/\w=$/).include? "#{attr}=".to_sym
+      end
+
+      def self.exist? extension
+        if $elastix.get("#{$base_address}/index.php?menu=pbxconfig")
+          .body.match(/#{extension}/) then true else false end
+      end
+
+      def self.href_is_acceptable?(href)
+        href.include? "config.php?type=setup&display=extensions&extdisplay=" unless href.nil?
+      end
+
+      def self.get_extension_from_link_text(link_text)
+        link_text.scan(/<(.*)>/).first.first
+      end
+  end
+end
+
+class Hash
+  #TODO figure out why symbols break the code. For now everything has to be in strings.
+  def symbolize_keys
+    self.keys.each do |key|
+      self[(key.to_sym rescue key) || key] = self.delete(key)
+    end
+    self
+  end
+end
+

data/lib/elastix/version.rb

@@ -0,0 +1,3 @@
+module Elastix
+  VERSION = "0.0.3"
+end

data/spec/base_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Base do
+  describe ".establish_connection" do
+    before { Base.establish_connection $auth_options[:ip], $auth_options[:username], $auth_options[:password] }
+    it "should assign an address to $base_address" do
+      $base_address.should eq "https://192.168.1.237"
+    end
+
+    it "should assign a mechanize agent to $elastix" do
+      $elastix.class.should eq Mechanize
+    end
+
+    it "should log into the webform" do
+      $elastix.page.title.should eq "Elastix"
+    end
+  end
+  
+  describe ".close_connection" do
+    before{ Base.close_connection }
+    it "should assign $base_address to nil" do
+      $base_address.should be_nil
+    end
+
+    it "should assign $elastix to nil" do
+      $elastix.should be_nil
+    end
+  end
+
+  pending "it should apply the configuration changes"
+end

data/spec/extension_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Extension do
+  let(:params) {
+      {
+        "extension" => "4555", "sipname" => "3333",
+        "outboundcid" => "3333333333", "name" => "David Hahn", "devinfo_secret" => "secret"
+      }
+  }
+
+  before { Base.establish_connection $auth_options[:ip], $auth_options[:username], $auth_options[:password] }
+  after(:all){ Base.close_connection }
+  after(:each) do
+    Extension.new(params).destroy if Extension.find(params["extension"])
+  end
+
+  describe ".initialize" do
+    it "should assign all params to their attribute equivalents" do
+      e = Extension.new(params)
+      params.each_pair {|key,value| e.send(key).should eq value}
+    end
+  end
+  
+  describe ".create" do
+    it "should create an extension" do
+      e = Extension.create(params) 
+      Extension.find(params["extension"]).to_hash.should eq e.to_hash
+    end
+
+    it "should return an Extension object" do
+      Extension.create(params).class.should eq Elastix::Extension
+    end
+  end
+  
+  describe ".save" do
+    it "should create an extension" do
+      e = Extension.new(params)
+      e.save
+      Extension.find(params["extension"]).should_not be_nil
+    end
+
+    it "should raise error if extension already exists" do
+      Extension.create(params)
+      Extension.new(params)
+      expect{Extension.save(params)}.to raise_error
+    end
+  end
+  
+  describe ".find" do
+    it "should return nil if extension doesn't exist" do
+      Extension.find("-9999999").should be_nil
+    end
+
+    it "should return the extension object if extension does exist" do
+      e = Extension.new(params)
+      e.save
+      Extension.find(params["extension"]).to_hash.should eq e.to_hash
+    end
+  end
+  
+  describe ".destroy" do
+    it "should remove the extension from the interface" do
+      e = Extension.create(params)
+      e.destroy
+      Extension.find(params["extension"]).should be_nil
+    end
+  end
+  
+  describe ".all" do
+    it "should return all extensions" do
+      e = Extension.create(params)
+      Extension.all.should include e
+    end
+  end
+
+  describe ".==" do
+    it "should return true if method contain the same attributes" do
+      e = Extension.new(params)
+      e2 = Extension.new(params)
+      (e == e2).should be_true
+    end
+
+    it "should return true if method contain the same attributes" do
+      e = Extension.new(params)
+      e2 = Extension.new({"extension" => "333333"})
+      (e == e2).should be_false
+    end
+  end
+  
+  describe ".to_hash" do
+    it "should output the attributes of an extension to a hash" do
+      e = Extension.create(params)
+      e.to_hash.should eq params
+    end
+  end
+
+  describe ".update_attributes" do
+    it "should only update the attributes that are input" do
+      e = Extension.create(params)
+      e.update_attributes!("sipname" => "testing")
+      new_ext = Extension.find(e.extension)
+      e.to_hash.should eq new_ext.to_hash
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+#gem
+require 'elastix'
+include Elastix
+
+$auth_options = {
+  ip: "ipaddress", username: "username", password: "password"
+}

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: elastix
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- David Hahn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: ! ' A wrapper of the Elastix Call Center Module that deals primarily
+  with extension management.'
+email:
+- dhahn@ctatechs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- elastix.gemspec
+- lib/elastix.rb
+- lib/elastix/base.rb
+- lib/elastix/extension.rb
+- lib/elastix/version.rb
+- spec/base_spec.rb
+- spec/extension_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CTA/elastix
+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: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Elastix is a gem that simplifies the process of creating, removing and changing
+  extensions in the elastix web interface.
+test_files:
+- spec/base_spec.rb
+- spec/extension_spec.rb
+- spec/spec_helper.rb