mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
66 lines
2.2 KiB
Markdown
66 lines
2.2 KiB
Markdown
---
|
|
title: Ruby SDK
|
|
---
|
|
|
|
> You will need your `API URL` and your `API token` in order to connect the Client SDK to you Unleash instance. You can find this information in the “Admin” section Unleash management UI. [Read more](../../how-to/how-to-create-api-tokens.mdx)
|
|
|
|
```ruby
|
|
require 'unleash'
|
|
|
|
@unleash = Unleash::Client.new(
|
|
url: '<API url>',
|
|
app_name: 'simple-test',
|
|
custom_http_headers: {'Authorization': '<API token>'},
|
|
)
|
|
```
|
|
|
|
### Sample usage {#sample-usage}
|
|
|
|
To evaluate a feature toggle, you can use:
|
|
|
|
```ruby
|
|
if @unleash.is_enabled? "AwesomeFeature", @unleash_context
|
|
puts "AwesomeFeature is enabled"
|
|
end
|
|
```
|
|
|
|
If the feature is not found in the server, it will by default return false. However you can override that by setting the default return value to `true`:
|
|
|
|
```ruby
|
|
if @unleash.is_enabled? "AwesomeFeature", @unleash_context, true
|
|
puts "AwesomeFeature is enabled by default"
|
|
end
|
|
```
|
|
|
|
Alternatively by using `if_enabled` you can send a code block to be executed as a parameter:
|
|
|
|
```ruby
|
|
@unleash.if_enabled "AwesomeFeature", @unleash_context, true do
|
|
puts "AwesomeFeature is enabled by default"
|
|
end
|
|
```
|
|
|
|
### Variations {#variations}
|
|
|
|
If no variant is found in the server, use the fallback variant.
|
|
|
|
```ruby
|
|
fallback_variant = Unleash::Variant.new(name: 'default', enabled: true, payload: {"color" => "blue"})
|
|
variant = @unleash.get_variant "ColorVariants", @unleash_context, fallback_variant
|
|
|
|
puts "variant color is: #{variant.payload.fetch('color')}"
|
|
```
|
|
|
|
## Client methods {#client-methods}
|
|
|
|
| Method Name | Description | Return Type |
|
|
| --- | --- | --- |
|
|
| `is_enabled?` | Check if feature toggle is to be enabled or not. | Boolean |
|
|
| `enabled?` | Alias to the `is_enabled?` method. But more ruby idiomatic. | Boolean |
|
|
| `if_enabled` | Run a code block, if a feature is enabled. | `yield` |
|
|
| `get_variant` | Get variant for a given feature | `Unleash::Variant` |
|
|
| `shutdown` | Save metrics to disk, flush metrics to server, and then kill ToggleFetcher and MetricsReporter threads. A safe shutdown. Not really useful in long running applications, like web applications. | nil |
|
|
| `shutdown!` | Kill ToggleFetcher and MetricsReporter threads immediately. | nil |
|
|
|
|
Read more at [github.com/Unleash/unleash-client-ruby](https://github.com/Unleash/unleash-client-ruby)
|