lib/backlog_kit/client.rb in backlog_kit-0.12.1 vs lib/backlog_kit/client.rb in backlog_kit-0.13.0

@@ -17,10 +17,14 @@
 require 'backlog_kit/response/file_parser'
 require 'backlog_kit/response/raise_error'
 require 'backlog_kit/hash_extensions'
 
 module BacklogKit
+
+  # Client for the Backlog API
+  #
+  # @see http://developer.nulab-inc.com/docs/backlog
   class Client
     include BacklogKit::Client::Authorization
     include BacklogKit::Client::Git
     include BacklogKit::Client::Group
     include BacklogKit::Client::Issue
@@ -45,10 +49,18 @@
       :redirect_uri,
       :state,
       :access_token
     )
 
+    # Initialize a new Client object with given options
+    #
+    # @param options [Hash] Initialize options
+    # @option options [String] :space_id Backlog space id
+    # @option options [String] :api_key Backlog api key
+    # @option options [String] :client_id Backlog OAuth client id
+    # @option options [String] :client_secret Backlog OAuth client secret
+    # @option options [String] :refresh_token Backlog OAuth refresh token
     def initialize(options = {})
       @space_id      = ENV['BACKLOG_SPACE_ID']
       @api_key       = ENV['BACKLOG_API_KEY']
       @client_id     = ENV['BACKLOG_OAUTH_CLIENT_ID']
       @client_secret = ENV['BACKLOG_OAUTH_CLIENT_SECRET']
@@ -57,32 +69,60 @@
       options.each do |key, value|
         instance_variable_set(:"@#{key}", value)
       end
     end
 
+    # Generate an OAuth authorization URL
+    #
+    # @return [String] OAuth authorization URL
     def authorization_url
       url = "#{host}/OAuth2AccessRequest.action?response_type=code&client_id=#{@client_id}"
       url += "&redirect_uri=#{URI.escape(@redirect_uri)}" if @redirect_uri
       url += "&state=#{@state}" if @state
       url
     end
 
+    # Make a HTTP GET request
+    #
+    # @param path [String] Path for request
+    # @param params [Hash] Request parameters
+    # @return [BacklogKit::Response] Response from API server
     def get(path, params = {})
       request(:get, path, params)
     end
 
+    # Make a HTTP POST request
+    #
+    # @param path [String] Path for request
+    # @param params [Hash] Request parameters
+    # @return [BacklogKit::Response] Response from API server
     def post(path, params = {})
       request(:post, path, params)
     end
 
+    # Make a HTTP PUT request
+    #
+    # @param path [String] Path for request
+    # @param params [Hash] Request parameters
+    # @return [BacklogKit::Response] Response from API server
     def put(path, params = {})
       request(:put, path, params)
     end
 
+    # Make a HTTP PATCH request
+    #
+    # @param path [String] Path for request
+    # @param params [Hash] Request parameters
+    # @return [BacklogKit::Response] Response from API server
     def patch(path, params = {})
       request(:patch, path, params)
     end
 
+    # Make a HTTP DELETE request
+    #
+    # @param path [String] Path for request
+    # @param params [Hash] Request parameters
+    # @return [BacklogKit::Response] Response from API server
     def delete(path, params = {})
       request(:delete, path, params)
     end
 
     private