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

Tumblr Plugin for apiNG
https://github.com/johnnythetank/aping-plugin-tumblr

angular api aping aping-plugin social-wall tumblr tumblr-api

Last synced: about 1 month ago
JSON representation

Tumblr Plugin for apiNG

• Host: GitHub
• URL: https://github.com/johnnythetank/aping-plugin-tumblr
• Owner: JohnnyTheTank
• License: mit
• Created: 2015-12-29T12:40:57.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-09-10T23:14:16.000Z (over 7 years ago)
• Last Synced: 2024-11-19T21:38:42.817Z (about 2 months ago)
• Topics: angular, api, aping, aping-plugin, social-wall, tumblr, tumblr-api
• Language: JavaScript
• Size: 22.5 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[logo]: http://aping.io/logo/320/aping-plugin.png "apiNG Plugin"

![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-tumblr.svg)](https://badge.fury.io/js/aping-plugin-tumblr)

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

**_apiNG-plugin-tumblr_** is a [Tumblr API](https://www.tumblr.com/docs/en/api/v2) plugin for [**apiNG**](https://github.com/JohnnyTheTank/apiNG).

# Information

* **Supported apiNG models: `social`, `image`, `video`**

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

* This plugin needs an [api key](#2-api-key) :warning:

* Used promise library: [angular-tumblr-api-factory](https://github.com/JohnnyTheTank/angular-tumblr-api-factory) _(included in distribution files)_

# Documentation

1. [INSTALLATION](#1-installation)

    1. Get file

    2. Include file

    3. Add dependency

    4. Add plugin

2. [API KEY](#2-api-key)

    1. Generate your `api_key`

    2. Insert your `api_key` into `aping-config.js`

3. [USAGE](#3-usage)

    1. Models

    2. Requests

## 1. INSTALLATION

### I. Get file

You can choose your preferred method of installation:

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

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

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

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

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

### II. Include file

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

```html

```

### III. Add dependency

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

```js

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

```

### IV. Add the plugin

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

```html

```

## 2. API KEY

### I. Generate your `api_key`

_coming soon ..._

### II. Insert your `api_key` into `aping-config.js`

Create and open `js/apiNG/aping-config.js` in your application folder. It should be look like this snippet:

```js

angular.module('jtt_aping').config(['$provide', function ($provide) {

    $provide.value("apingDefaultSettings", {

        apingApiKeys : {

            'tumblr': [

                {'api_key':''},

            ]

            //...

        }

    });

}]);

```

:warning: Replace `` with your `api_key`

## 3. USAGE

### I. Models

Supported apiNG models

|  model   | content | support | max items
per request | (native) default items
per request |

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

| `social` | **text, links, images, videos, audio** | full    | `20`   | `20`   |

| `video`  | **videos** | full    | `20`   | `20`   |

| `image`  | **images** | full    | `20`   | `20`   |

**support:**

* full: _the source platform provides a full list with usable results_

* partly: _the source platfrom provides just partly usable results_

### II. Requests

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

#### Requests by Page

|  parameter  | sample | default | description | optional |

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

| **`page`** | `camaradakalderra` |  | The standard or custom blog hostname  | no |

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

| **`tag`** | `soccer` |  | Limits the response to posts with the specified tag | yes |

Sample requests:

* `[{'page':'namikamusik'}]`

* `[{'page':'camaradakalderra', 'tag':'soccer', 'items':14}]`

# Licence

MIT