Git Product home page Git Product logo

fcc_reporting's Introduction

FCC Reporting Service

This service gathers the information necessary to support the periodic reporting required by the FCC. It automates the retrieval of customer data from ChargeBee and provides an interface to upload the FCC Fabric data that is sent from the FCC's contractor to Emerald via email.

When the FCC data is submitted to the application, the Emerald customer data is retrieved and analyzed to build a set of relevant records. Those records are then used to create the CSV reports suitable to be uploaded to the FCC website.

Running the Server

This is a Rust application and can be built and run from any system with a working Rust toolchain.

Running on Docker

docker build .
docker run -it -p 8000:8000 [HASH OUTPUT FROM BUILD]

Running Bare Metal

RUST_LOG=debug cargo run --bin server

Before executing the server, you will need to add some configuration data in the .env file at the root of this application.

API_URL=https://emeraldbroadband.chargebee.com/api/v2/subscriptions
API_KEY=live_TRUNCATED:

Note that the API_KEY above is truncated. Also note the trailling ':' character; that is required. This string is used as the Basic HTTP authentication parameter in the ChargeBee URL. That normally would take the format username:password but ChargeBee is just using the username field.

The API_URL should be as specified above.

Standard Usage

At its most basic, this is a web page with a single upload element for the Fabric data with a display showing the completed reports. Once running, you can browse to http://localhost:8000 and you should be presented with a form to select and submit the FCC Fabric CSV file.

The form is currently completely unstyled. It's the minimum necessary to make the function work. I'll add some basic aesthetics to it when I have the core functionality working.

API Usage

The functionality is accessible via API and can be accessed using curl in this way.

curl -F 'file=@./FCCFabric-FocusAreas.csv' http://localhost:8000/focus

Submitting the Fabric data as a multipart form to the /focus endpoint will kick off all of the analysis and report generation. This is exactly what submitting the file through the HTML form does as well.

fcc_reporting's People

Contributors

justindthomas avatar

Watchers

 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.