bank_of_thailand 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c8ed6b63a147c446647a9a14d22496586de29fcb34841bb87eb1486a7307118
+  data.tar.gz: a5929c13399366bf2715621922c73c6565c8a98b2f6d5d172ce8520e3006c0d6
+SHA512:
+  metadata.gz: 2f18242c5e071d0e42f3123bf1a796427a693603bb8c6297c9ae98ef01585515ffe5cf9e6fbf332c3454e3a3ad28c678f3347ae09b58dd7d62407b137f932ac8
+  data.tar.gz: e237535be4e3f98f0953ac74b06e8bdde61f91e7ee8a70fd7665f5faeb46fa7ede942d552d3a2d4dc2e64ad85e7e99b9f4f09b99f6f9a2789ba971430caef405

data/.yardopts

@@ -0,0 +1,8 @@
+--markup markdown
+--no-private
+--protected
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-03
+
+### Added
+- Initial release with 11 API resources
+- Exchange rate APIs (weighted-average interbank THB/USD and average exchange rates for 19 currencies)
+- Interest rate APIs (deposit rates, loan rates, interbank rates, Thai Baht implied rates)
+- Securities & markets APIs (debt securities auction results, swap point onshore)
+- Regulatory APIs (BOT license check, financial institutions holidays)
+- Search API (series search)
+- Comprehensive test coverage (66 examples, 100% pass rate)
+- RuboCop configuration for code quality
+- YARD documentation support
+- Ruby 3.0+ support with CI testing across 3.0, 3.1, 3.2, 3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Chayut Orapinpatipat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,293 @@
+# Bank of Thailand API Wrapper
+
+A Ruby gem for accessing the Bank of Thailand's public API services. This gem provides a clean, object-oriented interface to interact with BOT's official API catalog.
+
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.0.0-ruby.svg)](https://www.ruby-lang.org/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+
+## Features
+
+- **Token-based Authentication** - Secure API access using BOT's authorization system
+- **11 API Resources** - Complete coverage of all documented BOT API products
+- **Type Safety** - Comprehensive error handling with custom exception classes
+- **Flexible Configuration** - Global or instance-level configuration options
+- **Full Test Coverage** - 66 examples with 100% pass rate
+- **YARD Documentation** - Complete API documentation for all endpoints
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bank_of_thailand"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install bank_of_thailand
+```
+
+## Prerequisites
+
+Before using this gem, you need to obtain an API token from the Bank of Thailand API Portal:
+
+1. **Create an Account** at [https://portal.api.bot.or.th](https://portal.api.bot.or.th)
+2. **Create an Application** in your profile (Profile → My apps)
+3. **Subscribe to API Products** from the Catalogues menu
+4. **Select a Plan** and add to cart
+5. **Activate Subscription** by selecting your application
+6. **Retrieve Your Token** from Profile → My apps → Select your app → Copy token
+
+Note: A token can only access APIs from subscribed products. Make sure to subscribe to the products you need.
+
+## Configuration
+
+### Global Configuration
+
+Configure the gem globally for use throughout your application:
+
+```ruby
+require "bank_of_thailand"
+
+BankOfThailand.configure do |config|
+  config.api_token = ENV["BOT_API_TOKEN"]  # Required
+  config.timeout = 30                       # Optional, default: 30 seconds
+  config.max_retries = 3                    # Optional, default: 3
+end
+
+# Create a client using global configuration
+client = BankOfThailand::Client.new
+```
+
+### Instance Configuration
+
+Configure individual client instances:
+
+```ruby
+client = BankOfThailand::Client.new do |config|
+  config.api_token = "your_token_here"
+  config.timeout = 60
+end
+```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `api_token` | String | `nil` | **Required.** Your BOT API token from the portal |
+| `base_url` | String | `https://gateway.api.bot.or.th` | Base gateway URL (rarely needs changing) |
+| `timeout` | Integer | `30` | Request timeout in seconds |
+| `max_retries` | Integer | `3` | Number of retry attempts for failed requests |
+| `logger` | Logger | `nil` | Optional logger for debugging |
+
+## Usage
+
+### Available API Resources
+
+The gem provides access to 11 BOT API resources:
+
+```ruby
+client = BankOfThailand::Client.new
+
+# Exchange Rates
+client.exchange_rate          # Weighted-average Interbank Exchange Rate (THB/USD)
+client.average_exchange_rate  # Average Exchange Rate (THB/Foreign Currencies)
+
+# Interest Rates
+client.deposit_rate           # Deposit Interest Rates
+client.loan_rate              # Loan Interest Rates
+client.interbank_rate         # Interbank Transaction Rates
+client.implied_rate           # Thai Baht Implied Interest Rates
+
+# Securities & Markets
+client.debt_securities        # Debt Securities Auction Results
+client.swap_point             # Swap Point Onshore
+
+# Regulatory & Reference
+client.license_check          # BOT License Check
+client.financial_holidays     # Financial Institutions' Holidays
+client.search_series          # Search Stat APIs
+```
+
+### Exchange Rates
+
+#### Weighted-average Interbank Exchange Rate (THB/USD)
+
+```ruby
+# Daily rates
+daily_rates = client.exchange_rate.daily(
+  start_period: "2025-01-01",
+  end_period: "2025-01-31"
+)
+
+# Monthly, quarterly, and annual rates also available
+monthly = client.exchange_rate.monthly(start_period: "2025-01", end_period: "2025-03")
+quarterly = client.exchange_rate.quarterly(start_period: "2025-Q1", end_period: "2025-Q2")
+annual = client.exchange_rate.annual(start_period: "2020", end_period: "2024")
+```
+
+#### Average Exchange Rate (Multiple Currencies)
+
+```ruby
+# Daily average rates with optional currency filter
+rates = client.average_exchange_rate.daily(
+  start_period: "2025-01-01",
+  end_period: "2025-01-31",
+  currency: "USD"  # Optional: filter by currency
+)
+
+# Also supports monthly, quarterly, and annual
+```
+
+### Interest Rates
+
+```ruby
+# Deposit rates
+deposit = client.deposit_rate.rates(
+  start_period: "2025-01-01",
+  end_period: "2025-01-31"
+)
+deposit_avg = client.deposit_rate.average_rates(start_period: "2025-01-01", end_period: "2025-01-31")
+
+# Loan rates
+loan = client.loan_rate.rates(start_period: "2025-01-01", end_period: "2025-01-31")
+loan_avg = client.loan_rate.average_rates(start_period: "2025-01-01", end_period: "2025-01-31")
+
+# Interbank rates (with optional term_type filter)
+interbank = client.interbank_rate.rates(
+  start_period: "2025-01-01",
+  end_period: "2025-01-31",
+  term_type: "O/N"  # Optional
+)
+
+# Implied rates (with optional rate_type filter)
+implied = client.implied_rate.rates(
+  start_period: "2025-01-01",
+  end_period: "2025-01-31",
+  rate_type: "ONSHORE : T/N"  # Optional
+)
+```
+
+### Securities & Markets
+
+```ruby
+# Debt securities auction results
+```
+
+### Securities & Markets
+
+```ruby
+# Debt securities auction results
+results = client.debt_securities.auction_results(
+  start_period: "2025-01-01",
+  end_period: "2025-01-31"
+)
+
+# Swap point onshore (with optional term_type filter)
+swap = client.swap_point.rates(
+  start_period: "2025-01-01",
+  end_period: "2025-01-31",
+  term_type: "1 Month"  # Optional
+)
+```
+
+### Regulatory & Reference Data
+
+```ruby
+# Search for authorized entities
+results = client.license_check.search_authorized(
+  keyword: "finance",
+  page: 1,      # Optional
+  limit: 10     # Optional
+)
+
+# Get license details
+license = client.license_check.license(auth_id: "12345", doc_id: "DOC-001")
+
+# Get entity details
+entity = client.license_check.authorized_detail(id: 12345)
+
+# Financial holidays
+holidays = client.financial_holidays.list(year: "2025")
+
+# Search series
+series = client.search_series.search(keyword: "government debt")
+```
+
+## Error Handling
+
+```ruby
+begin
+  client.exchange_rate.daily
+rescue BankOfThailand::RateLimitError => e
+  retry_after = e.retry_after
+rescue BankOfThailand::APIError => e
+  puts "API error: #{e.message}"
+end
+```
+
+### Exception Hierarchy
+
+```
+BankOfThailand::Error (StandardError)
+├── ConfigurationError
+└── RequestError
+    ├── AuthenticationError
+    │   └── InvalidTokenError
+    ├── NotFoundError
+    ├── RateLimitError
+    └── ServerError
+```
+
+## Rate Limits
+
+Rate limits vary by API product. The gem automatically handles rate limiting errors and provides retry information via `RateLimitError#retry_after`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Run `rake spec` to execute tests. Use `bin/console` for an interactive prompt.
+
+```bash
+# Run tests
+bundle exec rspec
+
+# Run linter
+bundle exec rubocop
+
+# Generate documentation
+bundle exec yard doc
+```
+
+## API Documentation
+
+For detailed information about the Bank of Thailand APIs:
+
+- **API Portal**: [https://portal.api.bot.or.th](https://portal.api.bot.or.th)
+- **Production Gateway**: [https://gateway.api.bot.or.th](https://gateway.api.bot.or.th)
+- **Official BOT Website**: [https://www.bot.or.th](https://www.bot.or.th)
+
+## Contributing
+
+Bug reports and pull requests are welcome at [github.com/chayuto/bank_of_thailand](https://github.com/chayuto/bank_of_thailand).
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history and release notes.
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]