Giter Club home page Giter Club logo

status-reporter's Introduction

status-reporter

Build status

Gem for reporting on the status of things. Webhooks, pubsub, and more.

Installation

In your Gemfile:

gem 'status-reporter', github: '<your repo>/status-reporter'

Usage

require 'status_reporter'

The StatusReporter module is the only thing you need to require. It contains all the subclasses.

Then instantiate one of the subclasses and start using it. Here is an example:

reporter = StatusReporter::WebhookReporter.new
reporter.success_url = "http://example.com/success"
reporter.failure_url = "http://example.com/failure"
reporter.status_url "http://example.com/status"

params = {"file_location" => "/path/to/my/file.csv"}

reporter.report_success(params)

API structure

All implementors of the BaseReporter implement the same methods:

  • report_success(params=nil)
  • report_failure(params=nil)
  • report_status(params=nil)

License

Apache 2.0 (see LICENSE file for more)

status-reporter's People

Contributors

simonykq avatar daveseward avatar

Watchers

James Cloos 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.