launchdarkly_api_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d2501cb34864b4ae9586a01455dfe28ceb011a7ea1b146d595449e16a1b05ec
+  data.tar.gz: 37ec6115e79b2804cb698cbae919b5ddd533a25e55646abab55c574099d173d1
+SHA512:
+  metadata.gz: 276d0aaaf2df1e706a25e2e163c21cd215d0d238cbc8f9ac811d2f98434d6da65fa87194404a5ca0c3de1c9255bc93fcf0832958004e432eb68fd63a0530a3f6
+  data.tar.gz: 0a05bccf8b2573faf986fd3c53fae9aff85f2b156c7f8ca2edcc7d7f810560207d526cf517fe6d10f5ef137dee9cf946aea8f9b1bb3e1e6fc4fdc483a3b5c846

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 100
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 1000

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at amit.bi@browserstack.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in launchdarkly_api_helper.gemspec
+gemspec
+
+gem 'json'
+gem 'rubocop', '~> 1.21'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Amit Singh Bisht (https://github.com/amit-singh-bisht/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## 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
+
+TODO: Write usage instructions here
+
+## 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).

data/lib/launchdarkly_api_helper/constants.rb

@@ -0,0 +1,24 @@
+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,
+    'code' => 200,
+    'message' => 'OK'
+  },
+  post: {
+    'method' => Net::HTTP::Post,
+    'code' => 201,
+    'message' => 'Created'
+  },
+  patch: {
+    'method' => Net::HTTP::Patch,
+    'code' => 200,
+    'message' => 'OK'
+  },
+  delete: {
+    'method' => Net::HTTP::Delete,
+    'code' => 204,
+    'message' => 'No Content'
+  }
+}.freeze

data/lib/launchdarkly_api_helper/launchdarkly_api_helper_class.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'json'
+require 'net/http'
+require 'logger'
+# require_relative 'constants'
+
+# All methods related to launch darkly api are defined here
+class LaunchdarklyApiHelperClass
+  def initialize(access_token, log_file)
+    @access_token = access_token
+    @logger = Logger.new(log_file)
+  end
+
+  def parse_json(json)
+    puts "json: #{json}"
+    # json.read_body.empty? ? JSON.parse(json) ? JSON.parse(json.read_body)
+  end
+
+  def convert_to_json(hash)
+    JSON.dump(hash)
+  end
+
+  def ld_request(http_method, request_url, request_body = nil)
+    url = URI(request_url)
+    https = Net::HTTP.new(url.host, url.port)
+    https.use_ssl = true
+    request = REQUEST_CLASSES[http_method]['method'].new(url)
+    request['Authorization'] = @access_token
+    request['Content-Type'] = 'application/json'
+    request['LD-API-Version'] = 'beta'
+    case http_method
+    when :get, :patch, :post
+      request.body = convert_to_json(request_body) unless http_method == :get
+      https.request(request)
+    when :delete
+      return https.request(request)
+    else
+      raise StandardError, "Undefined HTTP method #{http_method} found"
+    end
+    response = https.request(request)
+    puts "response: #{response}"
+    JSON.parse(response.read_body)
+  end
+end

data/lib/launchdarkly_api_helper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LaunchdarklyApiHelper
+  VERSION = "0.1.0"
+end

data/lib/launchdarkly_api_helper.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2022 Amit Singh Bisht (https://github.com/amit-singh-bisht/)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'uri'
+require 'json'
+require 'net/http'
+require 'logger'
+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
+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
+
+  def ld_access_token(access_token, log_file = 'launchdarkly.log')
+    @launchdarkly_helper = LaunchdarklyApiHelperClass.new(access_token, 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
+  #
+  # == Here, 'developer_flag_for_regression' is the flag key and default is our Project name - Browserstack
+  # == By default, this returns the configurations for all environments
+  # == You can filter environments with the env query parameter. For example, setting env=k8s restricts the returned configurations to just the k8s environment
+  # https://app.launchdarkly.com/api/v2/flags/default/developer_flag_for_regression?env=k8s
+
+  def fetch_flag(flag, env)
+    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}?env=#{env}"
+    @launchdarkly_helper.ld_request(:get, request_url)
+  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
+
+  def create_flag(key, name: key, description: key, tags: ['created_via_regression_api'])
+    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
+
+  # == 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
+
+  def toggle_flag_for_specific_environment(env, flag, flag_value: true)
+    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']
+  end
+
+  def toggle_variation_served_status(flag, env = ENV['PROFILE'])
+    feature_flag_response = fetch_flag(flag, env)
+    feature_flag_env = feature_flag_response['environments'][env]
+    feature_flag_toggle_status = feature_flag_env['on']
+    feature_flag_variation_index = feature_flag_env['fallthrough']['variation']
+    feature_flag_variation = feature_flag_response['variations'][feature_flag_variation_index]
+    feature_flag_variation_value = feature_flag_variation['value']
+    feature_flag_variation_name = feature_flag_variation['name']
+    [feature_flag_toggle_status, feature_flag_variation_value, feature_flag_variation_name]
+  end
+
+  def search_value_in_hash(feature_flag_hash, attribute)
+    value_at_index = -1
+    feature_flag_hash.length.times do |index|
+      next unless feature_flag_hash[index].to_s.include? attribute.to_s
+
+      value_at_index = index
+      break
+    end
+    value_at_index
+  end
+
+  def feature_flag_rules_clauses_index(flag, attribute, env = ENV['PROFILE'])
+    @feature_flag_response = fetch_flag(flag, env)
+    feature_flag_env = @feature_flag_response['environments'][env]
+    @feature_flag_env_rules = feature_flag_env['rules']
+    rule_index = search_value_in_hash(@feature_flag_env_rules, attribute)
+    @feature_flag_env_rules_clauses = @feature_flag_env_rules[rule_index]['clauses']
+    clause_index = search_value_in_hash(@feature_flag_env_rules_clauses, attribute)
+    [rule_index, clause_index]
+  end
+
+  def feature_flag_add_values_to_rules(flag, attribute, value, env = ENV['PROFILE'])
+    @flag = flag
+    @attribute = attribute
+    @value = value
+    @rule_index, @clause_index = feature_flag_rules_clauses_index(flag, attribute)
+    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    request_body = { 'op' => 'add', 'path' => "/environments/#{env}/rules/#{@rule_index}/clauses/#{@clause_index}/values/0", 'value' => value }
+    ld_request(:patch, request_url, [request_body])
+  end
+
+  def feature_flag_remove_values_to_rules(flag = @flag, attribute = @attribute, value = @value, env = ENV['PROFILE'])
+    @rule_index, @clause_index = feature_flag_rules_clauses_index(flag, attribute, env = ENV['PROFILE']) unless flag || attribute
+    feature_flag_env_rules_clauses_values = @feature_flag_env_rules_clauses[@clause_index]['values']
+    value_index = search_value_in_hash(feature_flag_env_rules_clauses_values, value)
+    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    request_body = { 'op': 'test', 'path': "/environments/#{env}/rules/#{@rule_index}/clauses/#{@clause_index}/values/#{value_index}", 'value': value }, { 'op' => 'remove', 'path' => "/environments/#{env}/rules/#{@rule_index}/clauses/#{@clause_index}/values/#{value_index}" }
+    ld_request(:patch, request_url, request_body)
+  end
+
+  def delete_flag(flag)
+    request_url = "#{LAUNCH_DARKLY_FLAGS}/#{flag}"
+    ld_request(:delete, request_url)
+  end
+end
+
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: launchdarkly_api_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- amit-singh-bisht
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-18 00:00:00.000000000 Z
+dependencies: []
+description: Write a longer description or delete this line.
+email:
+- bishtamitsingh98@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/launchdarkly_api_helper.rb
+- lib/launchdarkly_api_helper/constants.rb
+- lib/launchdarkly_api_helper/launchdarkly_api_helper_class.rb
+- lib/launchdarkly_api_helper/version.rb
+homepage: https://github.com/amit-singh-bisht/launchdarkly_api_helper_ruby
+licenses:
+- MIT
+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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []