Class JIRA::Client
In: lib/jira/client.rb
Parent: Object

This class is the main access point for all JIRA::Resource instances.

The client must be initialized with an options hash containing configuration options. The available options are:

  :site               => 'http://localhost:2990',
  :context_path       => '/jira',
  :signature_method   => 'RSA-SHA1',
  :request_token_path => "/plugins/servlet/oauth/request-token",
  :authorize_path     => "/plugins/servlet/oauth/authorize",
  :access_token_path  => "/plugins/servlet/oauth/access-token",
  :private_key_file   => "rsakey.pem",
  :rest_base_path     => "/rest/api/2",
  :consumer_key       => nil,
  :consumer_secret    => nil,
  :ssl_verify_mode    => OpenSSL::SSL::VERIFY_PEER,
  :use_ssl            => true,
  :username           => nil,
  :password           => nil,
  :auth_type          => :oauth
  :proxy_address      => nil
  :proxy_port         => nil

See the JIRA::Base class methods for all of the available methods on these accessor objects.

Methods

Constants

DEFAULT_OPTIONS = { :site => 'http://localhost:2990', :context_path => '/jira', :rest_base_path => "/rest/api/2", :ssl_verify_mode => OpenSSL::SSL::VERIFY_PEER, :use_ssl => true, :auth_type => :oauth, :http_debug => false

Attributes

cache  [RW]  The OAuth::Consumer instance returned by the OauthClient

The authenticated client instance returned by the respective client type (Oauth, Basic)

consumer  [RW]  The OAuth::Consumer instance returned by the OauthClient

The authenticated client instance returned by the respective client type (Oauth, Basic)

http_debug  [RW]  The OAuth::Consumer instance returned by the OauthClient

The authenticated client instance returned by the respective client type (Oauth, Basic)

options  [R]  The configuration options for this client instance
request_client  [RW]  The OAuth::Consumer instance returned by the OauthClient

The authenticated client instance returned by the respective client type (Oauth, Basic)

Public Class methods

Public Instance methods

HTTP methods without a body

HTTP methods with a body

Sends the specified HTTP request to the REST API through the appropriate method (oauth, basic).

Protected Instance methods

[Validate]