test-words-api-client-sdk 1.0.4 → 3.0.1
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 +4 -4
- data/README.md +10 -10
- data/lib/words_api/controllers/base_controller.rb +9 -9
- data/lib/words_api/utilities/file_wrapper.rb +9 -9
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a9423c551feebe6f41512cd9153d77938013fafca2fd0f82643e94bd9ce934d0
|
4
|
+
data.tar.gz: 691a4abf7ce92810eefa1d09e47f409f5cad819151c53cb146502438f19e9716
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5b452c593d474bbfd6d35993631480cbd2f317f05f45e1176197176bd6e7e05eea5d042d0eacb19b7d4e5f82aff7f9b173a16c623a3a47fe7284351e854dcf93
|
7
|
+
data.tar.gz: 6fcfa787e922870c088a1576f21c5848fedb25e804665631610d1ea8df2841913698935c7c8a42a5eac05e86d564a40d2f6eebf7e8fb3faf8ccf7feb37a8c93c
|
data/README.md
CHANGED
@@ -10,16 +10,16 @@ Words API lets you retrieve information about English words, including definitio
|
|
10
10
|
Install the gem from the command line:
|
11
11
|
|
12
12
|
```ruby
|
13
|
-
gem install test-words-api-client-sdk -v
|
13
|
+
gem install test-words-api-client-sdk -v 3.0.1
|
14
14
|
```
|
15
15
|
|
16
16
|
Or add the gem to your Gemfile and run `bundle`:
|
17
17
|
|
18
18
|
```ruby
|
19
|
-
gem 'test-words-api-client-sdk', '
|
19
|
+
gem 'test-words-api-client-sdk', '3.0.1'
|
20
20
|
```
|
21
21
|
|
22
|
-
For additional gem details, see the [RubyGems page for the test-words-api-client-sdk gem](https://rubygems.org/gems/test-words-api-client-sdk/versions/
|
22
|
+
For additional gem details, see the [RubyGems page for the test-words-api-client-sdk gem](https://rubygems.org/gems/test-words-api-client-sdk/versions/3.0.1).
|
23
23
|
|
24
24
|
## Test the SDK
|
25
25
|
|
@@ -31,7 +31,7 @@ rake
|
|
31
31
|
|
32
32
|
## Initialize the API Client
|
33
33
|
|
34
|
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/
|
34
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.1/doc/client.md)
|
35
35
|
|
36
36
|
The following parameters are configurable for the API Client:
|
37
37
|
|
@@ -46,7 +46,7 @@ The following parameters are configurable for the API Client:
|
|
46
46
|
| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
47
47
|
| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
48
48
|
| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
49
|
-
| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/
|
49
|
+
| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
|
50
50
|
|
51
51
|
The API client can be initialized as follows:
|
52
52
|
|
@@ -62,15 +62,15 @@ client = WordsApi::Client.new(
|
|
62
62
|
|
63
63
|
This API uses the following authentication schemes.
|
64
64
|
|
65
|
-
* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/
|
65
|
+
* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.1/doc/auth/custom-header-signature.md)
|
66
66
|
|
67
67
|
## List of APIs
|
68
68
|
|
69
|
-
* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/
|
69
|
+
* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.1/doc/controllers/ap-is.md)
|
70
70
|
|
71
71
|
## Classes Documentation
|
72
72
|
|
73
|
-
* [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/
|
74
|
-
* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/
|
75
|
-
* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/
|
73
|
+
* [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.1/doc/utility-classes.md)
|
74
|
+
* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.1/doc/http-response.md)
|
75
|
+
* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.1/doc/http-request.md)
|
76
76
|
|
@@ -30,15 +30,15 @@ module WordsApi
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Creates a new builder for the Api Call instance.
|
33
|
-
# @return [ApiCall] The instance of ApiCall.
|
34
|
-
def new_api_call_builder
|
35
|
-
@api_call.new_builder
|
36
|
-
end
|
37
|
-
|
38
|
-
# Creates a new instance of the request builder.
|
39
|
-
# @param [String] http_method The HTTP method to use in the request.
|
40
|
-
# @param [String] path The endpoint path to use in the request.
|
41
|
-
# @param [String] server The server to extract the base uri for the request.
|
33
|
+
# @return [ApiCall] The instance of ApiCall.
|
34
|
+
def new_api_call_builder
|
35
|
+
@api_call.new_builder
|
36
|
+
end
|
37
|
+
|
38
|
+
# Creates a new instance of the request builder.
|
39
|
+
# @param [String] http_method The HTTP method to use in the request.
|
40
|
+
# @param [String] path The endpoint path to use in the request.
|
41
|
+
# @param [String] server The server to extract the base uri for the request.
|
42
42
|
# @return [RequestBuilder] The instance of RequestBuilder.
|
43
43
|
def new_request_builder(http_method, path, server)
|
44
44
|
RequestBuilder.new
|
@@ -5,12 +5,12 @@
|
|
5
5
|
|
6
6
|
module WordsApi
|
7
7
|
# A utility to allow users to set the content-type for files
|
8
|
-
class FileWrapper < CoreLibrary::FileWrapper
|
9
|
-
# The constructor.
|
10
|
-
# @param [File] file The file to be sent in the request.
|
11
|
-
# @param [string] content_type The content type of the provided file.
|
12
|
-
def initialize(file, content_type: 'application/octet-stream')
|
13
|
-
super
|
14
|
-
end
|
15
|
-
end
|
16
|
-
end
|
8
|
+
class FileWrapper < CoreLibrary::FileWrapper
|
9
|
+
# The constructor.
|
10
|
+
# @param [File] file The file to be sent in the request.
|
11
|
+
# @param [string] content_type The content type of the provided file.
|
12
|
+
def initialize(file, content_type: 'application/octet-stream')
|
13
|
+
super
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: test-words-api-client-sdk
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 3.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Sufyan
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-10-
|
11
|
+
date: 2024-10-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: apimatic_core_interfaces
|
@@ -141,6 +141,6 @@ requirements: []
|
|
141
141
|
rubygems_version: 3.1.6
|
142
142
|
signing_key:
|
143
143
|
specification_version: 4
|
144
|
-
summary: Words API lets you retrieve information about English words, including
|
145
|
-
synonyms, rhymes, pronunciation, syllables, and frequency of usage.
|
144
|
+
summary: Test Words API lets you retrieve information about English words, including
|
145
|
+
definitions, synonyms, rhymes, pronunciation, syllables, and frequency of usage.
|
146
146
|
test_files: []
|