heyquarry-shopify-profile-sync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d468da3b0e40914a555e63fe18f42324843da1cf9a34efc14bcce700b4356e7b
+  data.tar.gz: 4241e02242faf3241fc5c574fd2c3aa87d69ce5ceec628ef28ae34d26df5766f
+SHA512:
+  metadata.gz: 3f02c4cfad47cfcca693269c4f103a262632ea20fa31d74d9cd2db8c26971fbd152c3a255e2d1a2d55d52612aab3e3ba7e5e5f5e63aa5dbfb50c083ac8fa03f1
+  data.tar.gz: a70874641192926d0028392f09fa167a07071a11c5cc3be01bb79e74d13b8ba2273d140e701815f4533fb00c422f165b97226b02a2aac6531d44f004333c505c

data/lib/heyquarry/shopify_profile_sync/shop_query.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module HeyQuarry
+  module ShopifyProfileSync
+    SHOP_PROFILE_QUERY = <<~GRAPHQL.squish
+      query HeyQuarryShopProfile {
+        shop {
+          id
+          name
+          email
+          contactEmail
+          myshopifyDomain
+          description
+          plan { displayName }
+          billingAddress { phone countryCodeV2 }
+          primaryDomain { host }
+        }
+      }
+    GRAPHQL
+
+    module ShopQuery
+      module_function
+
+      def map_shop_to_payload(shop)
+        return nil unless shop.is_a?(Hash) && shop["myshopifyDomain"]
+
+        email = shop["email"]&.strip
+        email = shop["contactEmail"]&.strip if email.nil? || email.empty?
+
+        payload = { shopDomain: shop["myshopifyDomain"] }
+        payload[:email] = email if email && !email.empty?
+        payload[:phone] = shop.dig("billingAddress", "phone") if shop.dig("billingAddress", "phone")
+        payload[:shopifyPlan] = shop.dig("plan", "displayName") if shop.dig("plan", "displayName")
+        payload[:countryCode] = shop.dig("billingAddress", "countryCodeV2") if shop.dig("billingAddress", "countryCodeV2")
+        payload[:customDomain] = shop.dig("primaryDomain", "host") if shop.dig("primaryDomain", "host")
+        payload[:about] = shop["description"] if shop["description"]
+        payload[:shopGid] = shop["id"] if shop["id"]
+        payload[:shopName] = shop["name"] if shop["name"]
+        payload
+      end
+    end
+  end
+end

data/lib/heyquarry/shopify_profile_sync/sync.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+
+module HeyQuarry
+  module ShopifyProfileSync
+    DEFAULT_PROFILE_URL = "https://www.heyquarry.com/api/shopify/shops/profile"
+    DEFAULT_ADMIN_API_VERSION = "2026-01"
+
+    SyncResult = Struct.new(:ok, :skipped, :shop_domain, :status, :error, keyword_init: true)
+
+    module Sync
+      module_function
+
+      def sync_from_session(shop_domain:, access_token:, api_key: nil, profile_url: nil, admin_api_version: DEFAULT_ADMIN_API_VERSION)
+        resolved = resolve_options(api_key: api_key, profile_url: profile_url)
+        shop = fetch_shop_from_session(shop_domain, access_token, admin_api_version)
+        payload = ShopQuery.map_shop_to_payload(shop)
+        return skipped("Shop profile missing myshopifyDomain") unless payload
+
+        post_profile(resolved[:profile_url], resolved[:api_key], payload)
+      end
+
+      def sync_from_admin_client(client, api_key: nil, profile_url: nil)
+        resolved = resolve_options(api_key: api_key, profile_url: profile_url)
+        response = client.query(query: SHOP_PROFILE_QUERY)
+        shop = response.body.dig("data", "shop")
+        payload = ShopQuery.map_shop_to_payload(shop)
+        return skipped("Shop profile missing myshopifyDomain") unless payload
+
+        post_profile(resolved[:profile_url], resolved[:api_key], payload)
+      end
+
+      def post_profile_to_heyquarry(payload, api_key: nil, profile_url: nil)
+        resolved = resolve_options(api_key: api_key, profile_url: profile_url)
+        return skipped("shopDomain is required") unless payload.is_a?(Hash) && payload[:shopDomain]
+
+        post_profile(resolved[:profile_url], resolved[:api_key], payload)
+      end
+
+      def resolve_options(api_key:, profile_url:)
+        key = api_key || ENV["HEYQUARRY_APP_API_KEY"]
+        raise ArgumentError, "HeyQuarry app API key is required. Pass api_key: or set HEYQUARRY_APP_API_KEY." if key.nil? || key.strip.empty?
+
+        url = profile_url || ENV["HEYQUARRY_PROFILE_URL"] || DEFAULT_PROFILE_URL
+        { api_key: key.strip, profile_url: url.sub(%r{/\z}, "") }
+      end
+
+      def fetch_shop_from_session(shop_domain, access_token, admin_api_version)
+        host = shop_domain.sub(%r{\Ahttps?://}, "").sub(%r{/\z}, "")
+        uri = URI("https://#{host}/admin/api/#{admin_api_version}/graphql.json")
+        request = Net::HTTP::Post.new(uri)
+        request["Content-Type"] = "application/json"
+        request["X-Shopify-Access-Token"] = access_token
+        request.body = JSON.generate(query: SHOP_PROFILE_QUERY)
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
+        JSON.parse(response.body).dig("data", "shop")
+      end
+
+      def post_profile(profile_url, api_key, payload)
+        uri = URI(profile_url)
+        request = Net::HTTP::Post.new(uri)
+        request["Content-Type"] = "application/json"
+        request["X-App-Api-Key"] = api_key
+        request.body = JSON.generate(payload.transform_keys(&:to_s))
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(request) }
+        if response.is_a?(Net::HTTPSuccess)
+          SyncResult.new(ok: true, shop_domain: payload[:shopDomain], status: response.code.to_i)
+        else
+          SyncResult.new(
+            ok: false,
+            shop_domain: payload[:shopDomain],
+            status: response.code.to_i,
+            error: response.body.to_s[0, 300].presence || response.message,
+          )
+        end
+      end
+
+      def skipped(message)
+        SyncResult.new(ok: false, skipped: true, error: message)
+      end
+    end
+  end
+end

data/lib/heyquarry/shopify_profile_sync/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module HeyQuarry
+  module ShopifyProfileSync
+    VERSION = "0.1.0"
+  end
+end

data/lib/heyquarry/shopify_profile_sync.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "shopify_profile_sync/version"
+require_relative "shopify_profile_sync/shop_query"
+require_relative "shopify_profile_sync/sync"
+
+module HeyQuarry
+  module ShopifyProfileSync
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: heyquarry-shopify-profile-sync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- HeyQuarry
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-06-25 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- support@heyquarry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/heyquarry/shopify_profile_sync.rb
+- lib/heyquarry/shopify_profile_sync/shop_query.rb
+- lib/heyquarry/shopify_profile_sync/sync.rb
+- lib/heyquarry/shopify_profile_sync/version.rb
+homepage: https://heyquarry.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Sync Shopify shop profile (email, plan, phone) to HeyQuarry after OAuth install.
+test_files: []