apiverve_permutationcombination 1.2.0 → 1.2.2

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: 93092a01f70164da689c80561eb65b7178508e141cd8ba871c0bb97ce1775059
4
- data.tar.gz: c2094b8dcab7d45a47adb912a8e22de581bf8852cee16a20497c88d1912b7899
3
+ metadata.gz: 8aed762a982cccc2864c047c0113fe50a7b7105eba4daf152c12d8b64c88dd98
4
+ data.tar.gz: 5bed56a37d6fccc4cf7f5ab70e0da8722298b913f508cd800f61e9e226ff7442
5
5
  SHA512:
6
- metadata.gz: e8595e00a82fda356e87b4cf996d2393bd0e72a9a0c8de3b749f033e16c18e2357514eb1955fbdaaede9ca7756136e9b3e1748161aaf8392189b755281f8007f
7
- data.tar.gz: 8a93cd5b097ea47bfe8f6bc6eafd2f9d0a09512421e904a0c00a3610d7a15f0ed0ea730cdad7f16cd626dbfb2831a4db3b64467fbafb295955a7b80906c986d8
6
+ metadata.gz: 236aa91fdcc41f0686c940e149272182223bc8045c1e2c757a333d472ca72472c097df542de2f0a71c5d5612912ab86fd8ec93da4be19c5a48b0987535c80ce1
7
+ data.tar.gz: d7393a3761734a4e31a03076838b452ef6d4896e543ddefadb5fc6d5399ce6dda6928f552038020887fcc307aab358365723291e93279ae80b06f7824b0da913
data/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) {{year}} APIVerve
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 APIVerve and EvlarSoft LLC
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -1,77 +1,77 @@
1
- # Permutation & Combination Calculator API - Ruby Gem
2
-
3
- Calculate permutations (P(n,r)) and combinations (C(n,r)) for any given values of n and r.
4
-
5
- ## Installation
6
-
7
- Add this line to your application's Gemfile:
8
-
9
- ```ruby
10
- gem 'apiverve_permutationcombination'
11
- ```
12
-
13
- And then execute:
14
-
15
- ```bash
16
- $ bundle install
17
- ```
18
-
19
- Or install it yourself as:
20
-
21
- ```bash
22
- $ gem install apiverve_permutationcombination
23
- ```
24
-
25
- ## Getting Started
26
-
27
- Get your API key at [APIVerve](https://apiverve.com)
28
-
29
- ### Basic Usage
30
-
31
- ```ruby
32
- require 'apiverve_permutationcombination'
33
-
34
- # Initialize the client
35
- client = APIVerve::Permutationcombination::Client.new(api_key: "YOUR_API_KEY")
36
-
37
- # Make a request
38
- response = client.execute({
1
+ # Permutation & Combination Calculator API - Ruby Gem
2
+
3
+ Calculate permutations (P(n,r)) and combinations (C(n,r)) for any given values of n and r.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'apiverve_permutationcombination'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ ```bash
16
+ $ bundle install
17
+ ```
18
+
19
+ Or install it yourself as:
20
+
21
+ ```bash
22
+ $ gem install apiverve_permutationcombination
23
+ ```
24
+
25
+ ## Getting Started
26
+
27
+ Get your API key at [APIVerve](https://apiverve.com)
28
+
29
+ ### Basic Usage
30
+
31
+ ```ruby
32
+ require 'apiverve_permutationcombination'
33
+
34
+ # Initialize the client
35
+ client = APIVerve::Permutationcombination::Client.new(api_key: "YOUR_API_KEY")
36
+
37
+ # Make a request
38
+ response = client.execute({
39
39
  n: 10,
40
- r: 3
41
- })
42
-
43
- # Print the response
44
- puts response
45
- ```
46
-
47
-
48
- ### Error Handling
49
-
50
- ```ruby
51
- begin
52
- response = client.execute({ n: 10, r: 3 })
53
- puts response["data"]
54
- rescue APIVerve::Permutationcombination::ValidationError => e
55
- puts "Validation error: #{e.errors.join(', ')}"
56
- rescue APIVerve::Permutationcombination::APIError => e
57
- puts "API error: #{e.message}"
58
- puts "Status code: #{e.status_code}"
59
- end
60
- ```
61
-
62
- ### Debug Mode
63
-
64
- ```ruby
65
- # Enable debug logging
66
- client = APIVerve::Permutationcombination::Client.new(
67
- api_key: "YOUR_API_KEY",
68
- debug: true
69
- )
70
- ```
71
-
72
- ## Example Response
73
-
74
- ```json
40
+ r: 3
41
+ })
42
+
43
+ # Print the response
44
+ puts response
45
+ ```
46
+
47
+
48
+ ### Error Handling
49
+
50
+ ```ruby
51
+ begin
52
+ response = client.execute({ n: 10, r: 3 })
53
+ puts response["data"]
54
+ rescue APIVerve::Permutationcombination::ValidationError => e
55
+ puts "Validation error: #{e.errors.join(', ')}"
56
+ rescue APIVerve::Permutationcombination::APIError => e
57
+ puts "API error: #{e.message}"
58
+ puts "Status code: #{e.status_code}"
59
+ end
60
+ ```
61
+
62
+ ### Debug Mode
63
+
64
+ ```ruby
65
+ # Enable debug logging
66
+ client = APIVerve::Permutationcombination::Client.new(
67
+ api_key: "YOUR_API_KEY",
68
+ debug: true
69
+ )
70
+ ```
71
+
72
+ ## Example Response
73
+
74
+ ```json
75
75
  {
76
76
  "status": "ok",
77
77
  "error": null,
@@ -85,18 +85,18 @@ client = APIVerve::Permutationcombination::Client.new(
85
85
  "combination": "C(n,r) = n! / (r! × (n-r)!)"
86
86
  }
87
87
  }
88
- }
89
- ```
90
-
91
- ## Documentation
92
-
93
- For more information, visit the [API Documentation](https://docs.apiverve.com/ref/permutationcombination?utm_source=rubygems&utm_medium=readme).
94
-
95
- ## Support
96
-
97
- - Website: [https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=readme](https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=readme)
98
- - Email: hello@apiverve.com
99
-
100
- ## License
101
-
102
- This gem is available under the [MIT License](LICENSE).
88
+ }
89
+ ```
90
+
91
+ ## Documentation
92
+
93
+ For more information, visit the [API Documentation](https://docs.apiverve.com/ref/permutationcombination?utm_source=rubygems&utm_medium=referral&utm_content=readme).
94
+
95
+ ## Support
96
+
97
+ - Website: [https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=referral&utm_content=readme](https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=referral&utm_content=readme)
98
+ - Email: hello@apiverve.com
99
+
100
+ ## License
101
+
102
+ This gem is available under the [MIT License](LICENSE).
@@ -1,187 +1,184 @@
1
- # frozen_string_literal: true
2
-
3
- require "faraday"
4
- require "faraday/multipart"
5
- require "json"
6
-
7
- module APIVerve
8
- module Permutationcombination
9
- # Client for the Permutation & Combination Calculator API
10
- #
11
- # @example Basic usage
12
- # client = APIVerve::Permutationcombination::Client.new(api_key: "your_api_key")
13
- # response = client.execute({ n: 10, r: 3 })
14
- # puts response
15
- #
16
- # @see https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=readme
17
- class Client
18
- BASE_URL = "https://api.apiverve.com/v1/permutationcombination"
19
- DEFAULT_TIMEOUT = 30
20
-
21
- # Validation rules for parameters
22
- VALIDATION_RULES = {
23
- 'n' => { type: 'integer', required: true, min: 0, max: 170 },
24
- 'r' => { type: 'integer', required: true, min: 0, max: 170 }
25
- }
26
-
27
- # Format validation patterns
28
- FORMAT_PATTERNS = {
29
- 'email' => /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
30
- 'url' => /^https?:\/\/.+/,
31
- 'ip' => /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
32
- 'date' => /^\d{4}-\d{2}-\d{2}$/,
33
- 'hexColor' => /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
34
- }.freeze
35
-
36
- # Initialize the client
37
- #
38
- # @param api_key [String] Your APIVerve API key
39
- # @param timeout [Integer] Request timeout in seconds (default: 30)
40
- # @param debug [Boolean] Enable debug logging (default: false)
41
- # @raise [ArgumentError] If API key is invalid
42
- def initialize(api_key:, timeout: DEFAULT_TIMEOUT, debug: false)
43
- validate_api_key!(api_key)
44
-
45
- @api_key = api_key
46
- @timeout = timeout
47
- @debug = debug
48
-
49
- @connection = Faraday.new(url: BASE_URL) do |conn|
50
- conn.request :multipart
51
- conn.request :url_encoded
52
- conn.adapter Faraday.default_adapter
53
- conn.options.timeout = @timeout
54
- conn.headers["x-api-key"] = @api_key
55
- conn.headers["auth-mode"] = "rubygems-package"
56
- conn.headers["Content-Type"] = "application/json"
57
- end
58
- end
59
-
60
- # Execute the API request
61
- #
62
- # @param params [Hash] Query parameters or request body
63
- # @return [Hash] API response
64
- # @raise [APIError] If the request fails
65
- # @raise [ValidationError] If parameter validation fails
66
- def execute(params = {})
67
- validate_params!(params)
68
-
69
- log("Making GET request to #{BASE_URL}")
70
- log("Parameters: #{params.inspect}") if params.any?
71
-
72
- response = @connection.get do |req|
73
- params.each { |k, v| req.params[k.to_s] = v }
74
- end
75
-
76
- handle_response(response)
77
- end
78
-
79
- private
80
-
81
- def validate_api_key!(api_key)
82
- raise ArgumentError, "API key is required. Get your API key at: https://apiverve.com" if api_key.nil? || api_key.strip.empty?
83
-
84
- unless api_key.match?(/^[a-zA-Z0-9_-]+$/)
85
- raise ArgumentError, "Invalid API key format. API key should only contain letters, numbers, hyphens, and underscores."
86
- end
87
- end
88
-
89
- def validate_params!(params)
90
- return if VALIDATION_RULES.empty?
91
-
92
- errors = []
93
-
94
- VALIDATION_RULES.each do |param_name, rules|
95
- value = params[param_name.to_sym] || params[param_name]
96
-
97
- # Check required
98
- if rules[:required] && (value.nil? || value.to_s.empty?)
99
- errors << "Required parameter [#{param_name}] is missing."
100
- next
101
- end
102
-
103
- next if value.nil?
104
-
105
- case rules[:type]
106
- when "integer", "number"
107
- begin
108
- num_value = rules[:type] == "number" ? Float(value) : Integer(value)
109
- errors << "Parameter [#{param_name}] must be at least #{rules[:min]}." if rules[:min] && num_value < rules[:min]
110
- errors << "Parameter [#{param_name}] must be at most #{rules[:max]}." if rules[:max] && num_value > rules[:max]
111
- rescue ArgumentError, TypeError
112
- errors << "Parameter [#{param_name}] must be a valid #{rules[:type]}."
113
- end
114
- when "string"
115
- unless value.is_a?(String)
116
- errors << "Parameter [#{param_name}] must be a string."
117
- next
118
- end
119
- errors << "Parameter [#{param_name}] must be at least #{rules[:min_length]} characters." if rules[:min_length] && value.length < rules[:min_length]
120
- errors << "Parameter [#{param_name}] must be at most #{rules[:max_length]} characters." if rules[:max_length] && value.length > rules[:max_length]
121
-
122
- if rules[:format] && FORMAT_PATTERNS[rules[:format]]
123
- unless value.match?(FORMAT_PATTERNS[rules[:format]])
124
- errors << "Parameter [#{param_name}] must be a valid #{rules[:format]}."
125
- end
126
- end
127
- when "boolean"
128
- unless [true, false, "true", "false"].include?(value)
129
- errors << "Parameter [#{param_name}] must be a boolean."
130
- end
131
- end
132
-
133
- # Enum validation
134
- if rules[:enum] && !rules[:enum].include?(value)
135
- errors << "Parameter [#{param_name}] must be one of: #{rules[:enum].join(', ')}."
136
- end
137
- end
138
-
139
- raise ValidationError, errors unless errors.empty?
140
- end
141
-
142
- def handle_response(response)
143
- log("Response status: #{response.status}")
144
-
145
- data = JSON.parse(response.body)
146
-
147
- if data["status"] == "error"
148
- raise APIError.new(data["error"] || "Unknown API error", response.status, data)
149
- end
150
-
151
- unless response.success?
152
- raise APIError.new(data["error"] || "HTTP #{response.status} error", response.status, data)
153
- end
154
-
155
- log("Request successful")
156
- data
157
- rescue JSON::ParserError => e
158
- raise APIError.new("Invalid JSON response: #{e.message}", response.status)
159
- end
160
-
161
- def log(message)
162
- puts "[APIVerve::Permutationcombination] #{message}" if @debug
163
- end
164
- end
165
-
166
- # Custom error class for API errors
167
- class APIError < StandardError
168
- attr_reader :status_code, :response
169
-
170
- def initialize(message, status_code = nil, response = nil)
171
- @status_code = status_code
172
- @response = response
173
- super(message)
174
- end
175
- end
176
-
177
- # Custom error class for validation errors
178
- class ValidationError < StandardError
179
- attr_reader :errors
180
-
181
- def initialize(errors)
182
- @errors = errors
183
- super("Validation failed: #{errors.join(' ')}")
184
- end
185
- end
186
- end
187
- end
1
+ # frozen_string_literal: true
2
+
3
+ require "faraday"
4
+ require "faraday/multipart"
5
+ require "json"
6
+
7
+ module APIVerve
8
+ module Permutationcombination
9
+ # Client for the Permutation & Combination Calculator API
10
+ #
11
+ # @example Basic usage
12
+ # client = APIVerve::Permutationcombination::Client.new(api_key: "your_api_key")
13
+ # response = client.execute({ n: 10, r: 3 })
14
+ # puts response
15
+ #
16
+ # @see https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=referral&utm_content=readme
17
+ class Client
18
+ BASE_URL = "https://api.apiverve.com/v1/permutationcombination"
19
+ DEFAULT_TIMEOUT = 30
20
+
21
+ # Validation rules for parameters
22
+ VALIDATION_RULES = { 'n' => { type: 'integer', required: true, min: 0, max: 170 }, 'r' => { type: 'integer', required: true, min: 0, max: 170 } }
23
+
24
+ # Format validation patterns
25
+ FORMAT_PATTERNS = {
26
+ 'email' => /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
27
+ 'url' => /^https?:\/\/.+/,
28
+ 'ip' => /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
29
+ 'date' => /^\d{4}-\d{2}-\d{2}$/,
30
+ 'hexColor' => /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
31
+ }.freeze
32
+
33
+ # Initialize the client
34
+ #
35
+ # @param api_key [String] Your APIVerve API key
36
+ # @param timeout [Integer] Request timeout in seconds (default: 30)
37
+ # @param debug [Boolean] Enable debug logging (default: false)
38
+ # @raise [ArgumentError] If API key is invalid
39
+ def initialize(api_key:, timeout: DEFAULT_TIMEOUT, debug: false)
40
+ validate_api_key!(api_key)
41
+
42
+ @api_key = api_key
43
+ @timeout = timeout
44
+ @debug = debug
45
+
46
+ @connection = Faraday.new(url: BASE_URL) do |conn|
47
+ conn.request :multipart
48
+ conn.request :url_encoded
49
+ conn.adapter Faraday.default_adapter
50
+ conn.options.timeout = @timeout
51
+ conn.headers["x-api-key"] = @api_key
52
+ conn.headers["auth-mode"] = "rubygems-package"
53
+ conn.headers["Content-Type"] = "application/json"
54
+ end
55
+ end
56
+
57
+ # Execute the API request
58
+ #
59
+ # @param params [Hash] Query parameters or request body
60
+ # @return [Hash] API response
61
+ # @raise [APIError] If the request fails
62
+ # @raise [ValidationError] If parameter validation fails
63
+ def execute(params = {})
64
+ validate_params!(params)
65
+
66
+ log("Making GET request to #{BASE_URL}")
67
+ log("Parameters: #{params.inspect}") if params.any?
68
+
69
+ response = @connection.get do |req|
70
+ params.each { |k, v| req.params[k.to_s] = v }
71
+ end
72
+
73
+ handle_response(response)
74
+ end
75
+
76
+ private
77
+
78
+ def validate_api_key!(api_key)
79
+ raise ArgumentError, "API key is required. Get your API key at: https://apiverve.com" if api_key.nil? || api_key.strip.empty?
80
+
81
+ unless api_key.match?(/^[a-zA-Z0-9_-]+$/)
82
+ raise ArgumentError, "Invalid API key format. API key should only contain letters, numbers, hyphens, and underscores."
83
+ end
84
+ end
85
+
86
+ def validate_params!(params)
87
+ return if VALIDATION_RULES.empty?
88
+
89
+ errors = []
90
+
91
+ VALIDATION_RULES.each do |param_name, rules|
92
+ value = params[param_name.to_sym] || params[param_name]
93
+
94
+ # Check required
95
+ if rules[:required] && (value.nil? || value.to_s.empty?)
96
+ errors << "Required parameter [#{param_name}] is missing."
97
+ next
98
+ end
99
+
100
+ next if value.nil?
101
+
102
+ case rules[:type]
103
+ when "integer", "number"
104
+ begin
105
+ num_value = rules[:type] == "number" ? Float(value) : Integer(value)
106
+ errors << "Parameter [#{param_name}] must be at least #{rules[:min]}." if rules[:min] && num_value < rules[:min]
107
+ errors << "Parameter [#{param_name}] must be at most #{rules[:max]}." if rules[:max] && num_value > rules[:max]
108
+ rescue ArgumentError, TypeError
109
+ errors << "Parameter [#{param_name}] must be a valid #{rules[:type]}."
110
+ end
111
+ when "string"
112
+ unless value.is_a?(String)
113
+ errors << "Parameter [#{param_name}] must be a string."
114
+ next
115
+ end
116
+ errors << "Parameter [#{param_name}] must be at least #{rules[:min_length]} characters." if rules[:min_length] && value.length < rules[:min_length]
117
+ errors << "Parameter [#{param_name}] must be at most #{rules[:max_length]} characters." if rules[:max_length] && value.length > rules[:max_length]
118
+
119
+ if rules[:format] && FORMAT_PATTERNS[rules[:format]]
120
+ unless value.match?(FORMAT_PATTERNS[rules[:format]])
121
+ errors << "Parameter [#{param_name}] must be a valid #{rules[:format]}."
122
+ end
123
+ end
124
+ when "boolean"
125
+ unless [true, false, "true", "false"].include?(value)
126
+ errors << "Parameter [#{param_name}] must be a boolean."
127
+ end
128
+ end
129
+
130
+ # Enum validation
131
+ if rules[:enum] && !rules[:enum].include?(value)
132
+ errors << "Parameter [#{param_name}] must be one of: #{rules[:enum].join(', ')}."
133
+ end
134
+ end
135
+
136
+ raise ValidationError, errors unless errors.empty?
137
+ end
138
+
139
+ def handle_response(response)
140
+ log("Response status: #{response.status}")
141
+
142
+ data = JSON.parse(response.body)
143
+
144
+ if data["status"] == "error"
145
+ raise APIError.new(data["error"] || "Unknown API error", response.status, data)
146
+ end
147
+
148
+ unless response.success?
149
+ raise APIError.new(data["error"] || "HTTP #{response.status} error", response.status, data)
150
+ end
151
+
152
+ log("Request successful")
153
+ data
154
+ rescue JSON::ParserError => e
155
+ raise APIError.new("Invalid JSON response: #{e.message}", response.status)
156
+ end
157
+
158
+ def log(message)
159
+ puts "[APIVerve::Permutationcombination] #{message}" if @debug
160
+ end
161
+ end
162
+
163
+ # Custom error class for API errors
164
+ class APIError < StandardError
165
+ attr_reader :status_code, :response
166
+
167
+ def initialize(message, status_code = nil, response = nil)
168
+ @status_code = status_code
169
+ @response = response
170
+ super(message)
171
+ end
172
+ end
173
+
174
+ # Custom error class for validation errors
175
+ class ValidationError < StandardError
176
+ attr_reader :errors
177
+
178
+ def initialize(errors)
179
+ @errors = errors
180
+ super("Validation failed: #{errors.join(' ')}")
181
+ end
182
+ end
183
+ end
184
+ end
@@ -1,9 +1,9 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative "apiverve_permutationcombination/client"
4
-
5
- module APIVerve
6
- module Permutationcombination
7
- VERSION = "1.2.0"
8
- end
9
- end
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "apiverve_permutationcombination/client"
4
+
5
+ module APIVerve
6
+ module Permutationcombination
7
+ VERSION = "1.2.2"
8
+ end
9
+ end
metadata CHANGED
@@ -1,13 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: apiverve_permutationcombination
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 1.2.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - APIVerve
8
+ autorequire:
8
9
  bindir: bin
9
10
  cert_chain: []
10
- date: 1980-01-02 00:00:00.000000000 Z
11
+ date: 2026-10-21 00:00:00.000000000 Z
11
12
  dependencies:
12
13
  - !ruby/object:Gem::Dependency
13
14
  name: faraday
@@ -67,17 +68,17 @@ extra_rdoc_files: []
67
68
  files:
68
69
  - LICENSE
69
70
  - README.md
70
- - lib/apiverve/client.rb
71
71
  - lib/apiverve_permutationcombination.rb
72
72
  - lib/apiverve_permutationcombination/client.rb
73
- homepage: https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=homepage
73
+ homepage: https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=referral&utm_content=homepage
74
74
  licenses:
75
75
  - MIT
76
76
  metadata:
77
- homepage_uri: https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=homepage
77
+ homepage_uri: https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=referral&utm_content=homepage
78
78
  source_code_uri: https://github.com/apiverve/permutationcombination-API/tree/main/ruby
79
79
  changelog_uri: https://apiverve.com/changelog
80
80
  documentation_uri: https://docs.apiverve.com/ref/permutationcombination
81
+ post_install_message:
81
82
  rdoc_options: []
82
83
  require_paths:
83
84
  - lib
@@ -92,7 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
92
93
  - !ruby/object:Gem::Version
93
94
  version: '0'
94
95
  requirements: []
95
- rubygems_version: 3.6.9
96
+ rubygems_version: 3.0.3.1
97
+ signing_key:
96
98
  specification_version: 4
97
99
  summary: Permutation & Combination Calculator API - Ruby Client
98
100
  test_files: []
@@ -1,184 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require "faraday"
4
- require "faraday/multipart"
5
- require "json"
6
-
7
- module APIVerve
8
- module Permutationcombination
9
- # Client for the Permutation & Combination Calculator API
10
- #
11
- # @example Basic usage
12
- # client = APIVerve::Permutationcombination::Client.new(api_key: "your_api_key")
13
- # response = client.execute({ n: 10, r: 3 })
14
- # puts response
15
- #
16
- # @see https://apiverve.com/marketplace/permutationcombination?utm_source=ruby&utm_medium=readme
17
- class Client
18
- BASE_URL = "https://api.apiverve.com/v1/permutationcombination"
19
- DEFAULT_TIMEOUT = 30
20
-
21
- # Validation rules for parameters
22
- VALIDATION_RULES = { 'n' => { type: 'integer', required: true, min: 0, max: 170 }, 'r' => { type: 'integer', required: true, min: 0, max: 170 } }
23
-
24
- # Format validation patterns
25
- FORMAT_PATTERNS = {
26
- 'email' => /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
27
- 'url' => /^https?:\/\/.+/,
28
- 'ip' => /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
29
- 'date' => /^\d{4}-\d{2}-\d{2}$/,
30
- 'hexColor' => /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
31
- }.freeze
32
-
33
- # Initialize the client
34
- #
35
- # @param api_key [String] Your APIVerve API key
36
- # @param timeout [Integer] Request timeout in seconds (default: 30)
37
- # @param debug [Boolean] Enable debug logging (default: false)
38
- # @raise [ArgumentError] If API key is invalid
39
- def initialize(api_key:, timeout: DEFAULT_TIMEOUT, debug: false)
40
- validate_api_key!(api_key)
41
-
42
- @api_key = api_key
43
- @timeout = timeout
44
- @debug = debug
45
-
46
- @connection = Faraday.new(url: BASE_URL) do |conn|
47
- conn.request :multipart
48
- conn.request :url_encoded
49
- conn.adapter Faraday.default_adapter
50
- conn.options.timeout = @timeout
51
- conn.headers["x-api-key"] = @api_key
52
- conn.headers["auth-mode"] = "rubygems-package"
53
- conn.headers["Content-Type"] = "application/json"
54
- end
55
- end
56
-
57
- # Execute the API request
58
- #
59
- # @param params [Hash] Query parameters or request body
60
- # @return [Hash] API response
61
- # @raise [APIError] If the request fails
62
- # @raise [ValidationError] If parameter validation fails
63
- def execute(params = {})
64
- validate_params!(params)
65
-
66
- log("Making GET request to #{BASE_URL}")
67
- log("Parameters: #{params.inspect}") if params.any?
68
-
69
- response = @connection.get do |req|
70
- params.each { |k, v| req.params[k.to_s] = v }
71
- end
72
-
73
- handle_response(response)
74
- end
75
-
76
- private
77
-
78
- def validate_api_key!(api_key)
79
- raise ArgumentError, "API key is required. Get your API key at: https://apiverve.com" if api_key.nil? || api_key.strip.empty?
80
-
81
- unless api_key.match?(/^[a-zA-Z0-9_-]+$/)
82
- raise ArgumentError, "Invalid API key format. API key should only contain letters, numbers, hyphens, and underscores."
83
- end
84
- end
85
-
86
- def validate_params!(params)
87
- return if VALIDATION_RULES.empty?
88
-
89
- errors = []
90
-
91
- VALIDATION_RULES.each do |param_name, rules|
92
- value = params[param_name.to_sym] || params[param_name]
93
-
94
- # Check required
95
- if rules[:required] && (value.nil? || value.to_s.empty?)
96
- errors << "Required parameter [#{param_name}] is missing."
97
- next
98
- end
99
-
100
- next if value.nil?
101
-
102
- case rules[:type]
103
- when "integer", "number"
104
- begin
105
- num_value = rules[:type] == "number" ? Float(value) : Integer(value)
106
- errors << "Parameter [#{param_name}] must be at least #{rules[:min]}." if rules[:min] && num_value < rules[:min]
107
- errors << "Parameter [#{param_name}] must be at most #{rules[:max]}." if rules[:max] && num_value > rules[:max]
108
- rescue ArgumentError, TypeError
109
- errors << "Parameter [#{param_name}] must be a valid #{rules[:type]}."
110
- end
111
- when "string"
112
- unless value.is_a?(String)
113
- errors << "Parameter [#{param_name}] must be a string."
114
- next
115
- end
116
- errors << "Parameter [#{param_name}] must be at least #{rules[:min_length]} characters." if rules[:min_length] && value.length < rules[:min_length]
117
- errors << "Parameter [#{param_name}] must be at most #{rules[:max_length]} characters." if rules[:max_length] && value.length > rules[:max_length]
118
-
119
- if rules[:format] && FORMAT_PATTERNS[rules[:format]]
120
- unless value.match?(FORMAT_PATTERNS[rules[:format]])
121
- errors << "Parameter [#{param_name}] must be a valid #{rules[:format]}."
122
- end
123
- end
124
- when "boolean"
125
- unless [true, false, "true", "false"].include?(value)
126
- errors << "Parameter [#{param_name}] must be a boolean."
127
- end
128
- end
129
-
130
- # Enum validation
131
- if rules[:enum] && !rules[:enum].include?(value)
132
- errors << "Parameter [#{param_name}] must be one of: #{rules[:enum].join(', ')}."
133
- end
134
- end
135
-
136
- raise ValidationError, errors unless errors.empty?
137
- end
138
-
139
- def handle_response(response)
140
- log("Response status: #{response.status}")
141
-
142
- data = JSON.parse(response.body)
143
-
144
- if data["status"] == "error"
145
- raise APIError.new(data["error"] || "Unknown API error", response.status, data)
146
- end
147
-
148
- unless response.success?
149
- raise APIError.new(data["error"] || "HTTP #{response.status} error", response.status, data)
150
- end
151
-
152
- log("Request successful")
153
- data
154
- rescue JSON::ParserError => e
155
- raise APIError.new("Invalid JSON response: #{e.message}", response.status)
156
- end
157
-
158
- def log(message)
159
- puts "[APIVerve::Permutationcombination] #{message}" if @debug
160
- end
161
- end
162
-
163
- # Custom error class for API errors
164
- class APIError < StandardError
165
- attr_reader :status_code, :response
166
-
167
- def initialize(message, status_code = nil, response = nil)
168
- @status_code = status_code
169
- @response = response
170
- super(message)
171
- end
172
- end
173
-
174
- # Custom error class for validation errors
175
- class ValidationError < StandardError
176
- attr_reader :errors
177
-
178
- def initialize(errors)
179
- @errors = errors
180
- super("Validation failed: #{errors.join(' ')}")
181
- end
182
- end
183
- end
184
- end