Giter Club home page Giter Club logo

sharpenup's Introduction

CircleCI Coveralls NuGet Twitter

Sharpen Up

A .Net Standard library for working with the Uptime Robot API.

About

This is a library for working with the Uptime Robot API. It allows you to easily integrate the metrics and tooling provided by Uptime Robot into your own applications.

Note: This includes all endpoints EXCEPT the endpoints required to create or edit a Monitor. There were too many moving parts involved in that process to feel good about it. If you need to create a monitor, I recommend doing it through the Uptime Robot webpage.

This project adheres to the Contributor Covenant Code of Conduct.

Usage

You can either clone this repo and add the .csproj file to your project or add it via NuGet using the command:

dotnet add package SharpenUp

Usage Examples

Development

For information on the setting up the environment, see the Environment Setup document.

Acknowldegements

  • Uptime Robot - Really, this library doesn't make sense without their service.
  • RestSharp - Making REST calls isn't terribly difficult in C#, but RestSharp makes it even easier. Especially when you're trying to stuff queries into the request body.
  • Shields.io - Having matching badges that aren't a nightmare to work with is nice and I appreciate that there's a service to make it work.
  • Coveralls - This is my first time really messing with code coverage. It was pretty easy to get my foot in the door with Coveralls.
  • CircleCI - Aside from dealing with .Net issues, CircleCI provides an easy way to get CI into your project.

sharpenup's People

Contributors

ianknighton avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

linecomparison

sharpenup's Issues

GetAlertContacts( int alertContactId ) Requires Seven Digits

Describe the bug
If an ID with less than 7 digits is passed into the method, the API will not return results. Ultimately, this may be an issue with the API, but it should be able to handle it in the code.

To Reproduce

  1. Call the GetAlertContacts( int alertContactId ) method with an ID less than 1000000.

Environmental Information

  • Running in XUnit tests.

Expected behavior
Leading 0's should be added to fit the requirement of the API.

Additional context
It may be worth experimenting with adding multiple leading 0's to future proof another integer being added and breaking all previous ID's.

Create/Update Monitors

Is your feature request related to a problem? Please describe.
Currently, there is no way to create or update Monitors.

Describe the solution you'd like
I'd like the ability to do that.

Describe alternatives you've considered
It can be done through the Uptime Robot dashboard.

Additional context
I created an issue for this for a few reasons:

  1. To see if there's a need.
  2. To track others that may ever need it.
  3. In hopes of preventing others from creating issues.

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.