From 2175a2f4d9a416f4a443166a2487c8c12a3df9e2 Mon Sep 17 00:00:00 2001 From: kballou Date: Tue, 26 Jul 2016 12:39:08 -0600 Subject: ExPing: Initial Commit --- .gitignore | 6 ++ .travis.yml | 13 +++ LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 32 ++++++++ config/config.exs | 3 + config/dev.exs | 1 + config/prod.exs | 1 + config/test.exs | 1 + lib/exping.ex | 5 ++ lib/exping/application.ex | 14 ++++ lib/exping/supervisor.ex | 20 +++++ mix.exs | 43 ++++++++++ mix.lock | 3 + test/exping_test.exs | 5 ++ test/test_helper.exs | 1 + 15 files changed, 349 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 config/config.exs create mode 100644 config/dev.exs create mode 100644 config/prod.exs create mode 100644 config/test.exs create mode 100644 lib/exping.ex create mode 100644 lib/exping/application.ex create mode 100644 lib/exping/supervisor.ex create mode 100644 mix.exs create mode 100644 mix.lock create mode 100644 test/exping_test.exs create mode 100644 test/test_helper.exs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..008b35d --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +/_build +/cover +/deps +/doc +erl_crash.dump +*.ez diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..ac6ec90 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +language: elixir +elixir: + - 1.2 + - 1.3 +otp_release: + - 18.3 + - 19.0 + +script: + - MIX_ENV=dev mix do deps.get, dialyzer.plt + - MIX_ENV=dev mix dialyzer --halt-exit-status + - MIX_ENV=dev mix credo --strict + - MIX_ENV=test mix do deps.get, test diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4c9ad98 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5268c20 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# ExPing # + +Test service availablility through a series of requests. + +## Installation ## + +The package can be installed as: + +1. Add `exping` to your list of dependencies in `mix.exs`: + +```elixir +def deps do + [{:exping, "~> 0.1.0"}] +end +``` + +2. Ensure `exping` is started before your application: + +```elixir +def application do + [applications: [:exping]] +end +``` + +## License ## + +This code is provided AS-IS, WITHOUT any warranty, expressed or implied, under +the terms and conditions of the Apache, version 2.0, license. For more +information, see the provided LICENSE file. If your distribution did not come +with a LICENSE file, you may read about the terms [online][1]. + +[1]: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/config/config.exs b/config/config.exs new file mode 100644 index 0000000..c9c59bb --- /dev/null +++ b/config/config.exs @@ -0,0 +1,3 @@ +use Mix.Config + +import_config "#{Mix.env}.exs" diff --git a/config/dev.exs b/config/dev.exs new file mode 100644 index 0000000..d2d855e --- /dev/null +++ b/config/dev.exs @@ -0,0 +1 @@ +use Mix.Config diff --git a/config/prod.exs b/config/prod.exs new file mode 100644 index 0000000..d2d855e --- /dev/null +++ b/config/prod.exs @@ -0,0 +1 @@ +use Mix.Config diff --git a/config/test.exs b/config/test.exs new file mode 100644 index 0000000..d2d855e --- /dev/null +++ b/config/test.exs @@ -0,0 +1 @@ +use Mix.Config diff --git a/lib/exping.ex b/lib/exping.ex new file mode 100644 index 0000000..056bfda --- /dev/null +++ b/lib/exping.ex @@ -0,0 +1,5 @@ +defmodule ExPing do + @moduledoc """ + Public API for ExPing + """ +end diff --git a/lib/exping/application.ex b/lib/exping/application.ex new file mode 100644 index 0000000..33fce39 --- /dev/null +++ b/lib/exping/application.ex @@ -0,0 +1,14 @@ +defmodule ExPing.Application do + use Application + @moduledoc """ + Application definition for ExPing + """ + + @doc """ + Start ExPing OTP Application + """ + @spec start(any, any) :: {:ok, pid} | {:error, any} + def start(_, _) do + ExPing.Supervisor.start_link() + end +end diff --git a/lib/exping/supervisor.ex b/lib/exping/supervisor.ex new file mode 100644 index 0000000..403f35c --- /dev/null +++ b/lib/exping/supervisor.ex @@ -0,0 +1,20 @@ +defmodule ExPing.Supervisor do + use Supervisor + + @moduledoc """ + ExPing Supervision Tree + """ + + @spec start_link :: {:ok, pid} | {:error, any} + def start_link do + Supervisor.start_link(__MODULE__, []) + end + + @spec init(any) :: no_return + def init(_) do + children = [ + ] + + supervise(children, strategy: :one_for_one, name: __MODULE__) + end +end diff --git a/mix.exs b/mix.exs new file mode 100644 index 0000000..04f15ce --- /dev/null +++ b/mix.exs @@ -0,0 +1,43 @@ +defmodule ExPing.Mixfile do + use Mix.Project + + def project do + [app: :exping, + description: "ExPing", + package: package(), + version: "0.1.0", + elixir: "~> 1.3", + elixirc_paths: elixirc_paths(Mix.env), + build_embedded: Mix.env == :prod, + start_permanent: Mix.env == :prod, + dialyzer: dialyzer(), + deps: deps()] + end + + defp elixirc_paths(:test), do: ["lib", "test/support"] + defp elixirc_paths(_), do: ["lib"] + + def application do + [applications: [:logger, :inets], + mod: {ExPing.Application, []}] + end + + defp deps do + [{:dialyxir, "~> 0.3.5", only: :dev}, + {:credo, "~> 0.4.7", only: :dev}] + end + + defp package do + [maintainers: ["Kenny Ballou"], + licenses: ["Apache 2.0"], + links: %{"Git" => "https://git.devnulllabs.io/exping.git", + "GitHub" => "https://github.com/kennyballou/exping.git", + "Hex" => "https://hex.pm/packages/exping"}, + files: ~w(mix.exs README.md LICENSE lib)] + end + + defp dialyzer do + [plt_add_apps: [:inets], plt_add_deps: :transitive] + end + +end diff --git a/mix.lock b/mix.lock new file mode 100644 index 0000000..9253cba --- /dev/null +++ b/mix.lock @@ -0,0 +1,3 @@ +%{"bunt": {:hex, :bunt, "0.1.6", "5d95a6882f73f3b9969fdfd1953798046664e6f77ec4e486e6fafc7caad97c6f", [:mix], []}, + "credo": {:hex, :credo, "0.4.7", "1516ebd3c6099eff74ed0ef50637f0a43113c3f65338a9e1792efc03dff34855", [:mix], [{:bunt, "~> 0.1.6", [hex: :bunt, optional: false]}]}, + "dialyxir": {:hex, :dialyxir, "0.3.5", "eaba092549e044c76f83165978979f60110dc58dd5b92fd952bf2312f64e9b14", [:mix], []}} diff --git a/test/exping_test.exs b/test/exping_test.exs new file mode 100644 index 0000000..ddcb7db --- /dev/null +++ b/test/exping_test.exs @@ -0,0 +1,5 @@ +defmodule ExPing.Test do + use ExUnit.Case + doctest ExPing + +end diff --git a/test/test_helper.exs b/test/test_helper.exs new file mode 100644 index 0000000..869559e --- /dev/null +++ b/test/test_helper.exs @@ -0,0 +1 @@ +ExUnit.start() -- cgit v1.2.1