Skip to content

Commit d1d925f

Browse files
gierschvgierschv
committed
Update tests and README
Signed-off-by: Vincent Giersch <[email protected]>
1 parent 91568ca commit d1d925f

28 files changed

+1765
-525
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
node_modules/
22
.DS_Store
33
/auth*
4+
*~
5+
coverage/

‎.travis.yml

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ node_js:
55
- '0.9'
66
- '0.10'
77
- '0.11'
8+
after_script: 'npm install coveralls && cat ./coverage/lcov.info | node_modules/.bin/coveralls'

‎CHANGELOG.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## 1.1
4+
* Now official Node.js wrapper
5+
* Rewrite part of the tests, README & documentation
6+
* Add CONTRIBUTING guidelines
7+
38
## 1.0.2
49

510
* Fix noAuthenticated calls
@@ -72,4 +77,4 @@
7277

7378
## 0.1.0
7479

75-
* Initial release
80+
* Initial release

‎CONTRIBUTING.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributing to Node-OVH
2+
3+
This project accepts contributions. In order to contribute, you should
4+
pay attention to a few things:
5+
6+
1. your code must follow the coding style rules
7+
2. your code must be fully (100% coverage) unit-tested
8+
3. your code must be fully documented
9+
4. your work must be signed
10+
5. the format of the submission must be email patches or GitHub Pull Requests
11+
12+
13+
## Submitting Modifications
14+
15+
The contributions should be email patches. The guidelines are the same
16+
as the patch submission for the Linux kernel except for the DCO which
17+
is defined below. The guidelines are defined in the
18+
'SubmittingPatches' file, available in the directory 'Documentation'
19+
of the Linux kernel source tree.
20+
21+
It can be accessed online too:
22+
23+
https://www.kernel.org/doc/Documentation/SubmittingPatches
24+
25+
You can submit your patches via GitHub
26+
27+
## Licensing for new files
28+
29+
Node-OVH is licensed under a MIT license. Anything contributed to Node-OVH must
30+
be released under this license.
31+
32+
When introducing a new file into the project, please make sure it has a
33+
copyright header making clear under which license it's being released.
34+
35+
## Developer Certificate of Origin
36+
37+
To improve tracking of contributions to this project we will use a
38+
process modeled on the modified DCO 1.1 and use a "sign-off" procedure
39+
on patches that are being emailed around or contributed in any other
40+
way.
41+
42+
The sign-off is a simple line at the end of the explanation for the
43+
patch, which certifies that you wrote it or otherwise have the right
44+
to pass it on as an open-source patch. The rules are pretty simple:
45+
if you can certify the below:
46+
47+
By making a contribution to this project, I certify that:
48+
49+
(a) The contribution was created in whole or in part by me and I have
50+
the right to submit it under the open source license indicated in
51+
the file; or
52+
53+
(b) The contribution is based upon previous work that, to the best of
54+
my knowledge, is covered under an appropriate open source License
55+
and I have the right under that license to submit that work with
56+
modifications, whether created in whole or in part by me, under
57+
the same open source license (unless I am permitted to submit
58+
under a different license), as indicated in the file; or
59+
60+
(c) The contribution was provided directly to me by some other person
61+
who certified (a), (b) or (c) and I have not modified it.
62+
63+
(d) The contribution is made free of any other party's intellectual
64+
property claims or rights.
65+
66+
(e) I understand and agree that this project and the contribution are
67+
public and that a record of the contribution (including all
68+
personal information I submit with it, including my sign-off) is
69+
maintained indefinitely and may be redistributed consistent with
70+
this project or the open source license(s) involved.
71+
72+
73+
then you just add a line saying
74+
75+
Signed-off-by: Random J Developer <[email protected]>
76+
77+
using your real name (sorry, no pseudonyms or anonymous contributions.)
78+

‎LICENSE

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Copyright (c) 2014 OVH SAS
2+
Copyright (c) 2012 - 2013 Vincent Giersch
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in
12+
all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20+
THE SOFTWARE.
21+
22+
Except as contained in this notice, the name of OVH and or its trademarks
23+
shall not be used in advertising or otherwise to promote the sale, use or other
24+
dealings in this Software without prior written authorization from OVH.

‎Makefile

-11
This file was deleted.

‎README.md

+173-20
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,190 @@
1-
node-ovh
2-
========
1+
[![Node.js Wrapper for OVH APIs](http://ovh.github.io/node-ovh/img/logo.png)](http://ovh.github.io/node-ovh)
32

4-
[![Build Status](https://secure.travis-ci.org/gierschv/node-ovh.png)](http://travis-ci.org/gierschv/node-ovh)
3+
The easiest way to use the [OVH.com](http://ovh.com) APIs in your [node.js](http://nodejs.org/) applications.
54

6-
node-ovh is a Node.js helper library for [OVH REST APIs](https://api.ovh.com).
5+
[![NPM Version](https://img.shields.io/npm/v/ovh.svg?style=flat)](https://www.npmjs.org/package/express)
6+
[![Build Status](https://secure.travis-ci.org/ovh/node-ovh.png?style=flat)](http://travis-ci.org/ovh/node-ovh)
7+
[![Coverage Status](https://img.shields.io/coveralls/ovh/node-ovh.svg?style=flat)](https://coveralls.io/r/ovh/node-ovh?branch=master)
78

8-
Since the v1.0.0 of this module, the OVH WS are not supported anymore.
9-
The [branch v0.3](https://github.com/gierschv/node-ovh/tree/v0.3) is still maintained.
9+
```js
10+
// Create your first application tokens here: https://api.ovh.com/createToken/?GET=/me
11+
var ovh = require('ovh')({
12+
appKey: process.env.APP_KEY,
13+
appSecret: process.env.APP_SECRET,
14+
consumerKey: process.env.CONSUMER_KEY
15+
});
1016

11-
**This library is unofficial and consequently not maintained by OVH.**
17+
ovh.request('GET', '/me', function (err, me) {
18+
console.log(err || 'Welcome ' + me.firstname);
19+
});
20+
```
21+
22+
## Installation
23+
24+
The easiest way to get the latest stable release is to grab it from the
25+
[npm registry](https://npmjs.org/package/ovh).
26+
27+
```bash
28+
$ npm install ovh
29+
```
30+
31+
Alternatively, you may get latest development version directly from Git.
32+
33+
```bash
34+
$ npm install git://github.com/ovh/node-ovh.git
35+
```
36+
37+
## Example Usage
38+
39+
### Login as a user
40+
41+
#### 1. Create an application
42+
43+
Depending the API you plan yo use, you need to create an application on the below
44+
websites:
1245

13-
Documentation
14-
------------
46+
* [OVH Europe](https://eu.api.ovh.com/createApp/)
47+
* [OVH North-America](https://ca.api.ovh.com/createApp/)
48+
* [RunAbove](https://api.runabove.com/createApp/)
1549

16-
The documentation is available online: http://gierschv.github.io/node-ovh
50+
Once created, you will obtain an **application key (AK)** and an **application
51+
secret (AS)**.
1752

18-
License
19-
-------
53+
#### 2. Authorize your application to access to a customer account
2054

21-
node-ovh is freely distributable under the terms of the MIT license.
55+
To allow your application to access to a customer account using an OVH API,
56+
you need a **consumer key (CK)**.
2257

58+
Here is a sample code you can use to allow your application to access to a
59+
complete account.
60+
61+
Depending the API you want to use, you need to specify the below API endpoint:
62+
63+
* OVH Europe: ```ovh-eu``` (default)
64+
* OVH North-America: ```ovh-ca```
65+
* RunAbove: ```runabove-ca```
66+
67+
```js
68+
var ovh = require('ovh')({
69+
endpoint: 'ovh-eu',
70+
appKey: 'YOUR_APP_KEY',
71+
appSecret: 'YOUR_APP_SECRET'
72+
});
73+
74+
ovh.request('POST', '/auth/credential', {
75+
'accessRules': [
76+
{ 'method': 'GET', 'path': '/*'},
77+
{ 'method': 'POST', 'path': '/*'},
78+
{ 'method': 'PUT', 'path': '/*'},
79+
{ 'method': 'DELETE', 'path': '/*'}
80+
]
81+
}, function (error, credential) {
82+
console.log(error || credential);
83+
});
2384
```
24-
Copyright (c) 2012 - 2013 Vincent Giersch <[email protected]>
2585

26-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
27-
files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use,
28-
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:
86+
```bash
87+
$ node credentials.js
88+
{ validationUrl: 'https://api.ovh.com/auth/?credentialToken=XXX',
89+
consumerKey: 'CK',
90+
state: 'pendingValidation' }
91+
```
2992
30-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
93+
This consumer key can be scoped with a **specific authorization**.
94+
For example if your application will only send SMS:
3195
32-
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.
96+
```javascript
97+
ovh.request('POST', '/auth/credential', {
98+
'accessRules': [
99+
{ 'method': 'POST', 'path': '/sms/*/jobs'},
100+
]
101+
}, function (error, credential) {
102+
console.log(error || credential);
103+
});
33104
```
34105
106+
Once the consumer key will be authorized on the specified URL,
107+
you'll be able to play with the API calls allowed by this key.
108+
109+
#### 3. Let's play!
110+
111+
You are now be able to play with the API. Look at the
112+
[examples available online](http://ovh.github.io/node-ovh#examples).
113+
114+
You can browse the API schemas using the web consoles of the APIs:
115+
116+
* [OVH Europe](https://eu.api.ovh.com/console/)
117+
* [OVH North-America](https://ca.api.ovh.com/console/)
118+
* [RunAbove](https://api.runabove.com/console/)
119+
120+
## Full documentation and examples
121+
122+
The full documentation is available online: http://ovh.github.io/node-ovh.
123+
124+
## Hacking
125+
126+
### Get the sources
127+
128+
```bash
129+
git clone https://github.com/ovh/node-ovh.git
130+
cd node-ovh
131+
```
132+
133+
You've developed a new cool feature ? Fixed an annoying bug ? We'd be happy
134+
to hear from you !
135+
136+
### Run the tests
137+
138+
Tests are based on [mocha](http://visionmedia.github.io/mocha/).
139+
This package includes unit and integration tests.
140+
141+
```
142+
git clone https://github.com/ovh/node-ovh.git
143+
cd node-ovh
144+
npm install -d
145+
npm test
146+
```
147+
148+
Integration tests use the OVH /domain/zone API, the tokens can be created
149+
[here](https://api.ovh.com/createToken/).
150+
151+
```
152+
export APP_KEY=xxxxx
153+
export APP_SECRET=yyyyy
154+
export CONSUMER_KEY=zzzzz
155+
export DOMAIN_ZONE_NAME=example.com
156+
npm run-script test-integration
157+
```
158+
159+
### Documentation
160+
161+
The documentation is based on [Github Pages](https://pages.github.com/) and is
162+
available in the *gh-pages* branch.
163+
164+
165+
## Supported APIs
166+
167+
### OVH Europe
168+
169+
- **Documentation**: https://eu.api.ovh.com/
170+
- **Community support**: [email protected]
171+
- **Console**: https://eu.api.ovh.com/console
172+
- **Create application credentials**: https://eu.api.ovh.com/createApp/
173+
174+
### OVH North America
175+
176+
- **Documentation**: https://ca.api.ovh.com/
177+
- **Community support**: [email protected]
178+
- **Console**: https://ca.api.ovh.com/console
179+
- **Create application credentials**: https://ca.api.ovh.com/createApp/
180+
181+
### Runabove
182+
183+
- **Console**: https://api.runabove.com/console/
184+
- **Create application credentials**: https://api.runabove.com/createApp/
35185
36-
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/gierschv/node-ovh/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
186+
### Related links
37187
188+
- **Contribute**: https://github.com/ovh/node-ovh
189+
- **Report bugs**: https://github.com/ovh/node-ovh/issues
190+
- **Download**: http://npmjs.org/package/ovh

‎handler-maker.js ‎lib/handler-maker.js

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
// Can be used with node-proxy to create forwarding proxy,
2-
// i.e. forward all the calls to underlying object.
3-
//
41
// Taken from http://wiki.ecmascript.org/doku.php?id=harmony:proxies
52
//
3+
// istanbul ignore next
64
function handlerMaker(obj) {
5+
'use strict';
76
return {
87
getOwnPropertyDescriptor: function(name) {
98
var desc = Object.getOwnPropertyDescriptor(obj, name);
@@ -45,7 +44,11 @@ function handlerMaker(obj) {
4544
set: function(receiver, name, val) { obj[name] = val; return true; }, // bad behavior when set fails in non-strict mode
4645
enumerate: function() {
4746
var result = [];
48-
for (var name in obj) { result.push(name); };
47+
for (var name in obj) {
48+
if (obj.hasOwnProperty(name)) {
49+
result.push(name);
50+
}
51+
}
4952
return result;
5053
},
5154
keys: function() { return Object.keys(obj); }

0 commit comments

Comments
 (0)