flipper 0.20.0.beta2 → 0.20.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d324a4fa07054c9c189fba3f8baa100e4c4a70ae4618b251c84be77f56e27e54
-  data.tar.gz: 73a1ff5ddfdfbf04f43296fb0dfe67dd0cf2a3ab094d35909462dfa30fc9ba87
+  metadata.gz: 6fcb4dd7f20ac1164f7c3add8fc0bee2480926618b312dbb207375a9be171bf7
+  data.tar.gz: a81b1fb51952ab430d26ca52975dad38122643198b8ef1a874f8fe3c2cbaf0fa
 SHA512:
-  metadata.gz: 5ae1cde3eef862c76a40f6166deb59406a5f8a3560829220fd4291c614e4fd8eb91d300ad2eb218f81e433a447e90c6d88fea194ad05d9e27ea5a282bac51dfe
-  data.tar.gz: 33e3c151261a516fc9cf5b8415c57c472f5a5560d6670815f872b71cbf99293c79a1e7f1788e2db6a262f7c3b7e8ec2479717b59cdd6dba2cdc52945d9fc5c1b
+  metadata.gz: 2bf630be6690b4570443cefd44ac81ab801522e5b1be35f2357c45fa85c7503f1feb99abd4e01749d0fef1b1c941d53f91f0fc97ab38994a0c453533a00f7183
+  data.tar.gz: 536bad899391a69ac8380933fe151a1ede241e0ffaa43992cc42367394ad7f0adf51d8434740e9db31cd4c1fdc61debd5d0a5c7188a4f21a71aee4a27d31f5ac

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis
+        ports: ['6379:6379']
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7']
+    env:
+      RAILS_VERSION: 6.0.0
+      SQLITE3_VERSION: 1.4.1
+      REDIS_URL: redis://localhost:6379/0
+    steps:
+      - name: Setup memcached
+        uses: KeisukeYamashita/memcached-actions@v1
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.3.0
+        with:
+          mongodb-version: 4.0
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - name: Do some action caching
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gem-
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install libpq-dev
+        run: sudo apt-get -yqq install libpq-dev
+      - name: Install bundler
+        run: gem install bundler
+      - name: Run bundler
+        run: bundle install --jobs 4 --retry 3
+      - name: Run Rake
+        run: bundle exec rake

data/Changelog.md

@@ -1,3 +1,28 @@
+## 0.20.3
+
+### Additions/Changes
+
+* Changed the internal structure of how the memory adapter stores things.
+
+## 0.20.2
+
+### Additions/Changes
+
+* Http adapter now raises error when enable/disable/add/remove/clear fail.
+* Cloud adapter sends some extra info like hostname, ruby version, etc. for debugging and decision making.
+
+## 0.20.1
+
+### Additions/Changes
+
+* Just a minor tweak to cloud webhook middleware to provide more debugging information about why a hook wasn't successful.
+
+## 0.20.0
+
+### Additions/Changes
+
+* Add support for webhooks to `Flipper::Cloud` (https://github.com/jnunemaker/flipper/pull/489).
+
 ## 0.19.1
 
 ### Additions/Changes

data/docs/Optimization.md

@@ -7,7 +7,7 @@ One optimization that flipper provides is a memoizing middleware. The memoizing
 You can use the middleware like so for Rails:
 
 ```ruby
-# setup default instance (perhaps in config/initializer/flipper.rb)
+# setup default instance (perhaps in config/initializers/flipper.rb)
 Flipper.configure do |config|
   config.default do
     Flipper.new(...)
@@ -15,7 +15,7 @@ Flipper.configure do |config|
 end
 
 # This assumes you setup a default flipper instance using configure.
-config.middleware.use Flipper::Middleware::Memoizer
+Rails.configuration.middleware.use Flipper::Middleware::Memoizer
 ```
 
 **Note**: Be sure that the middleware is high enough up in your stack that all feature checks are wrapped.
@@ -23,8 +23,8 @@ config.middleware.use Flipper::Middleware::Memoizer
 **Also Note**: If you haven't setup a default instance, you can pass the instance to `SetupEnv` as `Memoizer` uses whatever is setup in the `env`:
 
 ```ruby
-config.middleware.use Flipper::Middleware::SetupEnv, -> { Flipper.new(...) }
-config.middleware.use Flipper::Middleware::Memoizer
+Rails.configuration.middleware.use Flipper::Middleware::SetupEnv, -> { Flipper.new(...) }
+Rails.configuration.middleware.use Flipper::Middleware::Memoizer
 ```
 
 ### Options
@@ -33,18 +33,18 @@ The Memoizer middleware also supports a few options. Use either `preload` or `pr
 
 * **`:preload`** - An `Array` of feature names (`Symbol`) to preload for every request. Useful if you have features that are used on every endpoint. `preload` uses `Adapter#get_multi` to attempt to load the features in one network call instead of N+1 network calls.
     ```ruby
-    config.middleware.use Flipper::Middleware::Memoizer,
+    Rails.configuration.middleware.use Flipper::Middleware::Memoizer,
       preload: [:stats, :search, :some_feature]
     ```
 * **`:preload_all`** - A Boolean value (default: false) of whether or not all features should be preloaded. Using this results in a `preload_all` call with the result of `Adapter#get_all`. Any subsequent feature checks will be memoized and perform no network calls. I wouldn't recommend using this unless you have few features (< 100?) and nearly all of them are used on every request.
     ```ruby
-    config.middleware.use Flipper::Middleware::Memoizer,
+    Rails.configuration.middleware.use Flipper::Middleware::Memoizer,
       preload_all: true
     ```
 * **`:unless`** - A block that prevents preloading and memoization if it evaluates to true.
     ```ruby
     # skip preloading and memoizing if path starts with /assets
-    config.middleware.use Flipper::Middleware::Memoizer,
+    Rails.configuration.middleware.use Flipper::Middleware::Memoizer,
       unless: ->(request) { request.path.start_with?("/assets") }
     ```
 

data/lib/flipper/adapters/http.rb

@@ -35,12 +35,6 @@ module Flipper
         end
       end
 
-      def add(feature)
-        body = JSON.generate(name: feature.key)
-        response = @client.post('/features', body)
-        response.is_a?(Net::HTTPOK)
-      end
-
       def get_multi(features)
         csv_keys = features.map(&:key).join(',')
         response = @client.get("/features?keys=#{csv_keys}")
@@ -87,51 +81,61 @@ module Flipper
         parsed_response['features'].map { |feature| feature['key'] }.to_set
       end
 
+      def add(feature)
+        body = JSON.generate(name: feature.key)
+        response = @client.post('/features', body)
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+        true
+      end
+
       def remove(feature)
         response = @client.delete("/features/#{feature.key}")
-        response.is_a?(Net::HTTPNoContent)
+        raise Error, response unless response.is_a?(Net::HTTPNoContent)
+        true
       end
 
       def enable(feature, gate, thing)
         body = request_body_for_gate(gate, thing.value.to_s)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
         response = @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
-        response.is_a?(Net::HTTPOK)
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+        true
       end
 
       def disable(feature, gate, thing)
         body = request_body_for_gate(gate, thing.value.to_s)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
-        response =
-          case gate.key
-          when :percentage_of_actors, :percentage_of_time
-            @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
-          else
-            @client.delete("/features/#{feature.key}/#{gate.key}#{query_string}", body)
-          end
-        response.is_a?(Net::HTTPOK)
+        response = case gate.key
+        when :percentage_of_actors, :percentage_of_time
+          @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
+        else
+          @client.delete("/features/#{feature.key}/#{gate.key}#{query_string}", body)
+        end
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+        true
       end
 
       def clear(feature)
         response = @client.delete("/features/#{feature.key}/clear")
-        response.is_a?(Net::HTTPNoContent)
+        raise Error, response unless response.is_a?(Net::HTTPNoContent)
+        true
       end
 
       private
 
       def request_body_for_gate(gate, value)
         data = case gate.key
-               when :boolean
-                 {}
-               when :groups
-                 { name: value }
-               when :actors
-                 { flipper_id: value }
-               when :percentage_of_actors, :percentage_of_time
-                 { percentage: value }
-               else
-                 raise "#{gate.key} is not a valid flipper gate key"
-               end
+        when :boolean
+          {}
+        when :groups
+          { name: value }
+        when :actors
+          { flipper_id: value }
+        when :percentage_of_actors, :percentage_of_time
+          { percentage: value }
+        else
+          raise "#{gate.key} is not a valid flipper gate key"
+        end
         JSON.generate(data)
       end
 

data/lib/flipper/adapters/memory.rb

@@ -20,58 +20,57 @@ module Flipper
 
       # Public: The set of known features.
       def features
-        read_feature_keys
+        @source.keys.to_set
       end
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
-        features.add(feature.key)
+        @source[feature.key] ||= default_config
         true
       end
 
       # Public: Removes a feature from the set of known features and clears
       # all the values for the feature.
       def remove(feature)
-        features.delete(feature.name.to_s)
-        clear(feature)
+        @source.delete(feature.key)
         true
       end
 
       # Public: Clears all the gate values for a feature.
       def clear(feature)
-        feature.gates.each do |gate|
-          delete key(feature, gate)
-        end
+        @source[feature.key] = default_config
         true
       end
 
       # Public
       def get(feature)
-        read_feature(feature)
+        @source[feature.key] || default_config
       end
 
       def get_multi(features)
-        read_many_features(features)
+        result = {}
+        features.each do |feature|
+          result[feature.key] = @source[feature.key] || default_config
+        end
+        result
       end
 
       def get_all
-        features = read_feature_keys.map do |key|
-          Flipper::Feature.new(key, self)
-        end
-
-        read_many_features(features)
+        @source
       end
 
       # Public
       def enable(feature, gate, thing)
+        @source[feature.key] ||= default_config
+
         case gate.data_type
         when :boolean
           clear(feature)
-          write key(feature, gate), thing.value.to_s
+          @source[feature.key][gate.key] = thing.value.to_s
         when :integer
-          write key(feature, gate), thing.value.to_s
+          @source[feature.key][gate.key] = thing.value.to_s
         when :set
-          set_add key(feature, gate), thing.value.to_s
+          @source[feature.key][gate.key] << thing.value.to_s
         else
           raise "#{gate} is not supported by this adapter yet"
         end
@@ -81,13 +80,15 @@ module Flipper
 
       # Public
       def disable(feature, gate, thing)
+        @source[feature.key] ||= default_config
+
         case gate.data_type
         when :boolean
           clear(feature)
         when :integer
-          write key(feature, gate), thing.value.to_s
+          @source[feature.key][gate.key] = thing.value.to_s
         when :set
-          set_delete key(feature, gate), thing.value.to_s
+          @source[feature.key][gate.key].delete thing.value.to_s
         else
           raise "#{gate} is not supported by this adapter yet"
         end
@@ -103,81 +104,6 @@ module Flipper
         ]
         "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
       end
-
-      private
-
-      def read_feature_keys
-        set_members(FeaturesKey)
-      end
-
-      # Private
-      def key(feature, gate)
-        "feature/#{feature.key}/#{gate.key}"
-      end
-
-      def read_many_features(features)
-        result = {}
-        features.each do |feature|
-          result[feature.key] = read_feature(feature)
-        end
-        result
-      end
-
-      def read_feature(feature)
-        result = {}
-
-        feature.gates.each do |gate|
-          result[gate.key] =
-            case gate.data_type
-            when :boolean, :integer
-              read key(feature, gate)
-            when :set
-              set_members key(feature, gate)
-            else
-              raise "#{gate} is not supported by this adapter yet"
-            end
-        end
-
-        result
-      end
-
-      # Private
-      def read(key)
-        @source[key.to_s]
-      end
-
-      # Private
-      def write(key, value)
-        @source[key.to_s] = value.to_s
-      end
-
-      # Private
-      def delete(key)
-        @source.delete(key.to_s)
-      end
-
-      # Private
-      def set_add(key, value)
-        ensure_set_initialized(key)
-        @source[key.to_s].add(value.to_s)
-      end
-
-      # Private
-      def set_delete(key, value)
-        ensure_set_initialized(key)
-        @source[key.to_s].delete(value.to_s)
-      end
-
-      # Private
-      def set_members(key)
-        ensure_set_initialized(key)
-        @source[key.to_s]
-      end
-
-      # Private
-      def ensure_set_initialized(key)
-        @source[key.to_s] ||= Set.new
-      end
     end
   end
 end

data/lib/flipper/adapters/sync/interval_synchronizer.rb

@@ -19,7 +19,7 @@ module Flipper
         # Public: Initializes a new interval synchronizer.
         #
         # synchronizer - The Synchronizer to call when the interval has passed.
-        # interval - The Integer number of milliseconds between invocations of
+        # interval - The Integer number of seconds between invocations of
         #            the wrapped synchronizer.
         def initialize(synchronizer, interval: nil)
           @synchronizer = synchronizer

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.0.beta2'.freeze
+  VERSION = '0.20.3'.freeze
 end

data/spec/flipper/adapters/http_spec.rb

@@ -76,9 +76,9 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.get(flipper[:feature_panel])
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 
@@ -88,9 +88,9 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.get_multi([flipper[:feature_panel]])
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 
@@ -100,9 +100,9 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.get_all
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 
@@ -112,9 +112,75 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.features
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#add" do
+    it "raises error when not successful" do
+      stub_request(:post, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.add(Flipper::Feature.new(:search, adapter))
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#remove" do
+    it "raises error when not successful" do
+      stub_request(:delete, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.remove(Flipper::Feature.new(:search, adapter))
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#clear" do
+    it "raises error when not successful" do
+      stub_request(:delete, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.clear(Flipper::Feature.new(:search, adapter))
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#enable" do
+    it "raises error when not successful" do
+      stub_request(:post, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      feature = Flipper::Feature.new(:search, adapter)
+      gate = feature.gate(:boolean)
+      thing = gate.wrap(true)
+      expect {
+        adapter.enable(feature, gate, thing)
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#disable" do
+    it "raises error when not successful" do
+      stub_request(:delete, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      feature = Flipper::Feature.new(:search, adapter)
+      gate = feature.gate(:boolean)
+      thing = gate.wrap(false)
+      expect {
+        adapter.disable(feature, gate, thing)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 

data/spec/flipper/adapters/memory_spec.rb

@@ -2,7 +2,27 @@ require 'helper'
 require 'flipper/spec/shared_adapter_specs'
 
 RSpec.describe Flipper::Adapters::Memory do
-  subject { described_class.new }
+  let(:source) { {} }
+  subject { described_class.new(source) }
 
   it_should_behave_like 'a flipper adapter'
+
+  it "can initialize from big hash" do
+    flipper = Flipper.new(subject)
+    flipper.enable :subscriptions
+    flipper.disable :search
+    flipper.enable_percentage_of_actors :pro_deal, 20
+    flipper.enable_percentage_of_time :logging, 30
+    flipper.enable_actor :following, Flipper::Actor.new('1')
+    flipper.enable_actor :following, Flipper::Actor.new('3')
+    flipper.enable_group :following, Flipper::Types::Group.new(:staff)
+
+    expect(source).to eq({
+      "subscriptions" => subject.default_config.merge(boolean: "true"),
+      "search" => subject.default_config,
+      "logging" => subject.default_config.merge(:percentage_of_time => "30"),
+      "pro_deal" => subject.default_config.merge(:percentage_of_actors => "20"),
+      "following" => subject.default_config.merge(actors: Set["1", "3"], groups: Set["staff"]),
+    })
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.20.0.beta2
+  version: 0.20.3
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-14 00:00:00.000000000 Z
+date: 2021-01-10 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -18,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/ci.yml"
 - CODE_OF_CONDUCT.md
 - Changelog.md
 - Dockerfile
@@ -168,9 +169,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: