tropo-provisioning 0.0.21 → 0.0.22

data/tropo-provisioning.gemspec

@@ -1,70 +1,35 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'tropo-provisioning/version'
+
 Gem::Specification.new do |s|
-  s.name = %q{tropo-provisioning}
-  s.version = "0.0.21"
+  s.name = "tropo-provisioning"
+  s.version = TropoProvisioning::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jason Goecke"]
-  s.date = %q{2010-07-28}
+  s.authors = ["Jason Goecke", "Juan de Bravo"]
+  s.email = ["jsgoecke@voxeo.com", "juandebravo@gmail.com"]
+
+  s.date = %q{2011-09-05}
   s.description = %q{Library for interacting with the Tropo Provisioning API}
-  s.email = %q{jsgoecke@voxeo.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/tropo-provisioning.rb",
-     "lib/tropo-provisioning/tropo-provisioning.rb",
-     "lib/tropo-provisioning/error.rb",
-     "tropo-provisioning.gemspec"
-  ]
-  s.homepage = %q{http://github.com/tropo/tropo-provisioning}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Library for interacting with the Tropo Provisioning API}
-  s.test_files = [
-    "spec/live-tropo-provisioning_spec.rb",
-     "spec/spec_helper.rb",
-     "spec/tropo-provisioning_spec.rb",
-     "spec/live-tropo-provisioning_spec.rb",
-     "examples/create_address.rb",
-     "examples/create_user.rb",
-     "examples/create_application.rb",
-     "examples/delete_application.rb",
-     "examples/list_addresses.rb",
-     "examples/list_applications.rb",
-     "examples/list_exchanges.rb",
-     "examples/list_pin.rb",
-     "examples/update_application.rb"
-  ]
+  
+  s.rubyforge_project = "tropo-provisioning"
+  
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {examples,test,spec,features}/*`.split("\n")
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.homepage = %q{http://github.com/tropo/tropo-provisioning}
+  s.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_runtime_dependency(%q<hashie>, [">= 0.2.1"])
-      s.add_runtime_dependency(%q<activesupport>)
-    else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_dependency(%q<hashie>, [">= 0.2.1"])
-      s.add_dependency(%q<activesupport>)
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    s.add_dependency(%q<hashie>, [">= 0.2.1"])
-    s.add_dependency(%q<activesupport>)
-  end
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("fakeweb")
+  s.add_development_dependency("yard")
+  s.add_development_dependency("rdoc")
+    
+  s.add_runtime_dependency("hashie", ">= 0.2.1")
+  s.add_runtime_dependency("activesupport")
+  s.add_runtime_dependency("i18n")
 end
 

metadata

@@ -1,31 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: tropo-provisioning
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
   prerelease: 
 platform: ruby
 authors:
 - Jason Goecke
+- Juan de Bravo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2010-07-28 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-09-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70360335704620 !ruby/object:Gem::Requirement
+  requirement: &70361391690020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.9
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70361391690020
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70361391688520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70361391688520
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70361391687380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70361391687380
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70361391686800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70360335704620
+  version_requirements: *70361391686800
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70360335704140 !ruby/object:Gem::Requirement
+  requirement: &70361391686000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +66,21 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70360335704140
+  version_requirements: *70361391686000
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70360335703760 !ruby/object:Gem::Requirement
+  requirement: &70361391685240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70361391685240
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70361391684580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,42 +88,60 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70360335703760
+  version_requirements: *70361391684580
 description: Library for interacting with the Tropo Provisioning API
-email: jsgoecke@voxeo.com
+email:
+- jsgoecke@voxeo.com
+- juandebravo@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
-- lib/tropo-provisioning.rb
-- lib/tropo-provisioning/tropo-provisioning.rb
-- lib/tropo-provisioning/error.rb
-- tropo-provisioning.gemspec
-- spec/live-tropo-provisioning_spec.rb
-- spec/spec_helper.rb
-- spec/tropo-provisioning_spec.rb
+- examples/app_details.yml
+- examples/authenticate_account.rb
+- examples/config.yml
 - examples/create_address.rb
-- examples/create_user.rb
 - examples/create_application.rb
+- examples/create_invitation.rb
+- examples/create_user.rb
 - examples/delete_application.rb
+- examples/delete_applications.rb
+- examples/get_balance.rb
 - examples/list_addresses.rb
 - examples/list_applications.rb
+- examples/list_applications_with_addresses.rb
 - examples/list_exchanges.rb
+- examples/list_features.rb
+- examples/list_invitations.rb
+- examples/list_partitions_platforms.rb
+- examples/list_payment_method.rb
+- examples/list_payment_methods.rb
 - examples/list_pin.rb
+- examples/list_user.rb
+- examples/modify_user.rb
 - examples/update_application.rb
-has_rdoc: true
+- examples/update_invitation.rb
+- examples/users_search.rb
+- lib/tropo-provisioning.rb
+- lib/tropo-provisioning/tropo_client.rb
+- lib/tropo-provisioning/tropo_error.rb
+- lib/tropo-provisioning/tropo_provisioning.rb
+- lib/tropo-provisioning/version.rb
+- spec/live-tropo-provisioning_spec.rb
+- spec/spec_helper.rb
+- spec/tropo-provisioning_spec.rb
+- tropo-provisioning.gemspec
 homepage: http://github.com/tropo/tropo-provisioning
 licenses: []
 post_install_message: 
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -95,22 +157,37 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.6.2
+rubyforge_project: tropo-provisioning
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Library for interacting with the Tropo Provisioning API
 test_files:
-- spec/live-tropo-provisioning_spec.rb
-- spec/spec_helper.rb
-- spec/tropo-provisioning_spec.rb
-- spec/live-tropo-provisioning_spec.rb
+- examples/app_details.yml
+- examples/authenticate_account.rb
+- examples/config.yml
 - examples/create_address.rb
-- examples/create_user.rb
 - examples/create_application.rb
+- examples/create_invitation.rb
+- examples/create_user.rb
 - examples/delete_application.rb
+- examples/delete_applications.rb
+- examples/get_balance.rb
 - examples/list_addresses.rb
 - examples/list_applications.rb
+- examples/list_applications_with_addresses.rb
 - examples/list_exchanges.rb
+- examples/list_features.rb
+- examples/list_invitations.rb
+- examples/list_partitions_platforms.rb
+- examples/list_payment_method.rb
+- examples/list_payment_methods.rb
 - examples/list_pin.rb
+- examples/list_user.rb
+- examples/modify_user.rb
 - examples/update_application.rb
+- examples/update_invitation.rb
+- examples/users_search.rb
+- spec/live-tropo-provisioning_spec.rb
+- spec/spec_helper.rb
+- spec/tropo-provisioning_spec.rb

data/VERSION

@@ -1 +0,0 @@
-0.0.19

data/lib/tropo-provisioning/error.rb

@@ -1,7 +0,0 @@
-class ProvisioningApiRuntimeError < RuntimeError
-  attr_reader :http_status
-  
-  def initialize(http_status)
-    @http_status = http_status
-  end
-end

data/lib/tropo-provisioning/tropo-provisioning.rb

@@ -1,864 +0,0 @@
-class TropoProvisioning
-  
-  # Defaults for the creation of applications
-  DEFAULT_OPTIONS = { :partition => 'staging', :platform  => 'scripting' }
-  
-  attr_reader :user_data
-  
-  ##
-  # Creates a new TropoProvisioning object
-  #
-  # @param [required, String] username for your Tropo user
-  # @param [required, String] password for your Tropo user
-  # @param [optional, Hash] params 
-  # @option params [optional, String] :base_uri to use for accessing the provisioning API if you would like a custom one
-  # @return [Object] a TropoProvisioning object
-  def initialize(username, password, params={})   
-    @username            = username
-    @password            = password
-    @base_uri            = params[:base_uri] || "http://api.tropo.com/v1"
-    @headers             = { 'Content-Type' => 'application/json' }
-    user(username)
-  end
-    
-  def account(username, password)
-    case current_method_name
-    when 'account'
-      action = 'get'
-    when 'authenticate_account'
-      action = 'authenticate'
-    end
-    temp_request(:get, "/#{action}.jsp?username=#{username}&password=#{password}")
-  end
-  alias :authenticate_account :account
-  
-  ##
-  # Obtain information about a user
-  #
-  # @param [required, String] the user ID or username to obtain the account details of
-  # @return [Hash]
-  #   contains the information on the user
-  def user(user_identifier)
-    result = request(:get, { :resource => 'users/' + user_identifier })
-    if result['username']
-      # Only add/update this if we are fetching the user we are logged in as
-      @user_data = result if result['username'].downcase == @username.downcase
-    end
-    result
-  end
-  
-  ##
-  # Confirms a user after they have been created. For example, you may want to email your user to make
-  # sure they are real before activating the user.
-  #
-  # @param [required, String] user_id returned when you created the user you now want to confirm
-  # @param [required, String] confirmation_key returned when you created the user you now want to confirm
-  # @param [required, String] the ip_address of the user client that did the confirmation
-  # @return [Hash]
-  #   contains a message key confirming the confirmation was successful
-  def confirm_user(user_id, confirmation_key, ip_address)
-    params = { :key => confirmation_key, :endUserHost => ip_address }
-    request(:post, { :resource => 'users/' + user_id + '/confirmations', :body => params })
-  end
-  
-  ##
-  # Creates a new user in a pending state. Once you receive the href/user_id/confirmation_key
-  # you may then invoke the confirm_user method once you have taken appropriate steps to confirm the
-  # user
-  #
-  # @param [required, Hash] params to create the user
-  # @option params [required, String] :username the name of the user to create the user for
-  # @option params [required, String] :password the password to use for the user
-  # @option params [required, String] :email the email address to use
-  # @option params [optional, String] :first_name of the user
-  # @option params [optional, String] :last_name of the user
-  # @option params [optional, String] :website the URL of the user's website
-  # @option params [optional, String] :organization of the user, such as a company name
-  # @option params [optional, String] :job_title of the user
-  # @option params [optional, String] :address of the user
-  # @option params [optional, String] :address2 second live of the address of the user
-  # @option params [optional, String] :city of the user
-  # @option params [optional, String] :state of the user
-  # @option params [optional, String] :postal_code of the user
-  # @option params [optional, String] :country of the user
-  # @option params [optional, String] :marketing_opt_in
-  # @option params [optional, String] :twitter_id
-  # @option params [optional, String] :joined_from_host IP address of the host they signed up from
-  # @return [Hash] details of the user created
-  #   includes the href, user_id and confirmation_key
-  # @raise [ArgumentError]
-  #   if missing the :username, :password or :email parameters
-  def create_user(params={})
-    validate_params(params, %w(username password email))
-    
-    # Set the Company Branding ID, or use default
-    params[:website] = 'tropo' unless params[:website]    
-    
-    result = request(:post, { :resource => 'users', :body => params })
-    result[:user_id] = get_element(result.href)
-    result[:confirmation_key] = result['confirmationKey']
-    result.delete('confirmationKey')
-    result
-  end
-
-  ##
-  # Modify/update an existing user
-  #
-  # @param [required, String] user_id of the user you would like to update
-  # @param [required, Hash] the parameters of the user you would like to update
-  # @return [Hash]
-  #   the href of the resource that was modified/updated
-  def modify_user(user_id, params={})
-    result = request(:put, { :resource => 'users/' + user_id, :body => params })
-    if result['href']
-      # Only add/update this if we are fetching the user we are logged in as
-      @user_data.merge!(params) if user_id == @user_data['id']
-    end
-    result
-  end
-  
-  ##
-  # Allows you to search users to find a list of users
-  #
-  # @param [required, String] a key/value of the search term you would like to use, such as 'username=foobar', or 'city=Orlando'
-  # @return [Array]
-  #   a hash containing an array of hashes with the qualifying account details
-  def search_users(search_term)
-    request(:get, { :resource => 'users/?' + search_term })
-  end
-
-  ##
-  # Allows you to search if a username exists or not
-  #
-  # @param [required, String] a username to check
-  # @return [Array]
-  #   a hash containing an array of hashes with the qualifying account details  
-  def username_exists?(username)
-    request(:get, { :resource => 'usernames/' + username })
-  end
-  
-  ##
-  # Fetches the payment information for a user
-  #
-  # @param [required, String] user_id to fetch the payment details for
-  # @return [Hash]
-  #   a hash containing the accountNumber, paymentType, paymentTypeName, rechargeAmount and rechargeThreshold
-  def user_payment_method(user_id)
-    result = request(:get, { :resource => 'users/' + user_id + '/payment/method'})
-    result.merge!({ :id => get_element(result.paymentType) })
-    result
-  end
-  
-  ##
-  # Lists the available payment types
-  #
-  # @return [Hash]
-  #   an array of available payment types that each include an id, href and name
-  def available_payment_types
-    request(:get, { :resource => 'types/payment' })
-  end
-  
-  ##
-  # Obtain the current balance of a user
-  #
-  # @param [required, String] user_id of the user to obtain the balance for
-  # @return [Hash]
-  #   the balance, pendingRechargeAmount and pendingUsageAmount for the user account
-  def balance(user_id)
-    request(:get, { :resource => 'users/' + user_id + '/usage'})
-  end
-  
-  ##
-  # Return the list of available countries
-  #
-  # @return [Hash]
-  #   returns an Array of hashes that include the country details available
-  def countries
-    result = request(:get, { :resource => 'countries' })
-    add_ids(result)
-  end
-  
-  ##
-  # Return the list of available states for a country
-  #
-  # @return [Hash]
-  #   returns an Array of hashes that include the state details for a country that are available
-  def states(id)
-    result = request(:get, { :resource => 'countries' + "/#{id}/" + 'states' })
-    add_ids(result)
-  end
-  
-  ##
-  # Lists the available features
-  #
-  # @return [Hash]
-  #   an array of available features that each include an id, href, name and description
-  def features
-    request(:get, { :resource => 'features' })
-  end
-
-  ##
-  # Lists the features configured for a user
-  #
-  # @return [Hash]
-  #   an array of available features that each include an href, feature and featureName
-  def user_features(user_id)
-    request(:get, { :resource => 'users/' + user_id + '/features' })
-  end
-  
-  ##
-  # Enable a particular feature for a user
-  #
-  # @param [required, String] user_id of the user to add the feature to
-  # @param [required, String] feature identifier of the feature you want to add
-  # @return [Hash]
-  #   the href of the feature added
-  def user_enable_feature(user_id, feature)
-    request(:post, { :resource => 'users/' + user_id + '/features', :body => { :feature => feature } })
-  end
-  
-  ##
-  # Disable a particular feature for a user
-  #
-  # @param [required, String] user_id of the user to disable the feature to
-  # @param [required, String] feature number of the feature you want to disable
-  # @return [Hash]
-  #   the href of the feature disable
-  def user_disable_feature(user_id, feature_number)
-    request(:delete, { :resource => 'users/' + user_id + '/features/' + feature_number  })
-  end
-  
-  ##
-  # Add/modify payment info for a user
-  #
-  # @param [required, String] user_id to add the payment details for
-  # @param [require, Hash] params the params to add the payment info
-  # @option params [required, String] :account_number the credit card number
-  # @option params [required, String] :payment_type the type, such as visa, mastercard, etc
-  # @option params [required, String] :address 
-  # @option params [optional, String] :address2
-  # @option params [required, String] :city
-  # @option params [required, String] :state
-  # @option params [required, String] :postal_code
-  # @option params [required, String] :country
-  # @option params [optional, String] :email
-  # @option params [required, String] :name_on_account name on the credit card
-  # @option params [required, String] :expiration_date expiration date of the credit card
-  # @option params [required, String] :security_code back panel/front panel (Amex) code on the card
-  # @option params [optional, String] :phone_number
-  # @return [Hash]
-  #   the href of the payment method added
-  # @raise [ArgumentError]
-  #   if a required param is not present
-  def add_payment_info(user_id, params={})
-    #validate_params(params, %w(account_number payment_type address city state postal_code country name_on_account expiration_date security_code recharge_amount email phone_number))
-    
-    result = request(:put, { :resource => 'users/' + user_id + '/payment/method', :body => params })
-    result
-  end
-  alias :modify_payment_info :add_payment_info
-  
-  ##
-  # Add/modify recurring fund amount and threshold
-  # 
-  # @param [required, String] user_id to add the payment details for
-  # @param [require, Hash] params the params to add the recurrence
-  # @option params [required, Float] :recharge_amount
-  # @option params [required, Float] :recharge_threshold
-  #
-  # @return [Hash]
-  def update_recurrence(user_id, params={})
-    validate_params(params, %w(recharge_amount threshold_percentage))
-    
-    result = request(:put, { :resource => 'users/' + user_id + '/payment/recurrence', :body => params })
-  end
-  
-  ##
-  # Add/modify recurring fund amount and threshold
-  # 
-  # @param [required, String] user_id to get the recurrence info for
-  #
-  # @return [Hash]
-  def get_recurrence(user_id)
-    result = request(:get, { :resource => 'users/' + user_id + '/payment/recurrence' })
-  end
-  
-  ##
-  # Makes a payment on behalf of a user
-  #
-  # @param [required, String] the user_id to make the payment for
-  # @param [required, Float] the amount, in US Dollars to make the payment for
-  # @return [Hash]
-  #   a message with the success or failure of the payment
-  def make_payment(user_id, amount)
-    raise ArgumentError, 'amount must be of type Float' if amount.instance_of?(Float) == false
-    
-    request(:post, { :resource => 'users/' + user_id + '/payments', :body => { :amount => amount } })
-  end
-  
-  ##
-  # Creates an address to an existing application
-  #
-  # @param [required, String] application_id to add the address to
-  # @param [required, Hash] params the parameters used to request the address
-  # @option params [String] :type this defines the type of address. The possibles types are number (phone numbers), pin (reserved), token, aim, jabber, msn, yahoo, gtalk & skype
-  # @option params [String] :prefix this defines the country code and area code for phone numbers
-  # @option params [String] :username the messaging/IM account's username
-  # @option params [String] :password the messaging/IM account's password
-  # @return [Hash] params the key/values that make up the application
-  # @option params [String] :href identifies the address that was added, refer to address method for details
-  # @option params [String] :address the address that was created
-  def create_address(application_id, params={})
-    validate_address_parameters(params)
-    
-    result = request(:post, { :resource => 'applications/' + application_id.to_s + '/addresses', :body => params })
-    result[:address] = get_element(result.href)
-    result
-  end
-  
-  ##
-  # Get a specific application
-  #
-  # @param [required, String] application_id of the application to get
-  # @return [Hash] params the key/values that make up the application
-  # @option params [String] :href the REST address for the application
-  # @option params [String] :name the name of the application
-  # @option params [String] :voiceUrl the URL that powers voice calls for your application
-  # @option params [String] :messagingUrl the URL that powers the SMS/messaging calls for your session
-  # @option params [String] :platform defines whether the application will use the Scripting API or the Web API
-  # @option params [String] :partition defines whether the application is in staging/development or production
-  def application(application_id)
-    app = request(:get, { :resource => 'applications/' + application_id.to_s })
-    app.merge!({ :application_id => get_element(app.href) })
-  end
-    
-  ##
-  # Fetches all of the applications configured for a user
-  #
-  # @return [Hash] contains the results of the inquiry with a list of applications for the authenticated user, refer to the application method for details
-  def applications
-    results = request(:get, { :resource => 'applications' })
-    result_with_ids = []
-    results.each do |app|
-      result_with_ids << app.merge!({ :application_id => get_element(app.href) })
-    end
-    result_with_ids
-  end
-  
-  ##
-  # Fetches the application(s) with the associated addresses in the hash
-  #
-  # @param [optional, String] application_id will return a single application with addresses if present
-  # @return [Hash] contains the results of the inquiry with a list of applications for the authenticated user, refer to the application method for details
-  def applications_with_addresses(application_id=nil)
-    if application_id
-      associate_addresses_to_application(application(application_id))
-    else
-      apps = []
-      applications.each do |app|
-        apps << associate_addresses_to_application(app)
-      end
-      apps
-    end
-  end
-  alias :application_with_address :applications_with_addresses
-  
-  ##
-  # Create a new application
-  #
-  # @param [required, Hash] params to create the application
-  # @option params [required, String] :name the name to assign to the application
-  # @option params [required, String] :partition this defines whether the application is in staging/development or production
-  # @option params [required, String] :platform (scripting) whether to use scripting or the webapi
-  # @option params [required, String] :messagingUrl or :messaging_url The URL that powers the SMS/messages sessions for your application
-  # @option params [optional, String] :voiceUrl or :voice_url the URL that powers voices calls for your application
-  # @return [Hash] returns the href of the application created and the application_id of the application created
-  def create_application(params={})
-    merged_params = DEFAULT_OPTIONS.merge(camelize_params(params))
-    validate_application_params(merged_params)
-    result = request(:post, { :resource => 'applications', :body => params })
-    result[:application_id] = get_element(result.href)
-    result
-  end
-  
-  ##
-  # Deletes an application
-  #
-  # @param [required, String] application_id to be deleted
-  # @return [Hash] not sure since it does 204 now, need to check with Cervantes, et al
-  def delete_application(application_id)
-    request(:delete, { :resource => 'applications/' + application_id.to_s })
-  end
-  
-  ##
-  # Deletes a address from a specific application
-  #
-  # @param [String] application_id that the address is associated to
-  # @param [String] address_id for the address
-  # @return
-  def delete_address(application_id, address_id)
-    address_to_delete = address(application_id, address_id)
-    
-    request(:delete, { :resource => 'applications/' + application_id.to_s + '/addresses/' + address_to_delete['type'] + '/' + address_id.to_s })
-  end
-  
-  ##
-  # Provides a list of available exchanges to obtain Numbers from
-  #
-  # @return [Array] the list of available exchanges
-  def exchanges
-    request(:get, { :resource => 'exchanges' })
-  end
-  
-  ##
-  # Used to move a address between one application and another
-  #
-  # @param [Hash] params contains a hash of the applications and address to move
-  # @option params [required, String] :from
-  # @option params [required, String] :to
-  # @option params [required, String] :address
-  def move_address(params={})
-    validate_params(params, %w(from to address))
-    
-    begin
-      address_to_move = address(params[:from], params[:address])
-      delete_address(params[:from], params[:address])
-      request(:post, { :resource => 'applications/' + params[:to] + '/addresses/' + address_to_move['type'] + '/' + params[:address]})
-    rescue
-      raise RuntimeError, 'Unable to move the address'
-    end
-  end
-  
-  ##
-  # Get a specific address for an application
-  #
-  # @param [required, String] application_id to obtain the address for
-  # @param [required, String] address_id of the address to obtain the details for
-  # @return [Hash] the details of the address
-  # @option params [String] :href the REST address for the application
-  # @option params [String] :name the name of the application
-  # @option params [String] :voiceUrl the URL that powers voices calls for your application
-  # @option params [String] :messagingUrl The URL that powers the SMS/messages sessions for your application
-  # @option params [String] :partition this defines whether the application is in staging/development or production
-  # @option params [String] :type this defines the type of address. The possibles types are number (phone numbers), pin (reserved), token, aim, jabber, msn, yahoo, gtalk & skype
-  # @option params [String] :prefix this defines the country code and area code for phone numbers
-  # @option params [String] :number the phone number assigned to the application
-  # @option params [String] :city the city associated with the assigned phone number
-  # @option params [String] :state the state associated with the assigned phone number
-  # @option params [String] :channel idenifites the type of channel, maybe 'voice' or 'messaging'
-  # @option params [String] :username the messaging/IM account's username
-  # @option params [String] :password the messaging/IM account's password
-  # @option params [String] :token alphanumeric string that identifies your Tropo application, used with the Session API
-  def address(application_id, address_id)
-    addresses(application_id).each { |address| return address if address['number']   == address_id || 
-                                                                 address['username'] == address_id || 
-                                                                 address['pin']      == address_id ||
-                                                                 address['token']    == address_id }
-    raise RuntimeError, 'Address not found with that application.'
-  end
-  
-  ##
-  # Get all of the configured addresses for an application
-  #
-  # @param [required, String] application_id to fetch the addresses for
-  # @return [Hash] all of the addresses configured for the application
-  def addresses(application_id)
-    request(:get, { :resource => 'applications/' + application_id.to_s + '/addresses' })
-  end
-  
-  ##
-  # Updated an existing application
-  #
-  # @param [required, String] the application id to update
-  # @param [required, Hash] params the parameters used to create the application
-  # @option params [optional, String] :name the name of the application
-  # @option params [optional, String] :voiceUrl the URL that powers voices calls for your application
-  # @option params [optional, String] :messagingUrl The URL that powers the SMS/messages sessions for your application
-  # @option params [optional, String] :partition whether to create in staging or production
-  # @option params [optional, String] :platform whehter to use scripting or the webapi
-  # @return [Hash] returns the href of the application created
-  def update_application(application_id, params={})
-    request(:put, { :resource => 'applications/' + application_id.to_s, :body => params })
-  end
-  
-  ##
-  # Fetch all invitations, or invitations by user
-  #
-  # @overload def invitations()
-  # @overload def user_inivitations(user_id)
-  #   @param [optional, String] the user_id to fetch the invitations for, if not present, will fetch all invitations
-  # @return [Hash] returns a list of the invitations
-  def invitations(user_id=nil)
-    if user_id
-      request(:get, { :resource => 'users' + "/#{user_id}" + '/invitations'})
-    else
-      request(:get, { :resource => 'invitations' })
-    end
-  end
-  alias :user_invitations :invitations
-  
-  ##
-  # Fetch an invitation
-  #
-  # @overload def invitation(invitation_id)
-  #   @param [required, String] the invitation id to fetch
-  # @overload def user_invitation(user_id, invitation_id)
-  #   @param [required, String] the invitation id to fetch
-  #   @param [optional, String] the user id to fetch the invitation for
-  # @return [Hash] return an invitation
-  def invitation(*args)
-    if args.length == 1
-      request(:get, { :resource => 'invitations' + "/#{args[0]}" })
-    elsif args.length == 2
-      request(:get, { :resource => 'users' + "/#{args[1]}" + '/invitations' + "/#{args[0]}" })
-    else
-      raise ArgumentError, 'Only accepts two arguments, invitation_id and user_id'
-    end
-  end
-  alias :user_invitation :invitation
-  
-  ##
-  # Fetch an invitation
-  #
-  # @overload def delete_invitation(invitation_id)
-  #   @param [required, String] the invitation id to delete
-  # @overload def delete_user_invitation(invitation_id, user_id)
-  #  @param [required, String] the invitation id to delete
-  #  @param [required, String] the user id to delete
-  # @return [Hash] return an invitation
-  def delete_invitation(*args)
-    if args.length == 1
-      request(:delete, { :resource => 'invitations' + "/#{args[0]}" })
-    elsif args.length == 2
-      request(:delete, { :resource => 'users' + "/#{args[1]}" + '/invitations' + "/#{args[0]}" })
-    end
-  end
-  alias :delete_user_invitation :delete_invitation
-  
-  ##
-  # Create an invitation
-  #
-  # @overload def create_invitation(options)
-  #   @param [required, Hash] params the parameters used to create the application
-  #   @option params [optional, String] :code the invitation code (defaults to a random alphanum string of length 6 if not specified on POST) 
-  #   @option params [optional, String] :count the number of accounts that may signup with this code (decrements on each signup) 
-  #   @option params [optional, String] :credit starting account balance for users who signup with this code (replaces the default for the brand) 
-  #   @option params [optional, String] :partition whether to create in staging or production
-  #   @option params [optional, String] :owner URI identifying the user to which this invite code belongs (optional - null implies this is a "global" code) 
-  # @overload def create_user_invitation(user_id, options)
-  #   @param [requried, String] user_id to create the invitation for
-  #   @param [required, Hash] params the parameters used to create the application
-  #   @option params [optional, String] :code the invitation code (defaults to a random alphanum string of length 6 if not specified on POST) 
-  #   @option params [optional, String] :count the number of accounts that may signup with this code (decrements on each signup) 
-  #   @option params [optional, String] :credit starting account balance for users who signup with this code (replaces the default for the brand) 
-  #   @option params [optional, String] :partition whether to create in staging or production
-  #   @option params [optional, String] :owner URI identifying the user to which this invite code belongs (optional - null implies this is a "global" code)
-  # @return [Hash] returns the href of the invitation created
-  def create_invitation(*args)
-    if args.length == 1
-      request(:post, { :resource => 'invitations', :body => args[0] })
-    elsif args.length == 2
-      request(:post, { :resource => 'users' + "/#{args[0]}" + '/invitations', :body => args[1] })
-    end
-  end
-  alias :create_user_invitation :create_invitation
-  
-  ##
-  # Update an invitation
-  #
-  # @overload def update_invitation(invitation_id, options)
-  #   @param [required, String] id of the invitation to udpate (code)
-  #   @param [required, Hash] params the parameters used to update the application
-  #   @option params [optional, String] :count the number of accounts that may signup with this code (decrements on each signup) 
-  #   @option params [optional, String] :credit starting account balance for users who signup with this code (replaces the default for the brand) 
-  #   @option params [optional, String] :partition whether to create in staging or production
-  #   @option params [optional, String] :owner URI identifying the user to which this invite code belongs (optional - null implies this is a "global" code) 
-  # @overload def updated_user_invitation(invitation_id, user_id, options)
-  #   @param [required, String] id of the invitation to udpate (code)
-  #   @param [required, String] id of the user to update the invitation code for
-  #   @param [required, Hash] params the parameters used to update the application
-  #   @option params [optional, String] :count the number of accounts that may signup with this code (decrements on each signup) 
-  #   @option params [optional, String] :credit starting account balance for users who signup with this code (replaces the default for the brand) 
-  #   @option params [optional, String] :partition whether to create in staging or production
-  #   @option params [optional, String] :owner URI identifying the user to which this invite code belongs (optional - null implies this is a "global" code)
-  # @return [Hash] returns the href of the invitation created
-  def update_invitation(*args)
-    if args.length == 2
-      request(:put, { :resource => 'invitations' + "/#{args[0]}", :body => args[1] })
-    elsif args.length == 3
-      request(:put, { :resource => 'users' + "/#{args[1]}" + '/invitations' + "/#{args[0]}", :body => args[2] })
-    end
-  end
-  alias :update_user_invitation :update_invitation
-  
-  ##
-  # Get the available partitions available
-  #
-  # @return [Array]
-  #   an array of hashes containing the partitions available
-  def partitions
-    request(:get, { :resource => 'partitions' })
-  end
-  
-  ##
-  # Get the available platforms available under a certain partition
-  #
-  # @return [Array]
-  #   an array of hashes containing the platforms available
-  def platforms(partition)
-    request(:get, { :resource => 'partitions/' + partition + '/platforms' })
-  end
-  
-  ##
-  # Get the whitelist of the numbers on a particular users list
-  #
-  # @param [required, String] user_id of the user you would like to update
-  # @return [Hash]
-  #   the href and value containing the number on the whitelist
-  def whitelist(user_id=nil)
-    if user_id
-      resource = 'users/' + user_id + '/partitions/production/platforms/sms/whitelist'
-    else
-      resource = 'users/partitions/production/platforms/sms/whitelist'
-    end
-    
-    request(:get, { :resource => resource })
-  end
-  
-  ##
-  # Add to a whitelist for a particular user
-  #
-  # @param [Hash] params contains a hash of the user_id and value to add
-  # @option params [optional, String] :user_id if present the user_id to add to, if not it will add to the user logged in as
-  # @option params [required, String] :value the value to add to the whitelist
-  # @return [Hash]
-  #   the href 
-  def add_whitelist(params={})
-    if params[:user_id]
-      resource = 'users/' + params[:user_id] + '/partitions/production/platforms/sms/whitelist'
-    else
-      resource = 'users/partitions/production/platforms/sms/whitelist'
-    end
-    
-    request(:post, { :resource => resource, :body => { :value => params[:value] } })
-  end
-
-  ##
-  # Delete from a whitelist for a particular user
-  #
-  # @param [Hash] params contains a hash of the user_id and value to delete
-  # @option params [optional, String] :user_id if present the user_id to delete from, if not it will add to the user logged in as
-  # @option params [required, String] :value the value to delete from the whitelist
-  # @return [Hash]
-  #   the href 
-  def delete_whitelist(params={})
-    if params[:user_id]
-      resource = 'users/' + params[:user_id] + '/partitions/production/platforms/sms/whitelist/'
-    else
-      resource = 'users/partitions/production/platforms/sms/whitelist/'
-    end
-    
-    request(:delete, { :resource => resource + params[:value] })
-  end
-  
-  private
-  
-  ##
-  #
-  def camelize_params(params)
-    camelized = {}
-    params.each { |k,v| camelized.merge!(k.to_s.camelize(:lower).to_sym => v) }
-    camelized
-  end
-  
-  ##
-  # Returns the current method name
-  #
-  # @return [String] current method name
-  def current_method_name
-    caller[0] =~ /`([^']*)'/ and $1
-  end
-  
-  ##
-  # Converts the hashes inside the array to Hashie::Mash objects
-  #
-  # @param [required, Array] array to be Hashied
-  # @param [Array] array that is now Hashied
-  def hashie_array(array)
-    hashied_array = []
-    array.each do |ele|
-      hashied_array << Hashie::Mash.new(ele)
-    end
-    hashied_array
-  end
-  
-  ##
-  # Adds the IDs to an Array of Hashes if no ID is present
-  #
-  # @param [required, Array] array of hashes to add IDs to
-  # 
-  # @return [Array]
-  #   the array of hashes with ID added
-  def add_ids(array)
-    array.each do |element|
-      element[:id] = get_element(element.href) if element[:id].nil?
-    end
-    array
-  end
-  
-  ##
-  # Parses the URL and returns the last element
-  #
-  # @param [required, String] the URL to parse for the application ID
-  # @return [String] the application id parsed from the URL
-  def get_element(url)
-    url.split('/').last
-  end
-  
-  ##
-  # Associates the addresses to an application
-  #
-  # @param [Object] application object to associate the address to
-  # @return [Object] returns the application object with the associated addresses embedded
-  def associate_addresses_to_application(app)
-    add = addresses(app.application_id)
-    app.merge!({ :addresses => add })
-  end
-  
-  ##
-  # Creates the appropriate URI and HTTP handlers for our request
-  #
-  # @param [required, Symbol] the HTTP action to use :delete, :get, :post or :put
-  # @param [required, Hash] params used to create the request
-  # @option params [String] :resource the resource to call on the base URL
-  # @option params [Hash] :body the details to use when posting, putting or deleting an object, converts into the appropriate JSON
-  # @return [Hash] the result of the request
-  # @raise [RuntimeError]
-  #   if it can not connect to the API server or if the response.code is not 200 
-  def request(method, params={})
-    params[:body] = camelize_params(params[:body]) if params[:body]
-    
-    if params[:resource]
-      uri = URI.parse(@base_uri + '/' + params[:resource])
-    else
-      uri = URI.parse(@base_uri)
-    end
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = true if uri.scheme == 'https' 
-    
-    request = set_request_type(method, uri)
-    request.initialize_http_header(@headers)
-    request.basic_auth @username, @password
-    request.body = ActiveSupport::JSON.encode params[:body] if params[:body]
-    
-    begin
-      response = http.request(request)
-    rescue => e
-      raise RuntimeError, "Unable to connect to the Provisioning API server - #{e.to_s}"
-    end
-
-    raise ProvisioningApiRuntimeError.new(response.code), "#{response.code}: #{response.message} - #{response.body}" unless response.code == '200'
-    
-    result = ActiveSupport::JSON.decode response.body
-    if result.instance_of? Array
-      hashie_array(result)
-    else
-      Hashie::Mash.new(result)
-    end
-  end
-  
-  ##
-  # Creates the appropriate request for the temporary Evolution account API
-  #
-  # @return [Hash] the result of the request
-  def temp_request(method, fields)
-    #base_uri = 'http://evolution.voxeo.com/api/account'
-    base_uri = 'http://web141.supernonstop.com/api/account'
-    uri = URI.parse(base_uri + fields)
-    http = Net::HTTP.new(uri.host, uri.port)
-
-    request = set_request_type(method, uri)
-    request.initialize_http_header(@headers)
-
-    response = http.request(request)
-    raise RuntimeError, "#{response.code} - #{response.message}" unless response.code == '200'
-
-    result = ActiveSupport::JSON.decode response.body
-    if result.instance_of? Array
-      hashie_array(result)
-    else
-      Hashie::Mash.new(result)
-    end
-  end
-  
-  ##
-  # Sets the HTTP REST type based on the method being called
-  # 
-  # @param [required, ymbol] the HTTP method to use, may be :delete, :get, :post or :put
-  # @param [Object] the uri object to create the request for
-  # @return [Object] the request object to be used to operate on the resource
-  def set_request_type(method, uri)
-    case method
-    when :delete
-      Net::HTTP::Delete.new(uri.request_uri)
-    when :get
-      Net::HTTP::Get.new(uri.request_uri)
-    when :post
-      Net::HTTP::Post.new(uri.request_uri)
-    when :put
-      Net::HTTP::Put.new(uri.request_uri)
-    end
-  end
-  
-  ##
-  # Used to validate required params in either underscore or camelCase formats
-  #
-  # @param [required, Hash] params to be checked
-  # @param [required, Array] requirements of which fields much be present
-  # @raise ArgumentError
-  #   if a param is not present that is required
-  def validate_params(params, requirements)
-    requirements.each do |requirement|
-      if params[requirement.to_sym].nil? && params[requirement.to_s.camelize(:lower).to_sym].nil? && params[requirement].nil? && params[requirement.to_s.camelize(:lower)].nil?
-        raise ArgumentError, ":#{requirement} is a required parameter"
-        break
-      end
-    end
-  end
-  
-  ##
-  # Validates that we have all of the appropriate params when creating an application
-  #
-  # @param [Hash] params to create the application
-  # @option params [required, String] :name the name to assign to the application
-  # @option params [required, String] :partition whether to create in staging or production
-  # @option params [required, String] :platform whehter to use scripting or the webapi
-  # @option params [String] :messagingUrl the Url to use for handiling messaging requests
-  # @option params [String] :voiceUrl the Url to use for handling voice requests
-  # @return nil
-  def validate_application_params(params={})
-    # Make sure all of the arguments are present
-    raise ArgumentError, ':name is a required parameter' unless params[:name] || params['name']
-    
-    # Make sure the arguments have valid values
-    raise ArgumentError, ":platform must be 'scripting' or 'webapi'" unless params[:platform] == 'scripting' || params[:platform] == 'webapi' || params['platform'] == 'scripting' || params['platform'] == 'webapi'
-    raise ArgumentError, ":partiion must be 'staging' or 'production'" unless params[:partition] == 'staging' || params[:partition] == 'production' || params['partition'] == 'staging' || params['partition'] == 'production'
-  end
-  
-  def validate_address_parameters(params={})
-    raise ArgumentError, ":type is a required parameter" unless params[:type] || params['type']
-    
-    case params[:type].downcase
-    when 'number'
-      raise ArgumentError, ':prefix required to add a number address' unless params[:prefix] || params[:number] || params['prefix'] || params['number']
-    when 'aim', 'msn', 'yahoo', 'gtalk'
-      raise ArgumentError, ':username is a required parameter' unless params[:username] || params['username']
-      raise ArgumentError, ':password is a required parameter' unless params[:password] || params ['password']
-    when 'jabber'
-      raise ArgumentError, ':username is a required parameter' unless params[:username] || params['username']
-    when 'token'
-      raise ArgumentError, ':channel is a required parameter' unless params[:channel] || params['channel']
-      raise ArgumentError, ':channel must be voice or messaging' unless params[:channel] == 'voice' || params[:channel] == 'messaging' || params['channel'] == 'voice' || params['channel'] == 'messaging'
-    end
-  end
-end