ffeature 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 646340342d1aa9998f7450ea4241cb14aec3a49c
+  data.tar.gz: 1396b0f16f21a306acb1186c589e2d3412beec36
+SHA512:
+  metadata.gz: 91fbc87c852569ecb8f501e1e786165b31bb07b7abfd4d53f08ef990f1d66705035adad69e0b2a00375f9582f3cbcc4bf1e84d0641faa28758f5b80628681814
+  data.tar.gz: 81754305fae394915bb46a28fff54b8419543a7064217d821fb54edaf7514dd5ca282c47a8b58b545309a63ee98ce0be7410f636ba59cb932e6db1dd0b14ce68

data/README.md

@@ -0,0 +1,59 @@
+# FFeature
+
+[![Build Status](https://travis-ci.org/fs/ffeature.svg?branch=master)](https://travis-ci.org/fs/ffeature)
+[![Dependency Status](https://gemnasium.com/badges/github.com/fs/ffeature.svg)](https://gemnasium.com/github.com/fs/ffeature)
+
+This is simple wrapper around Flipper for Rails projects to remove ugly global variables like `$flipper`.
+
+## Usage
+
+* `ffeature?(feature, user = current_user)` helper in views and controllers
+* `FFeature.enabled?(feature, user)` helper for PORO
+
+Here `user` or `current_user` should respond to `tester?` method to determine feature status for specific user.
+
+## Configuration
+
+You can configure `FFeature` in `config/inititalizers/ffeature.rb`
+
+```ruby
+# config/inititalizers/ffeature.rb
+
+require "flipper"
+require "flipper/adapters/redis"
+
+url = ENV.fetch("REDISTOGO_URL", ENV.fetch("REDIS_URL", nil))
+url = URI.parse(url) if url.present?
+
+redis = Redis.new(url: url)
+adapter = Flipper::Adapters::Redis.new(redis)
+
+FFeature.configure do |config|
+  config.features = %i(user_management)
+  config.ip_whitelist = ENV.fetch("FLIPPER_UI_IP_WHITELIST", "").split(",")
+  config.flipper = Flipper.new(adapter)
+  config.dev_mode = ENV["FEATURE_DEV_MODE"].present?
+end
+```
+
+Following options are available:
+* `features` – list of features registered for testers
+* `ip_whitelist` – list of IP addresses, could be used to configure FlipperUI route constraints
+* `dev_mode` – if enabled all features considered enabled for all users
+
+## FlipperUI
+
+You can use FlipperUI to have more robust control over features.
+
+```ruby
+# config/routes.rb
+constraints(->(request) { FFeature.ip_allowed?(request.remote_ip) }) do
+  mount Flipper::UI.app(FFeature.flipper) => "/flipper"
+end
+```
+## Credits
+
+FFeature is maintained and was written by [Flatstack](http://www.flatstack.com) with the help of our
+[contributors](http://github.com/fs/ffeature/contributors).
+
+[<img src="http://www.flatstack.com/logo.svg" width="100"/>](http://www.flatstack.com)

data/lib/ffeature/feature.rb

@@ -0,0 +1,15 @@
+module FFeature
+  class Feature
+    attr_reader :feature
+    private :feature
+
+    def initialize(feature)
+      @feature = feature
+    end
+
+    def enabled?(user)
+      return true if FFeature.dev_mode
+      FFeature.flipper[feature].enabled?(user.to_model)
+    end
+  end
+end

data/lib/ffeature/helper.rb

@@ -0,0 +1,15 @@
+module FFeature
+  module Helper
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :feature?
+    end
+
+    private
+
+    def ffeature?(feature, user = current_user)
+      FFeature.enabled?(feature, user)
+    end
+  end
+end

data/lib/ffeature/version.rb

@@ -0,0 +1,3 @@
+module FFeature
+  VERSION = "0.0.1".freeze
+end

data/lib/ffeature.rb

@@ -0,0 +1,44 @@
+require "bundler/setup"
+Bundler.setup
+
+require "flipper"
+require "active_support/core_ext/module/attribute_accessors"
+
+require "ffeature/version"
+require "ffeature/feature"
+
+module FFeature
+  cattr_accessor :ip_whitelist
+  self.ip_whitelist = []
+
+  cattr_accessor :dev_mode
+  self.dev_mode = false
+
+  cattr_accessor :features
+  self.features = %i(user_management)
+
+  cattr_accessor :flipper
+  self.flipper = nil
+
+  def self.configure
+    yield(self)
+
+    Flipper.register(:testers, &:tester?)
+
+    features.each do |feature|
+      flipper[feature].enable(flipper.group(:testers))
+    end
+  end
+
+  def self.reset!
+    Flipper.unregister_groups
+  end
+
+  def self.ip_allowed?(ip)
+    ip_whitelist.include?(ip)
+  end
+
+  def self.enabled?(feature, user)
+    Feature.new(feature).enabled?(user)
+  end
+end

data/lib/railtie.rb

@@ -0,0 +1,11 @@
+require "ffeature/helper"
+
+module FFeature
+  class Railtie < Rails::Railtie
+    initializer "ffeature.configure_view_controller" do |_app|
+      ActiveSupport.on_load :action_controller do
+        include FFeature::Helper
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: ffeature
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Timur Vafin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: flipper
+  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'
+- !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: bundler-audit
+  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: 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: rubocop-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'
+description: Flipper Helper
+email:
+- timur.vafin@flatstack.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ffeature.rb
+- lib/ffeature/feature.rb
+- lib/ffeature/helper.rb
+- lib/ffeature/version.rb
+- lib/railtie.rb
+homepage: https://github.com/fs/flipper-helper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Flipper Helper
+test_files: []