Code Monkey home page Code Monkey logo

github-app's Introduction

Authenticate as a GitHub App

This library provides functions that help with authenticating as a GitHub App.

Use

  1. Register your App with GitHub to obtain an App ID and a private key.
  2. Using the data from the step above, create AppAuth.
  3. For each installation of your app, get an InstallationAuth using mkInstallationAuth.
  4. Use the executeAppRequest function to execute requests. Behind the scenes, this function exchanges the installation auth token for a regular access token, caches it, and renews as needed.

See serokell/github-ops-access for a real-life example use.

About Serokell

This library is maintained and funded with ❤️ by Serokell. The names and logo for Serokell are trademark of Serokell OÜ.

github-app's People

Contributors

haskell-mouse avatar kirelagin avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

ilyakooo0

github-app's Issues

Create a library foundation

Here is a proposed design:

  1. Create a module called GitHub.App.
  2. Put there a data type called InstallationAuth with these three fields and one private field which is an
    IORef with an actual token.
    3)Put there a function authenticateInstallation :: InstallationAuth -> IO Auth which checks the expiration
    date on the token and if it is valid returns just this token wrapped into OAuth, else goes to the API,
    obtains a new token, caches it to the IORef and returns.

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.