From 009421163c5ad390964a8063f1aceef62387b027 Mon Sep 17 00:00:00 2001 From: marco ranieri Date: Tue, 14 Jun 2022 16:48:12 +0100 Subject: [PATCH 1/5] APIDOC-166: Algolia BLOG search --- .../app/views/search/_result.html.erb | 20 +++++++++++ .../app/views/search/results.html.erb | 4 ++- .../app/views/static/404.html.erb | 3 ++ .../javascript/components/search/Blog.vue | 33 +++++++++++++++++++ .../javascript/components/search/Search.vue | 13 ++++++-- .../webpacker/stylesheets/layout/_search.scss | 3 +- .../config/initializers/algolia.rb | 2 +- 7 files changed, 73 insertions(+), 5 deletions(-) create mode 100644 lib/nexmo_developer/app/webpacker/javascript/components/search/Blog.vue diff --git a/lib/nexmo_developer/app/views/search/_result.html.erb b/lib/nexmo_developer/app/views/search/_result.html.erb index 2c176fa44..21861a2f1 100644 --- a/lib/nexmo_developer/app/views/search/_result.html.erb +++ b/lib/nexmo_developer/app/views/search/_result.html.erb @@ -12,6 +12,26 @@ <% end %> + <% if index_name == 'prod_blogposts' %> + +
+ <%= hit.category.name %> + <%= hit.tags.map(&:upcase).join(' | ') %> +

<%= hit.title %>

+ +

+ <%= sanitize(hit.description, tags: ['em']) %> +

+ + + + + <%= hit.author.name %> + +
+ + <% end %> + <% if index_name.include? 'nexmo_developer' %> diff --git a/lib/nexmo_developer/app/views/search/results.html.erb b/lib/nexmo_developer/app/views/search/results.html.erb index 13f53b662..f27f6185f 100644 --- a/lib/nexmo_developer/app/views/search/results.html.erb +++ b/lib/nexmo_developer/app/views/search/results.html.erb @@ -6,9 +6,11 @@
<% if index.index.include? 'nexmo_developer' %> -

Nexmo Developer

+

Vonage Developer

<% elsif index.index == 'zendesk_nexmo_articles' %>

Knowlegebase

+ <% elsif index.index == 'prod_blogposts' %> +

Blog

<% end %>
diff --git a/lib/nexmo_developer/app/views/static/404.html.erb b/lib/nexmo_developer/app/views/static/404.html.erb index 1854928c0..00b0c1e45 100644 --- a/lib/nexmo_developer/app/views/static/404.html.erb +++ b/lib/nexmo_developer/app/views/static/404.html.erb @@ -13,6 +13,9 @@ <% elsif index.index == 'zendesk_nexmo_articles' %>

Knowlegebase

<% end %> + <% elsif index.index == 'prod_blogposts' %> +

Blog

+ <% end %>
diff --git a/lib/nexmo_developer/app/webpacker/javascript/components/search/Blog.vue b/lib/nexmo_developer/app/webpacker/javascript/components/search/Blog.vue new file mode 100644 index 000000000..fab29a13a --- /dev/null +++ b/lib/nexmo_developer/app/webpacker/javascript/components/search/Blog.vue @@ -0,0 +1,33 @@ + + diff --git a/lib/nexmo_developer/app/webpacker/javascript/components/search/Search.vue b/lib/nexmo_developer/app/webpacker/javascript/components/search/Search.vue index 391966ddf..fbabd8136 100644 --- a/lib/nexmo_developer/app/webpacker/javascript/components/search/Search.vue +++ b/lib/nexmo_developer/app/webpacker/javascript/components/search/Search.vue @@ -47,6 +47,9 @@
+
+ +

No results

@@ -62,6 +65,7 @@ import algoliasearch from 'algoliasearch' import debounce from 'lodash/debounce' import NDPArticle from './NDPArticle.vue'; import ZendeskArticle from './ZendeskArticle.vue'; +import Blog from './Blog.vue'; export default { data: function() { @@ -107,7 +111,9 @@ export default { if (name == 'zendesk_nexmo_articles') { return 'Knowledgebase'; } else if (name.includes('nexmo_developer')) { - return 'Nexmo Developer'; + return 'Vonage Developer'; + } else if (name == 'prod_blogposts') { + return 'Blog'; } }, isZendeskArticle: function(result) { @@ -116,6 +122,9 @@ export default { isNDPArticle: function(result) { return result.index.includes('nexmo_developer'); }, + isBlog: function(result) { + return result.index == 'prod_blogposts'; + }, hitKey: function(result, hit) { return result.index + hit.objectID; }, @@ -204,7 +213,7 @@ export default { } }, components: { - ZendeskArticle, NDPArticle + ZendeskArticle, NDPArticle, Blog } } diff --git a/lib/nexmo_developer/app/webpacker/stylesheets/layout/_search.scss b/lib/nexmo_developer/app/webpacker/stylesheets/layout/_search.scss index 50a633141..d2516867f 100644 --- a/lib/nexmo_developer/app/webpacker/stylesheets/layout/_search.scss +++ b/lib/nexmo_developer/app/webpacker/stylesheets/layout/_search.scss @@ -25,10 +25,11 @@ $quick-search-width: 800px; padding-left: $spacing; } -.Nxd-search__wrapper { +.Nxd-search__wrapper { display: flex; flex-wrap: wrap; margin-right: -1px; + min-width: 65vw; } .Nxd-search__result { diff --git a/lib/nexmo_developer/config/initializers/algolia.rb b/lib/nexmo_developer/config/initializers/algolia.rb index c9d767b97..b346913d5 100644 --- a/lib/nexmo_developer/config/initializers/algolia.rb +++ b/lib/nexmo_developer/config/initializers/algolia.rb @@ -21,7 +21,7 @@ algolia_search_parameters = { filters: filters.compact.join(' AND NOT ').prepend('NOT '), - attributesToSnippet: ['body', 'body_safe'], + attributesToSnippet: ['body', 'body_safe', 'description', 'title'], } ALGOLIA_SECURED_SEARCH_KEY = Algolia.generate_secured_api_key(ENV['ALGOLIA_SEARCH_KEY'], algolia_search_parameters) From 48f4aababb4621c70a0e228630d144c54d18ae06 Mon Sep 17 00:00:00 2001 From: marco ranieri Date: Tue, 14 Jun 2022 17:01:37 +0100 Subject: [PATCH 2/5] APIDOC-166: Fix test --- lib/nexmo_developer/app/views/static/404.html.erb | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/nexmo_developer/app/views/static/404.html.erb b/lib/nexmo_developer/app/views/static/404.html.erb index 00b0c1e45..3a4975a60 100644 --- a/lib/nexmo_developer/app/views/static/404.html.erb +++ b/lib/nexmo_developer/app/views/static/404.html.erb @@ -12,7 +12,6 @@

Nexmo Developer

<% elsif index.index == 'zendesk_nexmo_articles' %>

Knowlegebase

- <% end %> <% elsif index.index == 'prod_blogposts' %>

Blog

<% end %> From d4522389146c1297df368b63e052a79f767ad45c Mon Sep 17 00:00:00 2001 From: marco ranieri Date: Tue, 14 Jun 2022 17:14:34 +0100 Subject: [PATCH 3/5] APIDOC-166: Fix test JS --- .../spec/javascript/components/search/Search.test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/nexmo_developer/spec/javascript/components/search/Search.test.js b/lib/nexmo_developer/spec/javascript/components/search/Search.test.js index fe5e977dd..335095430 100644 --- a/lib/nexmo_developer/spec/javascript/components/search/Search.test.js +++ b/lib/nexmo_developer/spec/javascript/components/search/Search.test.js @@ -69,7 +69,7 @@ describe('Search', function() { await flushPromises(); - expect(wrapper.text()).toContain('Nexmo Developer'); + expect(wrapper.text()).toContain('Vonage Developer'); expect(wrapper.text()).toContain('Knowledgebase'); expect(wrapper.text()).toContain('No results'); }); From 2a5a376862ac7e03aa0751aa4f1a63bf59ab2653 Mon Sep 17 00:00:00 2001 From: marco ranieri Date: Wed, 15 Jun 2022 11:17:53 +0100 Subject: [PATCH 4/5] APIDOC-166: ADD test JS --- .../javascript/components/search/Blog.test.js | 28 +++++++++++++++++++ .../components/search/Search.test.js | 2 ++ 2 files changed, 30 insertions(+) create mode 100644 lib/nexmo_developer/spec/javascript/components/search/Blog.test.js diff --git a/lib/nexmo_developer/spec/javascript/components/search/Blog.test.js b/lib/nexmo_developer/spec/javascript/components/search/Blog.test.js new file mode 100644 index 000000000..a78adb45c --- /dev/null +++ b/lib/nexmo_developer/spec/javascript/components/search/Blog.test.js @@ -0,0 +1,28 @@ +import { shallowMount } from '@vue/test-utils'; +import Blog from 'components/search/Blog.vue'; + +describe('Blog', function() { + const blog = { + "title": "Vonage APIs rock!", + "_snippetResult": { "description": { "value": "highlighted snippet" } }, + "_highlightResult": { "description": { "value": "highlighted snippet" } }, + "category": { "name": "Category name" }, + "link": "1/2/3/latest_blog" + }; + + it('renders the blog', function() { + const wrapper = shallowMount(Blog, { propsData: { "hit": blog } }); + + expect(wrapper.find('.Nxd-search__result__link').attributes().href).toEqual( + 'https://developer.vonage.com/1/2/3/latest_blog' + ); + + expect(wrapper.find('h6.Vlt-blue-dark').text()).toEqual('Vonage APIs rock!'); + + expect(wrapper.find('.Nxd-search__result__highlight').text()).toEqual( + '...highlighted snippet...' + ); + + expect(wrapper.find('.Nxd-search__badge').text()).toEqual('Category name'); + }); +}); diff --git a/lib/nexmo_developer/spec/javascript/components/search/Search.test.js b/lib/nexmo_developer/spec/javascript/components/search/Search.test.js index 335095430..dbb7aabcf 100644 --- a/lib/nexmo_developer/spec/javascript/components/search/Search.test.js +++ b/lib/nexmo_developer/spec/javascript/components/search/Search.test.js @@ -9,6 +9,7 @@ import emptySearchFixture from 'javascript/fixtures/emptySearch'; import Search from 'components/search/Search.vue'; import NDPArticle from 'components/search/NDPArticle.vue'; import ZendeskArticle from 'components/search/ZendeskArticle.vue'; +import Blog from 'components/search/Blog.vue'; jest.mock('algoliasearch'); jest.mock('lodash/debounce', () => jest.fn(fn => fn)); @@ -48,6 +49,7 @@ describe('Search', function() { expect(wrapper.findComponent(ZendeskArticle).exists()).toBeTruthy(); expect(wrapper.findComponent(NDPArticle).exists()).toBeTruthy(); + expect(wrapper.findComponent(Blog).exists()).toBeTruthy(); }); }); From eeb70a69561d76c5e08ecaf42d46b85fd56a8d4f Mon Sep 17 00:00:00 2001 From: marco ranieri Date: Wed, 15 Jun 2022 11:37:23 +0100 Subject: [PATCH 5/5] APIDOC-166: ADD Blog fixture JS --- .../spec/javascript/fixtures/emptySearch.js | 12 +++ .../spec/javascript/fixtures/search.js | 94 +++++++++++++++++++ 2 files changed, 106 insertions(+) diff --git a/lib/nexmo_developer/spec/javascript/fixtures/emptySearch.js b/lib/nexmo_developer/spec/javascript/fixtures/emptySearch.js index 7a800f9de..2ddbae5cd 100644 --- a/lib/nexmo_developer/spec/javascript/fixtures/emptySearch.js +++ b/lib/nexmo_developer/spec/javascript/fixtures/emptySearch.js @@ -23,6 +23,18 @@ const emptySearchFixture = { "query": "empty", "params": "query=empty", "index": "zendesk_nexmo_articles" + }, + { + "hits": [], + "nbHits": 0, + "page": 0, + "nbPages": 0, + "hitsPerPage": 1, + "processingTimeMS": 1, + "exhaustiveNbHits": true, + "query": "empty", + "params": "query=empty", + "index": "prod_blogposts" } ] }; diff --git a/lib/nexmo_developer/spec/javascript/fixtures/search.js b/lib/nexmo_developer/spec/javascript/fixtures/search.js index edeef9319..4788c99c1 100644 --- a/lib/nexmo_developer/spec/javascript/fixtures/search.js +++ b/lib/nexmo_developer/spec/javascript/fixtures/search.js @@ -154,6 +154,100 @@ const searchFixture = { "query": "test", "params": "query=test", "index": "zendesk_nexmo_articles" + }, + { + "hits": [ + { + "locale": { + "locale": "en-us", + "name": "English", + "rtl": false + }, + "id": "212554438", + "updated_at": 17662, + "position": 0, + "title": "What are the limitations of the test period?", + "body_safe": "   \n Question \n \n Will I always have to enter all my destination numbers when using Nexmo? \n I saw the test message has '[FREE SMS DEMO, TEST MESSAGE]', will these words be removed after I buy credit? \n I saw the test message has '[Nexmo DEMO]', will these words be removed after I buy credit? \n What will no longer be restricted when I am not in testing mode? \n \n Answer \n When initially subscribing to Nexmo €2 free test credit is granted. At this stage, the following restrictions are in place: \n \n your destination numbers need to be whitelisted in advance of you sending SMS, voice calls, or verify to them unless it's to the handset the account was registered with \n the text [FREE SMS DEMO, TEST MESSAGE] will be included in your SMS  (older accounts will have different wording of [Nexmo DEMO] included instead). \n \n \n Once you move out of the Demo mode you no longer need to whitelist your numbers - you can send to any numbers you want within the local market regulations (see here for the local market regulations and restrictions that apply to your destination numbers) and the text [FREE SMS DEMO, TEST MESSAGE] will no longer be appended to the SMS you send. ", + "outdated": false, + "promoted": false, + "vote_sum": 3, + "comments_disabled": false, + "category": { + "id": "200201483", + "title": "SMS" + }, + "section": { + "id": "200621123", + "title": "Outbound SMS", + "full_path": "SMS > Outbound SMS", + "user_segment": "everybody" + }, + "user_segment": "everybody", + "label_names": [ + "sms", + "test" + ], + "created_at_iso": "2015-10-28T10:16:37Z", + "updated_at_iso": "2018-10-29T18:33:59Z", + "edited_at": 17662, + "edited_at_iso": "2018-05-11T17:07:56Z", + "objectID": "218389108", + "_snippetResult": { + "body_safe": { + "value": "using Nexmo? \n I saw the test message has '[FREE SMS", + "matchLevel": "full" + } + }, + "_highlightResult": { + "title": { + "value": "What are the limitations of the test period?", + "matchLevel": "full", + "fullyHighlighted": false, + "matchedWords": [ + "test" + ] + }, + "category": { + "title": { + "value": "SMS", + "matchLevel": "none", + "matchedWords": [] + } + }, + "section": { + "title": { + "value": "Outbound SMS", + "matchLevel": "none", + "matchedWords": [] + } + }, + "label_names": [ + { + "value": "sms", + "matchLevel": "none", + "matchedWords": [] + }, + { + "value": "test", + "matchLevel": "full", + "fullyHighlighted": true, + "matchedWords": [ + "test" + ] + } + ] + } + } + ], + "nbHits": 270, + "page": 0, + "nbPages": 68, + "hitsPerPage": 4, + "processingTimeMS": 6, + "exhaustiveNbHits": true, + "query": "test", + "params": "query=test", + "index": "prod_blogposts" } ] }