featurehub-sdk 1.2.3 → 1.3.0

data/examples/sinatra/app/application.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "rack"
+require "sinatra"
+require "featurehub-sdk"
+require "json"
+
+def configure_featurehub
+  puts "FeatureHub SDK Version is #{FeatureHub::Sdk::VERSION}"
+  config = FeatureHub::Sdk::FeatureHubConfig.new(ENV.fetch("FEATUREHUB_EDGE_URL", "http://localhost:8903"),
+                                                 [
+                                                   ENV.fetch("FEATUREHUB_CLIENT_API_KEY",
+                                                             "41ef6f5e-a70b-4ace-b6b5-8a3f1d636101/2PTj12Bn50Xn7Wt4yS9heBXtok3KGFAE9KW0Cms3") # rubocop:disable Layout/LineLength
+                                                 ])
+  config.use_polling_edge_service(1)
+  config.init
+end
+
+Todo = Struct.new(:id, :title, :resolved)
+
+# sample app
+class App < Sinatra::Base
+  # Middleware
+  # use Rack::CanonicalHost, ENV['CANONICAL_HOST']
+  configure do
+    rack = File.new("logs/rack.log", "a+")
+    use Rack::CommonLogger, rack
+
+    set :fh_config, configure_featurehub
+    set :users, {}
+  end
+
+  before do
+    content_type "application/json"
+  end
+
+  # Routes
+  # "resolve" a specific todo for this user
+  put("/todo/:user/:id/resolve") do
+    user = params["user"]
+    id = params["id"].to_s
+    todos = user_todos(user)
+    todo = todos.detect { |todo| todo.id.to_s == id }
+    todo&.resolved = true
+    todo_list(user)
+  end
+
+  # delete a specific todo for this user
+  delete("/todo/:user/:id") do
+    user = params["user"]
+    id = params["id"].to_s
+    todos = user_todos(user)
+    new_todos = todos.filter { |todo| todo.id.to_s != id }
+    settings.users[user] = new_todos
+    todo_list(user)
+  end
+
+  # delete a user
+  delete("/todo/:user") do
+    user = params["user"]
+    users = settings.users || {}
+    users[user] = []
+    status(204)
+  end
+
+  # add a user and the todo in the body
+  post("/todo/:user") do
+    user = params["user"]
+    todos = user_todos(user)
+    new_todo = JSON.parse(request.body.read)
+    if new_todo["title"].nil?
+      status(400)
+    else
+      todos.push(Todo.new(new_todo["id"] || 1, new_todo["title"], new_todo["resolved"] || false))
+      todo_list(user)
+    end
+  end
+
+  # get all the todos for this user
+  get("/todo/:user") do
+    todo_list(params["user"])
+  end
+
+  get("/health/readiness") do
+    if config.repository.ready?
+      "ok"
+    else
+      status(500)
+    end
+  end
+
+  private
+
+  def todo_list(user)
+    ctx = settings.fh_config.new_context.user_key(user).build
+    todos = user_todos(user)
+
+    new_todos = []
+
+    todos.each do |todo|
+      new_todos.push(Todo.new(todo.id, process_title(ctx, todo.title), todo.resolved).to_h)
+    end
+
+    new_todos.to_json
+  end
+
+  def user_todos(user)
+    todos = settings.users[user] || []
+    settings.users[user] = todos
+  end
+
+  def process_title(ctx, title)
+    new_title = title
+
+    new_title = "#{title} #{ctx.string("FEATURE_STRING")}" if ctx.set?("FEATURE_STRING") && title == "buy"
+
+    new_title = "#{title} #{ctx.number("FEATURE_NUMBER")}" if ctx.set?("FEATURE_NUMBER") && title == "pay"
+
+    if ctx.set?("FEATURE_JSON") && title == "find"
+      json = ctx.json("FEATURE_JSON")
+      new_title = if json.nil?
+                    title.to_s
+                  else
+                    "#{title} #{json["foo"]}"
+                  end
+    end
+
+    new_title = new_title.upcase if ctx.enabled?("FEATURE_TITLE_TO_UPPERCASE")
+
+    puts("features via repository: #{settings.fh_config.repository.features}")
+    puts("features via edge service: #{settings.fh_config.get_or_create_edge_service.repository}")
+
+    puts("enabled? #{ctx.repo.features}")
+    puts(ctx.enabled?("FEATURE_TITLE_TO_UPPERCASE"))
+    puts(ctx.flag("FEATURE_TITLE_TO_UPPERCASE"))
+    puts(settings.fh_config.repository.feature("FEATURE_TITLE_TO_UPPERCASE").feature_type)
+    puts(settings.fh_config.repository.feature("FEATURE_TITLE_TO_UPPERCASE").flag)
+
+    new_title&.strip
+  end
+end

data/examples/sinatra/build.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+docker build -t featurehub/ruby-todo:1.0 .

data/examples/sinatra/conf/nginx.conf

@@ -0,0 +1,57 @@
+worker_processes  5;
+env RACK_MULTIPART_PART_LIMIT=256;
+error_log /dev/stderr;
+
+include /etc/nginx/modules-enabled/*.conf;
+
+events {
+  worker_connections  1024;
+}
+
+http {
+
+
+  passenger_user_switching on;
+  passenger_user root;
+  passenger_default_user root;
+
+  passenger_max_pool_size 6;
+
+  passenger_disable_security_update_check on;
+  passenger_disable_anonymous_telemetry on;
+
+  include /etc/nginx/conf/vhosts/*.conf;
+  include /etc/nginx/conf.d/*.conf;
+
+  include       mime.types;
+  default_type  application/octet-stream;
+
+  sendfile        on;
+
+  keepalive_timeout  65;
+  server {
+    access_log /dev/stdout;
+    listen 8099 default_server;
+    server_name localhost;
+    root /app/featurehub;
+    passenger_app_root /app/featurehub;
+    passenger_enabled on;
+    passenger_startup_file config.ru;
+    passenger_app_type rack;
+
+    client_max_body_size 50M;
+
+    error_page 500 502 503 504  /50x.html;
+    location = /50x.html {
+      root   html;
+    }
+
+    location /nginx_status {
+      stub_status on;
+      access_log off;
+      allow 127.0.0.1;
+      allow 10.0.0.0/8;
+      deny all;
+    }
+  }
+}

data/examples/sinatra/conf/nsswitch.conf

@@ -0,0 +1,21 @@
+# /etc/nsswitch.conf
+#
+# Example configuration of GNU Name Service Switch functionality.
+# If you have the `glibc-doc-reference' and `info' packages installed, try:
+# `info libc "Name Service Switch"' for information about this file.
+
+passwd:         compat extrausers
+group:          compat extrausers
+shadow:         compat extrausers
+gshadow:        files
+
+hosts:          files dns
+networks:       files
+
+protocols:      db files
+services:       db files
+ethers:         db files
+rpc:            db files
+
+netgroup:       nis
+

data/examples/sinatra/config.ru

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "app/application"
+
+require "bundler"
+Bundler.setup(:default)
+
+if defined?(PhusionPassenger)
+  PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    if forked
+      puts("process forking, create a new edge instance #{App.settings}")
+      App.settings.fh_config.force_new_edge_service
+    end
+  end
+end
+
+run App

data/examples/sinatra/docker_start.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+export FEATUREHUB_EDGE_URL=http://host.docker.internal:8085
+docker run --rm -p 8099:8099 --name sinatra --entrypoint "/usr/sbin/nginx"  -e FEATUREHUB_EDGE_URL -e FEATUREHUB_CLIENT_API_KEY docker.io/featurehub/ruby-todo:1.0 -g "daemon off;"

data/examples/sinatra/sinatra.iml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="jdk" jdkName="rbenv: 3.0.6" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.10, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="domain_name (v0.5.20190701, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="eventmachine (v1.2.7, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ffi (v1.15.5, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ffi-compiler (v1.0.1, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="http-cookie (v1.0.5, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="http-form_data (v2.3.0, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="llhttp-ffi (v0.4.0, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby2_keywords (v0.0.5, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="sem_version (v2.0.1, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unf (v0.1.4, rbenv: 3.0.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.8.2, rbenv: 3.0.6) [gem]" level="application" />
+  </component>
+</module>

data/examples/sinatra/start.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+RACK_ENV=development
+bundle exec thin -R thin.ru -a 0.0.0.0 -p 8099 start

data/examples/sinatra/thin.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "thin"
+require_relative "app/application"
+
+require "bundler"
+Bundler.setup(:default)
+
+run App

data/featurehub-ruby-sdk.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

data/featurehub-sdk.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "feature_hub/sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "featurehub-sdk"
+  spec.version = FeatureHub::Sdk::VERSION
+  spec.authors = ["Richard Vowles", "Irina Southwell"]
+  spec.email = ["richard@bluetrainsoftware.com"]
+
+  spec.summary = "FeatureHub Ruby SDK"
+  spec.description = "FeatureHub Ruby SDK"
+  spec.homepage = "https://www.featurehub.io"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/featurehub-io/featurehub-ruby-sdk"
+  spec.metadata["changelog_uri"] = "https://github.com/featurehub-io/featurehub-ruby-sdk/featurehub-sdk/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "concurrent-ruby", "~> 1.3"
+  spec.add_dependency "faraday", "~> 2"
+  spec.add_dependency "ld-eventsource", "~> 2.3.0"
+  spec.add_dependency "murmurhash3", "~> 0.1.7"
+  spec.add_dependency "sem_version", "~> 2.0.0"
+end

data/lib/feature_hub/sdk/feature_hub_config.rb

@@ -110,14 +110,12 @@ module FeatureHub
         FeatureHub::Sdk::StreamingEdgeService.new(repo, api_keys, edge_url, logger)
       end
 
-      # rubocop:disable Style/GuardClause
       def detect_client_evaluated(api_keys)
         @client_evaluated = !api_keys.detect { |k| k.include?("*") }.nil?
         if api_keys.detect { |k| (@client_evaluated && !k.include?("*")) || (!@client_evaluated && k.include?("*")) }
           raise "api keys must all be of one type"
         end
       end
-      # rubocop:enable Style/GuardClause
 
       def parse_edge_url(edge_url)
         if edge_url[-1] == "/"

data/lib/feature_hub/sdk/impl/rollout_holders.rb

@@ -73,11 +73,11 @@ module FeatureHub
         end
 
         def float_values
-          @values.filter { |x| !x.nil? }.map(&:to_f)
+          @values.compact.map(&:to_f)
         end
 
         def str_values
-          @values.filter { |x| !x.nil? }.map(&:to_s)
+          @values.compact.map(&:to_s)
         end
 
         def to_s
@@ -96,7 +96,7 @@ module FeatureHub
           @id = strategy["id"]
           @name = strategy["name"]
           @percentage = (strategy["percentage"] || "0").to_i
-          @percentage_attributes = (strategy["percentageAttributes"] || [])
+          @percentage_attributes = strategy["percentageAttributes"] || []
           @value = strategy["value"]
         end
 

data/lib/feature_hub/sdk/streaming_edge_service.rb

@@ -82,7 +82,7 @@ module FeatureHub
 
         return unless must_close
 
-        close  # try again
+        close # try again
       end
 
       def process_config(json_data)

data/lib/feature_hub/sdk/version.rb

@@ -3,7 +3,7 @@
 module FeatureHub
   # already documented elsewhere
   module Sdk
-    VERSION = "1.2.3"
+    VERSION = "1.3.0"
 
     def default_logger
       log = ::Logger.new($stdout)

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: featurehub-sdk
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Richard Vowles
 - Irina Southwell
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -17,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -45,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: murmurhash3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
   name: sem_version
   requirement: !ruby/object:Gem::Requirement
@@ -95,8 +94,112 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - LICENSE.txt
+- README.md
 - Rakefile
+- examples/rails_example/.env.example
+- examples/rails_example/.gitattributes
+- examples/rails_example/.gitignore
+- examples/rails_example/.ruby-version
+- examples/rails_example/Dockerfile
+- examples/rails_example/Gemfile
+- examples/rails_example/Gemfile.lock
+- examples/rails_example/README.md
+- examples/rails_example/Rakefile
+- examples/rails_example/app/assets/config/manifest.js
+- examples/rails_example/app/assets/images/.keep
+- examples/rails_example/app/assets/stylesheets/application.css
+- examples/rails_example/app/channels/application_cable/channel.rb
+- examples/rails_example/app/channels/application_cable/connection.rb
+- examples/rails_example/app/controllers/application_controller.rb
+- examples/rails_example/app/controllers/concerns/.keep
+- examples/rails_example/app/controllers/home_controller.rb
+- examples/rails_example/app/helpers/application_helper.rb
+- examples/rails_example/app/helpers/home_helper.rb
+- examples/rails_example/app/javascript/application.js
+- examples/rails_example/app/javascript/controllers/application.js
+- examples/rails_example/app/javascript/controllers/hello_controller.js
+- examples/rails_example/app/javascript/controllers/index.js
+- examples/rails_example/app/jobs/application_job.rb
+- examples/rails_example/app/mailers/application_mailer.rb
+- examples/rails_example/app/models/application_record.rb
+- examples/rails_example/app/models/concerns/.keep
+- examples/rails_example/app/views/home/index.html.erb
+- examples/rails_example/app/views/layouts/application.html.erb
+- examples/rails_example/app/views/layouts/mailer.html.erb
+- examples/rails_example/app/views/layouts/mailer.text.erb
+- examples/rails_example/bin/bundle
+- examples/rails_example/bin/importmap
+- examples/rails_example/bin/rails
+- examples/rails_example/bin/rake
+- examples/rails_example/bin/setup
+- examples/rails_example/config.ru
+- examples/rails_example/config/application.rb
+- examples/rails_example/config/boot.rb
+- examples/rails_example/config/cable.yml
+- examples/rails_example/config/credentials.yml.enc
+- examples/rails_example/config/database.yml
+- examples/rails_example/config/environment.rb
+- examples/rails_example/config/environments/development.rb
+- examples/rails_example/config/environments/production.rb
+- examples/rails_example/config/environments/test.rb
+- examples/rails_example/config/importmap.rb
+- examples/rails_example/config/initializers/assets.rb
+- examples/rails_example/config/initializers/content_security_policy.rb
+- examples/rails_example/config/initializers/featurehub.rb
+- examples/rails_example/config/initializers/filter_parameter_logging.rb
+- examples/rails_example/config/initializers/inflections.rb
+- examples/rails_example/config/initializers/permissions_policy.rb
+- examples/rails_example/config/locales/en.yml
+- examples/rails_example/config/puma.rb
+- examples/rails_example/config/routes.rb
+- examples/rails_example/config/storage.yml
+- examples/rails_example/db/seeds.rb
+- examples/rails_example/lib/assets/.keep
+- examples/rails_example/lib/tasks/.keep
+- examples/rails_example/log/.keep
+- examples/rails_example/public/404.html
+- examples/rails_example/public/422.html
+- examples/rails_example/public/500.html
+- examples/rails_example/public/apple-touch-icon-precomposed.png
+- examples/rails_example/public/apple-touch-icon.png
+- examples/rails_example/public/favicon.ico
+- examples/rails_example/public/robots.txt
+- examples/rails_example/storage/.keep
+- examples/rails_example/test/application_system_test_case.rb
+- examples/rails_example/test/channels/application_cable/connection_test.rb
+- examples/rails_example/test/controllers/.keep
+- examples/rails_example/test/controllers/home_controller_test.rb
+- examples/rails_example/test/fixtures/files/.keep
+- examples/rails_example/test/helpers/.keep
+- examples/rails_example/test/integration/.keep
+- examples/rails_example/test/mailers/.keep
+- examples/rails_example/test/models/.keep
+- examples/rails_example/test/system/.keep
+- examples/rails_example/test/test_helper.rb
+- examples/rails_example/tmp/.keep
+- examples/rails_example/tmp/pids/.keep
+- examples/rails_example/tmp/storage/.keep
+- examples/rails_example/vendor/.keep
+- examples/rails_example/vendor/javascript/.keep
+- examples/sinatra/.gitignore
+- examples/sinatra/.ruby-version
+- examples/sinatra/Dockerfile
+- examples/sinatra/Gemfile
+- examples/sinatra/Gemfile.lock
+- examples/sinatra/README.adoc
+- examples/sinatra/app/application.rb
+- examples/sinatra/build.sh
+- examples/sinatra/conf/nginx.conf
+- examples/sinatra/conf/nsswitch.conf
+- examples/sinatra/config.ru
+- examples/sinatra/docker_start.sh
+- examples/sinatra/sinatra.iml
+- examples/sinatra/start.sh
+- examples/sinatra/thin.ru
+- featurehub-ruby-sdk.iml
+- featurehub-sdk.gemspec
 - featurehub-sdk.iml
 - lib/feature_hub/sdk/context.rb
 - lib/feature_hub/sdk/feature_hub_config.rb
@@ -124,7 +227,6 @@ metadata:
   source_code_uri: https://github.com/featurehub-io/featurehub-ruby-sdk
   changelog_uri: https://github.com/featurehub-io/featurehub-ruby-sdk/featurehub-sdk/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,15 +234,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.6
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: FeatureHub Ruby SDK
 test_files: []