-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #39 from inaka/flavio.27.example-app
[#27] example app, fixing dayron to make unit tests possible
- Loading branch information
Showing
54 changed files
with
1,338 additions
and
115 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# App artifacts | ||
/_build | ||
/db | ||
/deps | ||
/*.ez | ||
|
||
# Generate on crash by the VM | ||
erl_crash.dump | ||
|
||
# Static artifacts | ||
/node_modules | ||
|
||
# Since we are building assets from web/static, | ||
# we ignore priv/static. You may want to comment | ||
# this depending on your deployment strategy. | ||
/priv/static/ | ||
|
||
# The config/prod.secret.exs file by default contains sensitive | ||
# data and you should not commit it into version control. | ||
# | ||
# Alternatively, you may comment the line below and commit the | ||
# secrets file as long as you replace its contents by environment | ||
# variables. | ||
/config/prod.secret.exs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Simple Blog | ||
|
||
A Phoenix Application to work as an example of [Dayron](https://github.com/inaka/Dayron) usage. It's a simple blog consuming the public API endpoints provided by [JSON Placeholder](http://jsonplaceholder.typicode.com/). | ||
|
||
The API does not require authentication, but it provides a good example of basic CRUD operations. | ||
|
||
The application does not require Ecto or a local Database server. | ||
|
||
To start Simple Blog: | ||
|
||
* Install dependencies with `mix deps.get` | ||
* Install Node.js dependencies with `npm install` | ||
* Start Phoenix endpoint with `mix phoenix.server` | ||
|
||
After the above steps you can visit [`localhost:4000`](http://localhost:4000) from your browser. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
exports.config = { | ||
// See http://brunch.io/#documentation for docs. | ||
files: { | ||
javascripts: { | ||
joinTo: "js/app.js" | ||
|
||
// To use a separate vendor.js bundle, specify two files path | ||
// https://github.com/brunch/brunch/blob/stable/docs/config.md#files | ||
// joinTo: { | ||
// "js/app.js": /^(web\/static\/js)/, | ||
// "js/vendor.js": /^(web\/static\/vendor)|(deps)/ | ||
// } | ||
// | ||
// To change the order of concatenation of files, explicitly mention here | ||
// https://github.com/brunch/brunch/tree/master/docs#concatenation | ||
// order: { | ||
// before: [ | ||
// "web/static/vendor/js/jquery-2.1.1.js", | ||
// "web/static/vendor/js/bootstrap.min.js" | ||
// ] | ||
// } | ||
}, | ||
stylesheets: { | ||
joinTo: "css/app.css" | ||
}, | ||
templates: { | ||
joinTo: "js/app.js" | ||
} | ||
}, | ||
|
||
conventions: { | ||
// This option sets where we should place non-css and non-js assets in. | ||
// By default, we set this to "/web/static/assets". Files in this directory | ||
// will be copied to `paths.public`, which is "priv/static" by default. | ||
assets: /^(web\/static\/assets)/ | ||
}, | ||
|
||
// Phoenix paths configuration | ||
paths: { | ||
// Dependencies and current project directories to watch | ||
watched: [ | ||
"web/static", | ||
"test/static" | ||
], | ||
|
||
// Where to compile files to | ||
public: "priv/static" | ||
}, | ||
|
||
// Configure your plugins | ||
plugins: { | ||
babel: { | ||
// Do not use ES6 compiler in vendor code | ||
ignore: [/web\/static\/vendor/] | ||
} | ||
}, | ||
|
||
modules: { | ||
autoRequire: { | ||
"js/app.js": ["web/static/js/app"] | ||
} | ||
}, | ||
|
||
npm: { | ||
enabled: true, | ||
// Whitelist the npm deps to be pulled in as front-end assets. | ||
// All other deps in package.json will be excluded from the bundle. | ||
whitelist: ["phoenix", "phoenix_html"] | ||
} | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# This file is responsible for configuring your application | ||
# and its dependencies with the aid of the Mix.Config module. | ||
# | ||
# This configuration file is loaded before any dependency and | ||
# is restricted to this project. | ||
use Mix.Config | ||
|
||
# Configures the endpoint | ||
config :simple_blog, SimpleBlog.Endpoint, | ||
url: [host: "localhost"], | ||
root: Path.dirname(__DIR__), | ||
secret_key_base: "BHmOT2LUbCvWBU6CJsNfU78/E3dGEpmR5HqTj6syHickv5CBNEX9lMk9ygZCn1xx", | ||
render_errors: [accepts: ~w(html json)], | ||
pubsub: [name: SimpleBlog.PubSub, | ||
adapter: Phoenix.PubSub.PG2] | ||
|
||
# Configures Elixir's Logger | ||
config :logger, :console, | ||
format: "$time $metadata[$level] $message\n", | ||
metadata: [:request_id] | ||
|
||
# Configures Dayron's RestRepo | ||
config :simple_blog, SimpleBlog.RestRepo, | ||
url: "http://jsonplaceholder.typicode.com" | ||
|
||
# Import environment specific config. This must remain at the bottom | ||
# of this file so it overrides the configuration defined above. | ||
import_config "#{Mix.env}.exs" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
use Mix.Config | ||
|
||
# For development, we disable any cache and enable | ||
# debugging and code reloading. | ||
# | ||
# The watchers configuration can be used to run external | ||
# watchers to your application. For example, we use it | ||
# with brunch.io to recompile .js and .css sources. | ||
config :simple_blog, SimpleBlog.Endpoint, | ||
http: [port: 4000], | ||
debug_errors: true, | ||
code_reloader: true, | ||
check_origin: false, | ||
watchers: [node: ["node_modules/brunch/bin/brunch", "watch", "--stdin"]] | ||
|
||
# Watch static and templates for browser reloading. | ||
config :simple_blog, SimpleBlog.Endpoint, | ||
live_reload: [ | ||
patterns: [ | ||
~r{priv/static/.*(js|css|png|jpeg|jpg|gif|svg)$}, | ||
~r{priv/gettext/.*(po)$}, | ||
~r{web/views/.*(ex)$}, | ||
~r{web/templates/.*(eex)$} | ||
] | ||
] | ||
|
||
# Do not include metadata nor timestamps in development logs | ||
config :logger, :console, format: "[$level] $message\n" | ||
|
||
# Set a higher stacktrace during development. | ||
# Do not configure such in production as keeping | ||
# and calculating stacktraces is usually expensive. | ||
config :phoenix, :stacktrace_depth, 20 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
use Mix.Config | ||
|
||
# For production, we configure the host to read the PORT | ||
# from the system environment. Therefore, you will need | ||
# to set PORT=80 before running your server. | ||
# | ||
# You should also configure the url host to something | ||
# meaningful, we use this information when generating URLs. | ||
# | ||
# Finally, we also include the path to a manifest | ||
# containing the digested version of static files. This | ||
# manifest is generated by the mix phoenix.digest task | ||
# which you typically run after static files are built. | ||
config :simple_blog, SimpleBlog.Endpoint, | ||
http: [port: {:system, "PORT"}], | ||
url: [host: "example.com", port: 80], | ||
cache_static_manifest: "priv/static/manifest.json" | ||
|
||
# Do not print debug messages in production | ||
config :logger, level: :info | ||
|
||
# ## SSL Support | ||
# | ||
# To get SSL working, you will need to add the `https` key | ||
# to the previous section and set your `:url` port to 443: | ||
# | ||
# config :simple_blog, SimpleBlog.Endpoint, | ||
# ... | ||
# url: [host: "example.com", port: 443], | ||
# https: [port: 443, | ||
# keyfile: System.get_env("SOME_APP_SSL_KEY_PATH"), | ||
# certfile: System.get_env("SOME_APP_SSL_CERT_PATH")] | ||
# | ||
# Where those two env variables return an absolute path to | ||
# the key and cert in disk or a relative path inside priv, | ||
# for example "priv/ssl/server.key". | ||
# | ||
# We also recommend setting `force_ssl`, ensuring no data is | ||
# ever sent via http, always redirecting to https: | ||
# | ||
# config :simple_blog, SimpleBlog.Endpoint, | ||
# force_ssl: [hsts: true] | ||
# | ||
# Check `Plug.SSL` for all available options in `force_ssl`. | ||
|
||
# ## Using releases | ||
# | ||
# If you are doing OTP releases, you need to instruct Phoenix | ||
# to start the server for all endpoints: | ||
# | ||
# config :phoenix, :serve_endpoints, true | ||
# | ||
# Alternatively, you can configure exactly which server to | ||
# start per endpoint: | ||
# | ||
# config :simple_blog, SimpleBlog.Endpoint, server: true | ||
# | ||
# You will also need to set the application root to `.` in order | ||
# for the new static assets to be served after a hot upgrade: | ||
# | ||
# config :simple_blog, SimpleBlog.Endpoint, root: "." | ||
|
||
# Finally import the config/prod.secret.exs | ||
# which should be versioned separately. | ||
import_config "prod.secret.exs" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
use Mix.Config | ||
|
||
# We don't run a server during test. If one is required, | ||
# you can enable the server option below. | ||
config :simple_blog, SimpleBlog.Endpoint, | ||
http: [port: 4001], | ||
server: false | ||
|
||
# Print only warnings and errors during test | ||
config :logger, level: :warn |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
defmodule SimpleBlog do | ||
use Application | ||
|
||
# See http://elixir-lang.org/docs/stable/elixir/Application.html | ||
# for more information on OTP Applications | ||
def start(_type, _args) do | ||
import Supervisor.Spec, warn: false | ||
|
||
children = [ | ||
# Start the endpoint when the application starts | ||
supervisor(SimpleBlog.Endpoint, []), | ||
# Here you could define other workers and supervisors as children | ||
# worker(SimpleBlog.Worker, [arg1, arg2, arg3]), | ||
] | ||
|
||
# See http://elixir-lang.org/docs/stable/elixir/Supervisor.html | ||
# for other strategies and supported options | ||
opts = [strategy: :one_for_one, name: SimpleBlog.Supervisor] | ||
Supervisor.start_link(children, opts) | ||
end | ||
|
||
# Tell Phoenix to update the endpoint configuration | ||
# whenever the application is updated. | ||
def config_change(changed, _new, removed) do | ||
SimpleBlog.Endpoint.config_change(changed, removed) | ||
:ok | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
defmodule SimpleBlog.Endpoint do | ||
use Phoenix.Endpoint, otp_app: :simple_blog | ||
|
||
socket "/socket", SimpleBlog.UserSocket | ||
|
||
# Serve at "/" the static files from "priv/static" directory. | ||
# | ||
# You should set gzip to true if you are running phoenix.digest | ||
# when deploying your static files in production. | ||
plug Plug.Static, | ||
at: "/", from: :simple_blog, gzip: false, | ||
only: ~w(css fonts images js favicon.ico robots.txt) | ||
|
||
# Code reloading can be explicitly enabled under the | ||
# :code_reloader configuration of your endpoint. | ||
if code_reloading? do | ||
socket "/phoenix/live_reload/socket", Phoenix.LiveReloader.Socket | ||
plug Phoenix.LiveReloader | ||
plug Phoenix.CodeReloader | ||
end | ||
|
||
plug Plug.RequestId | ||
plug Plug.Logger | ||
|
||
plug Plug.Parsers, | ||
parsers: [:urlencoded, :multipart, :json], | ||
pass: ["*/*"], | ||
json_decoder: Poison | ||
|
||
plug Plug.MethodOverride | ||
plug Plug.Head | ||
|
||
plug Plug.Session, | ||
store: :cookie, | ||
key: "_simple_blog_key", | ||
signing_salt: "e8HdExc2" | ||
|
||
plug SimpleBlog.Router | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
defmodule SimpleBlog.RestRepo do | ||
@moduledoc false | ||
use Dayron.Repo, otp_app: :simple_blog | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
defmodule SimpleBlog.Mixfile do | ||
use Mix.Project | ||
|
||
def project do | ||
[app: :simple_blog, | ||
version: "0.0.1", | ||
elixir: "~> 1.0", | ||
elixirc_paths: elixirc_paths(Mix.env), | ||
compilers: [:phoenix, :gettext] ++ Mix.compilers, | ||
build_embedded: Mix.env == :prod, | ||
start_permanent: Mix.env == :prod, | ||
deps: deps] | ||
end | ||
|
||
# Configuration for the OTP application. | ||
# | ||
# Type `mix help compile.app` for more information. | ||
def application do | ||
[mod: {SimpleBlog, []}, | ||
applications: [:phoenix, :phoenix_html, :cowboy, :logger, :gettext, :dayron]] | ||
end | ||
|
||
# Specifies which paths to compile per environment. | ||
defp elixirc_paths(:test), do: ["lib", "web", "test/support"] | ||
defp elixirc_paths(_), do: ["lib", "web"] | ||
|
||
# Specifies your project dependencies. | ||
# | ||
# Type `mix help deps` for examples and options. | ||
defp deps do | ||
[ | ||
{:phoenix, "~> 1.1.4"}, | ||
{:phoenix_html, "~> 2.4"}, | ||
{:phoenix_live_reload, "~> 1.0", only: :dev}, | ||
{:gettext, "~> 0.9"}, | ||
{:cowboy, "~> 1.0"}, | ||
{:dayron, path: "../.."}, | ||
{:bypass, "~> 0.1", only: :test} | ||
] | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
%{"bypass": {:hex, :bypass, "0.5.1", "cf3e8a4d376ee1dcd89bf362dfaf1f4bf4a6e19895f52fdc2bafbd8207ce435f", [:mix], [{:plug, "~> 1.0", [hex: :plug, optional: false]}, {:cowboy, "~> 1.0", [hex: :cowboy, optional: false]}]}, | ||
"certifi": {:hex, :certifi, "0.4.0", "a7966efb868b179023618d29a407548f70c52466bf1849b9e8ebd0e34b7ea11f", [:rebar3], []}, | ||
"cowboy": {:hex, :cowboy, "1.0.4", "a324a8df9f2316c833a470d918aaf73ae894278b8aa6226ce7a9bf699388f878", [:rebar, :make], [{:cowlib, "~> 1.0.0", [hex: :cowlib, optional: false]}, {:ranch, "~> 1.0", [hex: :ranch, optional: false]}]}, | ||
"cowlib": {:hex, :cowlib, "1.0.2", "9d769a1d062c9c3ac753096f868ca121e2730b9a377de23dec0f7e08b1df84ee", [:make], []}, | ||
"crutches": {:hex, :crutches, "1.0.0", "34675f0c88f25a3a6d2a77912194beaece9bf835f9f2f5627027b4a19125aaa6", [:mix], []}, | ||
"fs": {:hex, :fs, "0.9.2", "ed17036c26c3f70ac49781ed9220a50c36775c6ca2cf8182d123b6566e49ec59", [:rebar], []}, | ||
"gettext": {:hex, :gettext, "0.11.0", "80c1dd42d270482418fa158ec5ba073d2980e3718bacad86f3d4ad71d5667679", [:mix], []}, | ||
"hackney": {:hex, :hackney, "1.6.0", "8d1e9440c9edf23bf5e5e2fe0c71de03eb265103b72901337394c840eec679ac", [:rebar3], [{:ssl_verify_fun, "1.1.0", [hex: :ssl_verify_fun, optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, optional: false]}, {:metrics, "1.0.1", [hex: :metrics, optional: false]}, {:idna, "1.2.0", [hex: :idna, optional: false]}, {:certifi, "0.4.0", [hex: :certifi, optional: false]}]}, | ||
"httpoison": {:hex, :httpoison, "0.8.3", "b675a3fdc839a0b8d7a285c6b3747d6d596ae70b6ccb762233a990d7289ccae4", [:mix], [{:hackney, "~> 1.6.0", [hex: :hackney, optional: false]}]}, | ||
"idna": {:hex, :idna, "1.2.0", "ac62ee99da068f43c50dc69acf700e03a62a348360126260e87f2b54eced86b2", [:rebar3], []}, | ||
"metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], []}, | ||
"mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], []}, | ||
"phoenix": {:hex, :phoenix, "1.1.4", "65809fba92eb94377372a5fb5a561197654bb8406e773cc47ca1a031bbe58019", [:mix], [{:poison, "~> 1.5 or ~> 2.0", [hex: :poison, optional: false]}, {:plug, "~> 1.0", [hex: :plug, optional: false]}, {:cowboy, "~> 1.0", [hex: :cowboy, optional: true]}]}, | ||
"phoenix_html": {:hex, :phoenix_html, "2.5.1", "631053f9e345fecb5c87d9e0ccd807f7266d27e2ee4269817067af425fd81ba8", [:mix], [{:plug, "~> 0.13 or ~> 1.0", [hex: :plug, optional: false]}]}, | ||
"phoenix_live_reload": {:hex, :phoenix_live_reload, "1.0.5", "829218c4152ba1e9848e2bf8e161fcde6b4ec679a516259442561d21fde68d0b", [:mix], [{:phoenix, "~> 1.0 or ~> 1.2-rc", [hex: :phoenix, optional: false]}, {:fs, "~> 0.9.1", [hex: :fs, optional: false]}]}, | ||
"plug": {:hex, :plug, "1.1.4", "2eee0e85ad420db96e075b3191d3764d6fff61422b101dc5b02e9cce99cacfc7", [:mix], [{:cowboy, "~> 1.0", [hex: :cowboy, optional: true]}]}, | ||
"poison": {:hex, :poison, "2.1.0", "f583218ced822675e484648fa26c933d621373f01c6c76bd00005d7bd4b82e27", [:mix], []}, | ||
"ranch": {:hex, :ranch, "1.2.1", "a6fb992c10f2187b46ffd17ce398ddf8a54f691b81768f9ef5f461ea7e28c762", [:make], []}, | ||
"ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.0", "edee20847c42e379bf91261db474ffbe373f8acb56e9079acb6038d4e0bf414f", [:rebar, :make], []}} |
Oops, something went wrong.