Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding events consumer which provides an example of working with email events #660

Closed
wants to merge 2 commits into from

Conversation

Taiters
Copy link

@Taiters Taiters commented Oct 8, 2018

Resolves #649

Checklist

  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the [Contribution Guide] and my PR follows them.
  • I updated my branch with the master branch.
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation about the functionality in the appropriate .md file
  • I have added in line documentation to the code I modified

Short description of what this PR does:

This PR adds

  • A Dockerized Flask app which provides an example of working with email events
  • A readme with guides for
    • Deploying locally with test data
    • Deploying locally with real data (using ngrok)
    • Deploying to Heroku

This repo already contains a Procfile for the email ingress example, so I've suggested copying the events/ dir into a new repo on the users computer as part of the Heroku deploy to keep them separate.

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 8, 2018
@SendGridDX
Copy link

SendGridDX commented Oct 8, 2018

CLA assistant check
All committers have signed the CLA.

@codecov
Copy link

codecov bot commented Oct 8, 2018

Codecov Report

Merging #660 into v4 will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##               v4     #660   +/-   ##
=======================================
  Coverage   84.35%   84.35%           
=======================================
  Files          36       36           
  Lines         965      965           
  Branches      107      107           
=======================================
  Hits          814      814           
  Misses         93       93           
  Partials       58       58

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update edd02e4...84837b7. Read the comment docs.

@agnesjang98 agnesjang98 added hacktoberfest difficulty: very hard fix is very hard in difficulty type: twilio enhancement feature request on Twilio's roadmap labels Oct 11, 2018
@misterdorm misterdorm added status: work in progress Twilio or the community is in the process of implementing and removed status: code review request requesting a community code review or review from Twilio labels Oct 19, 2018
@misterdorm misterdorm self-requested a review October 19, 2018 23:40
@thinkingserious thinkingserious added status: cla not signed and removed status: work in progress Twilio or the community is in the process of implementing labels Oct 23, 2018
@thinkingserious
Copy link
Contributor

Hello @Taiters,

Could you please take a moment to sign our CLA so that we can merge this?

Also, could you please merge this against our v4 branch? Thank you!

With Best Regards,

Elmer

@thinkingserious
Copy link
Contributor

Hello @Taiters,

Thanks again for the PR!

It's HACKTOBERFEST! We want to show our appreciation by sending you some special Hacktoberfest swag. If you have not already, could you please fill out this form so we can send it to you? Thanks!

Team SendGrid DX

@Taiters Taiters changed the title [WIP] adding events consumer which writes to a file and stdout Adding events consumer which provides an example of working with email events Oct 23, 2018
@Taiters Taiters changed the base branch from master to v4 October 23, 2018 19:21
@Taiters
Copy link
Author

Taiters commented Oct 23, 2018

Hey @thinkingserious,

I've added my latest changes (docs and a slightly easier way to view events) and updated the base branch to v4.

Let me know if anything else needs added.

Thanks!
Dan

Copy link
Contributor

@misterdorm misterdorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, except I think events/data/events.db should not be part of the PR.

@Taiters
Copy link
Author

Taiters commented Oct 25, 2018

Yeah well spotted @misterdorm! I've removed that folder from the PR

events/test.py Outdated
def read_events():
with open('sample_data.json', 'r') as f:
body = f.read()
return json.loads(body)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this what json.load is for?

with open('sample_data.json', 'r') as f:
    return json.load(f)

@Taiters
Copy link
Author

Taiters commented Oct 27, 2018

@42B yeah you're right. Changed in 84837b7

@thinkingserious
Copy link
Contributor

Hello @Taiters,

Thanks again for the PR!

You have earned 15 out of the 5 points needed to receive glorious SendGrid Hacktoberfest swag.

Please take a moment to checkout this link to find more issues to get you past the required threshold or to simply continue the celebration.

Also, please be sure you have officially registered with us here by November 1, 2018 to qualify.

If you have any questions you can email us at dx+hacktoberfest2018@sendgrid.com.

Thank you and Happy Hacktobering!

Team SendGrid

@misterdorm misterdorm added status: work in progress Twilio or the community is in the process of implementing and removed status: cla not signed labels Oct 31, 2018
@Taiters
Copy link
Author

Taiters commented Dec 6, 2018

Hey, I've noticed this PR still has the WIP label. It's no longer a WIP :)

@misterdorm misterdorm added status: ready for merge code deemed fit for merge and removed status: work in progress Twilio or the community is in the process of implementing labels Dec 6, 2018
@eshanholtz eshanholtz closed this Feb 27, 2020
@eshanholtz eshanholtz added status: invalid issues not related to the library and removed status: ready for merge code deemed fit for merge labels Feb 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: very hard fix is very hard in difficulty status: invalid issues not related to the library type: twilio enhancement feature request on Twilio's roadmap
Projects
None yet
7 participants