Skip to content

chaskiq/chaskiq-ruby-client

Repository files navigation

ChaskiqRubyClient

The chaskiq client allows you to interact with the Chaqkiq Graphql api,this library allows you to connect to any chaskiq instance.

Installation

Add this line to your application's Gemfile:

gem 'chaskiqRubyClient'

And then execute:

$ bundle

Or install it yourself as:

$ gem install chaskiqRubyClient

Usage

This library is based on graphlient so the same api is compatible to interface the chaskiq api

require "chaskiq-client"

token = "YOUR_CHASKIQ_ACCESS_TOKEN"
client.new("http://YOUR_CHASKIQ_INSTANCE/graphql", token)

#compose query

q = <<-'GRAPHQL'
    mutation($appKey: String!, $email: String!){
    inviteAgent(appKey: $appKey, email: $email){
        agent {
        email
        avatarUrl
        name
        }
    }
    }
GRAPHQL

result = client.query(q, {
    email: "[email protected]",
    appKey: "3v1y3UejFtX1itkssgdi-A",
})

# get results
result.data.invite_agent.agent.email

Development

After checking out the repo, run bin/setup to install dependencies. 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]/chaskiqRubyClient. 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 ChaskiqRubyClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published