apiverve_rsstojson 1.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 +7 -0
- data/LICENSE +21 -0
- data/README.md +166 -0
- data/lib/apiverve/client.rb +184 -0
- data/lib/apiverve_rsstojson/client.rb +186 -0
- data/lib/apiverve_rsstojson.rb +9 -0
- metadata +98 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 339c6fbfce83ad81f3f5d2f9ff12a016e250ba98d7fdcf53acddfb98956dcc95
|
|
4
|
+
data.tar.gz: cf9a94518bfbbdeb01ae6587ff3b336bbeb82dbe754dfae8641457db7ea0592b
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: dcddc9bbf2a646285dcce8a38614c4a47ea7846c3126724cee1d806c80f79bc58f0ab5abdb4bb807f93155028cfd595177c8ec5fb8d5354e6693df6a3d740467
|
|
7
|
+
data.tar.gz: 7051124bc2ee8db12cf64788e9b9b6048870c09a63933262aca769b7856a5b20fadd5bd2e22f36f55dfc60b8ce2873fde4866a493b84c45ee653141e43065300
|
data/LICENSE
ADDED
|
@@ -0,0 +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.
|
data/README.md
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# RSS to JSON API - Ruby Gem
|
|
2
|
+
|
|
3
|
+
RSS to JSON is a simple tool for converting RSS feeds into JSON format. It returns the RSS feed in JSON format.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Add this line to your application's Gemfile:
|
|
8
|
+
|
|
9
|
+
```ruby
|
|
10
|
+
gem 'apiverve_rsstojson'
|
|
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_rsstojson
|
|
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_rsstojson'
|
|
33
|
+
|
|
34
|
+
# Initialize the client
|
|
35
|
+
client = APIVerve::Rsstojson::Client.new(api_key: "YOUR_API_KEY")
|
|
36
|
+
|
|
37
|
+
# Make a request
|
|
38
|
+
response = client.execute({ url: "https://www.nasa.gov/rss/dyn/breaking_news.rss" })
|
|
39
|
+
|
|
40
|
+
# Print the response
|
|
41
|
+
puts response
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Error Handling
|
|
46
|
+
|
|
47
|
+
```ruby
|
|
48
|
+
begin
|
|
49
|
+
response = client.execute({ url: "https://www.nasa.gov/rss/dyn/breaking_news.rss" })
|
|
50
|
+
puts response["data"]
|
|
51
|
+
rescue APIVerve::Rsstojson::ValidationError => e
|
|
52
|
+
puts "Validation error: #{e.errors.join(', ')}"
|
|
53
|
+
rescue APIVerve::Rsstojson::APIError => e
|
|
54
|
+
puts "API error: #{e.message}"
|
|
55
|
+
puts "Status code: #{e.status_code}"
|
|
56
|
+
end
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Debug Mode
|
|
60
|
+
|
|
61
|
+
```ruby
|
|
62
|
+
# Enable debug logging
|
|
63
|
+
client = APIVerve::Rsstojson::Client.new(
|
|
64
|
+
api_key: "YOUR_API_KEY",
|
|
65
|
+
debug: true
|
|
66
|
+
)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Example Response
|
|
70
|
+
|
|
71
|
+
```json
|
|
72
|
+
{
|
|
73
|
+
"status": "ok",
|
|
74
|
+
"error": null,
|
|
75
|
+
"data": {
|
|
76
|
+
"source": "www.nasa.gov",
|
|
77
|
+
"articles": 10,
|
|
78
|
+
"maxReached": false,
|
|
79
|
+
"feed": [
|
|
80
|
+
{
|
|
81
|
+
"website": "NASA",
|
|
82
|
+
"title": "NASA IXPE’s Longest Observation Solves Black Hole Jets Mystery",
|
|
83
|
+
"pubDate": "Tue, 16 Dec 2025 21:23:13 +0000",
|
|
84
|
+
"description": "Written by Michael Allen An international team of astronomers using NASA’s IXPE (Imaging X-ray Polarimetry Explorer) has identified the origin of X-rays in a supermassive black hole’s jet, answering a question that has been unresolved since the earliest days of X-ray astronomy. Their findings are described in a paper published in The Astrophysical Journal Letters, […]",
|
|
85
|
+
"link": "https://www.nasa.gov/missions/ixpe/nasa-ixpes-longest-observation-solves-black-hole-jets-mystery/"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"website": "NASA",
|
|
89
|
+
"title": "NASA Launches Research Program for Students to Explore Big Ideas",
|
|
90
|
+
"pubDate": "Tue, 16 Dec 2025 21:01:46 +0000",
|
|
91
|
+
"description": "NASA is now accepting concepts for a new research challenge. The Opportunities in Research, Business, Innovation, and Technology (ORBIT) challenge is a multi-phase innovation competition designed to empower university and college students to develop next-generation solutions that benefit life on Earth and deep-space exploration. With up to $380,000 in total prize funding, NASA’s ORBIT challenges […]",
|
|
92
|
+
"link": "https://www.nasa.gov/learning-resources/research-program-for-students/"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"website": "NASA",
|
|
96
|
+
"title": "Through Astronaut Eyes: 25 Years of Life in Orbit ",
|
|
97
|
+
"pubDate": "Tue, 16 Dec 2025 20:35:35 +0000",
|
|
98
|
+
"description": "After 25 years of continuous human presence in space, the International Space Station remains a training and proving ground for deep space missions, enabling NASA to focus on Artemis missions to the Moon and Mars. The orbiting laboratory is also a living archive of human experience, culture, and connection. Creating community With 290 visitors from […]",
|
|
99
|
+
"link": "https://www.nasa.gov/centers-and-facilities/johnson/through-astronaut-eyes-25-years-of-life-in-orbit/"
|
|
100
|
+
},
|
|
101
|
+
{
|
|
102
|
+
"website": "NASA",
|
|
103
|
+
"title": "NASA Ignites New Golden Age of Exploration, Innovation in 2025",
|
|
104
|
+
"pubDate": "Tue, 16 Dec 2025 19:48:18 +0000",
|
|
105
|
+
"description": "With a second Trump Administration at the helm in 2025, NASA marked significant progress toward the Artemis II test flight early next year, which is the first crewed mission around the Moon in more than 50 years, as well as built upon its momentum toward a human return to the lunar surface in preparation to […]",
|
|
106
|
+
"link": "https://www.nasa.gov/news-release/nasa-ignites-new-golden-age-of-exploration-innovation-in-2025/"
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"website": "NASA",
|
|
110
|
+
"title": "How Small Is Too Small? Volunteers Help NASA Test Lake Monitoring From Space",
|
|
111
|
+
"pubDate": "Tue, 16 Dec 2025 19:45:41 +0000",
|
|
112
|
+
"description": "Volunteers participating in the Lake Observations by Citizen Scientists and Satellites (LOCSS) project have been collecting water level data in lakes since 2017. Now, the LOCSS team has used these data to examine the accuracy of water level measurements made from space.",
|
|
113
|
+
"link": "https://science.nasa.gov/get-involved/citizen-science/how-small-is-too-small-volunteers-help-nasa-test-lake-monitoring-from-space/"
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"website": "NASA",
|
|
117
|
+
"title": "NASA JPL Shakes Things Up Testing Future Commercial Lunar Spacecraft",
|
|
118
|
+
"pubDate": "Tue, 16 Dec 2025 19:43:07 +0000",
|
|
119
|
+
"description": "The same historic facilities that some 50 years ago prepared NASA’s twin Voyager probes for their ongoing interstellar odyssey are helping to ready a towering commercial spacecraft for a journey to the Moon. Launches involve brutal shaking and astonishingly loud noises, and testing in these facilities mimics those conditions to help ensure mission hardware can […]",
|
|
120
|
+
"link": "https://www.nasa.gov/centers-and-facilities/jpl/nasa-jpl-shakes-things-up-testing-future-commercial-lunar-spacecraft/"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"website": "NASA",
|
|
124
|
+
"title": "Peekaboo!",
|
|
125
|
+
"pubDate": "Tue, 16 Dec 2025 17:27:30 +0000",
|
|
126
|
+
"description": "Clockwise from left, JAXA (Japan Aerospace Exploration Agency) astronaut Kimiya Yui and NASA astronauts Jonny Kim, Zena Cardman, and Mike Fincke pose for a playful portrait through a circular opening in a hatch thermal cover aboard the International Space Station on Sept. 18, 2025. The cover provides micrometeoroid and orbital debris protection while maintaining cleanliness […]",
|
|
127
|
+
"link": "https://www.nasa.gov/image-article/peekaboo-2/"
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"website": "NASA",
|
|
131
|
+
"title": "Toxicology and Environmental Chemistry",
|
|
132
|
+
"pubDate": "Tue, 16 Dec 2025 16:28:12 +0000",
|
|
133
|
+
"description": "Ensuring Astronaut Safety Achieving safe exploration of space in vehicles that rely upon closed environmental systems to recycle air and water to sustain life and are operated in extremely remote locations is a major challenge. The Toxicology and Environmental Chemistry (TEC) group at Johnson Space Center (JSC) is made up of 2 interrelated groups: Toxicology […]",
|
|
134
|
+
"link": "https://www.nasa.gov/directorates/esdmd/hhp/toxicology-and-environmental-chemistry/"
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
"website": "NASA",
|
|
138
|
+
"title": "Statistics and Data Science",
|
|
139
|
+
"pubDate": "Tue, 16 Dec 2025 16:14:41 +0000",
|
|
140
|
+
"description": "Enabling Successful Research A major aim of biomedical research at NASA is to acquire data to evaluate, understand, and assess the biomedical hazards of spaceflight and to develop effective countermeasures. Data Science (S&DS) personnel provide statistical support to groups within the NASA JSC Human Health and Performance Directorate and other NASA communities. They have expertise […]",
|
|
141
|
+
"link": "https://www.nasa.gov/directorates/esdmd/hhp/biostatistics-and-data-science/"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"website": "NASA",
|
|
145
|
+
"title": "One of NASA’s Key Cameras Orbiting Mars Takes 100,000th Image",
|
|
146
|
+
"pubDate": "Tue, 16 Dec 2025 16:00:00 +0000",
|
|
147
|
+
"description": "Mesas and dunes stand out in the view snapped by HiRISE, one of the imagers aboard the agency’s Mars Reconnaissance Orbiter. After nearly 20 years at the Red Planet, NASA’s Mars Reconnaissance Orbiter (MRO) has snapped its 100,000th image of the surface with its HiRISE camera. Short for High Resolution Imaging Science Experiment, HiRISE is […]",
|
|
148
|
+
"link": "https://www.nasa.gov/missions/mars-reconnaissance-orbiter/one-of-nasas-key-cameras-orbiting-mars-takes-100000th-image/"
|
|
149
|
+
}
|
|
150
|
+
]
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## Documentation
|
|
156
|
+
|
|
157
|
+
For more information, visit the [API Documentation](https://docs.apiverve.com/ref/rsstojson?utm_source=rubygems&utm_medium=readme).
|
|
158
|
+
|
|
159
|
+
## Support
|
|
160
|
+
|
|
161
|
+
- Website: [https://apiverve.com/marketplace/rsstojson?utm_source=ruby&utm_medium=readme](https://apiverve.com/marketplace/rsstojson?utm_source=ruby&utm_medium=readme)
|
|
162
|
+
- Email: hello@apiverve.com
|
|
163
|
+
|
|
164
|
+
## License
|
|
165
|
+
|
|
166
|
+
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 Rsstojson
|
|
9
|
+
# Client for the RSS to JSON API
|
|
10
|
+
#
|
|
11
|
+
# @example Basic usage
|
|
12
|
+
# client = APIVerve::Rsstojson::Client.new(api_key: "your_api_key")
|
|
13
|
+
# response = client.execute({ url: "https://www.nasa.gov/rss/dyn/breaking_news.rss" })
|
|
14
|
+
# puts response
|
|
15
|
+
#
|
|
16
|
+
# @see https://apiverve.com/marketplace/rsstojson?utm_source=ruby&utm_medium=readme
|
|
17
|
+
class Client
|
|
18
|
+
BASE_URL = "https://api.apiverve.com/v1/rsstojson"
|
|
19
|
+
DEFAULT_TIMEOUT = 30
|
|
20
|
+
|
|
21
|
+
# Validation rules for parameters
|
|
22
|
+
VALIDATION_RULES = { 'url' => { type: 'string', required: true, format: 'url' } }
|
|
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 POST request to #{BASE_URL}")
|
|
67
|
+
log("Parameters: #{params.inspect}") if params.any?
|
|
68
|
+
|
|
69
|
+
response = @connection.post do |req|
|
|
70
|
+
req.body = params.to_json
|
|
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::Rsstojson] #{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,186 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "faraday"
|
|
4
|
+
require "faraday/multipart"
|
|
5
|
+
require "json"
|
|
6
|
+
|
|
7
|
+
module APIVerve
|
|
8
|
+
module Rsstojson
|
|
9
|
+
# Client for the RSS to JSON API
|
|
10
|
+
#
|
|
11
|
+
# @example Basic usage
|
|
12
|
+
# client = APIVerve::Rsstojson::Client.new(api_key: "your_api_key")
|
|
13
|
+
# response = client.execute({ url: "https://www.nasa.gov/rss/dyn/breaking_news.rss" })
|
|
14
|
+
# puts response
|
|
15
|
+
#
|
|
16
|
+
# @see https://apiverve.com/marketplace/rsstojson?utm_source=ruby&utm_medium=readme
|
|
17
|
+
class Client
|
|
18
|
+
BASE_URL = "https://api.apiverve.com/v1/rsstojson"
|
|
19
|
+
DEFAULT_TIMEOUT = 30
|
|
20
|
+
|
|
21
|
+
# Validation rules for parameters
|
|
22
|
+
VALIDATION_RULES = {
|
|
23
|
+
'url' => { type: 'string', required: true, format: 'url' }
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
# Format validation patterns
|
|
27
|
+
FORMAT_PATTERNS = {
|
|
28
|
+
'email' => /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
|
|
29
|
+
'url' => /^https?:\/\/.+/,
|
|
30
|
+
'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}$/,
|
|
31
|
+
'date' => /^\d{4}-\d{2}-\d{2}$/,
|
|
32
|
+
'hexColor' => /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
|
|
33
|
+
}.freeze
|
|
34
|
+
|
|
35
|
+
# Initialize the client
|
|
36
|
+
#
|
|
37
|
+
# @param api_key [String] Your APIVerve API key
|
|
38
|
+
# @param timeout [Integer] Request timeout in seconds (default: 30)
|
|
39
|
+
# @param debug [Boolean] Enable debug logging (default: false)
|
|
40
|
+
# @raise [ArgumentError] If API key is invalid
|
|
41
|
+
def initialize(api_key:, timeout: DEFAULT_TIMEOUT, debug: false)
|
|
42
|
+
validate_api_key!(api_key)
|
|
43
|
+
|
|
44
|
+
@api_key = api_key
|
|
45
|
+
@timeout = timeout
|
|
46
|
+
@debug = debug
|
|
47
|
+
|
|
48
|
+
@connection = Faraday.new(url: BASE_URL) do |conn|
|
|
49
|
+
conn.request :multipart
|
|
50
|
+
conn.request :url_encoded
|
|
51
|
+
conn.adapter Faraday.default_adapter
|
|
52
|
+
conn.options.timeout = @timeout
|
|
53
|
+
conn.headers["x-api-key"] = @api_key
|
|
54
|
+
conn.headers["auth-mode"] = "rubygems-package"
|
|
55
|
+
conn.headers["Content-Type"] = "application/json"
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# Execute the API request
|
|
60
|
+
#
|
|
61
|
+
# @param params [Hash] Query parameters or request body
|
|
62
|
+
# @return [Hash] API response
|
|
63
|
+
# @raise [APIError] If the request fails
|
|
64
|
+
# @raise [ValidationError] If parameter validation fails
|
|
65
|
+
def execute(params = {})
|
|
66
|
+
validate_params!(params)
|
|
67
|
+
|
|
68
|
+
log("Making POST request to #{BASE_URL}")
|
|
69
|
+
log("Parameters: #{params.inspect}") if params.any?
|
|
70
|
+
|
|
71
|
+
response = @connection.post do |req|
|
|
72
|
+
req.body = params.to_json
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
handle_response(response)
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
private
|
|
79
|
+
|
|
80
|
+
def validate_api_key!(api_key)
|
|
81
|
+
raise ArgumentError, "API key is required. Get your API key at: https://apiverve.com" if api_key.nil? || api_key.strip.empty?
|
|
82
|
+
|
|
83
|
+
unless api_key.match?(/^[a-zA-Z0-9_-]+$/)
|
|
84
|
+
raise ArgumentError, "Invalid API key format. API key should only contain letters, numbers, hyphens, and underscores."
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
def validate_params!(params)
|
|
89
|
+
return if VALIDATION_RULES.empty?
|
|
90
|
+
|
|
91
|
+
errors = []
|
|
92
|
+
|
|
93
|
+
VALIDATION_RULES.each do |param_name, rules|
|
|
94
|
+
value = params[param_name.to_sym] || params[param_name]
|
|
95
|
+
|
|
96
|
+
# Check required
|
|
97
|
+
if rules[:required] && (value.nil? || value.to_s.empty?)
|
|
98
|
+
errors << "Required parameter [#{param_name}] is missing."
|
|
99
|
+
next
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
next if value.nil?
|
|
103
|
+
|
|
104
|
+
case rules[:type]
|
|
105
|
+
when "integer", "number"
|
|
106
|
+
begin
|
|
107
|
+
num_value = rules[:type] == "number" ? Float(value) : Integer(value)
|
|
108
|
+
errors << "Parameter [#{param_name}] must be at least #{rules[:min]}." if rules[:min] && num_value < rules[:min]
|
|
109
|
+
errors << "Parameter [#{param_name}] must be at most #{rules[:max]}." if rules[:max] && num_value > rules[:max]
|
|
110
|
+
rescue ArgumentError, TypeError
|
|
111
|
+
errors << "Parameter [#{param_name}] must be a valid #{rules[:type]}."
|
|
112
|
+
end
|
|
113
|
+
when "string"
|
|
114
|
+
unless value.is_a?(String)
|
|
115
|
+
errors << "Parameter [#{param_name}] must be a string."
|
|
116
|
+
next
|
|
117
|
+
end
|
|
118
|
+
errors << "Parameter [#{param_name}] must be at least #{rules[:min_length]} characters." if rules[:min_length] && value.length < rules[:min_length]
|
|
119
|
+
errors << "Parameter [#{param_name}] must be at most #{rules[:max_length]} characters." if rules[:max_length] && value.length > rules[:max_length]
|
|
120
|
+
|
|
121
|
+
if rules[:format] && FORMAT_PATTERNS[rules[:format]]
|
|
122
|
+
unless value.match?(FORMAT_PATTERNS[rules[:format]])
|
|
123
|
+
errors << "Parameter [#{param_name}] must be a valid #{rules[:format]}."
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
when "boolean"
|
|
127
|
+
unless [true, false, "true", "false"].include?(value)
|
|
128
|
+
errors << "Parameter [#{param_name}] must be a boolean."
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# Enum validation
|
|
133
|
+
if rules[:enum] && !rules[:enum].include?(value)
|
|
134
|
+
errors << "Parameter [#{param_name}] must be one of: #{rules[:enum].join(', ')}."
|
|
135
|
+
end
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
raise ValidationError, errors unless errors.empty?
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
def handle_response(response)
|
|
142
|
+
log("Response status: #{response.status}")
|
|
143
|
+
|
|
144
|
+
data = JSON.parse(response.body)
|
|
145
|
+
|
|
146
|
+
if data["status"] == "error"
|
|
147
|
+
raise APIError.new(data["error"] || "Unknown API error", response.status, data)
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
unless response.success?
|
|
151
|
+
raise APIError.new(data["error"] || "HTTP #{response.status} error", response.status, data)
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
log("Request successful")
|
|
155
|
+
data
|
|
156
|
+
rescue JSON::ParserError => e
|
|
157
|
+
raise APIError.new("Invalid JSON response: #{e.message}", response.status)
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
def log(message)
|
|
161
|
+
puts "[APIVerve::Rsstojson] #{message}" if @debug
|
|
162
|
+
end
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Custom error class for API errors
|
|
166
|
+
class APIError < StandardError
|
|
167
|
+
attr_reader :status_code, :response
|
|
168
|
+
|
|
169
|
+
def initialize(message, status_code = nil, response = nil)
|
|
170
|
+
@status_code = status_code
|
|
171
|
+
@response = response
|
|
172
|
+
super(message)
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
# Custom error class for validation errors
|
|
177
|
+
class ValidationError < StandardError
|
|
178
|
+
attr_reader :errors
|
|
179
|
+
|
|
180
|
+
def initialize(errors)
|
|
181
|
+
@errors = errors
|
|
182
|
+
super("Validation failed: #{errors.join(' ')}")
|
|
183
|
+
end
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: apiverve_rsstojson
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 1.2.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- APIVerve
|
|
8
|
+
bindir: bin
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: faraday
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - ">="
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '1.0'
|
|
19
|
+
- - "<"
|
|
20
|
+
- !ruby/object:Gem::Version
|
|
21
|
+
version: '3.0'
|
|
22
|
+
type: :runtime
|
|
23
|
+
prerelease: false
|
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
25
|
+
requirements:
|
|
26
|
+
- - ">="
|
|
27
|
+
- !ruby/object:Gem::Version
|
|
28
|
+
version: '1.0'
|
|
29
|
+
- - "<"
|
|
30
|
+
- !ruby/object:Gem::Version
|
|
31
|
+
version: '3.0'
|
|
32
|
+
- !ruby/object:Gem::Dependency
|
|
33
|
+
name: faraday-multipart
|
|
34
|
+
requirement: !ruby/object:Gem::Requirement
|
|
35
|
+
requirements:
|
|
36
|
+
- - "~>"
|
|
37
|
+
- !ruby/object:Gem::Version
|
|
38
|
+
version: '1.0'
|
|
39
|
+
type: :runtime
|
|
40
|
+
prerelease: false
|
|
41
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
42
|
+
requirements:
|
|
43
|
+
- - "~>"
|
|
44
|
+
- !ruby/object:Gem::Version
|
|
45
|
+
version: '1.0'
|
|
46
|
+
- !ruby/object:Gem::Dependency
|
|
47
|
+
name: json
|
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
|
49
|
+
requirements:
|
|
50
|
+
- - "~>"
|
|
51
|
+
- !ruby/object:Gem::Version
|
|
52
|
+
version: '2.0'
|
|
53
|
+
type: :runtime
|
|
54
|
+
prerelease: false
|
|
55
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
56
|
+
requirements:
|
|
57
|
+
- - "~>"
|
|
58
|
+
- !ruby/object:Gem::Version
|
|
59
|
+
version: '2.0'
|
|
60
|
+
description: RSS to JSON is a simple tool for converting RSS feeds into JSON format.
|
|
61
|
+
It returns the RSS feed in JSON format.
|
|
62
|
+
email:
|
|
63
|
+
- hello@apiverve.com
|
|
64
|
+
executables: []
|
|
65
|
+
extensions: []
|
|
66
|
+
extra_rdoc_files: []
|
|
67
|
+
files:
|
|
68
|
+
- LICENSE
|
|
69
|
+
- README.md
|
|
70
|
+
- lib/apiverve/client.rb
|
|
71
|
+
- lib/apiverve_rsstojson.rb
|
|
72
|
+
- lib/apiverve_rsstojson/client.rb
|
|
73
|
+
homepage: https://apiverve.com/marketplace/rsstojson?utm_source=ruby&utm_medium=homepage
|
|
74
|
+
licenses:
|
|
75
|
+
- MIT
|
|
76
|
+
metadata:
|
|
77
|
+
homepage_uri: https://apiverve.com/marketplace/rsstojson?utm_source=ruby&utm_medium=homepage
|
|
78
|
+
source_code_uri: https://github.com/apiverve/rsstojson-API/tree/main/ruby
|
|
79
|
+
changelog_uri: https://apiverve.com/changelog
|
|
80
|
+
documentation_uri: https://docs.apiverve.com/ref/rsstojson
|
|
81
|
+
rdoc_options: []
|
|
82
|
+
require_paths:
|
|
83
|
+
- lib
|
|
84
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - ">="
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: 2.7.0
|
|
89
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
90
|
+
requirements:
|
|
91
|
+
- - ">="
|
|
92
|
+
- !ruby/object:Gem::Version
|
|
93
|
+
version: '0'
|
|
94
|
+
requirements: []
|
|
95
|
+
rubygems_version: 3.6.9
|
|
96
|
+
specification_version: 4
|
|
97
|
+
summary: RSS to JSON API - Ruby Client
|
|
98
|
+
test_files: []
|