shopify_api_bruv 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9135e1d7c6f0e40fa48c7cc13eec78b363385029f5b7724e6974557bf77e43c4
-  data.tar.gz: af5f2e7906ed83e85cdddf93fa11f05e970cafbded61f3a50237f9fe23e98967
+  metadata.gz: e8119277813ab65392ec1a963097cd264dc4f610c00ae3e31c8cfaeaaf9b735e
+  data.tar.gz: 834626e70982174fb36b0bd7451e6e6318ea13c213a05d295262039287aea7c3
 SHA512:
-  metadata.gz: 974510b1bf78b10321f9a6a165737ec9103e40258defb03805b182c8425dfdef4d9f6c98625e5a8a3717dd7a111bb11f55ea308ffba6f54451b7d84ebc0bd18c
-  data.tar.gz: bb739d8c212f13bb8baed21ea87b9c0a1391a3ed70c17e7ba4dff1edeacad61e619865a56edac14ab2191c8f5d20a70b5546aaed9789bb397c5c7cf1f0ceaadc
+  metadata.gz: e119e67234a23b633eca37f5370054b951669cd9c9363c0d99d215bbfd288c235ffabda5f8456fb43213222c6910092182717c63ff2f0e93211ecf859ba504d7
+  data.tar.gz: ff88c2d8b7a888a310cd14594d34ffe26c19506913ee1d91e232da4058bed4b3b42be46a3495f6cce6b096d48fc9f70db705875b289a7d35615316b191ee700f

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.3.0] - 2023-12-10
+
+- Refactor resource classes
+- Update docs
+
 ## [0.2.7] - 2023-12-09
 
 - Fixes variables not being passed on retry

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api_bruv (0.2.7)
+    shopify_api_bruv (0.3.0)
       httparty
       logger
 

data/README.md

@@ -17,7 +17,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-See [/docs](docs/README.md)
+Visit [/docs](docs/README.md)
 
 ## Development
 

data/docs/README.md

@@ -1,101 +1,15 @@
-# Documentation
+# Getting started
 
-## Environment variables
-
-```bash
-SHOPIFY_API_BRUV_LOGGER_ENABLED="true" # Enables logger, remove or set to false to disable
-SHOPIFY_API_BRUV_REQUEST_MAX_TRIES="3" # Max tries for resource class based requests
-SHOPIFY_API_BRUV_REQUEST_SLEEP_TIMER="4" # Sleep timer for resource class based requests
-SHOPIFY_API_BRUV_REQUEST_MINIMUM_CREDIT_LEFT="4" # Sleeps if credit left reaches this amount
-```
-
-## Auth
-```ruby
-# Initialize a config
-config = ShopifyApiBruv::Auth::Config.new(
-  api_domain: "shop.myshopify.com",
-  api_version: "2023-10",
-  api_access_token: "ACCESS_TOKEN"
-)
-```
-
-## Usage (GraphQL)  
-
-### Simple request
-
-```ruby
-# Initialize a graphql client and provide the config
-client = ShopifyApiBruv::Clients::Graphql::Client.new(config:)
-
-# Define a query
-query = <<~GRAPHQL
-  query {
-    products(first: 250) {
-      edges {
-        node {
-          id
-          title
-          handle
-        }
-      }
-    }
-  }
-GRAPHQL
-
-# Make the request
-client.request(query:)
-```
-
-### Using the resource class
+- [Auth](./usage/auth/README.md)
+- [Clients](./usage/clients/README.md)
+- [Resources](./usage/resources/README.md)
 
-```ruby
-class GetProducts < ShopifyApiBruv::Resources::Graphql::Resource
-  def query
-    <<~GRAPHQL
-      query {
-        products(first: 250) {
-          edges {
-            node {
-              id
-              title
-              handle
-            }
-          }
-        }
-      }
-    GRAPHQL
-  end
-end
-
-# Usage
-GetProducts.request(config:)
-```
-
-## Usage (Rest)  
-
-### Simple request
-
-```ruby
-# Initialize a graphql client and provide the config
-client = ShopifyApiBruv::Clients::Rest::Client.new(config:)
-
-# Make the request
-client.get(path: '/products')
-```
-
-### Using the resource class
-
-```ruby
-class GetProducts < ShopifyApiBruv::Resources::Rest::Resource
-  def initialize(config:)
-    super(
-      config:,
-      method: :get,
-      path: '/products'
-    )
-  end
-end
+## Environment variables
 
-# Usage
-GetProducts.request(config:)
-```
+| Key                                                    | Default value | Type    | Required |
+| ------------------------------------------------------ | ------------- | ------- | -------- |
+| `SHOPIFY_API_BRUV_LOGGER_ENABLED`                      | `false`       | Boolean | No       |
+| `SHOPIFY_API_BRUV_RESOURCE_GRAPHQL_MAX_TRIES`          | `3`           | Integer | No       |
+| `SHOPIFY_API_BRUV_RESOURCE_GRAPHQL_SLEEP_TIMER`        | `4`           | Integer | No       |
+| `SHOPIFY_API_BRUV_RESOURCE_REST_SLEEP_TIMER`           | `4`           | Integer | No       |
+| `SHOPIFY_API_BRUV_RESOURCE_REST_CREDIT_LEFT_THRESHOLD` | `8`           | Integer | No       |

data/docs/usage/auth/README.md

@@ -0,0 +1,11 @@
+# Auth
+
+This gem requires following configuration to authenticate:
+
+```ruby
+ShopifyApiBruv::Auth::Config.new(
+  api_domain: "<api_domain>",
+  api_version: "2023-10",
+  api_access_token: "<api_access_token>"
+)
+```

data/docs/usage/clients/README.md

@@ -0,0 +1,4 @@
+# Clients
+
+- [GraphQL](./graphql/README.md)
+- [Rest](./rest/README.md)

data/docs/usage/clients/graphql/README.md

@@ -0,0 +1,24 @@
+# GraphQL
+
+```ruby
+# Initialize a graphql client
+client = ShopifyApiBruv::Clients::Graphql::Client.new(config:)
+
+# Define your query
+query = <<~GRAPHQL
+  query {
+    products(first: 10) {
+      edges {
+        node {
+          id
+          title
+          handle
+        }
+      }
+    }
+  }
+GRAPHQL
+
+# Make the request
+client.request(query:)
+```

data/docs/usage/clients/rest/README.md

@@ -0,0 +1,9 @@
+# Rest
+
+```ruby
+# Initialize a rest client
+client = ShopifyApiBruv::Clients::Rest::Client.new(config:)
+
+# Make the request
+client.get(path: '/products', query: { limit: 10 })
+```

data/docs/usage/resources/README.md

@@ -0,0 +1,4 @@
+# Resources
+
+- [GraphQL](./graphql/README.md)
+- [Rest](./rest/README.md)

data/docs/usage/resources/graphql/README.md

@@ -0,0 +1,84 @@
+# GraphQL
+
+You can either use the resource class directly:
+
+```ruby
+resource = ShopifyApiBruv::Resources::Graphql::Resource.new(config:)
+resource.query = <<~GRAPHQL
+  mutation productCreate($input: ProductInput!) {
+    productCreate(input: $input) {
+      product {
+        title
+      }
+      userErrors {
+        field
+        message
+      }
+    }
+  }
+GRAPHQL
+resource.variables = { input: { title: "Test Product" } }
+resource.call
+```
+
+
+Or define it as a class inheriting from `ShopifyApiBruv::Resources::Graphql::Resource`
+
+## Query
+
+```ruby
+# frozen_string_literal: true
+
+module Shopify
+  module Graphql
+    class GetProduct < ShopifyApiBruv::Resources::Graphql::Resource
+      QUERY = <<~GRAPHQL
+        query ($id: ID!) {
+          product(id: $id) {
+            id
+            title
+          }
+        }
+      GRAPHQL
+    end
+  end
+end
+```
+
+Usage:
+
+```ruby
+Shopify::Graphql::GetProduct.call(config:, variables: { id: "gid://shopify/Product/1234567890" })
+```
+
+## Mutation
+
+```ruby
+# frozen_string_literal: true
+
+module Shopify
+  module Graphql
+    class CreateProduct < ShopifyApiBruv::Resources::Graphql::Resource
+      QUERY = <<~GRAPHQL
+        mutation productCreate($input: ProductInput!) {
+          productCreate(input: $input) {
+            product {
+              title
+            }
+            userErrors {
+              field
+              message
+            }
+          }
+        }
+      GRAPHQL
+    end
+  end
+end
+```
+
+Usage:
+
+```ruby
+Shopify::Graphql::CreateProduct.call(config:, variables: { input: { title: "Test Product" } })
+```

data/docs/usage/resources/rest/README.md

@@ -0,0 +1,74 @@
+# Rest
+
+You can either use the resource class directly:
+
+```ruby
+resource = ShopifyApiBruv::Resources::Rest::Resource.new(
+  config:,
+  method: :get,
+  path: '/products',
+  query: { limit: 10 }
+)
+response = resource.call
+
+# Built in pagination example
+loop do
+  break if resource.pagination.nil? && !resource.pagination.next_page?
+  response = resource.pagination.fetch_next_page
+end
+```
+
+Or define it as a class inheriting from `ShopifyApiBruv::Resources::Rest::Resource`
+
+## Receive data
+
+```ruby
+# frozen_string_literal: true
+
+module Shopify
+  module Rest
+    class GetProduct < ShopifyApiBruv::Resources::Rest::Resource
+      def initialize(config:, id:)
+        super(
+          config:,
+          method: :get,
+          path: "/products/#{id}"
+        )
+      end
+    end
+  end
+end
+```
+
+Usage:
+
+```ruby
+Shopify::Rest::GetProduct.call(config:, id: "1234567890")
+```
+
+## Populate data
+
+```ruby
+# frozen_string_literal: true
+
+module Shopify
+  module Rest
+    class CreateProduct < ShopifyApiBruv::Resources::Rest::Resource
+      def initialize(config:, body:)
+        super(
+          config:,
+          method: :post,
+          path: '/products',
+          body:
+        )
+      end
+    end
+  end
+end
+```
+
+Usage:
+
+```ruby
+Shopify::Rest::CreateProduct.call(config:, body: { product: { title: "Test Product" }  })
+```

data/lib/shopify_api_bruv/resources/base.rb

@@ -3,8 +3,8 @@
 module ShopifyApiBruv
   module Resources
     class Base
-      def self.request(...)
-        new(...).request
+      def self.call(...)
+        new(...).call
       end
     end
   end

data/lib/shopify_api_bruv/resources/graphql/resource.rb

@@ -5,25 +5,29 @@ module ShopifyApiBruv
     module Graphql
       class Resource < Base
         attr_reader :client
-        attr_accessor :query
+        attr_accessor :variables, :query
 
-        MAX_TRIES = ENV.fetch('SHOPIFY_API_BRUV_REQUEST_MAX_TRIES', 3).to_i
-        SLEEP_TIMER = ENV.fetch('SHOPIFY_API_BRUV_REQUEST_SLEEP_TIMER', 4).to_i
-        MUTATION_OBJECT_NAME_PATTERN = /mutation\s+(\w+)\s*\(.*/
+        QUERY = nil
+        MAX_TRIES = ENV.fetch('SHOPIFY_API_BRUV_RESOURCE_GRAPHQL_MAX_TRIES', 3).to_i
+        SLEEP_TIMER = ENV.fetch('SHOPIFY_API_BRUV_RESOURCE_GRAPHQL_SLEEP_TIMER', 4).to_i
 
-        def initialize(config:)
+        def initialize(config:, variables: nil)
           @client = Clients::Graphql::Client.new(config:)
+          @variables = variables
+          @query = self.class::QUERY unless self.class::QUERY.nil?
         end
 
-        def request(variables: nil, tries: 0)
-          raise NotImplementedError, 'Please set a query in the derived class' if query.nil?
+        def call(tries: 0)
+          if query.nil?
+            raise Errors::ResourceError, "Please set attribute 'query' or define constant 'QUERY' in derived class"
+          end
 
           response = client.request(query:, variables:)
           body = response.body
 
           handle_response_errors(body:, query:, variables:, tries:)
 
-          mutation_object_name = query.match(MUTATION_OBJECT_NAME_PATTERN)&.captures&.first
+          mutation_object_name = query.match(/mutation\s+(\w+)\s*\(.*/)&.captures&.first
           mutation_object_name.nil? ? body['data'] : body.dig('data', mutation_object_name)
         end
 
@@ -37,7 +41,7 @@ module ShopifyApiBruv
           if errors&.any? { |error| error['message'] == 'Throttled' }
             sleep(SLEEP_TIMER)
 
-            request(variables:, tries: + 1)
+            call(tries: + 1)
           end
 
           raise Errors::ResourceError, errors unless errors.nil?

data/lib/shopify_api_bruv/resources/rest/{pagination_resource.rb → pagination.rb}

@@ -3,7 +3,7 @@
 module ShopifyApiBruv
   module Resources
     module Rest
-      class PaginationResource
+      class Pagination
         attr_reader :resource, :page_info
 
         def initialize(resource:, page_info:)
@@ -27,14 +27,14 @@ module ShopifyApiBruv
           raise Errors::ResourceError, 'Next page cursor not found' unless next_page?
 
           resource.query[:page_info] = page_info[:next]
-          resource.request
+          resource.call
         end
 
         def fetch_previous_page
           raise Errors::ResourceError, 'Previous page cursor not found' unless previous_page?
 
           resource.query[:page_info] = page_info[:previous]
-          resource.request
+          resource.call
         end
       end
     end

data/lib/shopify_api_bruv/resources/rest/resource.rb

@@ -5,10 +5,10 @@ module ShopifyApiBruv
     module Rest
       class Resource < Base
         attr_reader :client, :method, :path, :body
-        attr_accessor :query, :pagination_resource
+        attr_accessor :query, :pagination
 
-        SLEEP_TIMER = ENV.fetch('SHOPIFY_API_BRUV_REQUEST_SLEEP_TIMER', 4).to_i
-        MINIMUM_CREDIT_LEFT = ENV.fetch('SHOPIFY_API_BRUV_REQUEST_MINIMUM_CREDIT_LEFT', 4).to_i
+        SLEEP_TIMER = ENV.fetch('SHOPIFY_API_BRUV_RESOURCE_REST_SLEEP_TIMER', 4).to_i
+        CREDIT_LEFT_THRESHOLD = ENV.fetch('SHOPIFY_API_BRUV_RESOURCE_REST_CREDIT_LEFT_THRESHOLD', 8).to_i
 
         def initialize(config:, method:, path:, body: nil, query: nil)
           @client = Clients::Rest::Client.new(config:)
@@ -20,13 +20,13 @@ module ShopifyApiBruv
           validate_arguments
         end
 
-        def request
+        def call
           response = client.public_send(method, path:, body:, query:)
 
           handle_response_api_limits(headers: response.headers)
 
-          pagination_resource = PaginationResource.new(resource: self, page_info: response.page_info)
-          @pagination_resource = pagination_resource if pagination_resource.purpose?
+          pagination = Pagination.new(resource: self, page_info: response.page_info)
+          @pagination = pagination if pagination.purpose?
 
           response.body
         end
@@ -45,7 +45,7 @@ module ShopifyApiBruv
           limit = api_call_limit_header.pop.to_i - 1
           used = api_call_limit_header.shift.to_i
 
-          if (limit - used) <= MINIMUM_CREDIT_LEFT
+          if (limit - used) <= CREDIT_LEFT_THRESHOLD
             sleep(SLEEP_TIMER)
           end
         end

data/lib/shopify_api_bruv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShopifyApiBruv
-  VERSION = '0.2.7'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api_bruv
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Idjent
@@ -111,6 +111,13 @@ files:
 - README.md
 - Rakefile
 - docs/README.md
+- docs/usage/auth/README.md
+- docs/usage/clients/README.md
+- docs/usage/clients/graphql/README.md
+- docs/usage/clients/rest/README.md
+- docs/usage/resources/README.md
+- docs/usage/resources/graphql/README.md
+- docs/usage/resources/rest/README.md
 - lib/shopify_api_bruv.rb
 - lib/shopify_api_bruv/auth/config.rb
 - lib/shopify_api_bruv/clients/graphql/client.rb
@@ -125,7 +132,7 @@ files:
 - lib/shopify_api_bruv/logger.rb
 - lib/shopify_api_bruv/resources/base.rb
 - lib/shopify_api_bruv/resources/graphql/resource.rb
-- lib/shopify_api_bruv/resources/rest/pagination_resource.rb
+- lib/shopify_api_bruv/resources/rest/pagination.rb
 - lib/shopify_api_bruv/resources/rest/resource.rb
 - lib/shopify_api_bruv/version.rb
 - sig/shopify_api_bruv.rbs