-
-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathcreate_feed.rb
More file actions
192 lines (164 loc) · 6.98 KB
/
create_feed.rb
File metadata and controls
192 lines (164 loc) · 6.98 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# frozen_string_literal: true
require 'time'
require 'json'
module Html2rss
module Web
module Api
module V1
##
# Creates stable feed records from authenticated API requests.
module CreateFeed # rubocop:disable Metrics/ModuleLength
FEED_ATTRIBUTE_KEYS =
%i[id name url feed_token public_url json_public_url created_at updated_at].freeze
class << self # rubocop:disable Metrics/ClassLength
# Creates a feed and returns a normalized API success payload.
#
# @param request [Rack::Request] HTTP request with auth context.
# @return [Hash{Symbol=>Object}] API response payload.
def call(request) # rubocop:disable Metrics/MethodLength
params, feed_data = build_feed_from_request(request)
emit_create_success(params)
Response.success(response: request.response,
status: 201,
data: {
feed: feed_attributes(feed_data),
conversion: FeedStatus.initial_conversion
},
meta: { created: true })
rescue StandardError => error
emit_create_failure(error)
raise
end
private
# @return [void]
def ensure_auto_source_enabled!
raise Html2rss::Web::AutoSourceDisabledError unless AutoSource.enabled?
end
# @param request [Rack::Request]
# @return [Hash]
def require_account(request)
account = Auth.authenticate(request)
raise Html2rss::Web::UnauthorizedError, 'Authentication required' unless account
account
end
# @param params [Hash]
# @param account [Hash]
# @return [Html2rss::Web::Api::V1::FeedMetadata::CreateParams]
def build_create_params(params, account)
url = validated_url(params['url'], account)
FeedMetadata::CreateParams.new(
url: url,
name: FeedMetadata.site_title_for(url)
)
end
# @param raw_url [String, nil]
# @param account [Hash]
# @return [String]
def validated_url(raw_url, account)
url = normalized_input_url(raw_url)
raise Html2rss::Web::BadRequestError, 'URL parameter is required' if url.empty?
url = UrlValidator.canonical_url(url)
raise Html2rss::Web::BadRequestError, 'Invalid URL format' unless url
unless UrlValidator.url_allowed?(account, url)
raise Html2rss::Web::ForbiddenError, 'URL not allowed for this account'
end
url
end
# @param raw_url [String, nil]
# @return [String]
def normalized_input_url(raw_url)
url = raw_url.to_s.strip
return url if url.empty?
return "https:#{url}" if url.start_with?('//')
return url if absolute_url?(url)
hostname_input?(url) ? "https://#{url}" : url
end
# @param url [String]
# @return [Boolean]
def absolute_url?(url)
url.match?(%r{\A[a-z][a-z0-9+\-.]*://}i)
end
# @param url [String]
# @return [Boolean]
def hostname_input?(url)
%r{
\A
(localhost(?::\d+)?|(?:\d{1,3}\.){3}\d{1,3}(?::\d+)?|(?:[a-z0-9-]+\.)+[a-z]{2,}(?::\d+)?)
(?:[/?#].*)?
\z
}ix.match?(url)
end
# @param feed_data [Hash, Html2rss::Web::Api::V1::FeedMetadata::Metadata]
# @return [Hash{Symbol=>Object}]
def feed_attributes(feed_data)
timestamp = Time.now.iso8601
typed_feed = feed_metadata(feed_data)
typed_feed_attributes(typed_feed, timestamp).slice(*FEED_ATTRIBUTE_KEYS)
end
# @param request [Rack::Request]
# @return [Hash]
def request_params(request)
return request.params unless json_request?(request)
raw_body = request.body.read
request.body.rewind
return request.params if raw_body.strip.empty?
parsed = JSON.parse(raw_body)
raise Html2rss::Web::BadRequestError, 'Invalid JSON payload' unless parsed.is_a?(Hash)
request.params.merge(parsed)
rescue JSON::ParserError
raise Html2rss::Web::BadRequestError, 'Invalid JSON payload'
end
# @param request [Rack::Request]
# @return [Boolean]
def json_request?(request)
content_type = request.env['CONTENT_TYPE'].to_s
content_type.include?('application/json')
end
# @param request [Rack::Request]
# @return [Array<(Html2rss::Web::Api::V1::FeedMetadata::CreateParams, Object)>]
def build_feed_from_request(request)
account = require_account(request)
ensure_auto_source_enabled!
params = build_create_params(request_params(request), account)
feed_data = AutoSource.create_stable_feed(params.name, params.url, account)
raise Html2rss::Web::InternalServerError, 'Failed to create feed' unless feed_data
[params, feed_data]
end
# @param params [Html2rss::Web::Api::V1::FeedMetadata::CreateParams]
# @return [void]
def emit_create_success(params)
Observability.emit(
event_name: 'feed.create',
outcome: 'success',
details: { url: params.url },
level: :info
)
end
# @param error [StandardError]
# @return [void]
def emit_create_failure(error)
Observability.emit(
event_name: 'feed.create',
outcome: 'failure',
details: { error_class: error.class.name, error_message: error.message },
level: :warn
)
end
# @param feed_data [Hash, Html2rss::Web::Api::V1::FeedMetadata::Metadata]
# @return [Html2rss::Web::Api::V1::FeedMetadata::Metadata]
def feed_metadata(feed_data)
return feed_data if feed_data.is_a?(FeedMetadata::Metadata)
FeedMetadata::Metadata.new(**feed_data)
end
# @param typed_feed [Html2rss::Web::Api::V1::FeedMetadata::Metadata]
# @param timestamp [String]
# @return [Hash{Symbol=>Object}]
def typed_feed_attributes(typed_feed, timestamp)
typed_feed.to_h.merge(created_at: timestamp, updated_at: timestamp)
end
end
end
end
end
end
end