asterisk-ari-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85b27638324674e15bd2f5220dc966c300ca2784
+  data.tar.gz: 5550be4213033e9599c04ec67ffede7c2bfa8ad3
+SHA512:
+  metadata.gz: ee5e99c5b46cfe4c15e290a823ab4263d9a0547c980cb14799b792a4e856686464ae5624e1b5676d4619b0c49ab57b786b5b3bc246ae408e55fb387346b994a4
+  data.tar.gz: fa4a32b9192197a9f9ec2a1631db0d839b67b0c763775c83e7b68be6a966e32bf8bc3e7884cb791f8d039af5d67f042a823f063b333b3e841c63f837852c1f4f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jan Svoboda
+
+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,85 @@
+# About
+
+This repository contains the ruby client library for the Asterisk REST Interface (ARI).
+It uses the swagger ARI json definitions to generate ruby classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asterisk-ari-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asterisk-ari-client
+
+## Usage
+
+```ruby
+# instantiate client
+@client = Ari::Client.new(
+  url: 'http://127.0.0.1:8088/ari',
+  api_key: 'asterisk:asterisk',
+  app: 'my-app'
+)
+
+# originate
+@client.channels.originate endpoint: 'PJSIP/endpoint-name', extension: 11
+
+# list all channels
+channels = @client.channels.list
+```
+
+When working with only one client you can also use the following:
+
+```ruby
+Ari.client = Ari::Client.new(
+  url: 'http://127.0.0.1:8088/ari',
+  api_key: 'asterisk:asterisk',
+  app: 'my-app'
+)
+
+# list channels
+channels = Ari::Channel.list
+```
+
+### WebSocket events
+
+```ruby
+# listen to events
+@client.on :websocket_open do
+  puts "Connected !"
+end
+
+@client.on :stasis_start do |e|
+  puts "Received call to #{e.channel.dialplan.exten} !"
+  
+  e.channel.answer
+
+  e.channel.on :channel_dtmf_received do |e|
+    puts "Digit pressed: #{e.digit} on channel #{e.channel.name} !"
+  end
+
+  e.channel.on :stasis_end do |e|
+    puts "Channel #{e.channel.name} left Stasis."
+  end
+end
+
+# start websocket to receive events
+@client.connect_websocket
+sleep
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/svoboda-jan/asterisk-ari/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,54 @@
+require "bundler/gem_tasks"
+require 'open-uri'
+require 'json'
+require 'ari/generators/resource_generator'
+
+desc "Generate resources from JSON specification"
+task :generate do
+
+  base_url = 'http://svn.asterisk.org/svn/asterisk/trunk/rest-api/api-docs/%{resource_name}.json'
+  resources = %w{ applications asterisk bridges channels deviceStates endpoints
+    events mailboxes playbacks recordings sounds
+  }
+
+  resource_options = {
+    asterisk: {
+      resource_klass_name: 'AsteriskInfo'
+    },
+    applications: {
+      id_attribute_name: 'applicationName'
+    },
+    events: {
+      only_models: true
+    }
+  }
+
+  models_path = File.join(__dir__, 'lib', 'ari', 'models.rb')
+  FileUtils.rm_f models_path
+  models_file = File.new(models_path, 'a')
+
+  resources_path = File.join(__dir__, 'lib', 'ari', 'resources.rb')
+  FileUtils.rm_f resources_path
+  resources_file = File.new(resources_path, 'a')
+
+  resources.each do |resource_name|
+    url = base_url % { resource_name: resource_name }
+    puts ">> generating #{resource_name} from #{url}"
+    json = JSON.parse open(url).read
+    generator = Ari::Generators::ResourceGenerator.new(
+      resource_name,
+      json,
+      resource_options[resource_name.to_sym] || {}
+    )
+    generator.generate
+
+    resources_file.puts "require 'ari/resources/#{generator.resource_name}'"
+    generator.models.each do |model|
+      next if model.name == generator.resource_name
+      models_file.puts "require 'ari/models/#{model.name}'"
+    end
+  end
+
+  models_file.close
+
+end

data/asterisk-ari-client.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asterisk/ari/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asterisk-ari-client"
+  spec.version       = Asterisk::Ari::Client::VERSION
+  spec.authors       = ["Jan Svoboda"]
+  spec.email         = ["jan@mluv.cz"]
+  spec.summary       = %q{Ruby client library for the Asterisk REST Interface (ARI).}
+  spec.description   = %q{Ruby client library for the Asterisk REST Interface (ARI).}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "minitest", "~> 5.4.2"
+  spec.add_development_dependency "vcr", "~> 2.9.3"
+  spec.add_development_dependency "webmock", "~> 1.19.0"
+
+  spec.add_development_dependency "active_support", "~> 4.1.6"
+
+  spec.add_dependency "websocket-client-simple", "~> 0.2.0"
+  spec.add_dependency "event_emitter", "~> 0.2.5"
+end

data/examples/list_channels.rb

@@ -0,0 +1,14 @@
+require 'asterisk-ari-client'
+
+@client = Ari::Client.new(
+  url: 'http://192.168.1.23:8088/ari',
+  api_key: 'asterisk:asterisk',
+  app: 'dialplan'
+)
+
+# list channels
+channels = @client.channels.list
+
+channels.each do |channel|
+  puts "Channel ID #{channel.id}: #{channel.name}"
+end

data/examples/websocket.rb

@@ -0,0 +1,33 @@
+require 'asterisk-ari-client'
+
+Ari.client = Ari::Client.new(
+  url: 'http://192.168.1.23:8088/ari',
+  api_key: 'asterisk:asterisk',
+  app: 'dialplan'
+)
+
+@client.on :websocket_open do
+  puts "Connected !"
+end
+
+@client.on :websocket_error do |err|
+  puts "Error :( #{err}"
+end
+
+@client.on :stasis_start do |e|
+  puts "Received call to #{e.channel.dialplan.exten} !"
+  
+  e.channel.answer
+
+  e.channel.on :channel_dtmf_received do |e|
+    puts "Digit pressed: #{e.digit} on channel #{e.channel.name} !"
+  end
+
+  e.channel.on :stasis_end do |e|
+    puts "Channel #{e.channel.name} left Stasis."
+  end
+end
+
+# start websocket to receive events
+@client.connect_websocket
+sleep

data/lib/ari.rb

@@ -0,0 +1,12 @@
+module Ari
+
+  def self.client
+    return @@client if defined?(@@client)
+    raise "ARI client not set. You can set it with ARI.client = client."
+  end
+
+  def self.client=(val)
+    @@client = val
+  end
+
+end

data/lib/ari/client.rb

@@ -0,0 +1,124 @@
+require 'net/http'
+require 'multi_json'
+require 'ari/request_error'
+require 'ari/server_error'
+require 'event_emitter'
+require 'websocket-client-simple'
+
+module Ari
+  class Client
+    include EventEmitter
+
+    attr_reader :ws
+
+    DEFAULTS = {
+      :url => 'http://localhost:8088/ari'
+    }
+
+    HTTP_HEADERS = {
+      'Content-Type'    => 'json',
+      'Accept'          => 'application/json',
+      'Accept-Charset'  => 'utf-8',
+      'User-Agent'      => "asterisk-ari-client/#{::Asterisk::Ari::Client::VERSION} ruby/#{RUBY_VERSION}"
+    }
+
+    def initialize(options = {})
+      @options = DEFAULTS.merge! options
+      @uri = URI.parse @options[:url]
+      raise ArgumentError.new("The :api_key needs to be specified.") unless @options[:api_key]
+    end
+
+    %w{ get put post delete }.each do |http_method|
+      method_klass = Net::HTTP.const_get http_method.to_s.capitalize
+      define_method http_method do |path, params = {}|
+        params.merge!({ api_key: @options[:api_key], app: @options[:app] })
+        query_string = URI.encode_www_form params
+        request_path = "#{@uri.path}#{path}?#{query_string}"
+        request = method_klass.new request_path, HTTP_HEADERS
+        send_request request
+      end
+    end
+
+    def connect_websocket
+      params = { api_key: @options[:api_key], app: @options[:app] }
+      query_string = URI.encode_www_form params
+      ws_url = "#{@uri}/events?#{query_string}"
+      if @ws
+        %w{ open message error close }.each { |e| @ws.remove_listener(e) }
+        @ws.close
+      end
+      @ws = WebSocket::Client::Simple.connect ws_url
+      @ws.on :open,    &method(:handle_websocket_open)
+      @ws.on :message, &method(:handle_websocket_message)
+      @ws.on :error,   &method(:handle_websocket_error)
+      @ws.on :close,   &method(:handle_websocket_close)
+    end
+
+    private
+
+    def handle_websocket_open
+      self.emit :websocket_open
+    end
+
+    def handle_websocket_message(event)
+      Thread.new do
+        begin
+          handle_websocket_close(event) and next if event.type == :close
+          next unless event.type == :text
+
+          object = MultiJson.load event.data
+
+          handler_klass = Ari.const_get object['type'] rescue nil
+          next unless handler_klass
+          event_name = object['type'].gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
+
+          instances = self.class.instance_listeners[event_name.to_sym]
+          
+          event_properties = (handler_klass.instance_methods - Ari::Event.instance_methods)
+          event_properties.reject! { |p| p.to_s.end_with? '=' }
+          handler = handler_klass.new(object.merge(client: self))
+          event_model_ids = event_properties.map { |p| handler.send(p).id rescue nil }.compact
+          [*instances].each do |instance|
+            if event_model_ids.include? instance.id
+              emit "#{event_name}-#{instance.id}", handler
+            end
+          end
+
+          self.emit event_name, handler_klass.new(object.merge(client: self))
+        rescue => err
+          emit :websocket_error, err
+        end
+      end
+    end
+
+    def handle_websocket_error(err)
+      self.emit :websocket_error, err
+    end
+
+    def handle_websocket_close(event)
+      self.emit :websocket_close, event
+    end
+
+    def send_request(request)
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      response = http.request(request)
+      if response.body and !response.body.empty?
+        object = MultiJson.load response.body
+      else
+        object = true
+      end
+      if response.kind_of? Net::HTTPClientError
+        raise Ari::RequestError.new(response.code), (object['message'] || object['error'])
+      elsif response.kind_of? Net::HTTPServerError
+        raise Ari::ServerError.new(response.code), (object['message'] || object['error'])
+      end
+      object
+    end
+
+    def self.instance_listeners
+      @instance_listeners ||= {}
+      @instance_listeners
+    end
+
+  end
+end

data/lib/ari/generators/api.rb

@@ -0,0 +1,23 @@
+module Ari
+  module Generators
+    class Api
+
+      def initialize(specification)
+        @specification = specification
+      end
+
+      def path
+        @specification['path'].gsub(/(\{[A-z]*\})/) { "%#{$1}" }
+      end
+
+      def description
+        @specification['description']
+      end
+
+      def operations
+        @operations ||= @specification['operations'].map { |op| Operation.new(op) }
+      end
+
+    end
+  end
+end

data/lib/ari/generators/attribute.rb

@@ -0,0 +1,35 @@
+module Ari
+  module Generators
+    class Attribute
+
+      def initialize(specification)
+        @specification = specification
+      end
+
+      def name
+        @specification['name']
+      end
+
+      def description
+        @specification['description']
+      end
+
+      def location
+        @specification['paramType']
+      end
+
+      def required?
+        @specification['required']
+      end
+
+      def multiple?
+        @specification['allowMultiple']
+      end
+
+      def type
+        @specification['dataType']
+      end
+
+    end
+  end
+end