bucket_maker 0.0.1

data/spec/dummy/config/initializers/bucket_maker.rb

@@ -0,0 +1,41 @@
+# Configure the BucketMaker
+BucketMaker.configure do |config|
+  # Path Prefix
+  # All the Series, Buckets and Groups can be viewed/edited via a special URI
+  # The path prefix is used to prefix these routes
+  #
+  # Default value - '2bOrNot2B/'
+  # config.path_prefix = '2bOrNot2B/'
+  #
+  # Redis Options
+  # Set the Redis options which can be host, port and db
+  # This takes effect when in module included
+  # in the ActiveModel is BucketMaker::Models::Redisable
+  #
+  # Default value - { host: 'localhost', port: 6379, db: 1 }
+  # config.redis_options = {
+  #   host:    'localhost',
+  #   port:    6379,
+  #   db:      1
+  #   }
+  #
+  # Buckets Config File
+  # The configuration file for adding/removing Series, Buckets and Groups
+  #
+  config.buckets_config_file = 'config/buckets.yml'
+  #
+  # Lazy Load
+  # If false then Bucketize the object on creation
+  # If true then the Bucketization happens on the first call of in_bucket?
+  #
+  # Default value - true
+  # config.lazy_load = true
+  #
+  # Redis Expiration Time
+  # The redis expiration time if the configuration is for Redis
+  #
+  # Default value - 12.months
+  # config.redis_expiration_time = 12.months
+  #
+end
+

data/spec/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,12 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure your secret_key_base is kept private
+# if you're sharing your code publicly.
+Dummy::Application.config.secret_key_base = '26ea46774c38ecbb8fa7ca2ab6b102c3bde865884ab51460a21d5d91164681d5a22013ccaa65cc3130f59896db68cc62bbefd164a8ea143866b4e4de047cc41e'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_usettings_test_session'

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,23 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,2 @@
+Dummy::Application.routes.draw do
+end

data/spec/dummy/db/migrate/20131223144333_create_users.rb

@@ -0,0 +1,9 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string  :email
+      t.string  :uuid
+      t.timestamps
+    end
+  end
+end

data/spec/factories/factories.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :user do
+    id "12345"
+    email "test@test.com"
+    uuid "YGSHJKBEKJWKJHJKXNJKLDNWN"
+    created_at DateTime.parse('1st Jan 2011')
+  end
+end

data/spec/routing/routes_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe 'Routes' do
+  context 'with default routes' do
+    it 'should have get bucket route' do
+      expect(get: '/2bOrNot2B/test_series_one/actual_test_one/group_one.json').to route_to(
+        controller:         'bucket_maker',
+        action:             'show',
+        series_name:        'test_series_one',
+        bucket_name:        'actual_test_one',
+        group_name:         'group_one',
+        format:             'json'
+      )
+    end
+
+    it 'should have force set bucket route' do
+      expect(post: '/2bOrNot2B/test_series_one/actual_test_one/group_one.json').to route_to(
+        controller:         'bucket_maker',
+        action:             'switch',
+        series_name:        'test_series_one',
+        bucket_name:        'actual_test_one',
+        group_name:         'group_one',
+        format:             'json'
+      )
+    end
+
+    it 'should have randomize bucket route' do
+      expect(post: '/2bOrNot2B/test_series_one/actual_test_one.json').to route_to(
+        controller:         'bucket_maker',
+        action:             'randomize',
+        series_name:        'test_series_one',
+        bucket_name:        'actual_test_one',
+        format:             'json'
+      )
+    end
+  end
+
+  context 'with special prefix' do
+    around do |example|
+      default_base_path = BucketMaker.configuration.path_prefix
+      BucketMaker.configuration.path_prefix = 'non_default_path'
+
+      Rails.application.reload_routes!
+
+      BucketMaker.configuration.path_prefix = default_base_path
+      Rails.application.reload_routes!
+    end
+
+    it 'should have get bucket route' do
+      expect(get: '/non_default_path/test_series_one/actual_test_one/group_one.json').to route_to(
+        controller:         'bucket_maker',
+        action:             'show',
+        series_name:        'test_series_one',
+        bucket_name:        'actual_test_one',
+        group_name:         'group_one',
+        format:             'json'
+      )
+    end
+
+    it 'should have force set bucket route' do
+      expect(post: '/non_default_path/test_series_one/actual_test_one/group_one.json').to route_to(
+        controller:         'bucket_maker',
+        action:             'switch',
+        series_name:        'test_series_one',
+        bucket_name:        'actual_test_one',
+        group_name:         'group_one',
+        format:             'json'
+      )
+    end
+
+    it 'should have randomize bucket route' do
+      expect(post: '/non_default_path/test_series_one/actual_test_one.json').to route_to(
+        controller:         'bucket_maker',
+        action:             'randomize',
+        series_name:        'test_series_one',
+        bucket_name:        'actual_test_one',
+        format:             'json'
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path("../dummy/config/environment.rb", __FILE__)
+require 'pry'
+require 'rails/test_help'
+require 'rspec/rails'
+require 'capybara/rails'
+require 'factory_girl_rails'
+
+require 'coveralls'
+Coveralls.wear!
+
+Rails.backtrace_cleaner.remove_silencers!
+Capybara.default_driver = :rack_test
+Capybara.default_selector = :css
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each {|f| require f}
+
+RSpec.configure do |config|
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+  config.mock_with :rspec
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/unit/bucket_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe BucketMaker::Bucket do
+  let(:bucket_options) do
+    {
+      'description' => 'Test One',
+      'created_after' => "2nd Jan 2010",
+      'distributions' => {
+        'group_one' => 0.3,
+        'group_two' => 0.5,
+        'group_three' => 0.2,
+      }
+    }
+  end
+
+  let(:bucket) { BucketMaker::Bucket.new('test_bucket', bucket_options) }
+
+  context 'for configuration' do
+    it 'should have the correct distributions' do
+      bucket.distributions[:group_one].should == 0.3
+      bucket.distributions[:group_two].should == 0.5
+      bucket.distributions[:group_three].should == 0.2
+    end
+
+    context 'and distributions percent' do
+      before { bucket.random_group }
+
+      it 'should have the correct distribution percentages' do
+        bucket.distributions_percent[:group_one].should == (0..30)
+        bucket.distributions_percent[:group_two].should == (30..80)
+        bucket.distributions_percent[:group_three].should == (80..100)
+      end
+    end
+  end
+
+  context '#is_bucketable?' do
+    it 'should return false if created after doesnt satisfy' do
+      user = build(:user, id: 12345, created_at: DateTime.parse('1st Jan 2010'))
+      bucket.is_bucketable?(user).should be_false
+    end
+
+    it 'should return true if created after does satisfy' do
+      user = build(:user, id: 12345, created_at: DateTime.parse('3rd Jan 2010'))
+      bucket.is_bucketable?(user).should be_true
+    end
+  end
+
+  context '#has_group?' do
+    it 'should return false for non existant group' do
+      bucket.has_group?('non_existant_test').should be_false
+    end
+
+    it 'should return true for existing group' do
+      bucket.has_group?('group_two').should be_true
+    end
+  end
+end

data/spec/unit/bucketable_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe BucketMaker::Models::Bucketable do
+  class DummyClass
+    def id; 12345; end
+  end
+
+  let(:dummy) { DummyClass.new }
+  let(:existing_series) { 'test_series_one' }
+  let(:existing_bucket) { 'actual_test_one' }
+  let(:existing_group)  { 'group_two' }
+
+  before do
+    dummy.extend BucketMaker::Models::Bucketable
+  end
+
+  context '#group_for_key' do
+    it 'should raise exception' do
+      expect {
+        dummy.send(:group_for_key, 'test_series')
+      }.to raise_error
+    end
+  end
+
+  context '#set_group_for_key' do
+    it 'should raise exception' do
+      expect {
+        dummy.send(:set_group_for_key, 'test_series', 'test_group')
+      }.to raise_error NotImplementedError
+    end
+  end
+
+  context 'with stubbed group_for_key and set_group_for_key' do
+    before do
+      dummy.stub(:group_for_key) { true }
+      dummy.stub(:set_group_for_key) { true }
+      dummy.stub(:has_attribute?) { true }
+      dummy.stub(:created_at) { DateTime.parse('1st Jan 2010') }
+    end
+
+    context '#in_bucket?' do
+      context 'with invalid params' do
+        it 'should return false' do
+          dummy.in_bucket?('non_existant_series', existing_bucket, existing_group).should be_false
+        end
+      end
+
+      context 'with valid params' do
+        it 'should return false' do
+          # group_for_key return true and true == existing_group is false
+          dummy.in_bucket?(existing_series, existing_bucket, existing_group).should be_false
+        end
+
+        context 'when group_for_key returns the current group' do
+          before do
+            dummy.stub(:group_for_key).with(anything()) { existing_group }
+          end
+
+          it 'should return true' do
+            dummy.in_bucket?(existing_series, existing_bucket, existing_group).should be_true
+          end
+        end
+      end
+    end
+
+    context '#force_to_bucket!' do
+      context 'with invalid params' do
+        it 'should return false' do
+          dummy.force_to_bucket!('non_existant_series', existing_bucket, existing_group).should be_false
+        end
+      end
+
+      context 'with valid params' do
+        it 'should return true' do
+          dummy.force_to_bucket!(existing_series, existing_bucket, existing_group).should be_true
+        end
+      end
+    end
+
+    context '#bucketize_for_series_and_bucket!' do
+      context 'with invalid params' do
+        it 'should return false' do
+          dummy.bucketize_for_series_and_bucket!('non_existant_series', existing_bucket).should be_false
+        end
+      end
+
+      context 'with valid params' do
+        it 'should return true' do
+          dummy.bucketize_for_series_and_bucket!(existing_series, existing_bucket).should be_true
+        end
+      end
+    end
+
+    context '#bucketize!' do
+      it 'should return true' do
+        dummy.bucketize!.should be_true
+      end
+    end
+  end
+end

data/spec/unit/series_maker_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe BucketMaker::SeriesMaker do
+  let(:bucket_maker) { BucketMaker::SeriesMaker.instance }
+  let(:user) { build(:user, id: 12345) }
+  let(:existing_series) { 'test_series_one' }
+  let(:existing_bucket) { 'actual_test_one' }
+  let(:existing_group)  { 'group_two' }
+
+  before do
+    BucketMaker::Bucket.any_instance.stub(:random_group) { existing_group }
+  end
+
+  context 'for configuration' do
+    it 'should have correct number of series' do
+      bucket_maker.series.keys.length.should == 2 # Look at config/buckets.yml
+    end
+
+    it 'should have correct number of buckets' do
+      bucket_maker.series_with_name(existing_series).buckets.keys.length.should == 2
+    end
+
+    it 'should have correct number of distribut' do
+      bucket_maker.series_with_name(existing_series).bucket_with_name(existing_bucket).distributions.keys.length.should == 3
+    end
+  end
+
+  context '#configured?' do
+    it 'should be configured' do
+      bucket_maker.configured?.should be_true
+    end
+  end
+
+  context '#key_for_series' do
+    it 'should return the correct key' do
+      bucket_maker.key_for_series(user, 'series_one', 'bucket_one').should == 'bucket_maker:user_12345:series_one:bucket_one'
+    end
+  end
+
+  context '#has_series?' do
+    it 'should return true for an existing series' do
+      bucket_maker.has_series?(existing_series).should be_true
+    end
+
+    it 'should return false for a non existing series' do
+      bucket_maker.has_series?('non_existing_series').should be_false
+    end
+  end
+
+  context '#series_with_name' do
+    it 'should return a Series object' do
+      bucket_maker.series_with_name(existing_series).should be_kind_of(BucketMaker::Series)
+    end
+  end
+
+  context '#has_bucket_in_series?' do
+    it 'should return true for an existing bucket' do
+      bucket_maker.has_bucket_in_series?(existing_series, existing_bucket).should be_true
+    end
+
+    it 'should return false for a non existing bucket' do
+      bucket_maker.has_bucket_in_series?('non_existing_series', existing_bucket).should be_false
+    end
+  end
+
+  context '#has_group_in_bucket_in_series?' do
+    it 'should return true for an existing group' do
+      bucket_maker.has_group_in_bucket_in_series?(existing_series, existing_bucket, existing_group).should be_true
+    end
+
+    it 'should return false for a non existing group' do
+      bucket_maker.has_group_in_bucket_in_series?('non_existing_series', existing_bucket, existing_group).should be_false
+    end
+  end
+
+  context '#bucketize' do
+    it 'should return a valid group' do
+      bucket_maker.bucketize(existing_series, existing_bucket).should == existing_group
+    end
+  end
+
+  context '#bucketable?' do
+    it 'should return true for valid params' do
+      bucket_maker.bucketable?(user, existing_series, existing_bucket, existing_group).should be_true
+    end
+
+    it 'should return false for invalid params' do
+      bucket_maker.bucketable?(user, 'non_existing_series', existing_bucket, existing_group).should be_false
+    end
+  end
+end