svix 1.60.1 → 1.61.1

data/svix.gemspec

@@ -19,11 +19,6 @@ Gem::Specification.new do |spec|
 
     Thank you for installing svix!
 
-    If you are using svix to send outgoing webhhooks, you should also install the `typhoeus` gem.
-    If you are only using svix to consume incoming webhooks, you do not need it.
-
-      gem 'typhoeus`
-
   MESSAGE
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -41,13 +36,9 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   ignored = Regexp.union(
-    /\A\.openapi-generator/,
     /\Aspec/,
     /\Apkg/,
-    /\Atemplates/,
     /\A.gitignore/,
-    /\A.openapi-generator-ignore/,
-    /\Aopenapi-generator-config.json/,
     /.gem\z/
   )
   spec.files = Dir['**/*'].reject {|f| !File.file?(f) || ignored.match(f) }
@@ -58,5 +49,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  spec.add_development_dependency 'webmock', '~> 3.25'
 end

data/templates/api_extra/application_create.rb

@@ -0,0 +1,16 @@
+def get_or_create(application_in, options = {})
+  options = options.transform_keys(&:to_s)
+  path = "/api/v1/app"
+  res = @client.execute_request(
+    "POST",
+    path,
+    query_params: {
+      "get_if_exists" => true
+    },
+    headers: {
+      "idempotency-key" => options["idempotency-key"]
+    },
+    body: application_in
+  )
+  ApplicationOut.deserialize(res)
+end

data/templates/api_extra/message.rb

@@ -0,0 +1,26 @@
+# Creates a [`MessageIn`] with a raw string payload.
+#
+# The payload is not normalized on the server. Normally, payloads are required
+# to be JSON, and Svix will minify the payload before sending the webhook
+# (for example, by removing extraneous whitespace or unnecessarily escaped
+# characters in strings). With this function, the payload will be sent
+# "as is", without any minification or other processing.
+#
+# `attributes[:payload]` must be a string. An extra attribute `content_type`
+# is accepted that sets the `content-type` header of the webhook sent by Svix,
+# overwriting the default of `application/json` if specified. Other than that,
+# the attributes are forwarded [`MessageIn.new`], so all the same ones are
+# accepted.
+def message_in_raw(attributes = {})
+  attributes[:transformations_params] ||= {}
+  attributes[:transformations_params][:rawPayload] = attributes[:payload]
+  attributes[:payload] = {}
+
+  content_type = attributes.delete(:content_type)
+  if content_type != nil
+    attributes[:transformations_params][:headers] ||= {}
+    attributes[:transformations_params][:headers][:"content-type"] = content_type
+  end
+
+  MessageIn.new(attributes)
+end

data/templates/api_resource.rb.jinja

@@ -0,0 +1,71 @@
+{% set resource_type_name = resource.name | to_upper_camel_case -%}
+# frozen_string_literal: true
+# This file is @generated
+
+require 'net/http'
+
+
+module Svix
+  {% if resource.name == "message" -%}
+  module_function
+    {% include "api_extra/message.rb" %}
+  {% endif -%}
+  class {{ resource_type_name }}
+    def initialize(client)
+      @client = client
+    end
+{% for op in resource.operations %}
+    {% set func_args -%}
+      {# path params -#}
+      {%- for p in op.path_params -%}
+      {{ p | to_snake_case }},
+      {%- endfor -%}
+      {# request body -#}
+      {%- if op.request_body_schema_name is defined -%}
+      {{ op.request_body_schema_name | to_snake_case }},
+      {%- endif -%}
+      {# header/query params -#}
+      {%- if op | has_query_or_header_params -%}
+      options = {}
+      {%- endif -%}
+    {% endset -%}
+
+    def {{ op.name | to_snake_case }}({{ func_args | strip_trailing_comma }})
+      {% if op | has_query_or_header_params -%}
+      options = options.transform_keys(&:to_s)
+      {% endif -%}
+      {% if op.response_body_schema_name is defined -%}res = {% endif -%}
+      @client.execute_request(
+        "{{ op.method | upper }}",
+        "{{ op.path | generate_ruby_path_str(op.path_params) }}",
+        {% if op.query_params | length >0 -%}
+        query_params:{
+          {% for p in op.query_params -%}
+            "{{ p.name }}" => options["{{ p.name }}"],
+          {% endfor -%}
+        },
+        {% endif -%}
+        {% if op.header_params | length >0 -%}
+        headers:{
+          {% for p in op.header_params -%}
+            "{{ p.name }}" => options["{{ p.name }}"],
+          {% endfor -%}
+        },
+        {% endif -%}
+        {% if op.request_body_schema_name is defined -%}
+        body: {{ op.request_body_schema_name | to_snake_case }},
+        {% endif -%}
+        )
+      {% if op.response_body_schema_name is defined -%}
+      {{ op.response_body_schema_name | to_upper_camel_case }}.deserialize res
+      {% endif %}
+    end
+
+    {% set extra_path -%}
+        api_extra/{{ resource.name | to_snake_case }}_{{ op.name | to_snake_case }}.rb
+    {%- endset -%}
+    {% include extra_path ignore missing %}
+
+{% endfor -%}
+  end
+end

data/templates/component_type.rb.jinja

@@ -0,0 +1,7 @@
+{% if type.kind == "struct" -%}
+    {% include "types/struct.rb.jinja" -%}
+{%- elif type.kind == "string_enum"-%}
+    {% include "types/string_enum.rb.jinja" -%}
+{%- elif type.kind == "integer_enum" -%}
+    {% include "types/integer_enum.rb.jinja" -%}
+{%- endif %}

data/templates/summary.rb.jinja

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# This file is @generated
+
+require "json"
+require "openssl"
+require "base64"
+require "uri"
+require "logger"
+
+{% macro require_api(resource) -%}
+  {% if resource.operations | length > 0 -%}
+require "svix/api/{{ resource.name | to_snake_case }}"
+  {% endif -%}
+{% endmacro -%}
+
+
+# API
+{% for resource in api.resources -%}
+{{ require_api(resource) -}}
+    {% for _resource_name, resource in resource.subresources | items -%}
+{{ require_api(resource) -}}
+    {% endfor -%}
+{% endfor -%}
+
+# Models
+{% for type in types -%}
+require "svix/models/{{ type | to_snake_case }}"
+{% endfor -%}
+
+# Core
+require "svix/api_error"
+require "svix/errors"
+require "svix/svix"
+require "svix/util"
+require "svix/version"
+require "svix/webhook"
+require "svix/http_error_out"
+require "svix/http_validation_error"
+require "svix/validation_error"
+require "svix/svix_http_client.rb"
+require "svix/internal"

data/templates/types/integer_enum.rb.jinja

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# This file is @generated
+{% set class_ty = type.name | to_upper_camel_case  -%}
+
+module Svix
+  {% if type.description is defined -%}
+  {{ type.description | to_doc_comment(style="ruby") | indent(4) }}
+  {% endif -%}
+  class {{ class_ty }}
+    {% for name, value in type.variants -%}
+    {{ name | to_upper_snake_case }} = {{ value }}.freeze
+    {% endfor %}
+    def self.all_vars
+      @all_vars ||= [
+        {%- for name, value in type.variants -%}
+        {{ name | to_upper_snake_case }},
+        {%- endfor -%}
+      ].freeze
+    end
+
+    def initialize(value)
+      unless {{ class_ty }}.all_vars.include?(value)
+        raise "Invalid ENUM value '#{value}' for class #{{ class_ty }}"
+      end
+      @value = value
+    end
+
+    def self.deserialize(value)
+      return value if {{ class_ty }}.all_vars.include?(value)
+      raise "Invalid ENUM value '#{value}' for class #{{ class_ty }}"
+    end
+
+    def serialize
+      @value
+    end
+  end
+end

data/templates/types/string_enum.rb.jinja

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# This file is @generated
+{% set class_ty = type.name | to_upper_camel_case  -%}
+
+module Svix
+  {% if type.description is defined -%}
+  {{ type.description | to_doc_comment(style="ruby") | indent(4) }}
+  {% endif -%}
+  class {{ class_ty }}
+    {% for value in type.values -%}
+    {{ value | to_upper_snake_case }} = "{{ value }}".freeze
+    {% endfor %}
+    def self.all_vars
+      @all_vars ||= [
+        {%- for value in type.values -%}
+        {{ value | to_upper_snake_case }},
+        {%- endfor -%}
+      ].freeze
+    end
+
+    def initialize(value)
+      unless {{ class_ty }}.all_vars.include?(value)
+        raise "Invalid ENUM value '#{value}' for class #{{ class_ty }}"
+      end
+      @value = value
+    end
+
+    def self.deserialize(value)
+      return value if {{ class_ty }}.all_vars.include?(value)
+      raise "Invalid ENUM value '#{value}' for class #{{ class_ty }}"
+    end
+
+    def serialize
+      @value
+    end
+  end
+end

data/templates/types/struct.rb.jinja

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+# This file is @generated
+{% set class_ty = type.name | to_upper_camel_case  -%}
+require 'json'
+
+module Svix
+  {% if type.description is defined -%}
+  {{ type.description | to_doc_comment(style="ruby") | indent(4) }}
+  {% endif -%}
+  class {{ class_ty }}
+    {% for field in type.fields -%}
+    attr_accessor :{{ field.name | to_snake_case }}
+    {% endfor %}
+    ALL_FIELD ||= [
+      {%- for f in type.fields -%}
+      "{{ f.name | to_snake_case }}"{% if not loop.last %},{% endif %}
+      {%- endfor -%}
+    ].freeze
+    private_constant :ALL_FIELD
+
+    def initialize(attributes = {})
+      unless attributes.is_a?(Hash)
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::{{ class_ty }}` new method"
+      end
+      attributes.each do |k, v|
+        unless ALL_FIELD.include? k.to_s
+          fail ArgumentError, "The field #{k} is not part of Svix::{{ class_ty }}"
+        end
+        instance_variable_set("@#{k}", v)
+        instance_variable_set("@__#{k}_is_defined", true)
+      end
+    end
+
+    def self.deserialize(attributes = {})
+      attributes = attributes.transform_keys(&:to_s)
+      attrs = Hash.new
+      {% for field in type.fields -%}
+        {% set val_expr %}attributes['{{ field.name }}']{% endset -%}
+        {% set not_nil_check = "" -%}
+        {% if not field.required -%}
+          {% set not_nil_check %}if {{ val_expr }}{% endset -%}
+        {% endif -%}
+
+        {% if (field.type.is_set() or  field.type.is_list()) and field.type.inner_type().is_schema_ref() -%}
+          {% set val_expr -%}
+              attributes['{{ field.name }}'].map { | v | Svix::{{ field.type.inner_type().to_ruby() }}.deserialize v } {{ not_nil_check }}
+          {%- endset -%}
+        {% elif field.type.is_schema_ref() -%}
+          {% set val_expr -%}
+              Svix::{{ field.type.to_ruby() }}.deserialize(attributes['{{ field.name }}']) {{ not_nil_check }}
+          {%- endset -%}
+        {% elif field.type.is_datetime() -%}
+          {% set val_expr %}DateTime.rfc3339({{ val_expr }}).to_time {{ not_nil_check }}{% endset -%}
+        {% endif -%}
+        attrs['{{ field.name | to_snake_case }}'] = {{ val_expr }}
+      {% endfor -%}
+      new attrs
+    end
+
+    def serialize
+      out = Hash.new
+      {% for field in type.fields -%}
+        {% set val_expr %}@{{ field.name | to_snake_case }}{% endset -%}
+
+        {% if (field.type.is_set() or  field.type.is_list()) and field.type.inner_type().is_schema_ref() -%}
+          {% set val_expr %}{{ val_expr }}.map { | v | v.serialize }{% endset -%}
+        {% elif field.type.is_schema_ref() -%}
+          {% set val_expr %}{{ val_expr }}.serialize{% endset -%}
+        {% else -%}
+          {% set val_expr %}Svix::serialize_primitive({{ val_expr }}){% endset -%}
+        {% endif -%}
+        {% if type.name is endingwith "Patch" and field.nullable -%}
+        out['{{ field.name }}'] = {{ val_expr }} if @__{{ field.name | to_snake_case }}_is_defined
+        {% else -%}
+        out['{{ field.name }}'] = {{ val_expr }} if @{{ field.name | to_snake_case }}
+        {% endif -%}
+      {% endfor -%}
+      out
+    end
+
+    # Serializes the object to a json string
+    # @return String
+    def to_json
+      JSON.dump(serialize)
+    end
+  end
+end