stigg-api-client 0.0.1.pre.b.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2f8a82740d256bf027b896fc6a0fe74e3c38daa8b930a891e6a648624b5b28f
-  data.tar.gz: a4788ccaa8586a675618666e5452dbd4aea1b502df25b7808fa706768e207914
+  metadata.gz: eb5028b371f0211e5eb36b851f178f31511e4fab423638d92724e534d120a400
+  data.tar.gz: 31e5e37fab257d53fd006f5854ad3c8e4650398607a4c7113ba37901eef34df8
 SHA512:
-  metadata.gz: a7750418ce25ad2f0e92b39192db5597cea37700d76eee08599e4f3cc1683f5f80cc1ddcd845f73e53e37b68ed54c30ae1545c684359a40c691ab0b056b78d9c
-  data.tar.gz: 1a4b7c1179c6b7eb0c77b0db92614b43482444b84facb2b676a12e39aaadb965c7b1d3d71a7471d1bed9ef8dc170a46707f058d6c94fa365467b4aebf87a254b
+  metadata.gz: 84fde9de567650ab41a0ee5f13f7322303dae573457dbe276082c77dce300b1444ab3d1e7f8f0f087dd5c790ffa1abca16ef349387603f3c80cced268882f994
+  data.tar.gz: 3dbab4968ff612a628dca33a59766b802d397d6a48d5a4ab8c06f2c809790eaf89383126380df2e8336d44dbfcee0c753a134a9eb96beb77b06d359ae1c877ea

data/Gemfile

@@ -10,5 +10,3 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
-
-gem "bump", "~> 0.10"

data/Gemfile.lock

@@ -1,36 +1,35 @@
 PATH
   remote: .
   specs:
-    stigg-api-client (0.0.1.pre.b.4)
+    stigg-api-client (0.1.0)
       graphlient (~> 0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    bump (0.10.0)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    faraday (2.7.4)
+    faraday (2.6.0)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
     graphlient (0.7.0)
       faraday (~> 2.0)
       graphql-client
-    graphql (2.0.20)
+    graphql (2.0.15)
     graphql-client (0.18.0)
       activesupport (>= 3.0)
       graphql
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
-    minitest (5.18.0)
+    minitest (5.16.3)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -65,17 +64,14 @@ GEM
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    tzinfo (2.0.6)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
 
 PLATFORMS
-  arm64-darwin-22
   x86_64-darwin-21
-  x86_64-linux
 
 DEPENDENCIES
-  bump (~> 0.10)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/README.md

@@ -1,7 +1,10 @@
 # Stigg::Client
 
-This Ruby gem provides a wrapper to [Stigg's GraphQL API](https://docs.stigg.io/docs/graphql-api) based on the operations that are in use by the [Stigg's Node.js SDK](https://docs.stigg.io/docs/nodejs-sdk). 
-It leverages the [graphlient](https://github.com/ashkan18/graphlient) library under the hood, and utilizes the `Graphlient::Client` class to execute the API requests.
+This library provides a Ruby wrapper to [Stigg's GraphQL API](https://docs.stigg.io/docs/graphql-api) based on
+the operations the [Stigg's Node.js SDK](https://docs.stigg.io/docs/nodejs-sdk) is using under the hood.
+
+It leverages the [graphlient](https://github.com/ashkan18/graphlient) library, and utilizes the `Graphlient::Client` class to send the API requests.
+
 
 ## Documentation
 

data/lib/stigg/client.rb

@@ -19,8 +19,6 @@ module Stigg
     # @param [String api_url
     # @return [Client]
     def create_client(api_key, api_url = "https://api.stigg.io/graphql", request_timeout=30)
-      schema_path = File.join(__dir__, 'generated/schema.json').to_s
-
       client = Graphlient::Client.new(
         api_url,
         headers: {
@@ -30,7 +28,7 @@ module Stigg
           read_timeout: request_timeout,
           write_timeout: request_timeout
         },
-        schema_path: schema_path
+        schema_path: 'schema.json'
       )
 
       Client.new(client)

data/lib/stigg/generated/operations.rb

@@ -0,0 +1,608 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Fragment
+    PlanFragment = <<~GRAPHQL
+      fragment PlanFragment on Plan {
+        id: refId
+        displayName
+        description
+        metadata: additionalMetaData
+        product {
+          id: refId
+          displayName
+          description
+        }
+        basePlan {
+          id: refId
+          displayName
+        }
+        entitlements {
+          ...PackageEntitlementFragment
+        }
+        inheritedEntitlements {
+          ...PackageEntitlementFragment
+        }
+        compatibleAddons {
+          ...AddonFragment
+        }
+        prices {
+          ...PriceFragment
+        }
+        pricingType
+        defaultTrialConfig {
+          duration
+          units
+        }
+      }
+    GRAPHQL
+
+    TotalPriceFragment = <<~GRAPHQL
+      fragment TotalPriceFragment on CustomerSubscriptionTotalPrice {
+        subTotal {
+          amount
+          currency
+        }
+        total {
+          amount
+          currency
+        }
+      }
+    GRAPHQL
+
+    PriceFragment = <<~GRAPHQL
+      fragment PriceFragment on Price {
+        billingModel
+        billingPeriod
+        price {
+          amount
+          currency
+        }
+        feature {
+          ...FeatureFragment
+        }
+      }
+    GRAPHQL
+
+    PackageEntitlementFragment = <<~GRAPHQL
+      fragment PackageEntitlementFragment on PackageEntitlement {
+        usageLimit
+        hasUnlimitedUsage
+        featureId
+        resetPeriod
+        feature {
+          ...FeatureFragment
+        }
+      }
+    GRAPHQL
+
+    AddonFragment = <<~GRAPHQL
+      fragment AddonFragment on Addon {
+        id: refId
+        displayName
+        description
+        metadata: additionalMetaData
+        entitlements {
+          ...PackageEntitlementFragment
+        }
+        pricingType
+      }
+    GRAPHQL
+
+    SubscriptionFragment = <<~GRAPHQL
+      fragment SubscriptionFragment on CustomerSubscription {
+        id: refId
+        status
+        startDate
+        endDate
+        trialEndDate
+        cancellationDate
+        effectiveEndDate
+        currentBillingPeriodEnd
+        metadata: additionalMetaData
+        billingId
+        billingLinkUrl
+        prices {
+          usageLimit
+          price {
+            ...PriceFragment
+          }
+        }
+        totalPrice {
+          ...TotalPriceFragment
+        }
+        pricingType
+        plan {
+          ...PlanFragment
+        }
+        addons {
+          id
+          quantity
+          addon {
+            ...AddonFragment
+          }
+        }
+      }
+    GRAPHQL
+
+    PromotionalEntitlementFragment = <<~GRAPHQL
+      fragment PromotionalEntitlementFragment on PromotionalEntitlement {
+        status
+        usageLimit
+        featureId
+        hasUnlimitedUsage
+        resetPeriod
+        endDate
+        isVisible
+        feature {
+          ...FeatureFragment
+        }
+      }
+    GRAPHQL
+
+    CouponFragment = <<~GRAPHQL
+      fragment CouponFragment on Coupon {
+        id: refId
+        name
+        description
+        type
+        discountValue
+        metadata: additionalMetaData
+        createdAt
+        updatedAt
+        billingId
+        billingLinkUrl
+        status
+      }
+    GRAPHQL
+
+    CustomerFragment = <<~GRAPHQL
+      fragment CustomerFragment on Customer {
+        id: refId
+        name
+        email
+        createdAt
+        updatedAt
+        subscriptions {
+          ...SubscriptionFragment
+        }
+        promotionalEntitlements {
+          ...PromotionalEntitlementFragment
+        }
+        hasPaymentMethod
+        coupon {
+          ...CouponFragment
+        }
+        billingId
+        metadata: additionalMetaData
+      }
+    GRAPHQL
+
+    SlimSubscriptionFragment = <<~GRAPHQL
+      fragment SlimSubscriptionFragment on CustomerSubscription {
+        id: refId
+        status
+        metadata: additionalMetaData
+        billingId
+        billingLinkUrl
+        effectiveEndDate
+        currentBillingPeriodEnd
+        pricingType
+        prices {
+          usageLimit
+          price {
+            ...PriceFragment
+          }
+        }
+        totalPrice {
+          ...TotalPriceFragment
+        }
+        plan {
+          id: refId
+        }
+        addons {
+          quantity
+          addon {
+            id: refId
+          }
+        }
+        customer {
+          id: refId
+        }
+      }
+    GRAPHQL
+
+    PaywallPlanFragment = <<~GRAPHQL
+      fragment PaywallPlanFragment on Plan {
+        id: refId
+        description
+        displayName
+        product {
+          id: refId
+          displayName
+          description
+        }
+        basePlan {
+          id: refId
+          displayName
+        }
+        entitlements {
+          ...PaywallPackageEntitlementFragment
+        }
+        metadata: additionalMetaData
+        inheritedEntitlements {
+          ...PaywallPackageEntitlementFragment
+        }
+        prices {
+          ...PaywallPriceFragment
+        }
+        pricingType
+        defaultTrialConfig {
+          duration
+          units
+        }
+        compatibleAddons {
+          ...PaywallAddonFragment
+        }
+      }
+    GRAPHQL
+
+    FeatureFragment = <<~GRAPHQL
+      fragment FeatureFragment on Feature {
+        id: refId
+        featureType
+        meterType
+        featureUnits
+        featureUnitsPlural
+        displayName
+        description
+      }
+    GRAPHQL
+
+    EntitlementFeatureFragment = <<~GRAPHQL
+      fragment EntitlementFeatureFragment on EntitlementFeature {
+        id: refId
+        featureType
+        meterType
+        featureUnits
+        featureUnitsPlural
+        displayName
+        description
+      }
+    GRAPHQL
+
+    PaywallPackageEntitlementFragment = <<~GRAPHQL
+      fragment PaywallPackageEntitlementFragment on PackageEntitlement {
+        usageLimit
+        hasUnlimitedUsage
+        featureId
+        resetPeriod
+        feature {
+          ...FeatureFragment
+        }
+      }
+    GRAPHQL
+
+    PaywallPriceFragment = <<~GRAPHQL
+      fragment PaywallPriceFragment on Price {
+        billingModel
+        billingPeriod
+        price {
+          amount
+          currency
+        }
+        feature {
+          ...FeatureFragment
+        }
+      }
+    GRAPHQL
+
+    PaywallAddonFragment = <<~GRAPHQL
+      fragment PaywallAddonFragment on Addon {
+        id: refId
+        displayName
+        description
+        entitlements {
+          ...PaywallPackageEntitlementFragment
+        }
+        prices {
+          ...PaywallPriceFragment
+        }
+        metadata: additionalMetaData
+        pricingType
+      }
+    GRAPHQL
+
+    SubscriptionPreviewFragment = <<~GRAPHQL
+      fragment SubscriptionPreviewFragment on SubscriptionPreview {
+        subTotal {
+          amount
+          currency
+        }
+        total {
+          amount
+          currency
+        }
+        billingPeriodRange {
+          start
+          end
+        }
+        proration {
+          prorationDate
+          credit {
+            amount
+            currency
+          }
+          debit {
+            amount
+            currency
+          }
+        }
+      }
+    GRAPHQL
+
+    EntitlementFragment = <<~GRAPHQL
+      fragment EntitlementFragment on Entitlement {
+        isGranted
+        accessDeniedReason
+        customerId
+        usageLimit
+        hasUnlimitedUsage
+        currentUsage
+        requestedUsage
+        nextResetDate
+        resetPeriod
+        feature {
+          ...EntitlementFeatureFragment
+        }
+        resetPeriodConfiguration {
+          ... on MonthlyResetPeriodConfig {
+            monthlyAccordingTo
+          }
+          ... on WeeklyResetPeriodConfig {
+            weeklyAccordingTo
+          }
+        }
+      }
+    GRAPHQL
+  end
+
+  module Mutation
+    CreateCustomer = <<~GRAPHQL
+      mutation ($input: CustomerInput!) {
+        createCustomer: createOneCustomer(input: $input) {
+          ...CustomerFragment
+        }
+      }
+      #{Fragment::CustomerFragment}
+      #{Fragment::SubscriptionFragment}
+      #{Fragment::PriceFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::TotalPriceFragment}
+      #{Fragment::PlanFragment}
+      #{Fragment::PackageEntitlementFragment}
+      #{Fragment::AddonFragment}
+      #{Fragment::PromotionalEntitlementFragment}
+      #{Fragment::CouponFragment}
+    GRAPHQL
+
+    ProvisionCustomer = <<~GRAPHQL
+      mutation ($input: ProvisionCustomerInput!) {
+        provisionCustomer(input: $input) {
+          customer {
+            ...CustomerFragment
+          }
+          subscriptionStrategyDecision
+          subscription {
+            ...SlimSubscriptionFragment
+          }
+        }
+      }
+      #{Fragment::CustomerFragment}
+      #{Fragment::SubscriptionFragment}
+      #{Fragment::PriceFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::TotalPriceFragment}
+      #{Fragment::PlanFragment}
+      #{Fragment::PackageEntitlementFragment}
+      #{Fragment::AddonFragment}
+      #{Fragment::PromotionalEntitlementFragment}
+      #{Fragment::CouponFragment}
+      #{Fragment::SlimSubscriptionFragment}
+    GRAPHQL
+
+    ImportCustomer = <<~GRAPHQL
+      mutation ($input: ImportCustomerInput!) {
+        importCustomer: importOneCustomer(input: $input) {
+          ...CustomerFragment
+        }
+      }
+      #{Fragment::CustomerFragment}
+      #{Fragment::SubscriptionFragment}
+      #{Fragment::PriceFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::TotalPriceFragment}
+      #{Fragment::PlanFragment}
+      #{Fragment::PackageEntitlementFragment}
+      #{Fragment::AddonFragment}
+      #{Fragment::PromotionalEntitlementFragment}
+      #{Fragment::CouponFragment}
+    GRAPHQL
+
+    UpdateCustomer = <<~GRAPHQL
+      mutation ($input: UpdateCustomerInput!) {
+        updateCustomer: updateOneCustomer(input: $input) {
+          ...CustomerFragment
+        }
+      }
+      #{Fragment::CustomerFragment}
+      #{Fragment::SubscriptionFragment}
+      #{Fragment::PriceFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::TotalPriceFragment}
+      #{Fragment::PlanFragment}
+      #{Fragment::PackageEntitlementFragment}
+      #{Fragment::AddonFragment}
+      #{Fragment::PromotionalEntitlementFragment}
+      #{Fragment::CouponFragment}
+    GRAPHQL
+
+    CreateSubscription = <<~GRAPHQL
+      mutation ($input: SubscriptionInput!) {
+        createSubscription(subscription: $input) {
+          ...SlimSubscriptionFragment
+        }
+      }
+      #{Fragment::SlimSubscriptionFragment}
+      #{Fragment::PriceFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::TotalPriceFragment}
+    GRAPHQL
+
+    ProvisionSubscription = <<~GRAPHQL
+      mutation ($input: ProvisionSubscription!) {
+        provisionSubscription(input: $input) {
+          checkoutUrl
+          status
+          subscription {
+            ...SlimSubscriptionFragment
+          }
+        }
+      }
+      #{Fragment::SlimSubscriptionFragment}
+      #{Fragment::PriceFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::TotalPriceFragment}
+    GRAPHQL
+
+    UpdateSubscription = <<~GRAPHQL
+      mutation ($input: UpdateSubscriptionInput!) {
+        updateSubscription: updateOneSubscription(input: $input) {
+          ...SlimSubscriptionFragment
+        }
+      }
+      #{Fragment::SlimSubscriptionFragment}
+      #{Fragment::PriceFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::TotalPriceFragment}
+    GRAPHQL
+
+    CancelSubscription = <<~GRAPHQL
+      mutation ($input: SubscriptionCancellationInput!) {
+        cancelSubscription(input: $input) {
+          ...SlimSubscriptionFragment
+        }
+      }
+      #{Fragment::SlimSubscriptionFragment}
+      #{Fragment::PriceFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::TotalPriceFragment}
+    GRAPHQL
+
+    InitiateCheckout = <<~GRAPHQL
+      mutation ($input: InitiateCheckoutInput!) {
+        initiateCheckout(input: $input) {
+          id
+          checkoutUrl
+          checkoutBillingId
+        }
+      }
+    GRAPHQL
+
+    EstimateSubscription = <<~GRAPHQL
+      mutation ($input: EstimateSubscriptionInput!) {
+        estimateSubscription(input: $input) {
+          ...SubscriptionPreviewFragment
+        }
+      }
+      #{Fragment::SubscriptionPreviewFragment}
+    GRAPHQL
+
+    EstimateSubscriptionUpdate = <<~GRAPHQL
+      mutation ($input: EstimateSubscriptionUpdateInput!) {
+        estimateSubscriptionUpdate(input: $input) {
+          ...SubscriptionPreviewFragment
+        }
+      }
+      #{Fragment::SubscriptionPreviewFragment}
+    GRAPHQL
+
+    ReportUsage = <<~GRAPHQL
+      mutation ($input: UsageMeasurementCreateInput!) {
+        createUsageMeasurement(usageMeasurement: $input) {
+          id
+        }
+      }
+    GRAPHQL
+  end
+
+  module Query
+    GetCustomerById = <<~GRAPHQL
+      query ($customerId: String) {
+        customers(filter: { refId: { eq: $customerId } }) {
+          edges {
+            node {
+              ...CustomerFragment
+            }
+          }
+        }
+      }
+      #{Fragment::CustomerFragment}
+      #{Fragment::SubscriptionFragment}
+      #{Fragment::PriceFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::TotalPriceFragment}
+      #{Fragment::PlanFragment}
+      #{Fragment::PackageEntitlementFragment}
+      #{Fragment::AddonFragment}
+      #{Fragment::PromotionalEntitlementFragment}
+      #{Fragment::CouponFragment}
+    GRAPHQL
+
+    GetCoupons = <<~GRAPHQL
+      query  {
+        coupons(filter: { status: { eq: ACTIVE } }, paging: { first: 50 }) {
+          edges {
+            node {
+              ...CouponFragment
+            }
+          }
+        }
+      }
+      #{Fragment::CouponFragment}
+    GRAPHQL
+
+    GetPaywall = <<~GRAPHQL
+      query ($input: GetPaywallInput!) {
+        getPaywall(input: $input) {
+          ...PaywallPlanFragment
+        }
+      }
+      #{Fragment::PaywallPlanFragment}
+      #{Fragment::PaywallPackageEntitlementFragment}
+      #{Fragment::FeatureFragment}
+      #{Fragment::PaywallPriceFragment}
+      #{Fragment::PaywallAddonFragment}
+    GRAPHQL
+
+    GetEntitlements = <<~GRAPHQL
+      query ($query: FetchEntitlementsQuery!) {
+        entitlements: cachedEntitlements(query: $query) {
+          ...EntitlementFragment
+        }
+      }
+      #{Fragment::EntitlementFragment}
+      #{Fragment::EntitlementFeatureFragment}
+    GRAPHQL
+
+    GetEntitlement = <<~GRAPHQL
+      query ($query: FetchEntitlementQuery!) {
+        entitlement(query: $query) {
+          ...EntitlementFragment
+        }
+      }
+      #{Fragment::EntitlementFragment}
+      #{Fragment::EntitlementFeatureFragment}
+    GRAPHQL
+  end
+end