Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ coverage/*
doc/*
log/*
measurement/*
pkg/*
pkg/*
vendor/bundle
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,24 @@ aliases = client.list_aliases('domain.com')
puts aliases['aliases']
```

Improvmx has a rate limit system, to handle this you can do
### Timeout Configuration

You can configure custom timeout values when initializing the client:

```ruby
require 'improvmx'

# Configure timeouts (in seconds)
client = Improvmx::Client.new('your-api-key', {
read_timeout: 120, # Time to wait for response (default: 60)
open_timeout: 30 # Time to wait for connection (default: 60)
})
```

### Rate Limiting

Improvmx has a rate limit system, to handle this you can do:

```ruby
require 'improvmx'
client = Improvmx::Client.new 'your-api-key'
Expand Down
12 changes: 10 additions & 2 deletions lib/improvmx/client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,26 @@ class Client
include Improvmx::SMTP
include Improvmx::Utils

def initialize(api_key = Improvmx.api_key)
# Default timeout values in seconds
DEFAULT_OPEN_TIMEOUT = 60
DEFAULT_READ_TIMEOUT = 60

# rubocop:disable Metrics/MethodLength
def initialize(api_key = Improvmx.api_key, options = {})
rest_client_params = {
user: 'api',
password: api_key,
user_agent: "improvmx-ruby/#{Improvmx::VERSION}",
timeout: options[:read_timeout] || DEFAULT_READ_TIMEOUT,
open_timeout: options[:open_timeout] || DEFAULT_OPEN_TIMEOUT,
headers: {
content_type: "application/json"
content_type: 'application/json'
}
}

@http_client = RestClient::Resource.new('https://api.improvmx.com/v3', rest_client_params)
end
# rubocop:enable Metrics/MethodLength

def post(resource_path, data, headers = {})
response = @http_client[resource_path].post(data.to_json, headers)
Expand Down
27 changes: 27 additions & 0 deletions spec/improvmx/client_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
require 'spec_helper'
require 'improvmx'

describe Improvmx::Client do
describe '#initialize' do
it 'initializes with default timeout values' do
client = described_class.new('test-api-key')

expect(client).to be_a(described_class)
end

it 'initializes with custom timeout values' do
client = described_class.new('test-api-key', {
read_timeout: 120,
open_timeout: 30
})

expect(client).to be_a(described_class)
end

it 'initializes with partial timeout configuration' do
client = described_class.new('test-api-key', { read_timeout: 90 })

expect(client).to be_a(described_class)
end
end
end