feature_flag_client 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10eaa56f76079b041f451559fdba1ba2d3e1d12d5d3a497f319c1e6253b9f326
-  data.tar.gz: e5104709f1d61669e7190909ff75734f0d63449a5d0f274b184c93351448924c
+  metadata.gz: 7065c7ae5de763c0b60757abd3acd69d954cfbcd061fc7111dc1eaa2528b07a7
+  data.tar.gz: 4bbf3c3ea64cfe1e0d930b7c8354b5e1d9d7d9bb14ac79f6d64976c7554e38d1
 SHA512:
-  metadata.gz: 49fcb38b5df36aed09a6f2841a88d2055c3080a72ed681538965e3ffad100a6d8012566d8f15098a37de2a79d9111d6d07c41e9f02bf24baa6ce6a02fe3b1a47
-  data.tar.gz: 9ce9be77d991a86dcd8ef6603126fc8f0d57c4a907e8de3e8c642e07dea82b1ee86218258c27d6585d94effebcc6781e67a0dcd8e5f199ad40a7efc282bce751
+  metadata.gz: 4f46c05adc2f1ab77e7346bdaafe93dcb9a45c24cd02776c8eba35271eb39aa2d60a0bf38ad98c813ff611c50d4a79c49881fe339145968959fcfc0d3cecbd31
+  data.tar.gz: bb6dca6a4596fd467c59738befcf6966cdc5b7665e0caee51139bf6dbe29197c7931aa3e8c3306ab9dda6c4bbc480cecd18d9bdbc3799f3682464c616d352fcc

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0
+
+* Fix the wrong documentation on configuration in README
+* Add `FeaturesCollection` to improve the interface of feature data
 ## 0.2.2
 
 * Update readme with usage and out of date description

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    feature_flag_client (0.2.1)
+    feature_flag_client (0.3.0)
       httparty (~> 0.17.3)
       mini_cache (~> 1.1)
 
@@ -19,7 +19,7 @@ GEM
       multi_xml (>= 0.5.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    mime-types-data (3.2020.1104)
     mini_cache (1.1.0)
     multi_xml (0.6.0)
     parallel (1.19.2)

data/README.md

@@ -24,23 +24,31 @@ Or install it yourself as:
     require 'feature_flag_client'
 
     # In some initializer
-    FeatureFlagClient::Configure do |config|
+    FeatureFlagClient::Client.configure do |config|
         # Main resource API to get feature flags
-        config.api_base_url = 'https://api-feature-flag-service.eu-west-1.elb.amazonaws.com/api/v1'
+        config.api_base_url = 'https://yeahrnb59i.execute-api.eu-west-1.amazonaws.com/dev/api/v1'
 
         # Featureflag service Auth api to get access token
-        config.auth_url = 'https://api-feature-flag-service.eu-west-1.elb.amazonaws.com/auth/token'
+        config.auth_url = 'https://yeahrnb59i.execute-api.eu-west-1.amazonaws.com/dev/auth/token'
 
         # client id and secret to get access token
-        config.client_id = '645da701fce2a12c'
-        config.client_secret = '13c77fa6f8e742fa036cd9f9afa912A@' # store this in a secret manager
+        config.client_id = 'xxxx'
+        config.client_secret = 'xxxxxxxxxxxxxxxxxxxx' # store this in a secret manager
     end
 
     # Elsewhere in the code
     client = FeatureFlagClient.new
     product_name = 'cool product'
-    client.features('cool product')
-    # => {"feature name"=>#<OpenStruct name="feature name", enabled=false, createdAt="2020-09-08T22:08:07.971Z", updatedAt="2020-09-18T23:37:59.479Z">, "feature name 2"=>#<OpenStruct name="feature name 2", enabled=true, createdAt="2020-09-08T22:08:14.309Z", updatedAt="2020-09-11T14:27:29.678Z">, "Magic Feature"=>#<OpenStruct name="Magic Feature", enabled=true, createdAt="2020-09-11T14:27:39.515Z", updatedAt="2020-09-11T14:27:45.873Z">}
+    features = client.features('cool product')
+    # => #<FeatureFlagClient::FeatureCollection:0x00007fb1981a32f8 @features={"qr-logo"=>#<OpenStruct name="qr-logo", enabled=true, createdAt="2020-12-15T14:07:50.274Z", updatedAt="2020-12-15T15:28:46.162Z">, "qr code 2"=>#<OpenStruct name="qr code 2", enabled=false, createdAt="2020-12-15T15:28:52.065Z", updatedAt="2020-12-15T15:28:52.066Z">}>
+
+    features.feature('qr-logo').enabled
+    # => true
+
+    # When looking for a non-existing feature
+    features.feature('non-existing')
+    # => nil
+
 ```
 
 ## Development

data/lib/feature_flag_client/client.rb

@@ -52,12 +52,31 @@ module FeatureFlagClient
     end
   end
 
+  class FeatureCollection
+    attr_reader :features
+
+    def initialize(_features)
+      p _features
+      @features = _features
+    end
+
+    def feature(name)
+      features[name]
+    end
+
+    def to_json(*_args)
+      features.keys.each_with_object({}) do |feature_name, result|
+        result[feature_name] = feature(feature_name).marshal_dump
+      end.to_json
+    end
+  end
+
   # Api Client class to fetch the features
   class Client
     include FeatureFlagClient::Version
 
     CACHE_KEY = 'features'
-    CACHE_TTL = 3600
+    CACHE_TTL = 60
 
     def self.config
       @config ||= FeatureFlagClient::Configuration.new
@@ -84,7 +103,7 @@ module FeatureFlagClient
 
         raise ClientError, response.error unless response.ok?
 
-        cache.set("#{CACHE_KEY}_#{product_name}", response.parsed, expires_in: CACHE_TTL)
+        cache.set("#{CACHE_KEY}_#{product_name}", FeatureCollection.new(response.parsed), expires_in: CACHE_TTL)
       end
 
       cache.get("#{CACHE_KEY}_#{product_name}")

data/lib/feature_flag_client/client/version.rb

@@ -2,6 +2,6 @@
 
 module FeatureFlagClient
   module Version
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_flag_client
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Ardeshir Eshghi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2020-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty