module Hub::GitHubAPI::HttpMethods

Methods for performing HTTP requests

Requires access to a `config` object that implements:

Methods for performing HTTP requests

Requires access to a `config` object that implements:

Public Instance Methods

apply_authentication(req, url) click to toggle source
# File lib/hub/github_api.rb, line 287
def apply_authentication req, url
  user = url.user ? CGI.unescape(url.user) : config.username(url.host)
  pass = config.password(url.host, user)
  req.basic_auth user, pass
end
byte_size(str) click to toggle source
# File lib/hub/github_api.rb, line 233
def byte_size str
  if    str.respond_to? :bytesize then str.bytesize
  elsif str.respond_to? :length   then str.length
  else  0
  end
end
configure_connection(req, url) { |url| ... } click to toggle source
# File lib/hub/github_api.rb, line 274
def configure_connection req, url
  url.scheme = config.protocol(url.host)
  if ENV['HUB_TEST_HOST']
    req['Host'] = url.host
    req['X-Original-Scheme'] = url.scheme
    url = url.dup
    url.scheme = 'http'
    url.host, test_port = ENV['HUB_TEST_HOST'].split(':')
    url.port = test_port.to_i if test_port
  end
  yield url
end
create_connection(url) click to toggle source
# File lib/hub/github_api.rb, line 299
def create_connection url
  use_ssl = 'https' == url.scheme

  proxy_args = []
  if proxy = config.proxy_uri(use_ssl)
    proxy_args << proxy.host << proxy.port
    if proxy.userinfo
      # proxy user + password
      proxy_args.concat proxy.userinfo.split(':', 2).map {|a| CGI.unescape a }
    end
  end

  http = Net::HTTP.new(url.host, url.port, *proxy_args)

  if http.use_ssl = use_ssl
    # FIXME: enable SSL peer verification!
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
  end
  return http
end
finalize_request(req, url) click to toggle source
# File lib/hub/github_api.rb, line 293
def finalize_request(req, url)
  if !req['Accept'] || req['Accept'] == '*/*'
    req['Accept'] = 'application/vnd.github.v3+json'
  end
end
get(url, &block) click to toggle source
# File lib/hub/github_api.rb, line 203
def get url, &block
  perform_request url, :Get, &block
end
get_all(url, &block) click to toggle source
# File lib/hub/github_api.rb, line 207
def get_all url, &block
  previous_res = nil
  user = url.user
  while url
    res = get(url, &block)
    if url = res.next_url
      url = url.dup
      url.user = user
    end
    res.data.unshift(*previous_res.data) if res.success? && previous_res
    previous_res = res
  end
  res
end
perform_request(url, type) { |req| ... } click to toggle source
# File lib/hub/github_api.rb, line 244
def perform_request url, type
  url = URI.parse url unless url.respond_to? :host

  require 'net/https'
  req = Net::HTTP.const_get(type).new request_uri(url)
  # TODO: better naming?
  http = configure_connection(req, url) do |host_url|
    create_connection host_url
  end

  req['User-Agent'] = "Hub #{Hub::VERSION}"
  apply_authentication(req, url)
  yield req if block_given?
  finalize_request(req, url)

  begin
    res = http.start { http.request(req) }
    res.extend ResponseMethods
    return res
  rescue SocketError => err
    raise Context::FatalError, "error with #{type.to_s.upcase} #{url} (#{err.message})"
  end
end
post(url, params = nil) { |req| ... } click to toggle source
# File lib/hub/github_api.rb, line 222
def post url, params = nil
  perform_request url, :Post do |req|
    if params
      req.body = JSON.dump params
      req['Content-Type'] = 'application/json;charset=utf-8'
    end
    yield req if block_given?
    req['Content-Length'] = byte_size req.body
  end
end
post_form(url, params) click to toggle source
# File lib/hub/github_api.rb, line 240
def post_form url, params
  post(url) {|req| req.set_form_data params }
end
request_uri(url) click to toggle source
# File lib/hub/github_api.rb, line 268
def request_uri url
  str = url.request_uri
  str = '/api/v3' << str if url.host != 'api.github.com' && url.host != 'gist.github.com'
  str
end