Giter Club home page Giter Club logo

reviews-to-slack's Introduction

reviews-to-slack

Build Status npm version Coverage Status dependencies Status

Node.js library for posting App Store and Google Play app reviews to Slack.

var reviews = require('reviews-to-slack')
reviews.start({
  slackHook: 'https://hooks.slack.com/services/T00000000/B00000000/token',
  appId: '123456789'
})

Installation

npm install reviews-to-slack

Usage

Quick setup

Only provide mandatory fields to send reviews for an app to the default channel for the webhook.

var reviews = require('reviews-to-slack')
reviews.start({
  slackHook: 'https://hooks.slack.com/services/T00000000/B00000000/token',
  appId: '123456789'
})

More complex setup

Example that sends reviews for different apps to different channels. Can be extended with any combination of the options (see below).

var reviews = require('reviews-to-slack')
var apps = [
  {
    appId: '123456789',
    channel: '#channel'
  },
  {
    appId: 'com.my.app',
    channel: '@user'
  }
]
for (var i = 0; i < apps.length; i++) {
  var app = apps[i]
  reviews.start({
    slackHook: 'https://hooks.slack.com/services/T00000000/B00000000/token',
    appId: app.appId,
    channel: app.channel
  })
}

start(options) -- Available options

  • slackHook: Mandatory, URL to an incoming Slack webhook.
  • appId: Mandatory, ID of an app in App Store or Google Play, e.g. 123456789 or com.my.app.
  • region: Two-letter country code for App Store (e.g. us), or two-letter language code for Google Play (e.g. en).
  • interval: How often the feed should be queried, in seconds. Default: 300
  • debug: Set to true to log debug information and send welcome message to Slack. Default: false
  • channel: Which channel to post to, set to override channel set in Slack.
  • store: To explicitly set the store, app-store or google-play. In most cases desired store can be derived from the appId so setting this is usually not required.
  • botUsername: Set to override the default bot username set in Slack.
  • botIcon: Set to override the default bot icon set in Slack.
  • appName: Set to override the app name fetched from the reviews provider.
  • appIcon: Set to override the app icon fetched from the reviews provider.
  • appLink: Set to override the app link fetched from the reviews provider.

FAQ

Why don't I receive any App Store reviews, or why are they coming in bursts?

Apple is caching their reviews feed quite heavily; you can check if there's actually a new review available by going to https://itunes.apple.com/{region}/rss/customerreviews/id={appId}/sortBy=mostRecent/xml. It may take several hours between updates to the feed. If you see a new review in the feed and it's not delivered to Slack in a timely manner, please file an issue.

License

MIT

reviews-to-slack's People

Contributors

wahni avatar

Watchers

James Cloos avatar James Futhey avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.