apiql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1247c3ec8750be3ff5db48d0503782f5342bb42dd7f0159518eb214356886697
+  data.tar.gz: 2f15a8174f0d452878913bf352ef7b49558bb33610fa63f33fc5bd4daa938519
+SHA512:
+  metadata.gz: 7ce244c93ce695ec8cfd56bc7f11f055312f1b59e0220a193faeb8a1a597b88733a33e8c0a2ca96e198fd01b34f15ff323bb51a6f03d715ce0ac02c643e36b84
+  data.tar.gz: c3edf30b166525a052be905902b2f4d7641e38a099e20ac75951e40c9d2dadf24cc4f8894012c9fbe7cd07a3f3d6a0deae4d4f52c90655408f457ca682d6cb3e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 DeSofto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# APIQL
+
+Implementation of the API language similar to GraphQL for Ruby on Rails
+
+Define your responder (requested methods):
+
+```ruby
+class UserAPIQL < ::APIQL
+  def me
+    authorize! :show, ::User
+
+    context.current_user&.eager_load(:roles) # you can preload everything you need for speedup presenters
+  end
+
+  def authenticate(email, password)
+    user = ::User.find_by(email)
+    user.authenticate(password)
+
+    user
+  end
+
+  def logout
+    context.current_user&.logout
+
+    :ok
+  end
+end
+
+```
+In controller or Grape API endpoint, handler of POST /user method:
+
+```ruby
+def user
+  schema = APIQL.cache(params)
+  UserAPIQL.new(self, :session, :current_user, :params).render(schema)
+end
+
+```
+variables `session`, `current_user` and `params` will be stored into context you can use in presenters and handlers
+
+Define presenters for your models:
+
+```ruby
+class User < ApplicationRecord
+  class Entity < ::APIQL::Entity
+    attributes :full_name, :email, :token, :role, :roles
+
+    def token
+      object.token if object == context.current_user
+    end
+  end
+
+  has_many :roles
+
+  ...
+end
+
+```
+# JS:
+
+application.js:
+
+```javascript
+APIQL.endpoint = "/"
+```
+
+```javascript
+authenticate(email, password) {
+  let api = new APIQL("user")
+  api.call(`
+    logout()
+    authenticate(email,password) {
+      token
+    }
+    me {
+      email full_name role token
+   }
+  `, {
+    email: email,
+    password: password
+  })
+  .then(response => {
+    let user = response.me
+  })
+}
+
+logout() {
+  let api = new APIQL("user")
+  api.call(`
+    logout
+  `)
+  .then(response => {
+  })
+}
+
+```

data/apiql.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'apiql'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Dmitry Silchenko']
+  spec.email         = ['dmitry@desofto.com']
+
+  spec.summary       = 'APIQL.'
+  spec.description   = 'APIQL.'
+  spec.homepage      = 'https://github.com/desofto/apiql'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/assets/javascripts/apiql.js

@@ -0,0 +1,64 @@
+class APIQL {
+  constructor(endpoint) {
+    this.endpoint = endpoint
+  }
+
+  hash(s) {
+    let hash = 0, i, chr
+    if(s.length === 0) return hash
+    for(i = 0; i < s.length; i++) {
+      chr   = s.charCodeAt(i)
+      hash  = ((hash << 5) - hash) + chr
+      hash |= 0
+    }
+    return hash
+  }
+
+  call(schema, params = {}, form = null) {
+    return new Promise((resolve, reject) => {
+      if(params instanceof FormData) {
+        form = params
+        params = {}
+      }
+
+      if(form) {
+        Object.keys(params).forEach(key => {
+          form.append(key, params[key])
+        })
+      }
+
+      if(form) {
+        form.append('apiql', this.hash(schema))
+      } else {
+        params.apiql = this.hash(schema)
+      }
+
+      Vue.http.post(`${APIQL.endpoint}${this.endpoint}`, params)
+      .then(response => {
+        resolve(response.body)
+      })
+      .catch(response => {
+        if(response.status == 401 && APIQL.unauthenticated) {
+          APIQL.unauthenticated()
+        }
+
+        if(form) {
+          form.append('apiql_request', schema)
+        } else {
+          params.apiql_request = schema
+        }
+
+        Vue.http.post(`${APIQL.endpoint}${this.endpoint}`, form || params)
+        .then(response => {
+          resolve(response.body)
+        })
+        .catch(response => {
+          alert(response.body.errors)
+        })
+      })
+    })
+  }
+}
+
+APIQL.unauthenticated = null
+APIQL.endpoint = ''

data/lib/apiql.rb

@@ -0,0 +1,275 @@
+class APIQL
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer 'apiql.assets' do |app|
+        app.config.assets.paths << root.join('assets', 'javascripts').to_s
+      end
+    end
+  end
+
+  class Error < StandardError; end
+  class CacheMissed < StandardError; end
+
+  attr_reader :context
+
+  class << self
+    @@cache = {}
+
+    def cache(params)
+      request_id = params[:apiql]
+      request = params[:apiql_request]
+
+      if request.present?
+        redis&.set("api-ql-cache-#{request_id}", request)
+        @@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?
+      end
+
+      request
+    end
+
+    def simple_class?(value)
+      value.nil? ||
+        value.is_a?(TrueClass) || value.is_a?(FalseClass) ||
+        value.is_a?(Symbol) || value.is_a?(String) ||
+        value.is_a?(Integer) || value.is_a?(Float) || value.is_a?(BigDecimal)
+    end
+
+    private
+
+    def redis
+      @redis ||=
+        begin
+          ::Redis.new(host: 'localhost')
+        rescue
+          nil
+        end
+    end
+  end
+
+  def initialize(binder, *fields)
+    @context = ::APIQL::Context.new(binder, *fields)
+  end
+
+  def render(schema)
+    result = {}
+
+    function = nil
+    data = nil
+
+    pool = nil
+    keys = nil
+    last_key = nil
+
+    while schema.present? do
+      if reg = schema.match(/\A\s*\{(?<rest>.*)\z/m) # {
+        schema = reg[:rest]
+
+        pool.push [keys, last_key]
+        keys = []
+      elsif reg = schema.match(/\A\s*\}(?<rest>.*)\z/m) # }
+        schema = reg[:rest]
+
+        last_keys = keys
+
+        keys, last_key = pool.pop
+
+        if pool.empty?
+          result[function] = context.render_value(data, last_keys)
+          function = nil
+        else
+          keys.delete(last_key)
+          keys << { last_key => last_keys }
+        end
+      elsif function.present? && (reg = schema.match(/\A\s*(?<name>\w+)(\((?<params>.*)\))?(?<rest>.*)\z/m))
+        schema = reg[:rest]
+
+        if reg[:params].present?
+          keys << [reg[:name], reg[:params]]
+        else
+          keys << reg[:name]
+        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]
+
+        function = reg[:name]
+        params = context.parse_params(reg[:params])
+
+        data = public_send(function, *params)
+
+        pool = []
+        requested = {}
+
+        last_key = nil
+
+        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]
+
+        function = reg[:name]
+        params = context.parse_params(reg[:params])
+
+        data = public_send(function, *params)
+        unless APIQL::simple_class?(data)
+          data = nil
+        end
+
+        result[function] = data
+
+        function = nil
+      else
+        raise Error
+      end
+    end
+
+    result
+  end
+
+  class Entity
+    class << self
+      attr_reader :apiql_attributes
+
+      def inherited(child)
+        super
+
+        return if self.class == ::APIQL::Entity
+
+        attributes = apiql_attributes&.try(:deep_dup) || []
+
+        child.instance_eval do
+          @apiql_attributes = attributes
+        end
+      end
+
+      def attributes(*attrs)
+        @apiql_attributes ||= []
+        @apiql_attributes += attrs.map(&:to_sym)
+      end
+    end
+
+    attr_reader :object, :context
+
+    def initialize(object, context)
+      @object = object
+      @context = context
+    end
+
+    def render(schema = nil)
+      return unless @object.present?
+
+      respond = {}
+
+      schema.each do |field|
+        if field.is_a? Hash
+          field.each do |field, sub_schema|
+            name = field.is_a?(Array) ? field.first : field
+            respond[name] = render_attribute(field, sub_schema)
+          end
+        else
+          name = field.is_a?(Array) ? field.first : field
+          respond[name] = render_attribute(field)
+        end
+      end
+
+      respond
+    end
+
+    private
+
+    def get_field(field)
+      if field.is_a? Array
+        field, params = field
+        params = context.parse_params(params)
+      end
+      return unless field.to_sym.in? self.class.apiql_attributes
+
+      if respond_to? field
+        public_send(field, *params)
+      else
+        object.public_send(field, *params)
+      end
+    end
+
+    def render_attribute(field, schema = nil)
+      data = get_field(field)
+
+      if data.is_a?(Hash) && schema.present?
+        respond = {}
+
+        schema.each do |field|
+          if field.is_a? Hash
+            field.each do |field, sub_schema|
+              respond[field] = render_value(data[field.to_sym], sub_schema)
+            end
+          else
+            respond[field] = render_value(data[field.to_sym], schema)
+          end
+        end
+
+        respond
+      else
+        render_value(data, schema)
+      end
+    end
+
+    def render_value(value, schema)
+      if schema.present?
+        context.render_value(value, schema)
+      else
+        value
+      end
+    end
+  end
+
+  class HashEntity < Entity
+    def get_field(field)
+      object[field.to_sym]
+    end
+  end
+
+  class Context
+    def initialize(binder, *fields)
+      fields.each do |field|
+        instance_variable_set("@#{field}", binder.send(field))
+        class_eval do
+          attr_accessor field
+        end
+      end
+    end
+
+    def parse_params(list)
+      list&.split(',')&.map(&:strip)&.map do |name|
+        if reg = name.match(/\A[a-zA-Z]\w*\z/)
+          params[name]
+        else
+          begin
+            Float(name)
+          rescue
+            name
+          end
+        end
+      end
+    end
+
+    def render_value(value, schema)
+      if value.is_a? Hash
+        HashEntity.new(value, self).render(schema)
+      elsif value.respond_to?(:each) && value.respond_to?(:map)
+        value.map do |object|
+          "#{object.class.name}::Entity".constantize.new(object, self).render(schema)
+        end
+      elsif APIQL::simple_class?(value)
+        value
+      else
+        "#{value.class.name}::Entity".constantize.new(value, self).render(schema)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: apiql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Silchenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: APIQL.
+email:
+- dmitry@desofto.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- apiql.gemspec
+- assets/javascripts/apiql.js
+- lib/apiql.rb
+homepage: https://github.com/desofto/apiql
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: APIQL.
+test_files: []