shopify_api_bruv 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8119277813ab65392ec1a963097cd264dc4f610c00ae3e31c8cfaeaaf9b735e
-  data.tar.gz: 834626e70982174fb36b0bd7451e6e6318ea13c213a05d295262039287aea7c3
+  metadata.gz: 19a848bdcf14ee4042a43849b80b920783836c6db174bd32354e139201fe159b
+  data.tar.gz: c19e896c3e1aae699c8dd27b04b3c7dd21b08480aa70b3841e5c9c2c1f6d5f2a
 SHA512:
-  metadata.gz: e119e67234a23b633eca37f5370054b951669cd9c9363c0d99d215bbfd288c235ffabda5f8456fb43213222c6910092182717c63ff2f0e93211ecf859ba504d7
-  data.tar.gz: ff88c2d8b7a888a310cd14594d34ffe26c19506913ee1d91e232da4058bed4b3b42be46a3495f6cce6b096d48fc9f70db705875b289a7d35615316b191ee700f
+  metadata.gz: 9dbdcedfe8ab7682ee69d54ee0454bd81077ddbae6186b5f436620f4093ed8b7f00e2496e2371f57ee5e730f760563a240f9b4a3b76654a4009d50117f4725d5
+  data.tar.gz: 01174bf39bed2c243f24b38e217d5b32693e6b37883ee783a68ca0cd7fb841630cdd3dda2f021fa12a6036e4b0bfd22a64c58d3c767f991f912d871de66aec65

data/.env.template

@@ -2,6 +2,3 @@ API_DOMAIN="{API_DOMAIN}"
 API_VERSION="{API_VERSION}"
 API_ACCESS_TOKEN="{API_ACCESS_TOKEN}"
 SHOPIFY_API_BRUV_LOGGER_ENABLED="true"
-SHOPIFY_API_BRUV_REQUEST_MAX_TRIES="3"
-SHOPIFY_API_BRUV_REQUEST_SLEEP_TIMER="4"
-SHOPIFY_API_BRUV_REQUEST_MINIMUM_CREDIT_LEFT="4"

data/CHANGELOG.md

@@ -1,9 +1,17 @@
 ## [Unreleased]
 
+## [0.3.2] - 2023-12-10
+
+- Adds better resource class responses
+
+## [0.3.1] - 2023-12-10
+
+- Adds error handling for http requests
+
 ## [0.3.0] - 2023-12-10
 
-- Refactor resource classes
-- Update docs
+- Refactors resource classes
+- Updates docs
 
 ## [0.2.7] - 2023-12-09
 

data/Gemfile.lock

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

data/docs/README.md

@@ -11,5 +11,4 @@
 | `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/lib/shopify_api_bruv/clients/http_request.rb

@@ -5,6 +5,13 @@ module ShopifyApiBruv
     class HttpRequest
       attr_reader :api, :method, :path, :body, :content_type, :query, :headers
 
+      VALID_METHODS = [
+        :get,
+        :delete,
+        :put,
+        :post
+      ].freeze
+
       def initialize(api:, method:, path:, body:, content_type:, query: nil, headers:)
         @api = api
         @method = method
@@ -14,11 +21,27 @@ module ShopifyApiBruv
         @query = query
         @headers = headers
 
+        validate
+
         ShopifyApiBruv.logger(
           method: :info,
           message: "Shopify API Request (Method: #{method}):\nPath:\n#{path}\n\nBody:\n#{body}"
         )
       end
+
+      private
+
+      def validate
+        raise Errors::HttpRequestError,
+          "Invalid method #{method}, valid methods are: #{VALID_METHODS}" unless VALID_METHODS.include?(method)
+
+        raise Errors::HttpRequestError,
+          'Content-Type missing' if !body.nil? && content_type.nil?
+
+        return unless [:put, :post].include?(method)
+
+        raise Errors::HttpRequestError, "Body is required for method #{method}" if body.nil?
+      end
     end
   end
 end

data/lib/shopify_api_bruv/clients/http_response.rb

@@ -10,12 +10,12 @@ module ShopifyApiBruv
         @headers = headers
         @body = body
 
+        validate
+
         ShopifyApiBruv.logger(
           method: :info,
           message: "Shopify API Response (Code: #{code}):\nHeaders:\n#{headers}\n\nBody:\n#{body}"
         )
-
-        validate
       end
 
       private

data/lib/shopify_api_bruv/errors/http_request_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ShopifyApiBruv
+  module Errors
+    class HttpRequestError < StandardError
+    end
+  end
+end

data/lib/shopify_api_bruv/errors/resource_response_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ShopifyApiBruv
+  module Errors
+    class ResourceResponseError < StandardError
+    end
+  end
+end

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

@@ -23,12 +23,10 @@ module ShopifyApiBruv
           end
 
           response = client.request(query:, variables:)
-          body = response.body
 
-          handle_response_errors(body:, query:, variables:, tries:)
+          handle_response_errors(body: response.body, query:, variables:, tries:)
 
-          mutation_object_name = query.match(/mutation\s+(\w+)\s*\(.*/)&.captures&.first
-          mutation_object_name.nil? ? body['data'] : body.dig('data', mutation_object_name)
+          ResourceResponse.new(body: response.body, query:)
         end
 
         private
@@ -36,7 +34,7 @@ module ShopifyApiBruv
         def handle_response_errors(body:, query:, variables:, tries:)
           errors = body['errors'] || body.dig('data', 'errors')
 
-          raise Errors::ResourceError, errors if tries == MAX_TRIES
+          raise Errors::ResourceResponseError, errors if tries == MAX_TRIES
 
           if errors&.any? { |error| error['message'] == 'Throttled' }
             sleep(SLEEP_TIMER)
@@ -44,7 +42,7 @@ module ShopifyApiBruv
             call(tries: + 1)
           end
 
-          raise Errors::ResourceError, errors unless errors.nil?
+          raise Errors::ResourceResponseError, errors unless errors.nil?
         end
       end
     end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ShopifyApiBruv
+  module Resources
+    module Graphql
+      class ResourceResponse
+        attr_accessor :data, :extensions, :throttle_status
+
+        def initialize(body:, query:)
+          parse_body(body:, query:)
+        end
+
+        def as_open_struct
+          # rubocop:disable Style/OpenStructUse
+          JSON.parse(data.to_json, object_class: OpenStruct)
+          # rubocop:enable Style/OpenStructUse
+        end
+
+        private
+
+        def parse_body(body:, query:)
+          mutation_object_name = query.match(/mutation\s+(\w+)\s*\(.*/)&.captures&.first
+
+          @data = mutation_object_name.nil? ? body['data'] : body.dig('data', mutation_object_name)
+          @throttle_status = body.dig('extensions', 'cost', 'throttleStatus')
+        end
+      end
+    end
+  end
+end

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

@@ -19,7 +19,7 @@ module ShopifyApiBruv
           !page_info[:previous].nil?
         end
 
-        def purpose?
+        def page_exists?
           next_page? || previous_page?
         end
 

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

@@ -7,9 +7,6 @@ module ShopifyApiBruv
         attr_reader :client, :method, :path, :body
         attr_accessor :query, :pagination
 
-        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:)
           @method = method
@@ -17,38 +14,25 @@ module ShopifyApiBruv
           @body = body
           @query = query
 
-          validate_arguments
+          validate
         end
 
         def call
           response = client.public_send(method, path:, body:, query:)
 
-          handle_response_api_limits(headers: response.headers)
-
           pagination = Pagination.new(resource: self, page_info: response.page_info)
-          @pagination = pagination if pagination.purpose?
+          @pagination = pagination if pagination.page_exists?
 
-          response.body
+          ResourceResponse.new(body: response.body, headers: response.headers)
         end
 
         private
 
-        def validate_arguments
+        def validate
           if [:put, :post].include?(method)
             raise Errors::ResourceError, "Argument 'body' is required for method: #{method}" if body.nil?
           end
         end
-
-        def handle_response_api_limits(headers:)
-          api_call_limit_header = headers['x-shopify-shop-api-call-limit'].split('/')
-
-          limit = api_call_limit_header.pop.to_i - 1
-          used = api_call_limit_header.shift.to_i
-
-          if (limit - used) <= CREDIT_LEFT_THRESHOLD
-            sleep(SLEEP_TIMER)
-          end
-        end
       end
     end
   end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ShopifyApiBruv
+  module Resources
+    module Rest
+      class ResourceResponse
+        attr_accessor :data
+        attr_reader :credit_limit, :credit_used, :credit_left
+
+        CREDIT_LEFT_THRESHOLD = ENV.fetch('SHOPIFY_API_BRUV_RESOURCE_REST_CREDIT_LEFT_THRESHOLD', 8).to_i
+
+        def initialize(body:, headers:)
+          @data = body
+
+          parse_api_call_limit(headers:)
+        end
+
+        def as_open_struct
+          # rubocop:disable Style/OpenStructUse
+          JSON.parse(data.to_json, object_class: OpenStruct)
+          # rubocop:enable Style/OpenStructUse
+        end
+
+        def credit_left?
+          credit_left > CREDIT_LEFT_THRESHOLD
+        end
+
+        private
+
+        def parse_api_call_limit(headers:)
+          api_call_limit_header = headers['x-shopify-shop-api-call-limit'].split('/')
+
+          @credit_limit = api_call_limit_header.pop.to_i - 1
+          @credit_used = api_call_limit_header.shift.to_i
+          @credit_left = credit_limit - credit_used
+        end
+      end
+    end
+  end
+end

data/lib/shopify_api_bruv/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api_bruv
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Idjent
@@ -127,13 +127,17 @@ files:
 - 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_request_error.rb
 - lib/shopify_api_bruv/errors/http_response_error.rb
 - lib/shopify_api_bruv/errors/resource_error.rb
+- lib/shopify_api_bruv/errors/resource_response_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/graphql/resource_response.rb
 - lib/shopify_api_bruv/resources/rest/pagination.rb
 - lib/shopify_api_bruv/resources/rest/resource.rb
+- lib/shopify_api_bruv/resources/rest/resource_response.rb
 - lib/shopify_api_bruv/version.rb
 - sig/shopify_api_bruv.rbs
 homepage: https://github.com/Idjent/shopify_api_bruv