Module: Poodle

Defined in:
lib/poodle.rb,
lib/poodle/email.rb,
lib/poodle/rails.rb,
lib/poodle/client.rb,
lib/poodle/version.rb,
lib/poodle/http_client.rb,
lib/poodle/test_helpers.rb,
lib/poodle/test_helpers.rb,
lib/poodle/configuration.rb,
lib/poodle/rails/railtie.rb,
lib/poodle/email_response.rb,
lib/poodle/errors/base_error.rb,
lib/poodle/errors/server_error.rb,
lib/poodle/errors/network_error.rb,
lib/poodle/errors/payment_error.rb,
lib/poodle/errors/forbidden_error.rb,
lib/poodle/errors/rate_limit_error.rb,
lib/poodle/errors/validation_error.rb,
lib/poodle/errors/authentication_error.rb

Overview

Convenience methods for global access

Defined Under Namespace

Modules: Rails, TestHelpers Classes: AuthenticationError, Client, Configuration, Email, EmailResponse, Error, ForbiddenError, HttpClient, NetworkError, PaymentError, RateLimitError, ServerError, ValidationError

Constant Summary collapse

VERSION =

The current version of the Poodle Ruby SDK

"1.0.0"

Class Method Summary collapse

Class Method Details

.clear_deliveries ⇒ Object 



233
234
235
 
# File 'lib/poodle/test_helpers.rb', line 233

def self.clear_deliveries
  TestHelpers::TestMode.clear_deliveries
end

.deliveries ⇒ Object 



229
230
231
 
# File 'lib/poodle/test_helpers.rb', line 229

def self.deliveries
  TestHelpers::TestMode.deliveries
end

.disable_test_mode! ⇒ Object 



221
222
223
 
# File 'lib/poodle/test_helpers.rb', line 221

def self.disable_test_mode!
  TestHelpers::TestMode.disable!
end

.last_delivery ⇒ Object 



237
238
239
 
# File 'lib/poodle/test_helpers.rb', line 237

def self.last_delivery
  TestHelpers::TestMode.last_delivery
end

.mock_client ⇒ Object 



241
242
243
 
# File 'lib/poodle/test_helpers.rb', line 241

def self.mock_client
  TestHelpers::MockClient.new
end

.new(*args, **kwargs) ⇒ Client

Convenience method to create a new client

Examples:

client = Poodle.new(api_key: "your_api_key")
# equivalent to: Poodle::Client.new(api_key: "your_api_key")

Parameters:

  • args (Array) —

    arguments to pass to Client.new

  • kwargs (Hash) —

    keyword arguments to pass to Client.new

Returns:

  • (Client) —

    a new client instance



70
71
72
 
# File 'lib/poodle.rb', line 70

def self.new(*args, **kwargs)
  Client.new(*args, **kwargs)
end

.test_mode! ⇒ Object 



217
218
219
 
# File 'lib/poodle/test_helpers.rb', line 217

def self.test_mode!
  TestHelpers::TestMode.enable!
end

.test_mode? ⇒ Boolean

Returns:

  • (Boolean) 


225
226
227
 
# File 'lib/poodle/test_helpers.rb', line 225

def self.test_mode?
  TestHelpers::TestMode.enabled?
end

.version ⇒ String

Get the SDK version

Returns:

  • (String) —

    the SDK version



77
78
79
 
# File 'lib/poodle.rb', line 77

def self.version
  VERSION
end