ngrok-api 0.9.0 → 0.16.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 (424) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +2 -2
  3. data/.yardopts +1 -0
  4. data/LICENSE +7 -0
  5. data/doc/NgrokAPI/Client.html +1469 -125
  6. data/doc/NgrokAPI/Error.html +3 -3
  7. data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
  8. data/doc/NgrokAPI/Errors.html +3 -3
  9. data/doc/NgrokAPI/HttpClient.html +66 -36
  10. data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
  11. data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
  12. data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
  13. data/doc/NgrokAPI/Models/AWSRole.html +543 -0
  14. data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
  15. data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
  16. data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
  17. data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
  18. data/doc/NgrokAPI/Models/Credential.html +1149 -0
  19. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
  20. data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
  21. data/doc/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
  22. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
  23. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
  24. data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
  25. data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
  26. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
  27. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
  28. data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
  29. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
  30. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
  31. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
  32. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
  33. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
  34. data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
  35. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
  36. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
  37. data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
  38. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
  39. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
  40. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
  41. data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
  42. data/doc/NgrokAPI/Models/EventSource.html +765 -0
  43. data/doc/NgrokAPI/Models/EventSourceList.html +617 -0
  44. data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
  45. data/doc/NgrokAPI/Models/EventStream.html +1309 -0
  46. data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
  47. data/doc/NgrokAPI/Models/EventTarget.html +765 -0
  48. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
  49. data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
  50. data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
  51. data/doc/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
  52. data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
  53. data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
  54. data/doc/NgrokAPI/Models/Listable.html +120 -52
  55. data/doc/NgrokAPI/Models/Ref.html +617 -0
  56. data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
  57. data/doc/NgrokAPI/Models/ReservedDomain.html +186 -1108
  58. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
  59. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
  60. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
  61. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
  62. data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
  63. data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
  64. data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
  65. data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
  66. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
  67. data/doc/NgrokAPI/Models/Tunnel.html +987 -0
  68. data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
  69. data/doc/NgrokAPI/Models.html +6 -6
  70. data/doc/NgrokAPI/PagedIterator.html +16 -12
  71. data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +404 -153
  72. data/doc/NgrokAPI/Services/AbuseReportsClient.html +706 -0
  73. data/doc/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
  74. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
  75. data/doc/NgrokAPI/Services/CredentialsClient.html +1644 -0
  76. data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
  77. data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
  78. data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
  79. data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
  80. data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
  81. data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
  82. data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
  83. data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
  84. data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
  85. data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
  86. data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
  87. data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
  88. data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
  89. data/doc/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
  90. data/doc/NgrokAPI/Services/EventSourcesClient.html +1532 -0
  91. data/doc/NgrokAPI/Services/EventStreamsClient.html +1792 -0
  92. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
  93. data/doc/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
  94. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
  95. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
  96. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
  97. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
  98. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
  99. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
  100. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
  101. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
  102. data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
  103. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
  104. data/doc/NgrokAPI/Services/TunnelsClient.html +669 -0
  105. data/doc/NgrokAPI/Services.html +6 -6
  106. data/doc/NgrokAPI.html +5 -5
  107. data/doc/README +94 -0
  108. data/doc/_index.html +621 -25
  109. data/doc/class_list.html +1 -1
  110. data/doc/file.README.html +55 -28
  111. data/doc/frames.html +1 -1
  112. data/doc/index.html +55 -28
  113. data/doc/method_list.html +7526 -286
  114. data/doc/top-level-namespace.html +3 -3
  115. data/docs/.gitkeep +0 -0
  116. data/docs/CNAME +1 -0
  117. data/docs/NgrokAPI/Client.html +1469 -125
  118. data/docs/NgrokAPI/Error.html +3 -3
  119. data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
  120. data/docs/NgrokAPI/Errors.html +3 -3
  121. data/docs/NgrokAPI/HttpClient.html +66 -36
  122. data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
  123. data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
  124. data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
  125. data/docs/NgrokAPI/Models/AWSRole.html +543 -0
  126. data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
  127. data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
  128. data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
  129. data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
  130. data/docs/NgrokAPI/Models/Credential.html +1149 -0
  131. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
  132. data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
  133. data/docs/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
  134. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
  135. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
  136. data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
  137. data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
  138. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
  139. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
  140. data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
  141. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
  142. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
  143. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
  144. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
  145. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
  146. data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
  147. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
  148. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
  149. data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
  150. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
  151. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
  152. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
  153. data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
  154. data/docs/NgrokAPI/Models/EventSource.html +765 -0
  155. data/docs/NgrokAPI/Models/EventSourceList.html +617 -0
  156. data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
  157. data/docs/NgrokAPI/Models/EventStream.html +1309 -0
  158. data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
  159. data/docs/NgrokAPI/Models/EventTarget.html +765 -0
  160. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
  161. data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
  162. data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
  163. data/docs/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
  164. data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
  165. data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
  166. data/docs/NgrokAPI/Models/Listable.html +120 -52
  167. data/docs/NgrokAPI/Models/Ref.html +617 -0
  168. data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
  169. data/docs/NgrokAPI/Models/ReservedDomain.html +186 -1108
  170. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
  171. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
  172. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
  173. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
  174. data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
  175. data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
  176. data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
  177. data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
  178. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
  179. data/docs/NgrokAPI/Models/Tunnel.html +987 -0
  180. data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
  181. data/docs/NgrokAPI/Models.html +6 -6
  182. data/docs/NgrokAPI/PagedIterator.html +16 -12
  183. data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +404 -153
  184. data/docs/NgrokAPI/Services/AbuseReportsClient.html +706 -0
  185. data/docs/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
  186. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
  187. data/docs/NgrokAPI/Services/CredentialsClient.html +1644 -0
  188. data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
  189. data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
  190. data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
  191. data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
  192. data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
  193. data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
  194. data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
  195. data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
  196. data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
  197. data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
  198. data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
  199. data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
  200. data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
  201. data/docs/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
  202. data/docs/NgrokAPI/Services/EventSourcesClient.html +1532 -0
  203. data/docs/NgrokAPI/Services/EventStreamsClient.html +1792 -0
  204. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
  205. data/docs/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
  206. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
  207. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
  208. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
  209. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
  210. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
  211. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
  212. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
  213. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
  214. data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
  215. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
  216. data/docs/NgrokAPI/Services/TunnelsClient.html +669 -0
  217. data/docs/NgrokAPI/Services.html +6 -6
  218. data/docs/NgrokAPI.html +5 -5
  219. data/docs/README +94 -0
  220. data/docs/_index.html +621 -25
  221. data/docs/class_list.html +1 -1
  222. data/docs/file.README.html +55 -28
  223. data/docs/frames.html +1 -1
  224. data/docs/index.html +55 -28
  225. data/docs/method_list.html +7526 -286
  226. data/docs/top-level-namespace.html +3 -3
  227. data/lib/ngrokapi/client.rb +229 -49
  228. data/lib/ngrokapi/http_client.rb +6 -7
  229. data/lib/ngrokapi/models/abuse_report.rb +37 -0
  230. data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
  231. data/lib/ngrokapi/models/agent_ingress.rb +66 -0
  232. data/lib/ngrokapi/models/api_key.rb +62 -64
  233. data/lib/ngrokapi/models/aws_auth.rb +27 -0
  234. data/lib/ngrokapi/models/aws_credentials.rb +27 -0
  235. data/lib/ngrokapi/models/aws_role.rb +25 -0
  236. data/lib/ngrokapi/models/certificate_authority.rb +72 -0
  237. data/lib/ngrokapi/models/credential.rb +67 -0
  238. data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
  239. data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
  240. data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
  241. data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
  242. data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
  243. data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
  244. data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
  245. data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
  246. data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
  247. data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
  248. data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
  249. data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
  250. data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
  251. data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
  252. data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
  253. data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
  254. data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
  255. data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
  256. data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
  257. data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
  258. data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
  259. data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
  260. data/lib/ngrokapi/models/event_destination.rb +49 -0
  261. data/lib/ngrokapi/models/event_source.rb +31 -0
  262. data/lib/ngrokapi/models/event_source_list.rb +27 -0
  263. data/lib/ngrokapi/models/event_source_replace.rb +29 -0
  264. data/lib/ngrokapi/models/event_stream.rb +77 -0
  265. data/lib/ngrokapi/models/event_subscription.rb +47 -0
  266. data/lib/ngrokapi/models/event_target.rb +31 -0
  267. data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
  268. data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
  269. data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
  270. data/lib/ngrokapi/models/ip_policy.rb +64 -0
  271. data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
  272. data/lib/ngrokapi/models/ip_restriction.rb +49 -0
  273. data/lib/ngrokapi/models/listable.rb +13 -2
  274. data/lib/ngrokapi/models/ref.rb +27 -0
  275. data/lib/ngrokapi/models/reserved_addr.rb +49 -0
  276. data/lib/ngrokapi/models/reserved_domain.rb +61 -211
  277. data/lib/ngrokapi/models/reserved_domain_cert_job.rb +31 -0
  278. data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
  279. data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
  280. data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
  281. data/lib/ngrokapi/models/ssh_credential.rb +67 -0
  282. data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
  283. data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
  284. data/lib/ngrokapi/models/tls_certificate.rb +92 -62
  285. data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
  286. data/lib/ngrokapi/models/tunnel.rb +37 -0
  287. data/lib/ngrokapi/models/tunnel_session.rb +43 -0
  288. data/lib/ngrokapi/paged_iterator.rb +4 -2
  289. data/lib/ngrokapi/services/.gitkeep +0 -0
  290. data/lib/ngrokapi/services/abuse_reports_client.rb +77 -0
  291. data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
  292. data/lib/ngrokapi/services/api_keys_client.rb +210 -144
  293. data/lib/ngrokapi/services/certificate_authorities_client.rb +211 -0
  294. data/lib/ngrokapi/services/credentials_client.rb +217 -0
  295. data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +108 -0
  296. data/lib/ngrokapi/services/endpoint_compression_module_client.rb +108 -0
  297. data/lib/ngrokapi/services/endpoint_configurations_client.rb +289 -313
  298. data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +108 -0
  299. data/lib/ngrokapi/services/endpoint_logging_module_client.rb +108 -0
  300. data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +108 -0
  301. data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +108 -0
  302. data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +108 -0
  303. data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +108 -0
  304. data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +108 -0
  305. data/lib/ngrokapi/services/endpoint_saml_module_client.rb +108 -0
  306. data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +108 -0
  307. data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +108 -0
  308. data/lib/ngrokapi/services/event_destinations_client.rb +221 -0
  309. data/lib/ngrokapi/services/event_sources_client.rb +185 -0
  310. data/lib/ngrokapi/services/event_streams_client.rb +224 -0
  311. data/lib/ngrokapi/services/event_subscriptions_client.rb +215 -0
  312. data/lib/ngrokapi/services/ip_policies_client.rb +215 -0
  313. data/lib/ngrokapi/services/ip_policy_rules_client.rb +214 -0
  314. data/lib/ngrokapi/services/ip_restrictions_client.rb +224 -0
  315. data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
  316. data/lib/ngrokapi/services/reserved_domains_client.rb +360 -313
  317. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +212 -0
  318. data/lib/ngrokapi/services/ssh_credentials_client.rb +215 -0
  319. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +217 -0
  320. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +221 -0
  321. data/lib/ngrokapi/services/tls_certificates_client.rb +213 -161
  322. data/lib/ngrokapi/services/tunnel_sessions_client.rb +237 -0
  323. data/lib/ngrokapi/services/tunnels_client.rb +78 -0
  324. data/lib/ngrokapi/version.rb +1 -1
  325. data/lib/ngrokapi.rb +1 -1
  326. data/ngrok-api.gemspec +1 -1
  327. data/spec/ngrokapi/client_spec.rb +158 -33
  328. data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
  329. data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
  330. data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
  331. data/spec/ngrokapi/models/api_key_spec.rb +42 -43
  332. data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
  333. data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
  334. data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
  335. data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
  336. data/spec/ngrokapi/models/credential_spec.rb +45 -0
  337. data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
  338. data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
  339. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
  340. data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
  341. data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
  342. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
  343. data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
  344. data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
  345. data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
  346. data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
  347. data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
  348. data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
  349. data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
  350. data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
  351. data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
  352. data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
  353. data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
  354. data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
  355. data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
  356. data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
  357. data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
  358. data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
  359. data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
  360. data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
  361. data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
  362. data/spec/ngrokapi/models/event_source_spec.rb +21 -0
  363. data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
  364. data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
  365. data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
  366. data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
  367. data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
  368. data/spec/ngrokapi/models/event_target_spec.rb +21 -0
  369. data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
  370. data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
  371. data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
  372. data/spec/ngrokapi/models/listable_spec.rb +4 -4
  373. data/spec/ngrokapi/models/ref_spec.rb +21 -0
  374. data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
  375. data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
  376. data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
  377. data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
  378. data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
  379. data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
  380. data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
  381. data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
  382. data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
  383. data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
  384. data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
  385. data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
  386. data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
  387. data/spec/ngrokapi/paged_iterator_spec.rb +7 -7
  388. data/spec/ngrokapi/services/.gitkeep +0 -0
  389. data/spec/ngrokapi/services/abuse_reports_client_spec.rb +65 -0
  390. data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +159 -0
  391. data/spec/ngrokapi/services/api_keys_client_spec.rb +157 -127
  392. data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +159 -0
  393. data/spec/ngrokapi/services/credentials_client_spec.rb +163 -0
  394. data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +125 -0
  395. data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +125 -0
  396. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +237 -0
  397. data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +125 -0
  398. data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +125 -0
  399. data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +125 -0
  400. data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +125 -0
  401. data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +125 -0
  402. data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +125 -0
  403. data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +125 -0
  404. data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +125 -0
  405. data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +125 -0
  406. data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +125 -0
  407. data/spec/ngrokapi/services/event_destinations_client_spec.rb +172 -0
  408. data/spec/ngrokapi/services/event_sources_client_spec.rb +192 -0
  409. data/spec/ngrokapi/services/event_streams_client_spec.rb +177 -0
  410. data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +169 -0
  411. data/spec/ngrokapi/services/ip_policies_client_spec.rb +159 -0
  412. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +165 -0
  413. data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +171 -0
  414. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +206 -0
  415. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +349 -0
  416. data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +163 -0
  417. data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +165 -0
  418. data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +167 -0
  419. data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +171 -0
  420. data/spec/ngrokapi/services/tls_certificates_client_spec.rb +161 -0
  421. data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +183 -0
  422. data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
  423. data/spec/spec_helper.rb +1096 -80
  424. metadata +360 -11
@@ -0,0 +1,169 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Services::EventSubscriptionsClient do
4
+ let(:base_url) { 'https://api.ngrok.com' }
5
+ let(:path) { '/event_subscriptions' }
6
+ let(:not_found) do
7
+ NgrokAPI::Errors::NotFoundError.new(response: event_subscription_result)
8
+ end
9
+
10
+ before(:each) do
11
+ @client = class_double("HttpClient")
12
+ @event_subscriptions_client = NgrokAPI::Services::EventSubscriptionsClient.new(client: @client)
13
+ end
14
+
15
+ describe "#create" do
16
+ it "will make a post request and return an instance of NgrokAPI::Models::EventSubscription" do
17
+ path = '/event_subscriptions'
18
+ replacements = {
19
+ }
20
+ data = {}
21
+ data[:metadata] = "New metadata"
22
+ data[:description] = "New description"
23
+ data[:sources] = "New sources"
24
+ data[:destination_ids] = "New destination_ids"
25
+ expect(@client).to receive(:post).with(path % replacements, data: data).
26
+ and_return(event_subscription_result)
27
+ result = @event_subscriptions_client.create(
28
+ metadata: "New metadata",
29
+ description: "New description",
30
+ sources: "New sources",
31
+ destination_ids: "New destination_ids"
32
+ )
33
+ expect(result.class).to eq(NgrokAPI::Models::EventSubscription)
34
+ end
35
+ end
36
+
37
+ describe "#delete" do
38
+ it "will make a delete request" do
39
+ path = '/event_subscriptions/%{id}'
40
+ replacements = {
41
+ id: api_key_result["id"],
42
+ }
43
+ expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
44
+ @event_subscriptions_client.delete(
45
+ id: api_key_result["id"]
46
+ )
47
+ end
48
+ end
49
+
50
+ describe "#delete!" do
51
+ it "will make a delete request" do
52
+ path = '/event_subscriptions/%{id}'
53
+ replacements = {
54
+ id: api_key_result["id"],
55
+ }
56
+ expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
57
+ @event_subscriptions_client.delete!(
58
+ id: api_key_result["id"]
59
+ )
60
+ end
61
+
62
+ it "will make a delete request and return NotFoundError if 404" do
63
+ path = '/event_subscriptions/%{id}'
64
+ replacements = {
65
+ id: api_key_result["id"],
66
+ }
67
+ expect do
68
+ expect(@client).to receive(:delete).with(path % replacements, danger: true).
69
+ and_raise(NgrokAPI::Errors::NotFoundError)
70
+ result = @event_subscriptions_client.delete!(
71
+ id: api_key_result["id"]
72
+ )
73
+ expect(result).to be nil
74
+ end.to raise_error(NgrokAPI::Errors::NotFoundError)
75
+ end
76
+ end
77
+
78
+ describe "#get" do
79
+ it "will make a get request and return an instance of NgrokAPI::Models::EventSubscription" do
80
+ path = '/event_subscriptions/%{id}'
81
+ replacements = {
82
+ id: event_subscription_result["id"],
83
+ }
84
+ data = {}
85
+ expect(@client).to receive(:get).with(path % replacements, data: data).
86
+ and_return(event_subscription_result)
87
+ result = @event_subscriptions_client.get(
88
+ id: event_subscription_result["id"]
89
+ )
90
+ expect(result.class).to eq(NgrokAPI::Models::EventSubscription)
91
+ end
92
+ end
93
+
94
+ describe "#get!" do
95
+ it "will make a get request and return an instance of NgrokAPI::Models::EventSubscription" do
96
+ path = '/event_subscriptions/%{id}'
97
+ replacements = {
98
+ id: event_subscription_result["id"],
99
+ }
100
+ data = {}
101
+ expect(@client).to receive(:get).with(path % replacements, data: data).
102
+ and_return(event_subscription_result)
103
+ result = @event_subscriptions_client.get(
104
+ id: event_subscription_result["id"]
105
+ )
106
+ expect(result.class).to eq(NgrokAPI::Models::EventSubscription)
107
+ # expect(result.id).to eq(event_subscription_result["id"])
108
+ end
109
+ end
110
+
111
+ describe "#list" do
112
+ it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
113
+ expect(@client).to receive(:list).
114
+ and_return(event_subscription_results)
115
+ url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
116
+ result = @event_subscriptions_client.list(url: url)
117
+ expect(result.class).to eq(NgrokAPI::Models::Listable)
118
+ end
119
+ end
120
+
121
+ describe "#update" do
122
+ it "will make a patch request and return an instance of NgrokAPI::Models::EventSubscription" do
123
+ path = '/event_subscriptions/%{id}'
124
+ replacements = {
125
+ id: event_subscription_result["id"],
126
+ }
127
+ data = {}
128
+ data[:metadata] = "New metadata"
129
+ data[:description] = "New description"
130
+ data[:sources] = "New sources"
131
+ data[:destination_ids] = "New destination_ids"
132
+ expect(@client).to receive(:patch).with(path % replacements, data: data).
133
+ and_return(event_subscription_result)
134
+ result = @event_subscriptions_client.update(
135
+ id: event_subscription_result["id"],
136
+ metadata: "New metadata",
137
+ description: "New description",
138
+ sources: "New sources",
139
+ destination_ids: "New destination_ids"
140
+ )
141
+ expect(result.class).to eq(NgrokAPI::Models::EventSubscription)
142
+ end
143
+ end
144
+
145
+ describe "#update!" do
146
+ it "will make a patch request and return an instance of NgrokAPI::Models::EventSubscription" do
147
+ path = '/event_subscriptions/%{id}'
148
+ replacements = {
149
+ id: event_subscription_result["id"],
150
+ }
151
+ data = {}
152
+ data[:metadata] = "New metadata"
153
+ data[:description] = "New description"
154
+ data[:sources] = "New sources"
155
+ data[:destination_ids] = "New destination_ids"
156
+ expect(@client).to receive(:patch).with(path % replacements, data: data).
157
+ and_return(event_subscription_result)
158
+ result = @event_subscriptions_client.update(
159
+ id: event_subscription_result["id"],
160
+ metadata: "New metadata",
161
+ description: "New description",
162
+ sources: "New sources",
163
+ destination_ids: "New destination_ids"
164
+ )
165
+ expect(result.class).to eq(NgrokAPI::Models::EventSubscription)
166
+ # expect(result.id).to eq(event_subscription_result["id"])
167
+ end
168
+ end
169
+ end
@@ -0,0 +1,159 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Services::IPPoliciesClient do
4
+ let(:base_url) { 'https://api.ngrok.com' }
5
+ let(:path) { '/ip_policies' }
6
+ let(:not_found) do
7
+ NgrokAPI::Errors::NotFoundError.new(response: ip_policy_result)
8
+ end
9
+
10
+ before(:each) do
11
+ @client = class_double("HttpClient")
12
+ @ip_policies_client = NgrokAPI::Services::IPPoliciesClient.new(client: @client)
13
+ end
14
+
15
+ describe "#create" do
16
+ it "will make a post request and return an instance of NgrokAPI::Models::IPPolicy" do
17
+ path = '/ip_policies'
18
+ replacements = {
19
+ }
20
+ data = {}
21
+ data[:description] = "New description"
22
+ data[:metadata] = "New metadata"
23
+ data[:action] = "New action"
24
+ expect(@client).to receive(:post).with(path % replacements, data: data).
25
+ and_return(ip_policy_result)
26
+ result = @ip_policies_client.create(
27
+ description: "New description",
28
+ metadata: "New metadata",
29
+ action: "New action"
30
+ )
31
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicy)
32
+ end
33
+ end
34
+
35
+ describe "#delete" do
36
+ it "will make a delete request" do
37
+ path = '/ip_policies/%{id}'
38
+ replacements = {
39
+ id: api_key_result["id"],
40
+ }
41
+ expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
42
+ @ip_policies_client.delete(
43
+ id: api_key_result["id"]
44
+ )
45
+ end
46
+ end
47
+
48
+ describe "#delete!" do
49
+ it "will make a delete request" do
50
+ path = '/ip_policies/%{id}'
51
+ replacements = {
52
+ id: api_key_result["id"],
53
+ }
54
+ expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
55
+ @ip_policies_client.delete!(
56
+ id: api_key_result["id"]
57
+ )
58
+ end
59
+
60
+ it "will make a delete request and return NotFoundError if 404" do
61
+ path = '/ip_policies/%{id}'
62
+ replacements = {
63
+ id: api_key_result["id"],
64
+ }
65
+ expect do
66
+ expect(@client).to receive(:delete).with(path % replacements, danger: true).
67
+ and_raise(NgrokAPI::Errors::NotFoundError)
68
+ result = @ip_policies_client.delete!(
69
+ id: api_key_result["id"]
70
+ )
71
+ expect(result).to be nil
72
+ end.to raise_error(NgrokAPI::Errors::NotFoundError)
73
+ end
74
+ end
75
+
76
+ describe "#get" do
77
+ it "will make a get request and return an instance of NgrokAPI::Models::IPPolicy" do
78
+ path = '/ip_policies/%{id}'
79
+ replacements = {
80
+ id: ip_policy_result["id"],
81
+ }
82
+ data = {}
83
+ expect(@client).to receive(:get).with(path % replacements, data: data).
84
+ and_return(ip_policy_result)
85
+ result = @ip_policies_client.get(
86
+ id: ip_policy_result["id"]
87
+ )
88
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicy)
89
+ end
90
+ end
91
+
92
+ describe "#get!" do
93
+ it "will make a get request and return an instance of NgrokAPI::Models::IPPolicy" do
94
+ path = '/ip_policies/%{id}'
95
+ replacements = {
96
+ id: ip_policy_result["id"],
97
+ }
98
+ data = {}
99
+ expect(@client).to receive(:get).with(path % replacements, data: data).
100
+ and_return(ip_policy_result)
101
+ result = @ip_policies_client.get(
102
+ id: ip_policy_result["id"]
103
+ )
104
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicy)
105
+ # expect(result.id).to eq(ip_policy_result["id"])
106
+ end
107
+ end
108
+
109
+ describe "#list" do
110
+ it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
111
+ expect(@client).to receive(:list).
112
+ and_return(ip_policy_results)
113
+ url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
114
+ result = @ip_policies_client.list(url: url)
115
+ expect(result.class).to eq(NgrokAPI::Models::Listable)
116
+ end
117
+ end
118
+
119
+ describe "#update" do
120
+ it "will make a patch request and return an instance of NgrokAPI::Models::IPPolicy" do
121
+ path = '/ip_policies/%{id}'
122
+ replacements = {
123
+ id: ip_policy_result["id"],
124
+ }
125
+ data = {}
126
+ data[:description] = "New description"
127
+ data[:metadata] = "New metadata"
128
+ expect(@client).to receive(:patch).with(path % replacements, data: data).
129
+ and_return(ip_policy_result)
130
+ result = @ip_policies_client.update(
131
+ id: ip_policy_result["id"],
132
+ description: "New description",
133
+ metadata: "New metadata"
134
+ )
135
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicy)
136
+ end
137
+ end
138
+
139
+ describe "#update!" do
140
+ it "will make a patch request and return an instance of NgrokAPI::Models::IPPolicy" do
141
+ path = '/ip_policies/%{id}'
142
+ replacements = {
143
+ id: ip_policy_result["id"],
144
+ }
145
+ data = {}
146
+ data[:description] = "New description"
147
+ data[:metadata] = "New metadata"
148
+ expect(@client).to receive(:patch).with(path % replacements, data: data).
149
+ and_return(ip_policy_result)
150
+ result = @ip_policies_client.update(
151
+ id: ip_policy_result["id"],
152
+ description: "New description",
153
+ metadata: "New metadata"
154
+ )
155
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicy)
156
+ # expect(result.id).to eq(ip_policy_result["id"])
157
+ end
158
+ end
159
+ end
@@ -0,0 +1,165 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Services::IPPolicyRulesClient do
4
+ let(:base_url) { 'https://api.ngrok.com' }
5
+ let(:path) { '/ip_policy_rules' }
6
+ let(:not_found) do
7
+ NgrokAPI::Errors::NotFoundError.new(response: ip_policy_rule_result)
8
+ end
9
+
10
+ before(:each) do
11
+ @client = class_double("HttpClient")
12
+ @ip_policy_rules_client = NgrokAPI::Services::IPPolicyRulesClient.new(client: @client)
13
+ end
14
+
15
+ describe "#create" do
16
+ it "will make a post request and return an instance of NgrokAPI::Models::IPPolicyRule" do
17
+ path = '/ip_policy_rules'
18
+ replacements = {
19
+ }
20
+ data = {}
21
+ data[:description] = "New description"
22
+ data[:metadata] = "New metadata"
23
+ data[:cidr] = "New cidr"
24
+ data[:ip_policy_id] = "New ip_policy_id"
25
+ expect(@client).to receive(:post).with(path % replacements, data: data).
26
+ and_return(ip_policy_rule_result)
27
+ result = @ip_policy_rules_client.create(
28
+ description: "New description",
29
+ metadata: "New metadata",
30
+ cidr: "New cidr",
31
+ ip_policy_id: "New ip_policy_id"
32
+ )
33
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicyRule)
34
+ end
35
+ end
36
+
37
+ describe "#delete" do
38
+ it "will make a delete request" do
39
+ path = '/ip_policy_rules/%{id}'
40
+ replacements = {
41
+ id: api_key_result["id"],
42
+ }
43
+ expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
44
+ @ip_policy_rules_client.delete(
45
+ id: api_key_result["id"]
46
+ )
47
+ end
48
+ end
49
+
50
+ describe "#delete!" do
51
+ it "will make a delete request" do
52
+ path = '/ip_policy_rules/%{id}'
53
+ replacements = {
54
+ id: api_key_result["id"],
55
+ }
56
+ expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
57
+ @ip_policy_rules_client.delete!(
58
+ id: api_key_result["id"]
59
+ )
60
+ end
61
+
62
+ it "will make a delete request and return NotFoundError if 404" do
63
+ path = '/ip_policy_rules/%{id}'
64
+ replacements = {
65
+ id: api_key_result["id"],
66
+ }
67
+ expect do
68
+ expect(@client).to receive(:delete).with(path % replacements, danger: true).
69
+ and_raise(NgrokAPI::Errors::NotFoundError)
70
+ result = @ip_policy_rules_client.delete!(
71
+ id: api_key_result["id"]
72
+ )
73
+ expect(result).to be nil
74
+ end.to raise_error(NgrokAPI::Errors::NotFoundError)
75
+ end
76
+ end
77
+
78
+ describe "#get" do
79
+ it "will make a get request and return an instance of NgrokAPI::Models::IPPolicyRule" do
80
+ path = '/ip_policy_rules/%{id}'
81
+ replacements = {
82
+ id: ip_policy_rule_result["id"],
83
+ }
84
+ data = {}
85
+ expect(@client).to receive(:get).with(path % replacements, data: data).
86
+ and_return(ip_policy_rule_result)
87
+ result = @ip_policy_rules_client.get(
88
+ id: ip_policy_rule_result["id"]
89
+ )
90
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicyRule)
91
+ end
92
+ end
93
+
94
+ describe "#get!" do
95
+ it "will make a get request and return an instance of NgrokAPI::Models::IPPolicyRule" do
96
+ path = '/ip_policy_rules/%{id}'
97
+ replacements = {
98
+ id: ip_policy_rule_result["id"],
99
+ }
100
+ data = {}
101
+ expect(@client).to receive(:get).with(path % replacements, data: data).
102
+ and_return(ip_policy_rule_result)
103
+ result = @ip_policy_rules_client.get(
104
+ id: ip_policy_rule_result["id"]
105
+ )
106
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicyRule)
107
+ # expect(result.id).to eq(ip_policy_rule_result["id"])
108
+ end
109
+ end
110
+
111
+ describe "#list" do
112
+ it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
113
+ expect(@client).to receive(:list).
114
+ and_return(ip_policy_rule_results)
115
+ url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
116
+ result = @ip_policy_rules_client.list(url: url)
117
+ expect(result.class).to eq(NgrokAPI::Models::Listable)
118
+ end
119
+ end
120
+
121
+ describe "#update" do
122
+ it "will make a patch request and return an instance of NgrokAPI::Models::IPPolicyRule" do
123
+ path = '/ip_policy_rules/%{id}'
124
+ replacements = {
125
+ id: ip_policy_rule_result["id"],
126
+ }
127
+ data = {}
128
+ data[:description] = "New description"
129
+ data[:metadata] = "New metadata"
130
+ data[:cidr] = "New cidr"
131
+ expect(@client).to receive(:patch).with(path % replacements, data: data).
132
+ and_return(ip_policy_rule_result)
133
+ result = @ip_policy_rules_client.update(
134
+ id: ip_policy_rule_result["id"],
135
+ description: "New description",
136
+ metadata: "New metadata",
137
+ cidr: "New cidr"
138
+ )
139
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicyRule)
140
+ end
141
+ end
142
+
143
+ describe "#update!" do
144
+ it "will make a patch request and return an instance of NgrokAPI::Models::IPPolicyRule" do
145
+ path = '/ip_policy_rules/%{id}'
146
+ replacements = {
147
+ id: ip_policy_rule_result["id"],
148
+ }
149
+ data = {}
150
+ data[:description] = "New description"
151
+ data[:metadata] = "New metadata"
152
+ data[:cidr] = "New cidr"
153
+ expect(@client).to receive(:patch).with(path % replacements, data: data).
154
+ and_return(ip_policy_rule_result)
155
+ result = @ip_policy_rules_client.update(
156
+ id: ip_policy_rule_result["id"],
157
+ description: "New description",
158
+ metadata: "New metadata",
159
+ cidr: "New cidr"
160
+ )
161
+ expect(result.class).to eq(NgrokAPI::Models::IPPolicyRule)
162
+ # expect(result.id).to eq(ip_policy_rule_result["id"])
163
+ end
164
+ end
165
+ end
@@ -0,0 +1,171 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Services::IPRestrictionsClient do
4
+ let(:base_url) { 'https://api.ngrok.com' }
5
+ let(:path) { '/ip_restrictions' }
6
+ let(:not_found) do
7
+ NgrokAPI::Errors::NotFoundError.new(response: ip_restriction_result)
8
+ end
9
+
10
+ before(:each) do
11
+ @client = class_double("HttpClient")
12
+ @ip_restrictions_client = NgrokAPI::Services::IPRestrictionsClient.new(client: @client)
13
+ end
14
+
15
+ describe "#create" do
16
+ it "will make a post request and return an instance of NgrokAPI::Models::IPRestriction" do
17
+ path = '/ip_restrictions'
18
+ replacements = {
19
+ }
20
+ data = {}
21
+ data[:description] = "New description"
22
+ data[:metadata] = "New metadata"
23
+ data[:enforced] = "New enforced"
24
+ data[:type] = "New type"
25
+ data[:ip_policy_ids] = "New ip_policy_ids"
26
+ expect(@client).to receive(:post).with(path % replacements, data: data).
27
+ and_return(ip_restriction_result)
28
+ result = @ip_restrictions_client.create(
29
+ description: "New description",
30
+ metadata: "New metadata",
31
+ enforced: "New enforced",
32
+ type: "New type",
33
+ ip_policy_ids: "New ip_policy_ids"
34
+ )
35
+ expect(result.class).to eq(NgrokAPI::Models::IPRestriction)
36
+ end
37
+ end
38
+
39
+ describe "#delete" do
40
+ it "will make a delete request" do
41
+ path = '/ip_restrictions/%{id}'
42
+ replacements = {
43
+ id: api_key_result["id"],
44
+ }
45
+ expect(@client).to receive(:delete).with(path % replacements).and_return(nil)
46
+ @ip_restrictions_client.delete(
47
+ id: api_key_result["id"]
48
+ )
49
+ end
50
+ end
51
+
52
+ describe "#delete!" do
53
+ it "will make a delete request" do
54
+ path = '/ip_restrictions/%{id}'
55
+ replacements = {
56
+ id: api_key_result["id"],
57
+ }
58
+ expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil)
59
+ @ip_restrictions_client.delete!(
60
+ id: api_key_result["id"]
61
+ )
62
+ end
63
+
64
+ it "will make a delete request and return NotFoundError if 404" do
65
+ path = '/ip_restrictions/%{id}'
66
+ replacements = {
67
+ id: api_key_result["id"],
68
+ }
69
+ expect do
70
+ expect(@client).to receive(:delete).with(path % replacements, danger: true).
71
+ and_raise(NgrokAPI::Errors::NotFoundError)
72
+ result = @ip_restrictions_client.delete!(
73
+ id: api_key_result["id"]
74
+ )
75
+ expect(result).to be nil
76
+ end.to raise_error(NgrokAPI::Errors::NotFoundError)
77
+ end
78
+ end
79
+
80
+ describe "#get" do
81
+ it "will make a get request and return an instance of NgrokAPI::Models::IPRestriction" do
82
+ path = '/ip_restrictions/%{id}'
83
+ replacements = {
84
+ id: ip_restriction_result["id"],
85
+ }
86
+ data = {}
87
+ expect(@client).to receive(:get).with(path % replacements, data: data).
88
+ and_return(ip_restriction_result)
89
+ result = @ip_restrictions_client.get(
90
+ id: ip_restriction_result["id"]
91
+ )
92
+ expect(result.class).to eq(NgrokAPI::Models::IPRestriction)
93
+ end
94
+ end
95
+
96
+ describe "#get!" do
97
+ it "will make a get request and return an instance of NgrokAPI::Models::IPRestriction" do
98
+ path = '/ip_restrictions/%{id}'
99
+ replacements = {
100
+ id: ip_restriction_result["id"],
101
+ }
102
+ data = {}
103
+ expect(@client).to receive(:get).with(path % replacements, data: data).
104
+ and_return(ip_restriction_result)
105
+ result = @ip_restrictions_client.get(
106
+ id: ip_restriction_result["id"]
107
+ )
108
+ expect(result.class).to eq(NgrokAPI::Models::IPRestriction)
109
+ # expect(result.id).to eq(ip_restriction_result["id"])
110
+ end
111
+ end
112
+
113
+ describe "#list" do
114
+ it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do
115
+ expect(@client).to receive(:list).
116
+ and_return(ip_restriction_results)
117
+ url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1"
118
+ result = @ip_restrictions_client.list(url: url)
119
+ expect(result.class).to eq(NgrokAPI::Models::Listable)
120
+ end
121
+ end
122
+
123
+ describe "#update" do
124
+ it "will make a patch request and return an instance of NgrokAPI::Models::IPRestriction" do
125
+ path = '/ip_restrictions/%{id}'
126
+ replacements = {
127
+ id: ip_restriction_result["id"],
128
+ }
129
+ data = {}
130
+ data[:description] = "New description"
131
+ data[:metadata] = "New metadata"
132
+ data[:enforced] = "New enforced"
133
+ data[:ip_policy_ids] = "New ip_policy_ids"
134
+ expect(@client).to receive(:patch).with(path % replacements, data: data).
135
+ and_return(ip_restriction_result)
136
+ result = @ip_restrictions_client.update(
137
+ id: ip_restriction_result["id"],
138
+ description: "New description",
139
+ metadata: "New metadata",
140
+ enforced: "New enforced",
141
+ ip_policy_ids: "New ip_policy_ids"
142
+ )
143
+ expect(result.class).to eq(NgrokAPI::Models::IPRestriction)
144
+ end
145
+ end
146
+
147
+ describe "#update!" do
148
+ it "will make a patch request and return an instance of NgrokAPI::Models::IPRestriction" do
149
+ path = '/ip_restrictions/%{id}'
150
+ replacements = {
151
+ id: ip_restriction_result["id"],
152
+ }
153
+ data = {}
154
+ data[:description] = "New description"
155
+ data[:metadata] = "New metadata"
156
+ data[:enforced] = "New enforced"
157
+ data[:ip_policy_ids] = "New ip_policy_ids"
158
+ expect(@client).to receive(:patch).with(path % replacements, data: data).
159
+ and_return(ip_restriction_result)
160
+ result = @ip_restrictions_client.update(
161
+ id: ip_restriction_result["id"],
162
+ description: "New description",
163
+ metadata: "New metadata",
164
+ enforced: "New enforced",
165
+ ip_policy_ids: "New ip_policy_ids"
166
+ )
167
+ expect(result.class).to eq(NgrokAPI::Models::IPRestriction)
168
+ # expect(result.id).to eq(ip_restriction_result["id"])
169
+ end
170
+ end
171
+ end