Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owncloud/owncloud-sdk
:cloud: ownCloud client library for JavaScript
https://github.com/owncloud/owncloud-sdk
javascript library owncloud
Last synced: 3 months ago
JSON representation
:cloud: ownCloud client library for JavaScript
- Host: GitHub
- URL: https://github.com/owncloud/owncloud-sdk
- Owner: owncloud
- License: mit
- Archived: true
- Created: 2017-05-08T08:36:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-05T10:14:13.000Z (7 months ago)
- Last Synced: 2024-07-05T15:00:08.351Z (6 months ago)
- Topics: javascript, library, owncloud
- Language: JavaScript
- Homepage: https://owncloud.dev/owncloud-sdk/
- Size: 7.9 MB
- Stars: 75
- Watchers: 57
- Forks: 34
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://owncloud.github.io/owncloud-sdk/)
# ownCloud JavaScript SDK
**Deprecation notice: The `owncloud-sdk` has been deprecated and discontinued in favor of the [web-client package](https://github.com/owncloud/web/tree/master/packages/web-client). This means the package won't get any updates in the future.**
Use this light-weight JS library with a promise-based interface for seamless communication with your ownCloud instance, both from the browser and from Node backends.
## Installation
Run either
```
npm install owncloud-sdk
```
or
```
yarn add owncloud-sdk
```
to add the `owncloud-sdk` to your project.
If you haven't done so already, you also need to add the following `peerDependencies` to your dependencies:
```
npm install axios cross-fetch promise qs utf8 uuid webdav xml-js
```
or
```
yarn add axios cross-fetch promise qs utf8 uuid webdav xml-js
```
## Usage
```js
const owncloud = require('owncloud-sdk');
let oc = new owncloud({
baseUrl: config.owncloudURL,
auth: {
basic: {
username: config.username,
password: config.password
}
}
});
// Login
oc.login().then(status => {
// STUFF
}).catch(error => {
// HANDLE ERROR
});
// Share File With Link
oc.shares.shareFileWithLink('linkToYourFile').then(shareInfo => {
console.log("Link is : " + shareInfo.getLink());
}).catch(error => {
// HANDLE ERROR
});
// List all files
oc.files.list('/path/to/file/folder').then(files => {
console.log(files);
}).catch(error => {
console.log(error);
});
```
## Example Projects
### ownCloud web
[ownCloud web](https://github.com/owncloud/web) is the next generation web frontend for ownCloud.
### ownCloud file-picker
[ownCloud file-picker](github.com/owncloud/file-picker) is an integration to access the files in your ownCloud, e.g. in a chat app.
## Documentation
The full API documentation is available [on the docs website](https://owncloud.dev/owncloud-sdk/).
### Building the docs
The docs are based on JSDocs.
To build them, run the following command and follow the instructions on the terminal:
```
yarn build:docs
```
## Unit/Integration tests
### Overview
`owncloud-sdk` uses [pactjs](https://github.com/pact-foundation/pact-js) with jest for unit and integration tests.
On the pact provider side, tests have 4 different `interactions`:
- interactions that work on both oc10 & ocis
- interactions that are "pending" on oc10 but should work on ocis
- interactions that are "pending" on ocis but should work on oc10
- interactions that are "pending" on both ocis & oc10
The CI is not expected to fail for the interactions that are "pending" but it's expected to fail for those interactions that were already verified and started failing. Pact.io has a system to handle such a scenario called [pending pacts](https://docs.pact.io/pact_broker/advanced_topics/pending_pacts/ 'pending pacts'). This feature allows changed contracts to be verified without failing the provider's build.
Four different pacts for the different buckets of interactions are created when running the provider tests. Pacts that are allowed to fail are marked as `pending` else not.
In a consumer test, a new mock provider is created using the function `createProvider`. It takes two parameters: `pendingOnOc10` and `pendingOnOcis` in order. Each parameter can have value `true` or `false` depending upon which provider-version the test is still pending.
To add a new consumer test which is expected to fail on ocis but pass on oc10 provider, provider should be created as:
```js
describe('feature', function () {
it('new test feature', function () {
const isPendingOnOc10 = true // set this as true if the test is allowed to fail on oc10 provider
const isPendingOnOcis = false // set this as true if the test is allowed to fail on ocis provider
const provider = createProvider(isPendingOnOc10, isPendingOnOcis)
// get interactions
// execute test
provider.executeTest(() => {
// test body
})
})
})
```
### Running tests
At first, you need to create `config.json` file.
```
cp tests/config/config.sample.json tests/config/config.json
```
### Consumer tests
The pact consumer tests checks owncloud sdk against the pact mock server. In order to run these tests, use the following command:
```
yarn test-consumer
```
> Note: If you have pacts from old test run in `tests/pacts` your tests will fail. Make sure to delete that before you run the tests again.
> Note: The pact tests need node 14. You can switch node versions locally with `nvm install 14` and then `make` to get all the correct dependencies.
### Provider tests
The pact provider tests the pacts generated from the consumer tests against the real owncloud backend server. For this you will need an actual owncloud server running. Then you can run the pact tests with the following command:
```
PROVIDER_BASE_URL= yarn test-provider
```
## Credits
This project was originally created by Noveen Sachdeva, Vincent Petry and Thomas Müller as part of the [2017 Google Summer of Code](https://summerofcode.withgoogle.com/archive/2017/projects/5166409181036544).
## License
The ownCloud SDK is released under the [MIT License](https://github.com/owncloud/owncloud-sdk/blob/master/LICENSE.md).