Skip to content

Commit

Permalink
Added mailgun example.
Browse files Browse the repository at this point in the history
  • Loading branch information
jmdobry committed Oct 21, 2015
1 parent e941b43 commit ed1e39d
Show file tree
Hide file tree
Showing 13 changed files with 434 additions and 0 deletions.
1 change: 1 addition & 0 deletions appengine/mailgun/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
./config.js
62 changes: 62 additions & 0 deletions appengine/mailgun/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
## Mailgun on Google App Engine

> [Mailgun](https://www.mailgun.com/): The Email Service For Developers
### Sign up for Mailgun

1. Sign up for a [Mailgun account](https://mailgun.com/signup).
1. Add a [new domain](https://mailgun.com/app/domains).
1. Find your API key in your new domain's settings.

### Create a new Node.js app

This example is going to use [Express.js](http://expressjs.com).

### Configure

Create an `app.yaml` in the root of your application with the following
contents:

```yaml
runtime: nodejs
vm: true
api_version: 1
env_variables:
PORT: 8080
```
Create a `config.js` in the root of your application with the following
contents:

```yaml
module.exports = {
mailgunApiKey: 'your-mailgun-api-key'
};
```

### Start the app locally

```
$ npm start
```
Now visit http://localhost:8080 and try sending yourself an email.
### Deploy
For convenience, you can use an npm script to run the `gcloud` command. Add
these lines to your `package.json` file:
```json
"scripts": {
"start": "node ./bin/www",
"deploy": "gcloud preview app deploy app.yaml --promote --project <your-project-id>"
}
```

At the terminal you can now run the following command to deploy your
application:

```
$ npm deploy
```
72 changes: 72 additions & 0 deletions appengine/mailgun/app.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
// Copyright 2015, Google, Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

var express = require('express');
var path = require('path');
var logger = require('morgan');
var cookieParser = require('cookie-parser');
var bodyParser = require('body-parser');

var routes = require('./routes/index');
var hello = require('./routes/hello');

var app = express();

// view engine setup
app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'jade');

app.use(logger('dev'));
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));

app.use('/', routes);
app.use('/hello', hello);

// catch 404 and forward to error handler
app.use(function(req, res, next) {
var err = new Error('Not Found');
err.status = 404;
next(err);
});

// error handlers

// development error handler
// will print stacktrace
if (app.get('env') === 'development') {
app.use(function(err, req, res) {
res.status(err.status || 500);
res.render('error', {
message: err.message,
error: err
});
});
}

// production error handler
// no stacktraces leaked to user
app.use(function(err, req, res) {
res.status(err.status || 500);
res.render('error', {
message: err.message,
error: {}
});
});


module.exports = app;
20 changes: 20 additions & 0 deletions appengine/mailgun/app.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Copyright 2015, Google, Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# [START app_yaml]
runtime: nodejs
vm: true
api_version: 1
env_variables:
PORT: 8080
# [END app_yaml]
90 changes: 90 additions & 0 deletions appengine/mailgun/bin/www
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
#!/usr/bin/env node

'use strict';

// [START server]

/**
* Module dependencies.
*/
var app = require('../app');
var debug = require('debug')('express:server');
var http = require('http');

/**
* Get port from environment and store in Express.
*/
var port = normalizePort(process.env.PORT || 8080);
app.set('port', port);

/**
* Create HTTP server.
*/

var server = http.createServer(app);

/**
* Listen on provided port, on all network interfaces.
*/
server.listen(port);
server.on('error', onError);
server.on('listening', onListening);

// [END server]

/**
* Normalize a port into a number, string, or false.
*/
function normalizePort(val) {
var port = parseInt(val, 10);

if (isNaN(port)) {
// named pipe
return val;
}

if (port >= 0) {
// port number
return port;
}

return false;
}

/**
* Event listener for HTTP server "error" event.
*/
function onError(error) {
if (error.syscall !== 'listen') {
throw error;
}

var bind = typeof port === 'string'
? 'Pipe ' + port
: 'Port ' + port;

// handle specific listen errors with friendly messages
switch (error.code) {
case 'EACCES':
console.error(bind + ' requires elevated privileges');
process.exit(1);
break;
case 'EADDRINUSE':
console.error(bind + ' is already in use');
process.exit(1);
break;
default:
throw error;
}
}

/**
* Event listener for HTTP server "listening" event.
*/
function onListening() {
var addr = server.address();
var bind = typeof addr === 'string'
? 'pipe ' + addr
: 'port ' + addr.port;
debug('Listening on ' + bind);
}
3 changes: 3 additions & 0 deletions appengine/mailgun/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
mailgunApiKey: 'key-4z6h5ysqalzctf97y-17dqzbnlpxz8b8'
};
24 changes: 24 additions & 0 deletions appengine/mailgun/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"name": "appengine-mailgun",
"description": "An example of using Mailgun in Node.js on Google App Engine.",
"version": "0.0.1",
"private": true,
"license": "Apache Version 2.0",
"engines": {
"node": "~0.12.7"
},
"scripts": {
"start": "node ./bin/www",
"deploy": "gcloud preview app deploy app.yaml --promote --project mailgun-demo"
},
"dependencies": {
"body-parser": "^1.14.1",
"cookie-parser": "^1.4.0",
"debug": "^2.2.0",
"express": "^4.13.3",
"jade": "^1.11.0",
"mailgun": "^0.5.0",
"morgan": "^1.6.1",
"serve-favicon": "^2.3.0"
}
}
21 changes: 21 additions & 0 deletions appengine/mailgun/public/stylesheets/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/** Copyright 2015, Google, Inc.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
body {
padding: 50px;
font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
}

a {
color: #00B7FF;
}
50 changes: 50 additions & 0 deletions appengine/mailgun/routes/hello.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// Copyright 2015, Google, Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

var express = require('express');
var router = express.Router();
var config = require('../config');
var Mailgun = require('mailgun').Mailgun;
var mg = new Mailgun(config.mailgunApiKey);

var link = 'https://github.com/GoogleCloudPlatform/nodejs-docs-samples/tree/master/appengine/mailgun'; // jshint ignore:line

// [START send]
router.post('/', function(req, res, next) {
var servername = '';
var options = {};

mg.sendText(
'no-reply@appengine-mailgun-demo.com',
req.body.email,
'Hello World!',
'Go to ' + link + ' to read about using Mailgun on Google App Engine.',
servername,
options,
function (err) {
if (err) {
return next(new Error('Failed to send email!'));
} else {
return res.render('index', {
title: 'Hello World! Express.js on Google App Engine.',
sent: true
});
}
}
);
});
// [END send]

module.exports = router;
27 changes: 27 additions & 0 deletions appengine/mailgun/routes/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Copyright 2015, Google, Inc.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

var express = require('express');
var router = express.Router();

// [START hello_world]
router.get('/', function(req, res) {
res.render('index', {
title: 'Hello World! Express.js on Google App Engine.'
});
});
// [END hello_world]

module.exports = router;
Loading

0 comments on commit ed1e39d

Please sign in to comment.