https://github.com/benaubin/graphql-model
A Ruby library to make using GraphQL 100% more awesome
https://github.com/benaubin/graphql-model
dsl graphql graphql-client ruby
Last synced: 2 months ago
JSON representation
A Ruby library to make using GraphQL 100% more awesome
- Host: GitHub
- URL: https://github.com/benaubin/graphql-model
- Owner: benaubin
- License: mit
- Created: 2017-08-13T20:05:35.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-18T21:54:11.000Z (almost 9 years ago)
- Last Synced: 2025-04-03T21:44:46.370Z (about 1 year ago)
- Topics: dsl, graphql, graphql-client, ruby
- Language: Ruby
- Size: 66.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GraphQL::Model
A Ruby library to make using GraphQL 100% more awesome
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'graphql-model'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install graphql-model
## Usage
Define your class.
```ruby
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.
```ruby
$ Character.query_hero(episode: :EMPIRE)
=> {
"hero" => Character
}
```
[Learn more](https://github.com/benaubin/graphql-model/wiki/Fields).
## 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](https://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](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## 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](https://github.com/[USERNAME]/graphql-model/blob/master/CODE_OF_CONDUCT.md).