Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

graphql_client

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

graphql_client

  • 0.4.1
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

A Ruby GraphQL Client

Build Status

This is an early stage attempt at a generic GraphQL client in Ruby.

This client offers two APIs:

  1. Query Builder
  2. Raw Queries

The Query Builder is considered unstable and should be used with caution.

We recommend start with raw queries since it offers an easy migration path to another API or library. With the raw queries, you are just writing plain GraphQL queries as strings.

Below you'll find some usage examples.

Usage

Create a client:

client = GraphQL::Client.new(Pathname.new('path/to/schema.json')) do
  configure do |c|
    c.url = "https://#{shopify_domain}/admin/api/graphql.json"
    c.read_timeout = 1 # 5 seconds is the default
    c.headers = {
      'X-Shopify-Access-Token' => shopify_token
    }
  end
end

Raw Queries

client.raw_query('
  query {
    shop {
       name
      }
    }
')

Query Builder

query = client.build_query do |q|
  q.add_field('shop') do |shop|
    shop.add_field('name')
  end
end

client.query(query)

More complex query using a connection:

query = client.build_query do |q|
  q.add_field('product', id: 'gid://Product/1') do |product|
    product.add_connection('images', first: 10) do |connection|
      connection.add_field('src')
    end
  end

  q.add_field('shop') do |shop|
    shop.add_field('name')

    shop.add_field('billingAddress') do |billing_address|
      billing_address.add_fields('city', 'country')
    end
  end
end

client.query(query)

Responses

Both query and raw_query methods return a response object that converts the JSON to Ruby objects offering easy method access instead of via a Hash.

Example:

response = client.raw_query('
  query {
    shop {
       name
      }
    }
')

puts response.shop.name

Extensions

The GraphQL specification allows for an extensions key in the response. To access this data use the raw_query_with_extensions method instead. It will return a tuple of response objects, one for the data key and one for the extensions key.

data, extensions = client.raw_query_with_extensions('
  query {
    shop {
       name
      }
    }
')

FAQs

Package last updated on 29 Mar 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc