Comment gérer l'authentification d'un wrapper API Ruby?

Question

Je travaille sur un wrapper API pour Viddler, qui sera finalement rendu public, et j'essaie de trouver la meilleure façon de traiter les clés d'authentification/API, en particulier avec l'utilisation dans les applications Rails à l'esprit.

La meilleure façon d'écrire l'emballage serait d'avoir juste le code de créer un nouveau client chaque fois, et le développeur peut stocker la clé API dans une constante pour une utilisation future:

@client = Viddler::Client.new(VIDDLER_API_KEY) 

Le problème avec c'est, c'est un peu maladroit de devoir continuer à créer des objets client et à passer la clé de l'API. Cela devient encore plus compliqué lorsque vous lancez l'authentification des utilisateurs dans le mixage.

Je pense à une sorte de solution où toute la clé de l'API doit être définie dans le fichier d'environnement, puis l'authentification se fera dans un before_filter.

Viddler::Client.api_key = 'abc123' 
Viddler::Client.authenticate! 'username', 'password' 

Viddler::Client serait alors le stocker dans une variable de classe, et vous pourriez appeler Viddler::Client.new sans aucun paramètre et faire des appels authentifiés. Une chose qui m'inquiète, c'est que cela signifie que le développeur devra s'assurer d'effacer l'authentification avant ou après chaque requête, puisque les variables de la classe persisteront entre les requêtes.

Des pensées?

Answer 1

Stocker la clé API globalement serait certainement très utile et c'est certainement la voie à suivre pour ce type d'information. D'autre part, l'authentification des utilisateurs ne devrait pas être stockée globalement, jamais, surtout pour une API de haut niveau, car dire à vos utilisateurs de "s'assurer d'ajouter un after_filter :reset_viddler_auth" pourrait entraîner des risques de sécurité inattendus.

# in a config/initializer/*.rb file or something 
Viddler::Client.api_key = "abc123" 

# in the controller/action/model/wherever 
@client = Viddler::Client.new # anonymous 
@client.authenticate!("username", "password") # authenticate anon client 

@client_auth = Viddler::Client.new("username", "password") # authenticated client 

Devinez comme vous avez le meilleur des deux mondes :) Peut-être même fournir un moyen de créer un nouveau client avec une autre clé API comme,

@client_other = Viddler::Client.new("username", "password", :api_key => "xyz890") 

... Alors que mes 2 cents .

PS: pas sûr de la mise à jour est, mais il y a déjà une enveloppe de viddler rubis, juste FYI, http://viddler.rubyforge.org/rdoc/