ahn-restful-rpc 0.1.0

data/config/ahn-restful-rpc.yml

@@ -0,0 +1,34 @@
+# Use path_nesting to specify an arbitrarily nested. Could be used for additional security or in HTTP reverse proxy server.
+path_nesting: /
+
+port: 5000
+
+# The "handler" option here can be any valid Rack::Handler constant name.
+# Other options: WEBrick, EventedMongrel.
+# If you don't know the differences between these, "Mongrel" is definitely a good choice.
+handler: WEBrick
+
+# In a production system, you should make this "false" since
+show_exceptions: true
+
+# The "authentication" config option can either be "false" or key/value pairs representing allowed usernames and passwords.
+
+#authentication: false
+authentication:
+  jicksta: roflcopterz
+  foo: bar6213671682
+
+access: everyone   # When allowing "everyone" access, no IPs are blocked.
+#access: whitelist # When using a whitelist, the "whitelist" data below will be used.
+#access: blacklist # When using a blacklist, the "blacklist" data below will be used.
+
+# This is a list of IPs which are exclusively allowed to call this web service.
+# Note: whitelists are far more secure than blacklists.
+whitelist:
+  - 127.0.0.1
+  - 192.168.*.*
+
+# This is a list of the IPs which are explicitly NOT allowed to call this web service. This will only be used if "access" is
+# set to "blacklist" above.
+blacklist:
+  - 100.200.100.200

data/lib/ahn-restful-rpc.rb

@@ -0,0 +1,105 @@
+begin
+  require 'rack'
+  require 'json'
+rescue LoadError
+  abort "ERROR: restful_rpc requires the 'rack' and 'json' gems"
+end
+
+# Don't you love regular expressions? Matches only 0-255 octets. Recognizes "*" as an octet wildcard.
+VALID_IP_ADDRESS = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|\*)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|\*)$/
+
+def ip_allowed?(ip)
+  raise ArgumentError, "#{ip.inspect} is not a valid IP address!" unless ip.kind_of?(String) && ip =~ VALID_IP_ADDRESS
+
+  octets = ip.split "."
+
+  case COMPONENTS.restful_rpc["access"]
+    when "everyone"
+      true
+    when "whitelist"
+      whitelist = COMPONENTS.restful_rpc["whitelist"]
+      !! whitelist.find do |pattern|
+        pattern_octets = pattern.split "."
+        # Traverse both arrays in parallel
+        octets.zip(pattern_octets).map do |octet, octet_pattern|
+          octet_pattern == "*" ? true : (octet == octet_pattern)
+        end == [true, true, true, true]
+      end
+    when "blacklist"
+      blacklist = COMPONENTS.restful_rpc["blacklist"]
+      ! blacklist.find do |pattern|
+        pattern_octets = pattern.split "."
+        # Traverse both arrays in parallel
+        octets.zip(pattern_octets).map do |octet, octet_pattern|
+          octet_pattern == "*" ? true : (octet == octet_pattern)
+        end == [true, true, true, true]
+      end
+    else
+      raise Adhearsion::Components::ConfigurationError, 'Unrecognized "access" configuration value!'
+  end
+end
+
+RESTFUL_API_HANDLER = lambda do |env|
+  json = env["rack.input"].read
+
+  # Return "Bad Request" HTTP error if the client forgot
+  return [400, {}, "You must POST a valid JSON object!"] if json.blank?
+
+  json = JSON.parse json
+
+  nesting = COMPONENTS.restful_rpc["path_nesting"]
+  path = env["PATH_INFO"]
+
+  return [404, {}, "This resource does not respond to #{path.inspect}"] unless path[0...nesting.size] == nesting
+
+  path = path[nesting.size..-1]
+
+  return [404, {"Content-Type" => "application/json"}, "You cannot nest method names!"] if path.include?("/")
+
+  rpc_object = Adhearsion::Components.component_manager.extend_object_with(Object.new, :rpc)
+
+  # TODO: set the content-type and other HTTP headers
+  response_object = rpc_object.send(path, *json)
+  [200, {"Content-Type" => "application/json"}, Array(response_object.to_json)]
+
+end
+
+initialization do
+  config = COMPONENTS.send :'ahn-restful-rpc'
+
+  api = RESTFUL_API_HANDLER
+
+  port            = config["port"] || 5000
+  authentication  = config["authentication"]
+  show_exceptions = config["show_exceptions"]
+  handler         = Rack::Handler.const_get(config["handler"] || "Mongrel")
+
+  if authentication
+    api = Rack::Auth::Basic.new(api) do |username, password|
+      authentication[username] == password
+    end
+    api.realm = "Adhearsion API"
+  end
+
+  if show_exceptions
+    api = Rack::ShowStatus.new(Rack::ShowExceptions.new(api))
+  end
+
+  Thread.new do
+    handler.run api, :Port => port
+  end
+end
+
+methods_for :rpc do
+  [:send_action, :introduce, :originate, :call_into_context, :call_and_exec, :ping].each do |method_name|
+    define_method("restful_#{method_name}") do |*args|
+      if VoIP::Asterisk.manager_interface
+        response = VoIP::Asterisk.manager_interface.send(method_name, *args)
+        {:result => true}
+      else
+        ahn_log.ami_remote.error "AMI has not been enabled in startup.rb!"
+        {:result => false}
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: ahn-restful-rpc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jay Phillips
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-26 00:00:00.000000000 +01:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: adhearsion
+  requirement: &2156809400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156809400
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2156808940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156808940
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2156808520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156808520
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156808100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156808100
+description: Allows remote procedure calls over an HTTP API integrated in Adhearsion
+email: dev&adhearsion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ahn-restful-rpc.rb
+- config/ahn-restful-rpc.yml
+has_rdoc: false
+homepage: https://github.com/adhearsion/ahn-restful-rpc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 2
+summary: Provides a RESTful RPC API on Adhearsion
+test_files: []