diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..2217d89 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,49 @@ +# Pull Request Template + +## Description + +Please include a summary of the changes and the related issue. Explain the +motivation for the change and how it addresses the issue. Provide context if necessary. + +Fixes # (issue) + +## Type of Change + +Please delete options that are not relevant and add any that are. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to + not work as expected) +- [ ] Documentation update + +## Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide +instructions so we can reproduce. Include any relevant details for your test configuration. + +- [ ] Test A +- [ ] Test B + +## Screenshots (if applicable) + +If your changes include UI updates to the docs or other applicable repos, please +provide screenshots or GIFs to demonstrate the changes. + +## Additional Information + +Please add any other information that you think might be useful for the reviewer +to know while reviewing this PR. + +Thank you for contributing to the ABsmartly Ruby SDK! diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 1e7d505..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,5 +0,0 @@ -## [Unreleased] - -## [0.1.0] - 2022-08-03 - -- Initial release diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 893fb36..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,84 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the overall community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or - advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email - address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at omairr.azam@gmail.com. All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of actions. - -**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, -available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. - -Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see the FAQ at -https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..ec31a3f --- /dev/null +++ b/Contributing.md @@ -0,0 +1,45 @@ +# Contributing to the ABsmartly Ruby SDK + +The ABsmartly Ruby SDK is an open-source project, and we welcome your +feedback and contributions. This guide provides information on how to build +and test the project, and how to submit a pull request. + +## Development + +### Development Process + +1. **Fork and Branch**: Fork the repository and create a topic branch from the +main branch. Use a descriptive name for your branch. +2. **Commit Messages**: Use descriptive commit messages. Avoid short or vague +messages like "fix bug". +3. **Testing**: Add tests for both positive and negative cases to ensure +comprehensive coverage. +4. **Linting**: Run the linter script and fix any issues. This helps maintain +code quality and consistency. +5. **Building**: Run the build script to ensure it completes without errors. +6. **Testing**: Run all tests to ensure there are no failures. +7. **Push Changes**: Push your changes to GitHub in your topic branch. +8. **Pull Request**: Open a pull request from your forked repo into the main branch +of the original repository. +9. **PR Template**: Fill out all applicable fields in the pull request template. +10. **Conflict Check**: Ensure there are no conflicts with the main branch when +creating the pull request. +11. **Feedback**: Monitor your pull request for any feedback or comments from the +ABsmartly SDK team. + +### Building the SDK + +[[SDK_BUILD_DETAILS]] + +### Running Tests + +[[SDK_TESTING_DETAILS]] + +## Contact + +If you have any questions or need further assistance, you can reach us at + or on your company's dedicated ABsmartly Slack Connect +channel. + +Thank you for contributing to the ABsmartly Ruby SDK! Your efforts help us +improve and grow our open-source community. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e081663 --- /dev/null +++ b/LICENSE @@ -0,0 +1,204 @@ + Apache License + Version 2.0, January 2004 + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +Definitions. + +"License" shall mean the terms and conditions for use, reproduction, +and distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by +the copyright owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all +other entities that control, are controlled by, or are under common +control with that entity. For the purposes of this definition, +"control" means (i) the power, direct or indirect, to cause the +direction or management of such entity, whether by contract or +otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity +exercising permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, +including but not limited to software source code, documentation +source, and configuration files. + +"Object" form shall mean any form resulting from mechanical +transformation or translation of a Source form, including but +not limited to compiled object code, generated documentation, +and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or +Object form, made available under the License, as indicated by a +copyright notice that is included in or attached to the work +(an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object +form, that is based on (or derived from) the Work and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. For the purposes +of this License, Derivative Works shall not include works that remain +separable from, or merely link (or bind by name) to the interfaces of, +the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including +the original version of the Work and any modifications or additions +to that Work or Derivative Works thereof, that is intentionally +submitted to Licensor for inclusion in the Work by the copyright owner +or by an individual or Legal Entity authorized to submit on behalf of +the copyright owner. For the purposes of this definition, "submitted" +means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, +and issue tracking systems that are managed by, or on behalf of, the +Licensor for the purpose of discussing and improving the Work, but +excluding communication that is conspicuously marked or otherwise +designated in writing by the copyright owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity +on behalf of whom a Contribution has been received by Licensor and +subsequently incorporated within the Work. + +Grant of Copyright License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the +Work and such Derivative Works in Source or Object form. + +Grant of Patent License. Subject to the terms and conditions of +this License, each Contributor hereby grants to You a perpetual, +worldwide, non-exclusive, no-charge, royalty-free, irrevocable +(except as stated in this section) patent license to make, have made, +use, offer to sell, sell, import, and otherwise transfer the Work, +where such license applies only to those patent claims licensable +by such Contributor that are necessarily infringed by their +Contribution(s) alone or by combination of their Contribution(s) +with the Work to which such Contribution(s) was submitted. If You +institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work +or a Contribution incorporated within the Work constitutes direct +or contributory patent infringement, then any patent licenses +granted to You under this License for that Work shall terminate +as of the date such litigation is filed. + +Redistribution. You may reproduce and distribute copies of the +Work or Derivative Works thereof in any medium, with or without +modifications, and in Source or Object form, provided that You +meet the following conditions: + +(a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + +(b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + +(c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + +(d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + +You may add Your own copyright statement to Your modifications and +may provide additional or different license terms and conditions +for use, reproduction, or distribution of Your modifications, or +for any such Derivative Works as a whole, provided Your use, +reproduction, and distribution of the Work otherwise complies with +the conditions stated in this License. + +Submission of Contributions. Unless You explicitly state otherwise, +any Contribution intentionally submitted for inclusion in the Work +by You to the Licensor shall be under the terms and conditions of +this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify +the terms of any separate license agreement you may have executed +with Licensor regarding such Contributions. + +Trademarks. This License does not grant permission to use the trade +names, trademarks, service marks, or product names of the Licensor, +except as required for reasonable and customary use in describing the +origin of the Work and reproducing the content of the NOTICE file. + +Disclaimer of Warranty. Unless required by applicable law or +agreed to in writing, Licensor provides the Work (and each +Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +implied, including, without limitation, any warranties or conditions +of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +PARTICULAR PURPOSE. You are solely responsible for determining the +appropriateness of using or redistributing the Work and assume any +risks associated with Your exercise of permissions under this License. + +Limitation of Liability. In no event and under no legal theory, +whether in tort (including negligence), contract, or otherwise, +unless required by applicable law (such as deliberate and grossly +negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, +incidental, or consequential damages of any character arising as a +result of this License or out of the use or inability to use the +Work (including but not limited to damages for loss of goodwill, +work stoppage, computer failure or malfunction, or any and all +other commercial damages or losses), even if such Contributor +has been advised of the possibility of such damages. + +Accepting Warranty or Additional Liability. While redistributing +the Work or Derivative Works thereof, You may choose to offer, +and charge a fee for, acceptance of support, warranty, indemnity, +or other liability obligations and/or rights consistent with this +License. However, in accepting such obligations, You may act only +on Your own behalf and on Your sole responsibility, not on behalf +of any other Contributor, and only if You agree to indemnify, +defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason +of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + Copyright 2024 ABsmartly + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + + + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100644 index 608bb1d..0000000 --- a/LICENSE.txt +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2022 omairazam - -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. diff --git a/README.md b/README.md index ad73463..838ba69 100644 --- a/README.md +++ b/README.md @@ -1,253 +1,79 @@ -# A/B Smartly SDK + +

+ ABsmartly logo +

-A/B Smartly Ruby SDK +# ABsmartly Ruby SDK -## Compatibility +[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/absmartly/ruby-sdk/main.yml?label=CI)](https://github.com/absmartly/ruby-sdk/actions/workflows/main.yml) +[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/absmartly/ruby-sdk/publish.yml?label=publish)](https://github.com/absmartly/ruby-sdk/actions/workflows/publish.yml) +[![Gem Version](https://img.shields.io/gem/v/absmartly)](https://rubygems.org/gems/absmartly/versions/0.0.1) +[![Gem Total Downloads](https://img.shields.io/gem/dt/absmartly)](https://rubygems.org/gems/absmartly/versions/0.0.1) -The A/B Smartly Ruby SDK is compatible with Ruby versions 2.7 and later. For the best performance and code readability, Ruby 3 or later is recommended. This SDK is being constantly tested with the nightly builds of Ruby, to ensure it is compatible with the latest Ruby version. +Welcome to the Ruby SDK from ABsmartly! This SDK allows you to integrate +Feature Flagging and A/B testing seamlessly into your applications. +## Table of Contents -## Getting Started +- [About ABsmartly](#about-absmartly) +- [Installation](#installation) + - [With Bundler](#with-bundler) + - [Without Bundler](#without-bundler) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) +- [Support](#support) -### Install the SDK +## About ABsmartly -Install the gem and add to the application's Gemfile by executing: +ABsmartly is a platform that enables you to run A/B tests across your +applications to optimize and improve user experiences. For more information +about our platform and services, please visit our +website to request a demo. - $ bundle add absmartly-sdk +## Installation -If bundler is not being used to manage dependencies, install the gem by executing: +To install the Ruby SDK, simply use the following snippet: - $ gem install absmartly-sdk +### With Bundler -## Import and Initialize the SDK - -Once the SDK is installed, it can be initialized in your project. - -```ruby -Absmartly.configure_client do |config| - config.endpoint = "https://your-company.absmartly.io/v1" - config.api_key = "YOUR-API-KEY" - config.application = "website" - config.environment = "development" -end -``` - -**SDK Options** - -| Config | Type | Required? | Default | Description | -| :---------- | :----------------------------------- | :-------: | :-------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| endpoint | `string` | ✅ | `undefined` | The URL to your API endpoint. Most commonly `"your-company.absmartly.io"` | -| apiKey | `string` | ✅ | `undefined` | Your API key which can be found on the Web Console. | -| environment | `"production"` or `"development"` | ✅ | `undefined` | The environment of the platform where the SDK is installed. Environments are created on the Web Console and should match the available environments in your infrastructure. | -| application | `string` | ✅ | `undefined` | The name of the application where the SDK is installed. Applications are created on the Web Console and should match the applications where your experiments will be running. | -| retries | `number` | ❌ | `5` | The number of retries before the SDK stops trying to connect. | -| timeout | `number` | ❌ | `3000` | An amount of time, in milliseconds, before the SDK will stop trying to connect. | -| eventLogger | `(context, eventName, data) => void` | ❌ | See "Using a Custom Event Logger" below | A callback function which runs after SDK events. | - -### Using a Custom Event Logger - -The A/B Smartly SDK can be instantiated with an event logger used for all -contexts. In addition, an event logger can be specified when creating a -particular context, in the `[CONTEXT_CONFIG_VARIABLE]`. - -``` -Custom Event Logger Code -``` - -The data parameter depends on the type of event. Currently, the SDK logs the -following events: - -| eventName | when | data | -| ------------ | ------------------------------------------------------- | -------------------------------------------- | -| `"error"` | `Context` receives an error | error object thrown | -| `"ready"` | `Context` turns ready | data used to initialize the context | -| `"refresh"` | `Context.refresh()` method succeeds | data used to refresh the context | -| `"publish"` | `Context.publish()` method succeeds | data sent to the A/B Smartly event collector | -| `"exposure"` | `Context.treatment()` method succeeds on first exposure | exposure data enqueued for publishing | -| `"goal"` | `Context.track()` method succeeds | goal data enqueued for publishing | -| `"close"` | `Context.close()` method succeeds the first time | nil | - -## Create a New Context Request - - -```ruby -context_config = Absmartly.create_context_config -``` - -**With Prefetched Data** - -```ruby -client_config = ClientConfig.new( - endpoint: 'https://your-company.absmartly.io/v1', - api_key: 'YOUR-API-KEY', - application: 'website', - environment: 'development') - -sdk_config = ABSmartlyConfig.create -sdk_config.client = Client.create(client_config) - -sdk = Absmartly.create(sdk_config) +```bash +bundle add absmartly ``` -**Refreshing the Context with Fresh Experiment Data** - -For long-running contexts, the context is usually created once when the -application is first started. However, any experiments being tracked in your -production code, but started after the context was created, will not be -triggered. - -Alternatively, the `refresh` method can be called manually. The -`refresh` method pulls updated experiment data from the A/B -Smartly collector and will trigger recently started experiments when -`treatment` is called again. - -**Setting Extra Units** - -You can add additional units to a context by calling the `set_unit()` or -`set_units()` methods. These methods may be used, for example, when a user -logs in to your application and you want to use the new unit type in the -context. +### Without Bundler -Please note, you cannot override an already set unit type as that would be -a change of identity and would throw an exception. In this case, you must -create a new context instead. The `set_unit()` and -`set_units()` methods can be called before the context is ready. - -```ruby -context_config.set_unit('session_id', 'bf06d8cb5d8137290c4abb64155584fbdb64d8') -context_config.set_unit('user_id', '123456') -context = Absmartly.create_context(context_config) -``` -or -```ruby -context_config.set_units( - session_id: 'bf06d8cb5d8137290c4abb64155584fbdb64d8', - user_id: '123456' -) -context = Absmartly.create_context(context_config) +```bash +gem install absmartly ``` -## Basic Usage - -### Selecting A Treatment - -```ruby -treatment = context.treatment('exp_test_experiment') +## Usage -if treatment.zero? - # user is in control group (variant 0) -else - # user is in treatment group -end -``` +Comprehensive documentation for this SDK is available at +docs.absmartly.com. +There, you will find detailed guides, examples and API references to help you +get started. -### Treatment Variables +## Contributing -```ruby -default_button_color_value = 'red' +We welcome contributions from the community and our customers! If you'd like to contribute, +read the [Contributing Guide](Contributing.md) for more information. -context.variable_value('experiment_name', default_button_color_value) -``` +## License -### Peek at Treatment Variants +This project is licensed under the Apache 2.0 license. See the +[LICENSE](LICENSE) file for details. -Although generally not recommended, it is sometimes necessary to peek at -a treatment or variable without triggering an exposure. The A/B Smartly -SDK provides a `peek_treatment()` method for that. +## Support -```ruby -treatment = context.peek_treatment('exp_test_experiment') -``` +If you encounter any issues or have any questions, please reach out to us at +, open an issue on GitHub, or reach out to us on your +company's dedicated ABsmartly Slack Connect channel. -#### Peeking at variables +Happy Experimenting! -```ruby -treatment = context.peek_variable_value('exp_test_experiment') -``` - -### Overriding Treatment Variants - -During development, for example, it is useful to force a treatment for an -experiment. This can be achieved with the `set_override()` and/or `set_overrides()` -methods. These methods can be called before the context is ready. - -```ruby -context.set_override("exp_test_experiment", 1) # force variant 1 of treatment - -context.set_overrides( - 'exp_test_experiment' => 1, - 'exp_another_experiment' => 0, -) -``` - -## Advanced - -### Context Attributes - -Attributes are used to pass meta-data about the user and/or the request. -They can be used later in the Web Console to create segments or audiences. -They can be set using the `set_attribute()` or `set_attributes()` -methods, before or after the context is ready. - -```ruby -context.set_attribute('session_id', session_id) -context.set_attributes( - 'customer_age' => 'new_customer' -) -``` - -### Custom Assignments - -Sometimes it may be necessary to override the automatic selection of a -variant. For example, if you wish to have your variant chosen based on -data from an API call. This can be accomplished using the -`set_custom_assignment()` method. - -```ruby -chosen_variant = 1 -context.set_custom_assignment('experiment_name', chosen_variant) -``` - -If you are running multiple experiments and need to choose different -custom assignments for each one, you can do so using the -`set_custom_assignments()` method. - -```ruby -assignments = [ - 'experiment_name' => 1, - 'another_experiment_name' => 0, - 'a_third_experiment_name' => 2 -] - -context.set_custom_assignments(assignments) -``` - -### Publish - -Sometimes it is necessary to ensure all events have been published to the -A/B Smartly collector, before proceeding. You can explicitly call the -`publish()` methods. - -``` -context.publish -``` - -### Finalize - -The `close()` method will ensure all events have been -published to the A/B Smartly collector, like `publish()`, and will also -"seal" the context, throwing an error if any method that could generate -an event is called. - -``` -context.close -``` - -### Tracking Goals - -```ruby -context.track( - 'payment', - { item_count: 1, total_amount: 1999.99 } -) -``` +The ABsmartly Team