{"id":15019067,"url":"https://github.com/scrogson/romeo","last_synced_at":"2025-04-07T12:10:19.243Z","repository":{"id":57544749,"uuid":"46234958","full_name":"scrogson/romeo","owner":"scrogson","description":"An XMPP Client for Elixir","archived":false,"fork":false,"pushed_at":"2019-11-19T07:02:16.000Z","size":154,"stargazers_count":83,"open_issues_count":8,"forks_count":61,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-04T22:43:27.081Z","etag":null,"topics":["client","elixir","xmpp"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scrogson.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-15T20:42:26.000Z","updated_at":"2025-02-08T14:46:42.000Z","dependencies_parsed_at":"2022-09-16T23:01:16.000Z","dependency_job_id":null,"html_url":"https://github.com/scrogson/romeo","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrogson%2Fromeo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrogson%2Fromeo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrogson%2Fromeo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrogson%2Fromeo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scrogson","download_url":"https://codeload.github.com/scrogson/romeo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648977,"owners_count":20972945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client","elixir","xmpp"],"created_at":"2024-09-24T19:52:56.095Z","updated_at":"2025-04-07T12:10:19.218Z","avatar_url":"https://github.com/scrogson.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Romeo\n\n\u003e XMPP Client\n\n[![Build Status](https://travis-ci.org/scrogson/romeo.svg?branch=master)](https://travis-ci.org/scrogson/romeo)\n[![Coverage Status](https://coveralls.io/repos/scrogson/romeo/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/scrogson/romeo?branch=master)\n\n## Installation\n\n1. Add romeo to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [{:romeo, \"~\u003e 0.7\"}]\nend\n```\n\n2. Ensure romeo is started before your application:\n\n```elixir\ndef application do\n  [applications: [:romeo]]\nend\n```\n\n## Usage\n\n```elixir\nalias Romeo.Stanza\nalias Romeo.Connection, as: Conn\nalias Romeo.Roster\n\n# Minimum configuration options\nopts = [jid: \"romeo@montague.lit\", password: \"iL0v3JuL137\"]\n\n# Start the client\n{:ok, pid} = Conn.start_link(opts)\n\n# Send presence to the server\n:ok = Conn.send(pid, Stanza.presence)\n\n# Request your roster\n:ok = Conn.send(pid, Stanza.get_roster)\n\n# Join a chat room\n:ok = Conn.send(pid, Stanza.join(\"library@muc.montague.lit\", \"romeo\"))\n\n# Send a message to the room\nmsg = \"See how she leans her cheek upon her hand! \" \u003c\u003e\n      \"O that I were a glove upon that hand, that \" \u003c\u003e\n      \"I might touch that cheek!\"\n:ok = Conn.send(pid, Stanza.groupchat(\"library@muc.montague.lit\", msg))\n\n# Get roster items as tuple of %Romeo.Roster.Items{} struct\nitems = Roster.items(pid)\n\n# Add jid to roster\n:ok = Roster.add(pid, \"juliet@capulet.lit\")\n\n# Remove jid from roster\n:ok = Roster.remove(pid, \"juliet@capulet.lit\")\n```\n\n## Documentation\n\nDocumentation is available on [hexdocs](http://hexdocs.pm/romeo/)\n\n## Naming\n\nIt follows the great tradition to use characters of William Shakespeare's Romeo\nand Juliet in the XMPP specifications.\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2015 Sonny Scroggin\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n------------\n\n![Romeo and Juliet](https://upload.wikimedia.org/wikipedia/commons/c/cc/Picou%2C_Henri_Pierre_-_Romeo_and_Juliet.jpg\n\"Henri-Pierre Picou [Public domain], via Wikimedia Commons\")\n**Image credit:** Henri-Pierre Picou [Public domain], via Wikimedia Commons\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrogson%2Fromeo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscrogson%2Fromeo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrogson%2Fromeo/lists"}