surge_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc8267ebb4682d2884a0ed0a4ff0c1ec89a6e76988ee96cbdd794bc9ee745ef2
-  data.tar.gz: fcefd6289c6dae43967d4eac94bbc87299ab03c52e335f611949a4d6169c7c79
+  metadata.gz: 3cdf5f24e69c710419d1609ebc934daaafd1be183603d3f364e6a3d4085fa9b9
+  data.tar.gz: 65ecd730b0df9e65ab06bd73a272bbff75e7f3b17c5136173ca26d48e92364bb
 SHA512:
-  metadata.gz: 22b712d8f2898bca0a102de847125c57cc1feb4771c23db55de558616b6dba9de87a1915e05e44c23ca619872f9a9d0f70df9c8f522e8f867048fd43a53cb660
-  data.tar.gz: '025923bb1e6f82ecbe04e30ee9f849369e8ddd76dd73f729dfe046220ffc044633cc7f1d15d286b6d37c2b5d6d641bae27e2cb558499e4c6271133997ba8444f'
+  metadata.gz: 40416443213907937c15359db9fd573680ec1c0d6038a727304b632125d1331e765d980e4617afe0d80b98db12a1d7405bb3cd84d9b9be2a416ccda6ec9f7857
+  data.tar.gz: 20d73f3c32f237a86513ed84416b0ac144ff35f7ccd722bf57e79aa3a4fe44ee2525f91d523f67cd8b1b4819dfe3c3a9fe4b0f2c17cc56b280e2fe9f681d5386

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.3.0 (2025-12-17)
+
+Full Changelog: [v0.2.1...v0.3.0](https://github.com/surgeapi/ruby-sdk/compare/v0.2.1...v0.3.0)
+
+### Features
+
+* **api:** add retrieve message endpoint ([55df346](https://github.com/surgeapi/ruby-sdk/commit/55df346f91c99fece77d130057afc55b021666c7))
+
+
+### Bug Fixes
+
+* better thread safety via early initializing SSL store during HTTP client creation ([0d14e5e](https://github.com/surgeapi/ruby-sdk/commit/0d14e5e73496e95743359c4c8dbab6da1c384a6e))
+* calling `break` out of streams should be instantaneous ([b43c7e5](https://github.com/surgeapi/ruby-sdk/commit/b43c7e54e9dfaaf31ffa0fe498c53fcc51bbb81c))
+
+
+### Chores
+
+* bump dependency version and update sorbet types ([e00a588](https://github.com/surgeapi/ruby-sdk/commit/e00a5886df58170099838c7a2b1ba25fe36588d6))
+* explicitly require "base64" gem ([a25ee53](https://github.com/surgeapi/ruby-sdk/commit/a25ee53f821df6c2d177b0e41c864e15e4b8bae9))
+* **internal:** codegen related update ([744a068](https://github.com/surgeapi/ruby-sdk/commit/744a0682fa04890d445106232878d0d5be7d7273))
+
 ## 0.2.1 (2025-10-31)
 
 Full Changelog: [v0.2.0...v0.2.1](https://github.com/surgeapi/ruby-sdk/compare/v0.2.0...v0.2.1)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "surge_api", "~> 0.2.1"
+gem "surge_api", "~> 0.3.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/surge_api/internal/transport/base_client.rb

@@ -201,7 +201,8 @@ module SurgeAPI
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ module SurgeAPI
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{SurgeAPI::VERSION}"
+
         # @api private
         #
         # @return [String]

data/lib/surge_api/internal/transport/pooled_net_requester.rb

@@ -16,10 +16,11 @@ module SurgeAPI
         class << self
           # @api private
           #
+          # @param cert_store [OpenSSL::X509::Store]
           # @param url [URI::Generic]
           #
           # @return [Net::HTTP]
-          def connect(url)
+          def connect(cert_store:, url:)
             port =
               case [url.port, url.scheme]
               in [Integer, _]
@@ -33,6 +34,8 @@ module SurgeAPI
             Net::HTTP.new(url.host, port).tap do
               _1.use_ssl = %w[https wss].include?(url.scheme)
               _1.max_retries = 0
+
+              (_1.cert_store = cert_store) if _1.use_ssl?
             end
           end
 
@@ -102,7 +105,7 @@ module SurgeAPI
           pool =
             @mutex.synchronize do
               @pools[origin] ||= ConnectionPool.new(size: @size) do
-                self.class.connect(url)
+                self.class.connect(cert_store: @cert_store, url: url)
               end
             end
 
@@ -150,17 +153,19 @@ module SurgeAPI
                   end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
-                  conn.request(req) do |rsp|
-                    y << [req, rsp]
-                    break if finished
-
-                    rsp.read_body do |bytes|
-                      y << bytes.force_encoding(Encoding::BINARY)
-                      break if finished
-
-                      self.class.calibrate_socket_timeout(conn, deadline)
+                  ::Kernel.catch(:jump) do
+                    conn.request(req) do |rsp|
+                      y << [req, rsp]
+                      ::Kernel.throw(:jump) if finished
+
+                      rsp.read_body do |bytes|
+                        y << bytes.force_encoding(Encoding::BINARY)
+                        ::Kernel.throw(:jump) if finished
+
+                        self.class.calibrate_socket_timeout(conn, deadline)
+                      end
+                      eof = true
                     end
-                    eof = true
                   end
                 end
               ensure
@@ -192,6 +197,7 @@ module SurgeAPI
         def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size
+          @cert_store = OpenSSL::X509::Store.new.tap(&:set_default_paths)
           @pools = {}
         end
 

data/lib/surge_api/internal/type/union.rb

@@ -17,6 +17,18 @@ module SurgeAPI
       #   else
       #     puts(unwrap_webhook_event)
       #   end
+      #
+      # @example
+      #   case unwrap_webhook_event
+      #   in {type: :"call.ended", account_id: account_id, data: data, timestamp: timestamp}
+      #     puts(account_id)
+      #   in {type: :"campaign.approved", account_id: account_id, data: data, timestamp: timestamp}
+      #     puts(data)
+      #   in {type: :"contact.opted_in", account_id: account_id, data: data, timestamp: timestamp}
+      #     puts(timestamp)
+      #   else
+      #     puts(unwrap_webhook_event)
+      #   end
       module Union
         include SurgeAPI::Internal::Type::Converter
         include SurgeAPI::Internal::Util::SorbetRuntimeSupport

data/lib/surge_api/models/message_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Messages#retrieve
+    class MessageRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/unwrap_webhook_event.rb

@@ -5,23 +5,25 @@ module SurgeAPI
     module UnwrapWebhookEvent
       extend SurgeAPI::Internal::Type::Union
 
-      variant -> { SurgeAPI::CallEndedWebhookEvent }
+      discriminator :type
 
-      variant -> { SurgeAPI::CampaignApprovedWebhookEvent }
+      variant :"call.ended", -> { SurgeAPI::CallEndedWebhookEvent }
 
-      variant -> { SurgeAPI::ContactOptedInWebhookEvent }
+      variant :"campaign.approved", -> { SurgeAPI::CampaignApprovedWebhookEvent }
 
-      variant -> { SurgeAPI::ContactOptedOutWebhookEvent }
+      variant :"contact.opted_in", -> { SurgeAPI::ContactOptedInWebhookEvent }
 
-      variant -> { SurgeAPI::ConversationCreatedWebhookEvent }
+      variant :"contact.opted_out", -> { SurgeAPI::ContactOptedOutWebhookEvent }
 
-      variant -> { SurgeAPI::MessageDeliveredWebhookEvent }
+      variant :"conversation.created", -> { SurgeAPI::ConversationCreatedWebhookEvent }
 
-      variant -> { SurgeAPI::MessageFailedWebhookEvent }
+      variant :"message.delivered", -> { SurgeAPI::MessageDeliveredWebhookEvent }
 
-      variant -> { SurgeAPI::MessageReceivedWebhookEvent }
+      variant :"message.failed", -> { SurgeAPI::MessageFailedWebhookEvent }
 
-      variant -> { SurgeAPI::MessageSentWebhookEvent }
+      variant :"message.received", -> { SurgeAPI::MessageReceivedWebhookEvent }
+
+      variant :"message.sent", -> { SurgeAPI::MessageSentWebhookEvent }
 
       # @!method self.variants
       #   @return [Array(SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent)]

data/lib/surge_api/models.rb

@@ -91,6 +91,8 @@ module SurgeAPI
 
   MessageReceivedWebhookEvent = SurgeAPI::Models::MessageReceivedWebhookEvent
 
+  MessageRetrieveParams = SurgeAPI::Models::MessageRetrieveParams
+
   MessageSentWebhookEvent = SurgeAPI::Models::MessageSentWebhookEvent
 
   Organization = SurgeAPI::Models::Organization

data/lib/surge_api/resources/messages.rb

@@ -59,6 +59,26 @@ module SurgeAPI
         )
       end
 
+      # Retrieves a Message object.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the message to retrieve.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::Message]
+      #
+      # @see SurgeAPI::Models::MessageRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["messages/%1$s", id],
+          model: SurgeAPI::Message,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [SurgeAPI::Client]

data/lib/surge_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SurgeAPI
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/surge_api.rb

@@ -3,12 +3,14 @@
 # Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
+require "base64"
 require "cgi"
 require "date"
 require "erb"
 require "etc"
 require "json"
 require "net/http"
+require "openssl"
 require "pathname"
 require "rbconfig"
 require "securerandom"
@@ -76,6 +78,7 @@ require_relative "surge_api/models/message_create_params"
 require_relative "surge_api/models/message_delivered_webhook_event"
 require_relative "surge_api/models/message_failed_webhook_event"
 require_relative "surge_api/models/message_received_webhook_event"
+require_relative "surge_api/models/message_retrieve_params"
 require_relative "surge_api/models/message_sent_webhook_event"
 require_relative "surge_api/models/organization"
 require_relative "surge_api/models/phone_number"

data/manifest.yaml

@@ -1,11 +1,13 @@
 dependencies:
   - English
+  - base64
   - cgi
   - date
   - erb
   - etc
   - json
   - net/http
+  - openssl
   - pathname
   - rbconfig
   - securerandom

data/rbi/surge_api/internal/transport/base_client.rbi

@@ -176,6 +176,11 @@ module SurgeAPI
         private def auth_headers
         end
 
+        # @api private
+        sig { returns(String) }
+        private def user_agent
+        end
+
         # @api private
         sig { returns(String) }
         private def generate_idempotency_key

data/rbi/surge_api/internal/transport/pooled_net_requester.rbi

@@ -26,8 +26,12 @@ module SurgeAPI
 
         class << self
           # @api private
-          sig { params(url: URI::Generic).returns(Net::HTTP) }
-          def connect(url)
+          sig do
+            params(cert_store: OpenSSL::X509::Store, url: URI::Generic).returns(
+              Net::HTTP
+            )
+          end
+          def connect(cert_store:, url:)
           end
 
           # @api private

data/rbi/surge_api/internal/type/base_model.rbi

@@ -31,7 +31,7 @@ module SurgeAPI
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
-          sig { params(child: T.self_type).void }
+          sig { params(child: SurgeAPI::Internal::Type::BaseModel).void }
           def inherited(child)
           end
 
@@ -274,9 +274,13 @@ module SurgeAPI
 
         # Create a new instance of a model.
         sig do
-          params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(
-            T.attached_class
-          )
+          params(
+            data:
+              T.any(
+                T::Hash[Symbol, T.anything],
+                SurgeAPI::Internal::Type::BaseModel
+              )
+          ).returns(T.attached_class)
         end
         def self.new(data = {})
         end

data/rbi/surge_api/models/message_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SurgeAPI
+  module Models
+    class MessageRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SurgeAPI::MessageRetrieveParams, SurgeAPI::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: SurgeAPI::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: SurgeAPI::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/surge_api/models.rbi

@@ -54,6 +54,8 @@ module SurgeAPI
 
   MessageReceivedWebhookEvent = SurgeAPI::Models::MessageReceivedWebhookEvent
 
+  MessageRetrieveParams = SurgeAPI::Models::MessageRetrieveParams
+
   MessageSentWebhookEvent = SurgeAPI::Models::MessageSentWebhookEvent
 
   Organization = SurgeAPI::Models::Organization

data/rbi/surge_api/resources/messages.rbi

@@ -46,6 +46,20 @@ module SurgeAPI
       )
       end
 
+      # Retrieves a Message object.
+      sig do
+        params(
+          id: String,
+          request_options: SurgeAPI::RequestOptions::OrHash
+        ).returns(SurgeAPI::Message)
+      end
+      def retrieve(
+        # The ID of the message to retrieve.
+        id,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: SurgeAPI::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/surge_api/internal/transport/base_client.rbs

@@ -87,6 +87,8 @@ module SurgeAPI
 
         private def auth_headers: -> ::Hash[String, String]
 
+        private def user_agent: -> String
+
         private def generate_idempotency_key: -> String
 
         private def build_request: (

data/sig/surge_api/internal/transport/pooled_net_requester.rbs

@@ -17,7 +17,10 @@ module SurgeAPI
 
         DEFAULT_MAX_CONNECTIONS: Integer
 
-        def self.connect: (URI::Generic url) -> top
+        def self.connect: (
+          cert_store: OpenSSL::X509::Store,
+          url: URI::Generic
+        ) -> top
 
         def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
 

data/sig/surge_api/models/message_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module SurgeAPI
+  module Models
+    type message_retrieve_params =
+      {  } & SurgeAPI::Internal::Type::request_parameters
+
+    class MessageRetrieveParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: SurgeAPI::request_opts) -> void
+
+      def to_hash: -> { request_options: SurgeAPI::RequestOptions }
+    end
+  end
+end

data/sig/surge_api/models.rbs

@@ -51,6 +51,8 @@ module SurgeAPI
 
   class MessageReceivedWebhookEvent = SurgeAPI::Models::MessageReceivedWebhookEvent
 
+  class MessageRetrieveParams = SurgeAPI::Models::MessageRetrieveParams
+
   class MessageSentWebhookEvent = SurgeAPI::Models::MessageSentWebhookEvent
 
   class Organization = SurgeAPI::Models::Organization

data/sig/surge_api/resources/messages.rbs

@@ -7,6 +7,11 @@ module SurgeAPI
         ?request_options: SurgeAPI::request_opts
       ) -> SurgeAPI::Message
 
+      def retrieve: (
+        String id,
+        ?request_options: SurgeAPI::request_opts
+      ) -> SurgeAPI::Message
+
       def initialize: (client: SurgeAPI::Client) -> void
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surge_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Surge
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-31 00:00:00.000000000 Z
+date: 2025-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -81,6 +81,7 @@ files:
 - lib/surge_api/models/message_failed_webhook_event.rb
 - lib/surge_api/models/message_params.rb
 - lib/surge_api/models/message_received_webhook_event.rb
+- lib/surge_api/models/message_retrieve_params.rb
 - lib/surge_api/models/message_sent_webhook_event.rb
 - lib/surge_api/models/organization.rb
 - lib/surge_api/models/phone_number.rb
@@ -154,6 +155,7 @@ files:
 - rbi/surge_api/models/message_failed_webhook_event.rbi
 - rbi/surge_api/models/message_params.rbi
 - rbi/surge_api/models/message_received_webhook_event.rbi
+- rbi/surge_api/models/message_retrieve_params.rbi
 - rbi/surge_api/models/message_sent_webhook_event.rbi
 - rbi/surge_api/models/organization.rbi
 - rbi/surge_api/models/phone_number.rbi
@@ -226,6 +228,7 @@ files:
 - sig/surge_api/models/message_failed_webhook_event.rbs
 - sig/surge_api/models/message_params.rbs
 - sig/surge_api/models/message_received_webhook_event.rbs
+- sig/surge_api/models/message_retrieve_params.rbs
 - sig/surge_api/models/message_sent_webhook_event.rbs
 - sig/surge_api/models/organization.rbs
 - sig/surge_api/models/phone_number.rbs