[VOICE-775] Add voice namespace and phone_number resource.

This commit adds a `Voice::PhoneNumber` resource, and a way to call `client.voice.phone_numbers.create(...)` etc. This is achieved using a `Delegator` class to forward method calls after the `voice` namespace back to the client object to be handled by `method_missing`.

Author: ciaranarcher

lib/zendesk_api/association.rb

@@ -1,7 +1,7 @@
 require 'zendesk_api/helpers'
 
 module ZendeskAPI
- # Represents an association between two resources 
+ # Represents an association between two resources
  # @private
  class Association
  # @return [Hash] Options passed into the association
@@ -10,7 +10,7 @@ class Association
  # Options to pass in
  # * class - Required
  # * parent - Parent instance
- # * path - Optional path instead of resource name 
+ # * path - Optional path instead of resource name
  def initialize(options = {})
  @options = Hashie::Mash.new(options)
  end
@@ -32,7 +32,7 @@ def generate_path(*args)
  instance = args.first
 
  namespace = @options[:class].to_s.split("::")
- namespace.delete("ZendeskAPI")
+ %w(ZendeskAPI Voice).each { |ns| namespace.delete(ns) }
  has_parent = namespace.size > 1 || (options[:with_parent] && @options.parent)
 
  if has_parent

lib/zendesk_api/client.rb

@@ -15,6 +15,7 @@
 require 'zendesk_api/middleware/response/parse_iso_dates'
 require 'zendesk_api/middleware/response/raise_error'
 require 'zendesk_api/middleware/response/logger'
+require 'zendesk_api/delegator'
 
 module ZendeskAPI
  # The top-level class that handles configuration and connection to the Zendesk API.
@@ -33,11 +34,13 @@ def method_missing(method, *args, &block)
  options = args.last.is_a?(Hash) ? args.pop : {}
 
  @resource_cache[method] ||= { :class => nil, :cache => ZendeskAPI::LRUCache.new }
-
  if !options.delete(:reload) && (cached = @resource_cache[method][:cache].read(options.hash))
  cached
  else
- @resource_cache[method][:class] ||= ZendeskAPI.const_get(ZendeskAPI::Helpers.modulize_string(Inflection.singular(method)))
+ klass_as_const = ZendeskAPI::Helpers.modulize_string(Inflection.singular(method))
+ klass = class_from_namespace(klass_as_const)
+
+ @resource_cache[method][:class] ||= klass
  @resource_cache[method][:cache].write(options.hash, ZendeskAPI::Collection.new(self, @resource_cache[method][:class], options))
  end
  end
@@ -109,6 +112,10 @@ def self.check_deprecated_namespace_usage(attributes, name)
  end
  end
 
+ def voice
+ Delegator.new(self)
+ end
+
  protected
 
  # Called by {#connection} to build a connection. Can be overwritten in a
@@ -158,6 +165,16 @@ def build_connection
 
  private
 
+ def class_from_namespace(klass_as_const)
+ [ZendeskAPI, ZendeskAPI::Voice].each do |ns|
+ if ns.const_defined?(klass_as_const)
+ return ns.const_get(klass_as_const)
+ end
+ end
+
+ nil
+ end
+
  def check_url
  if !config.allow_http && config.url !~ /^https/
  raise ArgumentError, "zendesk_api is ssl only; url must begin with https://"

lib/zendesk_api/delegator.rb

@@ -0,0 +1,4 @@
+module ZendeskAPI
+ class Delegator < SimpleDelegator; end
+end
+

lib/zendesk_api/resources.rb

@@ -466,4 +466,10 @@ def self.singular_resource_name
  end
 
  class Target < Resource; end
+
+ module Voice
+ class PhoneNumber < Resource
+ namespace "channels/voice"
+ end
+ end
 end

spec/core/client_spec.rb

@@ -19,7 +19,7 @@ def build_connection
  ZendeskAPI::Client.new do |config|
  config.url = "http://www.google.com"
  end
- end.to raise_error(ArgumentError) 
+ end.to raise_error(ArgumentError)
  end
 
  it "should not raise an exception when url isn't ssl and allow_http is set to true" do
@@ -115,7 +115,7 @@ def build_connection
 
  context "#logger" do
  before(:each) do
- @client = ZendeskAPI::Client.new do |config| 
+ @client = ZendeskAPI::Client.new do |config|
  config.url = "https://example.zendesk.com/"
  config.logger = subject
  end
@@ -232,4 +232,15 @@ def build_connection
  client.connection.should == "FOO"
  client.connection.object_id.should == client.connection.object_id # it's cached
  end
+
+ context ZendeskAPI::Voice do
+ it "defers to voice delegator" do
+ ZendeskAPI::Client.any_instance.should_receive(:phone_numbers).once
+ subject.voice.phone_numbers
+ end
+
+ it "manages namespace correctly" do
+ ZendeskAPI::Voice::PhoneNumber.new(subject, {}).path.should match(/channels\/voice\/phone_numbers/)
+ end
+ end
 end

spec/live/voice/phone_number_spec.rb

@@ -0,0 +1,11 @@
+describe ZendeskAPI::Voice::PhoneNumber, :delete_after do
+ def valid_attributes
+ {:number => "+14434064759", :country_code => "US", :toll_free => "false"}
+ end
+
+ it_should_be_creatable
+ it_should_be_updatable :nickname
+ it_should_be_updatable :transcription
+ it_should_be_updatable :recorded
+ it_should_be_deletable
+end