├── .credo.exs
├── .formatter.exs
├── .github
    ├── CODEOWNERS
    ├── dependabot.yml
    ├── release-please-config.json
    ├── release-please-manifest.json
    └── workflows
    │   ├── ci.yaml
    │   ├── common-config.yaml
    │   ├── pr.yaml
    │   ├── production.yaml
    │   ├── publish-docs.yaml
    │   ├── release.yaml
    │   └── stale.yaml
├── .gitignore
├── .tool-versions
├── CHANGELOG.md
├── LICENSE
├── README.md
├── example
    ├── .gitignore
    ├── README.md
    ├── assets
    │   ├── .babelrc
    │   ├── css
    │   │   ├── app.css
    │   │   └── phoenix.css
    │   ├── js
    │   │   ├── app.js
    │   │   └── socket.js
    │   ├── package-lock.json
    │   ├── package.json
    │   ├── static
    │   │   ├── favicon.ico
    │   │   ├── images
    │   │   │   └── phoenix.png
    │   │   └── robots.txt
    │   └── webpack.config.js
    ├── config
    │   ├── config.exs
    │   ├── dev.exs
    │   ├── prod.exs
    │   └── test.exs
    ├── lib
    │   ├── example.ex
    │   ├── example
    │   │   ├── application.ex
    │   │   └── repo.ex
    │   ├── example_web.ex
    │   └── example_web
    │   │   ├── channels
    │   │       └── user_socket.ex
    │   │   ├── controllers
    │   │       ├── foo_controller.ex
    │   │       └── page_controller.ex
    │   │   ├── endpoint.ex
    │   │   ├── gettext.ex
    │   │   ├── router.ex
    │   │   ├── templates
    │   │       ├── foo
    │   │       │   ├── edit.html.eex
    │   │       │   ├── form.html.eex
    │   │       │   ├── index.html.eex
    │   │       │   ├── new.html.eex
    │   │       │   └── show.html.eex
    │   │       ├── layout
    │   │       │   └── app.html.eex
    │   │       └── page
    │   │       │   └── index.html.eex
    │   │   └── views
    │   │       ├── error_helpers.ex
    │   │       ├── error_view.ex
    │   │       ├── layout_view.ex
    │   │       └── page_view.ex
    ├── mix.exs
    ├── mix.lock
    ├── priv
    │   ├── gettext
    │   │   ├── en
    │   │   │   └── LC_MESSAGES
    │   │   │   │   └── errors.po
    │   │   └── errors.pot
    │   └── repo
    │   │   ├── migrations
    │   │       └── 20161130184742_create_foo.exs
    │   │   └── seeds.exs
    └── test
    │   ├── example_web
    │       ├── controllers
    │       │   └── page_controller_test.exs
    │       └── views
    │       │   ├── error_view_test.exs
    │       │   ├── layout_view_test.exs
    │       │   └── page_view_test.exs
    │   ├── support
    │       ├── channel_case.ex
    │       ├── conn_case.ex
    │       └── data_case.ex
    │   └── test_helper.exs
├── lib
    ├── ua_parser.ex
    └── ua_parser
    │   ├── device.ex
    │   ├── operating_system.ex
    │   ├── parser.ex
    │   ├── parsers
    │       ├── base.ex
    │       ├── device.ex
    │       ├── operating_system.ex
    │       ├── user_agent.ex
    │       └── version.ex
    │   ├── processor.ex
    │   ├── storage.ex
    │   ├── user_agent.ex
    │   └── version.ex
├── mix.exs
├── mix.lock
├── priv
    └── patterns.yml
└── test
    ├── fixtures
        └── patterns.yml
    ├── test_helper.exs
    ├── ua_parser
        ├── device_test.exs
        ├── operating_system_test.exs
        ├── parser_test.exs
        ├── parsers
        │   ├── device_test.exs
        │   ├── operating_system_parser_test.exs
        │   ├── user_agent_test.exs
        │   └── version_test.exs
        ├── processor_test.exs
        ├── storage_test.exs
        ├── user_agent_test.exs
        └── version_test.exs
    └── ua_parser_test.exs


/.credo.exs:
--------------------------------------------------------------------------------
  1 | # This file is synced with beam-community/common-config. Any changes will be overwritten.
  2 | 
  3 | # This file contains the configuration for Credo and you are probably reading
  4 | # this after creating it with `mix credo.gen.config`.
  5 | #
  6 | # If you find anything wrong or unclear in this file, please report an
  7 | # issue on GitHub: https://github.com/rrrene/credo/issues
  8 | #
  9 | %{
 10 |   #
 11 |   # You can have as many configs as you like in the `configs:` field.
 12 |   configs: [
 13 |     %{
 14 |       #
 15 |       # Run any config using `mix credo -C <name>`. If no config name is given
 16 |       # "default" is used.
 17 |       #
 18 |       name: "default",
 19 |       #
 20 |       # These are the files included in the analysis:
 21 |       files: %{
 22 |         #
 23 |         # You can give explicit globs or simply directories.
 24 |         # In the latter case `**/*.{ex,exs}` will be used.
 25 |         #
 26 |         included: ["config/", "lib/", "priv/", "test/"],
 27 |         excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
 28 |       },
 29 |       #
 30 |       # Load and configure plugins here:
 31 |       #
 32 |       plugins: [],
 33 |       #
 34 |       # If you create your own checks, you must specify the source files for
 35 |       # them here, so they can be loaded by Credo before running the analysis.
 36 |       #
 37 |       requires: [],
 38 |       #
 39 |       # If you want to enforce a style guide and need a more traditional linting
 40 |       # experience, you can change `strict` to `true` below:
 41 |       #
 42 |       strict: true,
 43 |       #
 44 |       # To modify the timeout for parsing files, change this value:
 45 |       #
 46 |       parse_timeout: 5000,
 47 |       #
 48 |       # If you want to use uncolored output by default, you can change `color`
 49 |       # to `false` below:
 50 |       #
 51 |       color: true,
 52 |       #
 53 |       # You can customize the parameters of any check by adding a second element
 54 |       # to the tuple.
 55 |       #
 56 |       # To disable a check put `false` as second element:
 57 |       #
 58 |       #     {Credo.Check.Design.DuplicatedCode, false}
 59 |       #
 60 |       checks: [
 61 |         #
 62 |         ## Consistency Checks
 63 |         #
 64 |         {Credo.Check.Consistency.ExceptionNames, []},
 65 |         {Credo.Check.Consistency.LineEndings, []},
 66 |         {Credo.Check.Consistency.MultiAliasImportRequireUse, []},
 67 |         {Credo.Check.Consistency.ParameterPatternMatching, []},
 68 |         {Credo.Check.Consistency.SpaceAroundOperators, []},
 69 |         {Credo.Check.Consistency.SpaceInParentheses, []},
 70 |         {Credo.Check.Consistency.TabsOrSpaces, []},
 71 |         {Credo.Check.Consistency.UnusedVariableNames, false},
 72 | 
 73 |         #
 74 |         ## Design Checks
 75 |         #
 76 |         # You can customize the priority of any check
 77 |         # Priority values are: `low, normal, high, higher`
 78 |         #
 79 |         {Credo.Check.Design.AliasUsage, [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 2]},
 80 |         {Credo.Check.Design.DuplicatedCode, false},
 81 |         # You can also customize the exit_status of each check.
 82 |         # If you don't want TODO comments to cause `mix credo` to fail, just
 83 |         # set this value to 0 (zero).
 84 |         #
 85 |         {Credo.Check.Design.TagTODO, [exit_status: 2]},
 86 |         {Credo.Check.Design.TagFIXME, []},
 87 | 
 88 |         #
 89 |         ## Readability Checks
 90 |         #
 91 |         {Credo.Check.Readability.AliasAs, false},
 92 |         {Credo.Check.Readability.AliasOrder, []},
 93 |         {Credo.Check.Readability.BlockPipe, []},
 94 |         {Credo.Check.Readability.FunctionNames, []},
 95 |         {Credo.Check.Readability.ImplTrue, []},
 96 |         {Credo.Check.Readability.LargeNumbers, [trailing_digits: 2]},
 97 |         {Credo.Check.Readability.MaxLineLength, false},
 98 |         {Credo.Check.Readability.ModuleAttributeNames, []},
 99 |         {Credo.Check.Readability.ModuleDoc, false},
100 |         {Credo.Check.Readability.ModuleNames, []},
101 |         {Credo.Check.Readability.MultiAlias, false},
102 |         {Credo.Check.Readability.NestedFunctionCalls, []},
103 |         {Credo.Check.Readability.ParenthesesInCondition, []},
104 |         {Credo.Check.Readability.ParenthesesOnZeroArityDefs, []},
105 |         {Credo.Check.Readability.PredicateFunctionNames, []},
106 |         {Credo.Check.Readability.PreferImplicitTry, []},
107 |         {Credo.Check.Readability.RedundantBlankLines, []},
108 |         {Credo.Check.Readability.Semicolons, []},
109 |         {Credo.Check.Readability.SeparateAliasRequire, []},
110 |         {Credo.Check.Readability.SinglePipe, []},
111 |         {Credo.Check.Readability.SpaceAfterCommas, []},
112 |         {Credo.Check.Readability.Specs, false},
113 |         {Credo.Check.Readability.StrictModuleLayout,
114 |          [
115 |            order:
116 |              ~w(moduledoc behaviour use import require alias module_attribute defstruct callback macrocallback optional_callback)a,
117 |            ignore: [:type],
118 |            ignore_module_attributes: [:tag, :trace]
119 |          ]},
120 |         {Credo.Check.Readability.StringSigils, []},
121 |         {Credo.Check.Readability.TrailingBlankLine, []},
122 |         {Credo.Check.Readability.TrailingWhiteSpace, []},
123 |         {Credo.Check.Readability.UnnecessaryAliasExpansion, []},
124 |         {Credo.Check.Readability.VariableNames, []},
125 |         {Credo.Check.Readability.WithCustomTaggedTuple, []},
126 | 
127 |         #
128 |         ## Refactoring Opportunities
129 |         #
130 |         {Credo.Check.Refactor.ABCSize, false},
131 |         {Credo.Check.Refactor.AppendSingleItem, []},
132 |         {Credo.Check.Refactor.CondStatements, []},
133 |         {Credo.Check.Refactor.CyclomaticComplexity, []},
134 |         {Credo.Check.Refactor.DoubleBooleanNegation, []},
135 |         {Credo.Check.Refactor.FunctionArity, []},
136 |         {Credo.Check.Refactor.LongQuoteBlocks, []},
137 |         # {Credo.Check.Refactor.MapInto, []},
138 |         {Credo.Check.Refactor.MatchInCondition, []},
139 |         {Credo.Check.Refactor.ModuleDependencies, false},
140 |         {Credo.Check.Refactor.NegatedConditionsInUnless, []},
141 |         {Credo.Check.Refactor.NegatedConditionsWithElse, []},
142 |         {Credo.Check.Refactor.NegatedIsNil, []},
143 |         {Credo.Check.Refactor.Nesting, []},
144 |         {Credo.Check.Refactor.PipeChainStart, []},
145 |         {Credo.Check.Refactor.UnlessWithElse, []},
146 |         {Credo.Check.Refactor.VariableRebinding, false},
147 |         {Credo.Check.Refactor.WithClauses, []},
148 | 
149 |         #
150 |         ## Warnings
151 |         #
152 |         {Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
153 |         {Credo.Check.Warning.BoolOperationOnSameValues, []},
154 |         {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
155 |         {Credo.Check.Warning.IExPry, []},
156 |         {Credo.Check.Warning.IoInspect, []},
157 |         {Credo.Check.Warning.LeakyEnvironment, []},
158 |         # {Credo.Check.Warning.LazyLogging, []},
159 |         {Credo.Check.Warning.MapGetUnsafePass, []},
160 |         # disabling this check by default, as if not included, it will be
161 |         # run on version 1.7.0 and above
162 |         {Credo.Check.Warning.MissedMetadataKeyInLoggerConfig, []},
163 |         {Credo.Check.Warning.MixEnv, []},
164 |         {Credo.Check.Warning.OperationOnSameValues, []},
165 |         {Credo.Check.Warning.OperationWithConstantResult, []},
166 |         {Credo.Check.Warning.RaiseInsideRescue, []},
167 |         {Credo.Check.Warning.UnsafeExec, []},
168 |         {Credo.Check.Warning.UnsafeToAtom, []},
169 |         {Credo.Check.Warning.UnusedEnumOperation, []},
170 |         {Credo.Check.Warning.UnusedFileOperation, []},
171 |         {Credo.Check.Warning.UnusedKeywordOperation, []},
172 |         {Credo.Check.Warning.UnusedListOperation, []},
173 |         {Credo.Check.Warning.UnusedPathOperation, []},
174 |         {Credo.Check.Warning.UnusedRegexOperation, []},
175 |         {Credo.Check.Warning.UnusedStringOperation, []},
176 |         {Credo.Check.Warning.UnusedTupleOperation, []}
177 |       ]
178 |     }
179 |   ]
180 | }
181 | 


--------------------------------------------------------------------------------
/.formatter.exs:
--------------------------------------------------------------------------------
1 | # This file is synced with beam-community/common-config. Any changes will be overwritten.
2 | 
3 | [
4 |   import_deps: [],
5 |   inputs: ["*.{heex,ex,exs}", "{config,lib,priv,test}/**/*.{heex,ex,exs}"],
6 |   line_length: 120,
7 |   plugins: []
8 | ]
9 | 


--------------------------------------------------------------------------------
/.github/CODEOWNERS:
--------------------------------------------------------------------------------
1 | * @beam-community/team
2 | 


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | updates:
 3 |   - package-ecosystem: github-actions
 4 |     directory: "/"
 5 |     schedule:
 6 |       interval: weekly
 7 |     commit-message:
 8 |       prefix: "chore(deps)"
 9 | 
10 |   - package-ecosystem: mix
11 |     directory: "/"
12 |     schedule:
13 |       interval: weekly
14 |     commit-message:
15 |       prefix: "chore(deps)"
16 |     groups:
17 |       prod:
18 |         dependency-type: production
19 |       dev:
20 |         dependency-type: development
21 | 


--------------------------------------------------------------------------------
/.github/release-please-config.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "$comment": "This file is synced with beam-community/common-config. Any changes will be overwritten.",
 3 |   "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
 4 |   "changelog-sections": [
 5 |     {
 6 |       "type": "feat",
 7 |       "section": "Features",
 8 |       "hidden": false
 9 |     },
10 |     {
11 |       "type": "fix",
12 |       "section": "Bug Fixes",
13 |       "hidden": false
14 |     },
15 |     {
16 |       "type": "refactor",
17 |       "section": "Miscellaneous",
18 |       "hidden": false
19 |     }
20 |   ],
21 |   "draft": false,
22 |   "draft-pull-request": false,
23 |   "packages": {
24 |     ".": {
25 |       "extra-files": [
26 |         "README.md"
27 |       ],
28 |       "release-type": "elixir"
29 |     }
30 |   },
31 |   "plugins": [
32 |     {
33 |       "type": "sentence-case"
34 |     }
35 |   ],
36 |   "prerelease": false,
37 |   "pull-request-header": "An automated release has been created for you.",
38 |   "separate-pull-requests": true
39 | }
40 | 


--------------------------------------------------------------------------------
/.github/release-please-manifest.json:
--------------------------------------------------------------------------------
1 | {
2 |   ".": "1.9.0"
3 | }
4 | 


--------------------------------------------------------------------------------
/.github/workflows/ci.yaml:
--------------------------------------------------------------------------------
  1 | # This file is synced with beam-community/common-config. Any changes will be overwritten.
  2 | 
  3 | name: CI
  4 | 
  5 | on:
  6 |   merge_group:
  7 |   pull_request:
  8 |     types:
  9 |       - opened
 10 |       - reopened
 11 |       - synchronize
 12 |   push:
 13 |     branches:
 14 |       - main
 15 |   workflow_call:
 16 |     secrets:
 17 |       GH_PERSONAL_ACCESS_TOKEN:
 18 |         required: true
 19 |   workflow_dispatch:
 20 | 
 21 | concurrency:
 22 |   group: CI ${{ github.head_ref || github.run_id }}
 23 |   cancel-in-progress: true
 24 | 
 25 | jobs:
 26 |   Credo:
 27 |     runs-on: ubuntu-latest
 28 | 
 29 |     steps:
 30 |       - name: Checkout
 31 |         uses: actions/checkout@v4
 32 | 
 33 |       - name: Setup Elixir
 34 |         uses: stordco/actions-elixir/setup@v1
 35 |         with:
 36 |           github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
 37 | 
 38 |       - name: Credo
 39 |         run: mix credo --strict
 40 | 
 41 |   Dependencies:
 42 |     runs-on: ubuntu-latest
 43 | 
 44 |     steps:
 45 |       - name: Checkout
 46 |         uses: actions/checkout@v4
 47 | 
 48 |       - name: Setup Elixir
 49 |         uses: stordco/actions-elixir/setup@v1
 50 |         with:
 51 |           github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
 52 | 
 53 |       - name: Unused
 54 |         run: mix deps.unlock --check-unused
 55 | 
 56 |   Dialyzer:
 57 |     runs-on: ubuntu-latest
 58 | 
 59 |     steps:
 60 |       - name: Checkout
 61 |         uses: actions/checkout@v4
 62 | 
 63 |       - name: Setup Elixir
 64 |         uses: stordco/actions-elixir/setup@v1
 65 |         with:
 66 |           github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
 67 | 
 68 |       - name: Dialyzer
 69 |         run: mix dialyzer --format github
 70 | 
 71 |   Format:
 72 |     runs-on: ubuntu-latest
 73 | 
 74 |     steps:
 75 |       - name: Checkout
 76 |         uses: actions/checkout@v4
 77 | 
 78 |       - name: Setup Elixir
 79 |         uses: stordco/actions-elixir/setup@v1
 80 |         with:
 81 |           github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
 82 | 
 83 |       - name: Format
 84 |         run: mix format --check-formatted
 85 | 
 86 |   Test:
 87 |     name: Test (Elixir ${{ matrix.versions.elixir }} OTP ${{ matrix.versions.otp }})
 88 | 
 89 |     runs-on: ubuntu-latest
 90 | 
 91 |     env:
 92 |       MIX_ENV: test
 93 | 
 94 |     steps:
 95 |       - name: Checkout
 96 |         uses: actions/checkout@v4
 97 | 
 98 |       - name: Setup Elixir
 99 |         uses: stordco/actions-elixir/setup@v1
100 |         with:
101 |           elixir-version: ${{ matrix.versions.elixir }}
102 |           github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
103 |           otp-version: ${{ matrix.versions.otp }}
104 | 
105 |       - name: Compile
106 |         run: mix compile --warnings-as-errors
107 | 
108 |       - name: Test
109 |         run: mix test
110 | 
111 |     strategy:
112 |       fail-fast: false
113 |       matrix:
114 |         versions:
115 |           - elixir: 1.16
116 |             otp: 26
117 |           - elixir: 1.17
118 |             otp: 27
119 |           - elixir: 1.18
120 |             otp: 27
121 |           - elixir: 1.18.4-otp-27
122 |             otp: 28
123 | 
124 | 


--------------------------------------------------------------------------------
/.github/workflows/common-config.yaml:
--------------------------------------------------------------------------------
 1 | # This file is synced with beam-community/common-config. Any changes will be overwritten.
 2 | 
 3 | name: Common Config
 4 | 
 5 | on:
 6 |   push:
 7 |     branches:
 8 |       - main
 9 |     paths:
10 |       - .github/workflows/common-config.yaml
11 |   repository_dispatch:
12 |     types:
13 |       - common-config
14 |   schedule:
15 |     - cron: "8 12 8 * *"
16 |   workflow_dispatch: {}
17 | 
18 | concurrency:
19 |   group: Common Config
20 | 
21 | jobs:
22 |   Sync:
23 |     runs-on: ubuntu-latest
24 | 
25 |     steps:
26 |       - name: Checkout
27 |         uses: actions/checkout@v4
28 |         with:
29 |           token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
30 |           persist-credentials: true
31 | 
32 |       - name: Setup Node
33 |         uses: actions/setup-node@v4
34 |         with:
35 |           node-version: 20
36 | 
37 |       - name: Setup Elixir
38 |         uses: stordco/actions-elixir/setup@v1
39 |         with:
40 |           github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
41 |           elixir-version: "1.16"
42 |           otp-version: "26.0"
43 | 
44 |       - name: Sync
45 |         uses: stordco/actions-sync@v1
46 |         with:
47 |           commit-message: "chore: sync files with beam-community/common-config"
48 |           pr-enabled: true
49 |           pr-labels: common-config
50 |           pr-title: "chore: sync files with beam-community/common-config"
51 |           pr-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
52 |           sync-auth: doomspork:${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
53 |           sync-branch: latest
54 |           sync-repository: github.com/beam-community/common-config.git
55 | 


--------------------------------------------------------------------------------
/.github/workflows/pr.yaml:
--------------------------------------------------------------------------------
 1 | # This file is synced with beam-community/common-config. Any changes will be overwritten.
 2 | 
 3 | name: PR
 4 | 
 5 | on:
 6 |   merge_group:
 7 |   pull_request:
 8 |     types:
 9 |       - edited
10 |       - opened
11 |       - reopened
12 |       - synchronize
13 | 
14 | jobs:
15 |   Title:
16 |     permissions:
17 |       pull-requests: read
18 | 
19 |     if: ${{ github.event_name == 'pull_request' }}
20 |     name: Check Title
21 |     runs-on: ubuntu-latest
22 | 
23 |     steps:
24 |       - name: Check
25 |         uses: stordco/actions-pr-title@v1.0.0
26 |         with:
27 |           regex: '^(refactor!|feat!|fix!|refactor|fix|feat|chore)(\(\w+\))?:\s(\[#\d{1,5}\])?.*$'
28 |           hint: |
29 |             Your PR title does not match the Conventional Commits convention. Please rename your PR to match one of the following formats:
30 | 
31 |             fix: [#123] some title of the PR
32 |             fix(scope): [#123] some title of the PR
33 |             feat: [#1234] some title of the PR
34 |             chore: update some action
35 | 
36 |             Note: Adding ! (i.e. `feat!:`) represents a breaking change and will result in a SemVer major release.
37 | 
38 |             Please use one of the following types:
39 | 
40 |             - **feat:** A new feature, resulting in a MINOR version bump.
41 |             - **fix:** A bug fix, resulting in a PATCH version bump.
42 |             - **refactor:** A code change that neither fixes a bug nor adds a feature.
43 |             - **chore:** Changes unrelated to the release code, resulting in no version bump.
44 |             - **revert:** Reverts a previous commit.
45 | 
46 |             See https://www.conventionalcommits.org/en/v1.0.0/ for more information.
47 | 


--------------------------------------------------------------------------------
/.github/workflows/production.yaml:
--------------------------------------------------------------------------------
 1 | # This file is synced with beam-community/common-config. Any changes will be overwritten.
 2 | 
 3 | name: Production
 4 | 
 5 | on:
 6 |   release:
 7 |     types:
 8 |       - released
 9 |       - prereleased
10 |   workflow_dispatch:
11 | 
12 | concurrency:
13 |   group: Production
14 | 
15 | jobs:
16 |   Hex:
17 |     runs-on: ubuntu-latest
18 | 
19 |     steps:
20 |       - name: Checkout
21 |         uses: actions/checkout@v4
22 | 
23 |       - name: Setup Elixir
24 |         uses: stordco/actions-elixir/setup@v1
25 |         with:
26 |           github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
27 | 
28 |       - name: Compile
29 |         run: mix compile --docs
30 | 
31 |       - name: Publish
32 |         run: mix hex.publish --yes
33 |         env:
34 |           HEX_API_KEY: ${{ secrets.HEX_API_KEY }}
35 | 


--------------------------------------------------------------------------------
/.github/workflows/publish-docs.yaml:
--------------------------------------------------------------------------------
 1 | # This file is synced with beam-community/common-config. Any changes will be overwritten.
 2 | 
 3 | name: Publish Docs
 4 | 
 5 | on:
 6 |   workflow_dispatch:
 7 | 
 8 | concurrency:
 9 |   group: hex-publish-docs
10 |   cancel-in-progress: true
11 | 
12 | jobs:
13 |   Hex:
14 |     runs-on: ubuntu-latest
15 |     if: github.ref == 'refs/heads/main'
16 |     steps:
17 |       - name: Checkout
18 |         uses: actions/checkout@v4
19 | 
20 |       - name: Setup Elixir
21 |         uses: stordco/actions-elixir/setup@v1
22 |         with:
23 |           github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
24 | 
25 |       - name: Publish Docs
26 |         run: mix hex.publish docs --yes
27 |         env:
28 |           HEX_API_KEY: ${{ secrets.HEX_API_KEY }}
29 | 


--------------------------------------------------------------------------------
/.github/workflows/release.yaml:
--------------------------------------------------------------------------------
 1 | # This file is synced with beam-community/common-config. Any changes will be overwritten.
 2 | 
 3 | name: Release
 4 | 
 5 | on:
 6 |   push:
 7 |     branches:
 8 |       - main
 9 | 
10 | jobs:
11 |   Please:
12 |     runs-on: ubuntu-latest
13 | 
14 |     steps:
15 |       - id: release
16 |         name: Release
17 |         uses: googleapis/release-please-action@v4
18 |         with:
19 |           config-file: .github/release-please-config.json
20 |           manifest-file: .github/release-please-manifest.json
21 |           release-type: elixir
22 |           token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
23 | 


--------------------------------------------------------------------------------
/.github/workflows/stale.yaml:
--------------------------------------------------------------------------------
 1 | name: "Close stale issues and PRs"
 2 | 
 3 | on:
 4 |   workflow_dispatch:
 5 |   schedule:
 6 |     - cron: "30 1 * * *"
 7 | 
 8 | permissions:
 9 |   contents: write
10 |   issues: write
11 |   pull-requests: write
12 | 
13 | jobs:
14 |   stale:
15 |     runs-on: ubuntu-latest
16 |     steps:
17 |       - uses: actions/stale@v9
18 |         with:
19 |           days-before-issue-stale: 30
20 |           days-before-issue-close: 15
21 |           days-before-pr-stale: 60
22 |           days-before-pr-close: 60
23 | 
24 |           stale-issue-label: "stale:discard"
25 |           exempt-issue-labels: "stale:keep"
26 |           stale-issue-message: >
27 |             This issue has been automatically marked as "stale:discard". We are sorry that we haven't been able to
28 |             prioritize it yet.
29 | 
30 |             If this issue still relevant, please leave any comment if you have any new additional information that
31 |             helps to solve this issue. We encourage you to create a pull request, if you can. We are happy to help you
32 |             with that.
33 | 
34 |           close-issue-message: >
35 |             Closing this issue after a prolonged period of inactivity. If this issue is still relevant, feel free to
36 |             re-open the issue. Thank you!
37 | 
38 |           stale-pr-label: "stale:discard"
39 |           exempt-pr-labels: "stale:keep"
40 |           stale-pr-message: >
41 |             This pull request has been automatically marked as "stale:discard". **If this pull request is still
42 |             relevant, please leave any comment** (for example, "bump"), and we'll keep it open. We are sorry that we
43 |             haven't been able to prioritize reviewing it yet.
44 |             Your contribution is very much appreciated!.
45 |           close-pr-message: >
46 |             Closing this pull request after a prolonged period of inactivity. If this issue is still relevant, please
47 |             ask for this pull request to be reopened. Thank you!
48 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Created by https://www.gitignore.io/api/vim,osx,elixir
 2 | 
 3 | ### Vim ###
 4 | # swap
 5 | [._]*.s[a-w][a-z]
 6 | [._]s[a-w][a-z]
 7 | # session
 8 | Session.vim
 9 | # temporary
10 | .netrwhist
11 | *~
12 | # auto-generated tag files
13 | tags
14 | 
15 | 
16 | ### OSX ###
17 | *.DS_Store
18 | .AppleDouble
19 | .LSOverride
20 | 
21 | # Icon must end with two \r
22 | Icon
23 | # Thumbnails
24 | ._*
25 | # Files that might appear in the root of a volume
26 | .DocumentRevisions-V100
27 | .fseventsd
28 | .Spotlight-V100
29 | .TemporaryItems
30 | .Trashes
31 | .VolumeIcon.icns
32 | .com.apple.timemachine.donotpresent
33 | # Directories potentially created on remote AFP share
34 | .AppleDB
35 | .AppleDesktop
36 | Network Trash Folder
37 | Temporary Items
38 | .apdisk
39 | 
40 | 
41 | ### Elixir ###
42 | /_build/
43 | /cover/
44 | /deps/
45 | /doc/
46 | /.fetch
47 | erl_crash.dump
48 | *.ez
49 | ua_parser-*.tar
50 | /tmp/
51 | 
52 | # The directory NPM downloads your dependencies sources to.
53 | /example/assets/node_modules/
54 | 


--------------------------------------------------------------------------------
/.tool-versions:
--------------------------------------------------------------------------------
1 | elixir 1.18
2 | erlang 27.2
3 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | 
 3 | ## [1.9.2](https://github.com/beam-community/ua_parser/compare/v1.9.1...v1.9.2) (2024-12-30)
 4 | 
 5 | 
 6 | ### Miscellaneous Chores
 7 | 
 8 | * release 1.9.2 ([8cc2d02](https://github.com/beam-community/ua_parser/commit/8cc2d022940480cf3985feda81a2d6b9fff67974))
 9 | 
10 | ## [1.9.1](https://github.com/beam-community/ua_parser/compare/v1.9.0...v1.9.1) (2024-12-21)
11 | 
12 | 
13 | ### Bug Fixes
14 | 
15 | * resolve warning in Elixir 1.18 ([#93](https://github.com/beam-community/ua_parser/issues/93)) ([d674d47](https://github.com/beam-community/ua_parser/commit/d674d47dccd7f4b0c306c7a379cd8aece2ddf345))
16 | 
17 | ## [1.9.0](https://github.com/beam-community/ua_parser/compare/v1.8.0...v1.9.0) (2024-06-25)
18 | 
19 | 
20 | ### Features
21 | 
22 | * Add common config script ([#63](https://github.com/beam-community/ua_parser/issues/63)) ([0d23e82](https://github.com/beam-community/ua_parser/commit/0d23e82ecb346c7d6af8f4f2fc15291b10e85876))
23 | * Update pattern file ([2b9e308](https://github.com/beam-community/ua_parser/commit/2b9e30866eca052641f205c904743f31d971dae9))
24 | 
25 | 
26 | ### Bug Fixes
27 | 
28 | * Update common-config action names ([850a6fb](https://github.com/beam-community/ua_parser/commit/850a6fb6319f36b2e4a01ccf030738cc7d68110e))
29 | 
30 | 
31 | ### Miscellaneous
32 | 
33 | * Add .tool-versions file ([527f09b](https://github.com/beam-community/ua_parser/commit/527f09b1b6cef8f314efc2c51a68056f4360f55e))
34 | * Add release manifest ([a6114d2](https://github.com/beam-community/ua_parser/commit/a6114d24d0f90610f5771130de93e421d53d5ef6))
35 | * Run formatter ([6f065f0](https://github.com/beam-community/ua_parser/commit/6f065f03145b5dbdd0d414d034f24a0f29ab2d26))
36 | * Sync files with beam-community/common-config ([#67](https://github.com/beam-community/ua_parser/issues/67)) ([866471e](https://github.com/beam-community/ua_parser/commit/866471ede1312e94510a7a12ad2c7299922877e4))
37 | * Sync files with beam-community/common-config ([#72](https://github.com/beam-community/ua_parser/issues/72)) ([3efa6f5](https://github.com/beam-community/ua_parser/commit/3efa6f5aa57930b518a18202378b601c9adf7c92))
38 | * Sync files with beam-community/common-config ([#75](https://github.com/beam-community/ua_parser/issues/75)) ([8f55e1c](https://github.com/beam-community/ua_parser/commit/8f55e1c7f10d210eb9d3d701173b2476d8b1da45))
39 | * Update README badge ([#70](https://github.com/beam-community/ua_parser/issues/70)) ([4fbd079](https://github.com/beam-community/ua_parser/commit/4fbd079f28d30cec0ed1755cefdedb8f553b27c0))
40 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | # MIT License
 2 | 
 3 | Copyright (c) 2024 BEAM Community
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining
 6 | a copy of this software and associated documentation files (the
 7 | "Software"), to deal in the Software without restriction, including
 8 | without limitation the rights to use, copy, modify, merge, publish,
 9 | distribute, sublicense, and/or sell copies of the Software, and to
10 | permit persons to whom the Software is furnished to do so, subject to
11 | the following conditions:
12 | 
13 | The above copyright notice and this permission notice shall be
14 | included in all copies or substantial portions of the Software.
15 | 
16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # UAParser
  2 | 
  3 | [![Continuous Integration](https://github.com/beam-community/ua_parser/actions/workflows/ci.yaml/badge.svg)](https://github.com/beam-community/ua_parser/actions/workflows/ci.yaml)
  4 | [![Module Version](https://img.shields.io/hexpm/v/ua_parser.svg)](https://hex.pm/packages/ua_parser)
  5 | [![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/ua_parser/)
  6 | [![Total Download](https://img.shields.io/hexpm/dt/ua_parser.svg)](https://hex.pm/packages/ua_parser)
  7 | [![License](https://img.shields.io/hexpm/l/ua_parser.svg)](https://github.com/beam-community/ua_parser/blob/master/LICENSE)
  8 | [![Last Updated](https://img.shields.io/github/last-commit/beam-community/ua_parser.svg)](https://github.com/beam-community/ua_parser/commits/master)
  9 | 
 10 | A simple, fast user-agent parsing library based on [BrowserScope's](https://ua-profiler.appspot.com/) UA database with a good default dictionary.
 11 | 
 12 | ## Installation
 13 | 
 14 | Add `:ua_parser` to your `mix.exs` dependencies:
 15 | 
 16 | ```elixir
 17 | def deps do
 18 |   [
 19 |     {:ua_parser, "~> 1.8"}
 20 |   ]
 21 | end
 22 | ```
 23 | 
 24 | ## Usage
 25 | 
 26 | ```elixir
 27 | iex> ua = UAParser.parse("Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_7; en-us) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Safari/530.17 Skyfire/2.0")
 28 | %UAParser.UA{
 29 |   device: %UAParser.Device{family: nil},
 30 |   family: "Skyfire",
 31 |   os: %UAParser.OperatingSystem{
 32 |     family: "Mac OS X",
 33 |     version: %UAParser.Version{major: "10", minor: "5", patch: "7", patch_minor: nil}
 34 |   },
 35 |   version: %UAParser.Version{major: "2", minor: "0", patch: nil, patch_minor: nil}
 36 | }
 37 | iex> to_string(ua)
 38 | "Skyfire 2.0"
 39 | iex> to_string(ua.os)
 40 | "Mac OS X 10.5.7"
 41 | iex> to_string(ua.device)
 42 | "Other"
 43 | ```
 44 | 
 45 | Retrieving and parsing a user-agent string from Plug:
 46 | 
 47 | ```elixir
 48 | ua =
 49 |   conn
 50 |   |> Plug.Conn.get_req_header("user-agent")
 51 |   |> List.first()
 52 |   |> UAParser.parse()
 53 | ```
 54 | 
 55 | ## Example
 56 | 
 57 | There is an example Phoenix application with a simple endpoint/route to retrieve the user agent header.
 58 | To run it, simply cd into the `example` directory, and run the following:
 59 | 
 60 | ### Phoenix
 61 | 
 62 | ```shell
 63 | $ mix do deps.get, compile
 64 | $ npm i && brunch build
 65 | # change the configuration to match your own postgres username/password
 66 | $ mix do ecto.create, ecto.migrate
 67 | $ iex -S mix phoenix.server
 68 | # visit localhost:4000/user_agent
 69 | ```
 70 | 
 71 | ### Plug
 72 | 
 73 | It can also be used as a simple plug:
 74 | 
 75 | ```shell
 76 | mix new ua_plug
 77 | cd ua_plug
 78 | ```
 79 | 
 80 | And now set up `mix.exs`:
 81 | 
 82 | ```elixir
 83 | # ...
 84 | defp deps do
 85 |   [
 86 |    {:cowboy, "~> 1.0.0"},
 87 |    {:plug, "~> 1.0"},
 88 |    {:ua_parser, git: "https://github.com/beam-community/ua_parser.git",
 89 |                 branch: "master"},
 90 |   ]
 91 | end
 92 | # ...
 93 | ```
 94 | 
 95 | And we get our deps and compile:
 96 | 
 97 | ```shell
 98 | mix do deps.get, compile
 99 | ```
100 | 
101 | And now we can make our plug:
102 | 
103 | ```elixir
104 | defmodule UAPlug do
105 |   import Plug.Conn
106 | 
107 |   def init(options), do: options
108 | 
109 |   def call(conn, _opts) do
110 |     ua =
111 |       conn
112 |          |> Plug.Conn.get_req_header("user-agent")
113 |          |> List.first()
114 |          |> UAParser.parse()
115 |     send_resp(200, ua)
116 |   end
117 | end
118 | ```
119 | 
120 | From here we can pipe requests through it in other applications or use it on its own as we please.
121 | 
122 | ## Copyright and License
123 | 
124 | Copyright (c) 2016 Sean Callan
125 | 
126 | Licensed under the Apache License, Version 2.0 (the "License");
127 | you may not use this file except in compliance with the License.
128 | You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
129 | 
130 | Unless required by applicable law or agreed to in writing, software
131 | distributed under the License is distributed on an "AS IS" BASIS,
132 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
133 | See the License for the specific language governing permissions and
134 | limitations under the License.
135 | 


--------------------------------------------------------------------------------
/example/.gitignore:
--------------------------------------------------------------------------------
 1 | # The directory Mix will write compiled artifacts to.
 2 | /_build/
 3 | 
 4 | # If you run "mix test --cover", coverage assets end up here.
 5 | /cover/
 6 | 
 7 | # The directory Mix downloads your dependencies sources to.
 8 | /deps/
 9 | 
10 | # Where 3rd-party dependencies like ExDoc output generated docs.
11 | /doc/
12 | 
13 | # Ignore .fetch files in case you like to edit your project deps locally.
14 | /.fetch
15 | 
16 | # If the VM crashes, it generates a dump, let's ignore it too.
17 | erl_crash.dump
18 | 
19 | # Also ignore archive artifacts (built via "mix archive.build").
20 | *.ez
21 | 
22 | # Ignore package tarball (built via "mix hex.build").
23 | example-*.tar
24 | 
25 | # If NPM crashes, it generates a log, let's ignore it too.
26 | npm-debug.log
27 | 
28 | # The directory NPM downloads your dependencies sources to.
29 | /assets/node_modules/
30 | 
31 | # Since we are building assets from assets/,
32 | # we ignore priv/static. You may want to comment
33 | # this depending on your deployment strategy.
34 | /priv/static/
35 | 


--------------------------------------------------------------------------------
/example/README.md:
--------------------------------------------------------------------------------
 1 | # Example
 2 | 
 3 | To start your Phoenix app:
 4 | 
 5 |   * Install dependencies with `mix deps.get`
 6 |   * Create and migrate your database with `mix ecto.create && mix ecto.migrate`
 7 |   * Install Node.js dependencies with `npm install`
 8 |   * Start Phoenix endpoint with `mix phoenix.server`
 9 | 
10 | Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
11 | 
12 | Ready to run in production? Please [check our deployment guides](http://www.phoenixframework.org/docs/deployment).
13 | 
14 | ## Learn more
15 | 
16 |   * Official website: http://www.phoenixframework.org/
17 |   * Guides: http://phoenixframework.org/docs/overview
18 |   * Docs: https://hexdocs.pm/phoenix
19 |   * Mailing list: http://groups.google.com/group/phoenix-talk
20 |   * Source: https://github.com/phoenixframework/phoenix
21 | 


--------------------------------------------------------------------------------
/example/assets/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 |     "presets": [
3 |         "@babel/preset-env"
4 |     ]
5 | }
6 | 


--------------------------------------------------------------------------------
/example/assets/css/app.css:
--------------------------------------------------------------------------------
1 | /* This file is for your main application css. */
2 | 
3 | @import "./phoenix.css";
4 | 


--------------------------------------------------------------------------------
/example/assets/css/phoenix.css:
--------------------------------------------------------------------------------
  1 | /* Includes some default style for the starter application.
  2 |  * This can be safely deleted to start fresh.
  3 |  */
  4 | 
  5 | /* Milligram v1.3.0 https://milligram.github.io
  6 |  * Copyright (c) 2017 CJ Patoilo Licensed under the MIT license
  7 |  */
  8 | 
  9 | *,*:after,*:before{box-sizing:inherit}html{box-sizing:border-box;font-size:62.5%}body{color:#000000;font-family:'Helvetica', 'Arial', sans-serif;font-size:1.6em;font-weight:300;line-height:1.6}blockquote{border-left:0.3rem solid #d1d1d1;margin-left:0;margin-right:0;padding:1rem 1.5rem}blockquote *:last-child{margin-bottom:0}.button,button,input[type='button'],input[type='reset'],input[type='submit']{background-color:#0069d9;border:0.1rem solid #0069d9;border-radius:.4rem;color:#fff;cursor:pointer;display:inline-block;font-size:1.1rem;font-weight:700;height:3.8rem;letter-spacing:.1rem;line-height:3.8rem;padding:0 3.0rem;text-align:center;text-decoration:none;text-transform:uppercase;white-space:nowrap}.button:focus,.button:hover,button:focus,button:hover,input[type='button']:focus,input[type='button']:hover,input[type='reset']:focus,input[type='reset']:hover,input[type='submit']:focus,input[type='submit']:hover{background-color:#606c76;border-color:#606c76;color:#fff;outline:0}.button[disabled],button[disabled],input[type='button'][disabled],input[type='reset'][disabled],input[type='submit'][disabled]{cursor:default;opacity:.5}.button[disabled]:focus,.button[disabled]:hover,button[disabled]:focus,button[disabled]:hover,input[type='button'][disabled]:focus,input[type='button'][disabled]:hover,input[type='reset'][disabled]:focus,input[type='reset'][disabled]:hover,input[type='submit'][disabled]:focus,input[type='submit'][disabled]:hover{background-color:#0069d9;border-color:#0069d9}.button.button-outline,button.button-outline,input[type='button'].button-outline,input[type='reset'].button-outline,input[type='submit'].button-outline{background-color:transparent;color:#0069d9}.button.button-outline:focus,.button.button-outline:hover,button.button-outline:focus,button.button-outline:hover,input[type='button'].button-outline:focus,input[type='button'].button-outline:hover,input[type='reset'].button-outline:focus,input[type='reset'].button-outline:hover,input[type='submit'].button-outline:focus,input[type='submit'].button-outline:hover{background-color:transparent;border-color:#606c76;color:#606c76}.button.button-outline[disabled]:focus,.button.button-outline[disabled]:hover,button.button-outline[disabled]:focus,button.button-outline[disabled]:hover,input[type='button'].button-outline[disabled]:focus,input[type='button'].button-outline[disabled]:hover,input[type='reset'].button-outline[disabled]:focus,input[type='reset'].button-outline[disabled]:hover,input[type='submit'].button-outline[disabled]:focus,input[type='submit'].button-outline[disabled]:hover{border-color:inherit;color:#0069d9}.button.button-clear,button.button-clear,input[type='button'].button-clear,input[type='reset'].button-clear,input[type='submit'].button-clear{background-color:transparent;border-color:transparent;color:#0069d9}.button.button-clear:focus,.button.button-clear:hover,button.button-clear:focus,button.button-clear:hover,input[type='button'].button-clear:focus,input[type='button'].button-clear:hover,input[type='reset'].button-clear:focus,input[type='reset'].button-clear:hover,input[type='submit'].button-clear:focus,input[type='submit'].button-clear:hover{background-color:transparent;border-color:transparent;color:#606c76}.button.button-clear[disabled]:focus,.button.button-clear[disabled]:hover,button.button-clear[disabled]:focus,button.button-clear[disabled]:hover,input[type='button'].button-clear[disabled]:focus,input[type='button'].button-clear[disabled]:hover,input[type='reset'].button-clear[disabled]:focus,input[type='reset'].button-clear[disabled]:hover,input[type='submit'].button-clear[disabled]:focus,input[type='submit'].button-clear[disabled]:hover{color:#0069d9}code{background:#f4f5f6;border-radius:.4rem;font-size:86%;margin:0 .2rem;padding:.2rem .5rem;white-space:nowrap}pre{background:#f4f5f6;border-left:0.3rem solid #0069d9;overflow-y:hidden}pre>code{border-radius:0;display:block;padding:1rem 1.5rem;white-space:pre}hr{border:0;border-top:0.1rem solid #f4f5f6;margin:3.0rem 0}input[type='email'],input[type='number'],input[type='password'],input[type='search'],input[type='tel'],input[type='text'],input[type='url'],textarea,select{-webkit-appearance:none;-moz-appearance:none;appearance:none;background-color:transparent;border:0.1rem solid #d1d1d1;border-radius:.4rem;box-shadow:none;box-sizing:inherit;height:3.8rem;padding:.6rem 1.0rem;width:100%}input[type='email']:focus,input[type='number']:focus,input[type='password']:focus,input[type='search']:focus,input[type='tel']:focus,input[type='text']:focus,input[type='url']:focus,textarea:focus,select:focus{border-color:#0069d9;outline:0}select{background:url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" height="14" viewBox="0 0 29 14" width="29"><path fill="%23d1d1d1" d="M9.37727 3.625l5.08154 6.93523L19.54036 3.625"/></svg>') center right no-repeat;padding-right:3.0rem}select:focus{background-image:url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" height="14" viewBox="0 0 29 14" width="29"><path fill="%230069d9" d="M9.37727 3.625l5.08154 6.93523L19.54036 3.625"/></svg>')}textarea{min-height:6.5rem}label,legend{display:block;font-size:1.6rem;font-weight:700;margin-bottom:.5rem}fieldset{border-width:0;padding:0}input[type='checkbox'],input[type='radio']{display:inline}.label-inline{display:inline-block;font-weight:normal;margin-left:.5rem}.row{display:flex;flex-direction:column;padding:0;width:100%}.row.row-no-padding{padding:0}.row.row-no-padding>.column{padding:0}.row.row-wrap{flex-wrap:wrap}.row.row-top{align-items:flex-start}.row.row-bottom{align-items:flex-end}.row.row-center{align-items:center}.row.row-stretch{align-items:stretch}.row.row-baseline{align-items:baseline}.row .column{display:block;flex:1 1 auto;margin-left:0;max-width:100%;width:100%}.row .column.column-offset-10{margin-left:10%}.row .column.column-offset-20{margin-left:20%}.row .column.column-offset-25{margin-left:25%}.row .column.column-offset-33,.row .column.column-offset-34{margin-left:33.3333%}.row .column.column-offset-50{margin-left:50%}.row .column.column-offset-66,.row .column.column-offset-67{margin-left:66.6666%}.row .column.column-offset-75{margin-left:75%}.row .column.column-offset-80{margin-left:80%}.row .column.column-offset-90{margin-left:90%}.row .column.column-10{flex:0 0 10%;max-width:10%}.row .column.column-20{flex:0 0 20%;max-width:20%}.row .column.column-25{flex:0 0 25%;max-width:25%}.row .column.column-33,.row .column.column-34{flex:0 0 33.3333%;max-width:33.3333%}.row .column.column-40{flex:0 0 40%;max-width:40%}.row .column.column-50{flex:0 0 50%;max-width:50%}.row .column.column-60{flex:0 0 60%;max-width:60%}.row .column.column-66,.row .column.column-67{flex:0 0 66.6666%;max-width:66.6666%}.row .column.column-75{flex:0 0 75%;max-width:75%}.row .column.column-80{flex:0 0 80%;max-width:80%}.row .column.column-90{flex:0 0 90%;max-width:90%}.row .column .column-top{align-self:flex-start}.row .column .column-bottom{align-self:flex-end}.row .column .column-center{-ms-grid-row-align:center;align-self:center}@media (min-width: 40rem){.row{flex-direction:row;margin-left:-1.0rem;width:calc(100% + 2.0rem)}.row .column{margin-bottom:inherit;padding:0 1.0rem}}a{color:#0069d9;text-decoration:none}a:focus,a:hover{color:#606c76}dl,ol,ul{list-style:none;margin-top:0;padding-left:0}dl dl,dl ol,dl ul,ol dl,ol ol,ol ul,ul dl,ul ol,ul ul{font-size:90%;margin:1.5rem 0 1.5rem 3.0rem}ol{list-style:decimal inside}ul{list-style:circle inside}.button,button,dd,dt,li{margin-bottom:1.0rem}fieldset,input,select,textarea{margin-bottom:1.5rem}blockquote,dl,figure,form,ol,p,pre,table,ul{margin-bottom:2.5rem}table{border-spacing:0;width:100%}td,th{border-bottom:0.1rem solid #e1e1e1;padding:1.2rem 1.5rem;text-align:left}td:first-child,th:first-child{padding-left:0}td:last-child,th:last-child{padding-right:0}b,strong{font-weight:bold}p{margin-top:0}h1,h2,h3,h4,h5,h6{font-weight:300;letter-spacing:-.1rem;margin-bottom:2.0rem;margin-top:0}h1{font-size:4.6rem;line-height:1.2}h2{font-size:3.6rem;line-height:1.25}h3{font-size:2.8rem;line-height:1.3}h4{font-size:2.2rem;letter-spacing:-.08rem;line-height:1.35}h5{font-size:1.8rem;letter-spacing:-.05rem;line-height:1.5}h6{font-size:1.6rem;letter-spacing:0;line-height:1.4}img{max-width:100%}.clearfix:after{clear:both;content:' ';display:table}.float-left{float:left}.float-right{float:right}
 10 | 
 11 | /* General style */
 12 | h1{font-size: 3.6rem; line-height: 1.25}
 13 | h2{font-size: 2.8rem; line-height: 1.3}
 14 | h3{font-size: 2.2rem; letter-spacing: -.08rem; line-height: 1.35}
 15 | h4{font-size: 1.8rem; letter-spacing: -.05rem; line-height: 1.5}
 16 | h5{font-size: 1.6rem; letter-spacing: 0; line-height: 1.4}
 17 | h6{font-size: 1.4rem; letter-spacing: 0; line-height: 1.2}
 18 | 
 19 | .container{
 20 |   margin: 0 auto;
 21 |   max-width: 80.0rem;
 22 |   padding: 0 2.0rem;
 23 |   position: relative;
 24 |   width: 100%
 25 | }
 26 | select {
 27 |   width: auto;
 28 | }
 29 | 
 30 | /* Alerts and form errors */
 31 | .alert {
 32 |   padding: 15px;
 33 |   margin-bottom: 20px;
 34 |   border: 1px solid transparent;
 35 |   border-radius: 4px;
 36 | }
 37 | .alert-info {
 38 |   color: #31708f;
 39 |   background-color: #d9edf7;
 40 |   border-color: #bce8f1;
 41 | }
 42 | .alert-warning {
 43 |   color: #8a6d3b;
 44 |   background-color: #fcf8e3;
 45 |   border-color: #faebcc;
 46 | }
 47 | .alert-danger {
 48 |   color: #a94442;
 49 |   background-color: #f2dede;
 50 |   border-color: #ebccd1;
 51 | }
 52 | .alert p {
 53 |   margin-bottom: 0;
 54 | }
 55 | .alert:empty {
 56 |   display: none;
 57 | }
 58 | .help-block {
 59 |   color: #a94442;
 60 |   display: block;
 61 |   margin: -1rem 0 2rem;
 62 | }
 63 | 
 64 | /* Phoenix promo and logo */
 65 | .phx-hero {
 66 |   text-align: center;
 67 |   border-bottom: 1px solid #e3e3e3;
 68 |   background: #eee;
 69 |   border-radius: 6px;
 70 |   padding: 3em;
 71 |   margin-bottom: 3rem;
 72 |   font-weight: 200;
 73 |   font-size: 120%;
 74 | }
 75 | .phx-hero p {
 76 |   margin: 0;
 77 | }
 78 | .phx-logo {
 79 |   min-width: 300px;
 80 |   margin: 1rem;
 81 |   display: block;
 82 | }
 83 | .phx-logo img {
 84 |   width: auto;
 85 |   display: block;
 86 | }
 87 | 
 88 | /* Headers */
 89 | header {
 90 |   width: 100%;
 91 |   background: #fdfdfd;
 92 |   border-bottom: 1px solid #eaeaea;
 93 |   margin-bottom: 2rem;
 94 | }
 95 | header section {
 96 |   align-items: center;
 97 |   display: flex;
 98 |   flex-direction: column;
 99 |   justify-content: space-between;
100 | }
101 | header section :first-child {
102 |   order: 2;
103 | }
104 | header section :last-child {
105 |   order: 1;
106 | }
107 | header nav ul,
108 | header nav li {
109 |   margin: 0;
110 |   padding: 0;
111 |   display: block;
112 |   text-align: right;
113 |   white-space: nowrap;
114 | }
115 | header nav ul {
116 |   margin: 1rem;
117 |   margin-top: 0;
118 | }
119 | header nav a {
120 |   display: block;
121 | }
122 | 
123 | @media (min-width: 40.0rem) { /* Small devices (landscape phones, 576px and up) */
124 |   header section {
125 |     flex-direction: row;
126 |   }
127 |   header nav ul {
128 |     margin: 1rem;
129 |   }
130 |   .phx-logo {
131 |     flex-basis: 527px;
132 |     margin: 2rem 1rem;
133 |   }
134 | }
135 | 


--------------------------------------------------------------------------------
/example/assets/js/app.js:
--------------------------------------------------------------------------------
 1 | // We need to import the CSS so that webpack will load it.
 2 | // The MiniCssExtractPlugin is used to separate it out into
 3 | // its own CSS file.
 4 | import css from "../css/app.css"
 5 | 
 6 | // webpack automatically bundles all modules in your
 7 | // entry points. Those entry points can be configured
 8 | // in "webpack.config.js".
 9 | //
10 | // Import dependencies
11 | //
12 | import "phoenix_html"
13 | 
14 | // Import local files
15 | //
16 | // Local files can be imported directly using relative paths, for example:
17 | // import socket from "./socket"
18 | 


--------------------------------------------------------------------------------
/example/assets/js/socket.js:
--------------------------------------------------------------------------------
 1 | // NOTE: The contents of this file will only be executed if
 2 | // you uncomment its entry in "assets/js/app.js".
 3 | 
 4 | // To use Phoenix channels, the first step is to import Socket,
 5 | // and connect at the socket path in "lib/web/endpoint.ex".
 6 | //
 7 | // Pass the token on params as below. Or remove it
 8 | // from the params if you are not using authentication.
 9 | import {Socket} from "phoenix"
10 | 
11 | let socket = new Socket("/socket", {params: {token: window.userToken}})
12 | 
13 | // When you connect, you'll often need to authenticate the client.
14 | // For example, imagine you have an authentication plug, `MyAuth`,
15 | // which authenticates the session and assigns a `:current_user`.
16 | // If the current user exists you can assign the user's token in
17 | // the connection for use in the layout.
18 | //
19 | // In your "lib/web/router.ex":
20 | //
21 | //     pipeline :browser do
22 | //       ...
23 | //       plug MyAuth
24 | //       plug :put_user_token
25 | //     end
26 | //
27 | //     defp put_user_token(conn, _) do
28 | //       if current_user = conn.assigns[:current_user] do
29 | //         token = Phoenix.Token.sign(conn, "user socket", current_user.id)
30 | //         assign(conn, :user_token, token)
31 | //       else
32 | //         conn
33 | //       end
34 | //     end
35 | //
36 | // Now you need to pass this token to JavaScript. You can do so
37 | // inside a script tag in "lib/web/templates/layout/app.html.eex":
38 | //
39 | //     <script>window.userToken = "<%= assigns[:user_token] %>";</script>
40 | //
41 | // You will need to verify the user token in the "connect/3" function
42 | // in "lib/web/channels/user_socket.ex":
43 | //
44 | //     def connect(%{"token" => token}, socket, _connect_info) do
45 | //       # max_age: 1209600 is equivalent to two weeks in seconds
46 | //       case Phoenix.Token.verify(socket, "user socket", token, max_age: 1209600) do
47 | //         {:ok, user_id} ->
48 | //           {:ok, assign(socket, :user, user_id)}
49 | //         {:error, reason} ->
50 | //           :error
51 | //       end
52 | //     end
53 | //
54 | // Finally, connect to the socket:
55 | socket.connect()
56 | 
57 | // Now that you are connected, you can join channels with a topic:
58 | let channel = socket.channel("topic:subtopic", {})
59 | channel.join()
60 |   .receive("ok", resp => { console.log("Joined successfully", resp) })
61 |   .receive("error", resp => { console.log("Unable to join", resp) })
62 | 
63 | export default socket
64 | 


--------------------------------------------------------------------------------
/example/assets/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "repository": {},
 3 |   "license": "MIT",
 4 |   "scripts": {
 5 |     "deploy": "webpack --mode production",
 6 |     "watch": "webpack --mode development --watch"
 7 |   },
 8 |   "dependencies": {
 9 |     "phoenix": "file:../deps/phoenix",
10 |     "phoenix_html": "file:../deps/phoenix_html"
11 |   },
12 |   "devDependencies": {
13 |     "@babel/core": "^7.0.0",
14 |     "@babel/preset-env": "^7.0.0",
15 |     "babel-loader": "^8.0.0",
16 |     "copy-webpack-plugin": "^4.5.0",
17 |     "css-loader": "^2.1.1",
18 |     "mini-css-extract-plugin": "^0.4.0",
19 |     "optimize-css-assets-webpack-plugin": "^4.0.0",
20 |     "uglifyjs-webpack-plugin": "^1.2.4",
21 |     "webpack": "4.4.0",
22 |     "webpack-cli": "^2.0.10"
23 |   }
24 | }
25 | 


--------------------------------------------------------------------------------
/example/assets/static/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/beam-community/ua_parser/56ea70af1a038760a1ada4892185d78d20a47a29/example/assets/static/favicon.ico


--------------------------------------------------------------------------------
/example/assets/static/images/phoenix.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/beam-community/ua_parser/56ea70af1a038760a1ada4892185d78d20a47a29/example/assets/static/images/phoenix.png


--------------------------------------------------------------------------------
/example/assets/static/robots.txt:
--------------------------------------------------------------------------------
1 | # See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
2 | #
3 | # To ban all spiders from the entire site uncomment the next two lines:
4 | # User-agent: *
5 | # Disallow: /
6 | 


--------------------------------------------------------------------------------
/example/assets/webpack.config.js:
--------------------------------------------------------------------------------
 1 | const path = require('path');
 2 | const glob = require('glob');
 3 | const MiniCssExtractPlugin = require('mini-css-extract-plugin');
 4 | const UglifyJsPlugin = require('uglifyjs-webpack-plugin');
 5 | const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
 6 | const CopyWebpackPlugin = require('copy-webpack-plugin');
 7 | 
 8 | module.exports = (env, options) => ({
 9 |   optimization: {
10 |     minimizer: [
11 |       new UglifyJsPlugin({ cache: true, parallel: true, sourceMap: false }),
12 |       new OptimizeCSSAssetsPlugin({})
13 |     ]
14 |   },
15 |   entry: {
16 |       './js/app.js': ['./js/app.js'].concat(glob.sync('./vendor/**/*.js'))
17 |   },
18 |   output: {
19 |     filename: 'app.js',
20 |     path: path.resolve(__dirname, '../priv/static/js')
21 |   },
22 |   module: {
23 |     rules: [
24 |       {
25 |         test: /\.js$/,
26 |         exclude: /node_modules/,
27 |         use: {
28 |           loader: 'babel-loader'
29 |         }
30 |       },
31 |       {
32 |         test: /\.css$/,
33 |         use: [MiniCssExtractPlugin.loader, 'css-loader']
34 |       }
35 |     ]
36 |   },
37 |   plugins: [
38 |     new MiniCssExtractPlugin({ filename: '../css/app.css' }),
39 |     new CopyWebpackPlugin([{ from: 'static/', to: '../' }])
40 |   ]
41 | });
42 | 


--------------------------------------------------------------------------------
/example/config/config.exs:
--------------------------------------------------------------------------------
 1 | # This file is responsible for configuring your application
 2 | # and its dependencies with the aid of the Mix.Config module.
 3 | #
 4 | # This configuration file is loaded before any dependency and
 5 | # is restricted to this project.
 6 | 
 7 | # General application configuration
 8 | use Mix.Config
 9 | 
10 | # General application configuration
11 | config :example,
12 |   ecto_repos: [Example.Repo]
13 | 
14 | # Configures the endpoint
15 | config :example, ExampleWeb.Endpoint,
16 |   url: [host: "localhost"],
17 |   secret_key_base: "HmlZQvShc7xVDBnWzBxHQ2dLYOXfsW10xZDG/mXRio7Xy54uf8w9N+/X+HlhQ7oO",
18 |   render_errors: [view: ExampleWeb.ErrorView, accepts: ~w(html json)],
19 |   pubsub: [name: Example.PubSub, adapter: Phoenix.PubSub.PG2]
20 | 
21 | # Configures Elixir's Logger
22 | config :logger, :console,
23 |   format: "$time $metadata[$level] $message\n",
24 |   metadata: [:request_id]
25 | 
26 | # Use Jason for JSON parsing in Phoenix
27 | config :phoenix, :json_library, Jason
28 | 
29 | # Import environment specific config. This must remain at the bottom
30 | # of this file so it overrides the configuration defined above.
31 | import_config "#{Mix.env()}.exs"
32 | 


--------------------------------------------------------------------------------
/example/config/dev.exs:
--------------------------------------------------------------------------------
 1 | use Mix.Config
 2 | 
 3 | # Configure your database
 4 | config :example, Example.Repo,
 5 |   username: "CHANGE_ME",
 6 |   password: "CHANGE_ME",
 7 |   database: "example_dev",
 8 |   hostname: "localhost",
 9 |   show_sensitive_data_on_connection_error: true,
10 |   pool_size: 10
11 | 
12 | # For development, we disable any cache and enable
13 | # debugging and code reloading.
14 | #
15 | # The watchers configuration can be used to run external
16 | # watchers to your application. For example, we use it
17 | # with brunch.io to recompile .js and .css sources.
18 | config :example, ExampleWeb.Endpoint,
19 |   http: [port: 4000],
20 |   debug_errors: true,
21 |   code_reloader: true,
22 |   check_origin: false,
23 |   watchers: [
24 |     node: [
25 |       "node_modules/webpack/bin/webpack.js",
26 |       "--mode",
27 |       "development",
28 |       "--watch-stdin",
29 |       cd: Path.expand("../assets", __DIR__)
30 |     ]
31 |   ]
32 | 
33 | # ## SSL Support
34 | #
35 | # In order to use HTTPS in development, a self-signed
36 | # certificate can be generated by running the following
37 | # Mix task:
38 | #
39 | #     mix phx.gen.cert
40 | #
41 | # Note that this task requires Erlang/OTP 20 or later.
42 | # Run `mix help phx.gen.cert` for more information.
43 | #
44 | # The `http:` config above can be replaced with:
45 | #
46 | #     https: [
47 | #       port: 4001,
48 | #       cipher_suite: :strong,
49 | #       keyfile: "priv/cert/selfsigned_key.pem",
50 | #       certfile: "priv/cert/selfsigned.pem"
51 | #     ],
52 | #
53 | # If desired, both `http:` and `https:` keys can be
54 | # configured to run both http and https servers on
55 | # different ports.
56 | 
57 | # Watch static and templates for browser reloading.
58 | config :example, ExampleWeb.Endpoint,
59 |   live_reload: [
60 |     patterns: [
61 |       ~r"priv/static/.*(js|css|png|jpeg|jpg|gif|svg)$",
62 |       ~r"priv/gettext/.*(po)$",
63 |       ~r"lib/example_web/{live,views}/.*(ex)$",
64 |       ~r"lib/example_web/templates/.*(eex)$"
65 |     ]
66 |   ]
67 | 
68 | # Do not include metadata nor timestamps in development logs
69 | config :logger, :console, format: "[$level] $message\n"
70 | 
71 | # Set a higher stacktrace during development. Avoid configuring such
72 | # in production as building large stacktraces may be expensive.
73 | config :phoenix, :stacktrace_depth, 20
74 | 
75 | # Initialize plugs at runtime for faster development compilation
76 | config :phoenix, :plug_init_mode, :runtime
77 | 


--------------------------------------------------------------------------------
/example/config/prod.exs:
--------------------------------------------------------------------------------
 1 | use Mix.Config
 2 | 
 3 | # For production, don't forget to configure the url host
 4 | # to something meaningful, Phoenix uses this information
 5 | # when generating URLs.
 6 | #
 7 | # Note we also include the path to a cache manifest
 8 | # containing the digested version of static files. This
 9 | # manifest is generated by the `mix phx.digest` task,
10 | # which you should run after static files are built and
11 | # before starting your production server.
12 | config :example, ExampleWeb.Endpoint,
13 |   url: [host: "example.com", port: 80],
14 |   cache_static_manifest: "priv/static/cache_manifest.json"
15 | 
16 | # Do not print debug messages in production
17 | config :logger, level: :info
18 | 
19 | # ## SSL Support
20 | #
21 | # To get SSL working, you will need to add the `https` key
22 | # to the previous section and set your `:url` port to 443:
23 | #
24 | #     config :example, ExampleWeb.Endpoint,
25 | #       ...
26 | #       url: [host: "example.com", port: 443],
27 | #       https: [
28 | #         :inet6,
29 | #         port: 443,
30 | #         cipher_suite: :strong,
31 | #         keyfile: System.get_env("SOME_APP_SSL_KEY_PATH"),
32 | #         certfile: System.get_env("SOME_APP_SSL_CERT_PATH")
33 | #       ]
34 | #
35 | # The `cipher_suite` is set to `:strong` to support only the
36 | # latest and more secure SSL ciphers. This means old browsers
37 | # and clients may not be supported. You can set it to
38 | # `:compatible` for wider support.
39 | #
40 | # `:keyfile` and `:certfile` expect an absolute path to the key
41 | # and cert in disk or a relative path inside priv, for example
42 | # "priv/ssl/server.key". For all supported SSL configuration
43 | # options, see https://hexdocs.pm/plug/Plug.SSL.html#configure/1
44 | #
45 | # We also recommend setting `force_ssl` in your endpoint, ensuring
46 | # no data is ever sent via http, always redirecting to https:
47 | #
48 | #     config :example, ExampleWeb.Endpoint,
49 | #       force_ssl: [hsts: true]
50 | #
51 | # Check `Plug.SSL` for all available options in `force_ssl`.
52 | 
53 | # ## Using releases (Elixir v1.9+)
54 | #
55 | # If you are doing OTP releases, you need to instruct Phoenix
56 | # to start each relevant endpoint:
57 | #
58 | #     config :example, ExampleWeb.Endpoint, server: true
59 | #
60 | # Then you can assemble a release by calling `mix release`.
61 | # See `mix help release` for more information.
62 | 
63 | # Finally import the config/prod.secret.exs which loads secrets
64 | # and configuration from environment variables.
65 | import_config "prod.secret.exs"
66 | 


--------------------------------------------------------------------------------
/example/config/test.exs:
--------------------------------------------------------------------------------
 1 | use Mix.Config
 2 | 
 3 | # Configure your database
 4 | config :example, Example.Repo,
 5 |   username: "postgres",
 6 |   password: "postgres",
 7 |   database: "example_test",
 8 |   hostname: "localhost",
 9 |   pool: Ecto.Adapters.SQL.Sandbox
10 | 
11 | # We don't run a server during test. If one is required,
12 | # you can enable the server option below.
13 | config :example, ExampleWeb.Endpoint,
14 |   http: [port: 4002],
15 |   server: false
16 | 
17 | # Print only warnings and errors during test
18 | config :logger, level: :warn
19 | 


--------------------------------------------------------------------------------
/example/lib/example.ex:
--------------------------------------------------------------------------------
 1 | defmodule Example do
 2 |   @moduledoc """
 3 |   Example keeps the contexts that define your domain
 4 |   and business logic.
 5 | 
 6 |   Contexts are also responsible for managing your data, regardless
 7 |   if it comes from the database, an external API or others.
 8 |   """
 9 | end
10 | 


--------------------------------------------------------------------------------
/example/lib/example/application.ex:
--------------------------------------------------------------------------------
 1 | defmodule Example.Application do
 2 |   # See https://hexdocs.pm/elixir/Application.html
 3 |   # for more information on OTP Applications
 4 |   @moduledoc false
 5 | 
 6 |   use Application
 7 | 
 8 |   def start(_type, _args) do
 9 |     # List all child processes to be supervised
10 |     children = [
11 |       # Start the Ecto repository
12 |       Example.Repo,
13 |       # Start the endpoint when the application starts
14 |       ExampleWeb.Endpoint
15 |       # Starts a worker by calling: Example.Worker.start_link(arg)
16 |       # {Example.Worker, arg},
17 |     ]
18 | 
19 |     # See https://hexdocs.pm/elixir/Supervisor.html
20 |     # for other strategies and supported options
21 |     opts = [strategy: :one_for_one, name: Example.Supervisor]
22 |     Supervisor.start_link(children, opts)
23 |   end
24 | 
25 |   # Tell Phoenix to update the endpoint configuration
26 |   # whenever the application is updated.
27 |   def config_change(changed, _new, removed) do
28 |     ExampleWeb.Endpoint.config_change(changed, removed)
29 |     :ok
30 |   end
31 | end
32 | 


--------------------------------------------------------------------------------
/example/lib/example/repo.ex:
--------------------------------------------------------------------------------
1 | defmodule Example.Repo do
2 |   use Ecto.Repo,
3 |     otp_app: :example,
4 |     adapter: Ecto.Adapters.Postgres
5 | end
6 | 


--------------------------------------------------------------------------------
/example/lib/example_web.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb do
 2 |   @moduledoc """
 3 |   The entrypoint for defining your web interface, such
 4 |   as controllers, views, channels and so on.
 5 | 
 6 |   This can be used in your application as:
 7 | 
 8 |       use ExampleWeb, :controller
 9 |       use ExampleWeb, :view
10 | 
11 |   The definitions below will be executed for every view,
12 |   controller, etc, so keep them short and clean, focused
13 |   on imports, uses and aliases.
14 | 
15 |   Do NOT define functions inside the quoted expressions
16 |   below. Instead, define any helper function in modules
17 |   and import those modules here.
18 |   """
19 | 
20 |   def controller do
21 |     quote do
22 |       use Phoenix.Controller, namespace: ExampleWeb
23 | 
24 |       import Plug.Conn
25 |       import ExampleWeb.Gettext
26 |       alias ExampleWeb.Router.Helpers, as: Routes
27 |     end
28 |   end
29 | 
30 |   def view do
31 |     quote do
32 |       use Phoenix.View,
33 |         root: "lib/example_web/templates",
34 |         namespace: ExampleWeb
35 | 
36 |       # Import convenience functions from controllers
37 |       import Phoenix.Controller, only: [get_flash: 1, get_flash: 2, view_module: 1]
38 | 
39 |       # Use all HTML functionality (forms, tags, etc)
40 |       use Phoenix.HTML
41 | 
42 |       import ExampleWeb.ErrorHelpers
43 |       import ExampleWeb.Gettext
44 |       alias ExampleWeb.Router.Helpers, as: Routes
45 |     end
46 |   end
47 | 
48 |   def router do
49 |     quote do
50 |       use Phoenix.Router
51 |       import Plug.Conn
52 |       import Phoenix.Controller
53 |     end
54 |   end
55 | 
56 |   def channel do
57 |     quote do
58 |       use Phoenix.Channel
59 |       import ExampleWeb.Gettext
60 |     end
61 |   end
62 | 
63 |   @doc """
64 |   When used, dispatch to the appropriate controller/view/etc.
65 |   """
66 |   defmacro __using__(which) when is_atom(which) do
67 |     apply(__MODULE__, which, [])
68 |   end
69 | end
70 | 


--------------------------------------------------------------------------------
/example/lib/example_web/channels/user_socket.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.UserSocket do
 2 |   use Phoenix.Socket
 3 | 
 4 |   ## Channels
 5 |   # channel "room:*", ExampleWeb.RoomChannel
 6 | 
 7 |   # Socket params are passed from the client and can
 8 |   # be used to verify and authenticate a user. After
 9 |   # verification, you can put default assigns into
10 |   # the socket that will be set for all channels, ie
11 |   #
12 |   #     {:ok, assign(socket, :user_id, verified_user_id)}
13 |   #
14 |   # To deny connection, return `:error`.
15 |   #
16 |   # See `Phoenix.Token` documentation for examples in
17 |   # performing token verification on connect.
18 |   def connect(_params, socket, _connect_info) do
19 |     {:ok, socket}
20 |   end
21 | 
22 |   # Socket id's are topics that allow you to identify all sockets for a given user:
23 |   #
24 |   #     def id(socket), do: "user_socket:#{socket.assigns.user_id}"
25 |   #
26 |   # Would allow you to broadcast a "disconnect" event and terminate
27 |   # all active sockets and channels for a given user:
28 |   #
29 |   #     ExampleWeb.Endpoint.broadcast("user_socket:#{user.id}", "disconnect", %{})
30 |   #
31 |   # Returning `nil` makes this socket anonymous.
32 |   def id(_socket), do: nil
33 | end
34 | 


--------------------------------------------------------------------------------
/example/lib/example_web/controllers/foo_controller.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.FooController do
 2 |   use ExampleWeb, :controller
 3 | 
 4 |   def user_agent(conn, _params) do
 5 |     ua =
 6 |       conn
 7 |       |> Plug.Conn.get_req_header("user-agent")
 8 |       |> List.first()
 9 |       |> UAParser.parse()
10 | 
11 |     text(conn, ua)
12 |   end
13 | end
14 | 


--------------------------------------------------------------------------------
/example/lib/example_web/controllers/page_controller.ex:
--------------------------------------------------------------------------------
1 | defmodule ExampleWeb.PageController do
2 |   use ExampleWeb, :controller
3 | 
4 |   def index(conn, _params) do
5 |     render(conn, "index.html")
6 |   end
7 | end
8 | 


--------------------------------------------------------------------------------
/example/lib/example_web/endpoint.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.Endpoint do
 2 |   use Phoenix.Endpoint, otp_app: :example
 3 | 
 4 |   socket("/socket", ExampleWeb.UserSocket,
 5 |     websocket: true,
 6 |     longpoll: false
 7 |   )
 8 | 
 9 |   # Serve at "/" the static files from "priv/static" directory.
10 |   #
11 |   # You should set gzip to true if you are running phoenix.digest
12 |   # when deploying your static files in production.
13 |   plug(Plug.Static,
14 |     at: "/",
15 |     from: :example,
16 |     gzip: false,
17 |     only: ~w(css fonts images js favicon.ico robots.txt)
18 |   )
19 | 
20 |   # Code reloading can be explicitly enabled under the
21 |   # :code_reloader configuration of your endpoint.
22 |   if code_reloading? do
23 |     socket("/phoenix/live_reload/socket", Phoenix.LiveReloader.Socket)
24 |     plug(Phoenix.LiveReloader)
25 |     plug(Phoenix.CodeReloader)
26 |   end
27 | 
28 |   plug(Plug.RequestId)
29 |   plug(Plug.Logger)
30 | 
31 |   plug(Plug.Parsers,
32 |     parsers: [:urlencoded, :multipart, :json],
33 |     pass: ["*/*"],
34 |     json_decoder: Phoenix.json_library()
35 |   )
36 | 
37 |   plug(Plug.MethodOverride)
38 |   plug(Plug.Head)
39 | 
40 |   # The session will be stored in the cookie and signed,
41 |   # this means its contents can be read but not tampered with.
42 |   # Set :encryption_salt if you would also like to encrypt it.
43 |   plug(Plug.Session,
44 |     store: :cookie,
45 |     key: "_example_key",
46 |     signing_salt: "GZz0z5PI"
47 |   )
48 | 
49 |   plug(ExampleWeb.Router)
50 | end
51 | 


--------------------------------------------------------------------------------
/example/lib/example_web/gettext.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.Gettext do
 2 |   @moduledoc """
 3 |   A module providing Internationalization with a gettext-based API.
 4 | 
 5 |   By using [Gettext](https://hexdocs.pm/gettext),
 6 |   your module gains a set of macros for translations, for example:
 7 | 
 8 |       import ExampleWeb.Gettext
 9 | 
10 |       # Simple translation
11 |       gettext("Here is the string to translate")
12 | 
13 |       # Plural translation
14 |       ngettext("Here is the string to translate",
15 |                "Here are the strings to translate",
16 |                3)
17 | 
18 |       # Domain-based translation
19 |       dgettext("errors", "Here is the error message to translate")
20 | 
21 |   See the [Gettext Docs](https://hexdocs.pm/gettext) for detailed usage.
22 |   """
23 |   use Gettext, otp_app: :example
24 | end
25 | 


--------------------------------------------------------------------------------
/example/lib/example_web/router.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.Router do
 2 |   use ExampleWeb, :router
 3 | 
 4 |   pipeline :browser do
 5 |     plug(:accepts, ["html"])
 6 |     plug(:fetch_session)
 7 |     plug(:fetch_flash)
 8 |     plug(:protect_from_forgery)
 9 |     plug(:put_secure_browser_headers)
10 |   end
11 | 
12 |   pipeline :api do
13 |     plug(:accepts, ["json"])
14 |   end
15 | 
16 |   scope "/", ExampleWeb do
17 |     # Use the default browser stack
18 |     pipe_through(:browser)
19 |     get("/user_agent", FooController, :user_agent)
20 | 
21 |     get("/", PageController, :index)
22 |   end
23 | end
24 | 


--------------------------------------------------------------------------------
/example/lib/example_web/templates/foo/edit.html.eex:
--------------------------------------------------------------------------------
1 | <h2>Edit foo</h2>
2 | 
3 | <%= render "form.html", changeset: @changeset,
4 |                         action: foo_path(@conn, :update, @foo) %>
5 | 
6 | <%= link "Back", to: foo_path(@conn, :index) %>
7 | 


--------------------------------------------------------------------------------
/example/lib/example_web/templates/foo/form.html.eex:
--------------------------------------------------------------------------------
 1 | <%= form_for @changeset, @action, fn f -> %>
 2 |   <%= if @changeset.action do %>
 3 |     <div class="alert alert-danger">
 4 |       <p>Oops, something went wrong! Please check the errors below.</p>
 5 |     </div>
 6 |   <% end %>
 7 | 
 8 |   <div class="form-group">
 9 |     <%= label f, :bar, class: "control-label" %>
10 |     <%= text_input f, :bar, class: "form-control" %>
11 |     <%= error_tag f, :bar %>
12 |   </div>
13 | 
14 |   <div class="form-group">
15 |     <%= submit "Submit", class: "btn btn-primary" %>
16 |   </div>
17 | <% end %>
18 | 


--------------------------------------------------------------------------------
/example/lib/example_web/templates/foo/index.html.eex:
--------------------------------------------------------------------------------
 1 | <h2>Listing foos</h2>
 2 | 
 3 | <table class="table">
 4 |   <thead>
 5 |     <tr>
 6 |       <th>Bar</th>
 7 | 
 8 |       <th></th>
 9 |     </tr>
10 |   </thead>
11 |   <tbody>
12 | <%= for foo <- @foos do %>
13 |     <tr>
14 |       <td><%= foo.bar %></td>
15 | 
16 |       <td class="text-right">
17 |         <%= link "Show", to: foo_path(@conn, :show, foo), class: "btn btn-default btn-xs" %>
18 |         <%= link "Edit", to: foo_path(@conn, :edit, foo), class: "btn btn-default btn-xs" %>
19 |         <%= link "Delete", to: foo_path(@conn, :delete, foo), method: :delete, data: [confirm: "Are you sure?"], class: "btn btn-danger btn-xs" %>
20 |       </td>
21 |     </tr>
22 | <% end %>
23 |   </tbody>
24 | </table>
25 | 
26 | <%= link "New foo", to: foo_path(@conn, :new) %>
27 | 


--------------------------------------------------------------------------------
/example/lib/example_web/templates/foo/new.html.eex:
--------------------------------------------------------------------------------
1 | <h2>New foo</h2>
2 | 
3 | <%= render "form.html", changeset: @changeset,
4 |                         action: foo_path(@conn, :create) %>
5 | 
6 | <%= link "Back", to: foo_path(@conn, :index) %>
7 | 


--------------------------------------------------------------------------------
/example/lib/example_web/templates/foo/show.html.eex:
--------------------------------------------------------------------------------
 1 | <h2>Show foo</h2>
 2 | 
 3 | <ul>
 4 | 
 5 |   <li>
 6 |     <strong>Bar:</strong>
 7 |     <%= @foo.bar %>
 8 |   </li>
 9 | 
10 | </ul>
11 | 
12 | <%= link "Edit", to: foo_path(@conn, :edit, @foo) %>
13 | <%= link "Back", to: foo_path(@conn, :index) %>
14 | 


--------------------------------------------------------------------------------
/example/lib/example_web/templates/layout/app.html.eex:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="utf-8">
 5 |     <meta http-equiv="X-UA-Compatible" content="IE=edge">
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1">
 7 |     <meta name="description" content="">
 8 |     <meta name="author" content="">
 9 |     <title>Example · Phoenix Framework</title>
10 |     <link rel="stylesheet" href="<%= Routes.static_path(@conn, "/css/app.css") %>"/>
11 |   </head>
12 | 
13 |   <body>
14 |     <header>
15 |       <section class="container">
16 |         <nav role="navigation">
17 |           <ul>
18 |             <li><a href="https://hexdocs.pm/phoenix/overview.html">Get Started</a></li>
19 |           </ul>
20 |         </nav>
21 |         <a href="http://phoenixframework.org/" class="phx-logo">
22 |           <img src="<%= Routes.static_path(@conn, "/images/phoenix.png") %>" alt="Phoenix Framework Logo"/>
23 |         </a>
24 |       </section>
25 |     </header>
26 | 
27 |     <main role="main">
28 |       <p class="alert alert-info" role="alert"><%= get_flash(@conn, :info) %></p>
29 |       <p class="alert alert-danger" role="alert"><%= get_flash(@conn, :error) %></p>
30 |       <%= render @view_module, @view_template, assigns %>
31 |     </main>
32 | 
33 |     <script type="text/javascript" src="<%= Routes.static_path(@conn, "/js/app.js") %>"></script>
34 |   </body>
35 | </html>
36 | 


--------------------------------------------------------------------------------
/example/lib/example_web/templates/page/index.html.eex:
--------------------------------------------------------------------------------
 1 | <section class="phx-hero">
 2 |   <h1><%= gettext "Welcome to %{name}!", name: "Phoenix" %></h1>
 3 |   <p>A productive web framework that<br/>does not compromise speed or maintainability.</p>
 4 | </section>
 5 | 
 6 | <section class="row">
 7 |   <article class="column">
 8 |     <h2>Resources</h2>
 9 |     <ul>
10 |       <li>
11 |         <a href="https://hexdocs.pm/phoenix/overview.html">Guides &amp; Docs</a>
12 |       </li>
13 |       <li>
14 |         <a href="https://github.com/phoenixframework/phoenix">Source</a>
15 |       </li>
16 |       <li>
17 |         <a href="https://github.com/phoenixframework/phoenix/blob/v1.4/CHANGELOG.md">v1.4 Changelog</a>
18 |       </li>
19 |     </ul>
20 |   </article>
21 |   <article class="column">
22 |     <h2>Help</h2>
23 |     <ul>
24 |       <li>
25 |         <a href="https://elixirforum.com/c/phoenix-forum">Forum</a>
26 |       </li>
27 |       <li>
28 |         <a href="https://webchat.freenode.net/?channels=elixir-lang">#elixir-lang on Freenode IRC</a>
29 |       </li>
30 |       <li>
31 |         <a href="https://twitter.com/elixirphoenix">Twitter @elixirphoenix</a>
32 |       </li>
33 |     </ul>
34 |   </article>
35 | </section>
36 | 


--------------------------------------------------------------------------------
/example/lib/example_web/views/error_helpers.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.ErrorHelpers do
 2 |   @moduledoc """
 3 |   Conveniences for translating and building error messages.
 4 |   """
 5 | 
 6 |   use Phoenix.HTML
 7 | 
 8 |   @doc """
 9 |   Generates tag for inlined form input errors.
10 |   """
11 |   def error_tag(form, field) do
12 |     Enum.map(Keyword.get_values(form.errors, field), fn error ->
13 |       content_tag(:span, translate_error(error), class: "help-block")
14 |     end)
15 |   end
16 | 
17 |   @doc """
18 |   Translates an error message using gettext.
19 |   """
20 |   def translate_error({msg, opts}) do
21 |     # When using gettext, we typically pass the strings we want
22 |     # to translate as a static argument:
23 |     #
24 |     #     # Translate "is invalid" in the "errors" domain
25 |     #     dgettext("errors", "is invalid")
26 |     #
27 |     #     # Translate the number of files with plural rules
28 |     #     dngettext("errors", "1 file", "%{count} files", count)
29 |     #
30 |     # Because the error messages we show in our forms and APIs
31 |     # are defined inside Ecto, we need to translate them dynamically.
32 |     # This requires us to call the Gettext module passing our gettext
33 |     # backend as first argument.
34 |     #
35 |     # Note we use the "errors" domain, which means translations
36 |     # should be written to the errors.po file. The :count option is
37 |     # set by Ecto and indicates we should also apply plural rules.
38 |     if count = opts[:count] do
39 |       Gettext.dngettext(ExampleWeb.Gettext, "errors", msg, msg, count, opts)
40 |     else
41 |       Gettext.dgettext(ExampleWeb.Gettext, "errors", msg, opts)
42 |     end
43 |   end
44 | end
45 | 


--------------------------------------------------------------------------------
/example/lib/example_web/views/error_view.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.ErrorView do
 2 |   use ExampleWeb, :view
 3 | 
 4 |   # If you want to customize a particular status code
 5 |   # for a certain format, you may uncomment below.
 6 |   # def render("500.html", _assigns) do
 7 |   #   "Internal Server Error"
 8 |   # end
 9 | 
10 |   # By default, Phoenix returns the status message from
11 |   # the template name. For example, "404.html" becomes
12 |   # "Not Found".
13 |   def template_not_found(template, _assigns) do
14 |     Phoenix.Controller.status_message_from_template(template)
15 |   end
16 | end
17 | 


--------------------------------------------------------------------------------
/example/lib/example_web/views/layout_view.ex:
--------------------------------------------------------------------------------
1 | defmodule ExampleWeb.LayoutView do
2 |   use ExampleWeb, :view
3 | end
4 | 


--------------------------------------------------------------------------------
/example/lib/example_web/views/page_view.ex:
--------------------------------------------------------------------------------
1 | defmodule ExampleWeb.PageView do
2 |   use ExampleWeb, :view
3 | end
4 | 


--------------------------------------------------------------------------------
/example/mix.exs:
--------------------------------------------------------------------------------
 1 | defmodule Example.Mixfile do
 2 |   use Mix.Project
 3 | 
 4 |   def project do
 5 |     [
 6 |       app: :example,
 7 |       version: "0.1.0",
 8 |       elixir: "~> 1.5",
 9 |       elixirc_paths: elixirc_paths(Mix.env()),
10 |       compilers: [:phoenix, :gettext] ++ Mix.compilers(),
11 |       start_permanent: Mix.env() == :prod,
12 |       aliases: aliases(),
13 |       deps: deps()
14 |     ]
15 |   end
16 | 
17 |   # Configuration for the OTP application.
18 |   #
19 |   # Type `mix help compile.app` for more information.
20 |   def application do
21 |     [
22 |       mod: {Example.Application, []},
23 |       extra_applications: [:logger, :runtime_tools]
24 |     ]
25 |   end
26 | 
27 |   # Specifies which paths to compile per environment.
28 |   defp elixirc_paths(:test), do: ["lib", "test/support"]
29 |   defp elixirc_paths(_), do: ["lib"]
30 | 
31 |   # Specifies your project dependencies.
32 |   #
33 |   # Type `mix help deps` for examples and options.
34 |   defp deps do
35 |     [
36 |       {:phoenix, "~> 1.4.6"},
37 |       {:phoenix_pubsub, "~> 1.1"},
38 |       {:phoenix_ecto, "~> 4.0"},
39 |       {:ecto_sql, "~> 3.0"},
40 |       {:postgrex, ">= 0.0.0"},
41 |       {:phoenix_html, "~> 2.13"},
42 |       {:phoenix_live_reload, "~> 1.2", only: :dev},
43 |       {:gettext, "~> 0.16.1"},
44 |       {:jason, "~> 1.0"},
45 |       {:plug_cowboy, "~> 2.0"},
46 |       {:ua_parser, git: "https://github.com/beam-community/ua_parser.git", branch: "master"}
47 |     ]
48 |   end
49 | 
50 |   # Aliases are shortcuts or tasks specific to the current project.
51 |   # For example, to create, migrate and run the seeds file at once:
52 |   #
53 |   #     $ mix ecto.setup
54 |   #
55 |   # See the documentation for `Mix` for more info on aliases.
56 |   defp aliases do
57 |     [
58 |       "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
59 |       "ecto.reset": ["ecto.drop", "ecto.setup"],
60 |       test: ["ecto.create --quiet", "ecto.migrate", "test"]
61 |     ]
62 |   end
63 | end
64 | 


--------------------------------------------------------------------------------
/example/mix.lock:
--------------------------------------------------------------------------------
 1 | %{
 2 |   "connection": {:hex, :connection, "1.0.4", "a1cae72211f0eef17705aaededacac3eb30e6625b04a6117c1b2db6ace7d5976", [:mix], []},
 3 |   "cowboy": {:hex, :cowboy, "2.6.3", "99aa50e94e685557cad82e704457336a453d4abcb77839ad22dbe71f311fcc06", [:rebar3], [{:cowlib, "~> 2.7.3", [hex: :cowlib, repo: "hexpm", optional: false]}, {:ranch, "~> 1.7.1", [hex: :ranch, repo: "hexpm", optional: false]}], "hexpm"},
 4 |   "cowlib": {:hex, :cowlib, "2.7.3", "a7ffcd0917e6d50b4d5fb28e9e2085a0ceb3c97dea310505f7460ff5ed764ce9", [:rebar3], [], "hexpm"},
 5 |   "db_connection": {:hex, :db_connection, "2.0.6", "bde2f85d047969c5b5800cb8f4b3ed6316c8cb11487afedac4aa5f93fd39abfa", [:mix], [{:connection, "~> 1.0.2", [hex: :connection, repo: "hexpm", optional: false]}], "hexpm"},
 6 |   "decimal": {:hex, :decimal, "1.7.0", "30d6b52c88541f9a66637359ddf85016df9eb266170d53105f02e4a67e00c5aa", [:mix], [], "hexpm"},
 7 |   "ecto": {:hex, :ecto, "3.1.4", "69d852da7a9f04ede725855a35ede48d158ca11a404fe94f8b2fb3b2162cd3c9", [:mix], [{:decimal, "~> 1.6", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}], "hexpm"},
 8 |   "ecto_sql": {:hex, :ecto_sql, "3.1.3", "2c536139190492d9de33c5fefac7323c5eaaa82e1b9bf93482a14649042f7cd9", [:mix], [{:db_connection, "~> 2.0", [hex: :db_connection, repo: "hexpm", optional: false]}, {:ecto, "~> 3.1.0", [hex: :ecto, repo: "hexpm", optional: false]}, {:mariaex, "~> 0.9.1", [hex: :mariaex, repo: "hexpm", optional: true]}, {:myxql, "~> 0.2.0", [hex: :myxql, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.14.0", [hex: :postgrex, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm"},
 9 |   "file_system": {:hex, :file_system, "0.2.7", "e6f7f155970975789f26e77b8b8d8ab084c59844d8ecfaf58cbda31c494d14aa", [:mix], [], "hexpm"},
10 |   "fs": {:hex, :fs, "0.9.2", "ed17036c26c3f70ac49781ed9220a50c36775c6ca2cf8182d123b6566e49ec59", [:rebar], []},
11 |   "gettext": {:hex, :gettext, "0.16.1", "e2130b25eebcbe02bb343b119a07ae2c7e28bd4b146c4a154da2ffb2b3507af2", [:mix], [], "hexpm"},
12 |   "jason": {:hex, :jason, "1.1.2", "b03dedea67a99223a2eaf9f1264ce37154564de899fd3d8b9a21b1a6fd64afe7", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm"},
13 |   "mime": {:hex, :mime, "1.3.1", "30ce04ab3175b6ad0bdce0035cba77bba68b813d523d1aac73d9781b4d193cf8", [:mix], [], "hexpm"},
14 |   "phoenix": {:hex, :phoenix, "1.4.6", "8535f4a01291f0fbc2c30c78c4ca6a2eacc148db5178ad76e8b2fc976c590115", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:phoenix_pubsub, "~> 1.1", [hex: :phoenix_pubsub, repo: "hexpm", optional: false]}, {:plug, "~> 1.7", [hex: :plug, repo: "hexpm", optional: false]}, {:plug_cowboy, "~> 1.0 or ~> 2.0", [hex: :plug_cowboy, repo: "hexpm", optional: true]}], "hexpm"},
15 |   "phoenix_ecto": {:hex, :phoenix_ecto, "4.0.0", "c43117a136e7399ea04ecaac73f8f23ee0ffe3e07acfcb8062fe5f4c9f0f6531", [:mix], [{:ecto, "~> 3.0", [hex: :ecto, repo: "hexpm", optional: false]}, {:phoenix_html, "~> 2.9", [hex: :phoenix_html, repo: "hexpm", optional: true]}, {:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm"},
16 |   "phoenix_html": {:hex, :phoenix_html, "2.13.2", "f5d27c9b10ce881a60177d2b5227314fc60881e6b66b41dfe3349db6ed06cf57", [:mix], [{:plug, "~> 1.5", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm"},
17 |   "phoenix_live_reload": {:hex, :phoenix_live_reload, "1.2.0", "3bb31a9fbd40ffe8652e60c8660dffd72dd231efcdf49b744fb75b9ef7db5dd2", [:mix], [{:file_system, "~> 0.2.1 or ~> 0.3", [hex: :file_system, repo: "hexpm", optional: false]}, {:phoenix, "~> 1.4", [hex: :phoenix, repo: "hexpm", optional: false]}], "hexpm"},
18 |   "phoenix_pubsub": {:hex, :phoenix_pubsub, "1.1.2", "496c303bdf1b2e98a9d26e89af5bba3ab487ba3a3735f74bf1f4064d2a845a3e", [:mix], [], "hexpm"},
19 |   "plug": {:hex, :plug, "1.8.0", "9d2685cb007fe5e28ed9ac27af2815bc262b7817a00929ac10f56f169f43b977", [:mix], [{:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.0", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4", [hex: :telemetry, repo: "hexpm", optional: true]}], "hexpm"},
20 |   "plug_cowboy": {:hex, :plug_cowboy, "2.0.2", "6055f16868cc4882b24b6e1d63d2bada94fb4978413377a3b32ac16c18dffba2", [:mix], [{:cowboy, "~> 2.5", [hex: :cowboy, repo: "hexpm", optional: false]}, {:plug, "~> 1.7", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm"},
21 |   "plug_crypto": {:hex, :plug_crypto, "1.0.0", "18e49317d3fa343f24620ed22795ec29d4a5e602d52d1513ccea0b07d8ea7d4d", [:mix], [], "hexpm"},
22 |   "poison": {:hex, :poison, "2.2.0", "4763b69a8a77bd77d26f477d196428b741261a761257ff1cf92753a0d4d24a63", [:mix], []},
23 |   "poolboy": {:hex, :poolboy, "1.5.1", "6b46163901cfd0a1b43d692657ed9d7e599853b3b21b95ae5ae0a777cf9b6ca8", [:rebar], []},
24 |   "postgrex": {:hex, :postgrex, "0.14.3", "5754dee2fdf6e9e508cbf49ab138df964278700b764177e8f3871e658b345a1e", [:mix], [{:connection, "~> 1.0", [hex: :connection, repo: "hexpm", optional: false]}, {:db_connection, "~> 2.0", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}], "hexpm"},
25 |   "ranch": {:hex, :ranch, "1.7.1", "6b1fab51b49196860b733a49c07604465a47bdb78aa10c1c16a3d199f7f8c881", [:rebar3], [], "hexpm"},
26 |   "telemetry": {:hex, :telemetry, "0.4.0", "8339bee3fa8b91cb84d14c2935f8ecf399ccd87301ad6da6b71c09553834b2ab", [:rebar3], [], "hexpm"},
27 |   "ua_parser": {:git, "https://github.com/beam-community/ua_parser.git", "249a47dadab624df721cb25e0cf9774b40806c64", [branch: "master"]},
28 |   "yamerl": {:hex, :yamerl, "0.7.0", "e51dba652dce74c20a88294130b48051ebbbb0be7d76f22de064f0f3ccf0aaf5", [:rebar3], [], "hexpm"},
29 | }
30 | 


--------------------------------------------------------------------------------
/example/priv/gettext/en/LC_MESSAGES/errors.po:
--------------------------------------------------------------------------------
 1 | ## `msgid`s in this file come from POT (.pot) files.
 2 | ##
 3 | ## Do not add, change, or remove `msgid`s manually here as
 4 | ## they're tied to the ones in the corresponding POT file
 5 | ## (with the same domain).
 6 | ##
 7 | ## Use `mix gettext.extract --merge` or `mix gettext.merge`
 8 | ## to merge POT files into PO files.
 9 | msgid ""
10 | msgstr ""
11 | "Language: en\n"
12 | 
13 | ## From Ecto.Changeset.cast/4
14 | msgid "can't be blank"
15 | msgstr ""
16 | 
17 | ## From Ecto.Changeset.unique_constraint/3
18 | msgid "has already been taken"
19 | msgstr ""
20 | 
21 | ## From Ecto.Changeset.put_change/3
22 | msgid "is invalid"
23 | msgstr ""
24 | 
25 | ## From Ecto.Changeset.validate_format/3
26 | msgid "has invalid format"
27 | msgstr ""
28 | 
29 | ## From Ecto.Changeset.validate_subset/3
30 | msgid "has an invalid entry"
31 | msgstr ""
32 | 
33 | ## From Ecto.Changeset.validate_exclusion/3
34 | msgid "is reserved"
35 | msgstr ""
36 | 
37 | ## From Ecto.Changeset.validate_confirmation/3
38 | msgid "does not match confirmation"
39 | msgstr ""
40 | 
41 | ## From Ecto.Changeset.no_assoc_constraint/3
42 | msgid "is still associated to this entry"
43 | msgstr ""
44 | 
45 | msgid "are still associated to this entry"
46 | msgstr ""
47 | 
48 | ## From Ecto.Changeset.validate_length/3
49 | msgid "should be %{count} character(s)"
50 | msgid_plural "should be %{count} character(s)"
51 | msgstr[0] ""
52 | msgstr[1] ""
53 | 
54 | msgid "should have %{count} item(s)"
55 | msgid_plural "should have %{count} item(s)"
56 | msgstr[0] ""
57 | msgstr[1] ""
58 | 
59 | msgid "should be at least %{count} character(s)"
60 | msgid_plural "should be at least %{count} character(s)"
61 | msgstr[0] ""
62 | msgstr[1] ""
63 | 
64 | msgid "should have at least %{count} item(s)"
65 | msgid_plural "should have at least %{count} item(s)"
66 | msgstr[0] ""
67 | msgstr[1] ""
68 | 
69 | msgid "should be at most %{count} character(s)"
70 | msgid_plural "should be at most %{count} character(s)"
71 | msgstr[0] ""
72 | msgstr[1] ""
73 | 
74 | msgid "should have at most %{count} item(s)"
75 | msgid_plural "should have at most %{count} item(s)"
76 | msgstr[0] ""
77 | msgstr[1] ""
78 | 
79 | ## From Ecto.Changeset.validate_number/3
80 | msgid "must be less than %{number}"
81 | msgstr ""
82 | 
83 | msgid "must be greater than %{number}"
84 | msgstr ""
85 | 
86 | msgid "must be less than or equal to %{number}"
87 | msgstr ""
88 | 
89 | msgid "must be greater than or equal to %{number}"
90 | msgstr ""
91 | 
92 | msgid "must be equal to %{number}"
93 | msgstr ""
94 | 


--------------------------------------------------------------------------------
/example/priv/gettext/errors.pot:
--------------------------------------------------------------------------------
 1 | ## This file is a PO Template file.
 2 | ##
 3 | ## `msgid`s here are often extracted from source code.
 4 | ## Add new translations manually only if they're dynamic
 5 | ## translations that can't be statically extracted.
 6 | ##
 7 | ## Run `mix gettext.extract` to bring this file up to
 8 | ## date. Leave `msgstr`s empty as changing them here as no
 9 | ## effect: edit them in PO (`.po`) files instead.
10 | 
11 | ## From Ecto.Changeset.cast/4
12 | msgid "can't be blank"
13 | msgstr ""
14 | 
15 | ## From Ecto.Changeset.unique_constraint/3
16 | msgid "has already been taken"
17 | msgstr ""
18 | 
19 | ## From Ecto.Changeset.put_change/3
20 | msgid "is invalid"
21 | msgstr ""
22 | 
23 | ## From Ecto.Changeset.validate_format/3
24 | msgid "has invalid format"
25 | msgstr ""
26 | 
27 | ## From Ecto.Changeset.validate_subset/3
28 | msgid "has an invalid entry"
29 | msgstr ""
30 | 
31 | ## From Ecto.Changeset.validate_exclusion/3
32 | msgid "is reserved"
33 | msgstr ""
34 | 
35 | ## From Ecto.Changeset.validate_confirmation/3
36 | msgid "does not match confirmation"
37 | msgstr ""
38 | 
39 | ## From Ecto.Changeset.no_assoc_constraint/3
40 | msgid "is still associated to this entry"
41 | msgstr ""
42 | 
43 | msgid "are still associated to this entry"
44 | msgstr ""
45 | 
46 | ## From Ecto.Changeset.validate_length/3
47 | msgid "should be %{count} character(s)"
48 | msgid_plural "should be %{count} character(s)"
49 | msgstr[0] ""
50 | msgstr[1] ""
51 | 
52 | msgid "should have %{count} item(s)"
53 | msgid_plural "should have %{count} item(s)"
54 | msgstr[0] ""
55 | msgstr[1] ""
56 | 
57 | msgid "should be at least %{count} character(s)"
58 | msgid_plural "should be at least %{count} character(s)"
59 | msgstr[0] ""
60 | msgstr[1] ""
61 | 
62 | msgid "should have at least %{count} item(s)"
63 | msgid_plural "should have at least %{count} item(s)"
64 | msgstr[0] ""
65 | msgstr[1] ""
66 | 
67 | msgid "should be at most %{count} character(s)"
68 | msgid_plural "should be at most %{count} character(s)"
69 | msgstr[0] ""
70 | msgstr[1] ""
71 | 
72 | msgid "should have at most %{count} item(s)"
73 | msgid_plural "should have at most %{count} item(s)"
74 | msgstr[0] ""
75 | msgstr[1] ""
76 | 
77 | ## From Ecto.Changeset.validate_number/3
78 | msgid "must be less than %{number}"
79 | msgstr ""
80 | 
81 | msgid "must be greater than %{number}"
82 | msgstr ""
83 | 
84 | msgid "must be less than or equal to %{number}"
85 | msgstr ""
86 | 
87 | msgid "must be greater than or equal to %{number}"
88 | msgstr ""
89 | 
90 | msgid "must be equal to %{number}"
91 | msgstr ""
92 | 


--------------------------------------------------------------------------------
/example/priv/repo/migrations/20161130184742_create_foo.exs:
--------------------------------------------------------------------------------
 1 | defmodule Example.Repo.Migrations.CreateFoo do
 2 |   use Ecto.Migration
 3 | 
 4 |   def change do
 5 |     create table(:foos) do
 6 |       add(:bar, :string)
 7 | 
 8 |       timestamps()
 9 |     end
10 |   end
11 | end
12 | 


--------------------------------------------------------------------------------
/example/priv/repo/seeds.exs:
--------------------------------------------------------------------------------
 1 | # Script for populating the database. You can run it as:
 2 | #
 3 | #     mix run priv/repo/seeds.exs
 4 | #
 5 | # Inside the script, you can read and write to any of your
 6 | # repositories directly:
 7 | #
 8 | #     Example.Repo.insert!(%Example.SomeSchema{})
 9 | #
10 | # We recommend using the bang functions (`insert!`, `update!`
11 | # and so on) as they will fail if something goes wrong.
12 | 


--------------------------------------------------------------------------------
/example/test/example_web/controllers/page_controller_test.exs:
--------------------------------------------------------------------------------
1 | defmodule ExampleWeb.PageControllerTest do
2 |   use ExampleWeb.ConnCase
3 | 
4 |   test "GET /", %{conn: conn} do
5 |     conn = get(conn, "/")
6 |     assert html_response(conn, 200) =~ "Welcome to Phoenix!"
7 |   end
8 | end
9 | 


--------------------------------------------------------------------------------
/example/test/example_web/views/error_view_test.exs:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.ErrorViewTest do
 2 |   use ExampleWeb.ConnCase, async: true
 3 | 
 4 |   # Bring render/3 and render_to_string/3 for testing custom views
 5 |   import Phoenix.View
 6 | 
 7 |   test "renders 404.html" do
 8 |     assert render_to_string(ExampleWeb.ErrorView, "404.html", []) == "Not Found"
 9 |   end
10 | 
11 |   test "renders 500.html" do
12 |     assert render_to_string(ExampleWeb.ErrorView, "500.html", []) == "Internal Server Error"
13 |   end
14 | end
15 | 


--------------------------------------------------------------------------------
/example/test/example_web/views/layout_view_test.exs:
--------------------------------------------------------------------------------
1 | defmodule ExampleWeb.LayoutViewTest do
2 |   use ExampleWeb.ConnCase, async: true
3 | end
4 | 


--------------------------------------------------------------------------------
/example/test/example_web/views/page_view_test.exs:
--------------------------------------------------------------------------------
1 | defmodule ExampleWeb.PageViewTest do
2 |   use ExampleWeb.ConnCase, async: true
3 | end
4 | 


--------------------------------------------------------------------------------
/example/test/support/channel_case.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.ChannelCase do
 2 |   @moduledoc """
 3 |   This module defines the test case to be used by
 4 |   channel tests.
 5 | 
 6 |   Such tests rely on `Phoenix.ChannelTest` and also
 7 |   import other functionality to make it easier
 8 |   to build common data structures and query the data layer.
 9 | 
10 |   Finally, if the test case interacts with the database,
11 |   it cannot be async. For this reason, every test runs
12 |   inside a transaction which is reset at the beginning
13 |   of the test unless the test case is marked as async.
14 |   """
15 | 
16 |   use ExUnit.CaseTemplate
17 | 
18 |   using do
19 |     quote do
20 |       # Import conveniences for testing with channels
21 |       use Phoenix.ChannelTest
22 | 
23 |       # The default endpoint for testing
24 |       @endpoint ExampleWeb.Endpoint
25 |     end
26 |   end
27 | 
28 |   setup tags do
29 |     :ok = Ecto.Adapters.SQL.Sandbox.checkout(Example.Repo)
30 | 
31 |     unless tags[:async] do
32 |       Ecto.Adapters.SQL.Sandbox.mode(Example.Repo, {:shared, self()})
33 |     end
34 | 
35 |     :ok
36 |   end
37 | end
38 | 


--------------------------------------------------------------------------------
/example/test/support/conn_case.ex:
--------------------------------------------------------------------------------
 1 | defmodule ExampleWeb.ConnCase do
 2 |   @moduledoc """
 3 |   This module defines the test case to be used by
 4 |   tests that require setting up a connection.
 5 | 
 6 |   Such tests rely on `Phoenix.ConnTest` and also
 7 |   import other functionality to make it easier
 8 |   to build common data structures and query the data layer.
 9 | 
10 |   Finally, if the test case interacts with the database,
11 |   it cannot be async. For this reason, every test runs
12 |   inside a transaction which is reset at the beginning
13 |   of the test unless the test case is marked as async.
14 |   """
15 | 
16 |   use ExUnit.CaseTemplate
17 | 
18 |   using do
19 |     quote do
20 |       # Import conveniences for testing with connections
21 |       use Phoenix.ConnTest
22 |       alias ExampleWeb.Router.Helpers, as: Routes
23 | 
24 |       # The default endpoint for testing
25 |       @endpoint ExampleWeb.Endpoint
26 |     end
27 |   end
28 | 
29 |   setup tags do
30 |     :ok = Ecto.Adapters.SQL.Sandbox.checkout(Example.Repo)
31 | 
32 |     unless tags[:async] do
33 |       Ecto.Adapters.SQL.Sandbox.mode(Example.Repo, {:shared, self()})
34 |     end
35 | 
36 |     {:ok, conn: Phoenix.ConnTest.build_conn()}
37 |   end
38 | end
39 | 


--------------------------------------------------------------------------------
/example/test/support/data_case.ex:
--------------------------------------------------------------------------------
 1 | defmodule Example.DataCase do
 2 |   @moduledoc """
 3 |   This module defines the setup for tests requiring
 4 |   access to the application's data layer.
 5 | 
 6 |   You may define functions here to be used as helpers in
 7 |   your tests.
 8 | 
 9 |   Finally, if the test case interacts with the database,
10 |   it cannot be async. For this reason, every test runs
11 |   inside a transaction which is reset at the beginning
12 |   of the test unless the test case is marked as async.
13 |   """
14 | 
15 |   use ExUnit.CaseTemplate
16 | 
17 |   using do
18 |     quote do
19 |       alias Example.Repo
20 | 
21 |       import Ecto
22 |       import Ecto.Changeset
23 |       import Ecto.Query
24 |       import Example.DataCase
25 |     end
26 |   end
27 | 
28 |   setup tags do
29 |     :ok = Ecto.Adapters.SQL.Sandbox.checkout(Example.Repo)
30 | 
31 |     unless tags[:async] do
32 |       Ecto.Adapters.SQL.Sandbox.mode(Example.Repo, {:shared, self()})
33 |     end
34 | 
35 |     :ok
36 |   end
37 | 
38 |   @doc """
39 |   A helper that transforms changeset errors into a map of messages.
40 | 
41 |       assert {:error, changeset} = Accounts.create_user(%{password: "short"})
42 |       assert "password is too short" in errors_on(changeset).password
43 |       assert %{password: ["password is too short"]} = errors_on(changeset)
44 | 
45 |   """
46 |   def errors_on(changeset) do
47 |     Ecto.Changeset.traverse_errors(changeset, fn {message, opts} ->
48 |       Regex.replace(~r"%{(\w+)}", message, fn _, key ->
49 |         opts |> Keyword.get(String.to_existing_atom(key), key) |> to_string()
50 |       end)
51 |     end)
52 |   end
53 | end
54 | 


--------------------------------------------------------------------------------
/example/test/test_helper.exs:
--------------------------------------------------------------------------------
1 | ExUnit.start()
2 | 
3 | Ecto.Adapters.SQL.Sandbox.mode(Example.Repo, :manual)
4 | 


--------------------------------------------------------------------------------
/lib/ua_parser.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser do
 2 |   @moduledoc """
 3 |   A fast User Agent parser with a widely used API.
 4 |   """
 5 | 
 6 |   alias UAParser.{Parser, Storage}
 7 | 
 8 |   @doc """
 9 |   Parse a user-agent string into structs
10 | 
11 |   ## Examples
12 | 
13 |       iex> agent_string = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_7; en-us) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Safari/530.17 Skyfire/2.0"
14 |       iex> ua = UAParser.parse(agent_string)
15 |       iex> to_string(ua)
16 |       "Skyfire 2.0"
17 |       iex> to_string(ua.os)
18 |       "Mac OS X 10.5.7"
19 |       iex> to_string(ua.device)
20 |       "Mac"
21 | 
22 |   """
23 |   def parse(nil), do: parse("")
24 |   def parse(ua), do: parse(ua, default_pattern())
25 |   def parse(ua, pattern), do: Parser.parse(pattern, ua)
26 | 
27 |   defp default_pattern, do: Storage.list()
28 | end
29 | 


--------------------------------------------------------------------------------
/lib/ua_parser/device.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Device do
 2 |   @moduledoc """
 3 |   Device struct and helper methods.
 4 |   """
 5 | 
 6 |   @type t :: %__MODULE__{
 7 |           brand: String.t(),
 8 |           family: String.t(),
 9 |           model: String.t()
10 |         }
11 | 
12 |   @doc """
13 |   ## Examples
14 | 
15 |       iex> device = %UAParser.Device{family: "iPhone"}
16 |       iex> to_string(device)
17 |       "iPhone"
18 | 
19 |       iex> device = %UAParser.Device{}
20 |       iex> to_string(device)
21 |       "Other"
22 | 
23 |   """
24 |   defstruct [:brand, :family, :model]
25 | end
26 | 
27 | defimpl String.Chars, for: UAParser.Device do
28 |   def to_string(%{family: nil}), do: "Other"
29 |   def to_string(%{family: family}), do: family
30 | end
31 | 


--------------------------------------------------------------------------------
/lib/ua_parser/operating_system.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.OperatingSystem do
 2 |   @moduledoc """
 3 |   A module representing an operating System struct.
 4 |   """
 5 | 
 6 |   @type t :: %__MODULE__{
 7 |           family: String.t(),
 8 |           version: String.t()
 9 |         }
10 | 
11 |   @doc """
12 |   ## Examples
13 | 
14 |       iex> version = %UAParser.Version{major: "1", minor: "2"}
15 |       iex> os = %UAParser.OperatingSystem{family: "macOS", version: version}
16 |       iex> to_string(os)
17 |       "macOS 1.2"
18 | 
19 |       iex> os = %UAParser.OperatingSystem{family: "macOS"}
20 |       iex> to_string(os)
21 |       "macOS"
22 | 
23 |   """
24 |   defstruct [:family, :version]
25 | end
26 | 
27 | defimpl String.Chars, for: UAParser.OperatingSystem do
28 |   def to_string(%{family: family, version: version}), do: String.trim("#{family} #{version}")
29 | end
30 | 


--------------------------------------------------------------------------------
/lib/ua_parser/parser.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parser do
 2 |   @moduledoc """
 3 |   Handle parsing the user-agent string.
 4 |   """
 5 | 
 6 |   alias UAParser.Parsers.{Device, OperatingSystem, UA}
 7 | 
 8 |   @doc """
 9 |   Parse a user-agent string given a set of patterns.
10 |   """
11 |   def parse({ua_patterns, os_patterns, device_patterns}, user_agent) do
12 |     user_agent
13 |     |> sanitize
14 |     |> parse_user_agent(ua_patterns)
15 |     |> parse_device(device_patterns)
16 |     |> parse_os(os_patterns)
17 |   end
18 | 
19 |   defp find_and_parse(patterns, user_agent, module) do
20 |     patterns
21 |     |> search(user_agent)
22 |     |> module.parse
23 |   end
24 | 
25 |   defp match(nil, _string), do: nil
26 | 
27 |   defp match(group, string) do
28 |     match =
29 |       group
30 |       |> Keyword.fetch!(:regex)
31 |       |> Regex.run(string)
32 | 
33 |     {group, match}
34 |   end
35 | 
36 |   defp parse_device({user_agent, acc}, patterns) do
37 |     device = find_and_parse(patterns, user_agent, Device)
38 |     {user_agent, Map.put(acc, :device, device)}
39 |   end
40 | 
41 |   defp parse_os({user_agent, acc}, patterns) do
42 |     os = find_and_parse(patterns, user_agent, OperatingSystem)
43 |     Map.put(acc, :os, os)
44 |   end
45 | 
46 |   defp parse_user_agent(user_agent, patterns) do
47 |     ua = find_and_parse(patterns, user_agent, UA)
48 | 
49 |     {user_agent, ua}
50 |   end
51 | 
52 |   defp sanitize(user_agent), do: String.trim(user_agent)
53 | 
54 |   defp search(groups, string) do
55 |     groups
56 |     |> Enum.find(fn group ->
57 |       group
58 |       |> Keyword.fetch!(:regex)
59 |       |> Regex.match?(string)
60 |     end)
61 |     |> match(string)
62 |   end
63 | end
64 | 


--------------------------------------------------------------------------------
/lib/ua_parser/parsers/base.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parsers.Base do
 2 |   @moduledoc """
 3 |   A module representing the base and behaviour for all of our parsers.
 4 |   """
 5 | 
 6 |   @callback parse(args :: term) :: result :: term | nil
 7 | 
 8 |   defmacro __using__(_opts) do
 9 |     quote do
10 |       @behaviour UAParser.Parsers.Base
11 | 
12 |       import UAParser.Parsers.Base
13 |     end
14 |   end
15 | 
16 |   defmacro replacement_parser(opts) do
17 |     [family_key | replacements] = Keyword.fetch!(opts, :keys)
18 |     mod = opts[:struct]
19 | 
20 |     quote do
21 |       def parse(nil), do: struct(unquote(mod), %{})
22 | 
23 |       def parse({group, match}) do
24 |         family =
25 |           group
26 |           |> Keyword.get(unquote(family_key))
27 |           |> UAParser.Parsers.Base.replace(1, match)
28 | 
29 |         match = Enum.slice(match, 1, 5)
30 |         version = UAParser.Parsers.Version.parse({group, match}, unquote(replacements))
31 | 
32 |         struct(unquote(mod), %{family: family, version: version})
33 |       end
34 |     end
35 |   end
36 | 
37 |   def replace(nil, position, match), do: Enum.at(match, position)
38 | 
39 |   def replace(string, position, match) do
40 |     val = Enum.at(match, position)
41 | 
42 |     if val do
43 |       String.replace(string, "$#{position}", val)
44 |     else
45 |       string
46 |     end
47 |   end
48 | end
49 | 


--------------------------------------------------------------------------------
/lib/ua_parser/parsers/device.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parsers.Device do
 2 |   @moduledoc """
 3 |   A parser module representing the device & its relevent information
 4 |   of a user agent.
 5 |   """
 6 |   use UAParser.Parsers.Base
 7 | 
 8 |   alias UAParser.Device
 9 | 
10 |   @replacements [
11 |     brand: :brand_replacement,
12 |     family: :device_replacement,
13 |     model: :model_replacement
14 |   ]
15 | 
16 |   def parse(nil), do: %Device{}
17 |   def parse({group, match}), do: do_replacement(@replacements, {group, match}, %Device{})
18 | 
19 |   def do_replacement([], _, device), do: device
20 | 
21 |   def do_replacement([{key, replacement} | replacements], {group, match}, device) do
22 |     replace = Keyword.get(group, replacement)
23 | 
24 |     replace =
25 |       match
26 |       |> Enum.with_index()
27 |       |> Enum.reduce(replace, fn {_, index}, acc ->
28 |         replace(acc, index, match)
29 |       end)
30 | 
31 |     do_replacement(replacements, {group, match}, Map.put(device, key, replace))
32 |   end
33 | end
34 | 


--------------------------------------------------------------------------------
/lib/ua_parser/parsers/operating_system.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parsers.OperatingSystem do
 2 |   @moduledoc """
 3 |   A parser module representing the operating system derived
 4 |   from a user agent.
 5 |   """
 6 |   use UAParser.Parsers.Base
 7 | 
 8 |   alias UAParser.OperatingSystem
 9 | 
10 |   replacement_parser(
11 |     struct: OperatingSystem,
12 |     keys: [
13 |       :os_replacement,
14 |       :os_v1_replacement,
15 |       :os_v2_replacement,
16 |       :os_v3_replacement,
17 |       :os_v4_replacement
18 |     ]
19 |   )
20 | end
21 | 


--------------------------------------------------------------------------------
/lib/ua_parser/parsers/user_agent.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parsers.UA do
 2 |   @moduledoc """
 3 |   A parser module representing the user agent from a request.
 4 |   """
 5 |   use UAParser.Parsers.Base
 6 | 
 7 |   alias UAParser.UA
 8 | 
 9 |   replacement_parser(
10 |     struct: UA,
11 |     keys: [
12 |       :family_replacement,
13 |       :v1_replacement,
14 |       :v2_replacement,
15 |       :v3_replacement,
16 |       :v4_replacement
17 |     ]
18 |   )
19 | end
20 | 


--------------------------------------------------------------------------------
/lib/ua_parser/parsers/version.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parsers.Version do
 2 |   @moduledoc """
 3 |   A parser module representing the full version of a given
 4 |   browser derived from the user agent.
 5 |   """
 6 | 
 7 |   use UAParser.Parsers.Base
 8 | 
 9 |   alias UAParser.Version
10 | 
11 |   def parse(nil), do: %Version{}
12 | 
13 |   def parse(grouping, keys \\ []) do
14 |     keys
15 |     |> Enum.with_index()
16 |     |> Enum.map(&parse_version(grouping, &1))
17 |     |> version
18 |   end
19 | 
20 |   defp parse_version({group, match}, {key, index}) do
21 |     group
22 |     |> Keyword.get(key)
23 |     |> replace(index + 1, match)
24 |   end
25 | 
26 |   defp version([major]), do: %Version{major: major}
27 | 
28 |   defp version([major, minor, patch, patch_minor]),
29 |     do: %Version{major: major, minor: minor, patch: patch, patch_minor: patch_minor}
30 | end
31 | 


--------------------------------------------------------------------------------
/lib/ua_parser/processor.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Processor do
 2 |   @moduledoc """
 3 |   Prepare a raw YAML document for consumption by the parser by
 4 |   converting charlists into strings and compiling our patterns.
 5 |   """
 6 | 
 7 |   @doc """
 8 |   Process a document into Elixir keyword lists and compiled patterns.
 9 |   """
10 |   def process(document) do
11 |     document
12 |     |> extract
13 |     |> convert
14 |     |> compile
15 |   end
16 | 
17 |   defp atom_key(key) do
18 |     key
19 |     |> String.Chars.to_string()
20 |     # credo:disable-for-next-line Credo.Check.Warning.UnsafeToAtom
21 |     |> String.to_atom()
22 |   end
23 | 
24 |   defp compile(groups) do
25 |     # result: {user_agents, os, devices}
26 |     groups
27 |     |> Enum.map(&compile_groups/1)
28 |     |> :erlang.list_to_tuple()
29 |   end
30 | 
31 |   defp compile_group(group) do
32 |     pattern =
33 |       group
34 |       |> Keyword.fetch!(:regex)
35 |       |> Regex.compile!()
36 | 
37 |     Keyword.put(group, :regex, pattern)
38 |   end
39 | 
40 |   defp compile_groups(groups), do: Enum.map(groups, &compile_group/1)
41 | 
42 |   defp convert([]), do: []
43 | 
44 |   defp convert([head | tail]) do
45 |     result = Enum.map(head, &to_keyword/1)
46 |     [result | convert(tail)]
47 |   end
48 | 
49 |   defp extract([document | _]) do
50 |     [{~c"user_agent_parsers", user_agents}, {~c"os_parsers", os}, {~c"device_parsers", devices}] = document
51 | 
52 |     [user_agents, os, devices]
53 |   end
54 | 
55 |   defp to_keyword([]), do: []
56 | 
57 |   defp to_keyword([{key, value} | tails]) do
58 |     keyword = {atom_key(key), String.Chars.to_string(value)}
59 |     [keyword | to_keyword(tails)]
60 |   end
61 | end
62 | 


--------------------------------------------------------------------------------
/lib/ua_parser/storage.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Storage do
 2 |   @moduledoc """
 3 |   Load pattern data at compile time. Recompiling the application is necessary
 4 |   after updating the pattern file.
 5 |   """
 6 | 
 7 |   alias UAParser.Processor
 8 | 
 9 |   Application.start(:yamerl)
10 | 
11 |   data =
12 |     :ua_parser
13 |     |> :code.priv_dir()
14 |     |> Kernel.++(~c"/patterns.yml")
15 |     |> to_string
16 |     |> :yamerl_constr.file([])
17 |     |> Processor.process()
18 | 
19 |   @data data
20 | 
21 |   def list, do: @data
22 | end
23 | 


--------------------------------------------------------------------------------
/lib/ua_parser/user_agent.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.UA do
 2 |   @moduledoc """
 3 |   User Agent struct and helper methods.
 4 |   """
 5 | 
 6 |   @type t :: %__MODULE__{
 7 |           device: String.t(),
 8 |           family: String.t(),
 9 |           os: String.t(),
10 |           version: String.t()
11 |         }
12 | 
13 |   @doc """
14 |   Display the UA as a string.
15 | 
16 |   ## Examples
17 | 
18 |       iex> version = %UAParser.Version{major: "1", minor: "2", patch: "3", patch_minor: "4"}
19 |       iex> agent = %UAParser.UA{family: "Family", version: version}
20 |       iex> to_string(agent)
21 |       "Family 1.2.3.4"
22 | 
23 |       iex> agent = %UAParser.UA{family: "Family"}
24 |       iex> to_string(agent)
25 |       "Family"
26 | 
27 |       iex> agent = %UAParser.UA{}
28 |       iex> to_string(agent)
29 |       "Other"
30 | 
31 |   """
32 | 
33 |   defstruct [:device, :family, :os, :version]
34 | end
35 | 
36 | defimpl String.Chars, for: UAParser.UA do
37 |   def to_string(%{family: family, version: nil}), do: family_name(family)
38 | 
39 |   def to_string(%{family: family, version: version}) do
40 |     family_name = family_name(family)
41 |     "#{family_name} #{version}"
42 |   end
43 | 
44 |   defp family_name(nil), do: "Other"
45 |   defp family_name(name), do: name
46 | end
47 | 


--------------------------------------------------------------------------------
/lib/ua_parser/version.ex:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Version do
 2 |   @moduledoc """
 3 |   A module representing user agent version struct and helper methods.
 4 |   """
 5 | 
 6 |   @type t :: %__MODULE__{}
 7 | 
 8 |   @doc """
 9 |   ## Examples
10 | 
11 |       iex> version = %UAParser.Version{major: "1", minor: "2", patch: "3", patch_minor: "4"}
12 |       iex> to_string(version)
13 |       "1.2.3.4"
14 | 
15 |       iex> version = %UAParser.Version{major: "1", minor: "2", patch: "3"}
16 |       iex> to_string(version)
17 |       "1.2.3"
18 | 
19 |       iex> version = %UAParser.Version{major: "1", minor: "2"}
20 |       iex> to_string(version)
21 |       "1.2"
22 | 
23 |       iex> version = %UAParser.Version{major: "1"}
24 |       iex> to_string(version)
25 |       "1"
26 | 
27 |   """
28 |   defstruct [:major, :minor, :patch, :patch_minor]
29 | end
30 | 
31 | defimpl String.Chars, for: UAParser.Version do
32 |   def to_string(%{major: major, minor: minor, patch: patch, patch_minor: patch_minor}) do
33 |     [major, minor, patch, patch_minor]
34 |     |> Enum.reject(&is_nil/1)
35 |     |> Enum.join(".")
36 |   end
37 | end
38 | 


--------------------------------------------------------------------------------
/mix.exs:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Mixfile do
 2 |   use Mix.Project
 3 | 
 4 |   @source_url "https://github.com/beam-community/ua_parser"
 5 | 
 6 |   def project do
 7 |     [
 8 |       app: :ua_parser,
 9 |       version: "1.9.2",
10 |       elixir: "~> 1.13",
11 |       build_embedded: Mix.env() == :prod,
12 |       start_permanent: Mix.env() == :prod,
13 |       package: package(),
14 |       deps: deps(),
15 |       docs: docs()
16 |     ]
17 |   end
18 | 
19 |   def application do
20 |     [extra_aplications: [:logger, :yamerl]]
21 |   end
22 | 
23 |   defp deps do
24 |     [
25 |       {:yamerl, "~> 0.10"},
26 |       # Dev & Test dependencies
27 |       {:dialyxir, "~> 1.1", only: [:dev, :test], runtime: false},
28 |       {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
29 |       {:ex_doc, "~> 0.31", only: :dev, runtime: false}
30 |     ]
31 |   end
32 | 
33 |   defp package do
34 |     [
35 |       description: "Parse user-agent strings with BrowserScope patterns",
36 |       maintainers: ["Sean Callan", "Nathan Youngman"],
37 |       files: ["lib", "mix.exs", "README*", "LICENSE*", "priv"],
38 |       licenses: ["Apache-2.0"],
39 |       links: %{GitHub: @source_url}
40 |     ]
41 |   end
42 | 
43 |   defp docs do
44 |     [
45 |       extras: [
46 |         LICENSE: [title: "License"],
47 |         "README.md": [title: "Overview"]
48 |       ],
49 |       main: "readme",
50 |       source_url: @source_url,
51 |       formatters: ["html"]
52 |     ]
53 |   end
54 | end
55 | 


--------------------------------------------------------------------------------
/mix.lock:
--------------------------------------------------------------------------------
 1 | %{
 2 |   "bunt": {:hex, :bunt, "1.0.0", "081c2c665f086849e6d57900292b3a161727ab40431219529f13c4ddcf3e7a44", [:mix], [], "hexpm", "dc5f86aa08a5f6fa6b8096f0735c4e76d54ae5c9fa2c143e5a1fc7c1cd9bb6b5"},
 3 |   "credo": {:hex, :credo, "1.7.12", "9e3c20463de4b5f3f23721527fcaf16722ec815e70ff6c60b86412c695d426c1", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "8493d45c656c5427d9c729235b99d498bd133421f3e0a683e5c1b561471291e5"},
 4 |   "dialyxir": {:hex, :dialyxir, "1.4.5", "ca1571ac18e0f88d4ab245f0b60fa31ff1b12cbae2b11bd25d207f865e8ae78a", [:mix], [{:erlex, ">= 0.2.7", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "b0fb08bb8107c750db5c0b324fa2df5ceaa0f9307690ee3c1f6ba5b9eb5d35c3"},
 5 |   "earmark_parser": {:hex, :earmark_parser, "1.4.44", "f20830dd6b5c77afe2b063777ddbbff09f9759396500cdbe7523efd58d7a339c", [:mix], [], "hexpm", "4778ac752b4701a5599215f7030989c989ffdc4f6df457c5f36938cc2d2a2750"},
 6 |   "erlex": {:hex, :erlex, "0.2.7", "810e8725f96ab74d17aac676e748627a07bc87eb950d2b83acd29dc047a30595", [:mix], [], "hexpm", "3ed95f79d1a844c3f6bf0cea61e0d5612a42ce56da9c03f01df538685365efb0"},
 7 |   "ex_doc": {:hex, :ex_doc, "0.38.2", "504d25eef296b4dec3b8e33e810bc8b5344d565998cd83914ffe1b8503737c02", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "732f2d972e42c116a70802f9898c51b54916e542cc50968ac6980512ec90f42b"},
 8 |   "file_system": {:hex, :file_system, "1.1.0", "08d232062284546c6c34426997dd7ef6ec9f8bbd090eb91780283c9016840e8f", [:mix], [], "hexpm", "bfcf81244f416871f2a2e15c1b515287faa5db9c6bcf290222206d120b3d43f6"},
 9 |   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
10 |   "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
11 |   "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
12 |   "makeup_erlang": {:hex, :makeup_erlang, "1.0.2", "03e1804074b3aa64d5fad7aa64601ed0fb395337b982d9bcf04029d68d51b6a7", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "af33ff7ef368d5893e4a267933e7744e46ce3cf1f61e2dccf53a111ed3aa3727"},
13 |   "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
14 |   "yamerl": {:hex, :yamerl, "0.10.0", "4ff81fee2f1f6a46f1700c0d880b24d193ddb74bd14ef42cb0bcf46e81ef2f8e", [:rebar3], [], "hexpm", "346adb2963f1051dc837a2364e4acf6eb7d80097c0f53cbdc3046ec8ec4b4e6e"},
15 | }
16 | 


--------------------------------------------------------------------------------
/test/fixtures/patterns.yml:
--------------------------------------------------------------------------------
 1 | user_agent_parsers:
 2 |   - regex: '\b(MobileIron|Crosswalk|AdobeAIR|FireWeb|Jasmine|ANTGalio|Midori|Fresco|Lobo|PaleMoon|Maxthon|Lynx|OmniWeb|Dillo|Camino|Demeter|Fluid|Fennec|Epiphany|Shiira|Sunrise|Spotify|Flock|Netscape|Lunascape|WebPilot|NetFront|Netfront|Konqueror|SeaMonkey|Kazehakase|Vienna|Iceape|Iceweasel|IceWeasel|Iron|K-Meleon|Sleipnir|Galeon|GranParadiso|Opera Mini|iCab|NetNewsWire|ThunderBrowse|Iris|UP\.Browser|Bunjalloo|Google Earth|Raven for Mac|Openwave|MacOutlook)/(\d+)\.(\d+)\.(\d+)'
 3 | 
 4 | os_parsers:
 5 |   - regex: '((?:Mac ?|; )OS X)[\s/](?:(\d+)[_.](\d+)(?:[_.](\d+))?|Mach-O)'
 6 |     os_replacement: 'Mac OS X'
 7 | 
 8 | device_parsers:
 9 |   - regex: '(iPod)(?:;| touch;| Simulator;)'
10 |     device_replacement: '$1'
11 |     brand_replacement: 'Apple'
12 |     model_replacement: '$1'
13 | 


--------------------------------------------------------------------------------
/test/test_helper.exs:
--------------------------------------------------------------------------------
1 | ExUnit.start()
2 | 


--------------------------------------------------------------------------------
/test/ua_parser/device_test.exs:
--------------------------------------------------------------------------------
1 | defmodule UAParser.DeviceTest do
2 |   use ExUnit.Case
3 |   doctest UAParser.Device
4 | end
5 | 


--------------------------------------------------------------------------------
/test/ua_parser/operating_system_test.exs:
--------------------------------------------------------------------------------
1 | defmodule UAParser.OperatingSystemTest do
2 |   use ExUnit.Case
3 |   doctest UAParser.OperatingSystem
4 | end
5 | 


--------------------------------------------------------------------------------
/test/ua_parser/parser_test.exs:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.ParserTest do
 2 |   use ExUnit.Case
 3 | 
 4 |   alias UAParser.{Parser, Storage}
 5 | 
 6 |   @user_agent "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_7; en-us) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Safari/530.17 Skyfire/2.0"
 7 | 
 8 |   test "parse a user agent given patterns and a string" do
 9 |     %{family: family, os: os, version: version} = Parser.parse(Storage.list(), @user_agent)
10 | 
11 |     assert family == "Skyfire"
12 |     assert to_string(version) == "2.0"
13 |     assert os.family == "Mac OS X"
14 |     assert to_string(os.version) == "10.5.7"
15 |   end
16 | end
17 | 


--------------------------------------------------------------------------------
/test/ua_parser/parsers/device_test.exs:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parsers.DeviceTest do
 2 |   use ExUnit.Case
 3 | 
 4 |   alias UAParser.Parsers.Device, as: Parser
 5 |   alias UAParser.{Device, Storage}
 6 | 
 7 |   test "parses device information" do
 8 |     {_, _, [pattern | _]} = Storage.list()
 9 | 
10 |     result = Parser.parse({pattern, ["iPod;", "iPod"]})
11 |     assert %Device{family: "Spider", brand: "Spider", model: "Smartphone"} == result
12 |   end
13 | end
14 | 


--------------------------------------------------------------------------------
/test/ua_parser/parsers/operating_system_parser_test.exs:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parsers.OperatingSystemTest do
 2 |   use ExUnit.Case
 3 | 
 4 |   alias UAParser.Parsers.OperatingSystem, as: Parser
 5 |   alias UAParser.{OperatingSystem, Version}
 6 | 
 7 |   @pattern [
 8 |     regex: ~r/((?:Mac ?|; )OS X)[\s\/](?:(\d+)[_.](\d+)(?:[_.](\d+))?|Mach-O)/,
 9 |     os_replacement: "Mac OS X"
10 |   ]
11 |   @match ["Mac OS X 10_5_7", "Mac OS X", "10", "5", "7"]
12 | 
13 |   test "parses operating system information" do
14 |     result = Parser.parse({@pattern, @match})
15 |     version = %Version{major: "10", minor: "5", patch: "7"}
16 | 
17 |     assert %OperatingSystem{family: "Mac OS X", version: ^version} = result
18 |   end
19 | end
20 | 


--------------------------------------------------------------------------------
/test/ua_parser/parsers/user_agent_test.exs:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parsers.UATest do
 2 |   use ExUnit.Case
 3 | 
 4 |   alias UAParser.Parsers.UA, as: Parser
 5 |   alias UAParser.{UA, Version}
 6 | 
 7 |   @pattern [
 8 |     regex:
 9 |       ~r/\b(MobileIron|Crosswalk|AdobeAIR|FireWeb|Jasmine|ANTGalio|Midori|Fresco|Lobo|PaleMoon|Maxthon|Lynx|OmniWeb|Dillo|Camino|Demeter|Fluid|Fennec|Epiphany|Shiira|Sunrise|Spotify|Flock|Netscape|Lunascape|WebPilot|NetFront|Netfront|Konqueror|SeaMonkey|Kazehakase|Vienna|Iceape|Iceweasel|IceWeasel|Iron|K-Meleon|Sleipnir|Galeon|GranParadiso|Opera Mini|iCab|NetNewsWire|ThunderBrowse|Iris|UP\.Browser|Bunjalloo|Google Earth|Raven for Mac|Openwave|MacOutlook)\/(\d+)\.(\d+)\.(\d+)/
10 |   ]
11 |   @match ["AdobeAIR/2.5.1", "AdobeAIR", "2", "5", "1"]
12 | 
13 |   test "parses user agent information" do
14 |     result = Parser.parse({@pattern, @match})
15 |     version = %Version{major: "2", minor: "5", patch: "1"}
16 | 
17 |     assert %UA{family: "AdobeAIR", version: ^version} = result
18 |   end
19 | end
20 | 


--------------------------------------------------------------------------------
/test/ua_parser/parsers/version_test.exs:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.Parsers.VersionTest do
 2 |   use ExUnit.Case
 3 | 
 4 |   alias UAParser.Parsers.Version, as: Parser
 5 |   alias UAParser.Version
 6 | 
 7 |   @pattern [
 8 |     regex: ~r/((?:Mac ?|; )OS X)[\s\/](?:(\d+)[_.](\d+)(?:[_.](\d+))?|Mach-O)/,
 9 |     os_replacement: "Mac OS X"
10 |   ]
11 |   @match ["Mac OS X", "10", "5", "7"]
12 |   @replacement_keys [:not_used, :not_used, :not_used, :not_used]
13 | 
14 |   test "parses device information" do
15 |     result = Parser.parse({@pattern, @match}, @replacement_keys)
16 |     assert %Version{major: "10", minor: "5", patch: "7"} = result
17 |   end
18 | end
19 | 


--------------------------------------------------------------------------------
/test/ua_parser/processor_test.exs:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.ProcessorTest do
 2 |   use ExUnit.Case
 3 | 
 4 |   alias UAParser.Processor
 5 | 
 6 |   test "converts yaml document into data structure" do
 7 |     test_data =
 8 |       File.cwd!()
 9 |       |> Path.join("test/fixtures/patterns.yml")
10 |       |> :yamerl_constr.file()
11 | 
12 |     assert {[
13 |               [
14 |                 regex: %Regex{}
15 |               ]
16 |             ],
17 |             [
18 |               [
19 |                 regex: %Regex{},
20 |                 os_replacement: "Mac OS X"
21 |               ]
22 |             ],
23 |             [
24 |               [
25 |                 regex: %Regex{},
26 |                 device_replacement: "$1",
27 |                 brand_replacement: "Apple",
28 |                 model_replacement: "$1"
29 |               ]
30 |             ]} = Processor.process(test_data)
31 |   end
32 | end
33 | 


--------------------------------------------------------------------------------
/test/ua_parser/storage_test.exs:
--------------------------------------------------------------------------------
 1 | defmodule UAParser.StorageTest do
 2 |   use ExUnit.Case
 3 | 
 4 |   test "lists storage contents" do
 5 |     result = UAParser.Storage.list()
 6 | 
 7 |     assert is_tuple(result)
 8 |     assert tuple_size(result) == 3
 9 |   end
10 | end
11 | 


--------------------------------------------------------------------------------
/test/ua_parser/user_agent_test.exs:
--------------------------------------------------------------------------------
1 | defmodule UAParser.UATest do
2 |   use ExUnit.Case
3 |   doctest UAParser.UA
4 | end
5 | 


--------------------------------------------------------------------------------
/test/ua_parser/version_test.exs:
--------------------------------------------------------------------------------
1 | defmodule UAParser.VersionTest do
2 |   use ExUnit.Case
3 |   doctest UAParser.Version
4 | end
5 | 


--------------------------------------------------------------------------------
/test/ua_parser_test.exs:
--------------------------------------------------------------------------------
 1 | defmodule UAParserTest do
 2 |   use ExUnit.Case
 3 |   doctest UAParser
 4 | 
 5 |   @user_agent "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_7; en-us) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Safari/530.17 Skyfire/2.0"
 6 | 
 7 |   test "parse user_agent using default patterns" do
 8 |     ua = UAParser.parse(@user_agent)
 9 |     assert to_string(ua) == "Skyfire 2.0"
10 |     assert to_string(ua.os) == "Mac OS X 10.5.7"
11 |     assert to_string(ua.device) == "Mac"
12 |   end
13 | 
14 |   test "parse user_agent using custom patterns" do
15 |     custom_patterns = {
16 |       [
17 |         [
18 |           regex: ~r/(Skyfire)\/(\d+)\.(\d+)(?:\.(\d+))?/,
19 |           family_replacement: "Testing Pattern $1"
20 |         ]
21 |       ],
22 |       [],
23 |       []
24 |     }
25 | 
26 |     ua = UAParser.parse(@user_agent, custom_patterns)
27 |     assert ua.family == "Testing Pattern Skyfire"
28 |     assert to_string(ua.version) == "2.0"
29 |   end
30 | end
31 | 


--------------------------------------------------------------------------------