shopify_api-graphql-tiny 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 642318b955f62a8f303f68ed41165130c2c282b2f37f71f54e4b0beb68978b7f
+  data.tar.gz: 69d6fe346564ac10490119225043f3f338df160b7055bb74a3d30f24be4f00ff
+SHA512:
+  metadata.gz: b6a3c1c73bc9604f96d4d8bb8ee3a30b34d3b7cfdf772069f2e62bcef7070e4c1098e6d35cf53f7fd5f040082775e80e66506b17718ba09c56deb9654244e764
+  data.tar.gz: 350db8c3d0db2e212533a6593119cb3fbc1db7a274a239e35c8e208bed9ddee3bd45a48300ac6fb90478025ec21ea2d2a3cf0dc3a8ec900fb801e5f7f2633030

data/.env.template

@@ -0,0 +1,9 @@
+# To run tests:
+#
+#   1. Copy this file to .env
+#   2. Fill-in the below variables with valid values.
+#      These values will be used by the tests. Data will be written to SHOPIFY_DOMAIN
+#
+SHOPIFY_DOMAIN=
+SHOPIFY_TOKEN=
+SHOPIFY_CUSTOMER_ID=

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      SHOPIFY_DOMAIN: "${{ secrets.SHOPIFY_DOMAIN }}"
+      SHOPIFY_TOKEN: "${{ secrets.SHOPIFY_TOKEN }}"
+      SHOPIFY_CUSTOMER_ID: "${{ secrets.SHOPIFY_CUSTOMER_ID }}"
+
+    strategy:
+      matrix:
+        ruby: ["3.1", "3.0", "2.7.2", "2.6.6", "2.5.8", "2.4.10"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+
+      - run: bundle install
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in shopify_api-graphql-tiny.gemspec
+gemspec
+
+gem "dotenv", :group => "test" unless ENV["CI"]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ScreenStaring
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# ShopifyAPI::GraphQL::Tiny
+
+Lightweight, no-nonsense, Shopify GraphQL Admin API client with built-in retry.
+
+![CI](https://github.com/ScreenStaring/shopify_api-graphql-tiny/actions/workflows/ci.yml/badge.svg)
+
+## Usage
+
+```rb
+require "shopify_api/graphql/tiny"
+
+gql = ShopifyAPI::GraphQL::Tiny.new("my-shop", token)
+result = gql.execute(<<-GQL, :id => "gid://shopify/Customer/1283599123")
+  query findCustomer($id: ID!) {
+    customer(id: $id) {
+      id
+      tags
+      metafields(first: 10 namespace: "foo") {
+        edges {
+          node {
+            id
+            key
+            value
+          }
+        }
+      }
+    }
+  }
+GQL
+
+customer = result["data"]["customer"]
+p customer["tags"]
+p customer.dig("metafields", "edges", 0, "node")["value"]
+
+updates = { :id => customer["id"], :tags => customer["tags"] + %w[foo bar] }
+result = gql.execute(<<-GQL, :input => updates)
+  mutation customerUpdate($input: CustomerInput!) {
+    customerUpdate(input: $input) {
+      customer {
+        id
+      }
+      userErrors {
+        field
+        message
+      }
+    }
+  }
+GQL
+
+p result.dig("data", "customerUpdate", "userErrors")
+```
+
+See [the docs](https://rdoc.info/gems/shopify_api-graphql-tiny) for complete documentation.
+
+## Testing
+
+`cp env.template .env` and fill-in `.env` with the missing values. This requires a Shopify store.
+
+## See Also
+
+- [Shopify Dev Tools](https://github.com/ScreenStaring/shopify-dev-tools) - Command-line program to assist with the development and/or maintenance of Shopify apps and stores
+- [ShopifyAPIRetry](https://github.com/ScreenStaring/shopify_api_retry) - Retry a ShopifyAPI request if rate-limited or other errors occur (REST and GraphQL APIs)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+Made by [ScreenStaring](http://screenstaring.com)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shopify_api/graphql/tiny"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shopify_api/graphql/tiny/version.rb

@@ -0,0 +1,7 @@
+module ShopifyAPI
+  module GraphQL
+    class Tiny
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/shopify_api/graphql/tiny.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+require "json"
+require "net/http"
+
+require "shopify_api_retry"
+require "shopify_api/graphql/tiny/version"
+
+module ShopifyAPI
+  module GraphQL
+    ##
+    # Client to make Shopify GraphQL Admin API requests with built-in retries.
+    #
+    class Tiny
+      Error = Class.new(StandardError)
+      ConnectionError = Class.new(Error)
+      GraphQLError = Class.new(Error)
+
+      class HTTPError < Error
+        attr_reader :code
+
+        def initialize(message, code)
+          super(message)
+          @code = code
+        end
+      end
+
+      class RateLimitError < Error
+        attr_reader :response
+
+        def initialize(message, response)
+          super(message)
+          @response = response
+        end
+      end
+
+      SHOPIFY_DOMAIN = ".myshopify.com"
+
+      ACCESS_TOKEN_HEADER = "X-Shopify-Access-Token"
+      QUERY_COST_HEADER = "X-GraphQL-Cost-Include-Fields"
+      DEFAULT_RETRY_OPTIONS = { ConnectionError => { :wait => 3, :tries => 20 }, HTTPError => { :wait => 3, :tries => 20 } }
+      DEFAULT_HEADERS = { "Content-Type" => "application/json" }.freeze
+      ENDPOINT = "https://%s/admin/api%s/graphql.json"       # Note that we omit the "/" after API for the case where there's no version.
+
+      ##
+      #
+      # Create a new GraphQL client.
+      #
+      # === Arguments
+      #
+      # [shop (String)] Shopify domain to make requests against
+      # [token (String)] Shopify Admin API GraphQL token
+      # [options (Hash)] Client options. Optional.
+      #
+      # === Options
+      #
+      # [:retry (Boolean|Hash)] +Hash+ can be retry config options. For the format see {ShopifyAPIRetry}[https://github.com/ScreenStaring/shopify_api_retry/#usage]. Defaults to +true+
+      # [:version (String)] Shopify API version to use. Defaults to the latest version.
+      # [:debug (Boolean)] Output the HTTP request/response to +STDERR+. Defaults to +false+.
+      #
+      # === Errors
+      #
+      # ArgumentError if no +shop+ or +token+ is provided.
+      #
+
+      def initialize(shop, token, options = nil)
+        raise ArgumentError, "shop required" unless shop
+        raise ArgumentError, "token required" unless token
+
+        @domain = shopify_domain(shop)
+        @options = options || {}
+
+        @headers = DEFAULT_HEADERS.dup
+        @headers[ACCESS_TOKEN_HEADER] = token
+        @headers[QUERY_COST_HEADER] = "true" if retry?
+
+        @endpoint = URI(sprintf(ENDPOINT, @domain, !@options[:version].to_s.strip.empty? ? "/#{@options[:version]}" : ""))
+      end
+
+      #
+      # Execute a GraphQL query or mutation.
+      #
+      # === Arguments
+      #
+      # [q (String)] Query or mutation to execute
+      # [variables (Hash)] Optional. Variable to pass to the query or mutation given by +q+
+      #
+      # === Errors
+      #
+      # ConnectionError, HTTPError, RateLimitError, GraphQLError
+      #
+      # * An HTTPError is raised of the response does not have 200 status code
+      # * A RateLimitError is raised if rate-limited and retries are disabled or if still rate-limited after the configured number of retry attempts
+      # * A GraphQLError is raised if the response contains an +errors+ property that is not a rate-limit error
+      #
+      # === Returns
+      #
+      # [Hash] The GraphQL response. Unmodified.
+
+      def execute(q, variables = nil)
+        config = retry? ? @options[:retry] || DEFAULT_RETRY_OPTIONS : {}
+        ShopifyAPIRetry::GraphQL.retry(config) { post(q, variables) }
+      end
+
+      private
+
+      def retry?
+        @options[:retry] != false
+      end
+
+      def shopify_domain(host)
+        domain = host.sub(%r{\Ahttps?://}i, "")
+        domain << SHOPIFY_DOMAIN unless domain.end_with?(SHOPIFY_DOMAIN)
+        domain
+      end
+
+      def post(query, variables = nil)
+        begin
+          # Newer versions of Ruby
+          # response = Net::HTTP.post(@endpoint, query, @headers)
+          params = { :query => query }
+          params[:variables] = variables if variables
+
+          post = Net::HTTP::Post.new(@endpoint.path)
+          post.body = params.to_json
+
+          @headers.each { |k,v| post[k] = v }
+
+          request = Net::HTTP.new(@endpoint.host, @endpoint.port)
+          request.use_ssl = true
+          request.set_debug_output($stderr) if @options[:debug]
+
+          response = request.start { |http| http.request(post) }
+        rescue => e
+          raise ConnectionError, "request to #@endpoint failed: #{e}"
+        end
+
+        # TODO: Even if non-200 check if JSON. See: https://shopify.dev/api/admin-graphql
+        prefix = "failed to execute query for #@domain: "
+        raise HTTPError.new("#{prefix}#{response.body}", response.code) if response.code != "200"
+
+        json = JSON.parse(response.body)
+        return json unless json.include?("errors")
+
+        errors = json["errors"].map { |e| e["message"] }.join(", ")
+        if json.dig("errors", 0, "extensions", "code") == "THROTTLED"
+          raise RateLimitError.new(errors, json) unless retry?
+          return json
+        end
+
+        raise GraphQLError, prefix + errors
+      end
+    end
+  end
+
+  GQL = GraphQL
+end

data/shopify_api-graphql-tiny.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shopify_api/graphql/tiny/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shopify_api-graphql-tiny"
+  spec.version       = ShopifyAPI::GraphQL::Tiny::VERSION
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{Lightweight, no-nonsense, Shopify Admin API GraphQL client with built-in retry.}
+  spec.homepage      = "https://github.com/ScreenStaring/shopify_api-graphql-tiny"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "shopify_api_retry", "~> 0.2"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: shopify_api-graphql-tiny
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shopify_api_retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.template"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shopify_api/graphql/tiny.rb
+- lib/shopify_api/graphql/tiny/version.rb
+- shopify_api-graphql-tiny.gemspec
+homepage: https://github.com/ScreenStaring/shopify_api-graphql-tiny
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Lightweight, no-nonsense, Shopify Admin API GraphQL client with built-in
+  retry.
+test_files: []