launchdarkly_api_helper 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce783cd020dfb08afa37d2c2def2a34e637ac5206372cde1e33692fce4fc7e9c
-  data.tar.gz: 001f9d326e6361449587ac36107296af04e02cacc1d238c903a7622cb9af718f
+  metadata.gz: f063313104693353f6dd3e18a6ecd69c5142b62eb3f072b08f96b8b51e9175e0
+  data.tar.gz: 1f83a4dc6665e8864605decdb1d265178232785d44cca584488533fe21bd4ce6
 SHA512:
-  metadata.gz: 97992fe3501448666a630a59f779e35228fe75afa9e2b57d55396d56e2a8917caac50f232041bb5c59e6d9f356093628c4730db192dca2225bbd384323f57e0f
-  data.tar.gz: ebb0edb818fb938053a390ee8680d6fe6e309a6433c634ad2cd0e9de93220577584db74aa5157ea643b6f0a19f8ba70591e780493cce4fb0e6d776546cd7b628
+  metadata.gz: e9fadbf1588e1d429f3cf3d1bf9bcccf6b06bda032baa707970a65714321a970e8e5d8f952baa99be5115e4986564c45bbcfcc07034f829637522569e5fd9f15
+  data.tar.gz: b947d46ef24947acba122a57ce2e2c582af6342806e357de59864523ba4b8e78e9d81185dc6f51d4b183621d94b97d206840d020dc5226731db866ef77a25c7a

data/README.md

@@ -1,8 +1,10 @@
 # LaunchdarklyApiHelper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/launchdarkly_api_helper`. To experiment with that code, run `bin/console` for an interactive prompt.
+[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.
 
-TODO: Delete this and the text above, and describe your gem
+![alt text](https://docs.launchdarkly.com/static/de107a76f0cd388da14d5bd650ec1f5c/b8471/settings-access-tokens-obscured-callout.png)
+
+[Launch Darkly API Documentation](https://apidocs.launchdarkly.com/)
 
 ## Installation
 
@@ -16,7 +18,193 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+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)
+
+```ruby
+parameters:
+access_token (*required): this token will be used to send all requests to LaunchDarkly (string)
+log_file: all logs will be writeen to file 'launchdarkly.log' by default if no file name specified
+
+# set your LD API token and log file to capture logs
+def ld_access_token(access_token, log_file = 'launchdarkly.log') 
+  # code ...
+end
+```
+
+[Get feature flag](https://apidocs.launchdarkly.com/tag/Feature-flags#operation/getFeatureFlag)
+
+```ruby
+GET REQUEST
+https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression
+
+parameters:
+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)
+                                             
+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
+
+# this method will give you entire details about a flag for that particular environment
+def ld_fetch_flag_details(env, flag)
+  # code ...
+end
+
+@return value (response of feature flag details):
+response = "https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}" (string)
+```
+
+```ruby
+Get toggle status feature flag
+
+parameters:
+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)
+
+response = https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression?env=staging
+grab the value of the ['environments'][env]['on'] obtained from the above response
+
+# 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 value (response of feature flag toggle status):
+response = "https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}"
+response['environments'][env]['on'] (boolean)
+```
+
+```ruby
+Create a feature flag
+https://apidocs.launchdarkly.com/tag/Feature-flags/#operation/postFeatureFlag
+
+POST REQUEST
+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)
+
+{
+  "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
+
+# 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
+```
+
+```ruby
+Update feature flag
+https://apidocs.launchdarkly.com/tag/Feature-flags#operation/patchFeatureFlag
+
+PATCH REQUEST
+https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression
+
+parameters:
+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)
+
+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
+
+# 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 value (response of feature flag toggle status):
+response = "https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}"
+response['environments'][env]['on'] (boolean)
+```
+
+```ruby
+Get status of feature flag
+https://apidocs.launchdarkly.com/tag/Feature-flags#operation/patchFeatureFlag
+ 
+def ld_toggle_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'] (object)
+feature_flag_variation_name_response: response['variations'][feature_flag_variation_index_response]['name'] (string)
+```
+
+```ruby
+def ld_rules_clauses_index(env, flag, clause_name)
+  # code ...
+end
+```
+
+```ruby
+def ld_get_values_from_clauses(env, flag, clause_name)
+  # code ...
+end
+```
+
+```ruby
+def ld_add_values_to_clause(env, flag, clause_name, clause_value)
+  # code ...
+end
+```
+
+```ruby
+def ld__remove_values_from_clause(env, flag, clause_name, clause_value)
+  # code ...
+end
+```
+
+```ruby
+def ld_delete_flag(flag)
+  # code ...
+end
+```
 
 ## Development
 

data/lib/launchdarkly_api_helper/constants.rb

@@ -21,4 +21,4 @@ REQUEST_CLASSES = {
     'code' => 204,
     'message' => 'No Content'
   }
-}.freeze
+}.freeze

data/lib/launchdarkly_api_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LaunchdarklyApiHelper
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly_api_helper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - amit-singh-bisht
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies: []
 description: Write a longer description or delete this line.
 email: