celitech 2.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3424f5a55970a683d65659cdd00e6b6ed76433367af2804584ed8d0ae00e531
+  data.tar.gz: e13a30c0f6382ac209e773d18040150bec5cc57b6b19cd349dc34bd7ff4aba48
+SHA512:
+  metadata.gz: 147b03dcc340c791f2117103fef9939fcf0ab1de63db3b60e30a69b545cc7050648d59ef30f05f49af017a00f61ab8dda8d562addd7b04cdfe152b183c31aa31
+  data.tar.gz: 5a3213b42f42925ee348d79a0f72c20b9ae56bb528a8df67c3edf1080e07a9489b5ec356776c28574fb3fc354438866eedbac56270080755bfea682ee5dcc25d

data/README.md

@@ -0,0 +1,225 @@
+# Celitech Ruby SDK 2.0.7
+
+Welcome to the Celitech SDK documentation. This guide will help you get started with integrating and using the Celitech SDK in your project.
+
+## Versions
+
+- API version: `2.0.7`
+- SDK version: `2.0.7`
+
+## About the API
+
+Welcome to the CELITECH API documentation!
+
+Useful links: [Homepage](https://www.celitech.com) | [Support email](mailto:support@celitech.com) | [Blog](https://www.celitech.com/blog/)
+
+## Table of Contents
+
+- [Setup & Configuration](#setup--configuration)
+  - [Supported Language Versions](#supported-language-versions)
+  - [Installation](#installation)
+- [Authentication](#authentication)
+  - [OAuth Authentication](#oauth-authentication)
+  - [Environment Variables](#environment-variables)
+- [Sample Usage](#sample-usage)
+- [Services](#services)
+- [Models](#models)
+- [License](#license)
+
+# Setup & Configuration
+
+## Supported Language Versions
+
+This SDK is compatible with the following versions: `Ruby >= 3.3`
+
+## Installation
+
+### Using RubyGems
+
+If the gem is published to RubyGems or a private gem server, install it directly:
+
+```bash
+gem install celitech
+```
+
+### Using Bundler (recommended)
+
+Add the gem to your application's `Gemfile`:
+
+```ruby
+gem 'celitech'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Verifying the SDK setup
+
+To verify the SDK works correctly, you can run the included example:
+
+1. Install dependencies:
+
+```bash
+bundle install
+```
+
+2. Run the example:
+
+```bash
+bundle exec ruby example/example.rb
+```
+
+## Configuration Scopes
+
+The SDK supports three nested configuration scopes. The most-specific scope always wins; changes made at a narrower scope do not persist beyond that scope.
+
+### SDK-level (default)
+
+Set once at initialization and applied to every request unless overridden.
+
+```ruby
+require 'celitech'
+
+sdk = Celitech::Client.new(
+  base_url: 'https://api.example.com',
+  timeout: 30,
+)
+```
+
+### Service-level
+
+Override config for all requests made through a particular service instance. The original client and other services are not affected.
+
+```ruby
+override = Celitech::Config.new(base_url: 'https://api.example.com')
+service = sdk.destinations(config: override)
+response = service.some_method
+```
+
+### Per-request
+
+Override config for a single call only. The next call automatically reverts to the enclosing scope.
+
+```ruby
+response = sdk.destinations.some_method(
+  config: Celitech::Config.new(base_url: 'https://api.example.com'),
+)
+
+# The next call uses the original SDK-level config automatically
+response = sdk.destinations.some_method
+```
+
+Passing `config: nil` explicitly bypasses any service-level override for that single call, falling back directly to the SDK-level (connection) defaults.
+
+## Authentication
+
+### OAuth Authentication
+
+The Celitech API uses OAuth 2.0 for authentication.
+
+You need to provide your OAuth credentials when initializing the SDK. Tokens are automatically fetched, cached, and refreshed — you do not need to manage them yourself.
+
+```ruby
+require 'celitech'
+
+sdk = Celitech::Client.new(client_id: 'YOUR_CLIENT_ID', client_secret: 'YOUR_CLIENT_SECRET')
+```
+
+If you need to set or update the OAuth credentials after the SDK initialization, you can use:
+
+```ruby
+require 'celitech'
+
+sdk = Celitech::Client.new
+
+sdk.client_id = 'YOUR_CLIENT_ID'
+sdk.client_secret = 'YOUR_CLIENT_SECRET'
+```
+
+## Environment Variables
+
+These are the environment variables for the SDK:
+
+| Name          | Description             |
+| :------------ | :---------------------- |
+| CLIENT_ID     | Client ID parameter     |
+| CLIENT_SECRET | Client Secret parameter |
+
+Environment variables are a way to configure your application outside the code. You can set these environment variables on the command line or use your project's existing tooling for managing environment variables.
+
+If you are using a `.env` file, a template with the variable names is provided in the `.env.example` file located in the same directory as this README.
+
+# Sample Usage
+
+Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
+
+```ruby
+require 'celitech'
+
+sdk = Celitech::Client.new(client_id: 'YOUR_CLIENT_ID', client_secret: 'YOUR_CLIENT_SECRET')
+
+response = sdk.destinations.list_destinations
+
+puts response
+
+```
+
+## Services
+
+The SDK provides various services to interact with the API.
+
+<details>
+<summary>Below is a list of all available services with links to their detailed documentation:</summary>
+
+| Name                                                   |
+| :----------------------------------------------------- |
+| [Destinations](documentation/services/destinations.md) |
+| [Packages](documentation/services/packages.md)         |
+| [Purchases](documentation/services/purchases.md)       |
+| [ESim](documentation/services/e_sim.md)                |
+| [IFrame](documentation/services/i_frame.md)            |
+| [OAuth](documentation/services/o_auth.md)              |
+
+</details>
+
+## Models
+
+The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
+
+<details>
+<summary>Below is a list of all available models with links to their detailed documentation:</summary>
+
+| Name                                                                                             | Description |
+| :----------------------------------------------------------------------------------------------- | :---------- |
+| [ListDestinationsOkResponse](documentation/models/list_destinations_ok_response.md)              |             |
+| [ListPackagesOkResponse](documentation/models/list_packages_ok_response.md)                      |             |
+| [CreatePurchaseV2OkResponse](documentation/models/create_purchase_v2_ok_response.md)             |             |
+| [CreatePurchaseV2Request](documentation/models/create_purchase_v2_request.md)                    |             |
+| [ListPurchasesOkResponse](documentation/models/list_purchases_ok_response.md)                    |             |
+| [CreatePurchaseOkResponse](documentation/models/create_purchase_ok_response.md)                  |             |
+| [CreatePurchaseRequest](documentation/models/create_purchase_request.md)                         |             |
+| [TopUpEsimOkResponse](documentation/models/top_up_esim_ok_response.md)                           |             |
+| [TopUpEsimRequest](documentation/models/top_up_esim_request.md)                                  |             |
+| [EditPurchaseOkResponse](documentation/models/edit_purchase_ok_response.md)                      |             |
+| [EditPurchaseRequest](documentation/models/edit_purchase_request.md)                             |             |
+| [GetPurchaseConsumptionOkResponse](documentation/models/get_purchase_consumption_ok_response.md) |             |
+| [GetEsimOkResponse](documentation/models/get_esim_ok_response.md)                                |             |
+| [GetEsimDeviceOkResponse](documentation/models/get_esim_device_ok_response.md)                   |             |
+| [GetEsimHistoryOkResponse](documentation/models/get_esim_history_ok_response.md)                 |             |
+| [TokenOkResponse](documentation/models/token_ok_response.md)                                     |             |
+| [OAuthTokenResponse](documentation/models/o_auth_token_response.md)                              |             |
+| [OAuthTokenRequest](documentation/models/o_auth_token_request.md)                                |             |
+| [GrantType](documentation/models/grant_type.md)                                                  |             |
+| [BadRequest](documentation/models/bad_request.md)                                                |             |
+| [Unauthorized](documentation/models/unauthorized.md)                                             |             |
+
+</details>
+
+## License
+
+This SDK is licensed under the MIT License.
+
+See the [LICENSE](LICENSE) file for more details.

data/lib/celitech/client.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Celitech
+  class Client
+    DEFAULT_BASE_URL = Environment::DEFAULT
+    TOKEN_URL = 'https://auth.celitech.net/oauth2/token'
+
+    def initialize(base_url: DEFAULT_BASE_URL, timeout: nil, timeout_ms: nil, client_id: nil, client_secret: nil, token_url: TOKEN_URL)
+      unless timeout_ms.nil?
+        warn '[DEPRECATION] `timeout_ms` is deprecated; use `timeout` (seconds) instead.', uplevel: 1
+        timeout = timeout_ms / 1000.0 if timeout.nil?
+      end
+      @token_manager = HTTP::OAuthTokenManager.new(
+        client_id: client_id,
+        client_secret: client_secret,
+        token_url: token_url,
+      )
+      @connection = HTTP::Connection.new(base_url, {}, timeout: timeout)
+      @destinations = Destinations.new(@connection, nil, token_manager: @token_manager)
+      @packages = Packages.new(@connection, nil, token_manager: @token_manager)
+      @purchases = Purchases.new(@connection, nil, token_manager: @token_manager)
+      @e_sim = ESim.new(@connection, nil, token_manager: @token_manager)
+      @i_frame = IFrame.new(@connection, nil, token_manager: @token_manager)
+      @o_auth = OAuth.new(@connection, nil, token_manager: @token_manager)
+    end
+
+    def destinations(config: nil)
+      return @destinations unless config
+
+      Destinations.new(@connection, config, token_manager: @token_manager)
+    end
+
+    def packages(config: nil)
+      return @packages unless config
+
+      Packages.new(@connection, config, token_manager: @token_manager)
+    end
+
+    def purchases(config: nil)
+      return @purchases unless config
+
+      Purchases.new(@connection, config, token_manager: @token_manager)
+    end
+
+    def e_sim(config: nil)
+      return @e_sim unless config
+
+      ESim.new(@connection, config, token_manager: @token_manager)
+    end
+
+    def i_frame(config: nil)
+      return @i_frame unless config
+
+      IFrame.new(@connection, config, token_manager: @token_manager)
+    end
+
+    def o_auth(config: nil)
+      return @o_auth unless config
+
+      OAuth.new(@connection, config, token_manager: @token_manager)
+    end
+
+    def client_id=(client_id)
+      @token_manager.client_id = client_id
+    end
+
+    def client_secret=(client_secret)
+      @token_manager.client_secret = client_secret
+    end
+
+    def environment=(env)
+      self.base_url = Environment.const_get(env.to_s.upcase)
+    rescue NameError
+      raise ArgumentError, "Unknown environment: #{env.inspect}"
+    end
+
+    def base_url=(url)
+      @connection.base_url = url
+    end
+  end
+end

data/lib/celitech/config.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Celitech
+  class Config
+    attr_reader :base_url, :timeout, :enable_response_validation, :return_raw, :additional_headers, :additional_query_parameters, :retry_config
+
+    def initialize(
+      base_url: nil,
+      timeout: nil,
+      timeout_ms: nil,
+      enable_response_validation: false,
+      return_raw: false,
+      additional_headers: nil,
+      additional_query_parameters: nil,
+      retry_config: nil
+    )
+      unless timeout_ms.nil?
+        warn '[DEPRECATION] `timeout_ms` is deprecated; use `timeout` (seconds) instead.', uplevel: 1
+        timeout = timeout_ms / 1000.0 if timeout.nil?
+      end
+      @base_url = base_url
+      @timeout = timeout
+      @enable_response_validation = enable_response_validation
+      @return_raw = return_raw
+      @additional_headers = additional_headers
+      @additional_query_parameters = additional_query_parameters
+      @retry_config = retry_config
+    end
+
+    def with(**overrides)
+      base = to_h
+      base.delete(:timeout) if overrides.key?(:timeout_ms) && !overrides.key?(:timeout)
+      self.class.new(**base, **overrides)
+    end
+
+    def to_h
+      {
+        base_url: @base_url,
+        timeout: @timeout,
+        enable_response_validation: @enable_response_validation,
+        return_raw: @return_raw,
+        additional_headers: @additional_headers,
+        additional_query_parameters: @additional_query_parameters,
+        retry_config: @retry_config,
+      }
+    end
+  end
+end

data/lib/celitech/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Celitech
+  module Environment
+    DEFAULT = 'https://api.celitech.net/v1'
+  end
+end

data/lib/celitech/error.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Celitech
+  class Error < StandardError; end
+
+  class APIError < Error
+    attr_reader :status, :body, :headers
+
+    def initialize(status, body, headers = {})
+      @status  = status
+      @body    = body
+      @headers = headers || {}
+      super("HTTP #{status}: #{body}")
+    end
+  end
+
+  class TimeoutError < Error
+    def initialize(msg = 'Request timed out')
+      super
+    end
+  end
+
+  class ValidationError < Error
+    attr_reader :field, :validation_message
+
+    def initialize(field, message)
+      @field              = field
+      @validation_message = message
+      super("Validation failed for #{field}: #{message}")
+    end
+  end
+
+  class BadRequestError < APIError
+    attr_reader :data
+
+    def initialize(status, data, body, headers = {})
+      super(status, body, headers)
+      @data = data
+    end
+  end
+
+  class UnauthorizedError < APIError
+    attr_reader :data
+
+    def initialize(status, data, body, headers = {})
+      super(status, body, headers)
+      @data = data
+    end
+  end
+end