Class: OSDNClient::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/osdn-client/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.


7
8
9
 
# File 'lib/osdn-client/api/default_api.rb', line 7

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.


5
6
7
 
# File 'lib/osdn-client/api/default_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#ping(opts = {}) ⇒ Pong

return pong for test

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:


15
16
17
18
 
# File 'lib/osdn-client/api/default_api.rb', line 15

def ping(opts = {})
  data, status_code, headers = ping_with_http_info(opts)
  return data
end

#ping_with_http_info(opts = {}) ⇒ Array<(Pong, Fixnum, Hash)>

return pong for test

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Pong, Fixnum, Hash)>) —

    Pong data, response status code and response headers


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/osdn-client/api/default_api.rb', line 24

def ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi#ping ..."
  end
  
  # resource path
  path = "/ping".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['oauth2-implicit']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Pong')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#token(client_id, client_secret, opts = {}) ⇒ Token

Get access token by access code.

Parameters:

  • client_id —

    Your application ID

  • client_secret —

    Your application secret (key)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :grant_type (String) —

    &quot;authorization_code&quot; or &quot;refresh_token&quot;

  • :code (String) —

    Set auth code issued by osdn.jp/account/oauth2ui/authorize for grant_type=authorization_code

  • :refresh_token (String) —

    Set refresh token to update access token.

Returns:


76
77
78
79
 
# File 'lib/osdn-client/api/default_api.rb', line 76

def token(client_id, client_secret, opts = {})
  data, status_code, headers = token_with_http_info(client_id, client_secret, opts)
  return data
end

#token_with_http_info(client_id, client_secret, opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Get access token by access code.

Parameters:

  • client_id —

    Your application ID

  • client_secret —

    Your application secret (key)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :grant_type (String) —

    &quot;authorization_code&quot; or &quot;refresh_token&quot;

  • :code (String) —

    Set auth code issued by osdn.jp/account/oauth2ui/authorize for grant_type=authorization_code

  • :refresh_token (String) —

    Set refresh token to update access token.

Returns:

  • (Array<(Token, Fixnum, Hash)>) —

    Token data, response status code and response headers


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/osdn-client/api/default_api.rb', line 90

def token_with_http_info(client_id, client_secret, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi#token ..."
  end
  
  # verify the required parameter 'client_id' is set
  fail "Missing the required parameter 'client_id' when calling token" if client_id.nil?
  
  # verify the required parameter 'client_secret' is set
  fail "Missing the required parameter 'client_secret' when calling token" if client_secret.nil?
  
  # resource path
  path = "/token".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}
  form_params["client_id"] = client_id
  form_params["client_secret"] = client_secret
  form_params["grant_type"] = opts[:'grant_type'] if opts[:'grant_type']
  form_params["code"] = opts[:'code'] if opts[:'code']
  form_params["refresh_token"] = opts[:'refresh_token'] if opts[:'refresh_token']

  # http body (model)
  post_body = nil
  

  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Token')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end