asterisk-ari 0.0.1

data/lib/ari/errors.rb

@@ -0,0 +1,38 @@
+module ARI
+
+  class ARIError < StandardError; end
+
+  class Error < ARIError
+    attr_accessor :error_info, :response_body
+
+    def initialize(response_body = "", error_info = nil)
+      if response_body &&  response_body.is_a?(String)
+        @response_body = response_body.strip
+      else
+        @response_body = ''
+      end
+      if error_info.nil?
+        begin
+          error_info = ARI::JSON.load(response_body.to_s)
+        rescue
+          error_info ||= {}
+        end
+      end
+      @error_info = error_info
+      message = @response_body
+      super(message)
+    end
+  end
+
+  # handle 5xx response
+  class ServerError < Error
+    def initialize(response_body, error_info)
+      @response_body = response_body
+      @error_info = error_info
+    end
+  end
+
+  # handle 4xx response
+  class APIError < Error; end
+
+end

data/lib/ari/http_services.rb

@@ -0,0 +1,87 @@
+require "ari/json"
+require "ari/response"
+require "cgi"
+
+module ARI
+   module HTTPService
+
+    def self.included(base)
+      base.class_eval do
+        def self.server(options = {})
+          options[:host]
+        end
+      end# end class_eval
+    end
+  end
+
+  module NetHTTPService
+    require "net/http" unless defined?(Net::HTTP)
+    require "net/https"
+
+    METHODS = {
+      :get    => Net::HTTP::Get,
+      :post   => Net::HTTP::Post,
+      :put    => Net::HTTP::Put,
+      :delete => Net::HTTP::Delete
+    }
+
+    def self.included(base)
+      base.class_eval do
+
+        include ARI::HTTPService
+
+        def self.make_request(path, args, verb, options = {})
+          args.merge!({:method => verb})
+
+          http = create_http(server(options), options)
+          http.use_ssl = true if options[:port].to_i == 443
+
+          result = http.start do |http|
+            request = case verb.to_sym
+              when :get
+                METHODS[verb.to_sym].new "#{path}?#{encode_params(args)}"
+              else
+                request = METHODS[verb.to_sym].new path
+                request.set_form_data args
+                request
+              end
+            # basic auth
+            if options[:username] && options[:password]
+              request.basic_auth(options[:username], options[:password])
+            end
+            response, body = http.request(request)
+            ARI::Response.new(response.code.to_i, response.body, response)
+          end
+        end
+
+        protected
+
+          def self.encode_params(param_hash)
+            ((param_hash || {}).collect do |key_and_value|
+              key_and_value[1] = ARI::JSON.dump(key_and_value[1]) if key_and_value[1].class != String
+              "#{key_and_value[0].to_s}=#{CGI.escape key_and_value[1]}"
+            end).join("&")
+          end
+
+          def self.create_http(server, options)
+            if options[:proxy]
+              proxy = URI.parse(options[:proxy])
+              http  = Net::HTTP.new \
+                server, options[:port],
+                proxy.host, proxy.port,
+                proxy.user, proxy.password
+            else
+              http = Net::HTTP.new server, options[:port]
+            end
+            if options[:timeout]
+              http.open_timeout = options[:timeout]
+              http.read_timeout = options[:timeout]
+            end
+            http
+          end
+
+      end
+    end
+  end
+
+end

data/lib/ari/json.rb

@@ -0,0 +1,23 @@
+require "multi_json"
+
+module ARI
+  module JSON
+
+    def self.dump(*args)
+      if MultiJson.respond_to?(:dump)
+        MultiJson.dump(*args)
+      else
+        MultiJson.encode(*args)
+      end
+    end
+
+    def self.load(*args)
+      if MultiJson.respond_to?(:load)
+        MultiJson.load(*args)
+      else
+        MultiJson.decode(*args)
+      end
+    end
+
+  end
+end

data/lib/ari/response.rb

@@ -0,0 +1,18 @@
+module ARI
+  # @!attribute [r] status
+  #   @return [Integer] http status
+  # @!attribute [r] body
+  #   @return [String] response body
+  # @!attribute [r] headers
+  #   @return [String] response headers
+  class Response
+
+    def initialize(status, body, headers)
+      @status  = status
+      @body    = body
+      @headers = headers
+    end
+    attr_reader :status, :body, :headers
+
+  end
+end

data/lib/ari/version.rb

@@ -0,0 +1,3 @@
+module ARI
+  VERSION = "0.0.1"
+end

data/spec/ari/client_spec.rb

@@ -0,0 +1,158 @@
+require "spec_helper"
+
+describe ARI::Client do
+  before(:each) do
+    @client ||= ARI::Client.new({
+      :host     => SPEC_CONF["host"],
+      :port     => SPEC_CONF["port"],
+      :username => SPEC_CONF["username"],
+      :password => SPEC_CONF["password"]
+    })
+  end
+
+  it "has an attr_reader for host" do
+    @client.host.should == SPEC_CONF["host"]
+  end
+
+  it "has an attr_reader for port" do
+    @client.port.should == SPEC_CONF["port"]
+  end
+
+  it "has an attr_reader for username" do
+    @client.username.should == SPEC_CONF["username"]
+  end
+
+  it "has an attr_reader for password" do
+    @client.password.should == SPEC_CONF["password"]
+  end
+
+  context "api request", :vcr do
+    describe "#asterisk_get_info" do
+      it "returns data" do
+        result = @client.asterisk_get_info
+        result["build"].nil?.should == false
+      end
+    end
+    context "global_var" do
+      describe "#asterisk_set_global_var and #asterisk_get_global_var" do
+        it "returns data" do
+          key = "FOO"
+          value = "BAR"
+          result = @client.asterisk_set_global_var({:variable => key, :value => value})
+          result.should == ""
+          result = @client.asterisk_get_global_var({:variable => key})
+          result["value"].should == value
+        end
+      end
+    end
+
+    describe "#bridges_list" do
+      it "returns data" do
+        result = @client.bridges_list
+        result.is_a?(Array).should == true
+      end
+    end
+
+    describe "#bridges_create" do
+      it "returns data" do
+        bridge_id = "1409571774"
+        bridge_name = "bridge_name"
+        bridge_type = "mixing"
+        result = @client.bridges_create({:type => "mixing", :bridgeId => bridge_id, :name => bridge_name})
+        result["bridge_type"].should == bridge_type
+        result["id"].should == bridge_id
+        result["name"].should == bridge_name
+
+        new_bridge_type = "holding"
+        result = @client.bridges_create_or_update_with_id(bridge_id, {:type => new_bridge_type})
+        result["bridge_type"].should == new_bridge_type
+        result["id"].should == bridge_id
+        # result["name"].should == bridge_name
+
+        result = @client.bridges_get(bridge_id)
+        result["bridge_type"].should == new_bridge_type
+        result["id"].should == bridge_id
+        # result["name"].should == bridge_name
+
+        result = @client.bridges_destroy(bridge_id)
+        result.should == ""
+      end
+    end
+
+    describe "#channels_list" do
+      it "returns data" do
+        result = @client.channels_list
+        result.is_a?(Array).should == true
+      end
+    end
+
+    describe "#endpoints_list" do
+      it "returns data" do
+        result = @client.endpoints_list
+        result.is_a?(Array).should == true
+      end
+    end
+
+    describe "#endpoints_send_message" do
+      it "returns data" do
+        result = @client.endpoints_send_message({:to => "SIP", :from => "IAX2", :body => "body"})
+        result.should == ""
+      end
+    end
+
+    describe "#endpoints_list_by_tech" do
+      it "returns data" do
+        result = @client.endpoints_list_by_tech("SIP")
+        result.is_a?(Array).should == true
+      end
+    end
+
+    describe "#recordings_list_stored" do
+      it "returns data" do
+        result = @client.recordings_list_stored
+        result.is_a?(Array).should == true
+      end
+    end
+
+    describe "#sounds_list" do
+      context "without params" do
+        it "returns data" do
+          result = @client.sounds_list
+          result.is_a?(Array).should == true
+        end
+      end
+      context "with params" do
+        it "returns data" do
+          result = @client.sounds_list({:lang => "en"})
+          result.is_a?(Array).should == true
+        end
+      end
+    end
+
+    describe "#sounds_get" do
+      it "returns data" do
+        id = "vm-torerecord"
+        result = @client.sounds_get(id)
+        result["id"].should == id
+        result["text"].nil?.should == false
+        result["formats"].nil?.should == false
+      end
+    end
+
+    describe "#applications_list" do
+      it "returns data" do
+        result = @client.applications_list
+        result.is_a?(Array).should == true
+      end
+    end
+
+    describe "#device_states_list" do
+      it "returns data" do
+        result = @client.device_states_list
+        result.is_a?(Array).should == true
+      end
+    end
+
+  end
+
+end

data/spec/ari/errors_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe ARI::Error do
+  it "is a ARI::ARIError" do
+    ARI::Error.new(nil, nil).should be_a(ARI::ARIError)
+  end
+end
+
+describe ARI::ARIError do
+  it "is a StandardError" do
+    ARI::ARIError.new.should be_a(StandardError)
+  end
+end
+
+describe ARI::APIError do
+  it "is a ARI::APIError" do
+    ARI::APIError.new({}).should be_a(ARI::APIError)
+  end
+end
+
+describe ARI::ServerError do
+  it "is a ARI::Error" do
+    ARI::ServerError.new(nil, nil).should be_a(ARI::ServerError)
+  end
+end

data/spec/ari/http_service_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+class FakeHTTPService
+  include ARI::HTTPService
+end
+
+describe ARI::HTTPService do
+
+  describe "common methods" do
+    describe "server" do
+      it "should return the host" do
+        FakeHTTPService.server(:host => SPEC_CONF["host"]).should == SPEC_CONF["host"]
+      end
+    end
+
+  end
+
+end

data/spec/fixtures/vcr_cassettes/ARI_Client/api_request_applications_list_returns_data.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://asterisk:asterisk@127.0.0.1:8088/ari/applications?method=get
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Asterisk/12.5.0
+      Date:
+      - Mon, 01 Sep 2014 13:36:13 GMT
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, no-store
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '2'
+    body:
+      encoding: UTF-8
+      string: "[]"
+    http_version: 
+  recorded_at: Mon, 01 Sep 2014 13:36:13 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/vcr_cassettes/ARI_Client/api_request_asterisk_get_info_returns_data.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://asterisk:asterisk@127.0.0.1:8088/ari/asterisk/info?method=get
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Asterisk/12.5.0
+      Date:
+      - Mon, 01 Sep 2014 11:11:42 GMT
+      Connection:
+      - close
+      Cache-Control:
+      - no-cache, no-store
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '419'
+    body:
+      encoding: UTF-8
+      string: '{"config":{"default_language":"en","name":"","setid":{"group":"","user":""}},"build":{"os":"Linux","kernel":"3.13.0-34-generic","machine":"x86_64","user":"tk","options":"LOADABLE_MODULES,
+        BUILD_NATIVE, OPTIONAL_API","date":"2014-09-01 10:40:07 UTC"},"system":{"entity_id":"08:00:27:51:53:a7","version":"12.5.0"},"status":{"startup_time":"2014-09-01T20:10:30.620+0900","last_reload_time":"2014-09-01T20:10:30.620+0900"}}'
+    http_version: 
+  recorded_at: Mon, 01 Sep 2014 11:11:42 GMT
+recorded_with: VCR 2.9.2