Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/biophoton/ng-drupal-7-services
Well structured AngularJS modules mimic the architecture of Drupal Services 3.x. for your next AngularJS / Ionic Drupal Headless / Decoupled project
https://github.com/biophoton/ng-drupal-7-services
Last synced: 3 months ago
JSON representation
Well structured AngularJS modules mimic the architecture of Drupal Services 3.x. for your next AngularJS / Ionic Drupal Headless / Decoupled project
- Host: GitHub
- URL: https://github.com/biophoton/ng-drupal-7-services
- Owner: BioPhoton
- Created: 2015-03-23T17:33:59.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-15T16:42:36.000Z (over 8 years ago)
- Last Synced: 2024-04-14T02:19:32.989Z (9 months ago)
- Language: JavaScript
- Homepage: http://drupalionic.org
- Size: 7.54 MB
- Stars: 26
- Watchers: 7
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Angular/Ionic Drupal7 Services
#### Well structured angular modules mimic the architecture of [Drupal Services 3.x](https://www.drupal.org/project/services)
[](https://badge.fury.io/bo/ng-drupal-7-services)
[](https://badge.fury.io/js/ng-drupal-7-services)
[](http://packagequality.com/#?package=ng-drupal-7-services)
Angular Drupal7 Services is a REST client for AngularJS, which allows you to user predefined functions when communication with Drupal's api endpoints.
Unlike the other project focusing on the same topic, Angular Drupal7 Services is precisely organized around the [Drupal Services 3.x](https://www.drupal.org/project/services) architecture and naming conventions.
It optionally provides events next to the common used promise approach.
A full set of Drupal's resources is available, and all basic workflow's depending to authentication or helpers for CRUD operations are also provided as a set of extra modules.
##DEMOS
Check out the [Drupal-API-Explorer](https://github.com/BioPhoton/ng-drupal-services-tests-with-ng) for a full demo
Or check out the sample implementation for [Ionic-Headless-Drupal](https://github.com/BioPhoton/Ionic-Angular-Headless-Drupal-Demo)
## Get Started
**(1)** Get Angular Drupal7 Services:
- clone & build this repository
- [download as .zip](https://github.com/BioPhoton/ng-drupal-7-services/archive/master.zip)
- or via **[npm](https://www.npmjs.org/)**: by running `$ npm install ng-drupal-7-services` from your console
- or via **[Bower](http://bower.io/)**: by running `$ bower install ng-drupal-7-services` from your console
**(2)** Include `ng-drupal-7-services.js` in your `index.html`.
**(3)** Add `'d7-services'` to your main module's list of dependencies
## [API Documentation](http://www.drupalionic.org/docs) (!!!in progress!!!)
## Quickstart
**(1)** Insert the ```ng-drupal-7-services.js``` bundle into your ```index.html``` file.
```html
angular.module('myApp', ['d7-services'])
.config(function configFunction(DrupalApiConstant) {
//configure your drupal instance
DrupalApiConstant.drupal_instance = 'http://your.projects.domain/';
});
...
...
```
**(2)** Using the services.
```javascript
angular
angular.module('myApp')
.controller('NodeController', ['NodeResource', 'NodeChannel', function(NodeResource, NodeChannel){
//fire request
var retrievePromis = NodeResource.retrieve({nid:1});
//using promise.then callbacks
retrievePromis.then(function(data) { ... },function(error) { ... });
//subscribing to events
//This could happen in another directive/controller too
NodeChannel.subRetrieveConfirmed($scope, function(data){ ... });
NodeChannel.subRetrieveFailed($scope, function(error){ ... });
}]);
```
##Configuration
Basically all configurable options are wrapped in an angular constant.
IF you changed any of Drupal's default settings adopt the constants in DrupalApiConstant in Angular's config phase as shown above.
Find all available options in the [API Documentation](http://www.drupalionic.org/docs) under Commons/DrupalApiConstant.
```javascript
angular.module('myApp', ['d7-services'])
.config(function configFunction(DrupalApiConstant) {
...
//your changes here
...
});
```
##Supported Drupal Modules
Here is a list of supported Drupal services 3.x modules:
- [x] [Services](https://www.drupal.org/project/services) **7 Resources** | **51 Requests**
- [x] [Services Views](https://www.drupal.org/project/services_view) **1 Resources** | **1 Requests**
- [x] [Services Menu](https://www.drupal.org/project/services_menu) **1 Resources** | **1 Requests**
- [ ] [Services Search](https://www.drupal.org/project/services_search) **2 Resources** | **2 Requests**
- [ ] [Services Entity](https://www.drupal.org/project/services_entity) **6 Resources** | **47 Requests**
- [x] [Services Definitions](https://www.drupal.org/project/services_tools) **1 Resources** | **1 Requests**
- [x] [Geocoder](https://www.drupal.org/project/geocoder) **1 Resources** | **2 Requests**
##Extra Resources
Following extramodules are provided for simplifing authentication routing and viewcomposition
- [x] Authentication **authenticaion workflows and helper functions**
- [x] AccessControl **handle access for routing and actions**
- [x] Directives **show hide elements by role or accesslevel**
- **Drupal Services**
- Comment Resource
- Retrieve
- Create
- Update
- Delete
- Index
- CountAll
- CountNew
- Retrieve
- File Resource
- Retrieve
- Create
- Delete
- Index
- Create_raw
- Node Resource
- Retrieve
- Create
- Update
- Delete
- Index
- Files
- Comments
- Attach_file
- System Resource
- Connect
- Get_variable
- Set_variable
- Del_variable
- TaxonomyTerm Resource
- Retrieve
- Create
- Update
- Delete
- Index
- SelectNodes
- TaxonomyVocabulary Resource
- Retrieve
- Create
- Update
- Delete
- Index
- GetTree
- User Resource
- Retrieve
- Create
- Update
- Delete
- Index
- Login
- Logout
- Token
- Request_new_password
- Register
- Cancel
- Password_reset
- Resend_welcome_email
- **Drupal Services Views**
- Views Resource
- Retrieve
- **Drupal Geocoder**
-Views Geocoder
- Retrieve
- Index
- **Drupal Services Menu**
- Menu Resource
- Retrieve
- **Drupal Services Definition**
- Definition Resource
- Index
- **Extra Resources**
- Authentication service
- storeTokenData
- deleteTokenData
- refreshToken
- storeSessionData
- deleteSessionData
- getConnectionState
- setConnectionState
- getCurrentUser
- setCurrentUser
- refreshConnection
- getLastConnectTime
# Extra Services
##AccessControl
- roles
- accessLevels
- authorize
### Directives
- accessLevel => show hide elem based on role and acessLevel
## Setup for Drupal
- Start with a fresh Drupal7 installation.
###Services
- install [Drupal Services](https://www.drupal.org/project/services)
- Go to admin/structure/services/add and create a new endpoint with following settings:
- machine name: api
- server: REST
- path: api
- debug: unchecked
- session authentication: checked
- Then click the edit resources link and open the resources tab.
Now every resource you like by check box.
- Then click Save
- Click the Server tab
- For Response formatters check following:
- json
- For Request parsing check following:
- application/json
- application/x-www-form-urlencoded
- multipart/form-data (for file upload)
- text/xml
- Click Save.
- Flush all of Drupal's caches.
###Setup for CORS
- install [CORS](https://www.drupal.org/project/cors)
- Go to admin/config/services/cors and paste following into the textarea
`api/v1*||POST,PUT,GET,DELETE|Content-Type,Authorization,X-CSRF-TOKEN|true`
#Links
Testing resources on a test server => https://www.drupal.org/node/1447020