launchdarkly_api_helper 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce783cd020dfb08afa37d2c2def2a34e637ac5206372cde1e33692fce4fc7e9c
-  data.tar.gz: 001f9d326e6361449587ac36107296af04e02cacc1d238c903a7622cb9af718f
+  metadata.gz: b32c8619c0d002bd0974ae86f4172b4caa5733633919373d74956df9016a02f8
+  data.tar.gz: aa4328e4904f808b0588c02ecaf04068cc2a6d6a523500dd56a9acda0d872efd
 SHA512:
-  metadata.gz: 97992fe3501448666a630a59f779e35228fe75afa9e2b57d55396d56e2a8917caac50f232041bb5c59e6d9f356093628c4730db192dca2225bbd384323f57e0f
-  data.tar.gz: ebb0edb818fb938053a390ee8680d6fe6e309a6433c634ad2cd0e9de93220577584db74aa5157ea643b6f0a19f8ba70591e780493cce4fb0e6d776546cd7b628
+  metadata.gz: f411f430c4c844dbb4845d678ab77d0fffbc1a0f34cec14246de70e80d1f8ab787e6e3497678abaf85fb1fea61e3f6a296f7f8892f597864724d40ab13190542
+  data.tar.gz: f851657526a6d3efb998159ef78920882dedfab9f71bdd10597c0db0fe49a3885cdfc5b963ac6e244a32a074ddad0112904ad7199e9f6912f4967b917748f234

data/README.md

@@ -1,8 +1,10 @@
-# LaunchdarklyApiHelper
+# LaunchdarklyApiHelper ![alt_text](https://badge.fury.io/rb/launchdarkly_api_helper.svg)
 
-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,289 @@ 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)
+project_name: provide project name of your organistaion (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)
+
+# 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
+```
+
+[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
+
+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:
+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)
+
+# 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)
+```
+
+```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)
+
+# 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)
+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
+
+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:
+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)
+
+# 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)
+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
+
+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)
+
+# 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)
+```
+
+```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
+      }
+    ]
+  }
+]
+
+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)
+clause_name (*required): name of clause that you want to search for in response
+
+# 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}" ['environments'][env]['rules']
+rule_at_index = response[rule_index]  (integer) # index at which rule is found
+clause_at_index = response[rule_index]['clauses'][clause_index]  (integer) # index at which clause is found 
+```
+
+```ruby
+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)
+clause_name (*required): name of clause that you want to search for in response
+
+# 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}" ['environments'][env]['rules']
+values_for_clause_name = response[rule_at_index]['clauses'][clause_at_index]['values'] (string)
+```
+
+```ruby
+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)
+clause_name (*required): name of clause that you want to search for in response
+clause_value (*required): value that you want to add to a particular clause (NOTE: it will be appened at zeroth 0th index)
+
+# 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)
+response = "https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}" (string)
+```
+
+```ruby
+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)
+clause_name (*required): name of clause that you want to search for in response
+clause_value (*required): value that you want to add to a particular clause (NOTE: it will be appened at zeroth 0th index)
+
+# 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)
+response = "https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}" (string)
+```
+
+```ruby
+Delete feature flag
+https://apidocs.launchdarkly.com/tag/Feature-flags#operation/deleteFeatureFlag
+
+DELETE REQUEST
+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:
+flag (*required): name of the feature flag for which you want to get the details (string)
+
+# 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
 

data/lib/launchdarkly_api_helper/constants.rb

@@ -1,5 +1,3 @@
-LAUNCH_DARKLY_FLAGS = 'https://app.launchdarkly.com/api/v2/flags/default'.freeze
-LAUNCH_DARKLY_PROJECTS = 'https://app.launchdarkly.com/api/v2/projects/default'.freeze
 REQUEST_CLASSES = {
   get: {
     'method' => Net::HTTP::Get,
@@ -21,4 +19,4 @@ REQUEST_CLASSES = {
     'code' => 204,
     'message' => 'No Content'
   }
-}.freeze
+}.freeze

data/lib/launchdarkly_api_helper/launchdarkly_api_helper_class.rb

@@ -8,8 +8,12 @@ require_relative 'constants'
 
 # All methods related to launch darkly api are defined here
 class LaunchdarklyApiHelperClass
-  def initialize(access_token, log_file)
+
+  @launch_darkly_flags = 'https://app.launchdarkly.com/api/v2/flags/project_name'
+
+  def initialize(access_token, project_name, log_file)
     @access_token = access_token
+    @launch_darkly_flags.gsub! 'project_name', project_name
     @logger = Logger.new(log_file)
   end
 
@@ -43,7 +47,7 @@ class LaunchdarklyApiHelperClass
   end
 
   def fetch_flag_details(env, flag)
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}?env=#{env}"
+    request_url = "#{@launch_darkly_flags}/#{flag}?env=#{env}"
     ld_request(:get, request_url)
   end
 
@@ -53,14 +57,14 @@ class LaunchdarklyApiHelperClass
   end
 
   def create_flag(key, name, description, tags)
-    request_url = LAUNCH_DARKLY_FLAGS
+    request_url = @launch_darkly_flags
     request_body = {}
     request_body.merge!(key: key, name: name, description: description, tags: tags)
     ld_request(:post, request_url, request_body)
   end
 
   def toggle_specific_environment(env, flag, flag_value)
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    request_url = "#{@launch_darkly_flags}/#{flag}"
     request_body = { 'op' => 'replace', 'path' => "/environments/#{env}/on", 'value' => flag_value }
     response_body = ld_request(:patch, request_url, [request_body])
     response_body['environments'][env]['on']
@@ -86,7 +90,7 @@ class LaunchdarklyApiHelperClass
     details_response['variations'][index_response]['name']
   end
 
-  def ld_toggle_variation_served(env, flag)
+  def flag_variation_served(env, flag)
     details_response = fetch_flag_details(env, flag)
     toggle_status_response = fetch_flag_toggle_status(env, flag)
     variation_index_response = feature_flag_variation_index(toggle_status_response, details_response) # ['environments'][env]['fallthrough']['variation']
@@ -130,29 +134,29 @@ class LaunchdarklyApiHelperClass
   end
 
   def get_values_from_clauses(env, flag, clause_name)
-    rule_at_index, clause_at_index = feature_flag_rules_clauses_index(env, flag, clause_name)
+    rule_at_index, clause_at_index = rules_clauses_index(env, flag, clause_name)
     @feature_flag_rules_list[rule_at_index]['clauses'][clause_at_index]['values']
   end
 
   def add_values_to_clause(env, flag, clause_name, clause_value)
-    rule_at_index, clause_at_index = feature_flag_rules_clauses_index(env, flag, clause_name)
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    rule_at_index, clause_at_index = rules_clauses_index(env, flag, clause_name)
+    request_url = "#{@launch_darkly_flags}/#{flag}"
     request_body = { 'op' => 'add', 'path' => "/environments/#{env}/rules/#{rule_at_index}/clauses/#{clause_at_index}/values/0", 'value' => clause_value }
     ld_request(:patch, request_url, [request_body])
   end
 
   def remove_values_from_clause(env, flag, clause_name, clause_value)
-    rule_at_index, clause_at_index = feature_flag_rules_clauses_index(env, flag, clause_name)
+    rule_at_index, clause_at_index = rules_clauses_index(env, flag, clause_name)
     value_at_index = search_value_index(rule_at_index, clause_at_index, clause_value)
     puts "value_index: #{value_at_index}"
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    request_url = "#{@launch_darkly_flags}/#{flag}"
     request_body = { 'op' => 'test', 'path' => "/environments/#{env}/rules/#{rule_at_index}/clauses/#{clause_at_index}/values/#{value_at_index}", 'value' => clause_value },
                    { 'op' => 'remove', 'path' => "/environments/#{env}/rules/#{rule_at_index}/clauses/#{clause_at_index}/values/#{value_at_index}" }
     ld_request(:patch, request_url, request_body)
   end
 
   def delete_flag(flag)
-    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    request_url = "#{@launch_darkly_flags}/#{flag}"
     ld_request(:delete, request_url)
   end
 end

data/lib/launchdarkly_api_helper/version.rb

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

data/lib/launchdarkly_api_helper.rb

@@ -34,8 +34,8 @@ module LaunchdarklyApiHelper
   # == 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
 
-  def ld_access_token(access_token, log_file = 'launchdarkly.log')
-    @launchdarkly_helper = LaunchdarklyApiHelperClass.new(access_token, log_file)
+  def ld_access_token(access_token, project_name = 'default', log_file = 'launchdarkly.log')
+    @launchdarkly_helper = LaunchdarklyApiHelperClass.new(access_token, project_name, log_file)
   end
 
   # == Get feature flag
@@ -144,8 +144,8 @@ module LaunchdarklyApiHelper
   #
   # [fetch_flag_toggle_status_response, feature_flag_variation_index_response, feature_flag_variation_value_response, feature_flag_variation_name_response]
 
-  def ld_toggle_variation_served(env, flag)
-    @launchdarkly_helper.ld_toggle_variation_served(env, flag)
+  def ld_flag_variation_served(env, flag)
+    @launchdarkly_helper.flag_variation_served(env, flag)
   end
 
   def ld_rules_clauses_index(env, flag, clause_name)
@@ -160,7 +160,7 @@ module LaunchdarklyApiHelper
     @launchdarkly_helper.add_values_to_clause(env, flag, clause_name, clause_value)
   end
 
-  def ld__remove_values_from_clause(env, flag, clause_name, clause_value)
+  def ld_remove_values_from_clause(env, flag, clause_name, clause_value)
     @launchdarkly_helper.remove_values_from_clause(env, flag, clause_name, clause_value)
   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.5.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:
@@ -33,7 +33,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/amit-singh-bisht/launchdarkly_api_helper_ruby
   source_code_uri: https://github.com/amit-singh-bisht/launchdarkly_api_helper_ruby
-  changelog_uri: https://github.com/amit-singh-bisht/launchdarkly_api_helper_ruby/blob/main/README.md
+  changelog_uri: https://github.com/amit-singh-bisht/launchdarkly_api_helper_ruby/blob/master/README.md
 post_install_message: 
 rdoc_options: []
 require_paths: