rollout_service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4eb23b9f1860c997270a8133701f70fbf8dc7ec
+  data.tar.gz: 9998ef0936cc0b713ca92d44c78ae4b0bf57624b
+SHA512:
+  metadata.gz: 95b8179d34b583a77879ec2dd229522e2eea0d4bfac04b63ad8dc514577b9ba9432370a83a6bc6077a3c29da5f6cd64503fd4af9304d19563a40cb15a303f599
+  data.tar.gz: fab775be9f45b368a6f7cf0fb632295dd12200641b6feacca2ad5494c5ebd971f864dd9a2b13a54973bd2919d7f2965de1e106534a8001a3cdc632411b15dc8c

data/.gitignore

@@ -0,0 +1 @@
+.idea/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in testttt.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    rollout_service (0.1.0)
+      active_attr (~> 0.9.0)
+      activesupport (~> 5.0)
+      grape
+      grape-entity (~> 0.5.0)
+      redis
+      require_all
+      rollout
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_attr (0.9.0)
+      activemodel (>= 3.0.2, < 5.1)
+      activesupport (>= 3.0.2, < 5.1)
+    activemodel (5.0.7)
+      activesupport (= 5.0.7)
+    activesupport (5.0.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.11)
+    grape (1.0.3)
+      activesupport
+      builder
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+      virtus (>= 1.0.0)
+    grape-entity (0.5.2)
+      multi_json (>= 1.3.2)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    mustermann (1.0.2)
+    mustermann-grape (1.0.0)
+      mustermann (~> 1.0.0)
+    rack (2.0.5)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rake (10.5.0)
+    redis (4.0.1)
+    require_all (2.0.0)
+    rollout (2.4.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  rake (~> 10.0)
+  rollout_service!
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,27 @@
+# Rollout-Service
+**A Grape service that expose rollout gem via RESTful endpoints**
+
+This service expose RESTfull endpoints that allows you to perform CRUD operation on [rollout](https://github.com/fetlife/rollout) gem.
+
+This service works great with [Rollout-Dashboard](https://github.com/fiverr/rollout_dashboard) - a beautiful user interface for rollout gem) 
+
+## End-Points Documentation:
+
+| Description   | END POINT     |
+| ------------- | ------------- |
+| Get all features  | GET /api/v1/features  |
+| Get specific feature by name  | GET /api/v1/features/:feature_name  |
+| Get specific feature by name  | GET /api/v1/features/:feature_name  |
+| Check if feature is active  | GET /api/v1/features/:feature_name/:user_id/active  |
+| Create a new feature  | POST /api/v1/features/:feature_name  |
+| Partially update existing feature  | PATCH /api/v1/features/:feature_name  |
+| Delete a feature  | DELETE /api/v1/features/:feature_name  |
+
+
+# FAQ
+
+# How to set redis configuration?
+Edit `./config/redis.yml`
+
+## How to start the service? 
+run `bundle exec rackup -p :port`

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/rollout_service/api/feature_api.rb

@@ -0,0 +1,119 @@
+module RolloutService
+  module API
+    class Features < Grape::API
+
+      get '/' do
+        features = Config.rollout.features
+        features.map! do|feature|
+          Models::Feature.find(feature)
+        end
+
+        RestfulModels::Response.represent(data: features)
+      end
+
+
+      route_param :feature_name do
+        params do
+          requires :feature_name, type: Models::Feature
+        end
+        get '/' do
+          feature = params[:feature_name]
+
+          if feature.valid?
+            RestfulModels::Response.represent(data: feature)
+          else
+            status 500
+            RestfulModels::Response.represent(message: 'Error, feature is not valid')
+          end
+        end
+
+        params do
+          requires :user_id, type: Integer, desc: 'The user ID'
+          requires :feature_name, type: Models::Feature
+        end
+        get '/:user_id/active' do
+          user_id = params[:user_id].to_i
+          feature = params[:feature_name]
+
+          is_active = feature.active?(user_id)
+
+          RestfulModels::Response.represent(data: { active: is_active })
+        end
+
+        params do
+          requires :feature_name, type: Models::Feature
+        end
+        delete '/' do
+          feature = params[:feature_name]
+          feature.delete
+          ''
+        end
+
+        params do
+          requires :description, type: String, desc: 'The feature description'
+          requires :feature_name, type: String
+        end
+        post '/' do
+          feature_name = params[:feature_name]
+          error! 'Feature is already exist!' if Models::Feature.exist?(feature_name)
+
+          options = {
+              name: feature_name,
+              percentage: params[:percentage].to_i,
+              description:  params[:description],
+              author: current_user.name,
+              author_mail:  current_user.email,
+              created_at: Time.current
+          }
+
+          feature = Models::Feature.new(options)
+
+          begin
+            feature.save!
+            Models::Feature.set_users_to_feature(feature, params[:users])
+            RestfulModels::Response.represent(
+                message: 'Feature created successfully!',
+                data: feature
+            )
+          rescue => e
+            status 500
+            RestfulModels::Response.represent(message: "An error has been occurred.\r\n #{e}")
+          end
+        end
+
+        params do
+          requires :feature_name, type: Models::Feature
+        end
+        patch '/' do
+          feature = params[:feature_name]
+
+          options = {
+              percentage: params[:percentage].to_i,
+              description:  params[:description],
+              created_at: Time.current
+          }
+
+          # if the feature for some reason had no author, the current user become
+          if feature.author.blank?
+            options[:author] = current_user.name
+            options[:author_mail] = current_user.email
+          end
+
+          feature.assign_attributes(options)
+
+          begin
+            feature.save!
+            Models::Feature.set_users_to_feature(feature, params[:users])
+            RestfulModels::Response.represent(
+                message: 'Feature updated successfully!',
+                data: feature
+            )
+          rescue => e
+            status 500
+            RestfulModels::Response.represent(message: "An error has been occurred.\r\n #{e}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rollout_service/config/config.rb

@@ -0,0 +1,14 @@
+module RolloutService
+  module Config
+    extend self
+    attr_accessor :rollout, :redis
+
+    def configure
+      yield self
+      raise 'You must provide a redis instance' if redis.blank?
+
+      self.rollout = Rollout.new(redis, use_sets: true)
+    end
+  end
+end
+

data/lib/rollout_service/models/feature.rb

@@ -0,0 +1,107 @@
+module RolloutService
+  module Models
+    class Feature
+      include ActiveAttr::Model
+
+      MAX_HISTORY_RECORDS = 50
+
+      attribute :name, type: String
+      attribute :description, type: String
+      attribute :percentage, type: Integer, default: 0
+      attribute :author, type: String
+      attribute :author_mail, type: String
+      attribute :created_at, type: Date
+      attribute :history, default: []
+      attribute :users, default: []
+
+      validates :name,
+                :description,
+                :percentage,
+                :created_at,
+                :author,
+                :author_mail,
+                presence: true
+
+      def self.parse(name)
+        instance = find(name)
+        raise 'Feature is not exist' if instance.nil?
+        instance
+      end
+
+      def self.find(name)
+        return nil unless exist?(name)
+
+        feature = Config::rollout.get(name)
+        feature_data = feature.data.deep_symbolize_keys!
+
+        feature_data.merge!({
+          name: feature.name,
+          percentage: feature.percentage,
+          users: feature.users
+        })
+
+        feature_data.delete_if {|key, _| !self.method_defined?(key)}
+        
+        self.new(feature_data)
+      end
+
+      def self.exist?(name)
+        features = Config::rollout.features
+        features.include?(name.to_sym)
+      end
+
+      def self.set_users_to_feature(rollout, users)
+        return if users.nil? || rollout.nil?
+        users = users.to_a
+
+        current_active_users = rollout.users
+        users_to_remove = current_active_users - users
+        Config::rollout.deactivate_users(rollout.name ,users_to_remove)
+        Config::rollout.activate_users(rollout.name ,users)
+        rollout.users = users
+        users
+      end
+
+      def save!
+        set_history_attribute
+        raise 'Feature is not valid!' unless self.valid?
+
+        Config::rollout.activate_percentage(self.name, self.percentage)
+
+        feature_data = {
+            history: self.history,
+            description: self.description,
+            author: self.author,
+            author_mail: self.author_mail,
+            created_at: self.created_at
+        }
+
+        feature_data.delete_if { |_, value| value.blank? }
+        Config::rollout.set_feature_data(self.name, feature_data)
+      end
+
+      def active?(user_id)
+        Config::rollout.active?(self.name, user_id)
+      end
+
+      def delete
+        Config::rollout.delete(self.name)
+      end
+
+      private
+
+      def set_history_attribute
+        last_record = history.last
+        return if last_record.present? && last_record[:percentage] == self.percentage
+
+        self.history << {
+            author: self.author,
+            author_mail: self.author_mail,
+            percentage: self.percentage,
+            updated_at: Time.current
+        }
+        self.history = self.history.last(MAX_HISTORY_RECORDS)
+      end
+    end
+  end
+end

data/lib/rollout_service/models/user.rb

@@ -0,0 +1,12 @@
+module RolloutService
+  class User
+    attr_reader :name, :email
+
+    def initialize(env)
+      user = env['User-Details'] || ''
+      name, email = user.split(':')
+      @name = name || 'Anonymous'
+      @email = email || 'anonymous@anonymous.con'
+    end
+  end
+end

data/lib/rollout_service/restful_models/response.rb

@@ -0,0 +1,8 @@
+module RolloutService
+   module RestfulModels
+      class Response < Grape::Entity
+         expose :data, unless: Proc.new {|field| field.blank?}
+         expose :message, if: ->(response, _) { response[:data].blank? }
+      end
+   end
+end

data/lib/rollout_service/version.rb

@@ -0,0 +1,3 @@
+module RolloutService
+  VERSION = "0.1.0"
+end

data/lib/rollout_service.rb

@@ -0,0 +1,27 @@
+require 'rollout_service/version'
+require 'require_all'
+require 'grape'
+require 'grape-entity'
+require 'rollout'
+require 'redis'
+require 'active_support'
+require 'active_attr'
+
+require_rel 'rollout_service/config'
+require_rel 'rollout_service/restful_models'
+require_rel 'rollout_service/models'
+require_rel 'rollout_service/api'
+
+module RolloutService
+  class Service < Grape::API
+    format :json
+
+    helpers do
+      def current_user
+        @current_user ||= User.new(env)
+      end
+    end
+
+    resource(:features) { mount API::Features }
+  end
+end

data/rollout_service.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rollout_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rollout_service"
+  spec.version       = RolloutService::VERSION
+  spec.authors       = ["Fiverr"]
+  spec.email         = ["dev@fiverr.com"]
+  spec.summary       = "This gem exposes rollout gem API"
+  spec.homepage      = "https://www.fiverr.com"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'grape', '~> 1'
+  spec.add_dependency 'grape-entity', '~> 0.5'
+  spec.add_dependency 'rollout', '~> 2.4'
+  spec.add_dependency 'require_all', '~> 2'
+  spec.add_dependency 'activesupport', '~> 5'
+  spec.add_dependency 'active_attr', '~> 0.9'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: rollout_service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fiverr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: grape-entity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rollout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- dev@fiverr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rollout_service.rb
+- lib/rollout_service/api/feature_api.rb
+- lib/rollout_service/config/config.rb
+- lib/rollout_service/models/feature.rb
+- lib/rollout_service/models/user.rb
+- lib/rollout_service/restful_models/response.rb
+- lib/rollout_service/version.rb
+- rollout_service.gemspec
+homepage: https://www.fiverr.com
+licenses: []
+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.2
+signing_key: 
+specification_version: 4
+summary: This gem exposes rollout gem API
+test_files: []