bullet-train-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ff1a949e769f61e808e8a814ee7d543329f4fc9a52ae897ca7a53c6c207bd26
-  data.tar.gz: bfe93bbfc25b22daa972d142290803753bd5550cb07b18020b1836b573afff33
+  metadata.gz: a5c47e0b0313009db4ae84b4721fa39b87bc38f4660414a8ae8902520a204354
+  data.tar.gz: acc7b67eb95509fe392efea7f258bd19fdf4a84c10c4fe3f7e50bd89363dc10a
 SHA512:
-  metadata.gz: 618706b32e1535e913e0438075940c8ef0b89b7aaecbdb6ffd94b8e68afe1ffad09a67ac04e0b8c8f96e81b671fb89a7ec6223e47b095aa588aa97e28e8200d5
-  data.tar.gz: 16afdddb0b80d25a2e97a5ef8edf8a72aba7d1b5998db69d53eaca9c8fb6f64bf61c15fddfe5323aff183bee230bc92703adf6250a80ec55e84b675382db9109
+  metadata.gz: 5df011ddd786de343625b5a21b9e4b2067b6aa2e3c253c0f83dacc7d13211a8f47961eaef24014d91a440add3c693033fe57f211b4354b11ddd159ce1d8233b6
+  data.tar.gz: f0134af7e9ce7a6b469b2978521336b30b08d08aff1bbffbadd7d33cfd1b30d17a5bb6f65b5d56aadf7834a5bb278cab0c81a956588f40bd4e464143ab35f6a5

data/Rakefile

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

data/bullet-train-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "bullet-train-client"
-  spec.version = "1.0.0"
+  spec.version = "1.1.0"
   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)/}) }
@@ -8,4 +8,9 @@ Gem::Specification.new do |spec|
   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"
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_dependency 'faraday'
 end

data/lib/bullet-train.rb

@@ -1,69 +1,3 @@
-# require "bullet/train/ruby/version"
-require "open-uri"
-require "json"
+# frozen_string_literal: true
 
-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}
-    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
+require 'bullet_train'

data/lib/bullet_train.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+require 'faraday'
+
+class BulletTrain
+  attr_reader :bt_api
+
+  def initialize(opts = {})
+    @opts = {
+      api_key: opts[:api_key] || self.class.api_key,
+      url: opts[:url] || self.class.api_url
+    }
+
+    @bt_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 = @bt_api.get('flags/')
+      flags = transform_flags(res.body).select { |flag| flag[:segment].nil? }
+      flags_to_hash(flags)
+    else
+      res = @bt_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?
+
+    res = @bt_api.post('traits/', { identity: { identifier: user_id }, trait_key: normalize_key(trait), trait_value: value }.to_json)
+    res.body
+  end
+
+  def get_traits(user_id)
+    return {} if user_id.nil?
+
+    res = @bt_api.get("identities/?identifier=#{user_id}")
+    traits_to_hash(res.body)
+  end
+
+  # def remove_trait(user_id, trait_id)
+  #   # Request URL: https://api.bullet-train.io/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 { |t| result[normalize_key(t['trait_key'])] = t['trait_value'] }
+    result
+  end
+
+  def normalize_key(key)
+    key.to_s.downcase
+  end
+
+  alias :hasFeature :feature_enabled?
+  alias :getValue :get_value
+  alias :getFlags :get_flags
+  alias :getFlagsForUser :get_flags
+
+  def self.api_key
+    ENV['BULLETTRAIN_API_KEY']
+  end
+
+  def self.api_url
+    ENV.fetch('BULLETTRAIN_URL') { 'https://api.bullet-train.io/api/v1/' }
+  end
+end

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: bullet-train-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tom Stuart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
-dependencies: []
+date: 2020-01-16 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: 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: 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'
 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:
@@ -19,13 +75,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".vscode/launch.json"
 - Gemfile
 - LICENCE
 - README.md
+- Rakefile
 - bullet-train-ruby.gemspec
 - lib/bullet-train.rb
-- test.rb
+- lib/bullet_train.rb
 homepage: https://bullet-train.io
 licenses: []
 metadata: {}

data/.vscode/launch.json

@@ -1,15 +0,0 @@
-{
-    // 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/test.rb

@@ -1,7 +0,0 @@
-require "./lib/bullet-train.rb"
-
-
-bt = BulletTrainClient.new("TijpMX6ajA7REC4bf5suYg")
-puts("freeze_delinquent_accounts:" + bt.hasFeature("freeze_delinquent_accounts").to_s)
-puts("twilio_import_days_to_process:" + bt.getValue("twilio_import_days_to_process").to_s)
-puts("freeze_delinquent_accounts for user bullet_train_sample_user:" + bt.hasFeature("freeze_delinquent_accounts", "bullet_train_sample_user").to_s)