fastcomments 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9588e95449c3557fcbf3664870e8e52bc53b33b3dac156fcba54e374d4add258
4
- data.tar.gz: 726eba5099ef896b1231e043f06a606ddb83fab59f37979d9b3bd5bdafcdc4d7
3
+ metadata.gz: 4f4dfd907e77c9c85746aa5df1a51e71bc7289d83fb67954669a261b61885e2f
4
+ data.tar.gz: 8fe9e73a16bbd99d230165b93b4606589568c5d47c0bf256eee1f20131e0140c
5
5
  SHA512:
6
- metadata.gz: f67506f611434e52eddecbc4a351d2b198f2334d8d42e74f091627ef90dc1c5ac2f654fba43b46b0db03c4efe5855cb5677365f3f80815e25207239d83fce935
7
- data.tar.gz: 0c9f4fe046a457defa69792677774e11cc9478395fda36c904ec5986344ee4a3e4a608a864ce3678a02073e17bccb781352a2637a86872b35a84053048578229
6
+ metadata.gz: 3dc762cb7140a687ab3cd1a90feeca48f9f001d7c2e0fd25c9601a5f5fbbd7b524e2344a7a5ef05e07dc2422aeba91b8eb9059ad8c57e313f0143655f86b7b36
7
+ data.tar.gz: be6038148f9a9e4a2dabccdf05c8b4b4885f0375227dd40a7a785205d209d5e7b66cea010177ab88284bcc54b2859c5b14bc6e6581be14b53e84985c8585dd4b
data/README.md CHANGED
@@ -29,12 +29,12 @@ This library contains the generated API client and the SSO utilities to make wor
29
29
 
30
30
  ### Public vs Secured APIs
31
31
 
32
- For the API client, there are two classes, `DefaultAPI` and `PublicAPI`. The `DefaultAPI` contains methods that require your API key, and `PublicAPI` contains api calls
32
+ For the API client, there are two classes, `DefaultApi` and `PublicApi`. The `DefaultApi` contains methods that require your API key, and `PublicApi` contains api calls
33
33
  that can be made directly from a browser/mobile device/etc without authentication.
34
34
 
35
35
  ## Quick Start
36
36
 
37
- ### Using Authenticated APIs (DefaultAPI)
37
+ ### Using Authenticated APIs (DefaultApi)
38
38
 
39
39
  **Important:** You must set your API key on the ApiClient before making authenticated requests. If you don't, requests will fail with a 401 error.
40
40
 
@@ -46,10 +46,10 @@ config = FastCommentsClient::Configuration.new
46
46
  api_client = FastCommentsClient::ApiClient.new(config)
47
47
 
48
48
  # REQUIRED: Set your API key (get this from your FastComments dashboard)
49
- config.api_key['ApiKeyAuth'] = 'YOUR_API_KEY_HERE'
49
+ config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
50
50
 
51
51
  # Create the API instance with the configured client
52
- api = FastCommentsClient::DefaultAPI.new(api_client)
52
+ api = FastCommentsClient::DefaultApi.new(api_client)
53
53
 
54
54
  # Now you can make authenticated API calls
55
55
  begin
@@ -71,14 +71,14 @@ rescue FastCommentsClient::ApiError => e
71
71
  end
72
72
  ```
73
73
 
74
- ### Using Public APIs (PublicAPI)
74
+ ### Using Public APIs (PublicApi)
75
75
 
76
76
  Public endpoints don't require authentication:
77
77
 
78
78
  ```ruby
79
79
  require 'fastcomments-client'
80
80
 
81
- public_api = FastCommentsClient::PublicAPI.new
81
+ public_api = FastCommentsClient::PublicApi.new
82
82
 
83
83
  begin
84
84
  response = public_api.get_comments_public(
@@ -93,8 +93,8 @@ end
93
93
 
94
94
  ### Common Issues
95
95
 
96
- 1. **401 "missing-api-key" error**: Make sure you set `config.api_key['ApiKeyAuth'] = 'YOUR_KEY'` before creating the DefaultAPI instance.
97
- 2. **Wrong API class**: Use `DefaultAPI` for server-side authenticated requests, `PublicAPI` for client-side/public requests.
96
+ 1. **401 "missing-api-key" error**: Make sure you set `config.api_key['x-api-key'] = 'YOUR_KEY'` before creating the DefaultApi instance.
97
+ 2. **Wrong API class**: Use `DefaultApi` for server-side authenticated requests, `PublicApi` for client-side/public requests.
98
98
  3. **Null API key**: The SDK will silently skip authentication if the API key is null, leading to 401 errors.
99
99
 
100
100
  ## Notes
@@ -131,7 +131,7 @@ puts "SSO Token: #{token}"
131
131
  # Use the SSO token to make an authenticated API call
132
132
  config = FastCommentsClient::Configuration.new
133
133
  api_client = FastCommentsClient::ApiClient.new(config)
134
- public_api = FastCommentsClient::PublicAPI.new(api_client)
134
+ public_api = FastCommentsClient::PublicApi.new(api_client)
135
135
 
136
136
  response = public_api.get_comments_public(
137
137
  tenant_id: 'your-tenant-id',
@@ -165,7 +165,7 @@ puts "Secure SSO Token: #{token}"
165
165
  # Use the SSO token to make an authenticated API call
166
166
  config = FastCommentsClient::Configuration.new
167
167
  api_client = FastCommentsClient::ApiClient.new(config)
168
- public_api = FastCommentsClient::PublicAPI.new(api_client)
168
+ public_api = FastCommentsClient::PublicApi.new(api_client)
169
169
 
170
170
  response = public_api.get_comments_public(
171
171
  tenant_id: 'your-tenant-id',
@@ -193,6 +193,8 @@ bundle exec rspec
193
193
 
194
194
  ## Development
195
195
 
196
+ Currently to bump version update config.json, fastcomments.gemspec, lib/fastcomments.rb
197
+
196
198
  To update the generated client from the OpenAPI spec:
197
199
 
198
200
  ```bash
data/client/README.md CHANGED
@@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 0.0.0
10
- - Package version: 0.1.0
10
+ - Package version: 0.2.0
11
11
  - Generator version: 7.14.0
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
 
@@ -24,16 +24,16 @@ gem build fastcomments-client.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./fastcomments-client-0.1.0.gem
27
+ gem install ./fastcomments-client-0.2.0.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./fastcomments-client-0.1.0.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./fastcomments-client-0.2.0.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'fastcomments-client', '~> 0.1.0'
36
+ gem 'fastcomments-client', '~> 0.2.0'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **status** | [**APIStatus**](APIStatus.md) | | |
8
8
  | **user_badge** | [**UserBadge**](UserBadge.md) | | |
9
+ | **notes** | **Array<String>** | | [optional] |
9
10
 
10
11
  ## Example
11
12
 
@@ -14,7 +15,8 @@ require 'fastcomments-client'
14
15
 
15
16
  instance = FastCommentsClient::APICreateUserBadgeResponse.new(
16
17
  status: null,
17
- user_badge: null
18
+ user_badge: null,
19
+ notes: null
18
20
  )
19
21
  ```
20
22
 
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **status** | [**APIStatus**](APIStatus.md) | | |
8
8
  | **user_badge** | [**UserBadge**](UserBadge.md) | | |
9
+ | **notes** | **Array<String>** | | [optional] |
9
10
  | **reason** | **String** | | |
10
11
  | **code** | **String** | | |
11
12
  | **secondary_code** | **String** | | [optional] |
@@ -22,6 +23,7 @@ require 'fastcomments-client'
22
23
  instance = FastCommentsClient::CreateUserBadge200Response.new(
23
24
  status: null,
24
25
  user_badge: null,
26
+ notes: null,
25
27
  reason: null,
26
28
  code: null,
27
29
  secondary_code: null,
@@ -56,6 +56,7 @@
56
56
  | **no_styles** | **Boolean** | | [optional] |
57
57
  | **page_size** | **Integer** | | [optional] |
58
58
  | **readonly** | **Boolean** | | [optional] |
59
+ | **no_new_root_comments** | **Boolean** | | [optional] |
59
60
  | **require_sso** | **Boolean** | | [optional] |
60
61
  | **enable_resize_handle** | **Boolean** | | [optional] |
61
62
  | **restricted_link_domains** | **Array<String>** | | [optional] |
@@ -135,6 +136,7 @@ instance = FastCommentsClient::CustomConfigParameters.new(
135
136
  no_styles: null,
136
137
  page_size: null,
137
138
  readonly: null,
139
+ no_new_root_comments: null,
138
140
  require_sso: null,
139
141
  enable_resize_handle: null,
140
142
  restricted_link_domains: null,
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **reason** | **String** | | [optional] |
8
8
  | **code** | **String** | | [optional] |
9
+ | **comments_updated** | **Integer** | | [optional] |
9
10
  | **page** | [**APIPage**](APIPage.md) | | [optional] |
10
11
  | **status** | **String** | | |
11
12
 
@@ -17,6 +18,7 @@ require 'fastcomments-client'
17
18
  instance = FastCommentsClient::PatchPageAPIResponse.new(
18
19
  reason: null,
19
20
  code: null,
21
+ comments_updated: null,
20
22
  page: null,
21
23
  status: null
22
24
  )
@@ -278,9 +278,13 @@ module FastCommentsClient
278
278
  data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
279
279
  end
280
280
  else
281
- # models (e.g. Pet) or oneOf
281
+ # models (e.g. Pet) or oneOf/anyOf
282
282
  klass = FastCommentsClient.const_get(return_type)
283
- klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
283
+ if klass.respond_to?(:openapi_one_of) || klass.respond_to?(:openapi_any_of)
284
+ klass.build(data)
285
+ else
286
+ klass.build_from_hash(data)
287
+ end
284
288
  end
285
289
  end
286
290
 
@@ -19,6 +19,8 @@ module FastCommentsClient
19
19
 
20
20
  attr_accessor :user_badge
21
21
 
22
+ attr_accessor :notes
23
+
22
24
  class EnumAttributeValidator
23
25
  attr_reader :datatype
24
26
  attr_reader :allowable_values
@@ -45,7 +47,8 @@ module FastCommentsClient
45
47
  def self.attribute_map
46
48
  {
47
49
  :'status' => :'status',
48
- :'user_badge' => :'userBadge'
50
+ :'user_badge' => :'userBadge',
51
+ :'notes' => :'notes'
49
52
  }
50
53
  end
51
54
 
@@ -63,7 +66,8 @@ module FastCommentsClient
63
66
  def self.openapi_types
64
67
  {
65
68
  :'status' => :'APIStatus',
66
- :'user_badge' => :'UserBadge'
69
+ :'user_badge' => :'UserBadge',
70
+ :'notes' => :'Array<String>'
67
71
  }
68
72
  end
69
73
 
@@ -100,6 +104,12 @@ module FastCommentsClient
100
104
  else
101
105
  self.user_badge = nil
102
106
  end
107
+
108
+ if attributes.key?(:'notes')
109
+ if (value = attributes[:'notes']).is_a?(Array)
110
+ self.notes = value
111
+ end
112
+ end
103
113
  end
104
114
 
105
115
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -153,7 +163,8 @@ module FastCommentsClient
153
163
  return true if self.equal?(o)
154
164
  self.class == o.class &&
155
165
  status == o.status &&
156
- user_badge == o.user_badge
166
+ user_badge == o.user_badge &&
167
+ notes == o.notes
157
168
  end
158
169
 
159
170
  # @see the `==` method
@@ -165,7 +176,7 @@ module FastCommentsClient
165
176
  # Calculates hash code according to all attributes.
166
177
  # @return [Integer] Hash code
167
178
  def hash
168
- [status, user_badge].hash
179
+ [status, user_badge, notes].hash
169
180
  end
170
181
 
171
182
  # Builds the object from hash
@@ -119,6 +119,8 @@ module FastCommentsClient
119
119
 
120
120
  attr_accessor :readonly
121
121
 
122
+ attr_accessor :no_new_root_comments
123
+
122
124
  attr_accessor :require_sso
123
125
 
124
126
  attr_accessor :enable_resize_handle
@@ -237,6 +239,7 @@ module FastCommentsClient
237
239
  :'no_styles' => :'noStyles',
238
240
  :'page_size' => :'pageSize',
239
241
  :'readonly' => :'readonly',
242
+ :'no_new_root_comments' => :'noNewRootComments',
240
243
  :'require_sso' => :'requireSSO',
241
244
  :'enable_resize_handle' => :'enableResizeHandle',
242
245
  :'restricted_link_domains' => :'restrictedLinkDomains',
@@ -325,6 +328,7 @@ module FastCommentsClient
325
328
  :'no_styles' => :'Boolean',
326
329
  :'page_size' => :'Integer',
327
330
  :'readonly' => :'Boolean',
331
+ :'no_new_root_comments' => :'Boolean',
328
332
  :'require_sso' => :'Boolean',
329
333
  :'enable_resize_handle' => :'Boolean',
330
334
  :'restricted_link_domains' => :'Array<String>',
@@ -596,6 +600,10 @@ module FastCommentsClient
596
600
  self.readonly = attributes[:'readonly']
597
601
  end
598
602
 
603
+ if attributes.key?(:'no_new_root_comments')
604
+ self.no_new_root_comments = attributes[:'no_new_root_comments']
605
+ end
606
+
599
607
  if attributes.key?(:'require_sso')
600
608
  self.require_sso = attributes[:'require_sso']
601
609
  end
@@ -755,6 +763,7 @@ module FastCommentsClient
755
763
  no_styles == o.no_styles &&
756
764
  page_size == o.page_size &&
757
765
  readonly == o.readonly &&
766
+ no_new_root_comments == o.no_new_root_comments &&
758
767
  require_sso == o.require_sso &&
759
768
  enable_resize_handle == o.enable_resize_handle &&
760
769
  restricted_link_domains == o.restricted_link_domains &&
@@ -786,7 +795,7 @@ module FastCommentsClient
786
795
  # Calculates hash code according to all attributes.
787
796
  # @return [Integer] Hash code
788
797
  def hash
789
- [absolute_and_relative_dates, absolute_dates, allow_anon, allow_anon_flag, allow_anon_votes, allowed_languages, collapse_replies, comment_count_format, comment_html_rendering_mode, comment_thread_delete_mode, commenter_name_format, count_above_toggle, custom_css, default_avatar_src, default_sort_direction, default_username, disable_auto_admin_migration, disable_auto_hash_tag_creation, disable_blocking, disable_commenter_comment_delete, disable_commenter_comment_edit, disable_email_inputs, disable_live_commenting, disable_notification_bell, disable_profiles, disable_success_message, disable_toolbar, disable_unverified_label, disable_voting, enable_commenter_links, enable_search, enable_spoilers, enable_third_party_cookie_bypass, enable_view_counts, enable_vote_list, enable_wysiwyg, gif_rating, has_dark_background, header_html, hide_avatars, hide_comments_under_count_text_format, image_content_profanity_level, input_after_comments, limit_comments_by_groups, locale, max_comment_character_length, max_comment_created_count_pupm, no_custom_config, no_image_uploads, no_styles, page_size, readonly, require_sso, enable_resize_handle, restricted_link_domains, show_badges_in_top_bar, show_comment_save_success, show_live_right_away, show_question, spam_rules, sso_sec_lvl, translations, use_show_comments_toggle, use_single_line_comment_input, vote_style, widget_question_id, widget_question_results_style, widget_question_style, widget_question_when_to_save, widget_questions_required, widget_sub_question_visibility, wrap].hash
798
+ [absolute_and_relative_dates, absolute_dates, allow_anon, allow_anon_flag, allow_anon_votes, allowed_languages, collapse_replies, comment_count_format, comment_html_rendering_mode, comment_thread_delete_mode, commenter_name_format, count_above_toggle, custom_css, default_avatar_src, default_sort_direction, default_username, disable_auto_admin_migration, disable_auto_hash_tag_creation, disable_blocking, disable_commenter_comment_delete, disable_commenter_comment_edit, disable_email_inputs, disable_live_commenting, disable_notification_bell, disable_profiles, disable_success_message, disable_toolbar, disable_unverified_label, disable_voting, enable_commenter_links, enable_search, enable_spoilers, enable_third_party_cookie_bypass, enable_view_counts, enable_vote_list, enable_wysiwyg, gif_rating, has_dark_background, header_html, hide_avatars, hide_comments_under_count_text_format, image_content_profanity_level, input_after_comments, limit_comments_by_groups, locale, max_comment_character_length, max_comment_created_count_pupm, no_custom_config, no_image_uploads, no_styles, page_size, readonly, no_new_root_comments, require_sso, enable_resize_handle, restricted_link_domains, show_badges_in_top_bar, show_comment_save_success, show_live_right_away, show_question, spam_rules, sso_sec_lvl, translations, use_show_comments_toggle, use_single_line_comment_input, vote_style, widget_question_id, widget_question_results_style, widget_question_style, widget_question_when_to_save, widget_questions_required, widget_sub_question_visibility, wrap].hash
790
799
  end
791
800
 
792
801
  # Builds the object from hash
@@ -19,6 +19,8 @@ module FastCommentsClient
19
19
 
20
20
  attr_accessor :code
21
21
 
22
+ attr_accessor :comments_updated
23
+
22
24
  attr_accessor :page
23
25
 
24
26
  attr_accessor :status
@@ -28,6 +30,7 @@ module FastCommentsClient
28
30
  {
29
31
  :'reason' => :'reason',
30
32
  :'code' => :'code',
33
+ :'comments_updated' => :'commentsUpdated',
31
34
  :'page' => :'page',
32
35
  :'status' => :'status'
33
36
  }
@@ -48,6 +51,7 @@ module FastCommentsClient
48
51
  {
49
52
  :'reason' => :'String',
50
53
  :'code' => :'String',
54
+ :'comments_updated' => :'Integer',
51
55
  :'page' => :'APIPage',
52
56
  :'status' => :'String'
53
57
  }
@@ -83,6 +87,10 @@ module FastCommentsClient
83
87
  self.code = attributes[:'code']
84
88
  end
85
89
 
90
+ if attributes.key?(:'comments_updated')
91
+ self.comments_updated = attributes[:'comments_updated']
92
+ end
93
+
86
94
  if attributes.key?(:'page')
87
95
  self.page = attributes[:'page']
88
96
  end
@@ -131,6 +139,7 @@ module FastCommentsClient
131
139
  self.class == o.class &&
132
140
  reason == o.reason &&
133
141
  code == o.code &&
142
+ comments_updated == o.comments_updated &&
134
143
  page == o.page &&
135
144
  status == o.status
136
145
  end
@@ -144,7 +153,7 @@ module FastCommentsClient
144
153
  # Calculates hash code according to all attributes.
145
154
  # @return [Integer] Hash code
146
155
  def hash
147
- [reason, code, page, status].hash
156
+ [reason, code, comments_updated, page, status].hash
148
157
  end
149
158
 
150
159
  # Builds the object from hash
@@ -11,5 +11,5 @@ Generator version: 7.14.0
11
11
  =end
12
12
 
13
13
  module FastCommentsClient
14
- VERSION = '0.1.0'
14
+ VERSION = '0.2.0'
15
15
  end
@@ -39,4 +39,10 @@ describe FastCommentsClient::APICreateUserBadgeResponse do
39
39
  end
40
40
  end
41
41
 
42
+ describe 'test attribute "notes"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
42
48
  end
@@ -339,6 +339,12 @@ describe FastCommentsClient::CustomConfigParameters do
339
339
  end
340
340
  end
341
341
 
342
+ describe 'test attribute "no_new_root_comments"' do
343
+ it 'should work' do
344
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
345
+ end
346
+ end
347
+
342
348
  describe 'test attribute "require_sso"' do
343
349
  it 'should work' do
344
350
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -39,6 +39,12 @@ describe FastCommentsClient::PatchPageAPIResponse do
39
39
  end
40
40
  end
41
41
 
42
+ describe 'test attribute "comments_updated"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
42
48
  describe 'test attribute "page"' do
43
49
  it 'should work' do
44
50
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
data/lib/fastcomments.rb CHANGED
@@ -5,5 +5,5 @@ require_relative 'fastcomments/sso/simple_sso_user_data'
5
5
  require_relative 'fastcomments/sso/fastcomments_sso'
6
6
 
7
7
  module FastComments
8
- VERSION = '0.1.0'
8
+ VERSION = '0.2.0'
9
9
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: fastcomments
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - FastComments
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-11-18 00:00:00.000000000 Z
11
+ date: 2025-11-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus