surikat 0.3.0 → 0.3.1

data/README.md

@@ -407,7 +407,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/alxx/s
 
 ## Version
 
-This code reflects version 0.2.5.
+This code reflects version 0.3.0.
 
 ## License
 

data/exe/surikat

@@ -143,7 +143,8 @@ def exemplify_mutations(query_name, route)
   r_args.each.each do |var_name, var_type|
     k_var_name = ActiveSupport::Inflector.singularize(var_name.underscore)
     variables[k_var_name] = {}
-    all_types[var_type]['arguments'].each do |a, t|
+    arguments = all_types[var_type] && all_types[var_type]['arguments'] || []
+    arguments.each do |a, t|
       next if a == 'id' && route['method'] == 'create' # yes, someone may make create queries with other names
       if Types::BASIC.include?(t)
         variables[k_var_name][a] = random_values(t)

data/frontend-demo/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2018 Blackrock Digital LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/frontend-demo/README.md

@@ -0,0 +1,89 @@
+# Surikat Demo
+
+This is a collection of three HTML pages which test a few basic [Surikat](https://github.com/alxx/surikat) features.
+The layout is based on [Bare](http://startbootstrap.com/template-overviews/bare/) by [Start Bootstrap](http://startbootstrap.com/) 
+and, in addition to Bootstrap and jQuery, it uses [jquery-graphql](https://www.jquerycards.com/media/tables-graphs/jquery-graphql/).
+
+## Page 1. Authors
+
+The purpose of this page is to implement CRUD (create, retrieve, update and delete) operations using GraphQL.
+These operations can automatically created in a Surikat app by means of a scaffold command:
+
+```bash
+$ surikat generate scaffold Author name:string yob:integer
+$ rake db:migrate
+```
+
+## Page 2. Books
+
+To further comment on Surikat's simplicity, there's a secondary page where an author's list of books
+can be managed. In order for this to work, first the underlying scaffold must be generated:
+
+```bash
+$ surikat generate scaffold Book title:string
+$ rake db:migrate
+```
+
+Then, the `Author` and `Book` models need to be connected
+
+```ruby
+class Author < Surikat::BaseModel
+  has_many :books, dependent: :destroy
+end
+```
+
+```ruby
+class Book < Surikat::BaseModel
+  belongs_to :author
+end
+```
+
+And finally, the `Author` GraphQL type needs to include a field called `books`. So in `config/types.yml` add the last line, `books: "[Book]"`:
+
+```yaml
+Author:
+  type: Output
+  fields:
+    name: String
+    yob: Int
+    age: Int
+    created_at: String
+    updated_at: String
+    id: ID
+    books: "[Book]"
+```
+
+## Page 3. AAA
+
+The last page in this demo works with authentication, authorisation and access control (AAA).
+
+It requires that AAA is added to the Surikat app:
+
+```bash
+$ surikat generate aaa
+$ rake db:migrate
+```
+
+and that there's a user to login with:
+
+```bash
+$ bin/console
+> User.create email:'a@b.c', password:'1'
+```
+
+### Live Reload
+
+If you want to edit this demo and would like the benefits of live reloading, you can use `gulp`. First, install the necessary modules:
+
+```bash
+$ npm install
+```
+
+Then, the `gulp` command line interface:
+
+```bash
+$ npm install gulp-cli
+```
+
+Now, if you run `gulp dev` the index page will open in a browser, and it will refresh
+when you make changes in the files.

data/frontend-demo/aaa.html

@@ -0,0 +1,153 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="description" content="">
+    <meta name="author" content="">
+
+    <title>Surikat Demo</title>
+
+    <!-- Bootstrap core CSS -->
+    <link href="vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">
+
+    <!-- Custom styles for this template -->
+    <style>
+        body {
+            padding-top: 54px;
+        }
+
+        @media (min-width: 992px) {
+            body {
+                padding-top: 56px;
+            }
+        }
+
+    </style>
+
+</head>
+
+<body>
+
+<!-- Navigation -->
+<nav class="navbar navbar-expand-lg navbar-dark bg-dark fixed-top">
+    <div class="container">
+        <a class="navbar-brand" href="https://github.com/alxx/surikat">
+            <img src="https://camo.githubusercontent.com/b17e471f697a115ac68f565e637602328c402478/68747470733a2f2f692e696d6775722e636f6d2f4f6c43557733382e706e67"
+                 width="26" height="40" alt="">
+            Surikat Demo
+        </a>
+        <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarResponsive"
+                aria-controls="navbarResponsive" aria-expanded="false" aria-label="Toggle navigation">
+            <span class="navbar-toggler-icon"></span>
+        </button>
+        <div class="collapse navbar-collapse" id="navbarResponsive">
+            <ul class="navbar-nav ml-auto">
+                <li class="nav-item">
+                    <a class="nav-link" href="index.html">Authors</a>
+                </li>
+                <li class="nav-item">
+                    <a class="nav-link" href="books.html">Books</a>
+                </li>
+                <li class="nav-item active">
+                    <a class="nav-link" href="aaa.html">AAA</a>
+                    <span class="sr-only">(current)</span>
+                </li>
+            </ul>
+        </div>
+    </div>
+</nav>
+
+<!-- Page Content -->
+<div class="container">
+    <div class="row">
+        <div class="col-lg-12 text-center">
+            <h1 class="mt-5">Authentication, Authorisation, Access</h1>
+
+
+            <div id="not-logged-in">
+                <form>
+
+                    <div class="input-group mb-3">
+                        <div class="input-group-prepend">
+                            <label class="input-group-text" for="email">Email</label>
+                        </div>
+                        <input type="text" class="form-control" placeholder="Enter your email address" id="email">
+                    </div>
+
+                    <div class="input-group mb-3">
+                        <div class="input-group-prepend">
+                            <label class="input-group-text">Password</label>
+                        </div>
+                        <input type="password" class="form-control" placeholder="Enter your password" id="password">
+                    </div>
+
+                    <button type="submit" class="btn btn-primary" id="btnLogin" disabled="disabled">Login</button>
+                </form>
+            </div>
+
+            <div id="logged-in" style="display: none;">
+                <div id="current_user" class="alert alert-primary mb-3">You are logged in.</div>
+
+                <table class="table mb-lg-5">
+                    <tr width="100%">
+                        <td width="33%">
+                            <div class="card mb-lg-5">
+                                Click this button to make a call to CurrentUser.<br/>
+                                <button class="btn btn-outline-info" id="btnCurUser">Retrieve current user</button>
+                            </div>
+                        </td>
+                        <td width="33%">
+                            <div class="card mb-lg-5">
+                                Try to call DemoTwo, which only users who have the role 'hotdog' or 'hamburger' may call
+                                <button class="btn btn-outline-info" id="btnProtected">Try a role-protected action</button>
+                            </div>
+                        </td>
+                        <td width="33%">
+                            <div class="card mb-lg-5">
+                                Logout as this user and return to the login form
+                                <button class="btn btn-outline-info" id="btnLogout">Logout</button>
+                            </div>
+                        </td>
+                    </tr>
+                </table>
+
+            </div>
+
+        </div>
+    </div>
+</div>
+
+<!-- Bootstrap core JavaScript -->
+<script src="vendor/jquery/jquery.min.js"></script>
+<script src="vendor/bootstrap/js/bootstrap.bundle.min.js"></script>
+
+<!-- GraphQL Plugin -->
+<script src="vendor/graphql.min.js"></script>
+
+<!-- Notifications -->
+<script src="vendor/notify.min.js"></script>
+
+<!-- App -->
+<script src="aaa.js"></script>
+
+<script language="JavaScript">
+    $(document).ready(function () {
+
+        $('input[type="text"]').keyup(function () {
+            if ($(this).val() != '') {
+                $(':input[type="submit"]').prop('disabled', false);
+            } else {
+                $(':input[type="submit"]').prop('disabled', true);
+            }
+        });
+
+        run();
+    })
+</script>
+
+</body>
+
+</html>

data/frontend-demo/aaa.js

@@ -0,0 +1,115 @@
+var graph = graphql("http://localhost:3000/", {
+    headers: {
+      'Surikat':  'abc'//Math.random().toString(36).replace(/[^a-z]+/g, '')
+    }
+});
+
+var current_user;
+
+$("#btnLogin").click(function (el) {
+    el.preventDefault();
+
+    $(this).attr('disabled', true);
+
+    var email = $('#email').val();
+    var password = $('#password').val();
+
+    authenticate(email, password);
+});
+
+$('#btnCurUser').click(function (el) {
+    el.preventDefault();
+
+    $(this).attr('disabled', true);
+    getCurrentUser();
+});
+
+$('#btnLogout').click(function (e) {
+    e.preventDefault();
+
+    logout();
+});
+
+$('#btnProtected').click(function (e) {
+    e.preventDefault();
+
+    demoTwo();
+});
+
+function demoTwo() {
+    var q = '{DemoTwo}';
+    console.log('calling a role-protected method...');
+
+    graph.query.run(q).then(function (r) {
+        $.notify(r.DemoTwo, {position: 'top left', autoHideDelay: 3000})
+    }).catch(function(error) {
+        if (error.find(e => e.accessDenied)) {
+            $.notify('Access denied', {position: "top center", autoHideDelay: 3000});
+        } else {
+            alert(JSON.stringify(error))
+        }
+    })
+}
+
+function logout() {
+    var q = '{Logout}';
+    console.log('logging out...');
+
+    graph.query.run(q).then(function (r) {
+        $.notify('You have been logged out.', {position: "top center", autoHideDelay: 3000});
+        $('#not-logged-in').show();
+        $('#logged-in').hide();
+        $('#btnLogin').removeAttr('disabled');
+    }).catch(function(error) {
+        alert(JSON.stringify(error))
+    })
+}
+
+function getCurrentUser() {
+    var q = '{CurrentUser {id,email,roleids}}';
+    console.log('getting current user...');
+
+    graph.query.run(q).then(function (r) {
+        current_user = r.CurrentUser;
+        console.log('current user: ', current_user);
+
+        $('#not-logged-in').hide();
+        $('#logged-in').show();
+
+        $('#current_user').html(`You are logged in as ${current_user.email}. Your roles are: ${current_user.roleids}`);
+        $.notify(`You are logged in as ${current_user.email}. Your roles are: ${current_user.roleids}`, {position: "top center", autoHideDelay: 3000});
+        $('#btnCurUser').removeAttr('disabled');
+    }).catch(function(error) {
+        if (error.find(e => e.accessDenied)) {
+            $.notify('Bad credentials', {position: "top center", autoHideDelay: 3000});
+        } else {
+            alert(JSON.stringify(error))
+        }
+        alert(JSON.stringify(error))
+    })
+}
+
+function authenticate(email, password) {
+    var q = `{Authenticate(email: "${email}", password: "${password}")}`;
+    console.log(`logging in...`);
+
+    graph.query.run(q).then(function (r) {
+        $.notify('Successfully authenticated!', {position: "top center", autoHideDelay: 3000});
+        $('#not-logged-in').hide();
+        $('#logged-in').show();
+    }).catch(function (error) {
+        if (error.find(e => e.noResult)) {
+            $.notify('Bad credentials', {position: "top center", autoHideDelay: 3000});
+        } else {
+            alert(JSON.stringify(error))
+        }
+        $('#btnLogin').removeAttr('disabled');
+    })
+}
+
+
+function run() {
+    console.log('starting...');
+
+    getCurrentUser();
+}

data/frontend-demo/authors.js

@@ -0,0 +1,159 @@
+var graph = graphql("http://localhost:3000/", {});
+
+$(document).on("click", '#all tbody tr', function (tr) {
+    var id = $(tr.target.parentNode).data('id');
+
+    // simple way to ignore graphql if the click was on a link
+    if (tr.target.outerHTML.indexOf('<a href') == -1) {
+        setAuthor(id);
+    }
+});
+
+$("#btnDelete").click(function (el) {
+    el.preventDefault();
+
+    var id = $('#author_id').val();
+
+    $(this).attr('disabled', true);
+    $("#btnSubmit").attr('disabled', true);
+    deleteAuthor(id);
+});
+
+$("#btnSubmit").click(function (el) {
+    el.preventDefault();
+
+    $(this).attr('disabled', true);
+    $("#btnDelete").attr('disabled', true);
+
+    var id = $('#author_id').val();
+    var name = $('#name').val();
+    var yob = $('#yob').val();
+
+    if (id == null || id === "") {
+        console.log('save author');
+        saveAuthor(name, yob);
+    } else {
+        console.log('update author');
+        updateAuthor(id, name, yob);
+    }
+});
+
+function setAuthor(id) {
+    var q = `{Author(id: ${id}) {name,yob}}`;
+    console.log(`loading author ${id}...`);
+
+    graph.query.run(q).then(function (r) {
+        author = r.Author;
+        console.log(author);
+        $("#author_id").val(id);
+        $("#name").val(author.name);
+        $("#yob").val(author.yob);
+
+        $("#btnSubmit").removeAttr('disabled');
+        $("#btnDelete").removeAttr('disabled');
+    }).catch(function (error) {
+        alert(JSON.stringify(error))
+    })
+}
+
+function saveAuthor(name, yob) {
+    var q = `mutation Author($author: AuthorInput) {Author(author: $author) {id}}`;
+    var vars = {author: {name: name, yob: parseInt(yob)}};
+    console.log('creating author...');
+
+    var create = graph(q);
+
+    create(vars).then(function (r) {
+        author = r.Author;
+        $.notify(`Author created with id ${author.id}`, {position: "top center", autoHideDelay: 3000});
+
+        $("#author_id").val(author.id);
+
+        $("#btnSubmit").removeAttr('disabled');
+        $("#btnDelete").removeAttr('disabled');
+
+        authorList();
+    }).catch(function (error) {
+        alert(JSON.stringify(error))
+    })
+}
+
+function updateAuthor(id, name, yob) {
+    var q = `mutation UpdateAuthor($author: AuthorInput) {UpdateAuthor(author: $author) {id}}`;
+    var vars = {author: {id: id, name: name, yob: parseInt(yob)}};
+    console.log(`updating author ${id}...`);
+
+    var update = graph(q);
+
+    update(vars).then(function (r) {
+        author = r.UpdateAuthor;
+        $.notify(`Author updated`, {position: "top center", autoHideDelay: 3000});
+
+        $("#btnSubmit").removeAttr('disabled');
+        $("#btnDelete").removeAttr('disabled');
+
+        authorList();
+    }).catch(function (error) {
+        alert(JSON.stringify(error))
+    })
+}
+
+function deleteAuthor(id) {
+    var q = `mutation DeleteAuthor($id: ID) {DeleteAuthor(id: $id)}`;
+    var vars = {id: id};
+    console.log(`deleting author ${id}...`);
+
+    var del = graph(q);
+
+    del(vars).then(function (r) {
+        $.notify(`Author ${id} deleted.`, {position: "top center", autoHideDelay: 3000});
+
+        $('#author_id').val(null);
+        $('#name').val(null);
+        $('#yob').val(null);
+
+        authorList();
+    }).catch(function (error) {
+        alert(JSON.stringify(error))
+    })
+}
+
+function authorList() {
+    $("#all > tbody").html("");
+
+    var q = `{
+        Authors {
+          id
+          name
+          yob
+          created_at
+          updated_at
+          books {
+            id
+          }
+       }
+    }`;
+
+    console.log('loading authors...');
+
+    graph.query.run(q).then(function (all) {
+        all.Authors.forEach(function (r) {
+            $('#all tbody').append(`<tr data-id="${r.id}"><th scope="row">${r.id}</th>
+                    <td>${r.name}</td>
+                    <td>${r.yob}</td>
+                    <td>${r.created_at}</td>
+                    <td>${r.updated_at}</td>
+                    <td><a href="books.html?author_id=${r.id}">${r.books.length}</a></td></tr>`);
+        });
+
+    }).catch(function (error) {
+        alert(JSON.stringify(error));
+    })
+}
+
+
+function run() {
+    console.log('starting...');
+
+    authorList();
+}