bullet-train-client 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: a5c47e0b0313009db4ae84b4721fa39b87bc38f4660414a8ae8902520a204354
-  data.tar.gz: acc7b67eb95509fe392efea7f258bd19fdf4a84c10c4fe3f7e50bd89363dc10a
+SHA1:
+  metadata.gz: 700fb806fd2257ec039e885707d1d9d12e9b1d30
+  data.tar.gz: 9ab26fd436b94bb1d84a065c3dc8f38fe53e037c
 SHA512:
-  metadata.gz: 5df011ddd786de343625b5a21b9e4b2067b6aa2e3c253c0f83dacc7d13211a8f47961eaef24014d91a440add3c693033fe57f211b4354b11ddd159ce1d8233b6
-  data.tar.gz: f0134af7e9ce7a6b469b2978521336b30b08d08aff1bbffbadd7d33cfd1b30d17a5bb6f65b5d56aadf7834a5bb278cab0c81a956588f40bd4e464143ab35f6a5
+  metadata.gz: 50b6ec8f1f47c6c739fc83109aa3d517c2f28342cb0e785e192c1dd01d1857e8b337d9d1c72b2107f2dbee8c44c1996c9c6d492328a4c4e546bb774ead7f4611
+  data.tar.gz: f70d01cc775ddb42cf159bfa48df3b225cc5b33385c43c16e8fcf583372f8c4649b2209d90ca162ee26c576f6cd017ce41672e8fb77e4ca49f98b87858cb67e0

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from: .rubocop_todo.yml
+Layout/HashAlignment:
+  AllowMultipleStyles: true
+  EnforcedColonStyle: separator
+

data/.rubocop_todo.yml

@@ -0,0 +1,97 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-01-16 04:57:18 -1000 using RuboCop version 0.79.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
+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'
+
+# 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:
+  Exclude:
+    - 'Rakefile'
+
+# 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
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 188

data/README.md

@@ -11,7 +11,7 @@ These instructions will get you a copy of the project up and running on your loc
 
 ### VIA gem
 ```gem install bullet-train-client```
-	
+
 ## Usage
 **Retrieving feature flags for your project**
 
@@ -21,11 +21,11 @@ require "bullet-train-ruby-client"
 
 bt = BulletTrain.new("<<Your API KEY>>")
 
-if bt.getValue("font_size")
+if bt.get_value("font_size")
   #    Do something awesome with the font size
 end
 
-if bt.hasFeature("does_not_exist")
+if bt.feature_enabled?("does_not_exist")
   #do something
 else
   #do nothing, or something else
@@ -36,22 +36,20 @@ end
 
 | 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/
+| ```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/
 
 **Available Functions**
 
-| Property        | Description |         
+| 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
+| ```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
 
 
 **Identifying users**
@@ -66,7 +64,7 @@ Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45c
 
 ## 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. 
+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
 

data/bullet-train-ruby.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
   spec.name = "bullet-train-client"
-  spec.version = "1.1.0"
-  spec.authors = ["Tom Stuart"]
-  spec.email = ["tom@solidstategroup.com"]
+  spec.version = "1.1.1"
+  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 = "Bullet Train - Ship features with confidence"
@@ -10,7 +10,10 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://bullet-train.io"
 
   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/bullet_train.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
+
 require 'faraday'
+require 'faraday_middleware'
 
+# Ruby client for bullet-train.io
 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
-    }
+    @opts = determine_opts(opts)
 
     @bt_api = Faraday.new(url: @opts[:url]) do |faraday|
       faraday.headers['Accept'] = 'application/json'
@@ -48,7 +48,12 @@ class BulletTrain
   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)
+    trait = {
+      identity:    { identifier: user_id },
+      trait_key:   normalize_key(trait),
+      trait_value: value
+    }
+    res = @bt_api.post('traits/', trait.to_json)
     res.body
   end
 
@@ -86,7 +91,10 @@ class BulletTrain
 
   def traits_to_hash(user_flags)
     result = {}
-    user_flags['traits']&.each { |t| result[normalize_key(t['trait_key'])] = t['trait_value'] }
+    user_flags['traits']&.each do |t|
+      key = normalize_key(t['trait_key'])
+      result[key] = t['trait_value']
+    end
     result
   end
 
@@ -94,10 +102,19 @@ class BulletTrain
     key.to_s.downcase
   end
 
-  alias :hasFeature :feature_enabled?
-  alias :getValue :get_value
-  alias :getFlags :get_flags
-  alias :getFlagsForUser :get_flags
+  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
+
+  alias hasFeature feature_enabled?
+  alias getValue get_value
+  alias getFlags get_flags
+  alias getFlagsForUser get_flags
 
   def self.api_key
     ENV['BULLETTRAIN_API_KEY']

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bullet-train-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Tom Stuart
+- Brian Moelk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +25,20 @@ dependencies:
     - - ">="
       - !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
@@ -52,6 +67,20 @@ dependencies:
     - - ">="
       - !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
@@ -66,15 +95,32 @@ dependencies:
     - - ">="
       - !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 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
+- bmoelk@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENCE
 - README.md
@@ -100,7 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Bullet Train - Ship features with confidence