test-words-api-client-sdk 3.0.3 → 3.0.4

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.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -10
  3. data/lib/words_api/controllers/base_controller.rb +9 -9
  4. data/lib/words_api/utilities/file_wrapper.rb +9 -9
  5. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5ddbb43398c88cbf888688b9ce4d40d5d1e37115638a2b8c51ca6d6cdff2d2b7
4
- data.tar.gz: 20bf467807227f5aeb4fb9db095081100f2e79b091638f55a296eff9b100b055
3
+ metadata.gz: 4f3425333f011d7a29d8edba585d6abc08221fd3786a3d9e5d03bf36469aa861
4
+ data.tar.gz: 8a39d4a810625adac934a363a11ab52d63cbf13e0a8368adfbfb8a45e7be8285
5
5
  SHA512:
6
- metadata.gz: e6d8ad5cc4ada943b612776423453a73befa805e93b02646ee3657dcb55ef41a32cca682ee6d26f558458ece4dc5dc9e86283ccdeb231dc8601f9bc79ccbf7b4
7
- data.tar.gz: 36c878440cbb303343bb0aa6a642480e32bd7b3b3819789af038e35ca4e53cfdd834eb9f67e97ca4ae0c8b71e805995fbe0119785d45e17122862fe54ba7f344
6
+ metadata.gz: 1e1ba4504040a61bc08aa759a5d1db337578e96ad297d605fe806168267a6424d96d49eb77306f5486c204d864e26d872fe4447b715b408d7980c77ac9ea6344
7
+ data.tar.gz: a5c76dbda9c5de33c50c4470b15e9548374027a9e2ed0cfd87902131476413a5853188456a72573c995d4af1b3cd3c4d64efd0fd6cc28bdde396e18250182d50
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 3.0.3
13
+ gem install test-words-api-client-sdk -v 3.0.4
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', '3.0.3'
19
+ gem 'test-words-api-client-sdk', '3.0.4'
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/3.0.3).
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.4).
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/3.0.3/doc/client.md)
34
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.4/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/3.0.3/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
49
+ | `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.4/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/3.0.3/doc/auth/custom-header-signature.md)
65
+ * [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.4/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/3.0.3/doc/controllers/ap-is.md)
69
+ * [AP Is](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.4/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/3.0.3/doc/utility-classes.md)
74
- * [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.3/doc/http-response.md)
75
- * [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.3/doc/http-request.md)
73
+ * [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.4/doc/utility-classes.md)
74
+ * [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.4/doc/http-response.md)
75
+ * [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.4/doc/http-request.md)
76
76
 
data/lib/words_api/controllers/base_controller.rb CHANGED
@@ -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
data/lib/words_api/utilities/file_wrapper.rb CHANGED
@@ -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,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: test-words-api-client-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.3
4
+ version: 3.0.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sufyan