ruby_ami 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5e6e035e1967a44a905b10ad704dbac564d4c90
-  data.tar.gz: 20f7fd7d4a8061c6e15dffa0b2f178645ef31b32
+  metadata.gz: 290ed21fc6ee40c83c12d15b2acf9240f7ce47f1
+  data.tar.gz: 34ec462b7e67818135a307ead4baafae599fbae4
 SHA512:
-  metadata.gz: a5fafdd9ed56328ed906339a18d1ad8e3671985b6fd5a834ce9c6fe3d6e7ffccd7c44c2f0960d7f6f77358b3739ea6bb3e522f92191209e30b2ad12648cf0e7d
-  data.tar.gz: 0dc58ad3d2f2e3bf7e88fb66c43230d8c513bd61f7bdf7a196bd816e94fc78d7542b0eb55b26c154a7de6c26a56e4c881cd65ea52988192d5dd0d9e6d24be0f2
+  metadata.gz: 20c254c3d24652245ee2d806406aee1646e2756960e9a1a0a1bf14a9e77ec7e9b3c2048fde0a5e5b0d83210fe50d531cdc2222bddf552c2bae04a51fcd6d54fb
+  data.tar.gz: 039e2f837d3a941dedaab896db37bdc6867da934b0bc2eb3c9b1a3bb0e8ff2c9ae1d5ecda2d159a7adf843777834e6cb3a3b9764eab13a29366e378a7b4b28ce

data/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - jruby-19mode
-  - rbx-19mode
-  - ruby-head  
+  - 2.1.0
+  - jruby
+  - rbx-2.1.1
+  - ruby-head
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
+    - rvm: ruby-head
+    - rvm: rbx-2.1.1
 notifications:
   irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [develop](https://github.com/adhearsion/ruby_ami)
 
+# [2.2.0](https://github.com/adhearsion/ruby_ami/compare/v2.1.0...v2.2.0) - [2014-02-28](https://rubygems.org/gems/ruby_ami/versions/2.2.0)
+  * Feature: Provide timestamps of events as `#timestamp`, `#receipt_time` and `#best_time`.
+  * Feature: More performant parsing of AGI environment strings
+
 # [2.1.0](https://github.com/adhearsion/ruby_ami/compare/v2.0.0...v2.1.0) - [2013-05-29](https://rubygems.org/gems/ruby_ami/versions/2.1.0)
   * Enhancement: Replace Ragel parser with pure Ruby version, which is much more performant and simpler
   * Bugfix: Handle AGI 5xx responses

data/benchmarks/agi_env_parse.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'ruby_ami'
+require 'benchmark/ips'
+
+env_string = "agi_request%3A%20async%0Aagi_channel%3A%20SIP%2F1234-00000000%0Aagi_language%3A%20en%0Aagi_type%3A%20SIP%0Aagi_uniqueid%3A%201320835995.0%0Aagi_version%3A%201.8.4.1%0Aagi_callerid%3A%205678%0Aagi_calleridname%3A%20Jane%20Smith%0Aagi_callingpres%3A%200%0Aagi_callingani2%3A%200%0Aagi_callington%3A%200%0Aagi_callingtns%3A%200%0Aagi_dnid%3A%201000%0Aagi_rdnis%3A%20unknown%0Aagi_context%3A%20default%0Aagi_extension%3A%201000%0Aagi_priority%3A%201%0Aagi_enhanced%3A%200.0%0Aagi_accountcode%3A%20%0Aagi_threadid%3A%204366221312%0A%0A"
+
+Benchmark.ips do |ips|
+  ips.report("environment parsing") { RubyAMI::AsyncAGIEnvironmentParser.new(env_string).to_hash }
+  ips.report("CGI unescaping") { CGI.unescape(env_string) }
+end

data/lib/ruby_ami/agi_result_parser.rb

@@ -10,7 +10,7 @@ module RubyAMI
 
     def initialize(result_string)
       @result_string = result_string.dup
-      raise ArgumentError, "The result string did not match the required format." unless match
+      raise ArgumentError, "The result string (#{@result_string}) did not match the required format (#{FORMAT})." unless match
       parse
     end
 

data/lib/ruby_ami/async_agi_environment_parser.rb

@@ -3,13 +3,16 @@ require 'cgi'
 
 module RubyAMI
   class AsyncAGIEnvironmentParser
+    NEWLINE = "%0A".freeze
+    COLON_SPACE = '%3A%20'.freeze
+
     def initialize(environment_string)
       @environment_string = environment_string.dup
     end
 
     def to_hash
       to_array.inject({}) do |accumulator, element|
-        accumulator[element[0].to_sym] = element[1] || ''
+        accumulator[element[0].to_sym] = CGI.unescape(element[1] || '')
         accumulator
       end
     end
@@ -21,7 +24,7 @@ module RubyAMI
     private
 
     def to_array
-      CGI.unescape(@environment_string).split("\n").map { |p| p.split ': ' }
+      @environment_string.split(NEWLINE).map { |p| p.split COLON_SPACE }
     end
   end
 end

data/lib/ruby_ami/event.rb

@@ -3,13 +3,25 @@ require 'ruby_ami/response'
 
 module RubyAMI
   class Event < Response
-    attr_reader :name
+    attr_reader :name, :receipt_time
 
     def initialize(name, headers = {})
+      @receipt_time = DateTime.now
       super headers
       @name = name
     end
 
+    # @return [DateTime, nil] the timestamp of the event, or nil if none is available
+    def timestamp
+      return unless headers['Timestamp']
+      DateTime.strptime headers['Timestamp'], '%s'
+    end
+
+    # @return [DateTime] the best known timestamp for the event. Either its timestamp if specified, or its receipt time if not.
+    def best_time
+      timestamp || receipt_time
+    end
+
     def inspect_attributes
       [:name] + super
     end

data/lib/ruby_ami/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RubyAMI
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/spec/ruby_ami/event_spec.rb

@@ -3,6 +3,49 @@ require 'spec_helper'
 
 module RubyAMI
   describe Event do
+    subject { described_class.new 'Hangup' }
+
+    describe "#receipt_time" do
+      before do
+        @now = DateTime.now
+        DateTime.stub now: @now
+      end
+
+      it "should be the time the object was created (event receipt time)" do
+        subject.receipt_time.should == @now
+      end
+    end
+
+    context "when the event has a timestamp" do
+      subject { described_class.new 'Hangup', 'Timestamp' => '1393368380.572575' }
+
+      describe "#timestamp" do
+        it "should be a time object representing the event's timestamp (assuming UTC)" do
+          subject.timestamp.should == DateTime.new(2014, 2, 25, 22, 46, 20)
+        end
+      end
+
+      describe "#best_time" do
+        it "should be the timestamp" do
+          subject.best_time.should == subject.timestamp
+        end
+      end
+    end
+
+    context "when the event does not have a timestamp" do
+      describe "#timestamp" do
+        it "should be nil" do
+          subject.timestamp.should be_nil
+        end
+      end
+
+      describe "#best_time" do
+        it "should be the receipt_time" do
+          subject.best_time.should == subject.receipt_time
+        end
+      end
+    end
+
     describe "equality" do
       context "with the same name and the same headers" do
         let :event1 do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_ami
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Ben Langfeld
@@ -9,160 +9,160 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
   name: cucumber
   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: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !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: guard-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: guard-shell
   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: guard-cucumber
   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: guard-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: benchmark_suite
   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'
 description: A Ruby client library for the Asterisk Management Interface built on
@@ -174,15 +174,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/agi_env_parse.rb
 - benchmarks/lexer.rb
 - cucumber.yml
 - features/lexer.feature
@@ -223,17 +224,17 @@ 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: ruby_ami
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Futzing with AMI so you don't have to