shamu 0.0.1 → 0.0.2

data/spec/lib/shamu/events/in_memory/async_service_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe Shamu::Events::InMemory::AsyncService do
+  let( :service ) { scorpion.new Shamu::Events::InMemory::AsyncService }
+  let( :message ) { Shamu::Events::Message.new }
+
+  describe "#publish" do
+    it "adds message to channel" do
+      expect do
+        service.publish( "spec", message )
+      end.to change { service.channel_stats( "spec" )[ :queue_size ] }
+    end
+
+    it "serializes the message" do
+      expect( service ).to receive( :serialize ).and_call_original
+      service.publish( "spec", message )
+    end
+  end
+
+  describe "#subscribe" do
+    it "receives a message" do
+      expect do |b|
+        service.subscribe "spec", &b
+        service.publish "spec", message
+
+        wait_for { service.channel_stats( "spec" )[ :queue_size ] }.to eq 0
+      end.to yield_control
+    end
+
+    it "deserializes the message" do
+      expect( service ).to receive( :deserialize ).and_call_original
+      service.publish "spec", message
+      wait_for { service.channel_stats( "spec" )[ :queue_size ] }.to eq 0
+    end
+
+  end
+end

data/spec/lib/shamu/events/in_memory/service_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Shamu::Events::InMemory::Service do
+  let( :service ) { scorpion.new Shamu::Events::InMemory::Service }
+  let( :message ) { Shamu::Events::Message.new }
+
+  describe "#publish" do
+    it "adds message to channel" do
+      expect do
+        service.publish( "spec", message )
+      end.to change { service.channel_stats( "spec" )[ :queue_size ] }
+    end
+
+    it "serializes the message" do
+      expect( service ).to receive( :serialize ).and_call_original
+      service.publish( "spec", message )
+    end
+  end
+
+  describe "#subscribe" do
+    it "receives a message" do
+      expect do |b|
+        service.subscribe "spec", &b
+        service.publish "spec", message
+        service.dispatch
+      end.to yield_control
+    end
+
+    it "deserializes the message" do
+      expect( service ).to receive( :deserialize ).and_call_original
+      service.publish "spec", message
+      service.dispatch
+    end
+  end
+
+end

data/spec/lib/shamu/events/message_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Shamu::Events::Message do
+  it "generates an ID" do
+    expect( Shamu::Events::Message.new.id ).to be_present
+  end
+end

data/spec/lib/shamu/events/support_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe Shamu::Events::Support do
+  describe "#event_channel" do
+    {
+      "Users::UsersService" => "users",
+      "Users::ProfileService" => "users/profile",
+      "Users::Profiles::ProfilesService" => "users/profiles",
+      "Service" => "",
+      "Users::Service" => "users"
+    }.each do |name, channel|
+
+      it "is #{ channel } for #{ name }" do
+        klass = Class.new( Shamu::Services::Service ) do
+          include Shamu::Events::Support
+
+          public :event_channel
+        end
+
+        allow( klass ).to receive( :name ).and_return name
+
+        expect( klass.new.event_channel ).to eq channel
+      end
+    end
+  end
+
+  describe "event!" do
+    hunt( :events_service, Shamu::Events::EventsService )
+
+    let( :klass ) do
+      Class.new( Shamu::Services::Service ) do
+        include Shamu::Events::Support
+
+        public :event!
+      end
+    end
+    let( :service ) { scorpion.new klass }
+
+    it "publishes message to events_service" do
+      expect( events_service ).to receive( :publish )
+      service.event! Shamu::Events::Message.new
+    end
+  end
+end

data/spec/lib/shamu/features/conditions/condition_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe Shamu::Features::Conditions do
+  it "finds the proper condition" do
+    condition = Shamu::Features::Conditions::Condition.create "schedule_at", Time.now, double
+    expect( condition ).to be_a Shamu::Features::Conditions::ScheduleAt
+  end
+end

data/spec/lib/shamu/features/conditions/env_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+
+describe Shamu::Features::Conditions::Env do
+  let( :context ) { double( Shamu::Features::Context ) }
+  let( :toggle )  { double( Shamu::Features::Toggle ) }
+
+  it "matches on presence of truthy variable" do
+    condition = scorpion.new Shamu::Features::Conditions::Env, "CANARY", toggle
+
+    expect( context ).to receive( :env ).with( "CANARY" ).and_return "true"
+    expect( condition.match?( context ) ).to be_truthy
+  end
+
+  it "matches on variable value" do
+    condition = scorpion.new Shamu::Features::Conditions::Env, { "CANARY" => "example" }, toggle
+
+    expect( context ).to receive( :env ).with( "CANARY" ).and_return "example"
+    expect( condition.match?( context ) ).to be_truthy
+  end
+
+  it "doesn't match with invalid variable" do
+    condition = scorpion.new Shamu::Features::Conditions::Env, "MISSING_ENV_VARIABLE_NAME", toggle
+
+    expect( context ).to receive( :env ).with( "MISSING_ENV_VARIABLE_NAME" ).and_return nil
+    expect( condition.match?( context ) ).to be_falsy
+  end
+
+end

data/spec/lib/shamu/features/conditions/hosts_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+
+describe Shamu::Features::Conditions::Hosts do
+  let( :context ) { double( Shamu::Features::Context ) }
+  let( :toggle )  { double( Shamu::Features::Toggle ) }
+
+  it "matches using regex" do
+    condition = scorpion.new Shamu::Features::Conditions::Hosts, [ 'web\d+' ], toggle
+
+    expect( context ).to receive( :host ).and_return "web3"
+    expect( condition.match?( context ) ).to be_truthy
+  end
+
+  it "doesn't match using regex" do
+    condition = scorpion.new Shamu::Features::Conditions::Hosts, [ 'web\d+-staging' ], toggle
+
+    expect( context ).to receive( :host ).and_return "web3"
+    expect( condition.match?( context ) ).to be_falsy
+  end
+end

data/spec/lib/shamu/features/conditions/matching_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+
+describe Shamu::Features::Conditions::Matching do
+  let( :context ) { double( Shamu::Features::Context ) }
+  let( :toggle )  { double( Shamu::Features::Toggle ) }
+
+  it "matches if another feature is enabled" do
+    condition = scorpion.new Shamu::Features::Conditions::Matching, "spec/example", toggle
+
+    expect( context ).to receive( :enabled? ).and_return true
+    expect( condition.match?( context ) ).to be_truthy
+  end
+
+  it "doesn't matche if another feature is disabled" do
+    condition = scorpion.new Shamu::Features::Conditions::Matching, "spec/example", toggle
+
+    expect( context ).to receive( :enabled? ).and_return false
+    expect( condition.match?( context ) ).to be_falsy
+  end
+
+
+end

data/spec/lib/shamu/features/conditions/percentage_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+
+describe Shamu::Features::Conditions::Percentage do
+  let( :context ) { double( Shamu::Features::Context ) }
+  let( :toggle )  { double( Shamu::Features::Toggle ) }
+
+  before( :each ) do
+    allow( toggle ).to receive( :name ).and_return "example"
+  end
+
+  it "matches integer user id" do
+    condition = scorpion.new Shamu::Features::Conditions::Percentage, 5, toggle
+
+    expect( context ).to receive( :user_id ).at_least(:once).and_return 55
+    expect( condition.match?( context ) ).to be_truthy
+  end
+
+  it "matches same user id when percentage grows" do
+    condition = scorpion.new Shamu::Features::Conditions::Percentage, 15, toggle
+
+    expect( context ).to receive( :user_id ).at_least(:once).and_return 55
+    expect( condition.match?( context ) ).to be_truthy
+  end
+
+  it "excludes integer user id" do
+    condition = scorpion.new Shamu::Features::Conditions::Percentage, 5, toggle
+
+    expect( context ).to receive( :user_id ).at_least(:once).and_return 111
+    expect( condition.match?( context ) ).to be_falsy
+  end
+
+
+  it "matches uuid user id" do
+    condition = scorpion.new Shamu::Features::Conditions::Percentage, 23, toggle
+
+    expect( context ).to receive( :user_id ).at_least(:once).and_return "45561ca3-5bf9-4f3a-9b4f-89a15ea0e387"
+    expect( condition.match?( context ) ).to be_truthy
+  end
+
+  context "when no user_id" do
+    before( :each ) do
+      allow( context ).to receive( :user_id ).and_return nil
+      allow( context ).to receive( :sticky! )
+    end
+
+    it "assigns randomly" do
+      condition = scorpion.new Shamu::Features::Conditions::Percentage, 5, toggle
+
+      expect( Random ).to receive( :rand ).and_return 0
+      expect( condition.match?( context ) ).to be_truthy
+
+      expect( Random ).to receive( :rand ).and_return 8
+      expect( condition.match?( context ) ).to be_falsy
+    end
+
+    it "makes the assignment sticky" do
+      condition = scorpion.new Shamu::Features::Conditions::Percentage, 5, toggle
+
+      expect( Random ).to receive( :rand ).and_return 0
+      expect( context ).to receive( :sticky! )
+      condition.match?( context )
+    end
+
+    it "is always true at 100%" do
+      condition = scorpion.new Shamu::Features::Conditions::Percentage, 100, toggle
+      expect( condition.match?( context ) ).to be_truthy
+    end
+  end
+
+end

data/spec/lib/shamu/features/conditions/proc_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+module ProcSpec
+  class CustomProc
+    def match?( context )
+    end
+  end
+end
+
+describe Shamu::Features::Conditions::Proc do
+  let( :context ) { double( Shamu::Features::Context ) }
+  let( :toggle )  { double( Shamu::Features::Toggle ) }
+
+  it "invokes the specified match method" do
+    expect( context ).to receive( :scorpion ).and_return scorpion
+
+    condition = scorpion.new Shamu::Features::Conditions::Proc, "ProcSpec::CustomProc#match?", toggle
+
+    instance = condition.send( :instance, context )
+    expect( condition ).to receive( :instance ).and_return instance
+
+    expect( instance ).to be_a ProcSpec::CustomProc
+    expect( instance ).to receive( :match? ).with( context, toggle )
+
+    condition.match?( context )
+  end
+
+end

data/spec/lib/shamu/features/env_store_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Shamu::Features::EnvStore do
+  hunt( :codec, Shamu::Features::ToggleCodec ) { scorpion.new Shamu::Features::ToggleCodec }
+
+  it "reads from rack header" do
+    packed = codec.pack( "buy_now" => true )
+    env    = {
+      "rack.input" => StringIO.new,
+      Shamu::Features::EnvStore::RACK_ENV_KEY => packed
+    }
+    scorpion.hunt_for Scorpion::Rack::Env, return: env
+
+    store = scorpion.fetch( Shamu::Features::EnvStore )
+    expect( store.fetch( "buy_now" ) ).to eq true
+  end
+
+  it "reads from rack params" do
+    packed = codec.pack( "buy_now" => true )
+    env    = {
+      "rack.input" => StringIO.new,
+      "QUERY_STRING" => "#{ Shamu::Features::EnvStore::RACK_PARAMS_KEY }=#{ URI.escape( packed ) }"
+    }
+    scorpion.hunt_for Scorpion::Rack::Env, return: env
+
+    store = scorpion.fetch( Shamu::Features::EnvStore )
+    expect( store.fetch( "buy_now" ) ).to eq true
+  end
+
+  it "falls back to env" do
+    scorpion.hunt_for Scorpion::Rack::Env, return: { "rack.input" => StringIO.new }
+    store = scorpion.fetch( Shamu::Features::EnvStore )
+    key   = store.class.env_key_name( "buy_now" )
+
+    expect( ENV ).to receive( :key? ).with( key ).and_return true
+    expect( ENV ).to receive( :[] ).with( key ).and_return "false"
+
+    expect( store.fetch( "buy_now" ) ).to eq false
+  end
+
+  it "falls back to fall back block" do
+    scorpion.hunt_for Scorpion::Rack::Env, return: { "rack.input" => StringIO.new }
+    store = scorpion.fetch( Shamu::Features::EnvStore )
+
+    expect( store.fetch( "buy_now" ) { "yep" } ).to eq "yep"
+  end
+
+end

data/spec/lib/shamu/features/features.yml

@@ -0,0 +1,34 @@
+---
+shopping:
+
+  buy_now:
+    description: Show "Buy Now" one-click purchase option to customers.
+    retire_at: 2055-10-1
+    type: release
+    select:
+    - proc: "FeaturesServiceSpec::ProcToggle#buy_now?"
+    - schedule_at: 2015-4-1
+      percentage: 100
+      roles:
+      - first-time
+      hosts:
+      - web[\d]-sf
+      - web2
+      env:
+      - CANARY
+      matching:
+      - uploads/previews
+      not_matching:
+      - shopping/inline-ads
+      reject: true
+
+  # Import the feature configuration from the given path.
+  import: "secondary.yml"
+
+uploads:
+  previews:
+    description: "Show previews on uploads"
+    retire_at: 2005-10-1
+    type: release
+    select:
+    - reject: true

data/spec/lib/shamu/features/features_service_spec.rb

@@ -0,0 +1,109 @@
+require "spec_helper"
+require "fileutils"
+
+module FeaturesServiceSpec
+  class ProcToggle
+    def buy_now?( context, toggle )
+      false
+    end
+  end
+end
+
+describe Shamu::Features::FeaturesService do
+  let( :config_path ) { File.expand_path( "../features.yml", __FILE__ ) }
+  let( :service )     { scorpion.new Shamu::Features::FeaturesService, config_path }
+  let( :codec )       { scorpion.new Shamu::Features::ToggleCodec }
+
+  hunt( :session_store, Shamu::Sessions::SessionStore )
+  hunt( :env_store, Shamu::Features::EnvStore )
+
+  before( :each ) do
+    allow( session_store ).to receive( :fetch ).and_return nil
+    allow( env_store ).to receive( :fetch ).and_return nil
+  end
+
+  it "lists known features" do
+    expect( service.list ).to have_key "shopping/buy_now"
+    expect( service.list ).to have_key "uploads/previews"
+  end
+
+  it "lists known features by prefix" do
+    expect( service.list( "shopping" ) ).to have_key "shopping/buy_now"
+    expect( service.list( "shopping" ) ).not_to have_key "uploads/previews"
+  end
+
+  # TODO: Figure out how to make this work
+  #
+  # Listen does something with the threads and doesn't actually fire the change
+  # event until after the spec has executed :/.
+  #
+  # It's been verified to work manually but I'd like to get an automated test in
+  # as well.
+  #
+  # context "with file changes" do
+  #   let( :config_path ) { File.expand_path( "../../../../../tmp/#{ SecureRandom.hex( 16 ) }.yml", __FILE__ ) }
+  #   it "reloads when any source changes", :focus do
+  #     expect( Shamu::Features::Toggle ).to receive( :load ).twice.and_call_original
+  #
+  #     begin
+  #       File.write config_path, {}.to_yaml
+  #       service.list
+  #       File.write config_path, {}.to_yaml
+  #       sleep 1
+  #     ensure
+  #       File.unlink config_path
+  #     end
+  #   end
+  # end
+
+  context "with session information" do
+    let( :packed ) { codec.pack( "shopping/buy_now" => true ) }
+
+    it "reads sticky features" do
+      expect( session_store ).to receive( :fetch ).with( "shamu.toggles" ).and_return packed
+      expect( service ).not_to receive( :resolve_toggle )
+
+      expect( service.enabled?( "shopping/buy_now" ) ).to eq true
+    end
+
+    it "persists sticky context" do
+      expect( session_store ).to receive( :set ).with( "shamu.toggles", codec.pack( "shopping/buy_now" => false ) )
+
+      service.enabled?( "shopping/buy_now" )
+    end
+
+    it "appends to sticky context" do
+      existing_packed = codec.pack( "example" => true )
+      expect( session_store ).to receive( :fetch ).with( "shamu.toggles" ).and_return existing_packed
+      compbined_packed = codec.pack( "example" => true, "shopping/buy_now" => false )
+      expect( session_store ).to receive( :set ).with( "shamu.toggles", compbined_packed )
+
+      service.enabled?( "shopping/buy_now" )
+    end
+  end
+
+  context "with env information" do
+    it "overrides from environment" do
+      expect( env_store ).to receive( :fetch ).with( "shopping/buy_now" ).and_return true
+
+      expect( service.enabled?( "shopping/buy_now" ) ).to eq true
+    end
+  end
+
+  it "is always false for unknown toggles" do
+    allow( service.logger ).to receive( :info )
+    expect( service.enabled?( "not/yet/set" ) ).to be_falsy
+  end
+
+  it "logs when an unknown toggle is checked" do
+    expect( service.logger ).to receive( :info ).with /configured/
+    service.enabled?( "not/yet/set" )
+  end
+
+  it "raises when expired toggle is checked" do
+    expect do
+      service.enabled?( "uploads/previews" )
+    end.to raise_error Shamu::Features::RetiredToggleError, /retired/
+  end
+
+end

data/spec/lib/shamu/features/secondary.yml

@@ -0,0 +1,5 @@
+offers:
+  at_checkout:
+    description: "Show offers after purchase"
+    retire_at: 2050-1-1
+    type: ops

data/spec/lib/shamu/features/selector_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe Shamu::Features::Selector do
+  it "parses conditions" do
+    selector = Shamu::Features::Selector.new double, "schedule_at" => Time.now
+
+    expect( selector ).to be_a Shamu::Features::Selector
+    expect( selector.reject ).to be_falsy
+    expect( selector.conditions.first ).to be_a Shamu::Features::Conditions::ScheduleAt
+  end
+
+  it "parses reject option" do
+    selector = Shamu::Features::Selector.new double, "reject" => true
+
+    expect( selector.reject ).to be_truthy
+  end
+end

data/spec/lib/shamu/features/support_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe Shamu::Features::FeaturesService do
+  hunt( :features_service, Shamu::Features::FeaturesService )
+  let( :klass ) do
+    Class.new( Shamu::Services::Service ) do
+      include Shamu::Features::Support
+
+      public :when_feature
+    end
+  end
+  let( :service ) { scorpion.new klass }
+
+  it "executes the block if enabled" do
+    allow( features_service ).to receive( :enabled? ).and_return true
+
+    expect do |b|
+      service.when_feature( "example", &b )
+    end.to yield_control
+  end
+
+  it "doesn't execute if not enabled" do
+    allow( features_service ).to receive( :enabled? ).and_return false
+
+    expect do |b|
+      service.when_feature( "example", &b )
+    end.not_to yield_control
+  end
+
+  it "can override enabled" do
+    allow( features_service ).to receive( :enabled? ).and_return false
+
+    expect do |b|
+      service.when_feature( "example", override: true, &b )
+    end.to yield_control
+  end
+
+  it "can override disabled" do
+    allow( features_service ).to receive( :enabled? ).and_return true
+
+    expect do |b|
+      service.when_feature( "example", override: false, &b )
+    end.not_to yield_control
+  end
+end

data/spec/lib/shamu/features/toggle_codec_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Shamu::Features::ToggleCodec do
+  let( :codec ) { Shamu::Features::ToggleCodec.new( SecureRandom.random_bytes( 64 ) ) }
+
+  describe "#pack" do
+    subject { codec.pack( "buy_now" => true, "suggestions" => false ) }
+
+    it { is_expected.to match /,/ }
+    it { is_expected.to match /[^!]buy_now/ }
+    it { is_expected.to match /!suggestions/ }
+  end
+
+  describe "#unpack" do
+    let( :packed ) { codec.pack( "buy_now" => true, "suggestions" => false ) }
+
+    subject { codec.unpack( packed ) }
+
+    its(["buy_now"])     { is_expected.to eq true }
+    its(["suggestions"]) { is_expected.to eq false }
+    its(["not/set"])     { is_expected.to be_nil }
+
+    it "handles an empty feature hash" do
+      packed = codec.pack( {} )
+      expect( codec.unpack( packed ) ).to eq( {} )
+    end
+  end
+end

data/spec/lib/shamu/features/toggle_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe Shamu::Features::Toggle do
+  let( :path )    { File.expand_path( "../features.yml", __FILE__ ) }
+  let( :toggles ) { Shamu::Features::Toggle.load( path ) }
+
+  it "collapses path to name" do
+    expect( toggles ).to have_key "shopping/buy_now"
+  end
+
+  it "imports relative files" do
+    expect( toggles ).to have_key "shopping/offers/at_checkout"
+  end
+
+  context "with toggle" do
+    let( :toggle ) { toggles[ "shopping/buy_now" ] }
+
+    it "creates the toggle" do
+      expect( toggle ).to be_a Shamu::Features::Toggle
+    end
+
+    it "parses selectors LIFO" do
+      expect( toggle.selectors.count ).to eq 2
+    end
+
+    it "parses selector conditions" do
+      expect( toggle.selectors.last.conditions.count ).to eq 7
+    end
+  end
+
+  it "requires a retire_at date" do
+     expect do
+      Shamu::Features::Toggle.new( {} )
+     end.to raise_error ArgumentError, /retire_at/
+  end
+
+  it "requires a type" do
+     expect do
+      Shamu::Features::Toggle.new( "retire_at" => Time.now )
+     end.to raise_error ArgumentError, /Type/
+  end
+end

data/spec/lib/shamu/rack/cookies_middleware_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+require "shamu/rack"
+
+module CookiesMiddlewareSpec
+  class App
+    include Scorpion::Rack
+    attr_accessor :next
+
+    def call( env )
+      @next ||= proc { [ 200, {}, [ "Sting!" ] ] }
+      @next.call( env, self )
+    end
+  end
+end
+
+describe Shamu::Rack::CookiesMiddleware do
+  let(:app)                 { CookiesMiddlewareSpec::App.new }
+  let(:scorpion_middleware) { Scorpion::Rack::Middleware.new( cookies_middleware ) }
+  let(:cookies_middleware)  { Shamu::Rack::CookiesMiddleware.new( app ) }
+  let(:request)             { Rack::MockRequest.new( scorpion_middleware ) }
+  let(:response)            { request.get( "/" ) }
+
+  it "prepares it with the environment" do
+
+    app.next = proc do |env, app|
+      cookies = app.send( :scorpion, env ).fetch Shamu::Rack::Cookies
+      expect( cookies ).to be_a Shamu::Rack::Cookies
+      [ 200, {}, [ "Yum!" ] ]
+    end
+
+    request.get "/"
+  end
+end