rename gem to flagsmith and update documentation and code to reference new name

Author: Daniel Rinehart

.rubocop.yml

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

.rubocop_todo.yml

@@ -1,97 +1,30 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2020-01-16 04:57:18 -1000 using RuboCop version 0.79.0.
+# `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: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: special_inside_parentheses, consistent, align_braces
-Layout/FirstHashElementIndentation:
-  Exclude:
-    - 'lib/bullet_train.rb'
-    - 'spec/bullet_train_spec.rb'
-
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/HashAlignment:
-  Exclude:
-    - 'lib/bullet_train.rb'
-    - 'spec/bullet_train_spec.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Layout/SpaceAroundKeyword:
-  Exclude:
-    - 'spec/bullet_train_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-# SupportedStyles: space, no_space
-# SupportedStylesForEmptyBraces: space, no_space
-Layout/SpaceInsideBlockBraces:
-  Exclude:
-    - 'Gemfile'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
-Lint/UnusedBlockArgument:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 111
-
-# Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
-# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
-Naming/FileName:
-  Exclude:
-    - 'lib/bullet-train.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, never
-Style/FrozenStringLiteralComment:
   Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'bullet-train-ruby.gemspec'
+    - '**/*.gemspec'
+    - 'spec/flagsmith_spec.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
-# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-Style/HashSyntax:
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
   Exclude:
-    - 'Rakefile'
+    - 'lib/flagsmith.rb'
 
-# Offense count: 13
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'bullet-train-ruby.gemspec'
-
-# Offense count: 11
+# Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Configuration parameters: AutoCorrect, Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 188
+  Exclude:
+    - 'flagsmith.gemspec'

Gemfile

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

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

README.md

@@ -1,7 +1,8 @@
-<img width="100%" src="https://raw.githubusercontent.com/SolidStateGroup/bullet-train-frontend/master/hero.png"/>
+<img width="100%" src="https://raw.githubusercontent.com/Flagsmith/flagsmith-frontend/master/hero.png"/>
 
-# Bullet Train Client
-The SDK clients for Ruby [https://bullet-train.io/](https://www.bullet-train.io/). Bullet Train allows you to manage feature flags and remote config across multiple projects, environments and organisations.
+# 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
 
@@ -10,53 +11,56 @@ These instructions will get you a copy of the project up and running on your loc
 ## Installing
 
 ### VIA gem
-```gem install bullet-train-client```
+
+`gem install flagsmith`
 
 ## Usage
+
 **Retrieving feature flags for your project**
 
-**For full documentation visit [https://docs.bullet-train.io](https://docs.bullet-train.io)**
+**For full documentation visit [https://docs.flagsmith.com/](https://docs.flagsmith.com/)**
+
 ```ruby
-require "bullet-train-ruby-client"
+require "flagsmith"
 
-bt = BulletTrain.new("<<Your API KEY>>")
+flagsmith = Flagsmith.new("<<Your API KEY>>")
 
-if bt.get_value("font_size")
+if flagsmith.get_value("font_size")
   #    Do something awesome with the font size
 end
 
-if bt.feature_enabled?("does_not_exist")
+if flagsmith.feature_enabled?("does_not_exist")
   #do something
 else
   #do nothing, or something else
 end
 
 ```
+
 **Available Options**
 
-| Property        | Description           | Required  | Default Value  |
-| ------------- |:-------------:| -----:| -----:|
-| ```api_key```     | Defines which project environment you wish to get flags for. *example ACME Project - Staging.* | **YES** | null
-| ```url```     | Use this property to define where you're getting feature flags from, e.g. if you're self hosting. |  **NO** | https://bullet-train-api.dokku1.solidstategroup.com/api/v1/
+| 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```     | Initialise the sdk against a particular environment
-| ```feature_enabled?(key)```     | Get the value of a particular feature e.g. ```bulletTrain.feature_enabled?("powerUserFeature") // true```
-| ```feature_enabled?(key, user_id, default = false)```     | Get the value of a particular feature for a user e.g. ```bulletTrain.feature_enabled?("powerUserFeature", 1234) // true```
-| ```get_value(key)```     | Get the value of a particular feature e.g. ```bulletTrain.get_value("font_size") // 10```
-| ```get_value(key, user_id, default = nil)```     | Get the value of a particular feature for a specificed user e.g. ```bulletTrain.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
-
+| 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 [Bullet Train dashboard](https://www.bullet-train.io/).
-You can include an optional user identifier as part of the `hasFeature` and `getValue` methods to retrieve unique user flags and variables.
+**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
 
@@ -72,10 +76,8 @@ If you have any questions about our projects you can email <a href="mailto:proje
 
 ## Useful links
 
-[Website](https://bullet-train.io)
-
-[Documentation](https://docs.bullet-train.io/)
+[Website](https://flagsmith.com)
 
-[Code Examples](https://github.com/SolidStateGroup/bullet-train-docs)
+[Documentation](https://docs.flagsmith.com/)
 
-[Youtube Tutorials](https://www.youtube.com/channel/UCki7GZrOdZZcsV9rAIRchCw)
+[YouTube Tutorials](https://www.youtube.com/channel/UCki7GZrOdZZcsV9rAIRchCw)

Rakefile

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

bullet-train-ruby.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 = ['[email protected]', '[email protected]']
+  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