ApolloUploadServer
Middleware which allows you to upload files using graphql-ruby, apollo-upload-client and Ruby on Rails.
Note: this implementation uses v2 of the GraphQL multipart request spec, so you should use apollo-upload-client library >= v7.0.0-alpha.3. If you need support for v1 of the GraphQL multipart request spec, you must use version 1.0.0 of this gem.
Installation
Add this line to your application's Gemfile:
gem 'apollo_upload_server', '2.1'
And then execute:
$ bundle
Or install it yourself as:
$ gem install apollo_upload_server
Middleware will be used automatically.
Gem adds custom Upload
type to your GraphQL types.
Use ApolloUploadServer::Upload
type for your file as input field:
input_field :file, ApolloUploadServer::Upload
That's all folks!
Configuration
The following configuration options are supported:
Strict Mode
This can be set on ApolloUploadServer::Middleware
:
ApolloUploadServer::Middleware.strict_mode = true
Doing so ensures that all mapped array values are present in the input. If this
is set to true
, then for following request:
{
"operations": {
"query": "mutation { ... }",
"operationName": "SomeOperation",
"variables": {
"input": { "id": "123", "avatars": [null, null] }
}
}
}
A mapping for variables.input.avatars.0
or variables.input.avatars.1
, will work, but one for
variables.input.avatars.100
will not, and will raise an error.
In strict mode, passing empty destination arrays will always fail.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/jetruby/apollo_upload_server-ruby. 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.
Tests can be run via bundle exec rspec
.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the ApolloUploadServer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
About JetRuby
ApolloUploadServer is maintained and founded by JetRuby Agency.
We love open source software! See our projects or contact us to design, develop, and grow your product.