apiql 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f103af812fb631ddf00a34acc478436d42d39fd1a66de8e2b0ee32a7023d159c
-  data.tar.gz: 2cf523c953d6ba31d3017183fe09353546a9d627869972e325342e732c7f1f6c
+  metadata.gz: 3f34e609be9a7132527a772ee95d0e7dd4e43aff4bb7d8f9fd43010f73e9632e
+  data.tar.gz: 1194eed934b4c0f26084dc0cdec5beac7d51967236e1b6438efa176d176cfdb2
 SHA512:
-  metadata.gz: 765875ac74538f510065377ffe052d0e5a75ed2b331b9883e142be064b57f76c74c9398afe4c001e3e9674a94d7844aa8e940d819f336c0589e0e13038ed7020
-  data.tar.gz: 4d82c9d04123de11ae47da1eaca5b0d2ecce4d212b1e828ec6b19a35f6a75e0332fae273a4c9368a9eb28494a9a64d2bceb1bf04230a7ac6899ead8d2343c035
+  metadata.gz: adca6b4acf505f3a281a352640dbabb23a05b9ded7a9ddd99c10d64f0cbba1b67b054a66e048cbdd0f59c164f9fa2b850c3f8693cf0ec92ad967326e87639ee1
+  data.tar.gz: 0c1c05a98a7cb45868e3d0f3118b4d4ccf87c475e9e88aa84cb49808005ee5f45cdc1df9595eef0be5f5c3f7087213f8ecaeca97e5fad45733dbdf8280a28677

data/README.md

@@ -1,6 +1,10 @@
 # APIQL
 
-Implementation of the API language similar to GraphQL for Ruby on Rails
+Implementation of the API language similar to GraphQL for Ruby on Rails.
+
+It compiles requests into Hashes for faster rendering.
+
+Now, it automatically detects nested entities and eager-loads them for faster DB access!
 
 Define your responder (requested methods):
 
@@ -102,6 +106,37 @@ logout() {
 
 ```
 
+you can call methods on entities:
+
+```javascript
+  apiql("user", `
+    authenticate(email, password) {
+      token
+    }
+
+    me.reload {
+      email full_name role token
+
+      roles(filter) {
+        id title
+      }
+
+      contacts.primary {
+        full_name
+        email
+      }
+   }
+  `, {
+    email: email,
+    filter: 'all',
+    password: password
+  })
+  .then(response => {
+    let user = response['me.reload'] // name in response equals to called
+  })
+}
+```
+
 You can use initializer like this for authorization using cancancan gem:
 
 config/initializers/apiql.rb:
@@ -126,9 +161,11 @@ class APIQL
     end
   end
 end
+```
 
-and authorize access to every entity:
+and even authorize access to every entity:
 
+```ruby
 class ApplicationRecord < ActiveRecord::Base
   class BaseEntity < APIQL::Entity
     def initialize(object, context)

data/apiql.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'apiql'
-  spec.version       = '0.2.2'
+  spec.version       = '0.3.0'
   spec.authors       = ['Dmitry Silchenko']
   spec.email         = ['dmitry@desofto.com']
 

data/lib/apiql.rb

@@ -20,13 +20,14 @@ class APIQL
       request = params[:apiql_request]
 
       if request.present?
-        redis&.set("api-ql-cache-#{request_id}", request)
+        request = compile(request)
+        redis&.set("api-ql-cache-#{request_id}", request.to_json)
         @@cache = {} if @@cache.count > 1000
         @@cache[request_id] = request
       else
         request = @@cache[request_id]
-        request ||= redis&.get("api-ql-cache-#{request_id}")
-        raise CacheMissed unless request.present?
+        request ||= JSON.parse(redis.get("api-ql-cache-#{request_id}")) rescue nil
+        raise CacheMissed unless request.present? && request.is_a?(::Array)
       end
 
       request
@@ -50,74 +51,97 @@ class APIQL
           nil
         end
     end
-  end
 
-  def initialize(binder, *fields)
-    @context = ::APIQL::Context.new(binder, *fields)
-    @context.inject_delegators(self)
-  end
+    def compile(schema)
+      result = []
 
-  def render(schema)
-    result = {}
+      ptr = result
+      pool = []
 
-    function = nil
-    data = nil
+      while schema.present? do
+        if reg = schema.match(/\A\s*\{(?<rest>.*)\z/m) # {
+          schema = reg[:rest]
 
-    pool = nil
-    keys = nil
-    last_key = nil
+          pool.push(ptr)
+          key = ptr.pop
+          ptr.push(key => (ptr = []))
+        elsif reg = schema.match(/\A\s*\}(?<rest>.*)\z/m) # }
+          schema = reg[:rest]
 
-    while schema.present? do
-      if reg = schema.match(/\A\s*\{(?<rest>.*)\z/m) # {
-        schema = reg[:rest]
+          ptr = pool.pop
+        elsif pool.any? && (reg = schema.match(/\A\s*(?<name>[\w\.]+)(\((?<params>.*)\))?(?<rest>.*)\z/m))
+          schema = reg[:rest]
 
-        pool.push [keys, last_key]
-        keys = []
-      elsif reg = schema.match(/\A\s*\}(?<rest>.*)\z/m) # }
-        schema = reg[:rest]
+          if reg[:params].nil?
+            key = reg[:name]
+          else
+            key = "#{reg[:name]}(#{reg[:params]})"
+          end
 
-        last_keys = keys
+          ptr.push(key)
+        elsif reg = schema.match(/\A\s*(?<name>[\w\.]+)(\((?<params>((\w+)(\s*\,\s*\w+)*))?\))?\s*\{(?<rest>.*)\z/m)
+          schema = reg[:rest]
 
-        keys, last_key = pool.pop
+          pool.push(ptr)
+          ptr.push("#{reg[:name]}(#{reg[:params]})" => (ptr = []))
+        elsif reg = schema.match(/\A\s*(?<name>[\w\.]+)(\((?<params>((\w+)(\s*\,\s*\w+)*))?\))?\s*\n?(?<rest>.*)\z/m)
+          schema = reg[:rest]
 
-        if pool.empty?
-          result[function] = @context.render_value(data, last_keys)
-          function = nil
+          ptr.push("#{reg[:name]}(#{reg[:params]})")
         else
-          keys.delete(last_key)
-          keys << { last_key => last_keys }
+          raise Error, schema
         end
-      elsif function.present? && (reg = schema.match(/\A\s*(?<name>[\w\.]+)(\((?<params>.*)\))?(?<rest>.*)\z/m))
-        schema = reg[:rest]
+      end
 
-        if reg[:params].present?
-          keys << [reg[:name], reg[:params]]
-        else
-          keys << reg[:name]
-        end
+      result
+    end
+  end
 
-        last_key = reg[:name]
-      elsif reg = schema.match(/\A\s*(?<name>[\w\.]+)(\((?<params>((\w+)(\s*\,\s*\w+)*))?\))?\s*\{(?<rest>.*)\z/m)
-        schema = reg[:rest]
+  def initialize(binder, *fields)
+    @context = ::APIQL::Context.new(binder, *fields)
+    @context.inject_delegators(self)
+  end
 
-        function = reg[:name]
-        params = @context.parse_params(reg[:params])
+  def eager_load
+    result = @eager_load
 
-        data = public_send(function, *params)
+    @eager_load = nil
 
-        pool = []
-        requested = {}
+    result
+  end
 
-        last_key = nil
+  def render(schema)
+    result = {}
 
-        pool.push [keys, last_key]
-        keys = []
-      elsif reg = schema.match(/\A\s*(?<name>[\w\.]+)(\((?<params>((\w+)(\s*\,\s*\w+)*))?\))?\s*\n?(?<rest>.*)\z/m)
-        schema = reg[:rest]
+    schema.map do |call|
+      if call.is_a? ::Hash
+        call.each do |function, sub_schema|
+          reg = function.match(/\A(?<name>[\w\.]+)(\((?<params>.*)\))?\z/)
+          raise Error, function unless reg.present?
+
+          function = reg[:name]
+          params = @context.parse_params(reg[:params])
+
+          @eager_load = eager_loads(sub_schema)
+          data = public_send(function, *params)
+          if @eager_load.present? && !data.is_a?(::Hash)
+            if data.respond_to?(:each) && data.respond_to?(:map)
+              data = data.eager_load(eager_load)
+            elsif data.respond_to?(:id)
+              data = data.class.eager_load(eager_load).find(data.id)
+            end
+          end
+
+          result[function] = @context.render_value(data, sub_schema)
+        end
+      else
+        reg = call.match(/\A(?<name>[\w\.]+)(\((?<params>.*)\))?\z/)
+        raise Error, call unless reg.present?
 
         function = reg[:name]
         params = @context.parse_params(reg[:params])
 
+        @eager_load = ''
         data = public_send(function, *params)
         if data.is_a? Array
           if data.any? { |item| !APIQL::simple_class?(item) }
@@ -128,10 +152,30 @@ class APIQL
         end
 
         result[function] = data
+      end
+    end
 
-        function = nil
-      else
-        raise Error
+    result
+  end
+
+  private
+
+  def eager_loads(schema)
+    result = []
+
+    schema.each do |call|
+      if call.is_a? Hash
+        call.each do |function, sub_schema|
+          next if function.include? '('
+          function = function.split('.').first if function.include? '.'
+
+          sub = eager_loads(sub_schema)
+          if sub.present?
+            result.push(function => sub)
+          else
+            result.push function
+          end
+        end
       end
     end
 
@@ -316,7 +360,11 @@ class APIQL
         begin
           "#{value.class.name}::Entity".constantize.new(value, self).render(schema)
         rescue StandardError
-          nil
+          if ::Rails.env.development?
+            raise
+          else
+            nil
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiql
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Dmitry Silchenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-16 00:00:00.000000000 Z
+date: 2018-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler