apiql 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63b4f97269f59d36c635c7b748139aaa028ee54d39693d6f0f44e047448fbf50
-  data.tar.gz: 2b349ebef9fc19be13bff57f40a3b35dbb9b87fd749087da5b57f2d853442c83
+  metadata.gz: 0df2f76cbbbf87e6a3b506c598a7e41ef620dc283ddc345cd157d2fc80661848
+  data.tar.gz: c6a9b1b1af21e094684ce86ea61f2a26f1f8432ed00f4657f8272429bea3df22
 SHA512:
-  metadata.gz: ca5733013a1f7346c3ec80f9baab183694d8a2681a1f91d926c7827ae2d52014389a050d6ff5b3aefbec9da46e0bb28a5b89fc0d68cf318d62fa6f7e8baf03ea
-  data.tar.gz: e6b7644edb288b4cf7f4b729706b292e4ca0aad43e251bf4862cb7024ccf15e12b60306616a0b9075ed3648209b6ff18ac41084dd7bb9968b1de680becb9b1e6
+  metadata.gz: b41c1af521d8feb114c107af996868d5d4a7ceaade3d20a4251c5881f8e54aeab5dbaf071c6a943650edaa00a21b066e9fea87b827bdbb9103d4a5fb128bab3c
+  data.tar.gz: 38d9b8b00bbf2cf92f940629b9fe76192aa1b702b5cf10364ba03d757c81eca0e5fbc21f3987391d08ea6ddb6ed4b2d5fe103e26a4bc59e9bbc216da8f834be8

data/README.md

@@ -4,7 +4,7 @@ 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!
+It automatically detects nested entities and eager-loads them for faster DB access!
 
 Define your responder (requested methods):
 
@@ -31,16 +31,16 @@ class UserAPIQL < ::APIQL
 end
 
 ```
-In controller or Grape API endpoint, handler of POST /user method:
+In controller or Grape API endpoint, handler of POST /apiql method (or any other, see below APIQL.endpoint):
 
 ```ruby
-def user
+def apiql
   schema = APIQL.cache(params)
   UserAPIQL.new(self, :session, :current_user, :params).render(schema)
 end
 
 ```
-variables `session`, `current_user` and `params` (you can list any you need) will be stored into context you can use in presenters and handlers
+variables `session`, `current_user` and `params` (you can list any you need in your presenters/responders) will be stored into context you can use in presenters and handlers
 
 Define presenters for your models:
 
@@ -66,14 +66,14 @@ assets/javascripts/application.js:
 
 ```javascript
 //= require apiql
-APIQL.endpoint = "/"
+APIQL.endpoint = "/apiql"
 ```
 
 ```javascript
-// function apiql(endpoint, schema, params = {}, form = null) -- schema is cached, so entire request is passed only for first time, later - short hashes only
+// function apiql(schema, params = {}, form = null) -- schema is cached, so entire request is passed only for first time, later - short hashes only
 
 authenticate(email, password) {
-  apiql("user", `
+  apiql(`
     logout()
 
     authenticate(email, password) {
@@ -88,7 +88,7 @@ authenticate(email, password) {
       }
    }
   `, {
-    email: email, // these var will be passed into methods on the server side
+    email: email, // these vars will be passed into methods on the server side
     password: password
   })
   .then(response => { // response contains results of called methods
@@ -97,7 +97,7 @@ authenticate(email, password) {
 }
 
 logout() {
-  apiql("user", `
+  apiql(`
     logout
   `)
   .then(response => {
@@ -109,12 +109,12 @@ logout() {
 you can call methods on entities:
 
 ```javascript
-  apiql("user", `
+  apiql(`
     authenticate(email, password) {
       token
     }
 
-    me.reload {
+    user: me.reload {
       email full_name role token
 
       roles(filter) {
@@ -132,7 +132,7 @@ you can call methods on entities:
     password: password
   })
   .then(response => {
-    let user = response['me.reload'] // name in response equals to called
+    let user = response.user
   })
 }
 ```
@@ -143,12 +143,6 @@ config/initializers/apiql.rb:
 
 ```ruby
 class APIQL
-  delegate :authorize!, to: :@context
-
-  class Entity
-    delegate :authorize!, to: :@context
-  end
-
   class Context
     def authorize!(*args)
       ability.authorize!(*args)
@@ -182,3 +176,22 @@ class User < ApplicationRecord
 end
 
 ```
+
+you can add CRUD methods for your models:
+
+```ruby
+class UserAPIQL < ::APIQL
+  model ::User
+  model ::Role
+end
+```
+
+or mount methods from external modules:
+
+```ruby
+class UserAPIQL < ::APIQL
+  mount ::Services::User # all methouds could be called with "user" prefix like "user.logout()"
+  mount ::Services::Common, as: '' # all methods could be called without prefixes
+  mount ::Services::Employer, as: 'dashboard" # all methods could be called with specified prefix
+end
+```

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.3.6'
+  spec.version       = '0.4.0'
   spec.authors       = ['Dmitry Silchenko']
   spec.email         = ['dmitry@desofto.com']
 

data/assets/javascripts/apiql.js

@@ -13,7 +13,7 @@ const APIQL = {
     return hash
   },
 
-  call(endpoint, schema, params = {}, form = null) {
+  call(schema, params = {}, form = null) {
     return new Promise((resolve, reject) => {
       if(params instanceof FormData) {
         form = params
@@ -32,7 +32,7 @@ const APIQL = {
         params.apiql = this.hash(schema)
       }
 
-      Vue.http.post(`${APIQL.endpoint}${endpoint}`, form || params)
+      Vue.http.post(APIQL.endpoint, form || params)
       .then(response => {
         resolve(response.body)
       })
@@ -50,7 +50,7 @@ const APIQL = {
           params.apiql_request = schema
         }
 
-        Vue.http.post(`${APIQL.endpoint}${endpoint}`, form || params)
+        Vue.http.post(APIQL.endpoint, form || params)
         .then(response => {
           resolve(response.body)
         })
@@ -66,6 +66,6 @@ const APIQL = {
   }
 }
 
-function apiql(endpoint, schema, params = {}, form = null) {
-  return APIQL.call(endpoint, schema, params, form)
+function apiql(schema, params = {}, form = null) {
+  return APIQL.call(schema, params, form)
 }

data/lib/apiql.rb

@@ -7,12 +7,90 @@ class APIQL
     end
   end
 
+  module CRUD
+    def model(klass)
+      define_method "#{klass.name.pluralize.underscore}" do |page = nil, page_size = 10|
+        authorize! :read, klass
+
+        if page.present?
+          {
+            total: klass.count,
+            items: klass.offset(page * page_size).limit(page_size)
+          }
+        else
+          klass.all
+        end
+      end
+
+      define_method "#{klass.name.underscore}" do |id|
+        item = klass.find(id)
+
+        authorize! :read, item
+
+        item
+      end
+
+      define_method "#{klass.name.underscore}.create" do |params|
+        authorize! :create, klass
+
+        klass_entity = "#{klass.name}::Entity".constantize
+
+        if klass_entity.respond_to?(:create_params, params)
+          params = klass_entity.send(:create_params, params)
+        elsif klass_entity.respond_to?(:params, params)
+          params = klass_entity.send(:params, params)
+        end
+
+        klass.create!(params)
+      end
+
+      define_method "#{klass.name.underscore}.update" do |id, params|
+        item = klass.find(id)
+
+        authorize! :update, item
+
+        klass_entity = "#{klass.name}::Entity".constantize
+
+        if klass_entity.respond_to?(:update_params, params)
+          params = klass_entity.send(:update_params, params)
+        elsif klass_entity.respond_to?(:params, params)
+          params = klass_entity.send(:params, params)
+        end
+
+        item.update!(params)
+      end
+
+      define_method "#{klass.name.underscore}.destroy" do |id|
+        item = klass.find(id)
+
+        authorize! :destroy, item
+
+        item.destroy!
+      end
+    end
+  end
+
   class Error < StandardError; end
   class CacheMissed < StandardError; end
 
   attr_reader :context
+  delegate :authorize!, to: :@context
 
   class << self
+    include ::APIQL::CRUD
+
+    def mount(klass, as: nil)
+      as ||= klass.name.split('::').last.underscore
+      as += '.' if as.present?
+
+      klass.instance_methods(false).each do |method|
+        klass.alias_method("#{as}#{method}", method)
+        klass.remove_method(method) if as.present?
+      end
+
+      include klass
+    end
+
     @@cache = {}
 
     def cache(params)
@@ -185,6 +263,8 @@ class APIQL
   private
 
   class Entity
+    delegate :authorize!, to: :@context
+
     class << self
       attr_reader :apiql_attributes
 
@@ -350,6 +430,8 @@ class APIQL
       end
     end
 
+    def authorize!(*args); end
+
     def inject_delegators(target)
       @fields.each do |field|
         target.class_eval do

metadata

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