https://github.com/johnnythetank/aping-plugin-rss

RSS Plugin for apiNG
https://github.com/johnnythetank/aping-plugin-rss

angular aping aping-plugin rss social-wall

Last synced: about 1 month ago
JSON representation

RSS Plugin for apiNG

• Host: GitHub
• URL: https://github.com/johnnythetank/aping-plugin-rss
• Owner: JohnnyTheTank
• License: mit
• Created: 2015-12-29T18:39:14.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-09-14T08:13:44.000Z (over 6 years ago)
• Last Synced: 2024-11-10T08:51:31.600Z (about 1 month ago)
• Topics: angular, aping, aping-plugin, rss, social-wall
• Language: JavaScript
• Size: 27.3 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[logo]: http://johnnythetank.github.io/apiNG/logo/320/aping-logo.png "apiNG"

![apiNG][logo]

[![Join the chat at https://gitter.im/JohnnyTheTank/apiNG](https://img.shields.io/badge/GITTER-join%20chat-green.svg)](https://gitter.im/JohnnyTheTank/apiNG?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![npm version](https://badge.fury.io/js/aping-plugin-rss.svg)](https://badge.fury.io/js/aping-plugin-rss)

[![Bower version](https://badge.fury.io/bo/apiNG-plugin-rss.svg)](https://badge.fury.io/bo/apiNG-plugin-rss)

**_apiNG-plugin-rss_** is a [RSS](http://cyber.law.harvard.edu/rss/rss.html) plugin for [**apiNG**](https://github.com/JohnnyTheTank/apiNG).

# Information

* **Supported apiNG models: `social`, `native` (RSS)**

* This plugin supports the [`get-native-data` parameter](https://aping.readme.io/docs/advanced#parameters)

* Used RSS->JSON parse service: `https://rss2json.com/`

# Documentation

1. [INSTALLATION](#1-installation)

    1. Get file

    2. Include file

    3. Add dependency

    4. Add plugin

2. [USAGE](#2-usage)

    1. Models

    2. Requests

## 1. INSTALLATION

### I. Get file

Install via either [bower](http://bower.io/), [npm](https://www.npmjs.com/), CDN (jsDelivr) or downloaded files:

* `bower install apiNG-plugin-rss --save`

* `npm install aping-plugin-rss --save`

* use [CDN file](https://www.jsdelivr.com/projects/aping.plugin-rss)

* download [apiNG-plugin-rss.zip](https://github.com/JohnnyTheTank/apiNG-plugin-rss/zipball/master)

### II. Include file

Include `aping-plugin-rss.min.js` in your apiNG application

```html

```

### III. Add dependency

Add the module `jtt_aping_rss` as a dependency to your app module:

```js

angular.module('app', ['jtt_aping', 'jtt_aping_rss']);

```

### IV. Add the plugin

Add the plugin's directive `aping-rss="[]"` to your apiNG directive and [configure your requests](#ii-requests)

```html

```

## 2. USAGE

### I. Models

Supported apiNG models

|  model   | content |

|----------|---------|

| `social` | **RSS feed** |

| `native` (RSS) | **RSS feed** |

### II. Requests

Every **apiNG plugin** expects an array of **requests** as html attribute.

#### Requests by URL

|  parameter  | sample | default | description | optional |

|----------|---------|---------|---------|---------|

| **`path`** | `http://blog.hackerearth.com/feed` | |  RSS feed url | no |

| **`items`**  | `15` | | Items per request (`0`-`n`) |  yes  |

| **`parseImage`**  | `false` | `true` | Use `true` for try to parse image from content. This parameter only works for `social` model |  yes  |

| **`protocol`**  | `https` |  | Use `https` or `http` to force the protocol. Leave it blank to for dynamic choice |  yes  |

Sample requests:

* `[{'path':'http://blog.hackerearth.com/feed'}, {'path':'http://www.magazin.dtv.de/index.php/feed/'}]`

* `[{'page':'http://rss.nytimes.com/services/xml/rss/nyt/Science.xml', 'items':25}]`

# Licence

MIT