flagsmith 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35fb5ceee9613cc9425904d67f7429b82d56fcb42d3bfff4f0adb7c4d7a61ea2
-  data.tar.gz: a3d9a18ac02ad8a5f29f7f1ad116b8c47c563a7754f650320b693b349c3d03bf
+  metadata.gz: f75b8801ce9af235343975f0e7ded1e3d6fa79544ffccc94e9052a1293143cfb
+  data.tar.gz: 5fb178bb71c4fa72207e5843fcbc6d2778285e85be2f4138e19f9822038d68c8
 SHA512:
-  metadata.gz: 8b3017bfcf9e4c81965b719e499a992954a3ffb3c4d7984eaeab61befb5074268e2507e7ce57291eeeff59f99ec6dc06ed539f5112be24a97fb0b4eed9dcda4c
-  data.tar.gz: 42bb17bdcf66b4ff8bfdd70abd645c79eae85b60dec89163e4450b1920e8dbec6a6ce0e5136210e7bc22622a8613328676c1f8febf5d1ad1ba061042280d0ea4
+  metadata.gz: 17306e034862b4b66996edb1bed6f3744a15e74dcc283a10630b3c25dd6dde1a8ed80259d24169d167030af6e264f5da8df9141c5c8790668596e29441819ab1
+  data.tar.gz: d46975cd909e97f08c0f81f15b4d265fe11c9762a8f4558701af380874e338ee3d101d5a05be68264ca5f53861290250046ea8aa3e6ae3b374421b6c7c7d35a2

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -2,7 +2,10 @@ inherit_from: .rubocop_todo.yml
 
 Layout/HashAlignment:
   AllowMultipleStyles: true
-  EnforcedColonStyle: separator
+  EnforcedColonStyle: key
 AllCops:
   NewCops: enable
   SuggestExtensions: false
+  Exclude:
+    - 'spec/**/*'
+    - 'example/**/*'

data/.rubocop_todo.yml

@@ -12,7 +12,6 @@
 Metrics/BlockLength:
   Exclude:
     - '**/*.gemspec'
-    - 'spec/flagsmith_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: AllowedMethods.

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/Gemfile.lock

@@ -1,25 +1,52 @@
 PATH
   remote: .
   specs:
-    flagsmith (2.0.0)
+    flagsmith (3.0.0)
       faraday
+      faraday-retry
       faraday_middleware
+      semantic
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    coderay (1.1.3)
     diff-lcs (1.4.4)
-    faraday (1.2.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    faraday_middleware (1.0.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     gem-release (2.2.0)
+    method_source (1.0.0)
     multipart-post (2.1.1)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.0.3)
@@ -49,7 +76,8 @@ GEM
     rubocop-ast (1.3.0)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
+    ruby2_keywords (0.0.5)
+    semantic (1.6.1)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -59,9 +87,10 @@ DEPENDENCIES
   bundler
   flagsmith!
   gem-release
+  pry
   rake
   rspec
   rubocop
 
 BUNDLED WITH
-   1.17.2
+   2.3.14

data/LICENCE

@@ -1,12 +1,11 @@
-Copyright (c) 2018 Solid State Technology Ltd (https://www.solidstategroup.com/) and individual contributors.
-All rights reserved.
+Copyright 2022 Bullet Train Ltd. A UK company.
 
 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.
+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.
+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.
+3. Neither the name of the copyright holder 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

@@ -1,70 +1,16 @@
-<img width="100%" src="https://raw.githubusercontent.com/Flagsmith/flagsmith-frontend/master/hero.png"/>
+<img width="100%" src="https://github.com/Flagsmith/flagsmith/raw/main/static-files/hero.png"/>
 
-# Flagsmith Client
+# Flagsmith Ruby 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.
+The SDK clients for Ruby [https://www.flagsmith.com/](https://www.flagsmith.com/). Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and organizations.
 
-## Getting Started
+## Adding to your project
 
-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.
+For full documentation visit [https://docs.flagsmith.com/clients/ruby/](https://docs.flagsmith.com/clients/ruby/)
 
 ## 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.
+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
 
 ## Getting Help
 
@@ -72,12 +18,10 @@ If you encounter a bug or feature request we would like to hear about it. Before
 
 ## Get in touch
 
-If you have any questions about our projects you can email <a href="mailto:projects@solidstategroup.com">projects@solidstategroup.com</a>.
+If you have any questions about our projects you can email <a href="mailto:support@flagsmith.com">support@flagsmith.com</a>.
 
 ## Useful links
 
-[Website](https://flagsmith.com)
+[Website](https://www.flagsmith.com/)
 
 [Documentation](https://docs.flagsmith.com/)
-
-[YouTube Tutorials](https://www.youtube.com/channel/UCki7GZrOdZZcsV9rAIRchCw)

data/Rakefile

@@ -5,4 +5,8 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/example/.env.development

@@ -0,0 +1,5 @@
+# Define ENV variables for development environment
+DATABASE_URL="sqlite://db/example_development.sqlite"
+SERVE_STATIC_ASSETS="true"
+WEB_SESSIONS_SECRET="4743628fa58981a0eaf99cc636146f49ceffd0ab6a8423c0e2493e67cd825f67"
+FLAGSMITH_ENVIRONMENT_KEY="YOUR_FLAGSMITH_ENVIRONMENT_KEY"

data/example/.env.test

@@ -0,0 +1,4 @@
+# Define ENV variables for test environment
+DATABASE_URL="sqlite://db/example_test.sqlite"
+SERVE_STATIC_ASSETS="true"
+WEB_SESSIONS_SECRET="50f1a22a68ccc6d06b48387f4cd4aa63cbaabd2b525c288f0f7a7046b10cc6ac"

data/example/.gitignore

@@ -0,0 +1,5 @@
+/db/*.sqlite
+/public/assets*
+/tmp
+.env.local
+.env.*.local

data/example/.hanamirc

@@ -0,0 +1,3 @@
+project=example
+test=rspec
+template=slim

data/example/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/example/Gemfile

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+gem 'hanami', '~> 1.3'
+gem 'hanami-model', '~> 1.3'
+gem 'slim'
+gem 'sqlite3'
+gem "puma", "~> 5.6"
+
+gemspec path: '../'
+
+group :development do
+  # Code reloading
+  # See: https://guides.hanamirb.org/projects/code-reloading
+  gem 'hanami-webconsole'
+  gem 'shotgun', platforms: :ruby
+end
+
+group :test, :development do
+  gem 'dotenv', '~> 2.4'
+end
+
+group :test do
+  gem 'capybara'
+  gem 'rspec'
+end

data/example/Gemfile.lock

@@ -0,0 +1,269 @@
+PATH
+  remote: ..
+  specs:
+    flagsmith (3.0.0)
+      faraday
+      faraday-retry
+      faraday_middleware
+      semantic
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    better_errors (2.9.1)
+      coderay (>= 1.0.0)
+      erubi (>= 1.0.0)
+      rack (>= 0.9.0)
+    bigdecimal (1.4.4)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    capybara (3.32.2)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    debug_inspector (1.1.0)
+    diff-lcs (1.5.0)
+    dotenv (2.7.6)
+    dry-cli (0.7.0)
+    dry-configurable (0.11.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-initializer (1.4.1)
+    dry-logic (0.4.2)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-struct (0.3.1)
+      dry-configurable (~> 0.1)
+      dry-core (~> 0.3)
+      dry-equalizer (~> 0.2)
+      dry-types (~> 0.9, >= 0.9.0)
+      ice_nine (~> 0.11)
+    dry-types (0.11.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      inflecto (~> 0.0.0, >= 0.0.2)
+    dry-validation (0.11.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      dry-types (~> 0.11.0)
+    erubi (1.10.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    gem-release (2.2.2)
+    hanami (1.3.5)
+      bundler (>= 1.6, < 3)
+      concurrent-ruby (~> 1.0)
+      dry-cli (~> 0.5)
+      hanami-assets (~> 1.3)
+      hanami-controller (~> 1.3, >= 1.3.3)
+      hanami-helpers (~> 1.3)
+      hanami-mailer (~> 1.3)
+      hanami-router (~> 1.3)
+      hanami-utils (~> 1.3)
+      hanami-validations (>= 1.3, < 3)
+      hanami-view (~> 1.3)
+    hanami-assets (1.3.5)
+      hanami-helpers (~> 1.3)
+      hanami-utils (~> 1.3)
+      tilt (~> 2.0, >= 2.0.2)
+    hanami-controller (1.3.3)
+      hanami-utils (~> 1.3)
+      rack (~> 2.0)
+    hanami-helpers (1.3.3)
+      hanami-utils (~> 1.3)
+    hanami-mailer (1.3.3)
+      hanami-utils (~> 1.3)
+      mail (~> 2.6)
+      tilt (~> 2.0, >= 2.0.1)
+    hanami-model (1.3.3)
+      bigdecimal (~> 1.4)
+      concurrent-ruby (~> 1.0)
+      dry-logic (~> 0.4.2, < 0.5)
+      dry-types (~> 0.11.0)
+      hanami-utils (~> 1.3)
+      rom (~> 3.3, >= 3.3.3)
+      rom-repository (~> 1.4)
+      rom-sql (~> 1.3, >= 1.3.5)
+    hanami-router (1.3.2)
+      hanami-utils (~> 1.3)
+      http_router (= 0.11.2)
+      rack (~> 2.0)
+    hanami-utils (1.3.8)
+      concurrent-ruby (~> 1.0)
+      transproc (~> 1.0)
+    hanami-validations (1.3.8)
+      dry-configurable (<= 0.12)
+      dry-logic (~> 0.4.2, < 0.5)
+      dry-validation (~> 0.11, < 0.12)
+      hanami-utils (~> 1.3)
+    hanami-view (1.3.3)
+      hanami-utils (~> 1.3)
+      tilt (~> 2.0, >= 2.0.1)
+    hanami-webconsole (0.1.0)
+      better_errors (~> 2.4)
+      binding_of_caller (~> 0.8)
+    http_router (0.11.2)
+      rack (>= 1.0.0)
+      url_mount (~> 0.2.1)
+    ice_nine (0.11.2)
+    inflecto (0.0.2)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.4.0)
+    multipart-post (2.1.1)
+    nio4r (2.5.8)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.20.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    puma (5.6.4)
+      nio4r (~> 2.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (1.8.2)
+    rexml (3.2.5)
+    rom (3.3.3)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.3)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 1.3)
+      dry-types (~> 0.9, >= 0.9.4)
+      rom-mapper (~> 0.5, >= 0.5.1)
+    rom-mapper (0.5.1)
+      dry-core (~> 0.2, >= 0.2.3)
+      dry-equalizer (~> 0.2)
+      transproc (~> 1.0)
+    rom-repository (1.4.0)
+      dry-core (~> 0.3, >= 0.3.1)
+      dry-struct (~> 0.3)
+      rom (~> 3.3)
+      rom-mapper (~> 0.5)
+    rom-sql (1.3.5)
+      dry-core (~> 0.3)
+      dry-equalizer (~> 0.2)
+      dry-types (~> 0.11.0)
+      rom (~> 3.2, >= 3.2.2)
+      sequel (~> 4.43)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      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, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    semantic (1.6.1)
+    sequel (4.49.0)
+    shotgun (0.9.2)
+      rack (>= 1.0)
+    slim (4.1.0)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 2.0.6, < 2.1)
+    sqlite3 (1.4.2)
+    temple (0.8.2)
+    tilt (2.0.10)
+    transproc (1.1.1)
+    unicode-display_width (2.1.0)
+    url_mount (0.2.1)
+      rack
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  capybara
+  dotenv (~> 2.4)
+  flagsmith!
+  gem-release
+  hanami (~> 1.3)
+  hanami-model (~> 1.3)
+  hanami-webconsole
+  pry
+  puma (~> 5.6)
+  rake
+  rspec
+  rubocop
+  shotgun
+  slim
+  sqlite3
+
+BUNDLED WITH
+   2.3.14

data/example/README.md

@@ -0,0 +1,29 @@
+# Flagsmith Basic Ruby Example
+
+This directory contains a basic Flask application which utilises Flagsmith. To run the example application, you'll 
+need to go through the following steps:
+
+1. Create an account, organisation and project on [Flagsmith](https://flagsmith.com)
+2. Create a feature in the project called "secret_button"
+3. Give the feature a value using the json editor as follows: 
+
+```json
+{"colour": "#ababab"}
+```
+
+4. Create a .env.local file from the template located in this directory with the environment key of one of the environments 
+in flagsmith (This can be found on the 'settings' page accessed from the menu on the left under the chosen environment.)
+5. From a terminal window, export those environment variables (either manually or by using `export $(cat .env)`)
+6. Install dependencies:
+```bash
+bundle install
+```
+7. Run the application:
+```
+bundle exec hanami server
+```
+8. Browse to http://localhost:2300
+
+Now you can play around with the 'secret_button' feature in flagsmith, turn it on to show it and edit the colour in the
+json value to edit the colour of the button. You can also identify as a given user and then update the settings for the
+secret button feature for that user in the flagsmith interface to see the affect that has too. 

data/example/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'hanami/rake_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end