kit-rb 0.4.0 → 0.5.0

data/sig/kit-rb.rbs

@@ -168,6 +168,40 @@ module Kit
     def call: (String current_access_token) -> String?
   end
 
+  # ActiveSupport::Notifications-compatible: `instrument(name, payload) { }`.
+  interface _Instrumenter
+    def instrument: (String name, Hash[Symbol, untyped] payload) { (Hash[Symbol, untyped]) -> untyped } -> untyped
+  end
+
+  # Anything with a Logger-like #debug (block or message form).
+  interface _Logger
+    def debug: (?untyped message) ?{ () -> untyped } -> untyped
+  end
+
+  module Instrumentation
+    EVENT: String
+    def self.around: (_Instrumenter? instrumenter, Symbol method, String path, Integer retries) { () -> [Integer, untyped] } -> [Integer, untyped]
+    def self.new_payload: (Symbol method, String path, Integer retries) -> Hash[Symbol, untyped]
+    def self.record_error: (Hash[Symbol, untyped] payload, Error error) -> void
+    def self.build: (?instrumenter: _Instrumenter?, ?logger: _Logger?) -> _Instrumenter?
+
+    class LoggerInstrumenter
+      def initialize: (_Logger logger) -> void
+      def instrument: (String name, Hash[Symbol, untyped] payload) { (Hash[Symbol, untyped]) -> untyped } -> untyped
+    end
+
+    class Multi
+      def initialize: (Array[_Instrumenter] instrumenters) -> void
+      def instrument: (String name, Hash[Symbol, untyped] payload) { (Hash[Symbol, untyped]) -> untyped } -> untyped
+    end
+  end
+
+  module TagNames
+    def self.normalize: (untyped name) -> String
+    def self.key: (untyped name) -> String
+    def self.distinct: (untyped names) -> Array[String]
+  end
+
   class Configuration
     attr_reader auth: (Auth::ApiKey | Auth::OAuth)
     attr_reader base_url: String
@@ -178,7 +212,8 @@ module Kit
     attr_reader retry_backoff: Float
     attr_reader max_backoff: Numeric
     attr_reader renew: _Renewer?
-    def initialize: (?api_key: String?, ?access_token: String?, ?base_url: String, ?open_timeout: Integer, ?read_timeout: Integer, ?write_timeout: Integer, ?max_retries: Integer, ?retry_backoff: Float, ?max_backoff: Numeric, ?renew: _Renewer?) -> void
+    attr_reader instrumenter: _Instrumenter?
+    def initialize: (?api_key: String?, ?access_token: String?, ?base_url: String, ?open_timeout: Integer, ?read_timeout: Integer, ?write_timeout: Integer, ?max_retries: Integer, ?retry_backoff: Float, ?max_backoff: Numeric, ?renew: _Renewer?, ?instrumenter: _Instrumenter?, ?logger: _Logger?) -> void
   end
 
   class Connection
@@ -671,7 +706,7 @@ module Kit
 
   class Client
     attr_reader config: Configuration
-    def initialize: (?api_key: String?, ?access_token: String?, ?base_url: String, ?open_timeout: Integer, ?read_timeout: Integer, ?write_timeout: Integer, ?max_retries: Integer, ?retry_backoff: Float, ?max_backoff: Numeric, ?renew: _Renewer?) -> void
+    def initialize: (?api_key: String?, ?access_token: String?, ?base_url: String, ?open_timeout: Integer, ?read_timeout: Integer, ?write_timeout: Integer, ?max_retries: Integer, ?retry_backoff: Float, ?max_backoff: Numeric, ?renew: _Renewer?, ?instrumenter: _Instrumenter?, ?logger: _Logger?) -> void
     def account: () -> Resources::Account
     def subscribers: () -> Resources::Subscribers
     attr_reader tags: Resources::Tags
@@ -689,3 +724,91 @@ module Kit
     def bulk: () -> Resources::Bulk
   end
 end
+
+module Kit
+  # require "kit/testing" — consumer test support (not loaded by kit-rb).
+  module Testing
+    OPERATIONS: Hash[Symbol, [Symbol, String]]
+    OBJECTS: Hash[Symbol, Symbol]
+    FIXTURES_PATH: String
+    FIXTURES: Hash[String, Hash[String, untyped]]
+    KNOWN_FIELDS: Hash[String, Set[String]]
+
+    module Fixtures
+      PATH: String
+      ALL: Hash[String, Hash[String, untyped]]
+      KNOWN_FIELDS: Hash[String, Set[String]]
+      def self.for: (Symbol | String operation) -> Hash[String, untyped]
+      def self.status_for: (Hash[String, untyped] fixture, (Integer | String)? status) -> String
+      def self.merge_fields: (String type, Hash[String, untyped] example, Hash[Symbol | String, untyped] overrides) -> Hash[String, untyped]
+      def self.deep_dup: (untyped value) -> untyped
+      def self.deep_freeze: (untyped value) -> untyped
+    end
+
+    def self.response: (Symbol | String operation, ?http_status: (Integer | String)?, **untyped overrides) -> untyped
+    def self.attributes: (Symbol | String operation, **untyped overrides) -> Hash[String, untyped]
+    PAGINATION_FIELDS: Array[Symbol]
+    TYPES: Hash[Symbol, String]
+    def self.list_json: (Symbol | String operation, ?(Integer | Array[Hash[Symbol | String, untyped]]) items, ?has_next_page: bool, ?has_previous_page: bool, ?start_cursor: String?, ?end_cursor: String?, ?per_page: Integer?, ?total_count: Integer?) -> Hash[String, untyped]
+    def self.pagination_json: (?Hash[String, untyped] example, ?has_next_page: bool, ?has_previous_page: bool, ?start_cursor: String?, ?end_cursor: String?, ?per_page: Integer?, ?total_count: Integer?) -> Hash[String, untyped]
+    def self.error_json: (*(String | Array[String]) messages) -> Hash[String, Array[String]]
+    def self.http_status: (Symbol | String operation, ?(Integer | String)? http_status) -> Integer
+    def self.operation: (Symbol | String name) -> [Symbol, String]
+
+    module Factories
+      OBJECT_CLASSES: Hash[Symbol, untyped]
+      TOKEN_EXAMPLE: Hash[String, untyped]
+      def object: (Symbol | String factory, **untyped overrides) -> untyped
+      def account_info: (?user: Hash[Symbol | String, untyped], **untyped account_overrides) -> Objects::AccountInfo
+      def oauth_token: (**untyped overrides) -> OAuth::Token
+      def tagged_subscriber: (?tag_names: Array[String], **untyped subscriber_overrides) -> Objects::TaggedSubscriber
+    end
+    extend Factories
+
+    module Stubs
+      BASE_URL: String
+      JSON_HEADERS: Hash[String, String]
+      def stub: (Symbol | String operation, ?http_status: (Integer | String)?, **untyped params) -> untyped
+      def stub_error: (Symbol | String operation, Integer status, *(String | Array[String]) messages, **untyped path_params) -> untyped
+      def stub_rate_limited: (Symbol | String operation, ?retry_after: Integer, **untyped path_params) -> untyped
+      def url_for: (Symbol | String operation, **untyped path_params) -> (String | Regexp)
+    end
+    extend Stubs
+
+    def self.subscriber: (**untyped overrides) -> Objects::Subscriber
+    def self.tag: (**untyped overrides) -> Objects::Tag
+    def self.custom_field: (**untyped overrides) -> Objects::CustomField
+    def self.sequence: (**untyped overrides) -> Objects::Sequence
+    def self.sequence_email: (**untyped overrides) -> Objects::SequenceEmail
+    def self.broadcast: (**untyped overrides) -> Objects::Broadcast
+    def self.broadcast_stats: (**untyped overrides) -> Objects::BroadcastStats
+    def self.post: (**untyped overrides) -> Objects::Post
+    def self.snippet: (**untyped overrides) -> Objects::Snippet
+    def self.purchase: (**untyped overrides) -> Objects::Purchase
+    def self.webhook: (**untyped overrides) -> Objects::Webhook
+    def self.webhook_endpoint: (**untyped overrides) -> Objects::WebhookEndpoint
+    def self.creator_profile: (**untyped overrides) -> Objects::CreatorProfile
+    def self.email_stats: (**untyped overrides) -> Objects::EmailStats
+    def self.growth_stats: (**untyped overrides) -> Objects::GrowthStats
+    def self.subscriber_stats: (**untyped overrides) -> Objects::SubscriberStats
+    def self.account: (**untyped overrides) -> Objects::Account
+
+    def self.subscriber_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.tag_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.custom_field_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.sequence_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.sequence_email_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.broadcast_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.broadcast_stats_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.post_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.snippet_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.purchase_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.webhook_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.webhook_endpoint_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.creator_profile_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.email_stats_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.growth_stats_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.subscriber_stats_json: (**untyped overrides) -> Hash[String, untyped]
+    def self.account_json: (**untyped overrides) -> Hash[String, untyped]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kit-rb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Lawrence Lin
@@ -54,6 +54,7 @@ files:
 - lib/kit/configuration.rb
 - lib/kit/connection.rb
 - lib/kit/errors.rb
+- lib/kit/instrumentation.rb
 - lib/kit/oauth/client.rb
 - lib/kit/oauth/pkce.rb
 - lib/kit/oauth/token.rb
@@ -97,6 +98,13 @@ files:
 - lib/kit/resources/tags.rb
 - lib/kit/resources/webhook_endpoints.rb
 - lib/kit/resources/webhooks.rb
+- lib/kit/tag_names.rb
+- lib/kit/testing.rb
+- lib/kit/testing/factories.rb
+- lib/kit/testing/fixtures.json
+- lib/kit/testing/fixtures.rb
+- lib/kit/testing/operations.rb
+- lib/kit/testing/stubs.rb
 - lib/kit/version.rb
 - lib/kit/webhooks/delivery.rb
 - lib/kit/webhooks/events.rb