123456789_123456789_123456789_123456789_123456789_

Module: Octokit::Connection

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Client, EnterpriseAdminClient, EnterpriseManagementConsoleClient, ManageGHESClient
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, Authentication
Defined in: lib/octokit/connection.rb

Overview

Network layer for API clients.

Constant Summary

Authentication - Included

FARADAY_BASIC_AUTH_KEYS

Instance Attribute Summary

Authentication - Included

#application_authenticated?

Indicates if the client has OAuth Application client_id and secret credentials to make anonymous requests at a higher rate limit.
#basic_authenticated?

Indicates if the client was supplied Basic Auth username and password.
#bearer_authenticated?

Indicates if the client was supplied a bearer token.
#token_authenticated?

Indicates if the client was supplied an OAuth access token.
#user_authenticated?

Indicates if the client was supplied an OAuth access token or Basic Auth username and password.

Instance Method Summary

Authentication - Included

#login_from_netrc

Instance Method Details

#agent ⇒ Sawyer::Agent

Hypermedia agent for the GitHub API

[ GitHub ] 

  


# File 'lib/octokit/connection.rb', line 104



def agent
  @agent ||= Sawyer::Agent.new(endpoint, sawyer_options) do |http|
    http.headers[:accept] = default_media_type
    http.headers[:content_type] = 'application/json'
    http.headers[:user_agent] = user_agent
    http_cache_middleware = http.builder.handlers.delete(Faraday::HttpCache) if Faraday.const_defined?(:HttpCache)
    if basic_authenticated?
      http.request(*FARADAY_BASIC_AUTH_KEYS, @login, @password)
    elsif token_authenticated?
      http.request :authorization, 'token', @access_token
    elsif bearer_authenticated?
      http.request :authorization, 'Bearer', @bearer_token
    elsif application_authenticated?
      http.request(*FARADAY_BASIC_AUTH_KEYS, @client_id, @client_secret)
    end
    http.builder.handlers.push(http_cache_middleware) unless http_cache_middleware.nil?
  end
end


  








  

    #boolean_from_response(method, path, options = {})  ⇒ Boolean  (private)
  



  

    
Executes the request, checking if it was successful


  





  
Returns:


    
  
  • 
    (Boolean)
—    
    True on success, false otherwise
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 168



def boolean_from_response(method, path, options = {})
  request(method, path, options)
  [201, 202, 204].include? @last_response.status
rescue Octokit::NotFound
  false
end


  








  

    #delete(url, options = {})  ⇒ Sawyer::Resource 
  



  

    
Make a HTTP DELETE request


  





  
Parameters:


    
  
  • 
    url
    (String)
—    
    The path, relative to #api_endpoint
    

    
  
    • 
  
  • 
    options
    (Hash)
    (defaults to: {})
—    
    Query and header params for request
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 54



def delete(url, options = {})
  request :delete, url, options
end


  








  

    #get(url, options = {})  ⇒ Sawyer::Resource 
  



  

    
Make a HTTP GET request


  





  
Parameters:


    
  
  • 
    url
    (String)
—    
    The path, relative to #api_endpoint
    

    
  
    • 
  
  • 
    options
    (Hash)
    (defaults to: {})
—    
    Query and header params for request
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 18



def get(url, options = {})
  request :get, url, parse_query_and_convenience_headers(options)
end


  








  

    #head(url, options = {})  ⇒ Sawyer::Resource 
  



  

    
Make a HTTP HEAD request


  





  
Parameters:


    
  
  • 
    url
    (String)
—    
    The path, relative to #api_endpoint
    

    
  
    • 
  
  • 
    options
    (Hash)
    (defaults to: {})
—    
    Query and header params for request
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 63



def head(url, options = {})
  request :head, url, parse_query_and_convenience_headers(options)
end


  








  

    #last_response  ⇒ Sawyer::Response 
  



  

    
Response for last HTTP request


  





  


  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 133



def last_response
  @last_response if defined? @last_response
end


  








  

    #paginate(url, options = {})  ⇒ Sawyer::Resource 
  



  

    
Make one or more HTTP GET requests, optionally fetching
the next page of results from URL in Link response header based
on value in #auto_paginate.


  





  
Parameters:


    
  
  • 
    url
    (String)
—    
    The path, relative to #api_endpoint
    

    
  
    • 
  
  • 
    options
    (Hash)
    (defaults to: {})
—    
    Query and header params for request
    

    
  
    • 
  
  • 
    block
    (Block)
—    
    Block to perform the data concatination of the
multiple requests. The block is called with two parameters, the first
contains the contents of the requests so far and the second parameter
contains the latest response.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 78



def paginate(url, options = {})
  opts = parse_query_and_convenience_headers(options)
  if @auto_paginate || @per_page
    opts[:query][:per_page] ||= @per_page || (@auto_paginate ? 100 : nil)
  end

  data = request(:get, url, opts.dup)

  if @auto_paginate
    while @last_response.rels[:next] && rate_limit.remaining > 0
      @last_response = @last_response.rels[:next].get(headers: opts[:headers])
      if block_given?
        yield(data, @last_response)
      else
        data.concat(@last_response.data) if @last_response.data.is_a?(Array)
      end
    end

  end

  data
end


  








  

    #parse_query_and_convenience_headers(options)   (private)
  

  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 196



def parse_query_and_convenience_headers(options)
  options = options.dup
  headers = options.delete(:headers) { {} }
  CONVENIENCE_HEADERS.each do |h|
    if header = options.delete(h)
      headers[h] = header
    end
  end
  query = options.delete(:query)
  opts = { query: options }
  opts[:query].merge!(query) if query.is_a?(Hash)
  opts[:headers] = headers unless headers.empty?

  opts
end


  








  

    #patch(url, options = {})  ⇒ Sawyer::Resource 
  



  

    
Make a HTTP PATCH request


  





  
Parameters:


    
  
  • 
    url
    (String)
—    
    The path, relative to #api_endpoint
    

    
  
    • 
  
  • 
    options
    (Hash)
    (defaults to: {})
—    
    Body and header params for request
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 45



def patch(url, options = {})
  request :patch, url, options
end


  








  

    #post(url, options = {})  ⇒ Sawyer::Resource 
  



  

    
Make a HTTP POST request


  





  
Parameters:


    
  
  • 
    url
    (String)
—    
    The path, relative to #api_endpoint
    

    
  
    • 
  
  • 
    options
    (Hash)
    (defaults to: {})
—    
    Body and header params for request
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 27



def post(url, options = {})
  request :post, url, options
end


  








  

    #put(url, options = {})  ⇒ Sawyer::Resource 
  



  

    
Make a HTTP PUT request


  





  
Parameters:


    
  
  • 
    url
    (String)
—    
    The path, relative to #api_endpoint
    

    
  
    • 
  
  • 
    options
    (Hash)
    (defaults to: {})
—    
    Body and header params for request
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 36



def put(url, options = {})
  request :put, url, options
end


  








  

    #request(method, path, data, options = {})   (private)
  

  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 149



def request(method, path, data, options = {})
  if data.is_a?(Hash)
    options[:query]   = data.delete(:query) || {}
    options[:headers] = data.delete(:headers) || {}
    if accept = data.delete(:accept)
      options[:headers][:accept] = accept
    end
  end

  @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
  response_data_correctly_encoded(response)
rescue Octokit::Error => e
  @last_response = nil
  raise e
end


  








  

    #reset_agent   (private)
  

  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 145



def reset_agent
  @agent = nil
end


  








  

    #response_data_correctly_encoded(response)   (private)
  

  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 212



def response_data_correctly_encoded(response)
  content_type = response.headers.fetch('content-type', '')
  return response.data unless content_type.include?('charset') && response.data.is_a?(String)

  reported_encoding = content_type.match(/charset=([^ ]+)/)[1]
  response.data.force_encoding(reported_encoding)
end


  








  

    #root  ⇒ Sawyer::Resource 
  



  

    
Fetch the root resource for the API


  





  


  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 126



def root
  get '/'
end


  








  

    #sawyer_options   (private)
  

  [ GitHub ]


  

  


# File 'lib/octokit/connection.rb', line 175



def sawyer_options
  opts = {
    links_parser: Sawyer::LinkParsers::Simple.new
  }
  conn_opts = @connection_options
  conn_opts[:builder] = @middleware.dup if @middleware
  conn_opts[:proxy] = @proxy if @proxy
  if conn_opts[:ssl].nil?
    conn_opts[:ssl] = { verify_mode: @ssl_verify_mode } if @ssl_verify_mode
  else
    verify = @connection_options[:ssl][:verify]
    conn_opts[:ssl] = {
      verify: verify,
      verify_mode: verify == false ? 0 : @ssl_verify_mode
    }
  end
  opts[:faraday] = Faraday.new(conn_opts)

  opts
end