Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amit-singh-bisht/launchdarkly_api_helper_ruby
LaunchDarklyApiHelper provides you a way to access your Launch Darkly account using API token to view, edit or delete them accordingly.
https://github.com/amit-singh-bisht/launchdarkly_api_helper_ruby
api-client api-client-ruby feature-flags feature-toggle launchdarkly launchdarkly-api launchdarkly-api-automation launchdarkly-automation ruby
Last synced: 11 days ago
JSON representation
LaunchDarklyApiHelper provides you a way to access your Launch Darkly account using API token to view, edit or delete them accordingly.
- Host: GitHub
- URL: https://github.com/amit-singh-bisht/launchdarkly_api_helper_ruby
- Owner: amit-singh-bisht
- License: mit
- Created: 2022-11-18T05:41:25.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-21T06:39:47.000Z (almost 2 years ago)
- Last Synced: 2024-10-20T20:26:34.349Z (about 1 month ago)
- Topics: api-client, api-client-ruby, feature-flags, feature-toggle, launchdarkly, launchdarkly-api, launchdarkly-api-automation, launchdarkly-automation, ruby
- Language: Ruby
- Homepage: https://rubygems.org/gems/launchdarkly_api_helper
- Size: 75.2 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# LaunchdarklyApiHelper
[LaunchDarklyApiHelper](https://rubygems.org/gems/launchdarkly_api_helper) provides you a way to access your [Launch Darkly](https://apidocs.launchdarkly.com/) account using [API token](https://app.launchdarkly.com/settings/authorization/tokens/new) to view, edit or delete them accordingly.
[Launch Darkly API Documentation](https://apidocs.launchdarkly.com/)
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add launchdarkly_api_helper
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install launchdarkly_api_helper
## Usage
add `require 'launchdarkly_api_helper'` line at the beginning of your Ruby file
add `include LaunchdarklyApiHelper` line to access LaunchdarklyApiHelper module in gem _launchdarkly_api_helper_
To perform any operations such as add, remove, replace, move, copy, test you should have a working knowledge of [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902)
Projects allow you to manage multiple different software projects under one LaunchDarkly account. Each project has its own unique set of environments and feature flags. To learn more, read [Projects](https://docs.launchdarkly.com/home/organize/projects)
### [Set Access Token](https://apidocs.launchdarkly.com/tag/Access-tokens)
**_parameters for `ld_access_token` method_**
- **access_token (*required)**: this token will be used to send all requests to LaunchDarkly (string)
- **project_name**: provide project name of your organization (NOTE: for most, it should be `default` unless you have made some explicit changes)
- **log_file**: all logs will be written to file 'launchdarkly.log' by default if no file name specified (string)
```ruby
# set your LD API token and log file to capture logs
def ld_access_token(access_token, project_name = 'default', log_file = 'launchdarkly.log')
# code ...
end
```
### [Create a feature flag](https://apidocs.launchdarkly.com/tag/Feature-flags/#operation/postFeatureFlag)
Sample: `https://app.launchdarkly.com/api/v2/flags/`
Example: `https://app.launchdarkly.com/api/v2/flags/default`
Here, `default` is our Project name - eg. AmitSinghBisht
parameters:
- **key (*required)**: A unique key used to reference the feature flag in your code (string)
- **name (*required)**: A human-friendly name for the feature flag (string)
- **description**: Description of the feature flag. Defaults to an empty string (string)
- **tags**: Tags for the feature flag. Defaults to an empty array (Array of strings)
- **variations**: An array of possible variations for the flag. The variation values must be unique. If omitted, two boolean variations of true and false will be used (Array of objects)
- **defaults**
- **onVariation** (*required): The index, from the array of variations for this flag, of the variation to serve by default when targeting is on (integer)
- **offVariation** (*required): The index, from the array of variations for this flag, of the variation to serve by default when targeting is off (integer)
```ruby
{
"key": "developer_flag_for_regression",
"name": "developer_flag_for_regression",
"description": "developer_flag_for_regression is created via regression api on 18_10_2022",
"tags": [
"created_via_regression_api_on_18_10_2022"
],
"variations": [
{
"age": 10
},
{
"age": 20
}
],
"defaults": {
"onVariation": 1,
"offVariation": 0
}
}
```
Above code will create a key `developer_flag_for_regression` with name as `developer_flag_for_regression` and description as `developer_flag_for_regression is created via regression api on 18_10_2022`
Variations are provided while creating key, by default variation is a boolean value (true and false). **once flag with a specific variation is created, its type cannot be modified later, hence choose your variation type smartly (Boolean, String, Number, JSON)** In above example we are creating a flag with JSON type and its two values are 'age': 10 and 'age': 20
Also, variation has by default two values, and you must also define two variations while creating your own custom feature flag
Default will specify which variation to serve when flag is on or off. In above example when flag is turned on, '1' variation is served [Note: 0 and 1 are index position], so variations at first index ie variations[1] will be served when flag is turned on ie 'age': 20
**_parameters for `ld_create_flag` method_**
- **key (*required)**: A unique key used to reference the feature flag in your code (string)
- **name**: A human-friendly name for the feature flag (string)
- **description**: Description of the feature flag. Defaults to an empty string (string)
- **tags**: Tags for the feature flag. Defaults to an empty array (Array of strings)
```ruby
# this method will create a new feature flag, NOTE: feature falg are created at global level and environment resides inside feature flag
def ld_create_flag(key, name = key, description = key, tags = ['created_via_regression_api'])
# code ...
end
```
**_@return parameter_**: (response of feature flag details)
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}` (string)
### [Get feature flag](https://apidocs.launchdarkly.com/tag/Feature-flags#operation/getFeatureFlag)
Sample: `https://app.launchdarkly.com/api/v2/flags//`
Example: `https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression`
**1. GET FEATURE FLAG DETAILS**
Here, `developer_flag_for_regression` is the feature flag name and `default` is our Project name - eg. AmitSinghBisht
By default, this returns the configurations for all environments
You can filter environments with the env query parameter. For example, setting env=staging restricts the returned configurations to just the staging environment
`https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression?env=staging`
**_parameters for `ld_fetch_flag_details` method_**
- **env** (*required): name of the environment for which you want to get the details (string)
- **flag** (*required): name of the feature flag for which you want to get the details (string)
```ruby
# this method will give you entire details about a flag for that particular environment
def ld_fetch_flag_details(env, flag)
# code ...
end
```
**_@return parameter_**: (response of feature flag details)
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}` (string)
**2. GET FEATURE FLAG TOGGLE STATUS DETAILS**
**_parameters for `ld_fetch_flag_details` method_**
- **env** (*required): name of the environment for which you want to get the details (string)
- **flag** (*required): name of the feature flag for which you want to get the details (string)
```ruby
# this method will return the status of the flag, whether it is on or off viz set to true or false
def ld_fetch_flag_toggle_status(env, flag)
# code ...
end
```
**_@return parameter_**: (response of feature flag toggle status viz. response_on)
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}`
- response_on = `response['environments'][env]['on']` (boolean)
**3. GET FEW IMPORTANT PARAMETERS FROM FEATURE FLAG**
**_parameters for `ld_fetch_flag_details` method_**
- **env** (*required): name of the environment for which you want to get the details (string)
- **flag** (*required): name of the feature flag for which you want to get the details (string)
```ruby
# this method will get important parameters from the response
def flag_variation_served(env, flag)
# code ...
end
```
**@returns**: [fetch_flag_toggle_status_response, feature_flag_variation_index_response, feature_flag_variation_value_response, feature_flag_variation_name_response]
**_@return parameter_**:
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}`
- fetch_flag_toggle_status_response: `response['environments'][#{env}]['on']` (boolean)
- feature_flag_variation_index_response: `response` (integer)
- feature_flag_variation_value_response: `response['variations'][#{feature_flag_variation_index_response}]['value']` (string)
- feature_flag_variation_name_response: `response['variations'][#{feature_flag_variation_index_response}]['name']` (string)
### [Update feature flag](https://apidocs.launchdarkly.com/tag/Feature-flags#operation/patchFeatureFlag)
Sample: `https://app.launchdarkly.com/api/v2/flags//`
Example: `https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression`
**1. UPDATE FEATURE FLAG TOGGLE STATUS**
Here, `developer_flag_for_regression` is the flag key and `default` is our Project name - eg. AmitSinghBisht
You can update any parameter of feature flag using this method
**_parameters for `ld_toggle_specific_environment` method_**
- **env** (*required): name of the environment for which you want to get the details (string)
- **flag** (*required): name of the feature flag for which you want to get the details (string)
- **flag_value**: status of the feature flag that you want to set either on (true) or off (false) (boolean)
```ruby
# this method will be used to toggle status of feature flag either on / off for a particular environment
def ld_toggle_specific_environment(env, flag, flag_value = true)
# code ...
end
```
**_@return parameter_**: (response of feature flag toggle status viz. response_on)
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}`
- response_on = `response['environments'][env]['on']` (boolean)
**2. UPDATE FEATURE FLAG VALUES INSIDE CLAUSES INSIDE RULES**
```ruby
"rules": [
{ # rules/0
"variation": 0,
"clauses": [
{ # rules/0/clauses/0
"attribute": "groups",
"op": "in",
"values": ["Top Customers"],
"negate": false
},
{ # rules/0/clauses/1
"attribute": "email",
"op": "endsWith",
"values": ["gmail.com"],
"negate": false
}
]
},
{ # rules/1
"variation": 1,
"clauses": [
{ # rules/1/clauses/0
"attribute": "country",
"op": "in",
"values": [
"in", # rules/1/clauses/0/values/0
"eu" # rules/1/clauses/0/values/1
],
"negate": false
}
]
}
]
```
**2.a. TO UPDATE FEATURE FLAG - FIRST, GET THE INDEX OF RULES AND CLAUSE INSIDE WHICH VALUE RESIDES**
**_parameters for `ld_rules_clauses_index` method_**:
- **env** (*required): name of the environment for which you want to get the details (string)
- **flag** (*required): name of the feature flag for which you want to get the details (string)
- **clause_name** (*required): name of clause that you want to search for in response (string)
```ruby
# this method will return the index of rules and clauses by searching for clause_name in response
def ld_rules_clauses_index(env, flag, clause_name)
# code ...
end
```
**@returns**: [rule_at_index, clause_at_index]
**_@return parameter_**:
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}`
- response_rules = `response['environments'][#{env}]['rules']`
- rule_at_index = `response_rules[rule_index]` (integer) # index at which rule is found
- clause_at_index = `response_rules[rule_index]['clauses'][clause_index]` (integer) # index at which clause is found
**2.b. GET VALUES INSIDE A CLAUSE BY ITERATING THROUGH REQUIRED INDEX OF RULES AND CLAUSES**
**_parameters for `ld_get_values_from_clauses` method_**:
- **env** (*required): name of the environment for which you want to get the details (string)
- **flag** (*required): name of the feature flag for which you want to get the details (string)
- **clause_name** (*required): name of clause that you want to search for in response (string)
```ruby
# this method will return values inside a particular clause by searching for clause_name in response
def ld_get_values_from_clauses(env, flag, clause_name)
# code ...
end
```
**@return parameter**: values_for_clause_name
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}`
- response_rules = `response['environments'][#{env}]['rules']`
- values_for_clause_name = `response_rules[rule_at_index]['clauses'][clause_at_index]['values']` (string)
**2.c. ADD VALUES TO A PARTICULAR CLAUSE**
**_parameters for `ld_add_values_to_clause` method_**:
- **env** (*required): name of the environment for which you want to get the details (string)
- **flag** (*required): name of the feature flag for which you want to get the details (string)
- **clause_name** (*required): name of clause that you want to search for in response (string)
- **clause_value** (*required): value that you want to add to a particular clause (NOTE: it will be appended at zeroth 0th index) (string or number or json or object)
```ruby
# this method will help you to add a value to a particular clause by searching for clause_name in response
def ld_add_values_to_clause(env, flag, clause_name, clause_value)
# code ...
end
```
**@return parameter**: (response of feature flag details viz. updated_clause_value)
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}`
- response_rules = `response['environments'][#{env}]['rules']`
- updated_clause_value = `response_rules[rule_at_index]['clauses'][clause_at_index]['values']` (string)
**2.d. DELETE VALUES TO A PARTICULAR CLAUSE**
**_parameters for `ld_remove_values_from_clause` method_**:
- **env** (*required): name of the environment for which you want to get the details (string)
- **flag** (*required): name of the feature flag for which you want to get the details (string)
- **clause_name** (*required): name of clause that you want to search for in response (string)
- **clause_value** (*required): value that you want to add to a particular clause (NOTE: it will be appended at zeroth 0th index) (string or number or json or object)
```ruby
# this method will help you to remove a value to a particular clause by searching for clause_name in response
def ld_remove_values_from_clause(env, flag, clause_name, clause_value)
# code ...
end
```
**@return parameter**: (response of feature flag details viz. updated_clause_value)
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}`
- response_rules = `response['environments'][#{env}]['rules']`
- updated_clause_value = `response_rules[rule_at_index]['clauses'][clause_at_index]['values']` (string)
### [Delete feature flag](https://apidocs.launchdarkly.com/tag/Feature-flags#operation/deleteFeatureFlag)
Sample: `https://app.launchdarkly.com/api/v2/flags//`
Example: `https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression`
Here, `developer_flag_for_regression` is the flag key and default is our Project name - eg. AmitSinghBisht
You can delete any feature flag using this method
**_parameters for `ld_delete_flag` method_**:
- **flag** (*required): name of the feature flag you want to delete (NOTE: env resided inside flag which means flag is parent, so deleting a feature flag will delete it from all environment) (string)
```ruby
# this method will delete a feature flag in launchdarkly (NOTE: env resided inside flag which means flag is parent, so deleting a feature flag will delete it from all environment)
def ld_delete_flag(flag)
# code ...
end
```
**@return parameter**: (response of feature flag details)
- response = `https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}` (string)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/launchdarkly_api_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/launchdarkly_api_helper/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the LaunchdarklyApiHelper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/launchdarkly_api_helper/blob/master/CODE_OF_CONDUCT.md).