A client-side livescript/javascript spore client
bower install ls-sporeInclude and use "build/spore-client.min.js" :
<!DOCTYPE html>
<html>
<head>
<title>ls-spore example</title>
<script src="build/spore-client.min.js" type="text/javascript"></script>
<script type="text/javascript">
s = new Spore("http://serverurl/spore-description.json", function(){
if (s.isReady) {
s.enable(SporeMiddlewareAuthApiKey, {key_name:"Authorization", key_value:"Token S3CR3T"});
s.logBasicInfos()
s.methods.get_user({
format: "json",
username: "toto"
}, function(response){
console.log("Recuperation de toto ... :");
return console.log(response);
},
function(){
console.log("Error with the spore method");
});
}
},
function(){
console.log("Error with the spore client creation");
},
base_url = "http://127.0.0.1:8000");
</script>
</head>
<body>
</body>
</html>import { SporeMiddlewareAuthApiKey, Spore } from "spore-client.min.js"use the following lines to compile livescript to javascript :
sudo npm install -g LiveScript
lsc -wc -o src/js/ src/ls/*.ls
lsc -wc -o test/js/ test/ls/*.lsuse the following line to create a minified JS
sudo npm install -g uglify-js
uglifyjs src/js/request.js src/js/middleware.js src/js/spore.js -o build/spore-client.min.jsInstall nodejs and mongodb :
sudo apt-get install nodejs npm
sudo apt-get install mongodbRun a test WS and install and run karma :
cd test
sudo npm install
npm start
npm test- base_url
- description
- version
- authority
- meta
- name
- methods
- methods -> name
- methods -> path
- methods -> required_params
- methods -> optional_params
- methods -> headers
- methods -> base_url
- methods -> payload
- methods -> required_payload
- methods -> expected_status
- create spore client
- url for description file
- enable middleware
- middleware auth by token
- authentication (only for Authorization header)
- enable if middleware
- authentication (currently, only for Authorization header)
- unattended_params
- formats (currently, only JSON)
- methods -> form-data
- methods -> optional_payload
- methods -> unattended_params
- methods -> description
- methods -> deprecated
- methods -> authentication (currently, only for Authorization header)
- methods -> formats (currently, only JSON)
- disable middleware
- put client's meta data in a _meta variable and remove methods variable
- be more livescript idiomatic
- See the ls-spore-ui repository