launchdarkly_api_helper 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abb4c77aacd498e9201d80704cf76ace0ba1b212cb5c5b03048f7001b67a67e8
-  data.tar.gz: ad9a07e50ecf11c8bb9c2fc83dc7fffef0d5a79b5ad4214e5827e6775b07be40
+  metadata.gz: cc0c1b25efd8bceafce66fca401b054433d58bd16057952a5af5454f71c723aa
+  data.tar.gz: 2366bb57ed059ea241df1488c3300fd2ccd2f7803a03a04dd90915c199f7fab4
 SHA512:
-  metadata.gz: ab867dfc84d5a8cf1828efb1f195ce497456aac14ba46cecd71862cf5353c77c421d350ad4d44283dc114abf9e587e5792e86119037dc06f06eab35b8a2bc50c
-  data.tar.gz: 6206c419f1eafd0095626e743b08aec2f98b4f16a2d39eac0861966dba002b5932473cbc379100e1d7877e53cf41abd23e9fc481cc42377cf4f33e13d321c5d0
+  metadata.gz: 31921892456f509b895c2119873daa5b6a9d8d566baacc6721f1e5b307d7413156e7100dd8a890606621433305ea43def942d86d0ab01fe98ef660febd55f51f
+  data.tar.gz: 8ed558e1a93bf0f3e1b42b17ea767f700436b73438aa48eb02de30598f0683c020f98a97172e39249a6c474a0cbcac7c85d806b47a4095c59cf336264b1cd985

data/README.md

@@ -1,4 +1,12 @@
-# LaunchdarklyApiHelper ![alt_text](https://badge.fury.io/rb/launchdarkly_api_helper.svg)
+# LaunchdarklyApiHelper 
+<div>
+    <a href="https://rubygems.org/gems/launchdarkly_api_helper">
+        <img alt="GEM Version" src="https://img.shields.io/gem/v/launchdarkly_api_helper?color=38C160&logo=ruby&logoColor=FE1616">
+    </a>
+    <a href="https://rubygems.org/gems/launchdarkly_api_helper">
+        <img alt="Gem Downloads" src="https://img.shields.io/gem/dt/launchdarkly_api_helper?color=38C160&logo=ruby&logoColor=FE1616">
+    </a>
+</div>
 
 [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.
 
@@ -27,7 +35,7 @@ To perform any operations such as add, remove, replace, move, copy, test you sho
 ```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)
+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)
 
 # set your LD API token and log file to capture logs
@@ -261,7 +269,8 @@ def ld_add_values_to_clause(env, flag, clause_name, clause_value)
 end
 
 @return parameter: (response of feature flag details)
-response = "https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}" (string)
+response = "https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}"
+response[rule_at_index]['clauses'][clause_at_index]['values'] (string)
 ```
 
 ```ruby
@@ -277,7 +286,8 @@ def ld_remove_values_from_clause(env, flag, clause_name, clause_value)
 end
 
 @return parameter: (response of feature flag details)
-response = "https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}" (string)
+response = "https://app.launchdarkly.com/api/v2/flags/default/#{flag}?env=#{env}"
+response[rule_at_index]['clauses'][clause_at_index]['values'] (string)
 ```
 
 ```ruby

data/lib/launchdarkly_api_helper/version.rb

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

data/lib/launchdarkly_api_helper.rb

@@ -25,145 +25,61 @@
 require_relative 'launchdarkly_api_helper/constants'
 require_relative 'launchdarkly_api_helper/launchdarkly_api_helper_class'
 
-# All methods related to launch darkly api are defined here
+# LaunchDarklyApiHelper provides you a way to access your Launch Darkly account using API token to view, edit or delete them accordingly.
 module LaunchdarklyApiHelper
   class Error < StandardError; end
 
-  # == LaunchDarkly REST API
-  # https://apidocs.launchdarkly.com/
-  # == 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
-
+  # set your LD API token and log file to capture logs
   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
-  # https://apidocs.launchdarkly.com/tag/Feature-flags#operation/getFeatureFlag
-  #
-  # == GET REQUEST
-  # https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression
-  #
-  # == key (*required)
-  # env, flag
-  #
-  # == 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)
     @launchdarkly_helper.fetch_flag_details(env, flag)
   end
 
-  # == Get toggle status feature flag
-  #
-  # == key (*required)
-  # env, flag
-  #
-  # 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)
     @launchdarkly_helper.fetch_flag_toggle_status(env, flag)
   end
 
-  # == 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 - Browserstack
-  #
-  # key (*required): A unique key used to reference the 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'])
     @launchdarkly_helper.create_flag(key, name, description, tags)
   end
 
-  # == 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
-  #
-  # key (*required)
-  #
-  # == Here, 'developer_flag_for_regression' is the flag key and default is our Project name - Browserstack
-  # == 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)
     @launchdarkly_helper.toggle_specific_environment(env, flag, flag_value)
   end
 
-  # == Get status of feature flag
-  # https://apidocs.launchdarkly.com/tag/Feature-flags#operation/patchFeatureFlag
-  #
-  # [fetch_flag_toggle_status_response, feature_flag_variation_index_response, feature_flag_variation_value_response, feature_flag_variation_name_response]
-
+  # this method will get important parameters from the response
   def ld_flag_variation_served(env, flag)
     @launchdarkly_helper.flag_variation_served(env, flag)
   end
 
+  # 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)
     @launchdarkly_helper.rules_clauses_index(env, flag, clause_name)
   end
 
+  # 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)
     @launchdarkly_helper.get_values_from_clauses(env, flag, clause_name)
   end
 
+  # 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)
     @launchdarkly_helper.add_values_to_clause(env, flag, clause_name, clause_value)
   end
 
+  # 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)
     @launchdarkly_helper.remove_values_from_clause(env, flag, clause_name, clause_value)
   end
 
+  # 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)
     @launchdarkly_helper.delete_flag(flag)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: launchdarkly_api_helper
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - amit-singh-bisht
@@ -10,7 +10,8 @@ bindir: exe
 cert_chain: []
 date: 2022-11-19 00:00:00.000000000 Z
 dependencies: []
-description: Write a longer description or delete this line.
+description: LaunchDarklyApiHelper provides you a way to access your Launch Darkly
+  account using API token to view, edit or delete them accordingly. https://amit-singh-bisht.github.io/launchdarkly_api_helper_ruby/
 email:
 - bishtamitsingh98@gmail.com
 executables: []
@@ -52,5 +53,6 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: LaunchDarklyApiHelper provides you a way to access your Launch Darkly account
+  using API token to view, edit or delete them accordingly. https://amit-singh-bisht.github.io/launchdarkly_api_helper_ruby/
 test_files: []