Merge branch 'master' into features/basic-readme

Author: adrian-marino

.dockerignore

@@ -15,3 +15,5 @@ sudo: required
 notifications:
   recipients:
     - [email protected]
+before_script:
+  - echo "USE mysql;\nUPDATE user SET password=PASSWORD('1234') WHERE user='root';\nFLUSH PRIVILEGES;\n" | mysql -u root

.travis.yml

@@ -0,0 +1,11 @@
+FROM elixir:1.4
+
+RUN apt-get update
+RUN apt-get -y -q install mysql-client libmysqlclient-dev
+
+COPY . /app
+WORKDIR /app
+RUN mix local.hex --force
+RUN mix local.rebar --force
+RUN mix deps.get
+RUN mix compile

Dockerfile

@@ -19,34 +19,41 @@
 
 ## Beginning
 
-**Step 1:** Download project.
-```bash
-git clone https://github.com/adrianmarino/points.git; cd points
-```
-**Step 2:** Install dependencies.
-```bash
-mix deps.get
-```
-**Step 3:** Create your dev database.
-```bash
-mix ecto.create
-mix ecto.migrate
-MIX_ENV=dev mix ecto.reset
-```
-**Step 4:** Start server.
-```bash
-mix phoenix.server
-```
+  **Step 1:** Download project.
+  ```bash
+  git clone https://github.com/adrianmarino/points.git; cd points
+  ```
+
+  **Step 1**: Install dependencies.
+  ```bash
+  $ mix deps.get
+  ```
+
+  **Step 2**: Create and populate points database.
+  ```bash
+  $ MIX_ENV=dev mix ecto.reset
+  ```
+
+  **Step 3**: Start server.
+  ```bash
+  $ mix phoenix.server
+  ```
+
+## Beginning with docker
+
+  ```bash
+  $ ./docker-server-init
+  ```
 
 ## Guide
 
 This guide introduces you how can interact with points platform through easy examples. Adicionally, I'll show you how to configure the server.
 
 ### Client Tasks
 
-You can interact with the rest api through mix tasks without need to use curl or any rest client. This tasks actually use a rest client as we'll see later. 
+You can interact with the rest api through mix tasks without need to use curl or any rest client. This tasks actually use a rest client as we'll see later.
 
-What can you do with points api? 
+What can you do with points api?
 Run next on points directory:
 ```bash
 $ mix help | grep cli
@@ -63,7 +70,7 @@ mix cli.entities                   # Show entities. Params: token
 mix cli.entities.create            # Create an entity. Params: token code name
 mix cli.entities.delete            # Delete an entity. Params: token code
 mix cli.entities.partners          # Show entity partners. Params: token entity_code
-mix cli.entities.partners.create   # Create an entity partner. Params: token partner_code entity_code 
+mix cli.entities.partners.create   # Create an entity partner. Params: token partner_code entity_code
 mix cli.entities.partners.delete   # Delete an entity partner. Params: token partner_code entity_code
 mix cli.entities.show              # Show an entity. Params: token code
 mix cli.entities.update            # Update entity name. Params: token code name
@@ -125,7 +132,7 @@ $ mix cli.currencies.show OHpIUENHak9FTTAzUCtwaHB1dnk3dz09 XPT
 ```bash
 $ mix help | grep cli.users.create
 mix cli.users.create               # Create a user. Params: session_token email password first_name last_name
-$ mix cli.users.create OHpIUENHak9FTTAzUCtwaHB1dnk3dz09 [email protected] 1234567890 "Adrian Norberto" Marino 
+$ mix cli.users.create OHpIUENHak9FTTAzUCtwaHB1dnk3dz09 [email protected] 1234567890 "Adrian Norberto" Marino
 22:20:53.900 [info]  Response - Status: 201, Body: {
   "email": "[email protected]",
   "first_name": "Adrian Norberto",
@@ -252,3 +259,11 @@ To complete
 
 ### Custom Transactions
 To complete
+
+## Docker
+
+* docker-server-init: create/poulate database and run server in docker-compose env.
+* docker-server: Run server on docker-compose env.
+* docker-test: Run test on docker-compose env.
+* docker-reset: Reset(drop/create/migrate/populate) database in docker-compose env.
+* docker-clean: Clean(drop/create/migrate) database in docker-compose env.

README.md

@@ -7,7 +7,8 @@ use Mix.Config
 # watchers to your application. For example, we use it
 # with brunch.io to recompile .js and .css sources.
 config :point, Point.Endpoint,
-  http: [port: 4000],
+  http: [port: 3000],
+  url: [host: "localhost", port: 3000],
   debug_errors: true,
   code_reloader: true,
   check_origin: false,
@@ -36,5 +37,6 @@ config :point, Point.Repo,
   username: "root",
   password: "1234",
   database: "point_dev",
-  hostname: "localhost",
-  pool_size: 10
+  hostname: System.get_env("DB_HOST") || "localhost",
+  pool_size: 10,
+  ownership_timeout: 60_000

config/dev.exs

@@ -12,8 +12,8 @@ use Mix.Config
 # manifest is generated by the mix phoenix.digest task
 # which you typically run after static files are built.
 config :point, Point.Endpoint,
-  http: [port: {:system, "PORT"}],
-  url: [host: "example.com", port: 80],
+  http: [port: 3000],
+  url: [host: "points", port: 3000],
   cache_static_manifest: "priv/static/manifest.json",
   session_ttl: 1_800,
   simultaneous_sessions_by_user_and_remote_ip: 3,
@@ -29,6 +29,16 @@ config :logger,
   format: "$time $metadata[$level] $levelpad$message",
   level: :info
 
+# Configure your database
+config :point, Point.Repo,
+  adapter: Ecto.Adapters.MySQL,
+  username: "root",
+  password: "1234",
+  database: "point_prod",
+  hostname: System.get_env("DB_HOST") || "localhost",
+  pool_size: 100,
+  ownership_timeout: 60_000
+
 # ## SSL Support
 #
 # To get SSL working, you will need to add the `https` key

config/prod.exs

@@ -21,10 +21,11 @@ config :ecto_ttl,
 config :point, Point.Repo,
   adapter: Ecto.Adapters.MySQL,
   username: "root",
-  password: "",
+  password: "1234",
   database: "point_test",
-  hostname: "localhost",
-  pool: Ecto.Adapters.SQL.Sandbox
+  hostname: System.get_env("DB_HOST") || "localhost",
+  pool: Ecto.Adapters.SQL.Sandbox,
+  ownership_timeout: 60_000
 
 config :comeonin, :bcrypt_log_rounds, 4
 config :comeonin, :pbkdf2_rounds, 1

config/test.exs

@@ -0,0 +1,2 @@
+#!/bin/bash
+bash docker-run "mix ecto.clean" $1 $2

docker-clean

@@ -0,0 +1,24 @@
+database_storage:
+  image: "busybox"
+  volumes:
+    - /var/lib/mysql
+
+database:
+  image: "mariadb:10"
+  ports:
+    - "3306:3306"
+  environment:
+    MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
+    MYSQL_DATABASE: "point_${MIX_ENV}"
+  volumes_from:
+    - database_storage
+
+points:
+  build: "."
+  environment:
+    MIX_ENV: ${MIX_ENV}
+    DB_HOST: database
+  ports:
+    - "3000:3000"
+  links:
+    - database

docker-compose.yml

@@ -0,0 +1,2 @@
+#!/bin/bash
+bash docker-run "mix ecto.reset" $1 $2

docker-reset

@@ -0,0 +1,13 @@
+#!/bin/bash
+COMMAND=$1
+
+export MIX_ENV=${2:-dev}
+export MYSQL_ROOT_PASSWORD=${3:-1234}
+
+echo "=========================================================="
+echo "Environment: $MIX_ENV"
+echo "Password: $MYSQL_ROOT_PASSWORD"
+echo "Command: $COMMAND"
+echo "=========================================================="
+
+docker-compose run -p3000:3000 --rm points sh -c "$COMMAND"

docker-run

@@ -0,0 +1,2 @@
+#!/bin/bash
+bash docker-run "mix phoenix.server" $1 $2

docker-server

@@ -0,0 +1,2 @@
+#!/bin/bash
+bash docker-run "mix ecto.reset; mix phoenix.server" $1 $2

docker-server-init

@@ -0,0 +1,2 @@
+#!/bin/bash
+bash docker-run "mix espec --format=doc" test $2

docker-test

@@ -1,21 +1,21 @@
 defmodule Mix.Tasks.Cli.Accounts do
   use Mix.Task.Point.Client
-  @shortdoc "Show accounts. Param: session_token"
-  defrun fn(token) -> points(base_url, token) |> accounts end
+  @shortdoc "Show accounts. Params: token"
+  defrun fn([token | _]) -> points(base_url(), token) |> accounts end
 
   defmodule Show do
     use Mix.Task.Point.Client
-    @shortdoc "Show an account. Params: session_token owner_email currency_code"
-    defrun fn([token | account]) -> points(base_url, token) |> accounts(show: Account.create(account)) end
+    @shortdoc "Show an account. Params: token owner_email currency_code"
+    defrun fn([token | account]) -> points(base_url(), token) |> accounts(show: Account.create(account)) end
   end
   defmodule Create do
     use Mix.Task.Point.Client
-    @shortdoc "Create an account. Params: session_token owner_email currency_code"
-    defrun fn([token | account]) -> points(base_url, token) |> accounts(create: Account.create(account)) end
+    @shortdoc "Create an account. Params: token owner_email currency_code"
+    defrun fn([token | account]) -> points(base_url(), token) |> accounts(create: Account.create(account)) end
   end
   defmodule Delete do
     use Mix.Task.Point.Client
-    @shortdoc "Delete an account. Params: session_token owner_email currency_code"
-    defrun fn([token | account]) -> points(base_url, token) |> accounts(delete: Account.create(account)) end
+    @shortdoc "Delete an account. Params: token owner_email currency_code"
+    defrun fn([token | account]) -> points(base_url(), token) |> accounts(delete: Account.create(account)) end
   end
 end

google-chrome-stable

@@ -1,26 +1,26 @@
 defmodule Mix.Tasks.Cli.Currencies do
   use Mix.Task.Point.Client
-  @shortdoc "Show currencies. Param: session_token"
-  defrun fn(token) -> points(base_url, token) |> currencies end
+  @shortdoc "Show currencies. Params: token"
+  defrun fn([token | _]) -> points(base_url(), token) |> currencies end
 
   defmodule Show do
     use Mix.Task.Point.Client
-    @shortdoc "Show a currency. Params: session_token code"
-    defrun fn([token | [code | _]])-> points(base_url, token) |> currencies(show: code) end
+    @shortdoc "Show a currency. Params: token code"
+    defrun fn([token | [code | _]])-> points(base_url(), token) |> currencies(show: code) end
   end
   defmodule Create do
     use Mix.Task.Point.Client
-    @shortdoc "Create a currency. Params: session_token code name"
-    defrun fn([token | params]) -> points(base_url, token) |> currencies(create: Currency.new(params)) end
+    @shortdoc "Create a currency. Params: token code name"
+    defrun fn([token | params]) -> points(base_url(), token) |> currencies(create: Currency.new(params)) end
   end
   defmodule Update do
     use Mix.Task.Point.Client
-    @shortdoc "Update currency name. Params: session_token code name"
-    defrun fn([token | params]) -> points(base_url, token) |> currencies(update: Currency.new(params)) end
+    @shortdoc "Update currency name. Params: token code name"
+    defrun fn([token | params]) -> points(base_url(), token) |> currencies(update: Currency.new(params)) end
   end
   defmodule Delete do
     use Mix.Task.Point.Client
-    @shortdoc "Delete a currency. Params: session_token code"
-    defrun fn([token | [code | _]]) -> points(base_url, token) |> currencies(delete: code) end
+    @shortdoc "Delete a currency. Params: token code"
+    defrun fn([token | [code | _]]) -> points(base_url(), token) |> currencies(delete: code) end
   end
 end

lib/mix/tasks/client/accounts.ex

@@ -0,0 +1,43 @@
+defmodule Mix.Tasks.Cli.Entities do
+  use Mix.Task.Point.Client
+  @shortdoc "Show entities. Params: token"
+  defrun fn([token | _]) -> points(base_url(), token) |> entities end
+
+  defmodule Show do
+    use Mix.Task.Point.Client
+    @shortdoc "Show an entity. Params: token code"
+    defrun fn([token | [code | _]])-> points(base_url(), token) |> entities(show: code) end
+  end
+  defmodule Create do
+    use Mix.Task.Point.Client
+    @shortdoc "Create an entity. Params: token code name"
+    defrun fn([token | params]) -> points(base_url(), token) |> entities(create: Entity.new(params)) end
+  end
+  defmodule Update do
+    use Mix.Task.Point.Client
+    @shortdoc "Update entity name. Params: token code name"
+    defrun fn([token | params]) -> points(base_url(), token) |> entities(update: Entity.new(params)) end
+  end
+  defmodule Delete do
+    use Mix.Task.Point.Client
+    @shortdoc "Delete an entity. Params: token code"
+    defrun fn([token | [code | _]]) -> points(base_url(), token) |> entities(delete: code) end
+  end
+
+  defmodule Partners do
+    use Mix.Task.Point.Client
+    @shortdoc "Show entity partners. Params: token entity_code"
+    defrun fn([token | [entity_code | _]]) -> points(base_url(), token) |> partners(entity_code: entity_code) end
+
+    defmodule Create do
+      use Mix.Task.Point.Client
+      @shortdoc "Create an entity partner. Params: token partner_code entity_code "
+      defrun fn([token | params]) -> points(base_url(), token) |> partners(create: Partner.new(params)) end
+    end
+    defmodule Delete do
+      use Mix.Task.Point.Client
+      @shortdoc "Delete an entity partner. Params: token partner_code entity_code"
+      defrun fn([token | params]) -> points(base_url(), token) |> partners(delete: Partner.new(params)) end
+    end
+  end
+end

lib/mix/tasks/client/currencies.ex

@@ -1,26 +1,26 @@
 defmodule Mix.Tasks.Cli.ExchangeRates do
   use Mix.Task.Point.Client
-  @shortdoc "Show exchange rates. Param: session_token"
-  defrun fn(token) -> points(base_url, token) |> exchange_rates end
+  @shortdoc "Show exchange rates. Params: token"
+  defrun fn([token | _]) -> points(base_url(), token) |> exchange_rates end
 
   defmodule Show do
     use Mix.Task.Point.Client
-    @shortdoc "Show a exchange rate. Params: session_token source target"
-    defrun fn([token | params]) -> points(base_url, token) |> exchange_rates(show: ExchangeRateId.new(params)) end
+    @shortdoc "Show a exchange rate. Params: token source target"
+    defrun fn([token | params]) -> points(base_url(), token) |> exchange_rates(show: ExchangeRateId.new(params)) end
   end
   defmodule Create do
     use Mix.Task.Point.Client
-    @shortdoc "Create a exchange rate. Params: session_token source target value (target = source * value)"
-    defrun fn([token | params]) -> points(base_url, token) |> exchange_rates(create: ExchangeRate.new(params)) end
+    @shortdoc "Create a exchange rate. Params: token source target value"
+    defrun fn([token | params]) -> points(base_url(), token) |> exchange_rates(create: ExchangeRate.new(params)) end
   end
   defmodule Update do
     use Mix.Task.Point.Client
-    @shortdoc "Update a exchange rate. Params: session_token source target value"
-    defrun fn([token | params]) -> points(base_url, token) |> exchange_rates(update: ExchangeRate.new(params)) end
+    @shortdoc "Update a exchange rate. Params: token source target value"
+    defrun fn([token | params]) -> points(base_url(), token) |> exchange_rates(update: ExchangeRate.new(params)) end
   end
   defmodule Delete do
     use Mix.Task.Point.Client
-    @shortdoc "Delete a exchange rate. Params: session_token source target"
-    defrun fn([token | params]) -> points(base_url, token) |> exchange_rates(delete: ExchangeRateId.new(params)) end
+    @shortdoc "Delete a exchange rate. Params: token source target"
+    defrun fn([token | params]) -> points(base_url(), token) |> exchange_rates(delete: ExchangeRateId.new(params)) end
   end
 end

lib/mix/tasks/client/entities.ex

@@ -0,0 +1,12 @@
+defmodule Mix.Tasks.Cli.Movements do
+  defmodule ByAccountAfter do
+    use Mix.Task.Point.Client
+    @shortdoc "Show account movements after a date. Params: token owner_email currency_code timestamp (after format: YYYYMMDD_HHMM)"
+    defrun fn([token | params]) -> points(base_url(), token) |> movements(search: AccountMovement.create(params)) end
+  end
+  defmodule Between do
+    use Mix.Task.Point.Client
+    @shortdoc "Show movements between dates. Params: from to (format: YYYYMMDD_HHMM)"
+    defrun fn([token | params]) -> points(base_url(), token) |> movements(search: Between.create(params)) end
+  end
+end