apiverve_weatheralerts 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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 64264b3713d37091f14314dc791a8c1de6802c62a0260de03466e9faadb59905
4
+ data.tar.gz: e0aff16749a5b0ee0100b671ff7d0b16a280f3396ebe0e1571a06b5d77864c27
5
+ SHA512:
6
+ metadata.gz: 8c2c6fe2ba4dd389feae586247b2fdf05f0cb04db37d6ccc1753f4daa22b7d9ce370c83cc99eb800203d49f695831dbb0874b0d03f3e7621e2b2b9e83408bd16
7
+ data.tar.gz: 05fad05407ddf4062630ea29b2502d0db6ad0faa8f41e8df4d57f8e6b73e917e98717f5a1a7c932de344f7773f11e5dd59a61e341ed5cdfebe6411379da0dcbc
data/LICENSE ADDED
@@ -0,0 +1,21 @@
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 ADDED
@@ -0,0 +1,176 @@
1
+ # Weather Alerts API - Ruby Gem
2
+
3
+ Weather Alerts returns the severe weather warnings, watches and advisories in effect right now for any point or state in the United States, straight from the National Weather Service. Each alert names the event, how severe and urgent it is, the area covered, when it starts and ends, and what to do.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'apiverve_weatheralerts'
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_weatheralerts
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_weatheralerts'
33
+
34
+ # Initialize the client
35
+ client = APIVerve::Weatheralerts::Client.new(api_key: "YOUR_API_KEY")
36
+
37
+ # Make a request
38
+ response = client.execute({
39
+ lat: 38.627,
40
+ lon: -90.1994,
41
+ state: "TX"
42
+ })
43
+
44
+ # Print the response
45
+ puts response
46
+ ```
47
+
48
+
49
+ ### Error Handling
50
+
51
+ ```ruby
52
+ begin
53
+ response = client.execute({ lat: 38.627, lon: -90.1994, state: "TX" })
54
+ puts response["data"]
55
+ rescue APIVerve::Weatheralerts::ValidationError => e
56
+ puts "Validation error: #{e.errors.join(', ')}"
57
+ rescue APIVerve::Weatheralerts::APIError => e
58
+ puts "API error: #{e.message}"
59
+ puts "Status code: #{e.status_code}"
60
+ end
61
+ ```
62
+
63
+ ### Debug Mode
64
+
65
+ ```ruby
66
+ # Enable debug logging
67
+ client = APIVerve::Weatheralerts::Client.new(
68
+ api_key: "YOUR_API_KEY",
69
+ debug: true
70
+ )
71
+ ```
72
+
73
+ ## Example Response
74
+
75
+ ```json
76
+ {
77
+ "status": "ok",
78
+ "error": null,
79
+ "data": {
80
+ "location": {
81
+ "state": "TX"
82
+ },
83
+ "count": 2,
84
+ "highestSeverity": "Severe",
85
+ "alerts": [
86
+ {
87
+ "id": "urn:oid:2.49.0.1.840.0.f9aca49ebcd46d4148ecadc4f42f00d6fee04ca6.001.1",
88
+ "event": "Flood Warning",
89
+ "headline": "Flood Warning issued October 2 at 1:51PM CDT until October 3 at 2:51AM CDT by NWS Fort Worth TX",
90
+ "summary": "FLOOD WARNING NOW IN EFFECT UNTIL LATE TONIGHT",
91
+ "severity": "Severe",
92
+ "urgency": "Immediate",
93
+ "certainty": "Observed",
94
+ "response": "Avoid",
95
+ "messageType": "Update",
96
+ "area": "Dallas, TX",
97
+ "issuedBy": "NWS Fort Worth TX",
98
+ "sent": "2026-10-02T13:51:00-05:00",
99
+ "onset": "2026-10-02T13:51:00-05:00",
100
+ "expires": "2026-10-03T03:00:00-05:00",
101
+ "ends": "2026-10-03T02:51:00-05:00",
102
+ "description": "...The Flood Warning continues for the following rivers in Texas...\n\nTrinity River At Dallas affecting Dallas County.\n\n* WHAT...Minor flooding is occurring and minor flooding is forecast.\n\n* WHERE...Trinity River at Dallas.\n\n* WHEN...Until late tonight.\n\n* IMPACTS...At 30.0 feet, Minor lowland flooding will begin, and\ntrails along the river begin to flood.\n\n* ADDITIONAL DETAILS...\n- At 1:30 PM CDT Friday the stage was 30.9 feet.\n- Forecast...The river is expected to fall below flood stage this\nafternoon and continue falling to 12.7 feet early Wednesday\nafternoon.\n- Bankfull stage is 30.0 feet.\n- Flood stage is 30.0 feet.",
103
+ "instruction": "Do not drive cars through flooded areas. Caution is urged when\nwalking near riverbanks.\n\nAdditional information is available at water.noaa.gov/wfo/fwd.",
104
+ "geometry": {
105
+ "type": "Polygon",
106
+ "coordinates": [
107
+ [
108
+ [
109
+ -96.93,
110
+ 32.75
111
+ ],
112
+ [
113
+ -96.93,
114
+ 32.81
115
+ ],
116
+ [
117
+ -96.83,
118
+ 32.83
119
+ ],
120
+ [
121
+ -96.71,
122
+ 32.75
123
+ ],
124
+ [
125
+ -96.76,
126
+ 32.69
127
+ ],
128
+ [
129
+ -96.87,
130
+ 32.78
131
+ ],
132
+ [
133
+ -96.93,
134
+ 32.75
135
+ ]
136
+ ]
137
+ ]
138
+ }
139
+ },
140
+ {
141
+ "id": "urn:oid:2.49.0.1.840.0.b7cdd851a493afa58b5cf5fc13948ba8a35d2b25.001.1",
142
+ "event": "Flood Watch",
143
+ "headline": "Flood Watch issued October 2 at 1:36AM CDT until October 2 at 7:00PM CDT by NWS Corpus Christi TX",
144
+ "summary": "FLOOD WATCH REMAINS IN EFFECT THROUGH THIS EVENING",
145
+ "severity": "Severe",
146
+ "urgency": "Future",
147
+ "certainty": "Possible",
148
+ "response": "Prepare",
149
+ "messageType": "Update",
150
+ "area": "La Salle; McMullen; Live Oak; Bee; Goliad; Victoria; Webb; Duval; Jim Wells; Inland Kleberg; Inland Nueces; Inland San Patricio",
151
+ "issuedBy": "NWS Corpus Christi TX",
152
+ "sent": "2026-10-02T01:36:00-05:00",
153
+ "onset": "2026-10-02T01:36:00-05:00",
154
+ "expires": "2026-10-02T19:00:00-05:00",
155
+ "ends": "2026-10-02T19:00:00-05:00",
156
+ "description": "* WHAT...Flooding caused by excessive rainfall continues to be\npossible.\n\n* WHERE...A portion of south Texas, including the following areas,\nBee, Duval, Goliad, Inland Kleberg, Inland Nueces, Inland San\nPatricio, Jim Wells, La Salle, Live Oak, McMullen, Victoria and\nWebb.\n\n* WHEN...Through this evening.\n\n* IMPACTS...Excessive runoff may result in flooding of rivers,\ncreeks, streams, and other low-lying and flood-prone locations.\nFlooding may occur in poor drainage and urban areas.\n\n* ADDITIONAL DETAILS...\n- Flooding caused by excessive rainfall is possible. Additional\nrainfall totals of 1-3 inches with isolated higher amounts will\nfall over areas that have already seen 2-4\" of rain within the\nwatch area.\n- http://www.weather.gov/safety/flood",
157
+ "instruction": "You should monitor later forecasts and be alert for possible Flood\nWarnings. Those living in areas prone to flooding should be prepared\nto take action should flooding develop.",
158
+ "geometry": null
159
+ }
160
+ ]
161
+ }
162
+ }
163
+ ```
164
+
165
+ ## Documentation
166
+
167
+ For more information, visit the [API Documentation](https://docs.apiverve.com/ref/weatheralerts?utm_source=rubygems&utm_medium=referral&utm_content=readme).
168
+
169
+ ## Support
170
+
171
+ - Website: [https://apiverve.com/marketplace/weatheralerts?utm_source=ruby&utm_medium=referral&utm_content=readme](https://apiverve.com/marketplace/weatheralerts?utm_source=ruby&utm_medium=referral&utm_content=readme)
172
+ - Email: hello@apiverve.com
173
+
174
+ ## License
175
+
176
+ This gem is available under the [MIT License](LICENSE).
@@ -0,0 +1,184 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "faraday"
4
+ require "faraday/multipart"
5
+ require "json"
6
+
7
+ module APIVerve
8
+ module Weatheralerts
9
+ # Client for the Weather Alerts API
10
+ #
11
+ # @example Basic usage
12
+ # client = APIVerve::Weatheralerts::Client.new(api_key: "your_api_key")
13
+ # response = client.execute({ lat: 38.627, lon: -90.1994, state: "TX" })
14
+ # puts response
15
+ #
16
+ # @see https://apiverve.com/marketplace/weatheralerts?utm_source=ruby&utm_medium=referral&utm_content=readme
17
+ class Client
18
+ BASE_URL = "https://api.apiverve.com/v1/weatheralerts"
19
+ DEFAULT_TIMEOUT = 30
20
+
21
+ # Validation rules for parameters
22
+ VALIDATION_RULES = { 'lat' => { type: 'number', required: false, min: -90, max: 90 }, 'lon' => { type: 'number', required: false, min: -180, max: 180 }, 'state' => { type: 'string', required: false } }
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::Weatheralerts] #{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
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "apiverve_weatheralerts/client"
4
+
5
+ module APIVerve
6
+ module Weatheralerts
7
+ VERSION = "1.2.2"
8
+ end
9
+ end
metadata ADDED
@@ -0,0 +1,102 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: apiverve_weatheralerts
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.2.2
5
+ platform: ruby
6
+ authors:
7
+ - APIVerve
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2026-10-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: faraday
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '1.0'
20
+ - - "<"
21
+ - !ruby/object:Gem::Version
22
+ version: '3.0'
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: '1.0'
30
+ - - "<"
31
+ - !ruby/object:Gem::Version
32
+ version: '3.0'
33
+ - !ruby/object:Gem::Dependency
34
+ name: faraday-multipart
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '1.0'
40
+ type: :runtime
41
+ prerelease: false
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '1.0'
47
+ - !ruby/object:Gem::Dependency
48
+ name: json
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - "~>"
52
+ - !ruby/object:Gem::Version
53
+ version: '2.0'
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - "~>"
59
+ - !ruby/object:Gem::Version
60
+ version: '2.0'
61
+ description: Weather Alerts returns the severe weather warnings, watches and advisories
62
+ in effect right now for any point or state in the United States, straight from the
63
+ National Weather Service. Each alert names the event, how severe and urgent it is,
64
+ the area covered, when it starts and ends, and what to do.
65
+ email:
66
+ - hello@apiverve.com
67
+ executables: []
68
+ extensions: []
69
+ extra_rdoc_files: []
70
+ files:
71
+ - LICENSE
72
+ - README.md
73
+ - lib/apiverve_weatheralerts.rb
74
+ - lib/apiverve_weatheralerts/client.rb
75
+ homepage: https://apiverve.com/marketplace/weatheralerts?utm_source=ruby&utm_medium=referral&utm_content=homepage
76
+ licenses:
77
+ - MIT
78
+ metadata:
79
+ homepage_uri: https://apiverve.com/marketplace/weatheralerts?utm_source=ruby&utm_medium=referral&utm_content=homepage
80
+ source_code_uri: https://github.com/apiverve/weatheralerts-API/tree/main/ruby
81
+ changelog_uri: https://apiverve.com/changelog
82
+ documentation_uri: https://docs.apiverve.com/ref/weatheralerts
83
+ post_install_message:
84
+ rdoc_options: []
85
+ require_paths:
86
+ - lib
87
+ required_ruby_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: 2.7.0
92
+ required_rubygems_version: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ requirements: []
98
+ rubygems_version: 3.0.3.1
99
+ signing_key:
100
+ specification_version: 4
101
+ summary: Weather Alerts API - Ruby Client
102
+ test_files: []