lib/octocat_herder/connection.rb in octocat_herder-0.1.0 vs lib/octocat_herder/connection.rb in octocat_herder-0.1.1
- old
+ new
@@ -75,11 +75,11 @@
end
end
# Execute a GET request against the GitHub v3 API.
#
- # @since development
+ # @since 0.1.0
#
# @param [String] end_point The part of the API URL after
# +'api.github.com'+, including the leading +'/'+.
#
# @param [Hash] options A Hash of options to be passed down to
@@ -115,11 +115,11 @@
end
# Small wrapper around HTTParty.get, which handles adding
# authentication information to the API request.
#
- # @since development
+ # @since 0.1.0
def raw_get(end_point, options={})
query_params = options.delete(:params) || {}
query_string = query_string_from_params(query_params)
request_options = options.merge(httparty_options)
@@ -130,11 +130,11 @@
OctocatHerder::Connection.get(end_point + query_string, request_options)
end
# Are we making authenticated requests?
#
- # @since development
+ # @since 0.1.0
# @return [true, false]
def authenticated_requests?
if (user_name and password) or oauth2_token
true
else
@@ -149,11 +149,11 @@
# ['+next+'] The immediate next page of results.
# ['+last+'] The last page of first.
# ['+first+'] The first page of results.
# ['+prev+'] The immediate previous page of results.
#
- # @since development
+ # @since 0.1.0
#
# @raise [ArgumentError] If type is not one of the allowed values.
#
# @param [Hash] headers
#
@@ -169,10 +169,10 @@
CGI.parse(URI.parse(link.href).query)['page'].first
end
# Convenience method to generate URL query strings.
#
- # @since development
+ # @since 0.1.0
#
# @param [Hash] params A Hash of key/values to be turned into a
# URL query string. Does not support nested data.
#
# @return [String] Empty string if params is an empty hash,