add %User{role} attribute

Author: adrianmarino

lib/mix/tasks/client/roles.ex

@@ -0,0 +1,5 @@
+defmodule Mix.Tasks.Cli.Roles do
+  use Mix.Task.Point.Client
+  @shortdoc "Show roles. Param: token"
+  defrun fn(token)-> points(base_url, token) |> roles end
+end

lib/point/client/client.ex

@@ -44,6 +44,10 @@ defmodule Point.Client do
   end
   def users(client), do: request(method: :get, url: url(client, "users"), body: %{}, headers: %{token: client.token})
 
+
+  def roles(client), do: request(method: :get, url: url(client, "roles"), body: %{}, headers: %{token: client.token})
+
+
   def currencies(client, create: %Point.Client.Dto.Currency{code: code, name: name}) do
     request(
       method: :post,

mix.exs

@@ -19,8 +19,8 @@ defmodule Point.Mixfile do
   # Type `mix help compile.app` for more information.
   def application do
     [mod: {Point, []},
-     applications: [:phoenix, :phoenix_pubsub, :cowboy, :logger, :gettext, :phoenix_ecto, :mariaex, :ecto_ttl, :timex,
-                    :httpotion]]
+     applications: [:phoenix, :phoenix_pubsub, :cowboy, :logger, :gettext, :phoenix_ecto, :mariaex,
+                    :ecto_ttl, :timex, :httpotion]]
   end
 
   # Specifies which paths to compile per environment.
@@ -35,7 +35,6 @@ defmodule Point.Mixfile do
       {:phoenix, "~> 1.2.1"},
       {:phoenix_pubsub, "~> 1.0"},
       {:phoenix_ecto, "~> 3.0"},
-      {:postgrex, ">= 0.0.0"},
       {:gettext, "~> 0.11"},
       {:cowboy, "~> 1.0"},
       {:espec_phoenix, "~> 0.6.4", only: :test},
@@ -51,7 +50,8 @@ defmodule Point.Mixfile do
       {:timex, "~> 3.0"},
       {:timex_ecto, "~> 3.0"},
       {:exjsx, "~> 3.2.1", git: "https://github.com/talentdeficit/exjsx"},
-      {:httpotion, "~> 3.0.2"}
+      {:httpotion, "~> 3.0.2"},
+      {:ecto_enum, "~> 1.0"}
    ]
   end
 

mix.lock

@@ -10,6 +10,7 @@
   "db_connection": {:hex, :db_connection, "1.1.0", "b2b88db6d7d12f99997b584d09fad98e560b817a20dab6a526830e339f54cdb3", [:mix], [{:connection, "~> 1.0.2", [hex: :connection, optional: false]}, {:poolboy, "~> 1.5", [hex: :poolboy, optional: true]}, {:sbroker, "~> 1.0", [hex: :sbroker, optional: true]}]},
   "decimal": {:hex, :decimal, "1.3.1", "157b3cedb2bfcb5359372a7766dd7a41091ad34578296e951f58a946fcab49c6", [:mix], []},
   "ecto": {:hex, :ecto, "2.0.6", "9dcbf819c2a77f67a66b83739b7fcc00b71aaf6c100016db4f798930fa4cfd47", [:mix], [{:db_connection, "~> 1.0", [hex: :db_connection, optional: true]}, {:decimal, "~> 1.1.2 or ~> 1.2", [hex: :decimal, optional: false]}, {:mariaex, "~> 0.8.0", [hex: :mariaex, optional: true]}, {:poison, "~> 1.5 or ~> 2.0", [hex: :poison, optional: true]}, {:poolboy, "~> 1.5", [hex: :poolboy, optional: false]}, {:postgrex, "~> 0.12.0", [hex: :postgrex, optional: true]}, {:sbroker, "~> 1.0-beta", [hex: :sbroker, optional: true]}]},
+  "ecto_enum": {:hex, :ecto_enum, "1.0.1", "7853cd36b2063c1e2ba2a2e2987dd4745afa1ab1e24b16f6dba3b6bdbd4c907b", [:mix], [{:ecto, "~> 2.1.0", [hex: :ecto, optional: false]}, {:mariaex, "~> 0.8.0", [hex: :mariaex, optional: true]}, {:postgrex, "~> 0.13.0", [hex: :postgrex, optional: true]}]},
   "ecto_migrate": {:hex, :ecto_migrate, "0.6.3", "70b37ac2111bfe16b6076bb8815e0207e24331eceefb3c5b96f725d0296cf65d", [:mix], [{:ecto, "~> 1.0.0", [hex: :ecto, optional: false]}, {:ecto_it, "~> 0.2.0", [hex: :ecto_it, optional: true]}, {:mariaex, ">= 0.0.0", [hex: :mariaex, optional: true]}, {:postgrex, ">= 0.0.0", [hex: :postgrex, optional: true]}]},
   "ecto_ttl": {:git, "https://github.com/xerions/ecto_ttl.git", "2a2e2bcd1443e5a0a5ed594f807ddcec46a1a840", []},
   "espec": {:hex, :espec, "1.2.0", "93a057d9b200619c6a64676f27b5e7d3d6d80097763232a76bb88d8b0c3db28d", [:mix], [{:meck, "~> 0.8.4", [hex: :meck, optional: false]}]},

priv/repo/migrations/20170217012609_add_role_to_users.exs

@@ -0,0 +1,15 @@
+defmodule Point.Repo.Migrations.AddRoleToUsers do
+  use Ecto.Migration
+
+  def up do
+    alter table(:users) do
+      add :role, :integer
+    end
+  end
+
+  def down do
+    alter table(:users) do
+      remove :role
+    end
+  end
+end

priv/repo/seeds.exs

@@ -7,15 +7,15 @@ alias Point.{User, Entity, Account, Currency, ExchangeRate}
 # Is the root user
 chewbacca = insert! User.insert_changeset(%User{}, %{
   email: "[email protected]", password: "12345678910",
-  first_name: "Chewbacca", last_name: "Chewbacca"
+  first_name: "Chewbacca", last_name: "Chewbacca", role: :system_admin
 })
 obiwan_kenoby = insert! User.insert_changeset(%User{}, %{
   email: "[email protected]", password: "12345678910",
-  first_name: "Obi-Wan", last_name: "Kenoby"
+  first_name: "Obi-Wan", last_name: "Kenoby", role: :normal_user
 })
 anakin_skywalker = insert! User.insert_changeset(%User{}, %{
   email: "[email protected]", password: "12345678910",
-  first_name: "Anakin", last_name: "Skywalker"
+  first_name: "Anakin", last_name: "Skywalker", role: :normal_user
 })
 #
 #

spec/factories/user_factory.ex

@@ -2,27 +2,67 @@ defmodule Point.UserFactory do
   use ExMachina.Ecto, repo: Point.Repo
   alias Point.User
 
+  def session_test_user_factory do
+    %User{
+      email: "[email protected]",
+      password: "Whatever10",
+      first_name: "TestFirstName",
+      last_name: "TestLastName",
+      role: :system_admin
+    }
+  end
+
   def chewbacca_factory do
-    %User{email: sequence(:email, &"chewbacca#{&1}@gmail.com"), first_name: "chewbacca", last_name: "chewbacca"}
+    %User{
+      email: sequence(:email, &"chewbacca#{&1}@gmail.com"),
+      first_name: "chewbacca",
+      last_name: "chewbacca",
+      role: :system_admin
+    }
   end
 
   def luke_skywalker_factory do
-    %User{email: sequence(:email, &"lukeskywalker#{&1}@gmail.com"), first_name: "Luke", last_name: "Skywalker"}
+    %User{
+      email: sequence(:email, &"lukeskywalker#{&1}@gmail.com"),
+      first_name: "Luke",
+      last_name: "Skywalker",
+      role: :normal_user
+    }
   end
 
   def obiwan_kenoby_factory do
-    %User{email: sequence(:email, &"obiwankenoby#{&1}@gmail.com"), first_name: "Obi-Wan", last_name: "Kenoby"}
+    %User{
+      email: sequence(:email, &"obiwankenoby#{&1}@gmail.com"),
+      first_name: "Obi-Wan",
+      last_name: "Kenoby",
+      role: :normal_user
+    }
   end
 
   def han_solo_factory do
-    %User{email: sequence(:email, &"hansolo#{&1}@gmail.com"), first_name: "Han", last_name: "Solo"}
+    %User{
+      email: sequence(:email, &"hansolo#{&1}@gmail.com"),
+      first_name: "Han",
+      last_name: "Solo",
+      role: :normal_user
+    }
   end
 
   def anakin_skywalker_factory do
-    %User{email: sequence(:email, &"anakinskywalker#{&1}@gmail.com"), first_name: "Anakin", last_name: "Skywalker"}
+    %User{
+      email: sequence(:email, &"anakinskywalker#{&1}@gmail.com"),
+      first_name: "Anakin",
+      last_name: "Skywalker",
+      role: :normal_user
+    }
   end
 
   def jango_fett_factory do
-    %User{email: sequence(:email, &"jangofett#{&1}@gmail.com"), first_name: "Jango", last_name: "Fett"}
+    %User{
+      email: sequence(:email, &"jangofett#{&1}@gmail.com"),
+      first_name: "Jango",
+      last_name: "Fett",
+      role: :normal_user
+    }
   end
 end

spec/point/controllers/role_controller_spec.exs

@@ -0,0 +1,15 @@
+defmodule Point.RoleControllerSpec do
+  use ESpec.Phoenix, controller: Point.RoleController
+  use ESpec.Phoenix.Helper
+
+  describe "index" do
+    let response: sec_conn |> get(role_path(sec_conn, :index))
+    let roles: json_response(response, 200)
+
+    it "returns ok status", do: expect response.status |> to(eq 200)
+    it "returns a list with three roles", do: expect roles |> to(have_size 3)
+    it "returns a list that contains a system_admin role", do: expect roles |> to(have "system_admin")
+    it "returns a list that contains a entity_admin role", do: expect roles |> to(have "entity_admin")
+    it "returns a list that contains a normal_user role", do: expect roles |> to(have "normal_user")
+  end
+end

spec/point/controllers/session_controller_spec.exs

@@ -5,8 +5,13 @@ defmodule Point.SessionControllerSpec do
   alias Point.{Session, UserService, SessionService}
 
   let ip: "127.0.0.1"
-  let valid_user_attrs: %{email: "[email protected]", password: "Whatever1123", first_name: "adrian",
-    last_name: "marino"}
+  let valid_user_attrs: %{
+    email: "[email protected]",
+    password: "Whatever1123",
+    first_name: "adrian",
+    last_name: "marino",
+    role: "normal_user"
+  }
   let valid_attrs: sub_map(valid_user_attrs, [:email, :password])
 
   describe "sign_in" do

spec/point/controllers/user_controller_spec.exs

@@ -2,7 +2,13 @@ defmodule Point.UserControllerSpec do
   use ESpec.Phoenix, controller: Point.UserController
   use ESpec.Phoenix.Helper
 
-  let valid_attrs: %{email: "[email protected]", password: "Whatever10", first_name: "2222", last_name: "222"}
+  let valid_attrs: %{
+    email: "[email protected]",
+    password: "Whatever10",
+    first_name: "2222",
+    last_name: "222",
+    role: "normal_user"
+  }
 
   describe "create" do
     let response: sec_conn |> post(user_path(sec_conn, :create), attrs)

spec/point/helper/espec_phoenix_helper.exs

@@ -6,14 +6,7 @@ defmodule ESpec.Phoenix.Helper do
 
       alias Point.{Repo, Session, User}
 
-      let :current_user do
-        Repo.insert! User.insert_changeset(%User{}, %{
-          email: "[email protected]",
-          password: "Whatever10",
-          first_name: "Test",
-          last_name: "User"
-        })
-      end
+      let current_user: Point.UserFactory.insert(:session_test_user)
 
       let current_session: Repo.insert!(%Session{token: "token", remote_ip: "127.0.0.1", user_id: current_user.id})
 

spec/point/models/user_spec.exs

@@ -20,6 +20,23 @@ defmodule Point.UserSpec do
     end
   end
 
+  context "role_changeset" do
+    let changeset: User.role_changeset(%User{}, attrs)
+
+    context "when has a valid role" do
+      let attrs: %{role: :normal_user}
+      it do: expect changeset.valid? |> to(be_truthy)
+    end
+    context "when an unknow role" do
+      let attrs: %{role: :any}
+      it do: expect changeset.valid? |> to(be_falsy)
+    end
+    context "when hasn't role" do
+      let attrs: %{}
+      it do: expect changeset.valid? |> to(be_falsy)
+    end
+  end
+
   context "password_changeset" do
     let changeset: User.password_changeset(%User{}, attrs)
 
@@ -60,14 +77,25 @@ defmodule Point.UserSpec do
   end
 
   context "insert_changeset" do
-    let attrs: %{email: "[email protected]", password: "Whatever10", first_name: "Adrian", last_name: "Marino"}
+    let attrs: %{
+      email: "[email protected]",
+      password: "Whatever10",
+      first_name: "Adrian",
+      last_name: "Marino",
+      role: "normal_user"
+    }
     let changeset: User.insert_changeset(%User{}, attrs)
 
     it do: expect changeset.valid? |> to(be_truthy)
   end
 
   context "update_changeset" do
-    let attrs: %{password: "Whatever10", first_name: "Adrian", last_name: "Marino"}
+    let attrs: %{
+      password: "Whatever10",
+      first_name: "Adrian",
+      last_name: "Marino",
+      role: "normal_user"
+    }
     let changeset: User.update_changeset(%User{}, attrs)
 
     it do: expect changeset.valid? |> to(be_truthy)

web/controllers/role_controller.ex

@@ -0,0 +1,9 @@
+defmodule Point.RoleController do
+  use Point.Web, :controller
+  import Point.JSON
+  def index(conn, _) do
+    conn
+     |> put_resp_header("content-type", "application/json")
+     |> send_resp(:ok, to_json ~w[system_admin entity_admin normal_user])
+  end
+end

web/models/user.ex

@@ -1,11 +1,4 @@
 defmodule Point.User do
-  @moduledoc """
-  Represent a platform user. A user:
-    - Could be a issuer or a normal user.
-    - Belong to entities.
-    - Could issue currency.
-    - Has accounts.
-  """
   use Point.Web, :model
   use Timex.Ecto.Timestamps, usec: true
 
@@ -15,6 +8,7 @@ defmodule Point.User do
     field :password, :string, virtual: true
     field :first_name, :string
     field :last_name, :string
+    field :role, UserRole
 
     many_to_many :entities, Point.Entity, join_through: "users_entities"
     has_many :currencies, Point.Currency
@@ -26,6 +20,10 @@ defmodule Point.User do
     model |> cast_and_validate_required(params, [:first_name, :last_name])
   end
 
+  def role_changeset(model, params \\ %{}) do
+    model |> cast_and_validate_required(params, [:role])
+  end
+
   defp put_password_hash(changeset) do
     case changeset do
       %Ecto.Changeset{valid?: true, changes: %{password: value}} ->
@@ -53,11 +51,13 @@ defmodule Point.User do
       |> email_changeset(params)
       |> password_changeset(params)
       |> first_last_name_changeset(params)
+      |> role_changeset(params)
   end
 
   def update_changeset(model, params \\ %{}) do
     model
       |> first_last_name_changeset(params)
+      |> role_changeset(params)
       |> password_changeset(params)
   end
 end

web/models/user_role.ex

@@ -0,0 +1,2 @@
+import EctoEnum
+defenum UserRole, system_admin: 0, entity_admin: 1, normal_user: 2

web/router.ex

@@ -18,6 +18,9 @@ defmodule Point.Router do
     get "/sessions", SessionController, :index
 
     resources "/users", UserController, except: [:new, :edit], param: "email"
+
+    resources "/roles", RoleController, only: [:index]
+
     resources "/currencies", CurrencyController, except: [:new, :edit], param: "code"
 
     scope "/accounts" do