joshua 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97f67b2151729e09380d17e95912b296ff0c331350fae452e9f76dca7eb261ff
-  data.tar.gz: a357cae187aa7fe62a156fe072483ee2beabc551f8d0f4a3f7ef4cbddf54fbb1
+  metadata.gz: 890a0ef798280cde7effdabc9a385aa7adc07b52579bea110af04ab714c98e46
+  data.tar.gz: 749d50df471c4ee8d2badfe598b174a3eb3bf4190f88b70cc13da320b5a2386b
 SHA512:
-  metadata.gz: d436bb1c456d35c94eb58652b8f8039e82e73f9843d27b260228ee5138f9e97e3f5f50f3e198071a1bbb31687a0a52b0b71b4e6d6cd63e9b545c3b4f5cf1d893
-  data.tar.gz: 384f3639558cc7faa06bbf23d6bcd19ed92248b174eb58da4c812509d404717469bb1906e2dae363c9a182ca9ed444bd15a2a6fe123df7ff97824c2fbc157668
+  metadata.gz: 4fb42a8f389bea6fe2be92224ede26f06f3b8328d22c06c2c744a2cac4345ca819fc0c9d1a64af92d899de3f4a94b2d3e0cc96a031fcbec91a877dc808a519c5
+  data.tar.gz: aef74afb03695d3be2b5d7bfa15b94b0c5497080c314c135f7c075b07c4a019d03bd88edaa42b5650861758990e001d1dd0aaf94db88131bdeb37485977115d8

data/.version

@@ -1 +1 @@
-0.2.2
+0.2.4

data/lib/doc/doc.rb

@@ -8,14 +8,15 @@ class Joshua
         image: '<path d="M11.999 1.271C5.925 1.271 1 6.196 1 12.273c0 4.859 3.152 8.982 7.523 10.437.55.1.751-.239.751-.53l-.015-1.872c-3.06.666-3.706-1.474-3.706-1.474-.5-1.271-1.221-1.609-1.221-1.609-.999-.683.075-.668.075-.668 1.105.077 1.685 1.133 1.685 1.133.981 1.681 2.575 1.196 3.202.914.1-.711.384-1.196.698-1.471-2.442-.277-5.011-1.221-5.011-5.436 0-1.201.429-2.183 1.133-2.952-.114-.278-.491-1.397.108-2.911 0 0 .923-.296 3.025 1.127A10.56 10.56 0 0 1 12 6.591c.935.004 1.876.127 2.754.37 2.1-1.423 3.022-1.127 3.022-1.127.6 1.514.223 2.633.11 2.911.705.769 1.131 1.751 1.131 2.952 0 4.225-2.573 5.155-5.023 5.427.395.34.747 1.011.747 2.038 0 1.471-.014 2.657-.014 3.018 0 .293.199.636.756.528C19.851 21.251 23 17.13 23 12.273c0-6.077-4.926-11.002-11.001-11.002z"></path>',
       },
       twitter: {
-        url:   'https://twitter.com/@dux',
+        url:   nil,
         image: '<path d="M22.208 3.871c-.757.252-1.824.496-2.834.748-.757-.883-1.892-1.388-3.154-1.388-2.902 0-4.92 2.649-4.289 5.425-3.659-.126-6.939-1.892-9.083-4.542-1.135 1.892-.505 4.542 1.388 5.803-.757 0-1.388-.126-2.019-.505 0 2.145 1.388 4.037 3.532 4.416-.631.252-1.388.252-2.019.126.505 1.766 2.145 3.028 4.037 3.028-1.892 1.388-4.289 2.019-6.56 1.766 1.892 1.262 4.163 2.019 6.686 2.019 8.2 0 12.742-6.813 12.49-12.994.753-1.089 1.49-2.201 1.824-3.902z"></path>',
       },
       email: {
-        url:   'mailto:reic.dino@gmail.com',
+        url:   nil,
         image: '<path d="M22.22 9.787c0-5.13-4.062-8.307-8.983-8.307-6.666 0-11.457 4.948-11.457 11.431 0 6.042 4.609 9.609 9.999 9.609 1.64 0 3.749-.391 5.234-1.12l.364-2.031c-1.484.729-3.645 1.224-5.442 1.224-4.661 0-7.968-2.968-7.968-7.682 0-5.025 3.619-9.478 9.14-9.478 3.854 0 7.004 2.318 7.004 6.354 0 1.562-.39 3.671-1.588 4.843-.521.521-1.068.885-1.849.885-.599 0-1.015-.312-1.015-1.015 0-.235.052-.495.104-.729l1.614-6.458h-1.745l-.65 1.094c-.521-.938-1.615-1.381-2.63-1.381-3.386 0-5.208 3.151-5.208 6.25 0 1.198.416 2.291 1.197 3.047.599.598 1.485 1.041 2.5 1.041 1.328 0 2.422-.443 3.307-1.458.209.729 1.042 1.458 2.292 1.458 1.64 0 2.578-.625 3.541-1.562 1.536-1.484 2.239-3.828 2.239-6.015zm-7.916 1.276c0 1.77-.755 4.426-2.916 4.426-1.458 0-2.057-1.067-2.057-2.395 0-1.094.365-2.474 1.172-3.385.442-.495 1.015-.886 1.718-.886 1.406 0 2.083.886 2.083 2.24z"></path>',
       },
       error: {
+        url: 'https://github.com/dux/joshua/issues',
         image: '<path d="M3,4v12c0,1.103,0.897,2,2,2h3.5l3.5,4l3.5-4H19c1.103,0,2-0.897,2-2V4c0-1.103-0.897-2-2-2H5C3.897,2,3,2.897,3,4z M11,5 h2v6h-2V5z M11,13h2v2h-2V13z" />'
       }
     }
@@ -37,7 +38,7 @@ class Joshua
         n.head  do |n|
           n.title 'Joshua Tester'
           n.link({ href: "https://fonts.googleapis.com/css?family=Inter:300,400,500,600,700,800,900&display=swap",  rel:"stylesheet" })
-          n.link({ rel:"stylesheet", href:"https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" })
+          n.link({ rel:"stylesheet", href:"https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.5.0/css/bootstrap.min.css" })
           n.script({ src: 'https://cdnjs.cloudflare.com/ajax/libs/zepto/1.2.0/zepto.min.js' })
           n.script %[window.api_opts = { mount_on: '#{mount_on}', bearer: '#{bearer}' }]
         end
@@ -51,6 +52,8 @@ class Joshua
             end
           end
 
+          n.img src:"https://i.imgur.com/HWoUz5k.png", style: 'width: 40px; z-index: 1; position: absolute; top: 10px; left: 50%;', onclick: "window.open('https://github.com/dux/joshua')"
+
           n.push modal_dialog
 
           n._container do |n|
@@ -66,7 +69,7 @@ class Joshua
                   n.p '<b>TOOLS</b>'
                   n.div do |n|
                     n.push %[<p><a class="badge badge-light" href="#api_errors">Named errors</a></p>]
-                    n.push %[<p><a class="badge badge-light" href="#{mount_on}_/postman" target="capi_postman">Postman import URL</a></p>]
+                    n.push %[<p><a class="badge badge-light" href="#{mount_on}_/postman" target="capi_postman">Postman/Insomnija import URL</a></p>]
                     n.push %[<p><a class="badge badge-light" href="#{mount_on}_/raw" target="capi_raw">Raw doc data</a></p>]
                   end
 
@@ -74,7 +77,7 @@ class Joshua
 
                   n.p '<b>API LIBRARIES</b>'
                   n.div do |n|
-                    n.push %[<a class="badge badge-light" href="https://github.com/dux/joshua/blob/master/lib/misc/ruby_client.rb" target="capi_ruby">Ruby</a>]
+                    n.push %[<a class="badge badge-light" href="https://github.com/dux/joshua/blob/master/lib/client/ruby/client" target="capi_ruby">Ruby</a>]
                     n.push %[<a class="badge badge-light" href="https://github.com/dux/joshua/blob/master/lib/misc/api_example.coffee" target="capi_js">Javascript</a>]
                     n.push %[<a class="badge badge-light" href="#">Python</a>]
                     n.push %[<a class="badge badge-light" href="#">C#</a>]

data/lib/doc/special.rb

@@ -1,20 +1,128 @@
 # reponse from /api/_/foo
 
 class Joshua
-  module DocSpecial
-    extend self
+  class DocSpecial
+    def initialize api
+      @api = api
+    end
 
     def postman
-      raw
+      out = {
+        info: {
+          _postman_id: request.url,
+          _bearer_token: @api[:bearer],
+          name: request.host,
+          schema: "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+        },
+        item: []
+      }
+
+      for table, data in raw
+        raw_data = raw[table.to_s]
+        hash = {}
+        hash[:name] = table
+        hash[:item] = []
+
+        for type in [:collection, :member]
+          next unless raw_data[type]
+
+          if raw_data[type]
+            items = []
+
+            for key, value in raw_data[type]
+              items.push postman_add_method(type, table, key, value)
+            end
+
+            hash[:item].push *items
+            # hash[:item].push({
+            #   name: type,
+            #   item: items
+            # })
+          end
+        end
+
+        out[:item].push hash
+      end
+
+      @api[:development] ? JSON.pretty_generate(out) : out.to_json
     end
 
     def raw
       unwanted = %w(all member collection)
       {}.tap do |doc|
         for el in Joshua.documented
-          doc[el.to_s.sub(/Api$/, '').tableize] = el.opts.filter { |k, _| !unwanted.include?(k.to_s.split('_')[1]) }
+          doc[el.to_s.sub(/Api$/, '').underscore] = el.opts.filter do |k, v|
+            for k1, v1 in v
+              if v1.is_a?(Hash)
+                for k2 in v1.keys
+                  # remove Typero
+                  v1.delete(k2) if k2.to_s.start_with?('_')
+                end
+              end
+            end
+
+            !unwanted.include?(k.to_s.split('_')[1])
+          end
+        end
+      end
+    end
+
+    private
+
+    def postman_add_method type, table, name, item
+      path = []
+
+      base = request.url.split('/_/').first
+      base = base.split('/')
+
+      path.push base.pop
+      base = base.join('/')
+
+      path.push table
+      path.push ':id' if type == :member
+      path.push name
+
+      name = '%s*' % name if type == :collection
+
+      out = {
+        name: name,
+        request: {
+          method: 'POST',
+          header: [],
+          url: {
+            raw:      ([base] + path).join('/'),
+            protocol: base.split(':').first,
+            host:     request.host.split('.'),
+            port:     request.port,
+            path:     path
+          },
+        }
+      }
+
+      for key, value in (item[:params] || {})
+        out[:request][:body] ||= { mode: 'formdata', formdata: [] }
+
+        formdata_custom = 'formdata_%s' % value[:type]
+
+        # if value[:type] == 'model' and key == 'user' you can define "formdata_model"
+        # that returns list of fields for defined model
+        formdata_value =
+        if respond_to?(formdata_custom)
+          opts = { key: key, value: value, name: name, type: type, group: table }
+          [send(formdata_custom, opts.to_hwia)].flatten
+        else
+          { key: key, description: value[:type] }
         end
+
+        formdata_value = [formdata_value] unless formdata_value.is_a?(Array)
+        out[:request][:body][:formdata].push *formdata_value
       end
+
+      out
+    end
+
+    def request
+      @api[:api_host].request
     end
   end
 end

data/lib/joshua.rb

@@ -20,17 +20,14 @@ unless ''.respond_to?(:dasherize)
 end
 
 require 'json'
+require 'typero'
 require 'html-tag'
-require 'clean-hash'
+require 'hash_wia'
 
-require_relative './joshua/params/define'
-require_relative './joshua/params/parse'
-require_relative './joshua/params/types'
-require_relative './joshua/params/types_errors'
-require_relative './joshua/opts'
-require_relative './joshua/base'
-require_relative './joshua/error'
+require_relative './joshua/base_instance'
+require_relative './joshua/base_class'
 require_relative './joshua/response'
+require_relative './joshua/render_proxy'
 
 require_relative './doc/doc'
 require_relative './doc/special'

data/lib/joshua/base_class.rb

@@ -0,0 +1,420 @@
+class Joshua
+  @@after_auto_mount = nil
+  @@opts   = {}
+
+  class << self
+    # perform auto_mount from a rake call
+    def call env
+      request = Rack::Request.new env
+
+      if request.path == '/favicon.ico'
+        [
+          200,
+          { 'Cache-Control'=>'public; max-age=1000000' },
+          [Doc.misc_file('favicon.png')]
+        ]
+      else
+        data = auto_mount request: request, development: ENV['RACK_ENV'] == 'development'
+
+        if data.is_a?(Hash)
+          [
+            data[:status] || 200,
+            { 'Content-Type' => 'application/json', 'Cache-Control'=>'private; max-age=0' },
+            [data.to_json]
+          ]
+        else
+          data = data.to_s
+          [
+            200,
+            { 'Content-Type' => 'text/html', 'Cache-Control'=>'public; max-age=3600' },
+            [data]
+          ]
+        end
+      end
+    end
+
+    # ApplicationApi.auto_mount request: request, response: response, mount_on: '/api', development: true
+    # auto mount to a root
+    # * display doc in a root
+    # * call methods if possible /api/v1.comapny/1/show
+    def auto_mount api_host:, mount_on: nil, bearer: nil, development: false
+      request  = api_host.request
+      response = api_host.response
+
+      mount_on ||= OPTS[:api][:mount_on] || '/'
+      mount_on   = [request.base_url, mount_on].join('') unless mount_on.to_s.include?('//')
+
+      if request.url == mount_on && request.request_method == 'GET'
+        response.header['Content-Type'] = 'text/html' if response
+
+        Doc.render request: request, bearer: bearer
+      else
+        response.header['Content-Type'] = 'application/json' if response
+
+        body     = request.body.read.to_s
+        body     = body[0] == '{' ? JSON.parse(body) : nil
+
+        # class: klass, params: params, bearer: bearer, request: request, response: response, development: development
+        opts = {}
+        opts[:api_host]    = api_host
+        opts[:development] = development
+        opts[:bearer]      = bearer
+
+        action =
+        if body
+          # {
+          #   "id": 'foo',         # unique ID that will be returned, as required by JSON RPC spec
+          #   "class": 'v1/users', # v1/users => V1::UsersApi
+          #   "action": 'index',   # "index' or "6/info" or [6, "info"]
+          #   "token": 'ab12ef',   # api_token (bearer)
+          #   "params": {}         # methos params
+          # }
+          opts[:params] = body['params'] || {}
+          opts[:bearer] = body['token'] if body['token']
+          opts[:class]  = body['class']
+
+          body['action']
+        else
+          opts[:params] = request.params || {}
+          opts[:bearer] = opts[:params][:api_token] if opts[:params][:api_token]
+
+          mount_on = mount_on+'/' unless mount_on.end_with?('/')
+          path     = request.url.split(mount_on, 2).last.split('?').first.to_s
+          parts    = path.split('/')
+
+          @@after_auto_mount.call parts, opts if @@after_auto_mount
+
+          opts[:class] = parts.shift
+          parts
+        end
+
+        opts[:bearer] ||= request.env['HTTP_AUTHORIZATION'].to_s.split('Bearer ')[1]
+
+        api_response = render action, **opts
+
+        if api_response.is_a?(Hash)
+          response.status = api_response[:status] if response
+          api_response.to_h
+        else
+          api_response
+        end
+      end
+    end
+
+    # renders api doc or calls api class + action
+    def render action=nil, opts={}
+      if action
+        return error 'Action not defined' unless action[0]
+      else
+        return RenderProxy.new self
+      end
+
+      api_class =
+      if klass = opts.delete(:class)
+        # /api/_/foo
+        if klass == '_'
+          klass = Joshua::DocSpecial.new(opts)
+
+          if klass.respond_to?(action.first)
+            return klass.send action.first.to_sym
+          else
+            return error 'Action %s not defined' % action.first
+          end
+        end
+
+        klass = klass.split('/') if klass.is_a?(String)
+        klass[klass.length-1] += '_api'
+
+        begin
+          klass.join('/').classify.constantize
+        rescue NameError => e
+          return error 'API class "%s" not found' % klass
+        end
+      else
+        self
+      end
+
+      api = api_class.new action, **opts
+      api.execute_call
+    rescue => error
+      error_print error if opts[:development]
+      Response.auto_format error
+    end
+
+    # rescue_from CustomError do ...
+    # for unhandled
+    # rescue_from :all do
+    #   api.error 500, 'Error happens'
+    # end
+    # define handled error code and description
+    # error :not_found, 'Document not found'
+    # error 404, 'Document not found'
+    # in api methods
+    # error 404
+    # error :not_found
+    def rescue_from klass, desc=nil, &block
+      RESCUE_FROM[klass] = desc || block
+    end
+
+    def after_auto_mount &blok
+      @@after_auto_mount = blok
+    end
+
+    # show and render single error in class error format
+    # usually when API class not found
+    def response_error text
+      out = Response.new nil
+      out.error text
+      out.render
+    end
+
+    # class errors, raised by params validation
+    def error desc
+      raise Joshua::Error, desc
+    end
+
+    def error_print error
+      puts
+      puts 'Joshua error dump'.red
+      puts '---'
+      puts '%s: %s' % [error.class, error.message]
+      puts '---'
+      puts error.backtrace
+      puts '---'
+    end
+
+    # sets api mount point
+    # mount_on '/api'
+    def mount_on what
+      OPTS[:api][:mount_on] = what
+    end
+
+    # if you want to make API DOC public use "documented"
+    def documented
+      if self == Joshua
+        DOCUMENTED.map(&:to_s).sort.map(&:constantize)
+      else
+        DOCUMENTED.push self unless DOCUMENTED.include?(self)
+      end
+    end
+
+    def api_path
+      to_s.underscore.sub(/_api$/, '')
+    end
+
+    # define method annotations
+    # annotation :unsecure! do
+    #   @is_unsecure = true
+    # end
+    # unsecure!
+    # def login
+    #   ...
+    def annotation name, &block
+      ANNOTATIONS[name] = block
+      self.define_singleton_method name do |*args|
+        unless @method_type
+          error 'Annotation "%s" defined outside the API method blocks (member & collections)' % name
+        end
+
+        @@opts[:annotations] ||= {}
+        @@opts[:annotations][name] = args
+      end
+    end
+
+    # aleternative way to define a api function
+    # members do
+    #   define :foo do
+    #     params {}
+    #     proc {}
+    #   end
+    # end
+    def define name, &block
+      func = class_exec &block
+
+      if func.is_a?(Proc)
+        self.define_method(name, func)
+      else
+        raise 'Member block has to return a Func object'
+      end
+    end
+
+    # /api/companies/1/show
+    def member &block
+      @method_type = :member
+      func = class_exec &block
+      @method_type = nil
+    end
+    alias :members :member
+
+    # /api/companies/list?countrty_id=1
+    def collection &block
+      @method_type = :collection
+      class_exec &block
+      @method_type = nil
+    end
+    alias :collections :collection
+
+    # params do
+    #   name? String
+    #   email :email
+    # end
+    def params &block
+      raise ArgumentError.new('Block not given for Joshua API method params') unless block_given?
+
+      @@opts[:_typero] = Typero.schema &block
+      @@opts[:params] = @@opts[:_typero].to_h
+    end
+
+    # api method icon
+    # you can find great icons at https://boxicons.com/ - export to svg
+    def icon data
+      if @method_type
+        raise ArgumentError.new('Icons cant be added on methods')
+      else
+        set :opts, :icon, data
+      end
+    end
+
+    # api method description
+    def desc data
+      if @method_type
+        @@opts[:desc] = data
+      else
+        set :opts, :desc, data
+      end
+    end
+
+    # api method detailed description
+    def detail data
+      return if data.to_s == ''
+
+      if @method_type
+        @@opts[:detail] = data
+      else
+        set :opts, :detail, data
+      end
+    end
+
+    def allow type
+      if @method_type
+        @@opts[:allow] = type
+      else
+        raise ArgumentError.new('allow can only be set on methods')
+      end
+    end
+
+    # method in available for GET requests as well
+    def gettable
+      if @method_type
+        @@opts[:gettable] = true
+      else
+        raise ArgumentError.new('gettable can only be set on methods')
+      end
+    end
+
+    # allow methods without @api.bearer token set
+    def unsafe
+      if @method_type
+        @@opts[:unsafe] = true
+      else
+        raise ArgumentError.new('Only api methods can be unsafe')
+      end
+    end
+
+    # block execute before any public method or just some member or collection methods
+    def before &block
+      set_callback :before, block
+    end
+
+    # block execute after any public method or just some member or collection methods
+    # used to add meta tags to response
+    def after &block
+      set_callback :after, block
+    end
+
+    # simplified module include, masked as plugin
+    # Joshua.plugin :foo do ...
+    # Joshua.plugin :foo
+    def plugin name, &block
+      if block_given?
+        # if block given, define a plugin
+        PLUGINS[name] = block
+      else
+        # without a block execute it
+        blk = PLUGINS[name]
+        raise ArgumentError.new('Plugin :%s not defined' % name) unless blk
+        instance_exec &blk
+      end
+    end
+
+    def get *args
+      opts.dig *args
+    end
+
+    # dig all options for a current class
+    def opts
+      out = {}
+
+      # dig down the ancestors tree till Object class
+      ancestors.each do |klass|
+        break if klass == Object
+
+        # copy all member and collection method options
+        keys = (OPTS[klass.to_s] || {}).keys
+        keys.each do |type|
+          for k, v in (OPTS.dig(klass.to_s, type) || {})
+            out[type] ||= {}
+            out[type][k] ||= v
+          end
+        end
+      end
+
+      out
+    end
+
+    # propagate to typero
+    def model name, &block
+      Typero.schema name, &block
+    end
+
+    # here we capture member & collection metods
+    def method_added name
+      return if name.to_s.start_with?('_api_')
+      return unless @method_type
+
+      set @method_type, name, @@opts
+
+      @@opts = {}
+
+      alias_method "_api_#{@method_type}_#{name}", name
+      remove_method name
+    end
+
+    private
+
+    def only_in_api_methods!
+      raise ArgumentError, "Available only inside collection or member block for API methods." unless @method_type
+    end
+
+    def set_callback name, block
+      name = [name, @method_type || :all].join('_').to_sym
+      set name, []
+      OPTS[to_s][name].push block
+    end
+
+    # generic opts set
+    # set :user_name, :email, :baz
+    def set *args
+      name, value   = args.pop(2)
+      args.unshift to_s
+      pointer = OPTS
+
+      for el in args
+        pointer[el] ||= {}
+        pointer = pointer[el]
+      end
+
+      pointer[name] = value
+    end
+  end
+end