core_models 0.0.2

data/spec/models/user_spec.rb

@@ -0,0 +1,139 @@
+require 'rails_helper'
+require 'support/model_classes'
+require 'support/factories'
+require 'support/setup'
+require 'pry'
+
+describe "Test the user model mixin" do
+
+  context "Fail to find a user" do
+    it "should return nil on a user not existing" do
+      User.find_by_first_name('sally').should == nil
+    end
+  end
+
+  context "Validation checks" do
+    it "Validate a valid user object" do
+     FactoryGirl.build(:user).should be_valid
+    end
+
+    it "should not be valid if wong user name length" do
+      FactoryGirl.build(:user, :user_name => 'gg').should_not be_valid
+    end
+
+    it "should not be valid if missing password" do
+      FactoryGirl.build(:user, :password => '').should_not be_valid
+    end
+
+    it "should not be valid if wong password length" do
+      FactoryGirl.build(:user, :password => 'ggg').should_not be_valid
+    end
+
+    it "should not be valid if wong email" do
+      FactoryGirl.build(:user, :email => 'ggg.com').should_not be_valid
+    end
+
+    it "should validate a user based on login credentials" do
+      @user = FactoryGirl.create(:user)
+      @login = FactoryGirl.build(:user)
+      User.authenticate_user(@user.user_name, @login.password).should == @user
+    end
+
+    it "should fail on password being wrong" do
+      @user = FactoryGirl.create(:user)
+      @login = FactoryGirl.build(:user)
+      User.authenticate_user(@user.user_name, "skfdjhgsdkjfhg").should == nil
+    end
+
+    it "should hash my password" do
+      @user = FactoryGirl.create(:user)
+      @login = FactoryGirl.build(:user)
+      @user.password.should == BCrypt::Engine.hash_secret(@login.password, @user.salt)
+    end
+  end
+
+  context "Assign users groups, roles and permissions" do
+  before(:each) do
+    setup_group_role_permissions_relations_for_memeber
+  end
+
+  it "should assign a group to a user" do
+    @user.add_group = @group.group_name
+    @user.has_group?(@group.group_name).should_not eql false
+  end
+
+  it "should have a role for a user who belongs to a group" do
+    @user.add_group_membership(@group, @role)
+    @user.groups.find(@group.group_name.parameterize).has_role?(@role.role_name).should_not eql false
+  end
+
+  it "should have a permission for a role when a user who belongs to a group that has that role" do
+    @user.add_group = @group.group_name
+    @user.groups.find(@group.group_name.parameterize).roles.find(@role.role_name.parameterize).has_permission?(@permission.permission_name)
+  end
+end
+
+context "Get a Group and Roles and Permissions" do
+  before(:each) do
+    setup_group_role_permissions_relations_for_memeber
+  end
+
+  it "should return one group a user belongs to" do
+    @user.groups.nil?.should eql false
+  end
+
+  it "should return roles for a user belongs to a group" do
+    @user.roles.empty?.should eql false
+  end
+
+  it "should return permissions for a user who has a role" do
+    @user.permissions.empty?.should eql false
+  end
+end
+
+context "Concerns" do
+  before(:each) do
+    setup_group_role_permissions_relations_for_memeber
+  end
+
+  it "should get a set of associated groups" do
+    @user.group_names.should_not be_empty
+  end
+
+  it "should get a set of associated roles" do
+    @user.role_names.should_not be_empty
+  end
+
+  it "should get unique permissions" do
+    @user.uniq_permissions.should_not be_empty
+  end
+
+  it "should get all permissions" do
+    @user.permissions.should_not be_empty
+  end
+
+  it "should return true when the role belongs to the group and the user has both" do
+    @user.has_role_for_group?('Member', 'Member').should eql true
+  end
+
+  it "should get a role from a group association" do
+    group = Group.find('member')
+    @user.get_role_from_group_membership(group.id)
+  end
+
+  it "should remove a group membership association" do
+    @user.remove_group_membership('Member')
+    @user.has_group?('Member').should eql false
+  end
+
+  it "should get the first role" do
+    @user.role.should eql  'Member'
+  end
+
+  it "should get the first group" do
+    @user.group.should eql  'Member'
+  end
+
+end
+
+end

data/spec/rails_helper.rb

@@ -0,0 +1,57 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'spec_helper'
+require File.expand_path("../dummy/config/environment", __FILE__)
+require 'rspec/rails'
+require 'factory_girl_rails'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => 'test.sqlite3')
+load(File.dirname(__FILE__) + "/schema.rb")
+
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end

data/spec/schema.rb

@@ -0,0 +1,103 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20150122213141) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "friendly_id_slugs", force: true do |t|
+    t.string   "slug",                      null: false
+    t.integer  "sluggable_id",              null: false
+    t.string   "sluggable_type", limit: 50
+    t.string   "scope"
+    t.datetime "created_at"
+  end
+
+  add_index "friendly_id_slugs", ["slug", "sluggable_type", "scope"], name: "index_friendly_id_slugs_on_slug_and_sluggable_type_and_scope", unique: true, using: :btree
+  add_index "friendly_id_slugs", ["slug", "sluggable_type"], name: "index_friendly_id_slugs_on_slug_and_sluggable_type", using: :btree
+  add_index "friendly_id_slugs", ["sluggable_id"], name: "index_friendly_id_slugs_on_sluggable_id", using: :btree
+  add_index "friendly_id_slugs", ["sluggable_type"], name: "index_friendly_id_slugs_on_sluggable_type", using: :btree
+
+
+  create_table "group_memberships", force: true do |t|
+    t.integer "user_id"
+    t.integer "group_id"
+    t.integer "role_id"
+    t.integer "_v",       limit: 8, default: 1
+  end
+
+  create_table "groups", force: true do |t|
+    t.string  "group_name"
+    t.string  "slug"
+    t.boolean "can_alter",            default: true
+    t.boolean "can_delete",           default: true
+    t.integer "_v",         limit: 8, default: 1
+  end
+
+  add_index "groups", ["slug"], name: "index_groups_on_slug", using: :btree
+
+  create_table "groups_roles", force: true do |t|
+    t.integer "group_id"
+    t.integer "role_id"
+    t.integer "_v",       limit: 8, default: 1
+  end
+
+  create_table "permissions", force: true do |t|
+    t.string   "permission_name"
+    t.string   "slug"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.boolean  "can_alter",       default: true
+    t.boolean  "can_delete",      default: true
+  end
+
+  add_index "permissions", ["slug"], name: "index_permissions_on_slug", using: :btree
+
+  create_table "roles", force: true do |t|
+    t.string   "role_name"
+    t.integer  "_v",         limit: 8
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "slug"
+    t.boolean  "can_delete",           default: true
+    t.boolean  "can_alter",            default: true
+  end
+
+  add_index "roles", ["slug"], name: "index_roles_on_slug", using: :btree
+
+  create_table "roles_permissions", force: true do |t|
+    t.integer "role_id"
+    t.integer "permission_id"
+    t.integer "_v",            limit: 8, default: 1
+  end
+
+  create_table "users", force: true do |t|
+    t.string   "first_name"
+    t.string   "last_name"
+    t.string   "user_name"
+    t.string   "email"
+    t.string   "password"
+    t.string   "salt"
+    t.integer  "_v",                       limit: 8
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "auth_token"
+    t.string   "slug"
+    t.string   "password_reset_token"
+    t.datetime "password_reset_timestamp"
+  end
+
+  add_index "users", ["slug"], name: "index_users_on_slug", using: :btree
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/factories.rb

@@ -0,0 +1,54 @@
+FactoryGirl.define do
+  sequence :user_email do |n|
+    "user#{n}@example.com"
+  end
+
+  # Allows for multiple user names
+  sequence :user_name do |n|
+    "user#{n}"
+  end
+
+  sequence :permission_name do |n|
+    "can_read#{n}"
+  end
+
+  sequence :role_name do |n|
+    "Member#{n}"
+  end
+
+
+  factory :user, :class => User do
+    first_name 'Adam'
+    last_name 'Something'
+    user_name {generate :user_name}
+    email {generate :user_email}
+    password 'somePasswordThat_Is$ecure10!'
+  end
+
+  factory :admin, :class => User do
+    first_name "Sample Admin"
+    email "a@gmail.com"
+    user_name "Admin_User_Name"
+    password "admin_Password10985"
+  end
+
+  factory :member_role, :class => Role do
+    role_name "Member"
+  end
+
+  factory :admin_role, :class => Role do
+    role_name "Administrator"
+  end
+
+  factory :administrator_group, :class => Group do
+    group_name "Administrator"
+  end
+
+  factory :member_group, :class => Group do
+    group_name "Member"
+  end
+
+  factory :can_read, :class => Permission do
+    permission_name {generate :permission_name}
+  end
+end

data/spec/support/model_classes.rb

@@ -0,0 +1,36 @@
+require 'core_models/models/user'
+require 'core_models/models/group'
+require 'core_models/models/group_membership'
+require 'core_models/models/groups_role'
+require 'core_models/models/permission'
+require 'core_models/models/role'
+require 'core_models/models/roles_permission'
+
+
+class User < ActiveRecord::Base
+  include CoreModels::Models::User
+end
+
+class Group < ActiveRecord::Base
+  include CoreModels::Models::Group
+end
+
+class GroupMembership < ActiveRecord::Base
+  include CoreModels::Models::GroupMembership
+end
+
+class GroupsRole < ActiveRecord::Base
+  include CoreModels::Models::GroupsRole
+end
+
+class Permission < ActiveRecord::Base
+  include CoreModels::Models::Permission
+end
+
+class Role < ActiveRecord::Base
+  include CoreModels::Models::Role
+end
+
+class RolesPermission < ActiveRecord::Base
+  include CoreModels::Models::RolesPermission
+end