asterisk-ajam 0.0.2 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YmM4MjA4Yjc2MjQ2ODMyOTcwMDc5ODRmYzVlM2VjMDI5MTQwYjkzMw==
-  data.tar.gz: !binary |-
-    ODE4NWMyNTVmZWM0ODk0Yjg1MTY4ZjI2YjY1N2I5OGE5MDAzZWE5ZQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YjRmYjY2ODMwMzFmNDNkYTA1MjBmYjk0M2E2NTg1MzBmOGViZDRjYmVjMDYz
-    NWZlMmFiMzk5OTNmZWMyZDJiYmQwNTlmZjFjOWRhNDdiM2QyOTA2NTIxY2Qw
-    NjY0NWMyYTQzOGI5YzJlZWJkNjdiZDQxNzAwMzgwMTViNzdjMGE=
-  data.tar.gz: !binary |-
-    NmE3ZDUyNGU3NjdhYTI1NDY0OGFlYmI1OGY5ZWJhNjM5ZjhhZTM5ZmU1Y2Y0
-    YWRkYzcyZmMxMTczYTM0YzRkOTA2Zjc3MmEwYmEwZWUwYTA3ZDgyZGZmNjk2
-    MTRkZTk5YjRiZGE0Y2RmNjA4YzMxYTRmMGE3N2NhMzlhNjczNzM=
+SHA256:
+  metadata.gz: 6c38257b070aaeea398c8645c0335c23e0aeb29e87db6e65f598cc054eeaff72
+  data.tar.gz: 635ce04b15079e19b59f2339e6befc4b17584d7490f17e94e3143dfe2110b35c
+SHA512:
+  metadata.gz: b3bfc0dfc1152a4b5bdaf7528cc87f7abf379d96a467e84a22f6f49af498794ef8c91fc2732900fa16d46d3e9eb8fd9b2947473c94bab6ebf589e4a44c7bbf5e
+  data.tar.gz: 5d44099886152400b9e7242bd44688d07595632420689c85247ec0f462ba3398553ebb1ac41ee08280db2eb964e315623d41004b72a569c21d0970e9375608d0

data/.github/copilot-instructions.md

@@ -0,0 +1,55 @@
+# Copilot Instructions
+
+## Build & Test Commands
+
+```bash
+bundle install          # install dependencies
+rake spec               # run all tests (default task)
+rake spec_doc           # run tests with documentation formatter
+rspec spec/asterisk/ajam/session_spec.rb   # run a single spec file
+rspec spec/asterisk/ajam/response_spec.rb  # run a single spec file
+rake rdoc               # generate RDoc documentation
+```
+
+## Publishing to RubyGems
+
+```bash
+# One-time: authenticate with your RubyGems account
+gem signin
+# Or manually fetch and store the API key:
+# curl -u USERNAME https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials && chmod 0600 ~/.gem/credentials
+
+# Bump version in lib/asterisk/ajam/version.rb, then:
+rake build    # builds pkg/asterisk-ajam-X.Y.Z.gem
+rake release  # builds, tags vX.Y.Z in git, pushes tag, and publishes to rubygems.org
+```
+
+`rake release` requires a clean git working tree and that the tag doesn't already exist.
+
+## Architecture
+
+This is a Ruby gem (`asterisk-ajam`) that communicates with the Asterisk PBX [AMI](https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+AMI+Actions) over HTTP(S) via [AJAM](https://wiki.asterisk.org/wiki/pages/viewpage.action?pageId=4817256).
+
+**Entry point:** `Asterisk::AJAM.connect(options)` in `lib/asterisk/ajam.rb` — creates and logs in a `Session`, returning it.
+
+**Two core classes:**
+
+- `Asterisk::AJAM::Session` (`lib/asterisk/ajam/session.rb`) — manages the HTTP connection, login, session cookie, and dispatches actions. Uses `method_missing` to implement `action_NAME` dynamic methods that map to AMI action names.
+- `Asterisk::AJAM::Response` (`lib/asterisk/ajam/response.rb`) — wraps `Net::HTTPResponse`, parses the AJAM XML body using `libxml-ruby`, and exposes:
+  - `#list` — array of hashes for eventlist responses (e.g., SIP peers)
+  - `#attribute` — hash of attributes for single-result responses
+  - `#data` — string output for `command` responses (`opaque_data`)
+  - `#session_id` — parsed from `Set-Cookie` header (`mansession_id`)
+
+**Request flow:** `Session#send_action` → `http_send_action` → `Net::HTTP::Post` with form data → `Response.new`. Session cookies (`mansession_id`) are passed back on every subsequent request via `request_headers`.
+
+**Custom exceptions** defined in `session.rb`: `InvalidURI`, `InvalidAMILogin`, `NotLoggedIn`. In `response.rb`: `InvalidHTTPBody`.
+
+## Key Conventions
+
+- **Dynamic action methods:** `action_NAME` calls are handled via `method_missing`. Any method matching `/^action_\w+$/` is dispatched to `send_action` with the suffix as the AMI action symbol (e.g., `action_sippeers` → `send_action(:sippeers, {})`).
+- **SSL:** Enabled automatically when URI scheme is `https`. Certificate verification is intentionally disabled (`VERIFY_NONE`).
+- **Specs use modern RSpec expectations** (`expect(...).to receive(...)`) rather than the older RSpec 2 `.stub(...)` / `.should_receive(...)` syntax.
+- **Fixture helpers** for HTTP responses are defined as top-level methods in `spec/spec_helper.rb` (e.g., `get_body_sippeers`, `cmd_body_dialplan_reload`).
+- **XML format:** AJAM responses are `<ajax-response>` documents; each `<generic>` element maps to one node. The first node is the status node (checked for `response='Success'` or `response='Follows'`); subsequent nodes form the event list.
+- Runtime dependency: `libxml-ruby` gem (used in `Response`).

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 1.9.3
+  - 3.2.0

data/Gemfile

@@ -1,6 +1,5 @@
 source 'https://rubygems.org'
 
-gem 'simplecov', :require => false, :group => :test
-gem 'coveralls', :require => false
-# Specify your gem's dependencies in asterisk-ajam.gemspec
+gem 'coveralls', require: false
+gem 'simplecov', require: false, group: :test
 gemspec

data/README.md

@@ -1,16 +1,17 @@
 # Asterisk::AJAM
+
 [![Build Status](https://travis-ci.org/staskobzar/asterisk-ajam.png?branch=master)](https://travis-ci.org/staskobzar/asterisk-ajam)
 [![Coverage Status](https://coveralls.io/repos/staskobzar/asterisk-ajam/badge.png?branch=master)](https://coveralls.io/r/staskobzar/asterisk-ajam?branch=master)
 [![Gem Version](https://badge.fury.io/rb/asterisk-ajam.png)](http://badge.fury.io/rb/asterisk-ajam)
 
-* * * 
-This is a very simple library that allows to comunicate with [Asterisk PBX](http://www.asterisk.org/) using [Asterisk Management Interface (AMI) actions](https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+AMI+Actions). 
+---
+
+This is a very simple library that allows to communicate with [Asterisk PBX](http://www.asterisk.org/) using [Asterisk Management Interface (AMI) actions](https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+AMI+Actions).
 Library communicates with AMI through HTTP(s) protocol. HTTP interface is provided by Asterisk PBX and called [AJAM](https://wiki.asterisk.org/wiki/pages/viewpage.action?pageId=4817256)
 
 This library does not provide events interface to AMI. It only sends actions/commands and read responses back. If you need real AMI interface please, check [Adhearsion framework](http://adhearsion.com/) which is very powerful and provides a lot of functionality.
 
-This library can use HTTTP Authentication username/password for AJAM servers behind proxy protected with basic access authentication scheme and HTTPS (SSL).
-
+This library can use HTTP Authentication username/password for AJAM servers behind proxy protected with basic access authentication scheme and HTTPS (SSL).
 
 ## Installation
 
@@ -20,63 +21,66 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle install
+    bundle install
 
 Or install it yourself as:
 
-    $ gem install asterisk-ajam
+    gem install asterisk-ajam
 
 ## Usage
 
 You can check file [example/ajam.rb](https://github.com/staskobzar/asterisk-ajam/blob/master/example/ajam.rb) for some examples (comes with source).
 
 Simple example:
+
 ```ruby
 require 'asterisk/ajam'
 ajam = Asterisk::AJAM.connect :uri => 'http://127.0.0.1:8088/mxml',
                               :ami_user => 'admin',
                               :ami_password => 'passw0rd'
 if ajam.connected?
-	ajam.command 'dialplan reload'
+ ajam.command 'dialplan reload'
     res = ajam.action_sippeers
     res.list.each {|peer| puts peer['objectname']}
 end
 ```
 
-List of argument options for ```Asterisk::AJAM.connect```:
+List of argument options for `Asterisk::AJAM.connect`:
 
-* ```:uri``` URI of AJAM server. See [Asterisk documentation](https://wiki.asterisk.org/wiki/pages/viewpage.action?pageId=4817256)  which explains how to configure AJAM server.
-* ```:ami_user```  AMI user username
-* ```:ami_password``` AMI user password
-* ```:proxy_user``` proxy username for HTTP Authentication
-* ```:proxy_pass``` proxy password for HTTP Authentication
+- `:uri` URI of AJAM server. See [Asterisk documentation](https://wiki.asterisk.org/wiki/pages/viewpage.action?pageId=4817256) which explains how to configure AJAM server.
+- `:ami_user` AMI user username
+- `:ami_password` AMI user password
+- `:proxy_user` proxy username for HTTP Authentication
+- `:proxy_pass` proxy password for HTTP Authentication
 
 If URI scheme is "https" then library enables SSL use. Please, note that current version does not enable verify mode of Net::HTTPS ruby library so it will accept any SSL certiificates without verifications.
 
-```Asterisk::AJAM.connect``` returns ```Asterisk::AJAM::Session``` class which provides several useful methods:
+`Asterisk::AJAM.connect` returns `Asterisk::AJAM::Session` class which provides several useful methods:
+
+`connected?` returns true if successfully logged in AMI
 
-```connected?``` returns true if successfully logged in AMI
+`command` send command to AMI and read response. Example:
 
-```command``` send command to AMI and read response. Example:
 ```ruby
 ajam.command "dialplan reload"
 ajam.command "core restart when convenient"
 ```
 
-```action_NAME``` sends action to AMI. NAME must be replaced with AMI action name (see: [Asterisk documentation](https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+AMI+Actions)). Accepts hash as an argument. Example:
+`action_NAME` sends action to AMI. NAME must be replaced with AMI action name (see: [Asterisk documentation](https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+AMI+Actions)). Accepts hash as an argument. Example:
+
 ```ruby
 ajam.action_agents # no arguments
 ajam.action_mailboxcount mailbox: "5555@default"
 ajam.action_originate :channel => 'Local/local-chan@from-pstn',
-    				  :application => 'MusicOnHold',
-    				  :callerid => 'John Doe <5555555>'
+          :application => 'MusicOnHold',
+          :callerid => 'John Doe <5555555>'
 ```
 
-Actions and Commands return ```Asterisk::AJAM::Response``` class with several methods where response data can be found:
+Actions and Commands return `Asterisk::AJAM::Response` class with several methods where response data can be found:
 
-* list
-* attribute
-* data
+- list
+- attribute
+- data
 
 ```ruby
 res = ajam.action_meetmelist
@@ -86,6 +90,7 @@ pp res.data
 ```
 
 ## Using Apache proxy tutorial
+
 As an additional security measure Apache proxy with HTTP Authentication can be used. Here is an example of Apache Virtual Host configuration as Proxy to AJAM server
 
 ```
@@ -106,11 +111,13 @@ NameVirtualHost *:8888
 ```
 
 Generate password file:
+
 ```
 htpasswd -b -c /etc/httpd/.htpasswd admin passw0rd
 ```
 
 Connect to proxy:
+
 ```ruby
 ajam = Asterisk::AJAM.connect :uri => 'http://ajamproxy.com:8888/mxml',
                               :ami_user => 'admin',
@@ -126,4 +133,3 @@ ajam = Asterisk::AJAM.connect :uri => 'http://ajamproxy.com:8888/mxml',
 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

@@ -1,26 +1,26 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rdoc/task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = "--color"
+  t.rspec_opts = '--color'
 end
 
 RSpec::Core::RakeTask.new(:spec_doc) do |t|
-  t.rspec_opts = "--color --format doc"
+  t.rspec_opts = '--color --format doc'
 end
 
 RSpec::Core::RakeTask.new(:spec_html) do |t|
-  t.rspec_opts = "--format html -o spec/reports/index.html"
+  t.rspec_opts = '--format html -o spec/reports/index.html'
 end
 
 Rake::RDocTask.new do |rd|
-  rd.main = "README.md"
-  rd.rdoc_files.include("README.md","lib/**/*.rb")
+  rd.main = 'README.md'
+  rd.rdoc_files.include('README.md', 'lib/**/*.rb')
   rd.title = 'Asterisk::AJAM: Ruby module for interacting with Asterisk management interface (AMI) via HTTP'
-  rd.rdoc_dir = "doc"
+  rd.rdoc_dir = 'doc'
   rd.options << '--line-numbers'
   rd.options << '--all'
 end
 
-task :default => :spec
+task default: :spec

data/asterisk-ajam.gemspec

@@ -1,26 +1,26 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'asterisk/ajam/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "asterisk-ajam"
+  spec.name          = 'asterisk-ajam'
   spec.version       = Asterisk::AJAM::VERSION
-  spec.authors       = ["Stas Kobzar"]
-  spec.email         = ["stas@modulis.ca"]
-  spec.description   = %q{Ruby module for interacting with Asterisk management interface (AMI) via HTTP}
-  spec.summary       = %q{AMI via HTTP}
-  spec.homepage      = "https://github.com/staskobzar/asterisk-ajam"
-  spec.license       = "MIT"
+  spec.authors       = ['Stas Kobzar']
+  spec.email         = ['staskobzar@gmail.com']
+  spec.description   = 'Ruby module for interacting with Asterisk management interface (AMI) via HTTP'
+  spec.summary       = 'AMI via HTTP'
+  spec.homepage      = 'https://github.com/staskobzar/asterisk-ajam'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 3.2.0'
 
   spec.files         = `git ls-files`.split($/)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rdoc"
-  spec.add_development_dependency "rspec"
-  #spec.add_development_dependency "fakeweb"
-  spec.add_runtime_dependency "libxml-ruby"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rdoc'
+  spec.add_development_dependency 'rspec'
+  spec.add_runtime_dependency 'libxml-ruby'
 end

data/example/ajam.rb

@@ -1,21 +1,21 @@
 #!/usr/bin/env ruby
 require 'asterisk/ajam'
 require 'pp'
-ajam = Asterisk::AJAM.connect :uri => 'http://127.0.0.1:8088/mxml',
-                              :ami_user => 'admin',
-                              :ami_password => 'amp111',
-                              :proxy_user => 'admin',
-                              :proxy_pass => 'admin'
+ajam = Asterisk::AJAM.connect uri: 'http://127.0.0.1:8088/mxml',
+                              ami_user: 'admin',
+                              ami_password: 'amp111',
+                              proxy_user: 'admin',
+                              proxy_pass: 'admin'
 
 pp ajam.connected?
 # actions
 res = ajam.action_sippeers
 pp res.list
 
-ajam = Asterisk::AJAM.connect :uri => 'https://127.0.0.1:9443/mxml',
-                              :ami_user => 'admin',
-                              :ami_password => 'amp111',
-                              :use_ssl => true
+ajam = Asterisk::AJAM.connect uri: 'https://127.0.0.1:9443/mxml',
+                              ami_user: 'admin',
+                              ami_password: 'amp111',
+                              use_ssl: true
 res = ajam.action_corestatus
 pp res.attribute
 pp res.list

data/lib/asterisk/ajam/response.rb

@@ -1,4 +1,8 @@
-require 'libxml'
+begin
+  require 'libxml-ruby'
+rescue LoadError
+  require 'libxml'
+end
 
 #
 # = asterisk/ajam/response.rb
@@ -6,15 +10,14 @@ require 'libxml'
 module Asterisk
   module AJAM
     # Exception raised when HTTP response body is invalid
-    class InvalidHTTPBody < StandardError;end #:nodoc:
+    class InvalidHTTPBody < StandardError; end # :nodoc:
 
     #
-    # Generic class to process and store responses from 
+    # Generic class to process and store responses from
     # Asterisk AJAM server. Stores data from HTTP response
     # and xml document received from Asterisk server
     #
     class Response
-
       # HTTP response code
       attr_reader :code
 
@@ -27,15 +30,18 @@ module Asterisk
       # Response attributes
       attr_reader :attribute
 
-      # Creates new Response class instance. Sets instance 
+      # Creates new Response class instance. Sets instance
       # variables from HTTP Response (like code). Parses body.
       def initialize(http)
-        raise ArgumentError,
-          "Expected Net::HTTP::Response. Got #{http.class}" unless http.is_a?(Net::HTTPResponse)
+        unless http.is_a?(Net::HTTPResponse)
+          raise ArgumentError,
+                "Expected Net::HTTPResponse. Got #{http.class}"
+        end
         @attribute = []
         @list = []
         @code = http.code.to_i
         return unless httpok?
+
         parse_body http.body
         set_session_id http
       end
@@ -56,64 +62,66 @@ module Asterisk
       end
 
       # raw xml from command response
-      def raw_xml
-        @raw_xml
-      end
+      attr_reader :raw_xml
 
       private
-        # Parses HTTP response body.
-        # Body should by xml string. Otherwise will raise
-        # exception InvalidHTTPBody
-        def parse_body xml
-          @raw_xml = xml
-          set_nodes xml
-          verify_response
-          set_eventlist
-        end
 
-        # parse xml body and set result to internal variable for farther processing
-        def set_nodes xml
+      # Parses HTTP response body.
+      # Body should by xml string. Otherwise will raise
+      # exception InvalidHTTPBody
+      def parse_body(xml)
+        @raw_xml = xml
+        set_nodes xml
+        verify_response
+        set_eventlist
+      end
+
+      # parse xml body and set result to internal variable for farther processing
+      def set_nodes(xml)
+        if xml.to_s.empty?
           raise InvalidHTTPBody,
-            "Empty response body" if xml.to_s.empty?
-          src = LibXML::XML::Parser.string(xml).parse
-          @nodes = src.root.find('response/generic').to_a
+                'Empty response body'
         end
+        src = LibXML::XML::Parser.string(xml).parse
+        @nodes = src.root.find('response/generic').to_a
+      end
 
-        # 
-        # Check if AJAM response is successfull and set internal variable
-        # @success
-        def verify_response
-          node = @nodes.shift
-          @success = ['success', 'follows'].include? node[:response].to_s.downcase
-          @attribute = node.attributes.to_h
+      #
+      # Check if AJAM response is successful and set internal variable
+      # @success
+      def verify_response
+        node = @nodes.shift
+        @success = %w[success follows].include? node[:response].to_s.downcase
+        @attribute = node.attributes.to_h
 
-          set_command_data
-        end
+        set_command_data
+      end
 
-        # extract mansession_id from cookies
-        def set_session_id(http)
-          if /mansession_id=(['"])([^\1]+)\1/ =~ http['Set-Cookie']
-            @session_id = $2
-          end
-        end
+      # extract mansession_id from cookies
+      def set_session_id(http)
+        return unless /mansession_id=(['"])([^'"]+)\1/ =~ http['Set-Cookie']
 
-        # for reponses that contain eventlist of values set it to 
-        # internal attributes
-        def set_eventlist
-          return unless @attribute['eventlist'].to_s.downcase.eql? 'start'
-          @nodes.each do |node|
-            next if node['eventlist'].eql? 'Complete'
-            @list << node.attributes.to_h
-          end
-        end
+        @session_id = ::Regexp.last_match(2)
+      end
+
+      # for responses that contain eventlist of values set it to
+      # internal attributes
+      def set_eventlist
+        return unless @attribute['eventlist'].to_s.downcase.eql? 'start'
 
-        def set_command_data
-          if @attribute.has_key?('opaque_data')
-            @data = @attribute['opaque_data']
-            @attribute.delete 'opaque_data'
-          end
+        @nodes.each do |node|
+          next if node['eventlist'].eql? 'Complete'
+
+          @list << node.attributes.to_h
         end
+      end
 
+      def set_command_data
+        return unless @attribute.has_key?('opaque_data')
+
+        @data = @attribute['opaque_data']
+        @attribute.delete 'opaque_data'
+      end
     end
   end
 end

data/lib/asterisk/ajam/session.rb

@@ -5,29 +5,28 @@ require 'net/https' # this will also include net/http and uri
 module Asterisk
   module AJAM
     #
-    # == Session class for Asterisk AJAM 
-    # Used to controll connection to Astersik AJAM via HTTP protocol
+    # == Session class for Asterisk AJAM
+    # Used to control connection to Asterisk AJAM via HTTP protocol
     #
-    
+
     # Session errors
     # This class extends StandardError and raises when problem with
     # AJAM URL found, for ex: missing scheme or hostname
     # TODO: should be also used for HTTPS connections
-    class InvalidURI < StandardError; end #:nodoc:
+    class InvalidURI < StandardError; end # :nodoc:
 
     # This class extends StandardError and raises when problems
-    # with loggin AJAM server found or when missing importent
+    # with logging AJAM server found or when missing important
     # parameters like username or password.
-    class InvalidAMILogin < StandardError; end #:nodoc:
+    class InvalidAMILogin < StandardError; end # :nodoc:
 
     # Class extends StandardError and is raised when trying to
     # send command to not AJAM server where not logged in
-    class NotLoggedIn < StandardError; end #:nodoc:
+    class NotLoggedIn < StandardError; end # :nodoc:
 
     # This class establish connection to AJAM server using TCP connection
-    # and HTTP protocol. 
+    # and HTTP protocol.
     class Session
-
       # Asterisk AJAM server URI
       # URI class instance
       attr_accessor :uri
@@ -44,9 +43,9 @@ module Asterisk
       # http access password
       attr_accessor :proxy_pass
 
-      # Create new Asterisk AJAM session without initializing 
+      # Create new Asterisk AJAM session without initializing
       # TCP network connection
-      def initialize(options={})
+      def initialize(options = {})
         self.uri        = options[:uri]
         @ami_user       = options[:ami_user]
         @ami_password   = options[:ami_password]
@@ -55,7 +54,7 @@ module Asterisk
         @use_ssl        = options[:use_ssl]
       end
 
-      # login action. Also stores session identificator for 
+      # login action. Also stores session identifier for
       # sending many actions within same session
       def login
         ami_user_valid?
@@ -69,90 +68,101 @@ module Asterisk
         action_command command: command
       end
 
-      # Verify if session esteblished connection and set session id
+      # Verify if session established connection and set session id
       def connected?
         /^[0-9a-z]{8}$/.match(@response.session_id).is_a? MatchData
       end
 
       private
-        # handling action_ methods
-        def method_missing(method, *args)
-          method = method.id2name
+
+      # handling action_ methods
+      def method_missing(method, *args)
+        method = method.id2name
+        unless /^action_\w+$/.match(method)
           raise NoMethodError,
-            "Undefined method #{method}" unless /^action_\w+$/.match(method)
-          raise NotLoggedIn, "Not logged in" unless connected?
-          send_action method.sub(/^action_/,'').to_sym, *args
+                "Undefined method #{method}"
         end
+        raise NotLoggedIn, 'Not logged in' unless connected?
 
-        # send action to Asterisk AJAM server
-        def send_action(action, params={})
-          set_params Hash[action: action].merge params
-          @response = http_send_action
-        end
+        send_action method.sub(/^action_/, '').to_sym, *args
+      end
 
-        # Send HTTP request to AJAM server using "#uri"
-        def http_send_action
-          http = http_inst
-          req  = http_post
-          Response.new http.request req
-        end
+      # send action to Asterisk AJAM server
+      def send_action(action, params = {})
+        set_params Hash[action: action].merge params
+        @response = http_send_action
+      end
 
-        # create new Net::HTTP instance
-        def http_inst
-          http = Net::HTTP.new(@uri.host, @uri.port)
-          if @uri.scheme.downcase.eql? 'https'
-            http.use_ssl = true
-            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-          end
-          http
-        end
+      # Send HTTP request to AJAM server using "#uri"
+      def http_send_action
+        http = http_inst
+        req  = http_post
+        Response.new http.request req
+      end
 
-        # create new Net::HTTP::Post instance
-        def http_post
-          req  = Net::HTTP::Post.new @uri.request_uri, request_headers
-          req.set_form_data params
-          req.basic_auth @proxy_user, @proxy_pass if @proxy_pass && @proxy_user
-          req
+      # create new Net::HTTP instance
+      def http_inst
+        http = Net::HTTP.new(@uri.host, @uri.port)
+        if @uri.scheme.downcase.eql? 'https'
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
+        http
+      end
 
-        # Post parameters
-        def params
-          @params
-        end
+      # create new Net::HTTP::Post instance
+      def http_post
+        req = Net::HTTP::Post.new @uri.request_uri, request_headers
+        req.set_form_data params
+        req.basic_auth @proxy_user, @proxy_pass if @proxy_pass && @proxy_user
+        req
+      end
 
-        # set AJAM POST parameters
-        def set_params(params)
-          @params = params
-        end
+      # Post parameters
+      attr_reader :params
 
-        # verifies if AMI username is set and not empty
-        def ami_user_valid?
-          raise InvalidAMILogin,
-            "Missing AMI username" if @ami_user.to_s.empty?
-        end
+      # set AJAM POST parameters
+      def set_params(params)
+        @params = params
+      end
 
-        # verifies if AMI password (secret) is set and not empty
-        def ami_pass_valid?
-          raise InvalidAMILogin,
-            "Missing AMI user pass" if @ami_password.to_s.empty?
-        end
+      # verifies if AMI username is set and not empty
+      def ami_user_valid?
+        return unless @ami_user.to_s.empty?
 
-        # setup AJAM URI
-        def uri=(uri)
-          @uri = URI.parse uri
-          raise InvalidURI,
-            "No AJAM URI given" unless @uri
+        raise InvalidAMILogin,
+              'Missing AMI username'
+      end
+
+      # verifies if AMI password (secret) is set and not empty
+      def ami_pass_valid?
+        return unless @ami_password.to_s.empty?
+
+        raise InvalidAMILogin,
+              'Missing AMI user pass'
+      end
+
+      # setup AJAM URI
+      def uri=(uri)
+        @uri = URI.parse uri
+        unless @uri
           raise InvalidURI,
-            "Unsupported uri.scheme" unless %w/http https/.include? @uri.scheme
+                'No AJAM URI given'
         end
+        return if %w[http https].include? @uri.scheme
 
-        # initialize request headers for Net::HTTPRequest class
-        def request_headers
-          return nil unless @response
-          Hash[
-            'Cookie' => %Q!mansession_id="#{@response.session_id}"!
-          ]
-        end
+        raise InvalidURI,
+              'Unsupported uri.scheme'
+      end
+
+      # initialize request headers for Net::HTTPRequest class
+      def request_headers
+        return nil unless @response
+
+        Hash[
+          'Cookie' => %(mansession_id="#{@response.session_id}")
+        ]
+      end
     end
   end
 end

data/lib/asterisk/ajam/version.rb

@@ -1,5 +1,5 @@
 module Asterisk
   module AJAM
-    VERSION = "0.0.2"
+    VERSION = '0.1.0'
   end
 end

data/lib/asterisk/ajam.rb

@@ -3,7 +3,6 @@ require 'asterisk/ajam/session'
 require 'asterisk/ajam/response'
 
 module Asterisk
-
   module AJAM
     def self.connect(options)
       Session.new(options).login

data/spec/asterisk/ajam/response_spec.rb

@@ -6,96 +6,96 @@ module Asterisk
       # stub successful login
       let(:res_login_ok) do
         http = get_simple_httpok
-        http.stub(:body => get_body_success_login)
+        allow(http).to receive(:body).and_return(get_body_success_login)
         http
       end
       # stub failed login
       let(:res_login_fail) do
         http = get_simple_httpok
-        http.stub(:body => get_body_failed_login)
+        allow(http).to receive(:body).and_return(get_body_failed_login)
         http
       end
 
-      #new
-      describe "#new" do
-        it "raises error if parameter is not Net::HTTPResponse instance" do
-          expect{
+      # new
+      describe '#new' do
+        it 'raises error if parameter is not Net::HTTPResponse instance' do
+          expect do
             Response.new nil
-          }.to raise_error(ArgumentError)
+          end.to raise_error(ArgumentError)
         end
 
-        it "raises error if empty response body" do
+        it 'raises error if empty response body' do
           http = get_simple_httpok
-          http.stub(:body => '')
-          expect{
+          allow(http).to receive(:body).and_return('')
+          expect do
             Response.new http
-          }.to raise_error(InvalidHTTPBody)
+          end.to raise_error(InvalidHTTPBody)
         end
 
-        it "raises error if invalid xml response body" do
+        it 'raises error if invalid xml response body' do
           http = get_simple_httpok
-          http.stub(:body => '<a>this is not xml')
-          expect{
+          allow(http).to receive(:body).and_return('<a>this is not xml')
+          expect do
             Response.new http
-          }.to raise_error(LibXML::XML::Error)
+          end.to raise_error(LibXML::XML::Error)
         end
 
-        it "set session id" do
-          sid = "df901b5f"
+        it 'set session id' do
+          sid = 'df901b5f'
           res = res_login_ok
-          res.stub(:[]).with('Set-Cookie').and_return(%Q[mansession_id="#{sid}"; Version=1; Max-Age=60])
+          allow(res).to receive(:[]).with('Set-Cookie').and_return(%(mansession_id="#{sid}"; Version=1; Max-Age=60))
           response = Response.new res
-          response.session_id.should eql(sid)
+          expect(response.session_id).to eql(sid)
         end
       end
 
-      #httpok?
-      describe "#httpok?" do
-        it "returns true if successfully received response from AJAM" do
+      # httpok?
+      describe '#httpok?' do
+        it 'returns true if successfully received response from AJAM' do
           res = Response.new res_login_ok
-          res.should be_httpok
+          expect(res).to be_httpok
         end
-        it "returns false if response from AJAM anything but 200 OK" do
+        it 'returns false if response from AJAM anything but 200 OK' do
           res = Response.new get_http_unauth
-          res.should_not be_httpok
+          expect(res).not_to be_httpok
         end
       end
 
-      #success?
-      describe "#success?" do
-        it "returns true if AJAM response is successful" do
+      # success?
+      describe '#success?' do
+        it 'returns true if AJAM response is successful' do
           res = Response.new res_login_ok
-          res.should be_success
+          expect(res).to be_success
         end
-        it "returns false if AJAM response id error" do
+        it 'returns false if AJAM response id error' do
           res = Response.new res_login_fail
-          res.should_not be_success
+          expect(res).not_to be_success
         end
       end
 
-      describe "actions" do
-        it "set recieved response list to class attributes" do
+      describe 'actions' do
+        it 'set received response list to class attributes' do
           http = get_simple_httpok
-          http.stub(:body => get_body_sippeers)
+          allow(http).to receive(:body).and_return(get_body_sippeers)
           res = Response.new http
-          res.list.first.should include('event' => 'PeerEntry', 'objectname' => '5555')
-          res.list.last.should include('objectname' => '8903')
+          expect(res.list.first).to include('event' => 'PeerEntry', 'objectname' => '5555')
+          expect(res.list.last).to include('objectname' => '8903')
         end
 
-        it "when response has single result then it stored in :response" do
+        it 'when response has single result then it stored in :response' do
           http = get_simple_httpok
-          http.stub(:body => get_body_corestatus)
+          allow(http).to receive(:body).and_return(get_body_corestatus)
           res = Response.new http
-          res.attribute['corestartuptime'].should eql('17:13:00')
+          expect(res.attribute['corestartuptime']).to eql('17:13:00')
         end
       end
 
-      describe "#command" do
-        it "set data variable with response from AJAM" do
+      describe '#command' do
+        it 'set data variable with response from AJAM' do
           http = get_simple_httpok
-          http.stub(:body => cmd_body_dialplan_reload)
+          allow(http).to receive(:body).and_return(cmd_body_dialplan_reload)
           res = Response.new http
-          res.data.should match(/Dialplan reloaded/)
+          expect(res.data).to match(/Dialplan reloaded/)
         end
       end
     end

data/spec/asterisk/ajam/session_spec.rb

@@ -3,107 +3,104 @@ require 'spec_helper'
 module Asterisk
   module AJAM
     describe Session do
-      let(:uri_http){'http://ajam.asterisk.com:8088/mxml'}
-      let(:manses_id){"84d22b60"}
+      let(:uri_http) { 'http://ajam.asterisk.com:8088/mxml' }
+      let(:manses_id) { '84d22b60' }
       let(:http) do
         http = get_simple_httpok
-        http.stub(:body => get_body_success_login)
-        http.stub(:[]).with('Set-Cookie').and_return(%Q|mansession_id="#{manses_id}"; Version=1; Max-Age=60|)
+        allow(http).to receive(:body).and_return(get_body_success_login)
+        allow(http).to receive(:[]).with('Set-Cookie').and_return(%(mansession_id="#{manses_id}"; Version=1; Max-Age=60))
         http
       end
-      subject{Session.new uri: uri_http, ami_user: 'admin', ami_password: 'passw0rd'}
-      before(:each, :logginok => true) do
-        Net::HTTP.stub(:new).and_return(double('Net::HTTP', :request => http, :use_ssl= => true))
+      subject { Session.new uri: uri_http, ami_user: 'admin', ami_password: 'passw0rd' }
+      before(:each, logginok: true) do
+        allow(Net::HTTP).to receive(:new).and_return(double('Net::HTTP', :request => http, :use_ssl= => true))
       end
 
-      describe "#new" do
-        it "set AJAM uri" do
-          URI.stub(:parse => URI(uri_http))
-          URI.should_receive(:parse).with(uri_http)
+      describe '#new' do
+        it 'set AJAM uri' do
+          expect(URI).to receive(:parse).with(uri_http).and_return(URI(uri_http))
           Session.new uri: uri_http
         end
 
-        it "raises error if URI missing " do
-          expect{
+        it 'raises error if URI missing ' do
+          expect do
             Session.new
-          }.to raise_error(URI::InvalidURIError)
+          end.to raise_error(URI::InvalidURIError)
         end
 
-        it "raises error if scheme is not http or https" do
-          uri = "ftp://127.0.0.1/path"
-          expect{
+        it 'raises error if scheme is not http or https' do
+          uri = 'ftp://127.0.0.1/path'
+          expect do
             Session.new uri: uri
-          }.to raise_error(InvalidURI)
+          end.to raise_error(InvalidURI)
         end
       end
 
-      describe "#login", :logginok => true do
-        it "raises InvalidAMILogin if empty AMI username" do
+      describe '#login', logginok: true do
+        it 'raises InvalidAMILogin if empty AMI username' do
           subject.ami_user = nil
-          expect{
+          expect do
             subject.login
-          }.to raise_error(InvalidAMILogin)
+          end.to raise_error(InvalidAMILogin)
         end
 
-        it "raises InvalidAMILogin if empty AMI password" do
+        it 'raises InvalidAMILogin if empty AMI password' do
           subject.ami_password = nil
-          expect{
+          expect do
             subject.login
-          }.to raise_error(InvalidAMILogin)
+          end.to raise_error(InvalidAMILogin)
         end
 
-        it "should return Session class instance on success" , :mock_login => true do
+        it 'should return Session class instance on success', mock_login: true do
           response = subject.login
-          response.should be_kind_of Session
+          expect(response).to be_kind_of(Session)
         end
-
       end
 
-      describe "#connected?", :logginok => true do
-        it "returns true when successfuly logged in", :mock_login => true do
+      describe '#connected?', logginok: true do
+        it 'returns true when successfully logged in', mock_login: true do
           subject.login
-          subject.should be_connected
+          expect(subject).to be_connected
         end
       end
 
-      describe "action methods" do
-        before(:each) {subject.stub(:connected?).and_return(true)}
-        it "when call action without parameters then expects send_action with action name" do
-          subject.should_receive(:send_action).once.with(:sippeers)
+      describe 'action methods' do
+        before(:each) { allow(subject).to receive(:connected?).and_return(true) }
+        it 'when call action without parameters then expects send_action with action name' do
+          expect(subject).to receive(:send_action).once.with(:sippeers)
           subject.action_sippeers
         end
 
-        it "when call action with parameters then expects send_action with hash" do
+        it 'when call action with parameters then expects send_action with hash' do
           params = Hash[family: 'user', key: 'extension', val: '5555']
-          subject.should_receive(:send_action).with(:dbput, params)
+          expect(subject).to receive(:send_action).with(:dbput, params)
           subject.action_dbput params
         end
 
-        it "uses cookies when sending action", :logginok => true do
+        it 'uses cookies when sending action', logginok: true do
           subject.login
-          Net::HTTP::Post.should_receive(:new).
-            with(anything(),hash_including("Cookie"=>%Q!mansession_id="#{manses_id}"!)).
-            and_return(double('Net::HTTPResponse', :set_form_data => true))
+          expect(Net::HTTP::Post).to receive(:new)
+            .with(anything, hash_including('Cookie' => %(mansession_id="#{manses_id}")))
+            .and_return(double('Net::HTTPResponse', set_form_data: true))
           subject.action_corestatus
         end
       end
 
-      describe "#command" do
-        before(:each) {subject.stub(:connected?).and_return(true)}
-        it "sends command to action method" do
+      describe '#command' do
+        before(:each) { allow(subject).to receive(:connected?).and_return(true) }
+        it 'sends command to action method' do
           http = get_simple_httpok
-          http.stub(:body => cmd_body_sip_show_peers)
-          http.stub(:[]).and_return(%Q|mansession_id="#{manses_id}"; Version=1; Max-Age=60|)
-          http.stub(:set_form_data).with(anything())
-          http.stub(:use_ssl=)
-          http.stub(:request => http)
-          Net::HTTP.stub(:new => http)
-          Net::HTTP::Post.stub(:new).and_return(double('Net::HTTP::Post', :set_form_data => true))
+          allow(http).to receive(:body).and_return(cmd_body_sip_show_peers)
+          allow(http).to receive(:[]).and_return(%(mansession_id="#{manses_id}"; Version=1; Max-Age=60))
+          allow(http).to receive(:set_form_data).with(anything)
+          allow(http).to receive(:use_ssl=)
+          allow(http).to receive(:request).and_return(http)
+          allow(Net::HTTP).to receive(:new).and_return(http)
+          allow(Net::HTTP::Post).to receive(:new).and_return(double('Net::HTTP::Post', set_form_data: true))
           res = subject.command 'sip show peers'
-          res.data.should match(/88888\s+\(Unspecified\)/)
+          expect(res.data).to match(/88888\s+\(Unspecified\)/)
         end
       end
-
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,16 +1,16 @@
 require 'simplecov'
 require 'coveralls'
-Coveralls.wear!
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
-]
+])
 SimpleCov.start do
-  add_filter "spec/"
+  add_filter 'spec/'
 end
 require 'asterisk/ajam'
 
-# this fixture create valid HTTPOK response 
+# this fixture create valid HTTPOK response
 def get_simple_httpok
   Net::HTTPOK.new 1.1, 200, 'OK'
 end
@@ -20,22 +20,22 @@ def get_http_unauth
 end
 
 def get_body_success_login
-  %q{<ajax-response>
+  "<ajax-response>
 <response type='object' id='unknown'><generic response='Success' message='Authentication accepted' /></response>
 </ajax-response>
-  }
+  "
 end
 
 def get_body_failed_login
-  %q{
+  "
 <ajax-response>
 <response type='object' id='unknown'><generic response='Error' message='Authentication failed' /></response>
 </ajax-response>
-  }
+  "
 end
 
 def get_body_sippeers
-  %q{<ajax-response>
+  "<ajax-response>
 <response type='object' id='unknown'><generic response='Success' actionid='321321321' eventlist='start' message='Peer status list will follow' /></response>
 <response type='object' id='unknown'><generic event='PeerEntry' actionid='321321321' channeltype='SIP' objectname='5555' chanobjecttype='peer' ipaddress='-none-' ipport='0' dynamic='yes' forcerport='no' videosupport='no' textsupport='no' acl='yes' status='UNKNOWN' realtimedevice='no' /></response>
 <response type='object' id='unknown'><generic event='PeerEntry' actionid='321321321' channeltype='SIP' objectname='8734' chanobjecttype='peer' ipaddress='-none-' ipport='0' dynamic='yes' forcerport='yes' videosupport='no' textsupport='no' acl='yes' status='UNKNOWN' realtimedevice='no' /></response>
@@ -47,26 +47,26 @@ def get_body_sippeers
 <response type='object' id='unknown'><generic event='PeerEntry' actionid='321321321' channeltype='SIP' objectname='8903' chanobjecttype='peer' ipaddress='-none-' ipport='0' dynamic='yes' forcerport='yes' videosupport='no' textsupport='no' acl='yes' status='UNKNOWN' realtimedevice='no' /></response>
 <response type='object' id='unknown'><generic event='PeerlistComplete' eventlist='Complete' listitems='8' actionid='321321321' /></response>
 </ajax-response>
-  }
+  "
 end
 
 def get_body_corestatus
-  %q{<ajax-response>
+  "<ajax-response>
 <response type='object' id='unknown'><generic response='Success' corestartupdate='2013-05-25' corestartuptime='17:13:00' corereloaddate='2013-05-25' corereloadtime='17:13:00' corecurrentcalls='0' /></response>
 </ajax-response>
-  }
+  "
 end
 
 def cmd_body_dialplan_reload
-  %q{<ajax-response>
+  "<ajax-response>
 <response type='object' id='unknown'><generic response='Follows' privilege='Command' opaque_data='Dialplan reloaded.
 --END COMMAND--' /></response>
 </ajax-response>
-  }
+  "
 end
 
 def cmd_body_sip_show_peers
-  %q{<ajax-response>
+  "<ajax-response>
 <response type='object' id='unknown'><generic response='Follows' privilege='Command' opaque_data='Name/username              Host                                    Dyn Forcerport ACL Port     Status
 5555                       (Unspecified)                            D              A  0        UNKNOWN
 8734                       (Unspecified)                            D   N          A  0        UNKNOWN
@@ -79,5 +79,5 @@ def cmd_body_sip_show_peers
 8 sip peers [Monitored: 0 online, 8 offline Unmonitored: 0 online, 0 offline]
 --END COMMAND--' /></response>
 </ajax-response>
-  }
+  "
 end

metadata

@@ -1,95 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: asterisk-ajam
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Stas Kobzar
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
   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: Ruby module for interacting with Asterisk management interface (AMI)
   via HTTP
 email:
-- stas@modulis.ca
+- staskobzar@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".github/copilot-instructions.md"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -107,24 +107,21 @@ homepage: https://github.com/staskobzar/asterisk-ajam
 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'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
+rubygems_version: 4.0.6
 specification_version: 4
 summary: AMI via HTTP
 test_files: