Skip to content

Commit 4bdb8c3

Browse files
author
Bradford Folkens
committed
Initial commit
0 parents  commit 4bdb8c3

11 files changed

+655
-0
lines changed

‎.formatter.exs

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Used by "mix format"
2+
[
3+
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
4+
]

‎.gitignore

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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 third-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+
wind-*.tar
24+
25+
# Temporary files, for example, from tests.
26+
/tmp/

‎CHANGELOG.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
6+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## 0.0.1 - 2023-03-17
9+
10+
- Initial implementation
11+
- includes basic tools to build websocket clients, more to come...

‎LICENSE

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎README.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Wind
2+
3+
`Wind`. A pleasant Elixir websocket client framework, based on Mint.
4+
5+
## Installation
6+
7+
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
8+
by adding `wind` to your list of dependencies in `mix.exs`:
9+
10+
```elixir
11+
def deps do
12+
[
13+
{:wind, "~> 0.1.0"}
14+
]
15+
end
16+
```
17+
18+
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
19+
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
20+
be found at <https://hexdocs.pm/wind>.
21+
22+
## Example
23+
24+
Below is a minimal example to show how you could create a websocket client.
25+
26+
```elixir
27+
defmodule BinanceMonitor do
28+
use Wind.Stream
29+
30+
def start_link() do
31+
uri = URI.new!("wss://data-stream.binance.com/ws")
32+
Wind.Stream.start_link(__MODULE__, uri: uri)
33+
end
34+
35+
def handle_connect(state) do
36+
message = Jason.encode!(%{method: "SUBSCRIBE", params: ["btcusdt@aggTrade"], id: 1})
37+
{:reply, {:text, message}, state}
38+
end
39+
40+
def handle_frame({:text, message}, state) do
41+
data = Jason.decode!(message)
42+
IO.inspect(data)
43+
44+
{:noreply, state}
45+
end
46+
end
47+
```

‎lib/wind.ex

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
defmodule Wind do
2+
@moduledoc """
3+
`Wind`. A pleasant Elixir websocket client framework, based on Mint.
4+
"""
5+
6+
@doc """
7+
Statelessly connect to a websocket URL. This is a convenience function
8+
around Mint that establishes a connection to `uri` and then subsequently
9+
upgrades the connection.
10+
11+
## Examples
12+
13+
iex> URL.new!("wss://socketsbay.com/wss/v2/1/demo/") |> Wind.connect()
14+
{:ok, conn, ref}
15+
16+
"""
17+
@spec connect(URI.t(), list, list) ::
18+
{:ok, Mint.HTTP.t(), Mint.Types.request_ref()}
19+
| {:error, Mint.Types.error()}
20+
| {:error, Mint.HTTP.t(), Mint.WebSocket.error()}
21+
def connect(uri, headers \\ [], opts \\ []) do
22+
http_scheme =
23+
case uri.scheme do
24+
"ws" -> :http
25+
"wss" -> :https
26+
end
27+
28+
ws_scheme =
29+
case uri.scheme do
30+
"ws" -> :ws
31+
"wss" -> :wss
32+
end
33+
34+
path =
35+
case uri.query do
36+
nil -> uri.path
37+
query -> uri.path <> "?" <> query
38+
end
39+
40+
# We need verify_none to use the ssh tunnel. Keep this until we set up WS proxy.
41+
with {:ok, conn} <- Mint.HTTP.connect(http_scheme, uri.host, uri.port, opts),
42+
{:ok, conn, ref} <- Mint.WebSocket.upgrade(ws_scheme, conn, path || "/", headers) do
43+
{:ok, conn, ref}
44+
end
45+
end
46+
47+
@doc """
48+
Statelessly setup a websocket connection. This is a convenience function that
49+
wraps Mint.WebSocket the setup functions for a websocket.
50+
51+
## Examples
52+
53+
iex> Wind.setup(conn, ref, http_reply_message)
54+
{:ok, conn, ref, websocket}
55+
56+
"""
57+
@spec setup(Mint.HTTP.t(), Mint.Types.request_ref(), term, list) ::
58+
{:ok, Mint.HTTP.t(), Mint.Types.request_ref(), Mint.WebSocket.t()}
59+
| {:error, Mint.HTTP.t(), Mint.Types.error(), [Mint.Types.response()]}
60+
| :unknown
61+
def setup(conn, ref, http_reply_message, opts \\ []) do
62+
with {:ok, conn, [{:status, ^ref, status}, {:headers, ^ref, resp_headers}, {:done, ^ref}]} <-
63+
Mint.WebSocket.stream(conn, http_reply_message),
64+
{:ok, conn, websocket} <- Mint.WebSocket.new(conn, ref, status, resp_headers, opts) do
65+
{:ok, conn, ref, websocket}
66+
end
67+
end
68+
69+
@doc """
70+
Synchronously setup a websocket connection. See `setup/3`.
71+
72+
## Examples
73+
74+
iex> Wind.setup_await(conn, ref)
75+
{:ok, conn, ref, websocket}
76+
77+
"""
78+
@spec setup_await(Mint.HTTP.t(), Mint.Types.request_ref()) ::
79+
{:ok, Mint.HTTP.t(), Mint.Types.request_ref(), Mint.WebSocket.t()}
80+
| {:error, Mint.HTTP.t(), Mint.Types.error(), [Mint.Types.response()]}
81+
| :unknown
82+
def setup_await(conn, ref) do
83+
http_reply_message = receive(do: (message -> message))
84+
setup(conn, ref, http_reply_message)
85+
end
86+
87+
@doc """
88+
Statelessly decode a websocket message. This is a convenience function that
89+
wraps Mint.WebSocket `stream/2` and `decode/2` functions.
90+
91+
## Examples
92+
93+
iex> Wind.decode(conn, ref, websocket, message)
94+
{:ok, conn, websocket, data}
95+
96+
"""
97+
@spec decode(Mint.HTTP.t(), Mint.Types.request_ref(), Mint.WebSocket.t(), term()) ::
98+
{:ok, Mint.HTTP.t(), Mint.Types.request_ref(), Mint.WebSocket.t(),
99+
[Mint.WebSocket.frame() | {:error, term}]}
100+
| {:error, Mint.WebSocket.t(), any}
101+
def decode(conn, ref, websocket, message) do
102+
with {:ok, conn, [{:data, ^ref, data}]} <- Mint.WebSocket.stream(conn, message),
103+
{:ok, websocket, data} <- Mint.WebSocket.decode(websocket, data) do
104+
{:ok, conn, websocket, data}
105+
end
106+
end
107+
108+
@doc """
109+
Statelessly send a websocket message. This is a convenience function that
110+
wraps Mint.WebSocket the `encode/2` and `stream_request_body/3` functions.
111+
112+
## Examples
113+
114+
iex> Wind.decode(conn, ref, websocket, message)
115+
{:ok, conn, websocket}
116+
117+
"""
118+
@spec send(Mint.HTTP.t(), Mint.Types.request_ref(), Mint.WebSocket.t(), term()) ::
119+
{:ok, Mint.HTTP.t(), Mint.WebSocket.t()}
120+
| {:error, Mint.WebSocket.t(), any}
121+
| {:error, Mint.HTTP.t(), Mint.WebSocket.error()}
122+
def send(conn, ref, websocket, message) do
123+
with {:ok, websocket, data} <- Mint.WebSocket.encode(websocket, message),
124+
{:ok, conn} <- Mint.WebSocket.stream_request_body(conn, ref, data) do
125+
{:ok, conn, websocket}
126+
end
127+
end
128+
end

0 commit comments

Comments
 (0)