apiNG-plugin-codebird is a Twitter REST API plugin for apiNG.

• Supported apiNG models: social, image
• This plugin supports the get-native-data parameter
• This plugin needs an bearer token ⚠️
• Used JavaScript library: codebird-js (included in distribution files)

1. INSTALLATION
   1. Get file
   2. Include file
   3. Add dependency
   4. Add plugin
2. BEARER TOKEN
   1. Generate your bearer_token
   2. Insert your bearer_token into aping-config.js
3. USAGE
   1. Models
   2. Requests
   3. Rate limit

Install via either bower, npm, CDN (jsDelivr) or downloaded files:

• bower install apiNG-plugin-codebird --save
• npm install aping-plugin-codebird --save
• use CDN file
• download apiNG-plugin-codebird.zip

Include aping-plugin-codebird.min.js in your apiNG application

<!-- when using bower -->
<script src="bower_components/apiNG-plugin-codebird/dist/aping-plugin-codebird.min.js"></script>

<!-- when using npm -->
<script src="node_modules/aping-plugin-codebird/dist/aping-plugin-codebird.min.js"></script>

<!-- when using cdn file -->
<script src="//cdn.jsdelivr.net/npm/aping-plugin-codebird@latest/dist/aping-plugin-codebird.min.js"></script>

<!-- when using downloaded files -->
<script src="aping-plugin-codebird.min.js"></script>

Add the module jtt_aping_codebird as a dependency to your app module:

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

Add the plugin's directive aping-codebird="[]" to your apiNG directive and configure your requests

<aping
    template-url="templates/social.html"
    model="social"
    items="20"
    aping-codebird="[{'search':'#music'}]">
</aping>

1. Login on dev.twitter.com
2. Navigate to apps.twitter.com
   • Create an new app
   • Navigate to https://apps.twitter.com/app/<YOUR_APP_ID>/permissions
     • Change Access to Read only and save
   • Navigate to https://apps.twitter.com/app/<YOUR_APP_ID>
3. Get your bearer_token
   • Follow this official introductions: https://dev.twitter.com/oauth/reference/post/oauth2/token
   • OR just use this simple generator: https://gearside.com/nebula/documentation/utilities/twitter-bearer-token-generator/

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

angular.module('jtt_aping').config(['$provide', function ($provide) {
    $provide.value("apingDefaultSettings", {
        apingApiKeys : {
            twitter: [
                {'bearer_token':'<YOUR_TWITTER_BEARER_TOKEN>'}
            ],
            //...
        }
    });
}]);

⚠️ Replace <YOUR_TWITTER_BEARER_TOKEN> with your twitter bearer_token

Supported apiNG models

support:

• full: the source platform provides a full list with usable results
  
• partly: the source platfrom provides just partly usable results

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

Sample requests:

• [{'user':'johnnyzeitlos'}, {'user':'jowe'}, {'user':'angularui'}]
• [{'user':'AngularAir', 'items':10, 'showAvatar':'true', 'exclude_replies':true}]

Sample requests:

• [{'search':'#eagles', 'result_type':'recent'}, {'search':'Thomas Müller', 'result_type':'popular'}]
• [{'search':'machu picchu', 'lat':'-13.163333', 'lng':'-72.545556', 'distance':5}]

Visit the official Twitter REST API rate limit documentations

• Rate Limits
• Rate Limits: Chart

MIT