namabar 0.1.0

data/sig/client.rbs

@@ -0,0 +1,65 @@
+module Namabar
+    # HTTP client for interacting with the Namabar API
+  #
+  # This class provides the core HTTP functionality for making requests to the Namabar API.
+  # It uses HTTParty for HTTP operations and includes all endpoint methods from the Endpoints module.
+  #
+  # The client automatically handles:
+  # - Base URI configuration
+  # - Authentication via API key headers
+  # - Content-Type and Accept headers
+  # - JSON request/response handling
+  #
+  # @example Basic usage
+  #   # Configure globally first
+  #   Namabar.configure do |config|
+  #     config.api_key = 'your-api-key'
+  #   end
+  #
+  #   # Create and use client
+  #   client = Namabar::Client.new
+  #   response = client.send_message(
+  #     type: 'sms',
+  #     to: '+1234567890',
+  #     text: 'Hello from Namabar!',
+  #     service_id: 'sms-service'
+  #   )
+  #   puts response.code # => 200
+  #   puts response.body # => parsed JSON response
+  #
+  # @see Endpoints
+  # @see Configuration
+  class Client
+    @config: Configuration
+
+    include HTTParty
+    include Endpoints
+
+    # Initialize a new Namabar API client
+    #
+    # Creates a new client instance using the global Namabar configuration.
+    # The client will be configured with the API key and default headers
+    # required for authentication and proper JSON communication.
+    #
+    # @raise [StandardError] if Namabar.configuration is nil or api_key is not set
+    #
+    # @example Create a client
+    #   client = Namabar::Client.new
+    #
+    # @see Namabar.configure
+    def initialize: () -> void
+
+    # Get default HTTP options for requests
+    #
+    # Returns a hash containing the default options that should be included
+    # with every HTTP request, including headers for authentication and content type.
+    #
+    # @return [Hash] hash containing default headers and options
+    #
+    # @example Using default options
+    #   opts = client.default_options
+    #   opts = opts.merge(query: { limit: 10 })
+    #   response = HTTParty.get('/endpoint', opts)
+    def default_options: () -> { headers: Hash[String, String] }
+  end
+end 

data/sig/configuration.rbs

@@ -0,0 +1,50 @@
+module Namabar
+  # Configuration class for storing Namabar API credentials and settings
+  #
+  # This class holds the configuration options required to authenticate
+  # and interact with the Namabar API. It's typically configured once
+  # globally and then used by all Client instances.
+  #
+  # @example Configure with API credentials
+  #   config = Namabar::Configuration.new
+  #   config.api_key = ENV.fetch('NAMABAR__API_KEY', nil)
+  #
+  # @example Configure using the global configuration
+  #   Namabar.configure do |config|
+  #     config.api_key = 'your-api-key'
+  #   end
+  #
+  # @see Namabar.configure
+  class Configuration
+    # @return [String, nil] the API key for authenticating with the Namabar API
+    # @example Set API key
+    #   config.api_key = 'sk_live_1234567890abcdef'
+    attr_accessor api_key: String?
+  end
+
+  # @return [Configuration, nil] the global configuration instance
+  attr_accessor self.configuration: Configuration?
+
+  # Configure the Namabar gem with API credentials and settings
+  #
+  # This method provides a convenient way to set up the global configuration
+  # that will be used by all Client instances. The configuration object is
+  # yielded to the provided block for modification.
+  #
+  # @yield [config] Yields the configuration object for modification
+  # @yieldparam config [Configuration] the configuration instance to modify
+  # @return [Configuration] the configured Configuration instance
+  #
+  # @example Basic configuration
+  #   Namabar.configure do |config|
+  #     config.api_key = ENV.fetch('NAMABAR__API_KEY', nil)
+  #   end
+  #
+  # @example Configuration with validation
+  #   Namabar.configure do |config|
+  #     config.api_key = ENV.fetch('NAMABAR_API_KEY') { raise 'API key required' }
+  #   end
+  #
+  # @see Configuration
+  def self.configure: () { (Configuration) -> void } -> Configuration
+end 

data/sig/endpoints.rbs

@@ -0,0 +1,44 @@
+module Namabar
+  module Endpoints
+    # Create Verification Code
+    # @param to [String] (required)
+    # @param locale [(String | nil)] (optional)
+    # @param external_id [(String | nil)] (optional)
+    # @param code [(String | nil)] (optional)
+    # @param service_id [String] (required)
+    # @param template_data [(Hash[String, untyped] | nil)] (optional)
+    # @return [HTTParty::Response]
+    def create_verification_code: (to: String, ?locale: (String | nil), ?external_id: (String | nil), ?code: (String | nil), service_id: String, ?template_data: (Hash[String, untyped] | nil)) -> HTTParty::Response
+
+    # Verify Verification Code
+    # @param id [String] (required)
+    # @param code [String] (required)
+    # @return [HTTParty::Response]
+    def verify_verification_code: (id: String, code: String) -> HTTParty::Response
+
+    # Get Verification Code By Id
+    # @param id [String] (required)
+    # @return [HTTParty::Response]
+    def get_verification_code_by_id: (id: String) -> HTTParty::Response
+
+    # Send Message
+    # @param type [String] (required)
+    # @param to [String] (required)
+    # @param external_id [(String | nil)] (optional)
+    # @param service_id [String] (required)
+    # @param text [(String | nil)] (optional)
+    # @param template [(String | nil)] (optional)
+    # @return [HTTParty::Response]
+    def send_message: (type: String, to: String, ?external_id: (String | nil), service_id: String, ?text: (String | nil), ?template: (String | nil)) -> HTTParty::Response
+
+    # Get Message
+    # @param id [String] (required)
+    # @return [HTTParty::Response]
+    def get_message: (id: String) -> HTTParty::Response
+
+    # Get Message Status
+    # @param id [String] (required)
+    # @return [HTTParty::Response]
+    def get_message_status: (id: String) -> HTTParty::Response
+  end
+end

data/sig/namabar.rbs

@@ -0,0 +1,68 @@
+# The main Namabar module providing convenient access to the Namabar API
+#
+# This module serves as the primary entry point for the Namabar gem, offering:
+# - Global configuration management
+# - Client creation and management
+# - Error handling for the entire gem
+#
+# @example Basic usage
+#   Namabar.configure do |config|
+#     config.api_key = ENV.fetch('NAMABAR__API_KEY', nil)
+#   end
+#
+#   client = Namabar.client
+#   response = client.send_message(...)
+#
+# @see Client
+# @see Configuration
+module Namabar
+  # Base error class for all Namabar-related errors
+  #
+  # All errors raised by the Namabar gem inherit from this class,
+  # making it easy to rescue all gem-related errors with a single rescue clause.
+  #
+  # @example Rescuing all Namabar errors
+  #   begin
+  #     client.send_message(...)
+  #   rescue Namabar::Error => e
+  #     puts "Namabar error: #{e.message}"
+  #   end
+  class Error < StandardError
+  end
+
+  # @return [Configuration, nil] the current global configuration instance
+  attr_accessor self.configuration: Configuration?
+
+  # Configure the Namabar gem globally
+  #
+  # This method allows you to set global configuration options that will be
+  # used by all Client instances unless overridden. The configuration is
+  # yielded to the provided block for modification.
+  #
+  # @yield [config] Yields the configuration object for modification
+  # @yieldparam config [Configuration] the configuration instance to modify
+  # @return [Configuration] the configured Configuration instance
+  #
+  # @example Configure API credentials
+  #   Namabar.configure do |config|
+  #     config.api_key = ENV.fetch('NAMABAR__API_KEY', nil)
+  #   end
+  #
+  # @see Configuration
+  def self.configure: () { (Configuration) -> void } -> Configuration
+
+  # Create a new Namabar API client
+  #
+  # Creates and returns a new Client instance using the global configuration.
+  # This is a convenience method equivalent to calling Client.new directly.
+  #
+  # @param args [Array] arguments to pass to the Client constructor (currently none accepted)
+  # @return [Client] a new configured client instance
+  #
+  # @example Create a client
+  #   client = Namabar.client
+  #   response = client.send_message(...)
+  #
+  # @see Client#initialize
+  def self.client: (*untyped args) -> Client
+end

data/sig/version.rbs

@@ -0,0 +1,15 @@
+module Namabar
+  # The current version of the Namabar gem
+  #
+  # This constant follows semantic versioning (SemVer) conventions:
+  # - MAJOR: Incompatible API changes
+  # - MINOR: Backwards-compatible functionality additions
+  # - PATCH: Backwards-compatible bug fixes
+  #
+  # @return [String] the current version string
+  # @example Check the version
+  #   puts Namabar::VERSION # => "0.1.0"
+  #
+  # @see https://semver.org/ Semantic Versioning specification
+  VERSION: String
+end 

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: namabar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Muhammad Nawzad
+bindir: exe
+cert_chain: []
+date: 2025-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: A lightweight Ruby SDK providing HTTParty-based client with type definitions
+  for the Namabar OTP verification and messaging platform.
+email:
+- hama127n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/namabar.rb
+- lib/namabar/client.rb
+- lib/namabar/configuration.rb
+- lib/namabar/endpoints.rb
+- lib/namabar/version.rb
+- namabar.gemspec
+- sig/client.rbs
+- sig/configuration.rbs
+- sig/endpoints.rbs
+- sig/namabar.rbs
+- sig/version.rbs
+homepage: https://github.com/muhammadnawzad/namabar-ruby-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/muhammadnawzad/namabar-ruby-sdk
+  changelog_uri: https://github.com/muhammadnawzad/namabar-ruby-sdk/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/namabar
+  bug_tracker_uri: https://github.com/muhammadnawzad/namabar-ruby-sdk/issues
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: Ruby SDK for Namabar OTP verification and messaging API
+test_files: []