From bf7c355cd838a03134e92b70532625570d5edc8e Mon Sep 17 00:00:00 2001 From: Jason Kim Date: Fri, 10 Jun 2016 15:49:46 -0700 Subject: [PATCH] [chore] Docs on Request and ResponseError --- lib/napster/request.rb | 3 +++ lib/napster/response_error.rb | 3 +++ 2 files changed, 6 insertions(+) diff --git a/lib/napster/request.rb b/lib/napster/request.rb index 050aec9..79610be 100644 --- a/lib/napster/request.rb +++ b/lib/napster/request.rb @@ -6,6 +6,9 @@ class Request attr_accessor :faraday + # Initialize a Faraday client + # @param options [Hash] May contains api_key, api_secret adn access_token + # @return [Faraday] Return Faraday object for making API calls def initialize(options) @faraday = Faraday.new(url: HOST_URL) do |faraday| faraday.request :url_encoded diff --git a/lib/napster/response_error.rb b/lib/napster/response_error.rb index 5846519..aa3d329 100644 --- a/lib/napster/response_error.rb +++ b/lib/napster/response_error.rb @@ -5,6 +5,9 @@ class ResponseError < Faraday::Error :response_body, :faraday_response + # Initialize a Faraday client + # @param response [Faraday::Response] Should contain error response. + # @return [ResponseError] Return error object with info about the error. def initialize(response) @http_status = response.status @response_body = response.body