bullet-train-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83febba5a52e7d5602a6f1ffe57254707e930e9f
+  data.tar.gz: 2429172817181761da746db54512eebfa0e234d2
+SHA512:
+  metadata.gz: acdd435953e9112efae4ec8c1e8f98b08ecd2c04474ea4373efbfc04f3df112023d9fd5a5ae54ab6f21e1ac3682e476df52e35478c1fc928e43c2b9b1f0aacd9
+  data.tar.gz: 1fcf557da0d03cbe3d1bb588e1652f85d43df2d75612af660e931c866c30bd7cb3859309787fb58693aaf4ecfffc3702f0711498eadb3c8909abca7bcb28b353

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/.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Local File",
+            "type": "Ruby",
+            "request": "launch",
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceRoot}/lib/bullet-train.rb"
+        }
+    ]
+}

data/Gemfile

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

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,73 @@
+<img width="100%" src="https://raw.githubusercontent.com/SolidStateGroup/bullet-train-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.
+
+## 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 bullet-train-client```
+	
+## Usage
+**Retrieving feature flags for your project**
+
+**For full documentation visit [https://docs.bullet-train.io](https://docs.bullet-train.io)**
+```ruby
+require "bullet-train-ruby-client"
+
+bt = BulletTrain.new(<<Your API KEY>>")
+
+if bt.getValue("font_size")
+  #    Do something awesome with the font size
+end
+
+if bt.hasFeature("does_not_exist")
+  #do something
+else
+  #do nothing, or something else
+end
+
+```
+**Available Options**
+
+| Property        | Description           | Required  | Default Value  |
+| ------------- |:-------------:| -----:| -----:|
+| ```environmentID```     | Defines which project environment you wish to get flags for. *example ACME Project - Staging.* | **YES** | null
+| ```onError```     | Callback function on failure to retrieve flags. ``` (error)=>{...} ``` |  **NO** | null
+| ```defaultFlags```     | Defines the default flags if there are any | **NO** | null
+| ```api```     | 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/
+
+**Available Functions**
+
+| Property        | Description |         
+| ------------- |:-------------:|
+| ```init```     | Initialise the sdk against a particular environment
+| ```hasFeature(key)```     | Get the value of a particular feature e.g. ```bulletTrain.hasFeature("powerUserFeature") // true```
+| ```hasFeature(key, userId)```     | Get the value of a particular feature for a user e.g. ```bulletTrain.hasFeature("powerUserFeature", 1234) // true```
+| ```getValue(key)```     | Get the value of a particular feature e.g. ```bulletTrain.getValue("font_size") // 10```
+| ```getValue(keym userId)```     | Get the value of a particular feature for a specificed user e.g. ```bulletTrain.getValue("font_size", 1234) // 15```
+| ```getFlags()```     | Trigger a manual fetch of the environment features, if a user is identified it will fetch their features
+| ```getFlagsForUser(1234)```     | Trigger a manual fetch of the environment features with a 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.
+
+
+## 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>.

data/bullet-train-ruby.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |spec|
+  spec.name = "bullet-train-client"
+  spec.version = "0.0.1"
+  spec.authors = ["Tom Stuart"]
+  spec.email = ["tom@solidstategroup.com"]
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.summary = "Bullet Train - Ship features with confidence"
+  spec.description = "Ruby Client for Bullet-Train. Ship features with confidence using feature flags and remote config. Host yourself or use our hosted version at https://bullet-train.io"
+  spec.homepage = "https://bullet-train.io"
+end

data/lib/bullet-train.rb

@@ -0,0 +1,76 @@
+# require "bullet/train/ruby/version"
+require "open-uri"
+require "json"
+
+class BulletTrainClient
+  @@apiUrl = ""
+  @@environmentKey = ""
+
+  def initialize(apiKey = nil, apiUrl = "https://api.bullet-train.io/api/v1/")
+    @@environmentKey = apiKey
+    @@apiUrl = apiUrl
+  end
+
+  def getJSON(method = nil)
+    response = open(@@apiUrl + "" + method.concat("?format=json"),
+                    "x-environment-key" => @@environmentKey).read
+    return JSON.parse(response)
+  end
+
+  def processFlags(inputFlags)
+    flags = {}
+
+    for feature in inputFlags
+      featureName = feature["feature"]["name"].downcase.gsub(/\s+/, "_")
+      enabled = feature["enabled"]
+      state = feature["feature_state_value"]
+      flags[featureName] = {"enabled" => enabled, "value" => state}
+
+      return flags
+    end
+
+    return flags
+  end
+
+  def getFlagsForUser(identity = nil)
+    processFlags(getJSON("flags/#{identity}"))
+  end
+
+  def getFlags()
+    processFlags(getJSON("flags"))
+  end
+
+  def getValue(key, userId = nil)
+    flags = nil
+    # Get the features
+    if userId != nil
+      flags = getFlagsForUser(userId)
+    else
+      flags = getFlags()
+    end
+    # Return the value
+    return flags[key]["value"]
+  end
+
+  def hasFeature(key, userId = nil)
+    # Get the features
+    flags = nil
+    if userId != nil
+      flags = getFlagsForUser(userId)
+    else
+      flags = getFlags()
+    end
+
+    # Work out if this feature exists
+    if flags[key] == nil
+      return false
+    else
+      return flags[key]["enabled"]
+    end
+  end
+end
+
+# bt = BulletTrain.new("QjgYur4LQTwe5HpvbvhpzK")
+# print bt.getFlags()
+# print bt.getValue("font_size")
+# print bt.hasFeature("font_size")

data/test.rb

@@ -0,0 +1,14 @@
+require "bullet-train"
+
+bt = BulletTrain.new("QjgYur4LQTwe5HpvbvhpzK")
+
+if bt.getValue("font_size")
+  #    Do something awesome with the font size
+  puts bt.getValue("font_size")
+end
+
+if bt.hasFeature("does_not_exist")
+  #do something
+else
+  #do nothing, or something else
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: bullet-train-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-18 00:00:00.000000000 Z
+dependencies: []
+description: Ruby Client for Bullet-Train. Ship features with confidence using feature
+  flags and remote config. Host yourself or use our hosted version at https://bullet-train.io
+email:
+- tom@solidstategroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".vscode/launch.json"
+- Gemfile
+- LICENCE
+- README.md
+- bullet-train-ruby.gemspec
+- lib/bullet-train.rb
+- test.rb
+homepage: https://bullet-train.io
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Bullet Train - Ship features with confidence
+test_files: []