curl {{ external_api_uri_subdomain }}/v1/messages \
+curl {{ api_url }}/v1/messages \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
-d "type=stream" \
-d "to=Denmark" \
@@ -56,7 +56,7 @@ Sample steps to do:
Private message
-curl {{ external_api_uri_subdomain }}/v1/messages \
+curl {{ api_url }}/v1/messages \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
-d "type=private" \
-d "to=hamlet@example.com" \
@@ -74,7 +74,7 @@ Sample steps to do:
# Keyword arguments 'email' and 'api_key' are not required if you are using ~/.zuliprc
client = zulip.Client(email="othello-bot@example.com",
api_key="a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5",
- site="{{ external_api_uri_subdomain }}")
+ site="{{ api_url }}")
# Send a stream message
client.send_message({
"type": "stream",
@@ -107,19 +107,19 @@ Sample steps to do:
Stream message
zulip-send --stream Denmark --subject Castle \
--user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
---site={{ external_api_uri_subdomain }}
+--site={{ api_url }}
Private message
zulip-send hamlet@example.com \
--user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
---site={{ external_api_uri_subdomain }}
+--site={{ api_url }}
Passing in the message on the command-line
If you'd like, you can also provide the message on the command-line with the -m flag, as follows:
zulip-send --stream Denmark --subject Castle \
-m "Something is rotten in the state of Denmark." \
--user othello-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
---site={{ external_api_uri_subdomain }}
+--site={{ api_url }}
You can omit the user, api-key, and
@@ -137,7 +137,7 @@ Sample steps to do:
const config = {
username: 'othello-bot@example.com',
apiKey: 'a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5',
- realm: '{{ external_api_uri_subdomain }}'
+ realm: '{{ api_url }}'
};
const client = zulip(config);
@@ -192,7 +192,7 @@ Sample steps to do:
[api]
key=BOT_API_KEY
email=BOT_EMAIL_ADDRESS
-site={{ external_api_uri_subdomain }}
+site={{ api_url }}Additionally, you can also specify the parameters as environment variables as follows:
export ZULIP_CONFIG=/path/to/zulipconfig diff --git a/templates/zerver/help/include/git-webhook-url-with-branches.md b/templates/zerver/help/include/git-webhook-url-with-branches.md index 3381e4877e..b4613907b7 100644 --- a/templates/zerver/help/include/git-webhook-url-with-branches.md +++ b/templates/zerver/help/include/git-webhook-url-with-branches.md @@ -2,4 +2,4 @@ You can also limit the branches you receive notifications for by specifying them in a comma-separated list at the end of the URL, like so: -`{{ external_api_uri_subdomain }}{{ integration_url }}?api_key=abcdefgh&stream={{ recommended_stream_name }}&branches=master,development` +`{{ api_url }}{{ integration_url }}?api_key=abcdefgh&stream={{ recommended_stream_name }}&branches=master,development` diff --git a/templates/zerver/help/include/webhook-url-with-bot-email.md b/templates/zerver/help/include/webhook-url-with-bot-email.md index 95734dda41..3fe54ada9f 100644 --- a/templates/zerver/help/include/webhook-url-with-bot-email.md +++ b/templates/zerver/help/include/webhook-url-with-bot-email.md @@ -1,6 +1,6 @@ In the URL field, enter: -`{{ external_uri_scheme }}bot_email:bot_api_key@{{ external_api_path_subdomain }}{{ integration_url }}` +`{{ external_uri_scheme }}bot_email:bot_api_key@{{ api_url_scheme_relative }}{{ integration_url }}` Replace `bot_email` and `bot_api_key` above with the URL-encoded email address and API key of the bot. To URL-encode the email address, you diff --git a/templates/zerver/help/include/webhook-url.md b/templates/zerver/help/include/webhook-url.md index ff8ffe3933..2619c49a0b 100644 --- a/templates/zerver/help/include/webhook-url.md +++ b/templates/zerver/help/include/webhook-url.md @@ -1 +1 @@ -`{{ external_api_uri_subdomain }}{{ integration_url }}?api_key=abcdefgh&stream={{ recommended_stream_name }}` +`{{ api_url }}{{ integration_url }}?api_key=abcdefgh&stream={{ recommended_stream_name }}` diff --git a/templates/zerver/help/include/zulip-config.md b/templates/zerver/help/include/zulip-config.md index 3a7d62b7ac..f88fc7aec1 100644 --- a/templates/zerver/help/include/zulip-config.md +++ b/templates/zerver/help/include/zulip-config.md @@ -1,5 +1,5 @@ ``` ZULIP_USER = "{{ integration_name }}-bot@example.com" ZULIP_API_KEY = "0123456789abcdef0123456789abcdef" -ZULIP_SITE = "{{ external_api_uri_subdomain }}" +ZULIP_SITE = "{{ api_url }}" ``` diff --git a/templates/zerver/integrations/asana.md b/templates/zerver/integrations/asana.md index 495ac243a0..569c7ddf64 100644 --- a/templates/zerver/integrations/asana.md +++ b/templates/zerver/integrations/asana.md @@ -6,7 +6,7 @@ Next, on your {{ settings_html|safe }}, create a bot for Asana. Construct the URL for the Asana bot using the bot API key and stream name, like so: -`{{ external_api_uri_subdomain }}/v1/external/zapier?api_key=abcdefgh&stream=asana` +`{{ api_url }}/v1/external/zapier?api_key=abcdefgh&stream=asana` Start by setting up a [Zapier](https://zapier.com/) account. diff --git a/templates/zerver/integrations/capistrano.md b/templates/zerver/integrations/capistrano.md index d7178af6ee..37a7232f74 100644 --- a/templates/zerver/integrations/capistrano.md +++ b/templates/zerver/integrations/capistrano.md @@ -16,7 +16,7 @@ namespace :notify do # ~/.zuliprc if you omit --user and --api-key run_locally "echo ':beers: I just deployed to #{stage}! :beers:' | zulip-send \ --user capistrano-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \ - --site={{ external_api_uri_subdomain }} \ + --site={{ api_url }} \ --stream commits --subject deployments || true" end end diff --git a/templates/zerver/integrations/hubot.md b/templates/zerver/integrations/hubot.md index f962dc01f8..4b480f4199 100644 --- a/templates/zerver/integrations/hubot.md +++ b/templates/zerver/integrations/hubot.md @@ -15,7 +15,7 @@ variables by running: ``` -export HUBOT_ZULIP_SITE="{{ external_api_path_subdomain }}" +export HUBOT_ZULIP_SITE="{{ api_url_scheme_relative }}" export HUBOT_ZULIP_BOT="hubot-bot@example.com" export HUBOT_ZULIP_API_KEY="your_key" ``` diff --git a/templates/zerver/integrations/jira-plugin.md b/templates/zerver/integrations/jira-plugin.md index 7c1b5fb1c3..2d34e31443 100644 --- a/templates/zerver/integrations/jira-plugin.md +++ b/templates/zerver/integrations/jira-plugin.md @@ -28,7 +28,7 @@ default in the Java installation shipped with JIRA, you will need to tell JIRA about the certificate. 1. Navigate to **Administration > System > Configure SSL** and in the - **Import SSL Certificates** field, enter `{{ external_api_uri_subdomain }}`. + **Import SSL Certificates** field, enter `{{ api_url }}`. 2. After clicking **Save Certificates**, follow the on-screen instructions and restart JIRA for it to recognize the proper diff --git a/templates/zerver/integrations/mercurial.md b/templates/zerver/integrations/mercurial.md index 78dcb4b6ac..d2dd083f9a 100644 --- a/templates/zerver/integrations/mercurial.md +++ b/templates/zerver/integrations/mercurial.md @@ -20,7 +20,7 @@ hook if it installs in a different location on this system: email = "hg-bot@example.com" api_key = "0123456789abcdefg" stream = "commits" - site = {{ external_api_uri_subdomain }} + site = {{ api_url }} That’s all it takes for the basic setup! On the next `hg push`, you’ll get a Zulip update for the changeset. @@ -44,7 +44,7 @@ notifications: api_key = "0123456789abcdefg" stream = "commits" web_url = "http://hg.example.com:8000/" - site = {{ external_api_uri_subdomain }} + site = {{ api_url }} [1]: http://mercurial.selenic.com/wiki/QuickStart#Network_support diff --git a/templates/zerver/integrations/nagios.md b/templates/zerver/integrations/nagios.md index 30b874db77..9d918357b7 100644 --- a/templates/zerver/integrations/nagios.md +++ b/templates/zerver/integrations/nagios.md @@ -14,7 +14,7 @@ on your Nagios server: [api] email = NAGIOS_BOT_EMAIL_ADDRESS key = NAGIOS_BOT_API_KEY -site = {{ external_api_uri_subdomain }} +site = {{ api_url }} ``` Copy `integrations/nagios/zulip_nagios.cfg` to `/etc/nagios3/conf.d` diff --git a/templates/zerver/integrations/redmine.md b/templates/zerver/integrations/redmine.md index e393cd9e9b..bfdc7dc202 100644 --- a/templates/zerver/integrations/redmine.md +++ b/templates/zerver/integrations/redmine.md @@ -39,7 +39,7 @@ you want these settings to apply. To configure Zulip notifications for a particular Redmine project, visit the project's **Settings** page. -In either case, fill out zulip server by `{{ external_api_path_subdomain }}` +In either case, fill out zulip server by `{{ api_url_scheme_relative }}` the bot email address, and API key, and the Zulip stream that should receive notifications. Apply your changes. diff --git a/tools/linter_lib/custom_check.py b/tools/linter_lib/custom_check.py index 46406d386b..3a4fb41eeb 100644 --- a/tools/linter_lib/custom_check.py +++ b/tools/linter_lib/custom_check.py @@ -95,7 +95,7 @@ def custom_check_file(fn, identifier, rules, color, skip_rules=None, max_length= if (max_length is not None and line_length > max_length and '# type' not in line and 'test' not in fn and 'example' not in fn and not re.match("\[[ A-Za-z0-9_:,&()-]*\]: http.*", line) and - not re.match("`\{\{ external_api_uri_subdomain \}\}[^`]+`", line) and + not re.match("`\{\{ api_url \}\}[^`]+`", line) and "#ignorelongline" not in line and 'migrations' not in fn): print("Line too long (%s) at %s line %s: %s" % (len(line), fn, i+1, line_newline_stripped)) failed = True diff --git a/zerver/tests/test_docs.py b/zerver/tests/test_docs.py index 94ee453d81..74c8ef6cab 100644 --- a/zerver/tests/test_docs.py +++ b/zerver/tests/test_docs.py @@ -119,8 +119,8 @@ class IntegrationTest(TestCase): # type: () -> None context = dict() # type: Dict[str, Any] add_api_uri_context(context, HostRequestMock()) - self.assertEqual(context["external_api_path_subdomain"], "testserver/api") - self.assertEqual(context["external_api_uri_subdomain"], "http://testserver/api") + self.assertEqual(context["api_url_scheme_relative"], "testserver/api") + self.assertEqual(context["api_url"], "http://testserver/api") self.assertTrue(context["html_settings_links"]) @override_settings(ROOT_DOMAIN_LANDING_PAGE=True) @@ -128,8 +128,8 @@ class IntegrationTest(TestCase): # type: () -> None context = dict() # type: Dict[str, Any] add_api_uri_context(context, HostRequestMock()) - self.assertEqual(context["external_api_path_subdomain"], "yourZulipDomain.testserver/api") - self.assertEqual(context["external_api_uri_subdomain"], "http://yourZulipDomain.testserver/api") + self.assertEqual(context["api_url_scheme_relative"], "yourZulipDomain.testserver/api") + self.assertEqual(context["api_url"], "http://yourZulipDomain.testserver/api") self.assertFalse(context["html_settings_links"]) def test_api_url_view_subdomains_full(self): @@ -137,8 +137,8 @@ class IntegrationTest(TestCase): context = dict() # type: Dict[str, Any] request = HostRequestMock(host="mysubdomain.testserver") add_api_uri_context(context, request) - self.assertEqual(context["external_api_path_subdomain"], "mysubdomain.testserver/api") - self.assertEqual(context["external_api_uri_subdomain"], "http://mysubdomain.testserver/api") + self.assertEqual(context["api_url_scheme_relative"], "mysubdomain.testserver/api") + self.assertEqual(context["api_url"], "http://mysubdomain.testserver/api") self.assertTrue(context["html_settings_links"]) def test_integration_view_html_settings_links(self): diff --git a/zerver/views/integrations.py b/zerver/views/integrations.py index 64340b06a1..eb6a8c2935 100644 --- a/zerver/views/integrations.py +++ b/zerver/views/integrations.py @@ -27,16 +27,15 @@ def add_api_uri_context(context, request): display_subdomain = 'yourZulipDomain' html_settings_links = False if display_subdomain != Realm.SUBDOMAIN_FOR_ROOT_DOMAIN: - external_api_path_subdomain = '%s.%s/api' % (display_subdomain, + api_url_scheme_relative = '%s.%s/api' % (display_subdomain, settings.EXTERNAL_HOST) else: - external_api_path_subdomain = settings.EXTERNAL_HOST + "/api" + api_url_scheme_relative = settings.EXTERNAL_HOST + "/api" - external_api_uri_subdomain = '%s%s' % (settings.EXTERNAL_URI_SCHEME, - external_api_path_subdomain) + api_url = '%s%s' % (settings.EXTERNAL_URI_SCHEME, api_url_scheme_relative) - context['external_api_path_subdomain'] = external_api_path_subdomain - context['external_api_uri_subdomain'] = external_api_uri_subdomain + context['api_url_scheme_relative'] = api_url_scheme_relative + context['api_url'] = api_url context["html_settings_links"] = html_settings_links class ApiURLView(TemplateView): @@ -151,11 +150,11 @@ def api_endpoint_docs(request): langs = set() for call in calls: call["endpoint"] = "%s/v1/%s" % ( - context["external_api_uri_subdomain"], + context["api_url"], call["endpoint"]) call["example_request"]["curl"] = call["example_request"]["curl"].replace( "https://api.zulip.com", - context["external_api_uri_subdomain"]) + context["api_url"]) response = call['example_response'] if '\n' not in response: # For 1-line responses, pretty-print them diff --git a/zerver/webhooks/deskdotcom/doc.md b/zerver/webhooks/deskdotcom/doc.md index 53789944c3..de23c592d0 100644 --- a/zerver/webhooks/deskdotcom/doc.md +++ b/zerver/webhooks/deskdotcom/doc.md @@ -17,7 +17,7 @@ Fill in the form like this: * **Name**: Zulip * **Authentication Method**: Basic Auth -* **URL**: `{{ external_api_uri_subdomain }}/v1/external/deskdotcom` +* **URL**: `{{ api_url }}/v1/external/deskdotcom` * **User name**: *your bot's user name, e.g.* `desk-bot@yourdomain.com` * **Password**: *your bot's API key* diff --git a/zerver/webhooks/freshdesk/doc.md b/zerver/webhooks/freshdesk/doc.md index 2b22f72971..885ba22bcd 100644 --- a/zerver/webhooks/freshdesk/doc.md +++ b/zerver/webhooks/freshdesk/doc.md @@ -31,7 +31,7 @@ parts. 4. In the **Action** section, add a new action of type **Trigger Webhook**. Set the **Request Type** to **POST**. Set the following **Callback URL**, replacing the Zulip stream with your desired stream: - `{{ external_api_uri_subdomain }}/v1/external/freshdesk?stream=freshdesk` + `{{ api_url }}/v1/external/freshdesk?stream=freshdesk` 5. Check the **Requires Authentication** box, and supply the bot email address and API key. The **Action** section should look like this so @@ -103,7 +103,7 @@ changes, please continue to the next section. **Trigger Webhook**. Set the **Request Type** to **POST**. Set the following **Callback URL**, replacing the Zulip stream with your desired stream: - `{{ external_api_uri_subdomain }}/v1/external/freshdesk?stream=freshdesk` + `{{ api_url }}/v1/external/freshdesk?stream=freshdesk` 8. Check the **Requires Authentication** box, and supply the bot e-mail address and API key. The Action section should look like this so far: diff --git a/zerver/webhooks/github/doc.md b/zerver/webhooks/github/doc.md index 28274ec017..68d1888d92 100644 --- a/zerver/webhooks/github/doc.md +++ b/zerver/webhooks/github/doc.md @@ -22,7 +22,7 @@ To find the Zulip hook, you have to click on **Configure services**. Select **Zulip** from the list of service hooks. Fill in the API key and email address for your bot that you created earlier and check the **"active"** checkbox. Specify -`{{ external_api_uri_subdomain }}/v1/external/github` as the +`{{ api_url }}/v1/external/github` as the **Alternative endpoint**. You can optionally supply the Zulip stream (the default is `commits`) and restrict Zulip notifications to a specified set of branches. diff --git a/zerver/webhooks/helloworld/doc.md b/zerver/webhooks/helloworld/doc.md index 9333dca313..ca549fcafe 100644 --- a/zerver/webhooks/helloworld/doc.md +++ b/zerver/webhooks/helloworld/doc.md @@ -8,7 +8,7 @@ Next, on your {{ settings_html|safe }}, create a Hello World bot. Construct the URL for the Hello World bot using the API key and stream name: -`{{ external_api_uri_subdomain }}/v1/external/helloworld?api_key=abcdefgh&stream=test` +`{{ api_url }}/v1/external/helloworld?api_key=abcdefgh&stream=test` To trigger a notification using this webhook, use diff --git a/zerver/webhooks/homeassistant/doc.md b/zerver/webhooks/homeassistant/doc.md index 5a63cc7dc9..f8fed2e89a 100644 --- a/zerver/webhooks/homeassistant/doc.md +++ b/zerver/webhooks/homeassistant/doc.md @@ -14,7 +14,7 @@ the `homeassistant` stream. And the URL under `resource` should start with: -`{{ external_api_uri_subdomain }}/v1/external/homeassistant` +`{{ api_url }}/v1/external/homeassistant` Finally, you need to configure a trigger for the service by adding an automation entry in the HomeAssistant `configuration.yaml` file. diff --git a/zerver/webhooks/travis/doc.md b/zerver/webhooks/travis/doc.md index 06c9797d56..a76f87e4b5 100644 --- a/zerver/webhooks/travis/doc.md +++ b/zerver/webhooks/travis/doc.md @@ -9,7 +9,7 @@ Finally, set up a webhook in your `.travis.yml` file: ``` notifications: webhooks: -- {{ external_api_uri_subdomain }}/v1/external/travis?stream=travis&topic=build-status&api_key=abcdefgh +- {{ api_url }}/v1/external/travis?stream=travis&topic=build-status&api_key=abcdefgh ``` By default, pull request events are ignored since most people diff --git a/zerver/webhooks/yo/doc.md b/zerver/webhooks/yo/doc.md index 8fc6b51f3d..ea9f2ad389 100644 --- a/zerver/webhooks/yo/doc.md +++ b/zerver/webhooks/yo/doc.md @@ -5,7 +5,7 @@ First, on your {{ settings_html|safe }}, create a bot for {{ integration_display_name }} bot using the bot API key and the email address associated with your Zulip account: -`{{ external_api_uri_subdomain }}{{ integration_url }}?api_key=abcdefgh&email=awesome@zulip.example.com` +`{{ api_url }}{{ integration_url }}?api_key=abcdefgh&email=awesome@zulip.example.com` Modify the parameters of the URL above, where `api_key` is the API key of your Zulip bot. diff --git a/zerver/webhooks/zendesk/doc.md b/zerver/webhooks/zendesk/doc.md index c9c830cd1e..77a4269be8 100644 --- a/zerver/webhooks/zendesk/doc.md +++ b/zerver/webhooks/zendesk/doc.md @@ -4,7 +4,7 @@ Next, on your {{ settings_html|safe }}, create a bot. Construct a webhook URL like the following: -`{{ external_api_uri_subdomain }}/v1/external/zendesk?ticket_title={% raw %}{{ ticket.title }}&ticket_id={{ ticket.id }}{% endraw %}` +`{{ api_url }}/v1/external/zendesk?ticket_title={% raw %}{{ ticket.title }}&ticket_id={{ ticket.id }}{% endraw %}` {!append-stream-name.md!}