gopad 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +20 -0
- data/CONTRIBUTING.md +121 -0
- data/DCO +34 -0
- data/LICENSE +202 -0
- data/README.md +67 -0
- data/lib/gopad/api/auth_api.rb +154 -0
- data/lib/gopad/api/team_api.rb +671 -0
- data/lib/gopad/api/user_api.rb +671 -0
- data/lib/gopad/api_client.rb +429 -0
- data/lib/gopad/api_error.rb +56 -0
- data/lib/gopad/configuration.rb +390 -0
- data/lib/gopad/models/notification.rb +227 -0
- data/lib/gopad/models/team.rb +251 -0
- data/lib/gopad/models/team_user_params.rb +262 -0
- data/lib/gopad/models/team_users.rb +227 -0
- data/lib/gopad/models/teams.rb +220 -0
- data/lib/gopad/models/user.rb +299 -0
- data/lib/gopad/models/user_auth.rb +234 -0
- data/lib/gopad/models/user_team.rb +302 -0
- data/lib/gopad/models/user_team_params.rb +262 -0
- data/lib/gopad/models/user_teams.rb +227 -0
- data/lib/gopad/models/users.rb +220 -0
- data/lib/gopad/models/validation.rb +220 -0
- data/lib/gopad/version.rb +13 -0
- data/lib/gopad.rb +52 -0
- metadata +117 -0
@@ -0,0 +1,251 @@
|
|
1
|
+
# Gopad OpenAPI
|
2
|
+
#
|
3
|
+
# API definition for Gopad, Etherpad for markdown with go
|
4
|
+
#
|
5
|
+
# The version of the OpenAPI document: 1.0.0-alpha1
|
6
|
+
# Contact: gopad@webhippie.de
|
7
|
+
# Generated by: https://openapi-generator.tech
|
8
|
+
# Generator version: 7.6.0
|
9
|
+
#
|
10
|
+
|
11
|
+
require 'date'
|
12
|
+
require 'time'
|
13
|
+
|
14
|
+
module Gopad
|
15
|
+
# Model to represent team
|
16
|
+
class Team
|
17
|
+
attr_accessor :id, :slug, :name, :created_at, :updated_at, :users
|
18
|
+
|
19
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
20
|
+
def self.attribute_map
|
21
|
+
{
|
22
|
+
id: :id,
|
23
|
+
slug: :slug,
|
24
|
+
name: :name,
|
25
|
+
created_at: :created_at,
|
26
|
+
updated_at: :updated_at,
|
27
|
+
users: :users
|
28
|
+
}
|
29
|
+
end
|
30
|
+
|
31
|
+
# Returns all the JSON keys this model knows about
|
32
|
+
def self.acceptable_attributes
|
33
|
+
attribute_map.values
|
34
|
+
end
|
35
|
+
|
36
|
+
# Attribute type mapping.
|
37
|
+
def self.openapi_types
|
38
|
+
{
|
39
|
+
id: :String,
|
40
|
+
slug: :String,
|
41
|
+
name: :String,
|
42
|
+
created_at: :Time,
|
43
|
+
updated_at: :Time,
|
44
|
+
users: :'Array<UserTeam>'
|
45
|
+
}
|
46
|
+
end
|
47
|
+
|
48
|
+
# List of attributes with nullable: true
|
49
|
+
def self.openapi_nullable
|
50
|
+
Set.new(%i[
|
51
|
+
slug
|
52
|
+
name
|
53
|
+
users
|
54
|
+
])
|
55
|
+
end
|
56
|
+
|
57
|
+
# Initializes the object
|
58
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
59
|
+
def initialize(attributes = {})
|
60
|
+
unless attributes.is_a?(Hash)
|
61
|
+
raise ArgumentError, 'The input argument (attributes) must be a hash in `Gopad::Team` initialize method'
|
62
|
+
end
|
63
|
+
|
64
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
65
|
+
attributes = attributes.each_with_object({}) do |(k, v), h|
|
66
|
+
unless self.class.attribute_map.key?(k.to_sym)
|
67
|
+
raise ArgumentError, "`#{k}` is not a valid attribute in `Gopad::Team`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
68
|
+
end
|
69
|
+
|
70
|
+
h[k.to_sym] = v
|
71
|
+
end
|
72
|
+
|
73
|
+
if attributes.key?(:id)
|
74
|
+
self.id = attributes[:id]
|
75
|
+
end
|
76
|
+
|
77
|
+
if attributes.key?(:slug)
|
78
|
+
self.slug = attributes[:slug]
|
79
|
+
end
|
80
|
+
|
81
|
+
if attributes.key?(:name)
|
82
|
+
self.name = attributes[:name]
|
83
|
+
end
|
84
|
+
|
85
|
+
if attributes.key?(:created_at)
|
86
|
+
self.created_at = attributes[:created_at]
|
87
|
+
end
|
88
|
+
|
89
|
+
if attributes.key?(:updated_at)
|
90
|
+
self.updated_at = attributes[:updated_at]
|
91
|
+
end
|
92
|
+
|
93
|
+
if attributes.key?(:users) && (value = attributes[:users]).is_a?(Array)
|
94
|
+
self.users = value
|
95
|
+
end
|
96
|
+
end
|
97
|
+
|
98
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
99
|
+
# @return Array for valid properties with the reasons
|
100
|
+
def list_invalid_properties
|
101
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
102
|
+
[]
|
103
|
+
end
|
104
|
+
|
105
|
+
# Check to see if the all the properties in the model are valid
|
106
|
+
# @return true if the model is valid
|
107
|
+
def valid?
|
108
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
109
|
+
true
|
110
|
+
end
|
111
|
+
|
112
|
+
# Checks equality by comparing each attribute.
|
113
|
+
# @param [Object] Object to be compared
|
114
|
+
def ==(other)
|
115
|
+
return true if equal?(other)
|
116
|
+
|
117
|
+
self.class == other.class &&
|
118
|
+
id == other.id &&
|
119
|
+
slug == other.slug &&
|
120
|
+
name == other.name &&
|
121
|
+
created_at == other.created_at &&
|
122
|
+
updated_at == other.updated_at &&
|
123
|
+
users == other.users
|
124
|
+
end
|
125
|
+
|
126
|
+
# @see the `==` method
|
127
|
+
# @param [Object] Object to be compared
|
128
|
+
def eql?(other)
|
129
|
+
self == other
|
130
|
+
end
|
131
|
+
|
132
|
+
# Calculates hash code according to all attributes.
|
133
|
+
# @return [Integer] Hash code
|
134
|
+
def hash
|
135
|
+
[id, slug, name, created_at, updated_at, users].hash
|
136
|
+
end
|
137
|
+
|
138
|
+
# Builds the object from hash
|
139
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
140
|
+
# @return [Object] Returns the model itself
|
141
|
+
def self.build_from_hash(attributes)
|
142
|
+
return nil unless attributes.is_a?(Hash)
|
143
|
+
|
144
|
+
attributes = attributes.transform_keys(&:to_sym)
|
145
|
+
transformed_hash = {}
|
146
|
+
openapi_types.each_pair do |key, type|
|
147
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
148
|
+
transformed_hash[key.to_s] = nil
|
149
|
+
elsif type =~ /\AArray<(.*)>/i
|
150
|
+
# check to ensure the input is an array given that the attribute
|
151
|
+
# is documented as an array but the input is not
|
152
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
153
|
+
transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
|
154
|
+
end
|
155
|
+
elsif !attributes[attribute_map[key]].nil?
|
156
|
+
transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
|
157
|
+
end
|
158
|
+
end
|
159
|
+
new(transformed_hash)
|
160
|
+
end
|
161
|
+
|
162
|
+
# Deserializes the data based on type
|
163
|
+
# @param string type Data type
|
164
|
+
# @param string value Value to be deserialized
|
165
|
+
# @return [Object] Deserialized data
|
166
|
+
def self._deserialize(type, value)
|
167
|
+
case type.to_sym
|
168
|
+
when :Time
|
169
|
+
Time.parse(value)
|
170
|
+
when :Date
|
171
|
+
Date.parse(value)
|
172
|
+
when :String
|
173
|
+
value.to_s
|
174
|
+
when :Integer
|
175
|
+
value.to_i
|
176
|
+
when :Float
|
177
|
+
value.to_f
|
178
|
+
when :Boolean
|
179
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
180
|
+
true
|
181
|
+
else
|
182
|
+
false
|
183
|
+
end
|
184
|
+
when :Object
|
185
|
+
# generic object (usually a Hash), return directly
|
186
|
+
value
|
187
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
188
|
+
inner_type = Regexp.last_match[:inner_type]
|
189
|
+
value.map { |v| _deserialize(inner_type, v) }
|
190
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
191
|
+
k_type = Regexp.last_match[:k_type]
|
192
|
+
v_type = Regexp.last_match[:v_type]
|
193
|
+
{}.tap do |hash|
|
194
|
+
value.each do |k, v|
|
195
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
196
|
+
end
|
197
|
+
end
|
198
|
+
else # model
|
199
|
+
# models (e.g. Pet) or oneOf
|
200
|
+
klass = Gopad.const_get(type)
|
201
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
202
|
+
end
|
203
|
+
end
|
204
|
+
|
205
|
+
# Returns the string representation of the object
|
206
|
+
# @return [String] String presentation of the object
|
207
|
+
def to_s
|
208
|
+
to_hash.to_s
|
209
|
+
end
|
210
|
+
|
211
|
+
# to_body is an alias to to_hash (backward compatibility)
|
212
|
+
# @return [Hash] Returns the object in the form of hash
|
213
|
+
def to_body
|
214
|
+
to_hash
|
215
|
+
end
|
216
|
+
|
217
|
+
# Returns the object in the form of hash
|
218
|
+
# @return [Hash] Returns the object in the form of hash
|
219
|
+
def to_hash
|
220
|
+
hash = {}
|
221
|
+
self.class.attribute_map.each_pair do |attr, param|
|
222
|
+
value = send(attr)
|
223
|
+
if value.nil?
|
224
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
225
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
226
|
+
end
|
227
|
+
|
228
|
+
hash[param] = _to_hash(value)
|
229
|
+
end
|
230
|
+
hash
|
231
|
+
end
|
232
|
+
|
233
|
+
# Outputs non-array value in the form of hash
|
234
|
+
# For object, use to_hash. Otherwise, just return the value
|
235
|
+
# @param [Object] value Any valid value
|
236
|
+
# @return [Hash] Returns the value in the form of hash
|
237
|
+
def _to_hash(value)
|
238
|
+
if value.is_a?(Array)
|
239
|
+
value.compact.map { |v| _to_hash(v) }
|
240
|
+
elsif value.is_a?(Hash)
|
241
|
+
{}.tap do |hash|
|
242
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
243
|
+
end
|
244
|
+
elsif value.respond_to? :to_hash
|
245
|
+
value.to_hash
|
246
|
+
else
|
247
|
+
value
|
248
|
+
end
|
249
|
+
end
|
250
|
+
end
|
251
|
+
end
|
@@ -0,0 +1,262 @@
|
|
1
|
+
# Gopad OpenAPI
|
2
|
+
#
|
3
|
+
# API definition for Gopad, Etherpad for markdown with go
|
4
|
+
#
|
5
|
+
# The version of the OpenAPI document: 1.0.0-alpha1
|
6
|
+
# Contact: gopad@webhippie.de
|
7
|
+
# Generated by: https://openapi-generator.tech
|
8
|
+
# Generator version: 7.6.0
|
9
|
+
#
|
10
|
+
|
11
|
+
require 'date'
|
12
|
+
require 'time'
|
13
|
+
|
14
|
+
module Gopad
|
15
|
+
# Parameters to attach or remove team user
|
16
|
+
class TeamUserParams
|
17
|
+
attr_accessor :user, :perm
|
18
|
+
|
19
|
+
class EnumAttributeValidator
|
20
|
+
attr_reader :datatype, :allowable_values
|
21
|
+
|
22
|
+
def initialize(datatype, allowable_values)
|
23
|
+
@allowable_values = allowable_values.map do |value|
|
24
|
+
case datatype.to_s
|
25
|
+
when /Integer/i
|
26
|
+
value.to_i
|
27
|
+
when /Float/i
|
28
|
+
value.to_f
|
29
|
+
else
|
30
|
+
value
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
def valid?(value)
|
36
|
+
!value || allowable_values.include?(value)
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
41
|
+
def self.attribute_map
|
42
|
+
{
|
43
|
+
user: :user,
|
44
|
+
perm: :perm
|
45
|
+
}
|
46
|
+
end
|
47
|
+
|
48
|
+
# Returns all the JSON keys this model knows about
|
49
|
+
def self.acceptable_attributes
|
50
|
+
attribute_map.values
|
51
|
+
end
|
52
|
+
|
53
|
+
# Attribute type mapping.
|
54
|
+
def self.openapi_types
|
55
|
+
{
|
56
|
+
user: :String,
|
57
|
+
perm: :String
|
58
|
+
}
|
59
|
+
end
|
60
|
+
|
61
|
+
# List of attributes with nullable: true
|
62
|
+
def self.openapi_nullable
|
63
|
+
Set.new([
|
64
|
+
])
|
65
|
+
end
|
66
|
+
|
67
|
+
# Initializes the object
|
68
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
69
|
+
def initialize(attributes = {})
|
70
|
+
unless attributes.is_a?(Hash)
|
71
|
+
raise ArgumentError, 'The input argument (attributes) must be a hash in `Gopad::TeamUserParams` initialize method'
|
72
|
+
end
|
73
|
+
|
74
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
75
|
+
attributes = attributes.each_with_object({}) do |(k, v), h|
|
76
|
+
unless self.class.attribute_map.key?(k.to_sym)
|
77
|
+
raise ArgumentError, "`#{k}` is not a valid attribute in `Gopad::TeamUserParams`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
78
|
+
end
|
79
|
+
|
80
|
+
h[k.to_sym] = v
|
81
|
+
end
|
82
|
+
|
83
|
+
self.user = if attributes.key?(:user)
|
84
|
+
attributes[:user]
|
85
|
+
end
|
86
|
+
|
87
|
+
if attributes.key?(:perm)
|
88
|
+
self.perm = attributes[:perm]
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
92
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
93
|
+
# @return Array for valid properties with the reasons
|
94
|
+
def list_invalid_properties
|
95
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
96
|
+
invalid_properties = []
|
97
|
+
if @user.nil?
|
98
|
+
invalid_properties.push('invalid value for "user", user cannot be nil.')
|
99
|
+
end
|
100
|
+
|
101
|
+
invalid_properties
|
102
|
+
end
|
103
|
+
|
104
|
+
# Check to see if the all the properties in the model are valid
|
105
|
+
# @return true if the model is valid
|
106
|
+
def valid?
|
107
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
108
|
+
return false if @user.nil?
|
109
|
+
|
110
|
+
perm_validator = EnumAttributeValidator.new('String', %w[user admin owner])
|
111
|
+
return false unless perm_validator.valid?(@perm)
|
112
|
+
|
113
|
+
true
|
114
|
+
end
|
115
|
+
|
116
|
+
# Custom attribute writer method checking allowed values (enum).
|
117
|
+
# @param [Object] perm Object to be assigned
|
118
|
+
def perm=(perm)
|
119
|
+
validator = EnumAttributeValidator.new('String', %w[user admin owner])
|
120
|
+
unless validator.valid?(perm)
|
121
|
+
raise ArgumentError, "invalid value for \"perm\", must be one of #{validator.allowable_values}."
|
122
|
+
end
|
123
|
+
|
124
|
+
@perm = perm
|
125
|
+
end
|
126
|
+
|
127
|
+
# Checks equality by comparing each attribute.
|
128
|
+
# @param [Object] Object to be compared
|
129
|
+
def ==(other)
|
130
|
+
return true if equal?(other)
|
131
|
+
|
132
|
+
self.class == other.class &&
|
133
|
+
user == other.user &&
|
134
|
+
perm == other.perm
|
135
|
+
end
|
136
|
+
|
137
|
+
# @see the `==` method
|
138
|
+
# @param [Object] Object to be compared
|
139
|
+
def eql?(other)
|
140
|
+
self == other
|
141
|
+
end
|
142
|
+
|
143
|
+
# Calculates hash code according to all attributes.
|
144
|
+
# @return [Integer] Hash code
|
145
|
+
def hash
|
146
|
+
[user, perm].hash
|
147
|
+
end
|
148
|
+
|
149
|
+
# Builds the object from hash
|
150
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
151
|
+
# @return [Object] Returns the model itself
|
152
|
+
def self.build_from_hash(attributes)
|
153
|
+
return nil unless attributes.is_a?(Hash)
|
154
|
+
|
155
|
+
attributes = attributes.transform_keys(&:to_sym)
|
156
|
+
transformed_hash = {}
|
157
|
+
openapi_types.each_pair do |key, type|
|
158
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
159
|
+
transformed_hash[key.to_s] = nil
|
160
|
+
elsif type =~ /\AArray<(.*)>/i
|
161
|
+
# check to ensure the input is an array given that the attribute
|
162
|
+
# is documented as an array but the input is not
|
163
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
164
|
+
transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
|
165
|
+
end
|
166
|
+
elsif !attributes[attribute_map[key]].nil?
|
167
|
+
transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
|
168
|
+
end
|
169
|
+
end
|
170
|
+
new(transformed_hash)
|
171
|
+
end
|
172
|
+
|
173
|
+
# Deserializes the data based on type
|
174
|
+
# @param string type Data type
|
175
|
+
# @param string value Value to be deserialized
|
176
|
+
# @return [Object] Deserialized data
|
177
|
+
def self._deserialize(type, value)
|
178
|
+
case type.to_sym
|
179
|
+
when :Time
|
180
|
+
Time.parse(value)
|
181
|
+
when :Date
|
182
|
+
Date.parse(value)
|
183
|
+
when :String
|
184
|
+
value.to_s
|
185
|
+
when :Integer
|
186
|
+
value.to_i
|
187
|
+
when :Float
|
188
|
+
value.to_f
|
189
|
+
when :Boolean
|
190
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
191
|
+
true
|
192
|
+
else
|
193
|
+
false
|
194
|
+
end
|
195
|
+
when :Object
|
196
|
+
# generic object (usually a Hash), return directly
|
197
|
+
value
|
198
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
199
|
+
inner_type = Regexp.last_match[:inner_type]
|
200
|
+
value.map { |v| _deserialize(inner_type, v) }
|
201
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
202
|
+
k_type = Regexp.last_match[:k_type]
|
203
|
+
v_type = Regexp.last_match[:v_type]
|
204
|
+
{}.tap do |hash|
|
205
|
+
value.each do |k, v|
|
206
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
207
|
+
end
|
208
|
+
end
|
209
|
+
else # model
|
210
|
+
# models (e.g. Pet) or oneOf
|
211
|
+
klass = Gopad.const_get(type)
|
212
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
213
|
+
end
|
214
|
+
end
|
215
|
+
|
216
|
+
# Returns the string representation of the object
|
217
|
+
# @return [String] String presentation of the object
|
218
|
+
def to_s
|
219
|
+
to_hash.to_s
|
220
|
+
end
|
221
|
+
|
222
|
+
# to_body is an alias to to_hash (backward compatibility)
|
223
|
+
# @return [Hash] Returns the object in the form of hash
|
224
|
+
def to_body
|
225
|
+
to_hash
|
226
|
+
end
|
227
|
+
|
228
|
+
# Returns the object in the form of hash
|
229
|
+
# @return [Hash] Returns the object in the form of hash
|
230
|
+
def to_hash
|
231
|
+
hash = {}
|
232
|
+
self.class.attribute_map.each_pair do |attr, param|
|
233
|
+
value = send(attr)
|
234
|
+
if value.nil?
|
235
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
236
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
237
|
+
end
|
238
|
+
|
239
|
+
hash[param] = _to_hash(value)
|
240
|
+
end
|
241
|
+
hash
|
242
|
+
end
|
243
|
+
|
244
|
+
# Outputs non-array value in the form of hash
|
245
|
+
# For object, use to_hash. Otherwise, just return the value
|
246
|
+
# @param [Object] value Any valid value
|
247
|
+
# @return [Hash] Returns the value in the form of hash
|
248
|
+
def _to_hash(value)
|
249
|
+
if value.is_a?(Array)
|
250
|
+
value.compact.map { |v| _to_hash(v) }
|
251
|
+
elsif value.is_a?(Hash)
|
252
|
+
{}.tap do |hash|
|
253
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
254
|
+
end
|
255
|
+
elsif value.respond_to? :to_hash
|
256
|
+
value.to_hash
|
257
|
+
else
|
258
|
+
value
|
259
|
+
end
|
260
|
+
end
|
261
|
+
end
|
262
|
+
end
|