https://github.com/coderofsalvation/ohmygraph

Easily generate a REST (graph)client from a json api-modelspecification. Like restangular/traverse/backbone/restful but more atheist-style.
https://github.com/coderofsalvation/ohmygraph

Last synced: about 1 year ago
JSON representation

Easily generate a REST (graph)client from a json api-modelspecification. Like restangular/traverse/backbone/restful but more atheist-style.

• Host: GitHub
• URL: https://github.com/coderofsalvation/ohmygraph
• Owner: coderofsalvation
• License: bsd-3-clause
• Created: 2015-11-04T21:34:12.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2020-09-10T17:56:39.000Z (almost 6 years ago)
• Last Synced: 2025-03-31T09:16:39.196Z (about 1 year ago)
• Language: Shell
• Homepage: http://coderofsalvation.github.io/ohmygraph/index.html
• Size: 400 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          


# Usage:

    npm install ohmygraph

or in the browser (6k when gzipped):

     

Try the [online editor](http://coderofsalvation.github.io/ohmygraph/index.html)

# Video

[![VIDEO](http://img.youtube.com/vi/XrE-KVrLSaI/0.jpg)](http://www.youtube.com/watch?v=XrE-KVrLSaI)

    

# Example: github api

    ohmygraph = require 'ohmygraph'

    graph =

      repositories:

        type: "array"

        items: [{"$ref":"#/repository"}]

        data: { sort:'stars',q:'ohmy',order:'desc' }

        request:

          get:

            config:

              method: 'get'

              url: '/search/repositories'

              payload:

                q: '{repositories.data.q}'

                sort: '{repositories.data.sort}'

                order: '{repositories.data.order}'

            data: "{response.items}"

      repository:

        type: "object"

        properties: { ..... }

        data: {}

        request:

          get:

            config:

              method: 'get'

              url: '/repos/{repository.data.full_name}'

              payload: {}

            data: "{response}"

          post:

            type: "request"

            config:

              method: "post"

              url: '/repos/{repository.data.full_name}'

              payload:

                'full_name': '{repository.data.full_name}'

    omg = ohmygraph.create graph, {baseurl: "https://api.github.com",verbose:2}

    omg.init.client()

    client = omg.graph

    client.repositories.on 'data', (repositories) ->

      console.log "on repositories"

      repositories[0].get()

    client.repository.on 'data', (repository) ->

      console.log "on repository"

      console.dir repository

    # lets request data!

    client.repositories.get()

    client.repositories.get {q:"foo"}

# Features

* modular multi-api REST client

* resource linking (using a graph)

* easy to use with API's generated from json-model (just convert the model)

* only deal with dataobjects in javascript, not with REST code

* datamodel does not dictate api model (like backbone)

* fully customizable webcalls using fetch, [docs here](see https://www.npmjs.com/package/whatwg-fetch)

# Example: combining API's

    api_one = {..}

    api_two = {..}

    omg = ohmygraph.create();

    omg.graph = api_one;

    for (k in api_two) omg.graph[k] = api_two[k];

    omg.init.client();

# Example: patching/extending api-calls

Sometimes an jsonmodel needs to be patched.

Luckily, [json-ref-lite](https://www.npmjs.com/package/json-ref-lite#example-json-inheritance-extensions)'s "$extend" keys are automatically parsed.

# Api 

graph = graph

> access your resolved graph here

create(graph = {},opts = {})

> create graph

init.client()

> generate client functions from graph(after create())

extend()

> extend "$extend" keys in graph

resolve()

> resolve "$ref" references in graph

export_functions(return_array_boolean)

> dump client functions as string or array

yournode.bindrequests(node)

> autobind client requesthandlers on node

yournode.trigger(event,data)

> trigger an event on your nodeyournode.trigger('foo',{data:'bar'})

yournode.on(event,cb)

> register an event on your nodeyournode.on( 'foo', function(){} )

yournode.clone()

> call clone() on a node to keep the original intact 

get(node)

> get node with name x

clone(obj)

> deep clone object utility function

onWarning(err)

> customizable warning function

onError()

> customizable error/catch function

# Inspired by

This work was inspired by the thought that linking of resources could happen on a json model-level, instead of only on a RESTful level (interpreting links from responses).

Ohmygraph is pretty much jsonbased and framework- and API-agnostic, but it was inspired by:

[backbone/exoskeleton](http://backbonejs.org)

> requires particular api design

[restangular](https://github.com/mgonto/restangular)

> angular based router which requires angular + a particular api design.

[restful.js](https://github.com/marmelab/restful.js)

> restangular without angular but with particular api design

[traverson](https://github.com/basti1302/traverson)

> no restmapping, only linking