flagsmith 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35fb5ceee9613cc9425904d67f7429b82d56fcb42d3bfff4f0adb7c4d7a61ea2
+  data.tar.gz: a3d9a18ac02ad8a5f29f7f1ad116b8c47c563a7754f650320b693b349c3d03bf
+SHA512:
+  metadata.gz: 8b3017bfcf9e4c81965b719e499a992954a3ffb3c4d7984eaeab61befb5074268e2507e7ce57291eeeff59f99ec6dc06ed539f5112be24a97fb0b4eed9dcda4c
+  data.tar.gz: 42bb17bdcf66b4ff8bfdd70abd645c79eae85b60dec89163e4450b1920e8dbec6a6ce0e5136210e7bc22622a8613328676c1f8febf5d1ad1ba061042280d0ea4

data/.gitignore

@@ -0,0 +1,57 @@
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+Layout/HashAlignment:
+  AllowMultipleStyles: true
+  EnforcedColonStyle: separator
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false

data/.rubocop_todo.yml

@@ -0,0 +1,30 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude`
+# on 2020-12-30 22:56:14 UTC using RuboCop version 1.7.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Exclude:
+    - '**/*.gemspec'
+    - 'spec/flagsmith_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/flagsmith.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'flagsmith.gemspec'

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |_repo_name| 'https://github.com/Flagsmith/flagsmith-ruby-client' }
+
+# Specify your gem's dependencies in flagsmith.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    flagsmith (2.0.0)
+      faraday
+      faraday_middleware
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    faraday (1.2.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    gem-release (2.2.0)
+    multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  flagsmith!
+  gem-release
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.17.2

data/LICENCE

@@ -0,0 +1,12 @@
+Copyright (c) 2018 Solid State Technology Ltd (https://www.solidstategroup.com/) and individual contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of the Sentry nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,83 @@
+<img width="100%" src="https://raw.githubusercontent.com/Flagsmith/flagsmith-frontend/master/hero.png"/>
+
+# Flagsmith Client
+
+The SDK clients for Ruby [https://flagsmith.com/](https://www.flagsmith.com/). Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and organizations.
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See running in production for notes on how to deploy the project on a live system.
+
+## Installing
+
+### VIA gem
+
+`gem install flagsmith`
+
+## Usage
+
+**Retrieving feature flags for your project**
+
+**For full documentation visit [https://docs.flagsmith.com/](https://docs.flagsmith.com/)**
+
+```ruby
+require "flagsmith"
+
+flagsmith = Flagsmith.new("<<Your API KEY>>")
+
+if flagsmith.get_value("font_size")
+  #    Do something awesome with the font size
+end
+
+if flagsmith.feature_enabled?("does_not_exist")
+  #do something
+else
+  #do nothing, or something else
+end
+
+```
+
+**Available Options**
+
+| Property  |                                            Description                                            | Required |                     Default Value |   Environment Key |
+| --------- | :-----------------------------------------------------------------------------------------------: | -------: | --------------------------------: | ----------------: |
+| `api_key` |  Defines which project environment you wish to get flags for. _example ACME Project - Staging._   |  **YES** |                              null | FLAGSMITH_API_KEY |
+| `url`     | Use this property to define where you're getting feature flags from, e.g. if you're self hosting. |   **NO** | https://api.flagsmith.com/api/v1/ |     FLAGSMITH_URL |
+
+**Available Functions**
+
+| Property                                          |                                                     Description                                                      |
+| ------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------: |
+| `init`                                            |                                 Initialize the sdk against a particular environment                                  |
+| `feature_enabled?(key)`                           |         Get the value of a particular feature e.g. `flagsmith.feature_enabled?("powerUserFeature") // true`          |
+| `feature_enabled?(key, user_id, default = false)` | Get the value of a particular feature for a user e.g. `flagsmith.feature_enabled?("powerUserFeature", 1234) // true` |
+| `get_value(key)`                                  |                 Get the value of a particular feature e.g. `flagsmith.get_value("font_size") // 10`                  |
+| `get_value(key, user_id, default = nil)`          |    Get the value of a particular feature for a specified user e.g. `flagsmith.get_value("font_size", 1234) // 15`    |
+| `get_flags()`                                     |       Trigger a manual fetch of the environment features, if a user is identified it will fetch their features       |
+| `get_flags(user_id)`                              |                       Trigger a manual fetch of the environment features with a given user id                        |
+| `set_trait(user_id, trait, value)`                |                                    Set the value of a trait for the given user id                                    |
+
+**Identifying Users**
+
+Identifying users allows you to target specific users from the [Flagsmith dashboard](https://www.flagsmith.com/).
+You can include an optional user identifier as part of the `feature_enabled?` and `get_value` methods to retrieve unique user flags and variables.
+
+## Contributing
+
+Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45cbd3eefb21cb0486) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Getting Help
+
+If you encounter a bug or feature request we would like to hear about it. Before you submit an issue please search existing issues in order to prevent duplicates.
+
+## Get in touch
+
+If you have any questions about our projects you can email <a href="mailto:projects@solidstategroup.com">projects@solidstategroup.com</a>.
+
+## Useful links
+
+[Website](https://flagsmith.com)
+
+[Documentation](https://docs.flagsmith.com/)
+
+[YouTube Tutorials](https://www.youtube.com/channel/UCki7GZrOdZZcsV9rAIRchCw)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/flagsmith.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.4.0'
+  spec.name = 'flagsmith'
+  spec.version = '2.0.0'
+  spec.authors = ['Tom Stuart', 'Brian Moelk']
+  spec.email = ['tom@solidstategroup.com', 'bmoelk@gmail.com']
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.summary = 'Flagsmith - Ship features with confidence'
+  spec.description = 'Ruby Client for Flagsmith. Ship features with confidence using feature flags and remote config. Host yourself or use our hosted version at https://flagsmith.com'
+  spec.homepage = 'https://flagsmith.com'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'gem-release'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+end

data/lib/flagsmith.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+# Ruby client for flagsmith.com
+class Flagsmith
+  attr_reader :flagsmith_api
+
+  def initialize(opts = {})
+    @opts = determine_opts(opts)
+
+    @flagsmith_api = Faraday.new(url: @opts[:url]) do |faraday|
+      faraday.headers['Accept'] = 'application/json'
+      faraday.headers['Content-Type'] = 'application/json'
+      faraday.headers['x-environment-key'] = @opts[:api_key]
+      faraday.response :json
+      # TODO: add timeout adjustment here
+      faraday.adapter Faraday.default_adapter
+    end
+  end
+
+  def get_flags(user_id = nil)
+    if user_id.nil?
+      res = @flagsmith_api.get('flags/')
+      flags = transform_flags(res.body).select { |flag| flag[:segment].nil? }
+      flags_to_hash(flags)
+    else
+      res = @flagsmith_api.get("identities/?identifier=#{user_id}")
+      flags_to_hash(transform_flags(res.body['flags']))
+    end
+  end
+
+  def feature_enabled?(feature, user_id = nil, default = false)
+    flag = get_flags(user_id)[normalize_key(feature)]
+    return default if flag.nil?
+
+    flag[:enabled]
+  end
+
+  def get_value(key, user_id = nil, default = nil)
+    flag = get_flags(user_id)[normalize_key(key)]
+    return default if flag.nil?
+
+    flag[:value]
+  end
+
+  def set_trait(user_id, trait, value)
+    raise StandardError, 'user_id cannot be nil' if user_id.nil?
+
+    trait = {
+         identity:    { identifier: user_id },
+        trait_key:    normalize_key(trait),
+      trait_value:    value
+    }
+    res = @flagsmith_api.post('traits/', trait.to_json)
+    res.body
+  end
+
+  def get_traits(user_id)
+    return {} if user_id.nil?
+
+    res = @flagsmith_api.get("identities/?identifier=#{user_id}")
+    traits_to_hash(res.body)
+  end
+
+  # def remove_trait(user_id, trait_id)
+  #   # Request URL: https://api.flagsmith.com/api/v1/environments/API_KEY/identities/12345/traits/54321/
+  #   # Request Method: DELETE
+  # end
+
+  def transform_flags(flags)
+    flags.map do |flag|
+      {
+           name:    flag['feature']['name'],
+        enabled:    flag['enabled'],
+          value:    flag['feature_state_value'],
+        segment:    flag['feature_segment']
+      }
+    end
+  end
+
+  def flags_to_hash(flags)
+    result = {}
+    flags.each do |flag|
+      key = normalize_key(flag.delete(:name))
+      result[key] = flag
+    end
+    result
+  end
+
+  def traits_to_hash(user_flags)
+    result = {}
+    user_flags['traits']&.each do |t|
+      key = normalize_key(t['trait_key'])
+      result[key] = t['trait_value']
+    end
+    result
+  end
+
+  def normalize_key(key)
+    key.to_s.downcase
+  end
+
+  def determine_opts(opts)
+    opts = { api_key: opts } if opts.is_a? String
+
+    {
+      api_key: opts[:api_key] || self.class.api_key,
+          url: opts[:url] || self.class.api_url
+    }
+  end
+
+  def self.api_key
+    ENV['FLAGSMITH_API_KEY']
+  end
+
+  def self.api_url
+    ENV.fetch('FLAGSMITH_URL', 'https://api.flagsmith.com/api/v1/')
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: flagsmith
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Tom Stuart
+- Brian Moelk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Client for Flagsmith. Ship features with confidence using feature
+  flags and remote config. Host yourself or use our hosted version at https://flagsmith.com
+email:
+- tom@solidstategroup.com
+- bmoelk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Gemfile.lock
+- LICENCE
+- README.md
+- Rakefile
+- flagsmith.gemspec
+- lib/flagsmith.rb
+homepage: https://flagsmith.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Flagsmith - Ship features with confidence
+test_files: []