GraphQL::Model

A Ruby library to make using GraphQL 100% more awesome

Installation

Add this line to your application's Gemfile:

gem 'graphql-model'

And then execute:

$ bundle

Or install it yourself as:

$ gem install graphql-model

Usage

Define your class.

class Character < GraphQL::Model::Base
  attributes :name, :appears_in

  graphql_path "http://graphql-ruby-demo.herokuapp.com/queries"

  define_query :hero do
    def query(episode: :Episode)
      f = fragment
      super do
        hero(episode: episode) do
          _ f
        end
      end
    end
  end
end

Then execute your queries.

 $ Character.query_hero(episode: :EMPIRE)
=> {
     "hero" => Character<name: "Luke Skywalker", appears_in: ["NEWHOPE", "EMPIRE", "JEDI"]>
   }

Learn more.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also 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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/graphql-model. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Graphql::Model project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.