GQL

An attempted implementation of Facebook's yet-to-be-released GraphQL specification, heavily inspired by graphql-ruby, but with other/more/less features/bugs.

Caution! This is pre-alpha software. Use at your own risk.

Installation

Add this line to your application's Gemfile:

gem 'gql'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gql

Usage

TODO: Write usage instructions here

Example

Run bin/console for an interactive prompt and enter the following:

puts q(<<-QUERY_STRING).to_json
  user(<token>) {
    id,
    is_admin,
    full_name as name,
    created_at { year, month } as created_year_and_month,
    created_at.format("long") as created,
    account {
      bank_name,
      iban,
      saldo as saldo_string,
      saldo {
        currency,
        cents   /* silly block comment */
      }
    },
    albums.first(2) {
      count,
      edges {
        cursor,
        node {
          artist,
          title,
          songs.first(2) {
            edges {
              id,
              title.upcase as upcased_title,
              title.upcase.length as upcased_title_length
            }
          }
        }
      }
    }
  }

  <token> = "ma"  // a variable
QUERY_STRING

This should result in the following JSON (after prettyfication):

  {
    "id": "ma",
    "is_admin": true,
    "name": "Martin Andert",
    "created_year_and_month": {
      "year": 2010,
      "month": 3
    },
    "created": "March 04, 2010 14:04",
    "account": {
      "bank_name": "Foo Bank",
      "iban": "987654321",
      "saldo_string": "100000.00 EUR",
      "saldo": {
        "currency": "EUR",
        "cents": 10000000
      }
    },
    "albums": {
      "count": 2,
      "edges": [
        {
          "cursor": "1",
          "node": {
            "artist": "Metallica",
            "title": "Black Album",
            "songs": {
              "edges": [
                {
                  "id": 1,
                  "upcased_title": "ENTER SANDMAN",
                  "upcased_title_length": 13
                }, {
                  "id": 2,
                  "upcased_title": "SAD BUT TRUE",
                  "upcased_title_length": 12
                }
              ]
            }
          }
        }, {
          "cursor": "2",
          "node": {
            "artist": "Nirvana",
            "title": "Nevermind",
            "songs": {
              "edges": [
                {
                  "id": 5,
                  "upcased_title": "SMELLS LIKE TEEN SPIRIT",
                  "upcased_title_length": 23
                }, {
                  "id": 6,
                  "upcased_title": "COME AS YOU ARE",
                  "upcased_title_length": 15
                }
              ]
            }
          }
        }
      ]
    }
  }

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

1. Fork it ( https://github.com/martinandert/gql/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request