-
Notifications
You must be signed in to change notification settings - Fork 160
/
client.rb
196 lines (169 loc) · 5.56 KB
/
client.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# frozen_string_literal: true
require "faraday"
require "faraday/follow_redirects"
require "faraday/multipart"
require "json"
require "uri"
require "discourse_api/version"
require "discourse_api/api/categories"
require "discourse_api/api/search"
require "discourse_api/api/sso"
require "discourse_api/api/tags"
require "discourse_api/api/topics"
require "discourse_api/api/polls"
require "discourse_api/api/posts"
require "discourse_api/api/users"
require "discourse_api/api/groups"
require "discourse_api/api/invite"
require "discourse_api/api/private_messages"
require "discourse_api/api/notifications"
require "discourse_api/api/badges"
require "discourse_api/api/email"
require "discourse_api/api/api_key"
require "discourse_api/api/backups"
require "discourse_api/api/dashboard"
require "discourse_api/api/uploads"
require "discourse_api/api/user_actions"
require "discourse_api/api/site_settings"
module DiscourseApi
class Client
attr_accessor :api_key
attr_accessor :basic_auth
attr_reader :host, :api_username, :timeout
DEFAULT_TIMEOUT = 30
include DiscourseApi::API::Categories
include DiscourseApi::API::Search
include DiscourseApi::API::SSO
include DiscourseApi::API::Tags
include DiscourseApi::API::Topics
include DiscourseApi::API::Polls
include DiscourseApi::API::Posts
include DiscourseApi::API::Users
include DiscourseApi::API::Groups
include DiscourseApi::API::Invite
include DiscourseApi::API::PrivateMessages
include DiscourseApi::API::Notifications
include DiscourseApi::API::Badges
include DiscourseApi::API::Email
include DiscourseApi::API::ApiKey
include DiscourseApi::API::Backups
include DiscourseApi::API::Dashboard
include DiscourseApi::API::Uploads
include DiscourseApi::API::UserActions
include DiscourseApi::API::SiteSettings
def initialize(host, api_key = nil, api_username = nil)
raise ArgumentError, "host needs to be defined" if host.nil? || host.empty?
@host = host
@api_key = api_key
@api_username = api_username
@use_relative = check_subdirectory(host)
end
def timeout=(timeout)
@timeout = timeout
@connection.options.timeout = timeout if @connection
end
def api_username=(api_username)
@api_username = api_username
@connection.headers["Api-Username"] = api_username unless @connection.nil?
end
def connection_options
@connection_options ||= {
url: @host,
request: {
timeout: @timeout || DEFAULT_TIMEOUT,
},
headers: {
accept: "application/json",
user_agent: user_agent,
},
}
end
def ssl(options)
connection_options[:ssl] = options
end
def delete(path, params = {})
request(:delete, path, params)
end
def get(path, params = {})
request(:get, path, params)
end
def post(path, params = {})
response = request(:post, path, params)
case response.status
when 200, 201, 204
response.body
else
raise DiscourseApi::Error, response.body
end
end
def put(path, params = {})
request(:put, path, params)
end
def patch(path, params = {})
request(:patch, path, params)
end
def user_agent
@user_agent ||= "DiscourseAPI Ruby Gem #{DiscourseApi::VERSION}"
end
def deprecated(old, new)
warn "[DEPRECATED]: `#{old}` is deprecated. Please use `#{new}` instead."
end
private
def connection
@connection ||=
Faraday.new connection_options do |conn|
# Allow uploading of files
conn.request :multipart
# Convert request params to "www-form-encoded"
conn.request :url_encoded
# Allow to interact with forums behind basic HTTP authentication
if basic_auth
conn.request :authorization, :basic, basic_auth[:user], basic_auth[:password]
end
# Follow redirects
conn.response :follow_redirects, limit: 5
# Parse responses as JSON
conn.response :json, content_type: "application/json"
# For HTTP debugging, uncomment
# conn.response :logger
# Use Faraday's default HTTP adapter
conn.adapter Faraday.default_adapter
# Pass api_key and api_username on every request
unless api_username.nil?
conn.headers["Api-Key"] = api_key
conn.headers["Api-Username"] = api_username
end
end
end
def request(method, path, params = {})
unless Hash === params
params = params.to_h if params.respond_to? :to_h
end
path = @use_relative ? path.sub(%r{^/}, "") : path
response = connection.send(method.to_sym, path, params)
handle_error(response)
response.env
rescue Faraday::ClientError, JSON::ParserError
raise DiscourseApi::Error
rescue Faraday::ConnectionFailed
raise DiscourseApi::Timeout
end
def handle_error(response)
case response.status
when 403
raise DiscourseApi::UnauthenticatedError.new(response.env[:body], response.env)
when 404, 410
raise DiscourseApi::NotFoundError.new(response.env[:body], response.env)
when 422
raise DiscourseApi::UnprocessableEntity.new(response.env[:body], response.env)
when 429
raise DiscourseApi::TooManyRequests.new(response.env[:body], response.env)
when 500...600
raise DiscourseApi::Error.new(response.env[:body])
end
end
def check_subdirectory(host)
URI(host).request_uri != "/"
end
end
end