shopify_api_bruv 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1b6f7e063b556eb6732016cdd66426705db2f53fd9bc9844018f6b7ff93010d
-  data.tar.gz: a20c065d815f4beb997b0420cdee16b905ffcb919f22f97fa21ede0a39bc26f0
+  metadata.gz: 62561cc5b575e25d08e4fdbab3bb413f0f7d6b1c092ae617021d363fe39949e7
+  data.tar.gz: ede66f0903bca3c0c05cd77baec2049a7a254519815d2bbfd00afb546609e0ac
 SHA512:
-  metadata.gz: 9a1093b27403f929bbf6a2026c77fd3cd374f21582d4fc2d36f6c53e9789560dcfeaa3c9c6811e911949802b5a029a3bd036176ac7e55e1aaca6a22709a9259d
-  data.tar.gz: f016c5a2ef65da06fbb524a096839194c1812b1d234564bc2142f9f7e399a2604b8c2a96eb3483e49361885b1dadaa83e4596c3ecea74e194bfb6332bbe68fce
+  metadata.gz: c30df045b71ae5b922a2faec703eb85c40c3b71e7365c41ba5312def42c9b5f5067484a2ee0c7538212d275fa86fed0de8d016d9e4b8472ebc54c59ed44f6476
+  data.tar.gz: fc3d0fa99d9b63d69c47d0a971c72cf10d0a865b1d3e1807eae1922e5e498d429f764d3780404cf38eafa7d7a07d2bd620ee40c88796fce6aded445a9c07ab2d

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.2.6] - 2023-12-09
+
+- Adds pagination resource to rest resource
+- Fixes query not being forwarded
+
+## [0.2.5] - 2023-12-09
+
+- Updates http request for better log message
+
 ## [0.2.4] - 2023-12-09
 
 - Updates rest resource response to include page info

data/Gemfile.lock

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

data/lib/shopify_api_bruv/clients/graphql/client.rb

@@ -14,6 +14,7 @@ module ShopifyApiBruv
         def request(query:, variables: nil, headers: nil)
           http_client.request(
             http_request: HttpRequest.new(
+              api: :graphql,
               method: :post,
               path: '/graphql.json',
               body: { query:, variables: },

data/lib/shopify_api_bruv/clients/http_client.rb

@@ -31,7 +31,11 @@ module ShopifyApiBruv
           body: http_request.body
         )
 
-        HttpResponse.new(code: response.code, headers: response.headers, body: response.parsed_response)
+        if http_request.api == :rest
+          Rest::HttpResponse.new(code: response.code, headers: response.headers, body: response.parsed_response)
+        else
+          HttpResponse.new(code: response.code, headers: response.headers, body: response.parsed_response)
+        end
       end
     end
   end

data/lib/shopify_api_bruv/clients/http_request.rb

@@ -3,9 +3,10 @@
 module ShopifyApiBruv
   module Clients
     class HttpRequest
-      attr_reader :method, :path, :body, :content_type, :query, :headers
+      attr_reader :api, :method, :path, :body, :content_type, :query, :headers
 
-      def initialize(method:, path:, body:, content_type:, query: nil, headers:)
+      def initialize(api:, method:, path:, body:, content_type:, query: nil, headers:)
+        @api = api
         @method = method
         @path = path
         @body = body.is_a?(Hash) ? body.to_json : body
@@ -15,7 +16,7 @@ module ShopifyApiBruv
 
         ShopifyApiBruv.logger(
           method: :info,
-          message: 'Shopify API request initiated...'
+          message: "Shopify API Request (Method: #{method}):\nPath:\n#{path}\n\nBody:\n#{body}"
         )
       end
     end

data/lib/shopify_api_bruv/clients/http_response.rb

@@ -3,49 +3,28 @@
 module ShopifyApiBruv
   module Clients
     class HttpResponse
-      attr_reader :code, :headers, :body, :page_info
+      attr_reader :code, :headers, :body
 
       def initialize(code:, headers:, body:)
         @code = code
         @headers = headers
         @body = body
-        @page_info = parse_page_info
 
         ShopifyApiBruv.logger(
           method: :info,
           message: "Shopify API Response (Code: #{code}):\nHeaders:\n#{headers}\n\nBody:\n#{body}"
         )
 
-        validate!
+        validate
       end
 
       private
 
-      def parse_page_info
-        return { previous: nil, next: nil } if headers['link'].nil?
-
-        page_info = {}
-
-        headers['link'].split(',').each do |link|
-          rel = link.match(/rel="(.*?)"/).captures.first
-          url = link.match(/<(.*?)>/).captures.first
-
-          URI.parse(url).query.split('&').each do |param|
-            if param.split('=').first == 'page_info'
-              page_info[rel] = param.split('=').last
-              break
-            end
-          end
-        end
-
-        { previous: page_info['previous'], next: page_info['next'] }
-      end
-
       def ok?
         (200..299).cover?(code)
       end
 
-      def validate!
+      def validate
         return if ok?
 
         errors = body['errors'] || ''

data/lib/shopify_api_bruv/clients/rest/client.rb

@@ -32,9 +32,11 @@ module ShopifyApiBruv
         def request(method:, path:, body:, query:, headers:)
           http_client.request(
             http_request: HttpRequest.new(
+              api: :rest,
               method:,
               path:,
               body:,
+              query:,
               content_type: body.nil? ? nil : 'application/json',
               headers:
             )

data/lib/shopify_api_bruv/clients/rest/http_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ShopifyApiBruv
+  module Clients
+    module Rest
+      class HttpResponse < HttpResponse
+        attr_reader :page_info
+
+        def initialize(code:, headers:, body:)
+          super(code:, headers:, body:)
+
+          @page_info = parse_page_info
+        end
+
+        private
+
+        def parse_page_info
+          return { previous: nil, next: nil } if headers['link'].nil?
+
+          page_info = {}
+
+          headers['link'].split(',').each do |link|
+            rel = link.match(/rel="(.*?)"/).captures.first
+            url = link.match(/<(.*?)>/).captures.first
+
+            URI.parse(url).query.split('&').each do |param|
+              if param.split('=').first == 'page_info'
+                page_info[rel] = param.split('=').last
+                break
+              end
+            end
+          end
+
+          { previous: page_info['previous'], next: page_info['next'] }
+        end
+      end
+    end
+  end
+end

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

@@ -19,13 +19,6 @@ module ShopifyApiBruv
           raise NotImplementedError, 'Please set a query in the derived class' if query.nil?
 
           response = client.request(query:, variables:)
-
-          handle_response(response:, query:, variables:, tries:)
-        end
-
-        private
-
-        def handle_response(response:, query:, variables:, tries:)
           body = response.body
 
           handle_response_errors(body:, query:, variables:, tries:)
@@ -34,6 +27,8 @@ module ShopifyApiBruv
           mutation_object_name.nil? ? body['data'] : body.dig('data', mutation_object_name)
         end
 
+        private
+
         def handle_response_errors(body:, query:, variables:, tries:)
           errors = body['errors'] || body.dig('data', 'errors')
 

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ShopifyApiBruv
+  module Resources
+    module Rest
+      class PaginationResource
+        attr_reader :resource, :page_info
+
+        def initialize(resource:, page_info:)
+          @resource = resource
+          @page_info = page_info
+        end
+
+        def next_page?
+          !page_info[:next].nil?
+        end
+
+        def previous_page?
+          !page_info[:previous].nil?
+        end
+
+        def purpose?
+          next_page? || previous_page?
+        end
+
+        def fetch_next_page
+          raise Errors::ResourceError, 'Next page cursor not found' unless next_page?
+
+          resource.query[:page_info] = page_info[:next]
+          resource.request
+        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
+        end
+      end
+    end
+  end
+end

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

@@ -4,7 +4,8 @@ module ShopifyApiBruv
   module Resources
     module Rest
       class Resource < Base
-        attr_reader :client, :method, :path, :body, :query
+        attr_reader :client, :method, :path, :body
+        attr_accessor :query, :pagination_resource
 
         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
@@ -16,31 +17,28 @@ module ShopifyApiBruv
           @body = body
           @query = query
 
-          validate_arguments!
+          validate_arguments
         end
 
         def request
           response = client.public_send(method, path:, body:, query:)
 
-          handle_response(response:)
+          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?
+
+          response.body
         end
 
         private
 
-        def validate_arguments!
+        def validate_arguments
           if [:put, :post].include?(method)
             raise Errors::ResourceError, "Argument 'body' is required for method: #{method}" if body.nil?
           end
         end
 
-        def handle_response(response:)
-          handle_response_api_limits(headers: response.headers)
-
-          body = response.body
-          body['page_info'] = response.page_info if body.is_a?(Hash)
-          body
-        end
-
         def handle_response_api_limits(headers:)
           api_call_limit_header = headers['x-shopify-shop-api-call-limit'].split('/')
 

data/lib/shopify_api_bruv/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api_bruv
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Idjent
@@ -118,12 +118,14 @@ files:
 - lib/shopify_api_bruv/clients/http_request.rb
 - lib/shopify_api_bruv/clients/http_response.rb
 - lib/shopify_api_bruv/clients/rest/client.rb
+- lib/shopify_api_bruv/clients/rest/http_response.rb
 - lib/shopify_api_bruv/errors/http_client_error.rb
 - lib/shopify_api_bruv/errors/http_response_error.rb
 - lib/shopify_api_bruv/errors/resource_error.rb
 - 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/resource.rb
 - lib/shopify_api_bruv/version.rb
 - sig/shopify_api_bruv.rbs