appnigma-sdk 2.0.0 → 2.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.
Files changed (168) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +592 -26
  4. data/exe/appnigma +8 -0
  5. data/lib/appnigma/actions.rb +33 -0
  6. data/lib/appnigma/checks.rb +13 -0
  7. data/lib/appnigma/client.rb +30 -13
  8. data/lib/appnigma/command.rb +154 -0
  9. data/lib/appnigma/command_files.rb +46 -0
  10. data/lib/appnigma/connect_fields.rb +83 -0
  11. data/lib/appnigma/connections.rb +72 -3
  12. data/lib/appnigma/constants.rb +57 -0
  13. data/lib/appnigma/end_customers.rb +29 -0
  14. data/lib/appnigma/errors.rb +44 -6
  15. data/lib/appnigma/features.rb +19 -0
  16. data/lib/appnigma/files.rb +26 -0
  17. data/lib/appnigma/generated/api/default_api.rb +2149 -380
  18. data/lib/appnigma/generated/api_client.rb +1 -1
  19. data/lib/appnigma/generated/api_error.rb +1 -1
  20. data/lib/appnigma/generated/api_model_base.rb +1 -1
  21. data/lib/appnigma/generated/configuration.rb +1 -1
  22. data/lib/appnigma/generated/models/action_entry.rb +1 -1
  23. data/lib/appnigma/generated/models/check_logic_input.rb +276 -0
  24. data/lib/appnigma/generated/models/check_logic_output.rb +193 -0
  25. data/lib/appnigma/generated/models/client_event.rb +309 -0
  26. data/lib/appnigma/generated/models/client_event_delivery.rb +306 -0
  27. data/lib/appnigma/generated/models/client_event_type.rb +44 -0
  28. data/lib/appnigma/generated/models/client_webhook.rb +346 -0
  29. data/lib/appnigma/generated/models/connect_end_customer_input.rb +243 -0
  30. data/lib/appnigma/generated/models/connect_end_customer_output.rb +294 -0
  31. data/lib/appnigma/generated/models/connect_field.rb +308 -0
  32. data/lib/appnigma/generated/models/connection_status.rb +1 -1
  33. data/lib/appnigma/generated/models/create_connection_link_input.rb +1 -1
  34. data/lib/appnigma/generated/models/create_connection_link_output.rb +1 -1
  35. data/lib/appnigma/generated/models/create_logic_input.rb +273 -0
  36. data/lib/appnigma/generated/models/create_logic_input_trigger.rb +104 -0
  37. data/lib/appnigma/generated/models/create_logic_input_trigger_any_of.rb +257 -0
  38. data/lib/appnigma/generated/models/create_logic_input_trigger_any_of1.rb +238 -0
  39. data/lib/appnigma/generated/models/create_logic_output.rb +230 -0
  40. data/lib/appnigma/generated/models/create_portal_link_input.rb +2 -18
  41. data/lib/appnigma/generated/models/create_portal_link_output.rb +1 -1
  42. data/lib/appnigma/generated/models/create_webhook_input.rb +187 -0
  43. data/lib/appnigma/generated/models/create_webhook_output.rb +204 -0
  44. data/lib/appnigma/generated/models/crm_company.rb +1 -1
  45. data/lib/appnigma/generated/models/crm_company_get_output.rb +1 -1
  46. data/lib/appnigma/generated/models/crm_company_list_output.rb +1 -1
  47. data/lib/appnigma/generated/models/crm_company_write_output.rb +1 -1
  48. data/lib/appnigma/generated/models/crm_contact.rb +1 -1
  49. data/lib/appnigma/generated/models/crm_contact_get_output.rb +1 -1
  50. data/lib/appnigma/generated/models/crm_contact_list_output.rb +1 -1
  51. data/lib/appnigma/generated/models/crm_contact_write_output.rb +1 -1
  52. data/lib/appnigma/generated/models/crm_create_input.rb +1 -1
  53. data/lib/appnigma/generated/models/crm_custom_field.rb +1 -1
  54. data/lib/appnigma/generated/models/crm_deal.rb +1 -1
  55. data/lib/appnigma/generated/models/crm_deal_create_input.rb +1 -1
  56. data/lib/appnigma/generated/models/crm_deal_get_output.rb +1 -1
  57. data/lib/appnigma/generated/models/crm_deal_list_output.rb +1 -1
  58. data/lib/appnigma/generated/models/crm_deal_write_output.rb +1 -1
  59. data/lib/appnigma/generated/models/crm_email.rb +1 -1
  60. data/lib/appnigma/generated/models/crm_get_input.rb +1 -1
  61. data/lib/appnigma/generated/models/crm_labelled.rb +1 -1
  62. data/lib/appnigma/generated/models/crm_list_input.rb +1 -1
  63. data/lib/appnigma/generated/models/crm_phone.rb +1 -1
  64. data/lib/appnigma/generated/models/crm_update_input.rb +1 -1
  65. data/lib/appnigma/generated/models/delete_end_customer_input.rb +178 -0
  66. data/lib/appnigma/generated/models/delete_end_customer_output.rb +286 -0
  67. data/lib/appnigma/generated/models/delete_end_customer_output_connections_inner.rb +238 -0
  68. data/lib/appnigma/generated/models/delete_end_customer_output_logic_folder.rb +255 -0
  69. data/lib/appnigma/generated/models/delete_end_customer_output_steps_inner.rb +257 -0
  70. data/lib/appnigma/generated/models/delete_webhook_input.rb +189 -0
  71. data/lib/appnigma/generated/models/delete_webhook_output.rb +228 -0
  72. data/lib/appnigma/generated/models/discard_logic_input.rb +292 -0
  73. data/lib/appnigma/generated/models/discard_logic_output.rb +254 -0
  74. data/lib/appnigma/generated/models/disconnect_connection_input.rb +216 -0
  75. data/lib/appnigma/generated/models/disconnect_connection_output.rb +294 -0
  76. data/lib/appnigma/generated/models/edit_logic_input.rb +368 -0
  77. data/lib/appnigma/generated/models/edit_logic_output.rb +298 -0
  78. data/lib/appnigma/generated/models/encrypted_fields.rb +357 -0
  79. data/lib/appnigma/generated/models/end_customer.rb +17 -3
  80. data/lib/appnigma/generated/models/end_customer_connection.rb +1 -1
  81. data/lib/appnigma/generated/models/function_entry.rb +1 -1
  82. data/lib/appnigma/generated/models/function_owner.rb +1 -1
  83. data/lib/appnigma/generated/models/function_owner_one_of.rb +1 -1
  84. data/lib/appnigma/generated/models/function_owner_one_of1.rb +1 -1
  85. data/lib/appnigma/generated/models/get_alerts_output.rb +180 -0
  86. data/lib/appnigma/generated/models/get_connect_key_output.rb +256 -0
  87. data/lib/appnigma/generated/models/get_connection_input.rb +1 -1
  88. data/lib/appnigma/generated/models/get_connection_output.rb +34 -7
  89. data/lib/appnigma/generated/models/get_guide_output.rb +1 -1
  90. data/lib/appnigma/generated/models/get_logic_go_live_status_input.rb +247 -0
  91. data/lib/appnigma/generated/models/get_logic_go_live_status_output.rb +296 -0
  92. data/lib/appnigma/generated/models/get_logic_input.rb +247 -0
  93. data/lib/appnigma/generated/models/get_logic_output.rb +240 -0
  94. data/lib/appnigma/generated/models/get_logic_output_file.rb +204 -0
  95. data/lib/appnigma/generated/models/get_platform_input.rb +188 -0
  96. data/lib/appnigma/generated/models/get_platform_output.rb +326 -0
  97. data/lib/appnigma/generated/models/get_sync_output.rb +207 -0
  98. data/lib/appnigma/generated/models/go_live_logic_input.rb +316 -0
  99. data/lib/appnigma/generated/models/go_live_logic_output.rb +281 -0
  100. data/lib/appnigma/generated/models/json_value.rb +1 -1
  101. data/lib/appnigma/generated/models/list_actions_output.rb +1 -1
  102. data/lib/appnigma/generated/models/list_connections_output.rb +3 -3
  103. data/lib/appnigma/generated/models/list_events_input.rb +302 -0
  104. data/lib/appnigma/generated/models/list_events_output.rb +193 -0
  105. data/lib/appnigma/generated/models/list_features_output.rb +179 -0
  106. data/lib/appnigma/generated/models/list_features_output_features_inner.rb +229 -0
  107. data/lib/appnigma/generated/models/list_functions_output.rb +1 -1
  108. data/lib/appnigma/generated/models/list_logic_input.rb +162 -0
  109. data/lib/appnigma/generated/models/list_logic_output.rb +209 -0
  110. data/lib/appnigma/generated/models/list_logic_runs_input.rb +275 -0
  111. data/lib/appnigma/generated/models/list_logic_runs_output.rb +193 -0
  112. data/lib/appnigma/generated/models/list_platforms_output.rb +1 -1
  113. data/lib/appnigma/generated/models/list_record_changes_input.rb +375 -0
  114. data/lib/appnigma/generated/models/list_record_changes_output.rb +193 -0
  115. data/lib/appnigma/generated/models/list_webhooks_output.rb +180 -0
  116. data/lib/appnigma/generated/models/logic_check_problem.rb +203 -0
  117. data/lib/appnigma/generated/models/logic_conditional.rb +3 -3
  118. data/lib/appnigma/generated/models/logic_draft.rb +257 -0
  119. data/lib/appnigma/generated/models/logic_entry.rb +441 -0
  120. data/lib/appnigma/generated/models/logic_entry_failure.rb +205 -0
  121. data/lib/appnigma/generated/models/logic_folder_problem.rb +218 -0
  122. data/lib/appnigma/generated/models/logic_run.rb +483 -0
  123. data/lib/appnigma/generated/models/logic_test_call.rb +269 -0
  124. data/lib/appnigma/generated/models/platform_entry.rb +63 -6
  125. data/lib/appnigma/generated/models/platform_entry_coverage_inner.rb +1 -1
  126. data/lib/appnigma/generated/models/platform_request_input.rb +1 -1
  127. data/lib/appnigma/generated/models/platform_request_input_body.rb +1 -1
  128. data/lib/appnigma/generated/models/platform_request_output.rb +1 -1
  129. data/lib/appnigma/generated/models/ran_as.rb +1 -1
  130. data/lib/appnigma/generated/models/record_change.rb +231 -0
  131. data/lib/appnigma/generated/models/record_change_record.rb +105 -0
  132. data/lib/appnigma/generated/models/run_action_input.rb +1 -1
  133. data/lib/appnigma/generated/models/run_action_output.rb +1 -1
  134. data/lib/appnigma/generated/models/run_input.rb +1 -1
  135. data/lib/appnigma/generated/models/run_output.rb +1 -1
  136. data/lib/appnigma/generated/models/sdk_error.rb +1 -1
  137. data/lib/appnigma/generated/models/sdk_error_error.rb +3 -3
  138. data/lib/appnigma/generated/models/sdk_error_error_details.rb +81 -6
  139. data/lib/appnigma/generated/models/sdk_problem.rb +1 -1
  140. data/lib/appnigma/generated/models/set_alerts_input.rb +197 -0
  141. data/lib/appnigma/generated/models/set_alerts_output.rb +180 -0
  142. data/lib/appnigma/generated/models/set_sync_input.rb +177 -0
  143. data/lib/appnigma/generated/models/set_sync_output.rb +207 -0
  144. data/lib/appnigma/generated/models/switch_logic_off_input.rb +200 -0
  145. data/lib/appnigma/generated/models/switch_logic_off_output.rb +315 -0
  146. data/lib/appnigma/generated/models/switch_logic_on_input.rb +200 -0
  147. data/lib/appnigma/generated/models/switch_logic_on_output.rb +315 -0
  148. data/lib/appnigma/generated/models/sync_health.rb +231 -0
  149. data/lib/appnigma/generated/models/test_logic_input.rb +355 -0
  150. data/lib/appnigma/generated/models/test_logic_output.rb +418 -0
  151. data/lib/appnigma/generated/models/test_logic_output_error.rb +231 -0
  152. data/lib/appnigma/generated/models/update_logic_input.rb +359 -0
  153. data/lib/appnigma/generated/models/update_logic_output.rb +205 -0
  154. data/lib/appnigma/generated/version.rb +1 -1
  155. data/lib/appnigma/generated.rb +77 -1
  156. data/lib/appnigma/logic.rb +176 -0
  157. data/lib/appnigma/names.rb +4 -4
  158. data/lib/appnigma/platforms.rb +11 -1
  159. data/lib/appnigma/portal.rb +8 -5
  160. data/lib/appnigma/records.rb +46 -0
  161. data/lib/appnigma/schema_type.rb +149 -0
  162. data/lib/appnigma/sync.rb +30 -0
  163. data/lib/appnigma/types_printer.rb +154 -0
  164. data/lib/appnigma/verify_webhook.rb +107 -0
  165. data/lib/appnigma/version.rb +2 -2
  166. data/lib/appnigma/webhooks.rb +79 -0
  167. data/lib/appnigma.rb +1 -0
  168. metadata +95 -3
@@ -0,0 +1,154 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "schema_type"
4
+
5
+ module Appnigma
6
+ # The type alias names in one RBS file: lowercase words joined by
7
+ # underscores, and never the same twice.
8
+ class TypeAliasNames
9
+ def self.base(*words)
10
+ name = words.join("_").downcase.gsub(/[^a-z0-9]+/, "_").gsub(/\A_+|_+\z/, "")
11
+ name.match?(/\A[a-z]/) ? name : "t_#{name}"
12
+ end
13
+
14
+ def initialize
15
+ @taken = Set.new
16
+ end
17
+
18
+ # The name wanted, or the same with a number when one already has it.
19
+ def take(wanted)
20
+ candidate = wanted
21
+ number = 2
22
+ while @taken.include?(candidate)
23
+ candidate = "#{wanted}_#{number}"
24
+ number += 1
25
+ end
26
+ @taken << candidate
27
+ candidate
28
+ end
29
+ end
30
+
31
+ # Prints the RBS file `appnigma types` writes (24.3): a record type for the
32
+ # input and the output of every function and action, and a union of the
33
+ # names on each platform, inside `AppnigmaTypes`. Steep and RubyMine read
34
+ # it; the gem's own methods stay untyped, so the types are for the
35
+ # customer's own signatures.
36
+ class TypesPrinter
37
+ INDENT = " "
38
+
39
+ USAGE_LINES = [
40
+ "", "Each function and action has a type for what you send and one for what",
41
+ "comes back. Use them in your own signatures, for example:", "",
42
+ " def send_invoice: (AppnigmaTypes::hubspot_invoice_to_deal_input) -> void"
43
+ ].freeze
44
+
45
+ NOTHING_LIVE = ["", "No functions have gone live yet. Run `appnigma types` again once one has."].freeze
46
+
47
+ def self.print_types_file(functions, generated_at, actions = [])
48
+ new(functions, generated_at, actions).text
49
+ end
50
+
51
+ def initialize(functions, generated_at, actions)
52
+ @functions = functions
53
+ @actions = actions
54
+ @generated_at = generated_at
55
+ @names = TypeAliasNames.new
56
+ @functions_by_platform = group_functions(functions)
57
+ @actions_by_platform = actions.sort_by { |action| [action[:platform], action[:name]] }
58
+ .group_by { |action| action[:platform] }
59
+ end
60
+
61
+ def text
62
+ body = function_blocks + action_blocks
63
+ module_text = body.empty? ? "module AppnigmaTypes\nend" : "module AppnigmaTypes\n#{body.join("\n\n")}\nend"
64
+ "#{comment(header, "")}\n\n#{module_text}\n"
65
+ end
66
+
67
+ private
68
+
69
+ def header
70
+ read_at = @generated_at.utc.strftime("%Y-%m-%dT%H:%M:%S.%LZ")
71
+ lines = ["Your Appnigma functions, read on #{read_at} by `appnigma types`.",
72
+ "Do not edit by hand: run the command again after a function goes live.",
73
+ count_line(@functions.size, @functions_by_platform.size, "function")]
74
+ lines << count_line(@actions.size, @actions_by_platform.size, "action") unless @actions_by_platform.empty?
75
+ lines + USAGE_LINES + (@functions_by_platform.empty? ? NOTHING_LIVE : [])
76
+ end
77
+
78
+ def count_line(count, platform_count, word)
79
+ "#{plural(count, word)} across #{plural(platform_count, "platform")}."
80
+ end
81
+
82
+ # One entry per platform and name. The shape printed is the customer's
83
+ # own; end customers with a function of their own by that name are named
84
+ # by their logic folder key, each once; with none of the customer's, the
85
+ # first end customer's shape stands in. As the TypeScript printer does.
86
+ def group_functions(functions)
87
+ by_platform = Hash.new { |hash, platform| hash[platform] = {} }
88
+ functions.sort_by { |entry| [entry[:platform], entry[:name]] }.each do |entry|
89
+ add_function(by_platform[entry[:platform]], entry)
90
+ end
91
+ by_platform.transform_values(&:values)
92
+ end
93
+
94
+ def add_function(by_name, entry)
95
+ printed = (by_name[entry[:name]] ||= { entry: entry, their_own: [] })
96
+ if (entry[:owner] || {})[:type] == "end_customer"
97
+ printed[:their_own] |= [entry[:owner][:logic_folder_key]]
98
+ elsif (printed[:entry][:owner] || {})[:type] == "end_customer"
99
+ printed[:entry] = entry
100
+ end
101
+ end
102
+
103
+ def function_blocks
104
+ @functions_by_platform.flat_map do |platform, printed|
105
+ printed.map { |one| function_block(platform, one) } +
106
+ [names_block(platform, "function", printed.map { |one| one[:entry][:name] })]
107
+ end
108
+ end
109
+
110
+ def action_blocks
111
+ @actions_by_platform.flat_map do |platform, actions|
112
+ actions.map { |action| action_block(platform, action) } +
113
+ [names_block(platform, "action", actions.map { |action| action[:name] })]
114
+ end
115
+ end
116
+
117
+ def function_block(platform, printed)
118
+ entry = printed[:entry]
119
+ notes = printed[:their_own].map do |logic_folder_key|
120
+ "The end customer with logic folder key #{logic_folder_key} has a function of its own by this name."
121
+ end
122
+ lines = ["#{platform}: #{entry[:name]}", *description_lines(entry), *notes]
123
+ entry_block(lines, TypeAliasNames.base(platform, entry[:name]), entry[:input_schema], entry[:output_schema])
124
+ end
125
+
126
+ def action_block(platform, action)
127
+ lines = ["#{platform}: #{action[:name]} (action)", *description_lines(action)]
128
+ entry_block(lines, "#{TypeAliasNames.base(platform, action[:name])}_action", action[:input], action[:output])
129
+ end
130
+
131
+ def description_lines(entry)
132
+ entry[:description].to_s.lines.map(&:chomp)
133
+ end
134
+
135
+ def entry_block(lines, base, input, output)
136
+ [comment(lines, INDENT),
137
+ "#{INDENT}type #{@names.take("#{base}_input")} = #{SchemaType.of(input)}",
138
+ "#{INDENT}type #{@names.take("#{base}_output")} = #{SchemaType.of(output)}"].join("\n")
139
+ end
140
+
141
+ def names_block(platform, kind, entry_names)
142
+ quoted = entry_names.map { |name| SchemaType.quote(name) }
143
+ "#{INDENT}type #{@names.take(TypeAliasNames.base(platform, "#{kind}_name"))} = #{quoted.join(" | ")}"
144
+ end
145
+
146
+ def comment(lines, pad)
147
+ lines.map { |line| "#{pad}# #{line}".rstrip }.join("\n")
148
+ end
149
+
150
+ def plural(count, word)
151
+ "#{count} #{word}#{"s" unless count == 1}"
152
+ end
153
+ end
154
+ end
@@ -0,0 +1,107 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+ require "openssl"
5
+ require_relative "constants"
6
+ require_relative "errors"
7
+ require_relative "names"
8
+
9
+ module Appnigma
10
+ # 24.11: checks a webhook your server received before you trust it. The
11
+ # server sends `Appnigma-Signature: t=<unix seconds>,v1=<hex>`, where v1 is
12
+ # the HMAC-SHA256 of "<t>.<body>" keyed with the webhook's secret.
13
+ module VerifyWebhook
14
+ SECONDS_PATTERN = /\A\d+\z/
15
+ SIGNATURE_PATTERN = /\A[0-9a-fA-F]{64}\z/
16
+ MALFORMED = "The Appnigma-Signature header is not t=<seconds>,v1=<hex>"
17
+ EVENT_TEXT_KEYS = %w[id type createdAt].freeze
18
+
19
+ module_function
20
+
21
+ def refuse(reason, message)
22
+ raise WebhookSignatureError.new(reason: reason, message: message)
23
+ end
24
+
25
+ # The event, `{ id:, type:, created_at:, data: }` in Ruby names, once its
26
+ # signature checks. A type this gem does not know yet is still handed
27
+ # back: it was signed like any other.
28
+ def verify(body, signature_header, secret, tolerance_seconds:, now:)
29
+ refuse("missing_secret", "Pass the webhook's secret, as webhooks.create answered it") unless text?(secret)
30
+ raw = body_bytes(body)
31
+ signed_at, signatures = read_header(signature_header)
32
+ check_age!(signed_at, tolerance_seconds, now)
33
+ expected = OpenSSL::HMAC.hexdigest("SHA256", secret, "#{signed_at}.".b + raw)
34
+ unless signatures.any? { |signature| OpenSSL.secure_compare(expected, signature) }
35
+ refuse("mismatch", "The signature does not match this body and secret")
36
+ end
37
+ read_event(raw)
38
+ end
39
+
40
+ def text?(value)
41
+ value.is_a?(String) && !value.strip.empty?
42
+ end
43
+
44
+ def check_age!(signed_at, tolerance_seconds, now)
45
+ return if (now.to_i - signed_at).abs <= tolerance_seconds
46
+
47
+ refuse("too_old", "The signature is more than #{tolerance_seconds} seconds from now; " \
48
+ "refuse it, it may be a message sent again")
49
+ end
50
+
51
+ # The body as the bytes that arrived. A parsed Hash is refused: its JSON
52
+ # text written again may not be the bytes that were signed.
53
+ def body_bytes(body)
54
+ return body.b if body.is_a?(String)
55
+
56
+ refuse("body_not_raw", "Pass the body exactly as it arrived, as request.body.read gives it, not a parsed Hash")
57
+ end
58
+
59
+ # `t` once, and every v1, so a header carrying two signatures while a
60
+ # secret is replaced still checks.
61
+ def read_header(header)
62
+ refuse("missing_header", "The Appnigma-Signature header is missing") unless text?(header)
63
+ pairs = header.split(",").map { |part| header_pair(part) }
64
+ signed_at = values_named(pairs, "t", SECONDS_PATTERN).first
65
+ signatures = values_named(pairs, "v1", SIGNATURE_PATTERN).map(&:downcase)
66
+ refuse("malformed_header", MALFORMED) if signed_at.nil? || signatures.empty?
67
+ [Integer(signed_at, 10), signatures]
68
+ end
69
+
70
+ def values_named(pairs, wanted, pattern)
71
+ pairs.filter_map { |name, value| value if name == wanted && value.match?(pattern) }
72
+ end
73
+
74
+ def header_pair(part)
75
+ pieces = part.strip.split("=", -1)
76
+ refuse("malformed_header", MALFORMED) unless pieces.size == 2
77
+ pieces
78
+ end
79
+
80
+ def read_event(raw)
81
+ parsed = parse_json(raw)
82
+ refuse("not_an_event", "The body is not an Appnigma event") unless event?(parsed)
83
+ Names.answer(parsed)
84
+ end
85
+
86
+ def event?(parsed)
87
+ parsed.is_a?(Hash) && EVENT_TEXT_KEYS.all? { |key| parsed[key].is_a?(String) } && parsed["data"].is_a?(Hash)
88
+ end
89
+
90
+ def parse_json(raw)
91
+ JSON.parse(raw.dup.force_encoding(Encoding::UTF_8))
92
+ rescue JSON::ParserError, EncodingError
93
+ refuse("not_an_event", "The body is not JSON")
94
+ end
95
+ end
96
+
97
+ module_function
98
+
99
+ # Checks a webhook your server received: the body exactly as it arrived,
100
+ # the Appnigma-Signature header, and the webhook's secret. Answers the
101
+ # event; raises WebhookSignatureError when the message is not from us or
102
+ # is more than `tolerance_seconds` from now. `now` is for tests.
103
+ def verify_webhook(body, signature_header, secret, tolerance_seconds: WEBHOOK_SIGNATURE_TOLERANCE_SECONDS,
104
+ now: Time.now)
105
+ VerifyWebhook.verify(body, signature_header, secret, tolerance_seconds: tolerance_seconds, now: now)
106
+ end
107
+ end
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Appnigma
4
- VERSION = "2.0.0" # x-release-please-version
4
+ VERSION = "2.2.0" # x-release-please-version
5
5
 
6
6
  # The version of the API description (openapi/sdk-v1.yaml) this gem was
7
7
  # generated from. Written by bin/generate; a test ties it to the file.
8
- API_DESCRIPTION_VERSION = "4.0.0"
8
+ API_DESCRIPTION_VERSION = "5.4.0"
9
9
  end
@@ -0,0 +1,79 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "checks"
4
+ require_relative "names"
5
+
6
+ module Appnigma
7
+ # Where your server is told what happened: `client.webhooks.create`, `list`
8
+ # and `delete` (24.11). A create sent again after a lost answer would find
9
+ # its own address taken and its secret gone, and a delete would find
10
+ # nothing, so each is made once; the list is a read, and is retried.
11
+ class Webhooks
12
+ def initialize(client)
13
+ @client = client
14
+ end
15
+
16
+ # Add an https:// address on the public internet, up to five. The
17
+ # answer's `secret` signs every event sent there; it is in this answer
18
+ # only, so keep it where your server can read it.
19
+ def create(url:, timeout_ms: nil)
20
+ Checks.refuse("url", "must be an https:// address") unless url.is_a?(String) && !url.empty?
21
+ @client.call(:create_webhook, { "url" => url }, policy: @client.one_attempt, timeout_ms: timeout_ms)
22
+ end
23
+
24
+ # Every webhook, oldest first, never its secret. One whose every send
25
+ # failed for 3 days has `state` "switched_off": delete it and create it
26
+ # again to start over.
27
+ def list(timeout_ms: nil)
28
+ @client.call(:list_webhooks, timeout_ms: timeout_ms)
29
+ end
30
+
31
+ # Nothing more is sent to it, tries still waiting included. Its events
32
+ # stay in `events.list`, without its deliveries.
33
+ def delete(webhook_id:, timeout_ms: nil)
34
+ unless webhook_id.is_a?(String) && !webhook_id.empty?
35
+ Checks.refuse("webhook_id", "must be a webhook id, as webhooks.list gives it")
36
+ end
37
+ body = Names.camel_keys(webhook_id: webhook_id)
38
+ @client.call(:delete_webhook, body, policy: @client.one_attempt, timeout_ms: timeout_ms)
39
+ end
40
+ end
41
+
42
+ # What happened, kept 30 days: `client.events.list` (24.11). A read, so it
43
+ # is retried.
44
+ class Events
45
+ def initialize(client)
46
+ @client = client
47
+ end
48
+
49
+ # Newest first, each event with how it went at every webhook. `type` and
50
+ # `since` (ISO 8601 with a time zone) narrow it; `limit` is 1 to 100, 20
51
+ # if left out. Pass `next_cursor` back as `cursor`, with the same type
52
+ # and since.
53
+ def list(type: nil, since: nil, limit: nil, cursor: nil, timeout_ms: nil)
54
+ body = Names.camel_keys(type: type, since: since, limit: limit, cursor: cursor)
55
+ @client.call(:list_events, body, timeout_ms: timeout_ms)
56
+ end
57
+ end
58
+
59
+ # Which events are sent to your webhooks: `client.alerts.get` and `set`
60
+ # (24.11). Every type until you choose; `events.list` keeps every type
61
+ # either way. Both are retried: setting replaces the list, so a repeat
62
+ # changes nothing.
63
+ class Alerts
64
+ def initialize(client)
65
+ @client = client
66
+ end
67
+
68
+ def get(timeout_ms: nil)
69
+ @client.call(:get_alerts, timeout_ms: timeout_ms)
70
+ end
71
+
72
+ # Replaces the list: a type left out is not sent. An empty list sends
73
+ # nothing.
74
+ def set(events:, timeout_ms: nil)
75
+ Checks.refuse("events", "must be an Array of event types") unless events.is_a?(Array)
76
+ @client.call(:set_alerts, { "events" => events }, timeout_ms: timeout_ms)
77
+ end
78
+ end
79
+ end
data/lib/appnigma.rb CHANGED
@@ -10,6 +10,7 @@ require_relative "appnigma/transport"
10
10
  require_relative "appnigma/connections"
11
11
  require_relative "appnigma/crm"
12
12
  require_relative "appnigma/client"
13
+ require_relative "appnigma/verify_webhook"
13
14
 
14
15
  # The gem a customer's product installs to reach its Appnigma microserver.
15
16
  module Appnigma
metadata CHANGED
@@ -1,11 +1,11 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: appnigma-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.0
4
+ version: 2.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Appnigma
8
- bindir: bin
8
+ bindir: exe
9
9
  cert_chain: []
10
10
  date: 1980-01-02 00:00:00.000000000 Z
11
11
  dependencies:
@@ -62,20 +62,29 @@ description: 'The gem a customer''s product installs to reach its Appnigma micro
62
62
  call any platform''s API, connect end customers, and read its own guide.'
63
63
  email:
64
64
  - support@appnigma.ai
65
- executables: []
65
+ executables:
66
+ - appnigma
66
67
  extensions: []
67
68
  extra_rdoc_files: []
68
69
  files:
69
70
  - CHANGELOG.md
70
71
  - LICENSE
71
72
  - README.md
73
+ - exe/appnigma
72
74
  - lib/appnigma.rb
75
+ - lib/appnigma/actions.rb
73
76
  - lib/appnigma/checks.rb
74
77
  - lib/appnigma/client.rb
78
+ - lib/appnigma/command.rb
79
+ - lib/appnigma/command_files.rb
80
+ - lib/appnigma/connect_fields.rb
75
81
  - lib/appnigma/connections.rb
76
82
  - lib/appnigma/constants.rb
77
83
  - lib/appnigma/crm.rb
84
+ - lib/appnigma/end_customers.rb
78
85
  - lib/appnigma/errors.rb
86
+ - lib/appnigma/features.rb
87
+ - lib/appnigma/files.rb
79
88
  - lib/appnigma/generated.rb
80
89
  - lib/appnigma/generated/api/default_api.rb
81
90
  - lib/appnigma/generated/api_client.rb
@@ -83,11 +92,27 @@ files:
83
92
  - lib/appnigma/generated/api_model_base.rb
84
93
  - lib/appnigma/generated/configuration.rb
85
94
  - lib/appnigma/generated/models/action_entry.rb
95
+ - lib/appnigma/generated/models/check_logic_input.rb
96
+ - lib/appnigma/generated/models/check_logic_output.rb
97
+ - lib/appnigma/generated/models/client_event.rb
98
+ - lib/appnigma/generated/models/client_event_delivery.rb
99
+ - lib/appnigma/generated/models/client_event_type.rb
100
+ - lib/appnigma/generated/models/client_webhook.rb
101
+ - lib/appnigma/generated/models/connect_end_customer_input.rb
102
+ - lib/appnigma/generated/models/connect_end_customer_output.rb
103
+ - lib/appnigma/generated/models/connect_field.rb
86
104
  - lib/appnigma/generated/models/connection_status.rb
87
105
  - lib/appnigma/generated/models/create_connection_link_input.rb
88
106
  - lib/appnigma/generated/models/create_connection_link_output.rb
107
+ - lib/appnigma/generated/models/create_logic_input.rb
108
+ - lib/appnigma/generated/models/create_logic_input_trigger.rb
109
+ - lib/appnigma/generated/models/create_logic_input_trigger_any_of.rb
110
+ - lib/appnigma/generated/models/create_logic_input_trigger_any_of1.rb
111
+ - lib/appnigma/generated/models/create_logic_output.rb
89
112
  - lib/appnigma/generated/models/create_portal_link_input.rb
90
113
  - lib/appnigma/generated/models/create_portal_link_output.rb
114
+ - lib/appnigma/generated/models/create_webhook_input.rb
115
+ - lib/appnigma/generated/models/create_webhook_output.rb
91
116
  - lib/appnigma/generated/models/crm_company.rb
92
117
  - lib/appnigma/generated/models/crm_company_get_output.rb
93
118
  - lib/appnigma/generated/models/crm_company_list_output.rb
@@ -109,27 +134,73 @@ files:
109
134
  - lib/appnigma/generated/models/crm_list_input.rb
110
135
  - lib/appnigma/generated/models/crm_phone.rb
111
136
  - lib/appnigma/generated/models/crm_update_input.rb
137
+ - lib/appnigma/generated/models/delete_end_customer_input.rb
138
+ - lib/appnigma/generated/models/delete_end_customer_output.rb
139
+ - lib/appnigma/generated/models/delete_end_customer_output_connections_inner.rb
140
+ - lib/appnigma/generated/models/delete_end_customer_output_logic_folder.rb
141
+ - lib/appnigma/generated/models/delete_end_customer_output_steps_inner.rb
142
+ - lib/appnigma/generated/models/delete_webhook_input.rb
143
+ - lib/appnigma/generated/models/delete_webhook_output.rb
144
+ - lib/appnigma/generated/models/discard_logic_input.rb
145
+ - lib/appnigma/generated/models/discard_logic_output.rb
146
+ - lib/appnigma/generated/models/disconnect_connection_input.rb
147
+ - lib/appnigma/generated/models/disconnect_connection_output.rb
148
+ - lib/appnigma/generated/models/edit_logic_input.rb
149
+ - lib/appnigma/generated/models/edit_logic_output.rb
150
+ - lib/appnigma/generated/models/encrypted_fields.rb
112
151
  - lib/appnigma/generated/models/end_customer.rb
113
152
  - lib/appnigma/generated/models/end_customer_connection.rb
114
153
  - lib/appnigma/generated/models/function_entry.rb
115
154
  - lib/appnigma/generated/models/function_owner.rb
116
155
  - lib/appnigma/generated/models/function_owner_one_of.rb
117
156
  - lib/appnigma/generated/models/function_owner_one_of1.rb
157
+ - lib/appnigma/generated/models/get_alerts_output.rb
158
+ - lib/appnigma/generated/models/get_connect_key_output.rb
118
159
  - lib/appnigma/generated/models/get_connection_input.rb
119
160
  - lib/appnigma/generated/models/get_connection_output.rb
120
161
  - lib/appnigma/generated/models/get_guide_output.rb
162
+ - lib/appnigma/generated/models/get_logic_go_live_status_input.rb
163
+ - lib/appnigma/generated/models/get_logic_go_live_status_output.rb
164
+ - lib/appnigma/generated/models/get_logic_input.rb
165
+ - lib/appnigma/generated/models/get_logic_output.rb
166
+ - lib/appnigma/generated/models/get_logic_output_file.rb
167
+ - lib/appnigma/generated/models/get_platform_input.rb
168
+ - lib/appnigma/generated/models/get_platform_output.rb
169
+ - lib/appnigma/generated/models/get_sync_output.rb
170
+ - lib/appnigma/generated/models/go_live_logic_input.rb
171
+ - lib/appnigma/generated/models/go_live_logic_output.rb
121
172
  - lib/appnigma/generated/models/json_value.rb
122
173
  - lib/appnigma/generated/models/list_actions_output.rb
123
174
  - lib/appnigma/generated/models/list_connections_output.rb
175
+ - lib/appnigma/generated/models/list_events_input.rb
176
+ - lib/appnigma/generated/models/list_events_output.rb
177
+ - lib/appnigma/generated/models/list_features_output.rb
178
+ - lib/appnigma/generated/models/list_features_output_features_inner.rb
124
179
  - lib/appnigma/generated/models/list_functions_output.rb
180
+ - lib/appnigma/generated/models/list_logic_input.rb
181
+ - lib/appnigma/generated/models/list_logic_output.rb
182
+ - lib/appnigma/generated/models/list_logic_runs_input.rb
183
+ - lib/appnigma/generated/models/list_logic_runs_output.rb
125
184
  - lib/appnigma/generated/models/list_platforms_output.rb
185
+ - lib/appnigma/generated/models/list_record_changes_input.rb
186
+ - lib/appnigma/generated/models/list_record_changes_output.rb
187
+ - lib/appnigma/generated/models/list_webhooks_output.rb
188
+ - lib/appnigma/generated/models/logic_check_problem.rb
126
189
  - lib/appnigma/generated/models/logic_conditional.rb
190
+ - lib/appnigma/generated/models/logic_draft.rb
191
+ - lib/appnigma/generated/models/logic_entry.rb
192
+ - lib/appnigma/generated/models/logic_entry_failure.rb
193
+ - lib/appnigma/generated/models/logic_folder_problem.rb
194
+ - lib/appnigma/generated/models/logic_run.rb
195
+ - lib/appnigma/generated/models/logic_test_call.rb
127
196
  - lib/appnigma/generated/models/platform_entry.rb
128
197
  - lib/appnigma/generated/models/platform_entry_coverage_inner.rb
129
198
  - lib/appnigma/generated/models/platform_request_input.rb
130
199
  - lib/appnigma/generated/models/platform_request_input_body.rb
131
200
  - lib/appnigma/generated/models/platform_request_output.rb
132
201
  - lib/appnigma/generated/models/ran_as.rb
202
+ - lib/appnigma/generated/models/record_change.rb
203
+ - lib/appnigma/generated/models/record_change_record.rb
133
204
  - lib/appnigma/generated/models/run_action_input.rb
134
205
  - lib/appnigma/generated/models/run_action_output.rb
135
206
  - lib/appnigma/generated/models/run_input.rb
@@ -138,13 +209,34 @@ files:
138
209
  - lib/appnigma/generated/models/sdk_error_error.rb
139
210
  - lib/appnigma/generated/models/sdk_error_error_details.rb
140
211
  - lib/appnigma/generated/models/sdk_problem.rb
212
+ - lib/appnigma/generated/models/set_alerts_input.rb
213
+ - lib/appnigma/generated/models/set_alerts_output.rb
214
+ - lib/appnigma/generated/models/set_sync_input.rb
215
+ - lib/appnigma/generated/models/set_sync_output.rb
216
+ - lib/appnigma/generated/models/switch_logic_off_input.rb
217
+ - lib/appnigma/generated/models/switch_logic_off_output.rb
218
+ - lib/appnigma/generated/models/switch_logic_on_input.rb
219
+ - lib/appnigma/generated/models/switch_logic_on_output.rb
220
+ - lib/appnigma/generated/models/sync_health.rb
221
+ - lib/appnigma/generated/models/test_logic_input.rb
222
+ - lib/appnigma/generated/models/test_logic_output.rb
223
+ - lib/appnigma/generated/models/test_logic_output_error.rb
224
+ - lib/appnigma/generated/models/update_logic_input.rb
225
+ - lib/appnigma/generated/models/update_logic_output.rb
141
226
  - lib/appnigma/generated/version.rb
227
+ - lib/appnigma/logic.rb
142
228
  - lib/appnigma/names.rb
143
229
  - lib/appnigma/platforms.rb
144
230
  - lib/appnigma/portal.rb
231
+ - lib/appnigma/records.rb
145
232
  - lib/appnigma/retry.rb
233
+ - lib/appnigma/schema_type.rb
234
+ - lib/appnigma/sync.rb
146
235
  - lib/appnigma/transport.rb
236
+ - lib/appnigma/types_printer.rb
237
+ - lib/appnigma/verify_webhook.rb
147
238
  - lib/appnigma/version.rb
239
+ - lib/appnigma/webhooks.rb
148
240
  homepage: https://docs.appnigma.ai/sdk
149
241
  licenses:
150
242
  - MIT