Fix documentation typo in favorites.rb

[arronmabrey]

I think these should be favorite! not favorite because this is documenting the favorite! method.

-- Arron

[coveralls]

Coverage remained the same when pulling 46858e5 on arronmabrey:patch-1 into 96c211c on sferik:master.

[sferik]

Nice catch.

[arronmabrey]

@sferik I found it while a co-worker and I were trying to see if all the api type methods had bang ! counter parts that raise exceptions. We didn't really conclude one way or the other, do you know the answer to this question? What if any list of methods can we rely on to raise exceptions if the thing we are trying to do fails, as opposed to returning some falsely value.

[sferik]

@arronmabrey There are only three public methods of a Twitter::REST::Client that offer bang versions:

1. update!
2. retweet!
3. favorite!

According to HTTP POST semantics, these operations should not be idempotent. Specifically, calling any of these methods with the same arguments multiple times will result in an HTTP 403 Forbidden error after the first success. It seemed reasonable to provide safe, idempotent versions of these methods that ignore these errors, to emulate the semantics of an HTTP PUT, which I believe is a better model for retweeting and favoriting.

Any method, including the non-bang versions of the methods above, can raise an exception (e.g. Twitter::Error::Unauthorized) but these methods will never raise the corresponding Twitter::Error::AlreadyPosted, Twitter::Error::AlreadyRetweeted, or Twitter::Error::AlreadyFavorited errors.

[arronmabrey]

@sferik wow, thanks! That's great information, thank you for taking the time to write it up for me :-)