bearcat 1.5.36 → 1.5.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c1aa4cc552b9089c7aeba0bac9d8c6e6607f249397e0d4e3b9351346dc467b9
-  data.tar.gz: 467d992e8040ea5f79a89fda52bdce0ed944efd59fff85df165aa48c65604f44
+  metadata.gz: 7d158f0297de70f3ab0168d9eca3f0524ec3ab604ac8a4e756e0b07269a0e6e3
+  data.tar.gz: 07dd1d001f4bfc6248235be4f208782ad136a8af8223aed2e71ae60cc82fc9a3
 SHA512:
-  metadata.gz: 8394cf85848a727ebd888c20d76ad27f5d6335556eb949a1763b6ab584e746e9e3daf4195412c863333ae54d8d6abb792efe7b26ab79b3e0bf263972d3081f71
-  data.tar.gz: 04d083c01d107b8d0b71fe32e42a94e832c8c72b5ef48ff3b7958b6713c56b1b1d683626032557541dafd9995f8ce3c6278863aeb380e13422e921345881322d
+  metadata.gz: 050c5d4b285c4ec8a341b5bfdcc71d02837c8b7ffe5324ac77fef1bd17c77497273c7e366c608565a9dbe264e003b41c20c235d1fa328c774c4f831149e943c4
+  data.tar.gz: 3d9b79d660565eab8fe498d80d46d3ecd0553abd3d15b5d9be95038f7a781563fa44e2ab16f2505c267de725ed02473e739ec560d5de06ede75b1e2f05c20599

data/lib/bearcat/client/graph_ql.rb

@@ -1,17 +1,67 @@
 module Bearcat
+  class GraphqlError < StandardError
+    attr_reader :response
+
+    def initialize(message, response: nil)
+      super(message)
+      @response = response
+    end
+  end
+
   class Client < Footrest::Client
-    # Request body format should be: { query: "query string" }. More info in README.md
+    # Request body format should be:
+    #  - { query: "query string" }
+    #  - "query string"
+    #  - "path/to/gql/file", may be absolute, relative to application root, or relative to `app/graphql`. `.gql` extension is optional.
     module GraphQL
-
-      def graphql_query(query)
+      def graphql_query(query, args = {})
         if query.is_a?(String)
+          if /\A\w+\Z/.match?(query) && !query.include?("{")
+            query = query.underscore
+            @@gql_cache ||= {}
+
+            query = cache_on_class("gql:#{query}") do
+              paths = []
+
+              pn = Pathname.new(query)
+              if pn.absolute?
+                paths << query
+              else
+                paths << Rails.root.join("app", "graphql", query)
+                paths << Rails.root.join(query)
+              end
+
+              paths = paths.flat_map do |path|
+                [path, "#{path}.gql"]
+              end
+
+              query = paths.find do |path|
+                File.exist?(path)
+              end
+
+              File.read(query)
+            end
+          end
+
+          args.symbolize_keys!
+
+          query = query.gsub(/\{\{(.*?)\}\}/) do |_m|
+            match = Regexp.last_match
+            key = match[1].strip.to_sym
+            args[key]
+          end
+
           query = {
             query: query
           }
         end
-        post('/api/graphql', query)
-      end
 
+        result = post('/api/graphql', query)
+        raise GraphqlError.new("Error running GraphQL query:\n#{result["errors"].to_json}", response: result) if result["errors"].present?
+
+        # TODO: It'd be nice to unwrap and return result["data"] directly, but we want to keep backwards compatibility
+        result
+      end
     end
   end
 end

data/lib/bearcat/client.rb

@@ -39,6 +39,19 @@ module Bearcat
       connection.builder.delete(Footrest::RaiseFootrestErrors)
     end
 
+    def self.cache_on_self(key, &block)
+      @cache ||= {}
+      if Rails.env.development? || Rails.env.test?
+        block.call
+      else
+        @cache[key] ||= block.call
+      end
+    end
+
+    def cache_on_class(key, &block)
+      self.class.cache_on_self(key, &block)
+    end
+
     protected
 
     def rate_limited_request

data/lib/bearcat/version.rb

@@ -1,3 +1,3 @@
 module Bearcat
-  VERSION = '1.5.36' unless defined?(Bearcat::VERSION)
+  VERSION = '1.5.37' unless defined?(Bearcat::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 1.5.36
+  version: 1.5.37
 platform: ruby
 authors:
 - Instructure CustomDev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake