No commit activity in last 3 years
No release in over 3 years
Securely proxying graphql requests from our app to shopify
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.15
~> 5.0
~> 1.0
~> 10.0

Runtime

~> 0.6.4
 Project Readme

shopify-graphql_proxy

Gem to securely proxy graphql requests to Shopify from Rack based Apps

  • Avoid CORS complications by proxying from same domain to Shopify
  • Allows client side scripts to query a logged in merchant's shop without needing to know the users acces token

Installation

Add the following to your Gemfile

gem 'shopify-graphql_proxy', '-> 0.1.0'

Or install:

gem install shopify-graphql_proxy

Usage

It is recommended to use the omniauth-shopify-oauth2 to authenticate requests with Shopify

use Shopify::GraphQLProxy

This middleware expects that the session data is stored in the shopify key

session[:shopify] = {
  shop: shop_name,
  token: token
}

It will proxy any POST request to /graphql on your app to the current logged in shop found in session

Get GraphQL data from client side with logged in merchant's shop

fetch('/graphql', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ query: '{ shop { name } }' }),
  credentials: 'include'
})
  .then(res => res.json())
  .then(res => console.log(res.data));

Custom path

You can use the Rack::Builder#map method to specify middleware to run under specific path

# /shopify/graphql

map('/shopify') do
  use Shopify::GraphQLProxy
  run Proc.new { |env| [200, {'Content-Type' => 'text/plain'}, ['get rack\'d']]}
end

map('/') do
  run App
end

Thanks