[SCM] ci-tooling packaging branch, master, updated. ec32e5e048d3f89e5176ae1500685554e5966c5c

[Harald Sitter]

Gitweb-URL: http://git.debian.org/?p=pkg-kde/ci-tooling.git;a=commitdiff;h=ec32e5e

The following commit has been merged in the master branch:
commit ec32e5e048d3f89e5176ae1500685554e5966c5c
Author: Harald Sitter <sitter at kde.org>
Date:   Mon Jan 19 15:30:45 2015 +0100

    lp: document some stuff
---
 lib/lp.rb | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/lib/lp.rb b/lib/lp.rb
index 5942d8d..feef1a4 100644
--- a/lib/lp.rb
+++ b/lib/lp.rb
@@ -28,11 +28,13 @@ require 'oauth/signature/plaintext'
 module Launchpad
   @token = nil
 
+  # @!visibility private
   def self.token
     @token
   end
 
   # Get or load OAuth token.
+  # @return [OAuth::AccessToken]
   def self.authenticate
     consumer_options = {
       :signature_method   => 'PLAINTEXT',
@@ -73,6 +75,9 @@ module Launchpad
     @token
   end
 
+  # HTTP GET. Possibly via token.
+  # @param uri [URI] to get
+  # @return [String] body of response
   def self.get(uri)
     if @token
       # Token internally URIfies again without checking if it already has
@@ -95,6 +100,9 @@ module Launchpad
     d
   end
 
+  # HTTP POST. Only possible after {authenticate} was used to get a token!
+  # @param uri [URI] to post to.
+  # @return [String] body of response
   def self.post(uri)
     # Posting always requires a token.
     response = @token.post(uri.path, uri.query)

-- 
ci-tooling packaging