Rules engine on top of lucidworks view

.gitignore

@@ -9,7 +9,4 @@ node_modules
 npm-debug.log
 tmp
 
-FUSION_CONFIG.js
-FUSION_CONFIG.*.js
-!FUSION_CONFIG.sample.js
 .jira-prefix

FUSION_CONFIG.sample.js → FUSION_CONFIG.js

@@ -1,7 +1,7 @@
 appConfig = { //eslint-disable-line
-  // If you don't know what you want for some configuration items,
-  // leave them as-is and see what happens in UI.
-  // You may need to clear browser history/cache before your changes take affect.
+              // If you don't know what you want for some configuration items,
+              // leave them as-is and see what happens in UI.
+              // You may need to clear browser history/cache before your changes take affect.
 
   /**
    * Styles and colors
@@ -20,9 +20,11 @@ appConfig = { //eslint-disable-line
    *
    * To use https set the https server key and certificate. And set use_https to true.
    */
+  version: 'v2.8',
   host: 'http://localhost',
   port:'8764',
 
+
   proxy_allow_self_signed_cert: false, // Only turn on if you have a self signed proxy in front of fusion.
 
   // Serve View via https.
@@ -49,16 +51,16 @@ appConfig = { //eslint-disable-line
    */
   anonymous_access: {
     username: 'search-user',
-  //  password: 'search-user-password-here'
+    //  password: 'search-user-password-here'
   },
 
   // The name of your collection
-  collection: 'MyCollection',
+  collection: 'BestBuy',
 
   // Please specify a pipeline or profile that you want to leverage with this UI.
-  query_pipeline_id: 'default',
+  query_pipeline_id: 'BestBuy-rules',
   query_profile_id: 'default',
-  use_query_profile: true, // Force use of query-profile
+  use_query_profile: false, // Force use of query-profile
 
   // Search UI Title
   // This title appears in a number of places in the app, including page title.
@@ -95,9 +97,9 @@ appConfig = { //eslint-disable-line
    *   your_project_directory/client/assets/components/document/document_default/document_default.html
    */
   //In search results, for each doc, display this field as the head field
-  head_field: 'id',
-  subhead_field: 'subtitle',
-  description_field: 'description',
+  head_field: 'name',
+  subhead_field: 'department',
+  description_field: 'longDescription',
   //In search results, for each doc, use this field to generate link value when a user clicks on head_field
   head_url_field: 'url',
   //In search results, display a image in each doc page (leave empty for no image).
@@ -131,9 +133,11 @@ appConfig = { //eslint-disable-line
   //
   // The HTML/Angular template is located in the following directory:
   //    your_project_directory/client/assets/components/document/document.html
-  fields_to_display:['title','id','name', '*'],
+  fields_to_display:['name','department','longDescription'],
   field_display_labels: {
-    'name': 'Document Name',
+    'name': 'Name',
+    'department': 'Department',
+    'longDescription': 'Description'
     //'id': 'Identification Number'
     // you can add as many lines of labels as you want
   },
@@ -154,7 +158,7 @@ appConfig = { //eslint-disable-line
 
   // If enabled and a landing page is triggered via a query, the app will redirect
   // the user to the url provided.
-  landing_page_redirect: true,
+  landing_page_redirect: false,
 
   /**
    * Sorts
@@ -198,6 +202,43 @@ appConfig = { //eslint-disable-line
   // @see https://lucidworks.com/blog/2016/02/04/fusion-plus-solr-suggesters-search-less-typing/
 
   //typeahead_requesthandler: 'suggest', // recommended (requires configuration)
-  typeahead_requesthandler: 'select'
-
+  typeahead_requesthandler: 'select',
+
+  rules: {
+    debug: true,
+    collection: 'BestBuy_rules',
+
+    tags: [
+      "PROD", "TEST", "DESKTOP", "MOBILE"
+    ],
+
+    types: {
+      "Filter List": "filter_list",
+      "Block List": "block_list",
+      "Boost List": "boost_list",
+      "Redirect": "response_value",
+      "Banner": "response_value",
+      "Set Params": "set_params"
+    },
+
+    searchTermsMatching: {
+      text: "Text",
+      keywords: "Keywords",
+      contains: "Contains"
+    },
+
+    set_params: {
+      policies : {
+        "append": "Append",
+        "replace": "Replace"
+      }
+    },
+
+    documentFields: {
+      "type": "Type",
+      "id": "Product Id",
+      "department": "Department",
+      "categoryIds": "Category Id"
+    }
+  }
 };

README.md

@@ -1,34 +1,26 @@
-# Lucidworks View
-  [Lucidworks View](https://lucidworks.com/products/view/) is a consumer-facing front end for Lucidworks Fusion.  It provides a basic search interface with simple configuration, so you can quickly deliver a Fusion-based search solution with minimal development.  View is powered by Fusion, Gulp, Angular, and libSaSS.
+# Lucidworks Rules
 
-  You can also use View as the basis for developing a more sophisticated Web interface, using Foundation for Apps: http://foundation.zurb.com/apps/docs/
-
-  If you need help setting up Fusion, see https://doc.lucidworks.com/.
 
 ## Requirements
 
-If you downloaded a [platform-specific package](https://github.com/lucidworks/lucidworks-view/releases), all dependencies are included. Skip to Get Started step 4.
-
-If you start by cloning the repository, you'll need the following software:
-
+- [Fusion](https://doc.lucidworks.com/): If you need help setting up Fusion, see https://doc.lucidworks.com/.
 - [Node.js](http://nodejs.org): Use the installer for your OS. Use version 5.xxx.
 - [Git](http://git-scm.com/downloads) (if you're cloning the repo): Use the installer for your OS.
 - Windows users can also try [Git for Windows](http://git-for-windows.github.io/).
-- [Gulp](http://gulpjs.com/) and [Bower](http://bower.io): Run `npm install -g gulp bower`
-- Depending on how Node is configured on your machine, you may need to run `sudo npm install -g gulp bower` instead, if you get an error with the first command.
+- [Bower](http://bower.io): Run `npm install -g bower`
 
 ## Get Started
 
 1. Clone the repository, where `app` is the name of your app:
 
   ```bash
-  git clone https://github.com/lucidworks/lucidworks-view app
+  git clone https://github.com/AlexKolonitsky/lucidworks-view app
   ```
 
 1. Change into the directory:
 
   ```bash
-  cd app
+  cd app/rules
   ```
 
 1. Install the dependencies:
@@ -38,74 +30,69 @@ If you start by cloning the repository, you'll need the following software:
   bower install
   ```
 
-1. While you're working on your project, run:
-
-  * If you downloaded a tar package:
-
-    ```bash
-    ./view.sh start
-    ```
-
-  * If you cloned the repository:
-
-    ```bash
-    npm start
-    ```
-
-  This will compile the SaSS, assemble your Angular app, and create `FUSION_CONFIG.js` (if you haven't created it already).  You'll see output that tells you which port was selected:
+1. Set up fusion collections:
 
+  ```bash
+  #!/usr/bin/env bash
+  export FUSION_HOME=$HOME/fusion-2.1.3
+  export FUSION_API_BASE=http://localhost:8764/api/apollo
+  export SOLR_API_BASE=http://localhost:8983/solr
+  export FUSION_API_CREDENTIALS=admin:123qweasdzxc
+
+  # create products collection
+  curl -u $FUSION_API_CREDENTIALS -X PUT -H 'Content-type: application/json' \
+       -d '{"solrParams":{"replicationFactor":1,"numShards":1}}' \
+       ${FUSION_API_BASE}/collections/os_prod
+
+  # Adjust schema to allow attr-* fields to be strings rather than autodetected
+  curl -X POST -H 'Content-type:application/json' --data-binary '{
+    "add-dynamic-field":{
+       "name":"attr-*",
+       "type":"string",
+       "multiValued":true,
+       "stored":false }
+  }' $SOLR_API_BASE/os_prod/schema
+
+  curl -X POST -H 'Content-type:application/json' --data-binary '{
+    "replace-field":{
+       "name":"createdAt",
+       "type":"tdate",
+       "stored":true,
+       "multiValued":false}
+  }' $SOLR_API_BASE/os_prod_rules/schema
+
+  curl -X POST -H 'Content-type:application/json' --data-binary '{
+    "replace-field":{
+       "name":"updatedAt",
+       "type":"tdate",
+       "stored":true,
+       "multiValued":false}
+  }' $SOLR_API_BASE/os_prod_rules/schema
+
+  # set up -with-products pipeline for products (os_prod) collection
+  curl -u $FUSION_API_CREDENTIALS -X DELETE ${FUSION_API_BASE}/query-pipelines/os_prod-with-rules
+  curl -u $FUSION_API_CREDENTIALS -X POST -H 'Content-type: application/json' -d @os_prod-with-rules-query-pipeline.json ${FUSION_API_BASE}/query-pipelines
+
+
+  # upload products data
+  $FUSION_HOME/apps/solr-dist/bin/post -c os_prod -params "rowid=id&csv.mv.separator=~&csv.mv.encapsulator=%60&f.PhraseText.split=true&f.Category-search.split=true&f.CategoryID.split=true&f.CategoryID.separator=~&f.Color-search.split=true&f.attr-__General__LNav_Colors.split=true&f.ImageData.split=true&f.attr-__General__LNavColorCategory.split=true&skip=_version_,Brand-search,Color-search,Category-no_stem,Name-search,Name-no_stem,Name-sort,Price-search,PricePerMonth-search,ProductID-search,autoPhrase_text,LastIndexed,_text_" products.csv
+
+  # create rules collection (specific to the example products)
+  curl -u $FUSION_API_CREDENTIALS -X PUT -H 'Content-type: application/json' \
+       -d '{"solrParams":{"replicationFactor":1,"numShards":1}}' \
+       ${FUSION_API_BASE}/collections/os_prod_rules
+
+  curl -u $FUSION_API_CREDENTIALS -X PUT -H Content-type:application/json \
+       -d '{"enabled":true}' ${FUSION_API_BASE}/collections/os_prod/features/signals
+
+  # upload rules data
+  $FUSION_HOME/apps/solr-dist/bin/post -c os_prod_rules rules.json
   ```
-  [BS] Access URLs:
-   ------------------------------------
-         Local: http://localhost:3000
-      External: http://<external IP>:3000
-   ------------------------------------
-   ```
-
-   The default is port 3000, but if that port is already in use then the app selects the next highest available port.
-
-1. **Now go to `http://localhost:<port>` in your browser to see it in action.**
-
-  The first time you browse to the app, you'll see a login page.  Use your Fusion username and password.  To enable anonymous access, edit the `anonymous_access` keys in FUSION_CONFIG.js.
-
-  When you change FUSION_CONFIG.js or any file in the `client` folder, the appropriate Gulp task will run to build new files. This uses [`browser-sync`](https://www.browsersync.io/) for instant reload upon change of source files. Visit `http://localhost:3001` (or whatever your terminal shows as the browser-sync UI) for the `browser-sync` dashboard.
-
-To run the compiling process once, without watching any files, use the `build` command:
-```bash
-npm run build
-```
-
-## Unit testing
 
-```
-npm run build
-npm test
-```
+1. All configuration such as fusion url, available rule types or documents fields should be made in FUSION_CONFIG.js
 
-## Basic Configuration
+1. Run application:
 
-The first time you run `npm start`, FUSION_CONFIG.sample.js is copied to FUSION_CONFIG.js.  Modify this file to configure View's basic options.  Documentation about the configuration keys is included in the file.
-
-At a minimum, you _must_ configure the `collection` key to match the name of your Fusion collection.
-
-In a production environment, you must also configure `host` and `port` to point to the UI service of your Fusion deployment.  The default is `localhost:8764` for development purposes.
-
-When the app is running with BrowserSync, it reloads the configuration every time you save FUSION_CONFIG.js.  You can modify the configuration and watch the app change in real time in your browser.
-
-## Basic Customization
-
-The title and logo for your interface are configured in FUSION_CONFIG.js as `search_app_title` and `logo_location`.
-
-CSS options are configured in the files in client/assets/scss.
-
-Templates for various UI components are located in client/assets/components.
-
-Search results from different document types can use different templates.  The `client/assets/components/document` directory contains templates for some common document types, plus default templates for all others.  Data types correspond to Connectors in Fusion.  See [Customizing Documents](docs/Customizing_Documents.md) for details about working with these.
-
-## What's Next
-
-For more details about configuring and customizing View, see the [docs](docs/) directory.
-
-## Contributions
-
-View is open source! Pull requests welcome. This is a great way to give back to the community and help others build a better search app.
+  ```bash
+  npm start
+  ```

bower.json

@@ -28,12 +28,26 @@
     "angucomplete-alt": "~2.2.0",
     "angular-sanitize": "~1.4.10",
     "angular-rison": "~0.0.13",
-    "angularjs-humanize": "master"
+    "angularjs-humanize": "master",
+    "bootstrap-sass": "~3.3.5",
+    "modernizr": "~2.8.3",
+    "font-awesome": "^4.6.3",
+    "eonasdan-bootstrap-datetimepicker": "^4.17.37",
+    "autosize": "^3.0.15",
+    "bootstrap-tagsinput": "^0.8.0",
+    "angular": "~1.5.0",
+    "angular-route": "~1.5.0",
+    "angular-loader": "~1.5.0",
+    "angular-mocks": "~1.5.0",
+    "html5-boilerplate": "^5.3.0",
+    "ng-tags-input": "^3.1.1",
+    "adm-dtp": "*",
+    "checklist-model": "^0.10.0"
   },
   "devDependencies": {
     "angular-mocks": "~1.4.10"
   },
   "resolutions": {
     "angular": "1.3.x - 1.4.x"
   }
-}
+}

client/assets/components/banner/_banner.scss

@@ -0,0 +1,3 @@
+.banners-list {
+  list-style-type: none;
+}

client/assets/components/banner/banner.html

@@ -0,0 +1,8 @@
+<div ng-if="bd.banners" class="card">
+  <div class="card-section center">
+    <span>Banners:</span>
+    <ul class="banners-list">
+      <li ng-repeat="banner in bd.banners">{{banner}}</a></li>
+    </ul>
+  </div>
+</div>