ngrok-api 0.18.0 → 0.19.0

data/lib/ngrokapi/models/ssh_host_certificate.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class SSHHostCertificate
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :created_at,
@@ -18,29 +18,33 @@ module NgrokAPI
         :valid_until,
         :certificate
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @public_key = @result['public_key']
-        @key_type = @result['key_type']
-        @ssh_certificate_authority_id = @result['ssh_certificate_authority_id']
-        @principals = @result['principals']
-        @valid_after = @result['valid_after']
-        @valid_until = @result['valid_until']
-        @certificate = @result['certificate']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @public_key = @attrs['public_key']
+        @key_type = @attrs['key_type']
+        @ssh_certificate_authority_id = @attrs['ssh_certificate_authority_id']
+        @principals = @attrs['principals']
+        @valid_after = @attrs['valid_after']
+        @valid_until = @attrs['valid_until']
+        @certificate = @attrs['certificate']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##

data/lib/ngrokapi/models/ssh_user_certificate.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class SSHUserCertificate
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :created_at,
@@ -20,31 +20,35 @@ module NgrokAPI
         :valid_until,
         :certificate
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @public_key = @result['public_key']
-        @key_type = @result['key_type']
-        @ssh_certificate_authority_id = @result['ssh_certificate_authority_id']
-        @principals = @result['principals']
-        @critical_options = @result['critical_options']
-        @extensions = @result['extensions']
-        @valid_after = @result['valid_after']
-        @valid_until = @result['valid_until']
-        @certificate = @result['certificate']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @public_key = @attrs['public_key']
+        @key_type = @attrs['key_type']
+        @ssh_certificate_authority_id = @attrs['ssh_certificate_authority_id']
+        @principals = @attrs['principals']
+        @critical_options = @attrs['critical_options']
+        @extensions = @attrs['extensions']
+        @valid_after = @attrs['valid_after']
+        @valid_until = @attrs['valid_until']
+        @certificate = @attrs['certificate']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##

data/lib/ngrokapi/models/tcp_edge.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class TCPEdge
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :description,
         :metadata,
@@ -14,25 +14,29 @@ module NgrokAPI
         :backend,
         :ip_restriction
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @created_at = @result['created_at']
-        @uri = @result['uri']
-        @hostports = @result['hostports']
-        @backend = @result['backend']
-        @ip_restriction = @result['ip_restriction']
+        @attrs = attrs
+        @id = @attrs['id']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @created_at = @attrs['created_at']
+        @uri = @attrs['uri']
+        @hostports = @attrs['hostports']
+        @backend = @attrs['backend']
+        @ip_restriction = @attrs['ip_restriction']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##

data/lib/ngrokapi/models/tls_certificate.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class TLSCertificate
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :created_at,
@@ -27,38 +27,42 @@ module NgrokAPI
         :subject_province,
         :subject_country
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @certificate_pem = @result['certificate_pem']
-        @subject_common_name = @result['subject_common_name']
-        @subject_alternative_names = @result['subject_alternative_names']
-        @issued_at = @result['issued_at']
-        @not_before = @result['not_before']
-        @not_after = @result['not_after']
-        @key_usages = @result['key_usages']
-        @extended_key_usages = @result['extended_key_usages']
-        @private_key_type = @result['private_key_type']
-        @issuer_common_name = @result['issuer_common_name']
-        @serial_number = @result['serial_number']
-        @subject_organization = @result['subject_organization']
-        @subject_organizational_unit = @result['subject_organizational_unit']
-        @subject_locality = @result['subject_locality']
-        @subject_province = @result['subject_province']
-        @subject_country = @result['subject_country']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @certificate_pem = @attrs['certificate_pem']
+        @subject_common_name = @attrs['subject_common_name']
+        @subject_alternative_names = @attrs['subject_alternative_names']
+        @issued_at = @attrs['issued_at']
+        @not_before = @attrs['not_before']
+        @not_after = @attrs['not_after']
+        @key_usages = @attrs['key_usages']
+        @extended_key_usages = @attrs['extended_key_usages']
+        @private_key_type = @attrs['private_key_type']
+        @issuer_common_name = @attrs['issuer_common_name']
+        @serial_number = @attrs['serial_number']
+        @subject_organization = @attrs['subject_organization']
+        @subject_organizational_unit = @attrs['subject_organizational_unit']
+        @subject_locality = @attrs['subject_locality']
+        @subject_province = @attrs['subject_province']
+        @subject_country = @attrs['subject_country']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##

data/lib/ngrokapi/models/tls_certificate_sa_ns.rb

@@ -4,23 +4,27 @@ module NgrokAPI
   module Models
     class TLSCertificateSANs
       attr_reader :client,
-        :result,
+        :attrs,
         :dns_names,
         :ips
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @dns_names = @result['dns_names']
-        @ips = @result['ips']
+        @attrs = attrs
+        @dns_names = @attrs['dns_names']
+        @ips = @attrs['ips']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/tls_edge.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class TLSEdge
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :description,
         :metadata,
@@ -16,27 +16,31 @@ module NgrokAPI
         :mutual_tls,
         :tls_termination
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @created_at = @result['created_at']
-        @uri = @result['uri']
-        @hostports = @result['hostports']
-        @backend = @result['backend']
-        @ip_restriction = @result['ip_restriction']
-        @mutual_tls = @result['mutual_tls']
-        @tls_termination = @result['tls_termination']
+        @attrs = attrs
+        @id = @attrs['id']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @created_at = @attrs['created_at']
+        @uri = @attrs['uri']
+        @hostports = @attrs['hostports']
+        @backend = @attrs['backend']
+        @ip_restriction = @attrs['ip_restriction']
+        @mutual_tls = @attrs['mutual_tls']
+        @tls_termination = @attrs['tls_termination']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##

data/lib/ngrokapi/models/tunnel.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class Tunnel
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :public_url,
         :started_at,
@@ -17,28 +17,32 @@ module NgrokAPI
         :backends,
         :forwards_to
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @public_url = @result['public_url']
-        @started_at = @result['started_at']
-        @metadata = @result['metadata']
-        @proto = @result['proto']
-        @region = @result['region']
-        @tunnel_session = @result['tunnel_session']
-        @endpoint = @result['endpoint']
-        @labels = @result['labels']
-        @backends = @result['backends']
-        @forwards_to = @result['forwards_to']
+        @attrs = attrs
+        @id = @attrs['id']
+        @public_url = @attrs['public_url']
+        @started_at = @attrs['started_at']
+        @metadata = @attrs['metadata']
+        @proto = @attrs['proto']
+        @region = @attrs['region']
+        @tunnel_session = @attrs['tunnel_session']
+        @endpoint = @attrs['endpoint']
+        @labels = @attrs['labels']
+        @backends = @attrs['backends']
+        @forwards_to = @attrs['forwards_to']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/tunnel_group_backend.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class TunnelGroupBackend
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :created_at,
@@ -13,28 +13,32 @@ module NgrokAPI
         :labels,
         :tunnels
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @labels = @result['labels']
-        @tunnels = @result['tunnels']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @labels = @attrs['labels']
+        @tunnels = @attrs['tunnels']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##
-      # Delete a TunnelGroup backend by ID. TODO what if used?
+      # Delete a TunnelGroup backend by ID.
       #
       # https://ngrok.com/docs/api#api-tunnel-group-backends-delete
       def delete

data/lib/ngrokapi/models/tunnel_session.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class TunnelSession
       attr_reader :client,
-        :result,
+        :attrs,
         :agent_version,
         :credential,
         :id,
@@ -16,27 +16,31 @@ module NgrokAPI
         :transport,
         :uri
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @agent_version = @result['agent_version']
-        @credential = @result['credential']
-        @id = @result['id']
-        @ip = @result['ip']
-        @metadata = @result['metadata']
-        @os = @result['os']
-        @region = @result['region']
-        @started_at = @result['started_at']
-        @transport = @result['transport']
-        @uri = @result['uri']
+        @attrs = attrs
+        @agent_version = @attrs['agent_version']
+        @credential = @attrs['credential']
+        @id = @attrs['id']
+        @ip = @attrs['ip']
+        @metadata = @attrs['metadata']
+        @os = @attrs['os']
+        @region = @attrs['region']
+        @started_at = @attrs['started_at']
+        @transport = @attrs['transport']
+        @uri = @attrs['uri']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
     end
   end

data/lib/ngrokapi/models/weighted_backend.rb

@@ -4,7 +4,7 @@ module NgrokAPI
   module Models
     class WeightedBackend
       attr_reader :client,
-        :result,
+        :attrs,
         :id,
         :uri,
         :created_at,
@@ -12,27 +12,31 @@ module NgrokAPI
         :metadata,
         :backends
 
-      def initialize(client:, result:)
+      def initialize(client: nil, attrs: {})
         @client = client
-        @result = result
-        @id = @result['id']
-        @uri = @result['uri']
-        @created_at = @result['created_at']
-        @description = @result['description']
-        @metadata = @result['metadata']
-        @backends = @result['backends']
+        @attrs = attrs
+        @id = @attrs['id']
+        @uri = @attrs['uri']
+        @created_at = @attrs['created_at']
+        @description = @attrs['description']
+        @metadata = @attrs['metadata']
+        @backends = @attrs['backends']
       end
 
       def ==(other)
-        @result == other.result
+        @attrs == other.attrs
       end
 
       def to_s
-        @result.to_s
+        @attrs.to_s
+      end
+
+      def to_h
+        @attrs.to_h
       end
 
       ##
-      # Delete a Weighted backend by ID. TODO what if used?
+      # Delete a Weighted backend by ID.
       #
       # https://ngrok.com/docs/api#api-weighted-backends-delete
       def delete

data/lib/ngrokapi/paged_iterator.rb

@@ -26,7 +26,7 @@ module NgrokAPI
     #
     # @return [object] Returns an instance of a class.
     def get_next
-      item = @page.result[@list_property][@n]
+      item = @page.attrs[@list_property][@n]
       raise "None" if item.nil?
       self.n += 1
       item

data/lib/ngrokapi/services/abuse_reports_client.rb

@@ -35,7 +35,29 @@ module NgrokAPI
         data[:urls] = urls if urls
         data[:metadata] = metadata if metadata
         result = @client.post(path % replacements, data: data)
-        NgrokAPI::Models::AbuseReport.new(client: self, result: result)
+        NgrokAPI::Models::AbuseReport.new(client: self, attrs: result)
+      end
+
+      ##
+      # Creates a new abuse report which will be reviewed by our system and abuse
+      # response team. This API is only available to authorized accounts. Contact
+      # abuse@ngrok.com to request access
+      # Throws an exception if API error.
+      #
+      # @param [List<uri (string)>] urls a list of URLs containing suspected abusive content
+      # @param [string] metadata arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
+      # @return [NgrokAPI::Models::AbuseReport] result from the API request
+      #
+      # https://ngrok.com/docs/api#api-abuse-reports-create
+      def create!(urls:, metadata: "")
+        path = '/abuse_reports'
+        replacements = {
+        }
+        data = {}
+        data[:urls] = urls if urls
+        data[:metadata] = metadata if metadata
+        result = @client.post(path % replacements, data: data, danger: true)
+        NgrokAPI::Models::AbuseReport.new(client: self, attrs: result)
       end
 
       ##
@@ -52,7 +74,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data)
-        NgrokAPI::Models::AbuseReport.new(client: self, result: result)
+        NgrokAPI::Models::AbuseReport.new(client: self, attrs: result)
       end
 
       ##
@@ -70,7 +92,7 @@ module NgrokAPI
         }
         data = {}
         result = @client.get(path % replacements, data: data, danger: true)
-        NgrokAPI::Models::AbuseReport.new(client: self, result: result)
+        NgrokAPI::Models::AbuseReport.new(client: self, attrs: result)
       end
     end
   end