shopify_graphql 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7081c7f634ac890bc428d5eb2e67d260cebf1dae0cb56ee514d375a39de76c2f
-  data.tar.gz: 48e7c7b931e462502a93359e175ec13858988e5435be1f3e8dc114b75680103c
+  metadata.gz: '018b4cef704098a6424fda98cb9805a11e86c29fd3e5a391e5945687a7ddc621'
+  data.tar.gz: 1f4e1be2f4b3edbf319251023a6a9d596bf34fa1f877dc51269d0cd9bb5db6f7
 SHA512:
-  metadata.gz: a9db31af58e597e5d0b91e66e388ae8d1a2b75afcc08fc0c75e9a3a84ac3ffd4f2b94466c3747ed5131750b19d88283ec274ae6c366ea377368f6d98303a72d4
-  data.tar.gz: 4b8ad458b06267f51d35b9b1e56d85ec3f7ed4582928cba184567f047c8cd628e6d80d1d70199a004c9a0fbfeacd14bf624e80af4ed7f9b1f10e04ed1664fb12
+  metadata.gz: e2d0fdd479419a47c2647dffdc6cf65c1c09dfd6b66b35e2e13df9827b0844f0ee2191471d3a53ac42ddb60ecfec2f180457e61082fb209a385628e49c0a62af
+  data.tar.gz: cb05b2a483d83066fc233625938da8243905086baa31b0b29b1b6ff1af82f1b0afd5eb8534b4f3539b9f79fcc6c866a56295db1587a0a168fef33dbfe1242e3a

data/README.md

@@ -10,8 +10,8 @@ Less painful way to work with [Shopify Graphql API](https://shopify.dev/api/admi
 - Graphql webhooks integration
 - Built-in error handling
 - No schema and no memory issues
+- Buil-in retry on error
 - (Planned) Testing helpers
-- (Planned) Buil-in retry on error
 - (Planned) Pre-built calls for common Graphql operations
 
 ## Usage

data/app/graphql/shopify_graphql/app_subscription_fields.rb

@@ -0,0 +1,68 @@
+module ShopifyGraphql
+  class AppSubscriptionFields
+    FRAGMENT = <<~GRAPHQL
+      fragment AppSubscriptionFields on AppSubscription {
+        id
+        name
+        status
+        createdAt
+        trialDays
+        currentPeriodEnd
+        test
+        lineItems {
+          id
+          plan {
+            pricingDetails {
+              __typename
+              ... on AppRecurringPricing {
+                price {
+                  amount
+                }
+                interval
+              }
+              ... on AppUsagePricing {
+                balanceUsed {
+                  amount
+                }
+                cappedAmount {
+                  amount
+                }
+                interval
+                terms
+              }
+            }
+          }
+        }
+      }
+    GRAPHQL
+
+    def self.parse(data)
+      recurring_line_item = data.lineItems.find do |line_item|
+        line_item.plan.pricingDetails.__typename == "AppRecurringPricing"
+      end
+      recurring_pricing = recurring_line_item&.plan&.pricingDetails
+      usage_line_item = data.lineItems.find do |line_item|
+        line_item.plan.pricingDetails.__typename == "AppUsagePricing"
+      end
+      usage_pricing = usage_line_item&.plan&.pricingDetails
+
+      OpenStruct.new(
+        id: data.id,
+        name: data.name,
+        status: data.status,
+        created_at: data.createdAt && Time.parse(data.createdAt),
+        trial_days: data.trialDays,
+        current_period_end: data.currentPeriodEnd && Time.parse(data.currentPeriodEnd),
+        test: data.test,
+        recurring_line_item_id: recurring_line_item&.id,
+        recurring_price: recurring_pricing&.price&.amount&.to_d,
+        recurring_interval: recurring_pricing&.interval,
+        usage_line_item_id: usage_line_item&.id,
+        usage_balance: usage_pricing&.balanceUsed&.amount&.to_d,
+        usage_capped_amount: usage_pricing&.cappedAmount&.amount&.to_d,
+        usage_interval: usage_pricing&.interval,
+        usage_terms: usage_pricing&.terms
+      )
+    end
+  end
+end

data/app/graphql/shopify_graphql/cancel_subscription.rb

@@ -0,0 +1,34 @@
+module ShopifyGraphql
+  class CancelSubscription
+    include Mutation
+
+    MUTATION = <<~GRAPHQL
+      mutation appSubscriptionCancel($id: ID!) {
+        appSubscriptionCancel(id: $id) {
+          appSubscription {
+            id
+          }
+          userErrors {
+            field
+            message
+          }
+        }
+      }
+    GRAPHQL
+
+    def call(id:)
+      response = execute(MUTATION, id: id)
+      response.data = response.data.appSubscriptionCancel
+      handle_user_errors(response.data)
+      response.data = parse_data(response.data)
+      response
+    end
+
+    private
+
+    def parse_data(data)
+      subscription = OpenStruct.new(id: data.appSubscription.id)
+      OpenStruct.new(subscription: subscription)
+    end
+  end
+end

data/app/graphql/shopify_graphql/create_recurring_subscription.rb

@@ -0,0 +1,64 @@
+module ShopifyGraphql
+  class CreateRecurringSubscription
+    include Mutation
+
+    MUTATION = <<~GRAPHQL
+      #{AppSubscriptionFields::FRAGMENT}
+
+      mutation appSubscriptionCreate(
+        $name: String!,
+        $lineItems: [AppSubscriptionLineItemInput!]!,
+        $returnUrl: URL!,
+        $trialDays: Int,
+        $test: Boolean
+      ) {
+        appSubscriptionCreate(
+          name: $name,
+          lineItems: $lineItems,
+          returnUrl: $returnUrl,
+          trialDays: $trialDays,
+          test: $test
+        ) {
+          appSubscription {
+            ... AppSubscriptionFields
+          }
+          confirmationUrl
+          userErrors {
+            field
+            message
+          }
+        }
+      }
+    GRAPHQL
+
+    def call(name:, price:, return_url:, trial_days: nil, test: nil, interval: :monthly)
+      payload = {name: name, returnUrl: return_url}
+      plan_interval = interval == :monthly ? "EVERY_30_DAYS" : "ANNUAL"
+      payload[:lineItems] = [{
+        plan: {
+          appRecurringPricingDetails: {
+            price: {amount: price, currencyCode: "USD"},
+            interval: plan_interval
+          }
+        }
+      }]
+      payload[:trialDays] = trial_days if trial_days
+      payload[:test] = test if test
+
+      response = execute(MUTATION, **payload)
+      response.data = response.data.appSubscriptionCreate
+      handle_user_errors(response.data)
+      response.data = parse_data(response.data)
+      response
+    end
+
+    private
+
+    def parse_data(data)
+      OpenStruct.new(
+        subscription: AppSubscriptionFields.parse(data.appSubscription),
+        confirmation_url: data.confirmationUrl
+      )
+    end
+  end
+end

data/app/graphql/shopify_graphql/create_usage_subscription.rb

@@ -0,0 +1,62 @@
+module ShopifyGraphql
+  class CreateUsageSubscription
+    include Mutation
+
+    MUTATION = <<~GRAPHQL
+      #{AppSubscriptionFields::FRAGMENT}
+
+      mutation appSubscriptionCreate(
+        $name: String!,
+        $returnUrl: URL!,
+        $test: Boolean
+        $lineItems: [AppSubscriptionLineItemInput!]!,
+      ) {
+        appSubscriptionCreate(
+          name: $name,
+          returnUrl: $returnUrl,
+          test: $test
+          lineItems: $lineItems,
+        ) {
+          appSubscription {
+            ... AppSubscriptionFields
+          }
+          confirmationUrl
+          userErrors {
+            field
+            message
+          }
+        }
+      }
+    GRAPHQL
+
+    def call(name:, return_url:, terms:, capped_amount:, test: false)
+      response = execute(
+        MUTATION,
+        name: name,
+        returnUrl: return_url,
+        test: test,
+        lineItems: [{
+          plan: {
+            appUsagePricingDetails: {
+              terms: terms,
+              cappedAmount: {amount: capped_amount, currencyCode: "USD"}
+            }
+          }
+        }]
+      )
+      response.data = response.data.appSubscriptionCreate
+      handle_user_errors(response.data)
+      response.data = parse_data(response.data)
+      response
+    end
+
+    private
+
+    def parse_data(data)
+      OpenStruct.new(
+        subscription: AppSubscriptionFields.parse(data.appSubscription),
+        confirmation_url: data.confirmationUrl
+      )
+    end
+  end
+end

data/app/graphql/shopify_graphql/get_app_subscription.rb

@@ -0,0 +1,33 @@
+module ShopifyGraphql
+  class GetAppSubscription
+    include Query
+
+    QUERY = <<~GRAPHQL
+      #{AppSubscriptionFields::FRAGMENT}
+
+      query($id: ID!) {
+        node(id: $id) {
+          ... AppSubscriptionFields
+        }
+      }
+    GRAPHQL
+
+    def call(id:)
+      response = execute(QUERY, id: id)
+      response.data = parse_data(response.data)
+      response
+    end
+
+    private
+
+    def parse_data(data)
+      unless data.node
+        raise ResourceNotFound.new(200, "Subscription not found")
+      end
+
+      OpenStruct.new(
+        subscription: AppSubscriptionFields.parse(data.node),
+      )
+    end
+  end
+end

data/lib/shopify_graphql/client.rb

@@ -1,5 +1,16 @@
 module ShopifyGraphql
   class Client
+    RETRIABLE_EXCEPTIONS = [
+      Errno::ETIMEDOUT,
+      Errno::ECONNREFUSED,
+      Errno::EHOSTUNREACH,
+      'Timeout::Error',
+      Faraday::TimeoutError,
+      Faraday::RetriableResponse,
+      Faraday::ParsingError,
+      Faraday::ConnectionFailed,
+    ].freeze
+
     def initialize(api_version = ShopifyAPI::Base.api_version)
       @api_version = api_version
     end
@@ -29,6 +40,7 @@ module ShopifyGraphql
       @connection ||= Faraday.new(url: api_url, headers: request_headers) do |conn|
         conn.request :json
         conn.response :json, parser_options: { object_class: OpenStruct }
+        conn.request :retry, max: 3, interval: 1, backoff_factor: 2, exceptions: RETRIABLE_EXCEPTIONS
       end
     end
 

data/lib/shopify_graphql/engine.rb

@@ -17,7 +17,7 @@ module ShopifyGraphql
     engine_name 'shopify_graphql'
     isolate_namespace ShopifyGraphql
 
-    initializer "shopify_app.redact_job_params" do
+    initializer "shopify_graphql.redact_job_params" do
       ActiveSupport.on_load(:active_job) do
         if ActiveJob::Base.respond_to?(:log_arguments?)
           CreateWebhooksJob.log_arguments = false

data/lib/shopify_graphql/version.rb

@@ -1,3 +1,3 @@
 module ShopifyGraphql
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/shopify_graphql.rb

@@ -1,3 +1,4 @@
+require 'shopify_api'
 require 'faraday'
 require 'faraday_middleware'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_graphql
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: shopify_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shopify_app
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +90,11 @@ files:
 - LICENSE.txt
 - README.md
 - app/controllers/shopify_graphql/graphql_webhooks_controller.rb
+- app/graphql/shopify_graphql/app_subscription_fields.rb
+- app/graphql/shopify_graphql/cancel_subscription.rb
+- app/graphql/shopify_graphql/create_recurring_subscription.rb
+- app/graphql/shopify_graphql/create_usage_subscription.rb
+- app/graphql/shopify_graphql/get_app_subscription.rb
 - config/routes.rb
 - lib/shopify_graphql.rb
 - lib/shopify_graphql/client.rb
@@ -122,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Less painful way to work with Shopify Graphql API in Ruby.