Change API for setting the request environment #11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
harrylewis
force-pushed
the
support-test-mode-parameter
branch
from
44b5e35 to
aad2853
Compare
Clarify some the test descriptions, and add a test case for a missed edge case, when the test mode setting is not explicitly set.
harrylewis
force-pushed
the
support-test-mode-parameter
branch
from
aad2853 to
c855590
Compare
harrylewis
changed the title
:test_mode configuration
harrylewis
force-pushed
the
support-test-mode-parameter
branch
from
c855590 to
6d9510c
Compare
This is done for a generally safer library that requires explicit configuration to access the production environment.
harrylewis
force-pushed
the
support-test-mode-parameter
branch
from
6d9510c to
2c8bb51
Compare
This is an override argument, which will allow overriding the static environment configuration.
harrylewis
force-pushed
the
support-test-mode-parameter
branch
from
2c8bb51 to
17540bb
Compare
harrylewis
commented
Aug 29, 2024
Comment on lines
+22
to
+25
| ENVIRONMENTS = { | ||
| sandbox: :sandbox, | ||
| production: :production, | ||
| }.freeze |
There was a problem hiding this comment.
There are only two available environments, which correspond with two different URL's.
Comment on lines
-34
to
+40
| def self.test_mode=(test_mode) | ||
| configuration.test_mode = test_mode | ||
| def self.environment=(environment) | ||
| configuration.environment = environment |
There was a problem hiding this comment.
Changing the configuration setter from .test_mode= to .environment=.
| url = Payrix.configuration.url | ||
| url = Payrix.configuration.url(options[:environment]) |
There was a problem hiding this comment.
Support passing in the :environment per-request.
Comment on lines
+15
to
+19
| def environment=(environment) | ||
| validate_environment!(environment) | ||
|
|
||
| @environment = environment.to_sym | ||
| end |
There was a problem hiding this comment.
Here I am defining an explicit setter so that we can raise an appropriate developer error when it is set incorrectly.
Comment on lines
-11
to
+12
| @test_mode = false | ||
| @environment = Payrix::ENVIRONMENTS.fetch(:sandbox) |
There was a problem hiding this comment.
Change the default environment setting to sandbox. This is done to foster more safety when using the library, and prevent making accidental mutations in the production environment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR changes the API for setting the request environment. It is now set through
Payrix.environment=instead ofPayrix.test_mode=.Without explicit configuration, the default environment is sandbox now instead of production.
Additionally, support has been added for passing an
:environmentparameter into theoptionshash for all CRUD operations.