Created
April 5, 2012 20:29
-
-
Save scottwater/2313845 to your computer and use it in GitHub Desktop.
Is this the best pattern for deprecating a method paramater?
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
module FullContact | |
class Client | |
module Person | |
# Returns extended information for a given person (email, phone, twitter or facebook) | |
# | |
def person(options={}) | |
if options.is_a?(String) | |
warn "[DEPRECATION] supplying an email address directly is deprecated. Please use {email: #{options}} instead." | |
options = {:email => options} | |
end | |
response = get('person', options) | |
format.to_s.downcase == 'xml' ? response['person'] : response | |
end | |
end | |
end | |
end |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I should have pointed out the method initially looked like this:
def person(email)
response = get('person', email: email)
#....
end