Initial commit

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing to this connector
+
+### Bugfixes

HISTORY

@@ -0,0 +1,3 @@
+0.0.1 2014-09-30
+----------------
+- First version

LICENCE

@@ -0,0 +1,19 @@
+MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,113 @@
+# loopback-connector-elastic-search
+
+Basic Elasticsearch datasource connector for [Loopback](http://strongloop.com/node-js/loopback/).
+
+## Setting up Elasticsearch
+- Download and install [Elasticsearch](http://www.elasticsearch.org)
+- Goto /elasticsearch-path/bin$ and execute ./elasticsearch
+- Optional install [head plugin](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-plugins.html)
+- Open browser and goto default url: http://localhost:9200/
+- To use head plugin goto: _http://localhost:9200/_plugin/head/_
+- If all is ok then the result is some this:<br>
+
+
+    {
+        status: 200,
+        name: "Arno Stark",
+        version: {
+            number: "1.3.2",
+            build_hash: "dee175dbe2f254f3f26992f5d7591939aaefd12f",
+            build_timestamp: "2014-08-13T14:29:30Z",
+            build_snapshot: false,
+            lucene_version: "4.9"
+        },
+        tagline: "You Know, for Search"
+    }
+
+## Populate for demo Elasticsearch
+Run in terminal:<br>
+
+    curl -XPUT http://localhost:9200/shakespeare -d '{
+        "mappings" : {
+            "_default_" : {
+                "properties" : {
+                    "speaker" : {"type": "string", "index" : "not_analyzed" },
+                    "play_name" : {"type": "string", "index" : "not_analyzed" },
+                    "line_id" : { "type" : "integer" },
+                    "speech_number" : { "type" : "integer" }
+                }
+            }
+        }
+    }';
+
+Import data example to Elasticsearch:
+
+    cd examples/data
+    curl -XPUT localhost:9200/_bulk --data-binary @shakespeare.json
+
+
+## Setting up Loopback
+Install StrongLoop command line interface:
+
+    npm install -g strong-cli
+Create project:
+
+    slc loopback:loopback
+    set project path and name
+Attach datasource (see **/server/datasources.json**):
+
+    slc loopback:datasource test-elastic
+    select loopback-connector-elastic
+Create model (see **/examples/entry.json**):
+
+    slc loopback:model entry
+
+## Configuring elastic connector
+Edit **datasources.json** and set:
+
+    [ConnectorEntry] : {
+        "host": [127.0.0.1],
+        "port": [9200],
+        "name": [Name],
+        "connector": "elasticsearch",
+        ...
+        "log": "trace",
+        "defaultSize": [Rows],
+        "index": [IndexName],
+        "type": [TypeName]
+    }
+
+Required:
+---------
+- **Host:** Elasticsearch engine host address.
+- **Port:** Elasticsearch engine port.
+- **Name:** Connector name.
+- **Connector:** Elasticsearch driver.
+
+Optional:
+---------
+- **Log:** logging option.
+- **DefaultSize:** Rows to return per page.
+- **Index:** Search engine specific index.
+- **Type:** Search engine specific type.
+
+## Run example
+Goto to _examples_ folder and run:
+
+    npm install
+
+Goto _server_ folder and run:
+
+    node server.js
+
+Open browse, and set in URL:
+
+    http://localhost:3000/explorer
+
+To test a specific filter, use for example in GET method:
+
+    {"q" : "friends, romans, countrymen"}
+
+## Release notes
+
+  * First beta version

TODO

@@ -0,0 +1,3 @@
+TODO
+- Add unit tests.
+- Finish CRUD operations.

examples/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

examples/.jshintignore

@@ -0,0 +1,2 @@
+/client/
+/node_modules/

examples/.jshintrc

@@ -0,0 +1,21 @@
+{
+    "node": true,
+    "esnext": true,
+    "bitwise": true,
+    "camelcase": true,
+    "eqeqeq": true,
+    "eqnull": true,
+    "immed": true,
+    "indent": 2,
+    "latedef": "nofunc",
+    "newcap": true,
+    "nonew": true,
+    "noarg": true,
+    "quotmark": "single",
+    "regexp": true,
+    "undef": true,
+    "unused": false,
+    "trailing": true,
+    "sub": true,
+    "maxlen": 80
+}

examples/.npmignore

@@ -0,0 +1,16 @@
+.idea
+.project
+*.sublime-*
+.DS_Store
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.swp
+*.swo
+node_modules
+coverage
+*.tgz
+*.xml

examples/client/README.md

@@ -0,0 +1,3 @@
+## Client
+
+This is the place for your application front-end files.

examples/common/models/entry.js

@@ -0,0 +1,3 @@
+module.exports = function (Entry) {
+
+};

examples/common/models/entry.json

@@ -0,0 +1,29 @@
+{
+    "name": "entry",
+    "plural": "entries",
+    "properties": {
+        "line_id": {
+            "type": "number"
+        },
+        "play_name": {
+            "type": "string"
+        },
+        "speech_number": {
+            "type": "number"
+        },
+        "line_number": {
+            "type": "string",
+            "required": true
+        },
+        "speaker": {
+            "type": "string"
+        },
+        "text_entry": {
+            "type": "string"
+        }
+    },
+    "validations": [],
+    "relations": {},
+    "acls": [],
+    "methods": []
+}