joshua 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3681a7c08c75032f3f6c574645e6a8375e5613d64c729a90119d3bc1c6d3e5be
+  data.tar.gz: 4cf6aeac3d58573b649f545ccdfae95f905c393ec476364989e8fb1fa0c38595
+SHA512:
+  metadata.gz: 9791cbbf644061bf19821093e7f91367466df6e77f66b8a0ef414f2cd5b5b0b4fa9a0c36125a64b3c874cf55e791a920ce8381a55b6bbc58b6a38e0aed791a1b
+  data.tar.gz: 3cf4e524aa396ee9c017c953f6eea4efc478df31160e1f96e92602a73ef9710cc896a297a1e7a6c3b77cbe2979571d51040471eef4e2a64bef47c1c5fb05dbed

data/.version

@@ -0,0 +1 @@
+0.1.0

data/lib/doc/doc.rb

@@ -0,0 +1,273 @@
+class Joshua
+  module Doc
+    extend self
+
+    ICONS = {
+      github:  {
+        url:   'https://github.com/dux/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',
+        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',
+        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: {
+        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" />'
+      }
+    }
+
+    def tag
+      HtmlTagBuilder
+    end
+
+    def misc_file name
+      File.read [__dir__, '../misc/%s' % name].join('/')
+    end
+
+    # render full page
+    def render mount_on: nil, request: nil, bearer: nil
+      mount_on ||= request.url.split('?').first+'/'
+      mount_on.sub! %r{//$}, '/'
+
+      tag.html do |n|
+        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.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
+        n.body do |n|
+          n.style { misc_file('doc.css') }
+          n.header({ style: 'border-bottom: 1px solid rgb(228, 228, 228);'}) do |n|
+            n._container do |n|
+              n.push top_icons
+              n.push %[<button id="bearer_button" onclick="AuthButton.set()" class="btn btn-sm btn-outline-primary" style="float: right; margin-top: 15px; margin-right: 20px;">-</button>]
+              n.h1({ class: :nav}) { %[<a href="#top">Joshua &nbsp; <gray>Docs</gray></a>] }
+            end
+          end
+
+          n.push modal_dialog
+
+          n._container do |n|
+            n._row do |n|
+              n._col_3 do |n|
+                n._sticky(style: 'padding-top: 30px;') do |n|
+                  n.a({ class: :dark, href: '#top' }) { '<p><b>API OBJECTS</b></p>' }
+                  n.push left_nav
+
+                  n.br
+                  n.br
+
+                  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}_/raw" target="capi_raw">Raw doc data</a></p>]
+                  end
+
+                  n.br
+
+                  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/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>]
+                  end
+
+                  n.br
+
+                  n.p '<b>RESOURCES</b>'
+                  n.div do |n|
+                    n.push %[<a class="badge badge-light" href="http://vmrcre.org/web/scribe/home/-/blogs/why-rest-sucks" target="capi_why">Why we only prefer POST?</a>]
+                  end
+                end
+              end
+
+              n._col_9 do |n|
+                n.push index
+                n.push list_errors
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # anchor link
+    def name_link name, top=nil
+      %[<a name="#{name}" class="anchor" style="top: #{top || -95}px;"></a>]
+    end
+
+    # render single icon
+    def icon data, size: 24, color: nil, style: nil
+      %[<svg style="width: #{size}px; height: #{size}px; #{style}" viewBox="0 0 24 24" fill="currentColor">#{data}</svg>]
+    end
+
+    # top side navigation icons
+    def top_icons
+      tag.div({ style: 'float: right; margin-top: 18px;' }) do |n|
+        for icon in ICONS.values
+          next unless icon[:url]
+          n.push %[<a target="_new" href="#{icon[:url]}">#{icon icon[:image]}</a>]
+        end
+      end
+    end
+
+    # left side navigation
+    def left_nav
+      tag.div do |n|
+        Joshua.documented.each do |name|
+          n.a({ class:'btn btn-outline-info btn-sm', style: '-font-size: 14px; margin-bottom: 10px;', href: '#%s' % name}) do |n|
+            icon = name.opts.dig(:opts, :icon)
+            n.push self.icon icon, size: 20 if icon
+            n.push name.to_s.sub(/Api$/, '')
+          end
+
+          n.br
+        end
+      end
+    end
+
+    # render doc for all documented classes
+    def index
+      tag.div do |n|
+        for @klass in Joshua.documented
+          @opts = @klass.opts
+          icon = @opts.dig(:opts, :icon)
+
+          n._sticky(style: 'background: #f7f7f7; padding-bottom: 5px; padding-top: 30px; margin-top: 2px;') do |n|
+            n.push name_link @klass, 40
+            n.push self.icon icon, style: 'position: absolute; margin-left: -40px; margin-top: 1px; fill: #777; background: #f7f7f7;' if icon
+            n.h4 { @klass.to_s.sub(/Api$/, '') }
+          end
+
+          if desc = @opts.dig(:opts, :desc)
+            n.p { desc }
+          end
+
+          if detail = @opts.dig(:opts, :detail)
+            n.p { detail }
+          end
+
+          n.push render_type :member
+          n.push render_type :collection
+
+          n.br
+          n.hr
+          n.br
+        end
+      end
+    end
+
+    # render members or collection
+    def render_type name
+      base = @opts[name] || return
+
+      tag.div do |n|
+        n.br
+        n.h5 '<gray>%s methods</gray>' % name
+
+        for m_name, member in base
+          n.div do |n|
+            n.push render_method name: name, m_name: m_name, opts: member
+          end
+        end
+      end
+    end
+
+    # render api method
+    def render_method name:, m_name:, opts:
+      tag._box do |n|
+        # n.push %[<button onclick="" class="btn btn-info btn-sm request">request</button>]
+        anchor = [@klass, m_name].join('-')
+
+        n.push name_link anchor
+        n.h5 do |n|
+          n.push "<a href='##{anchor}'>#{m_name}</a>"
+          n.push ' <gray>&nbsp; &mdash; &nbsp; %s</gray>' % opts[:desc] if opts[:desc]
+        end
+
+        n.p({style: 'margin: 20px 0 25px 0;'}) do |n|
+          path = @klass.api_path
+          path += '/:id' if name == :member
+          path += "/#{m_name}"
+          n.push %[<button href="#{path}" class="btn btn-outline-info btn-sm" onclick="ModalForm.render(api_opts.mount_on+this.innerHTML, #{(opts[:params] || {}).to_json.gsub('"', '&quot;')})">#{path}</button>]
+        end
+
+        if opts[:detail]
+          n.h6 'Details'
+          n.pre opts[:detail]
+        end
+
+        if mopts = opts[:params]
+          n.h6 'Params'
+          n.ul do |n|
+            for name, opt in mopts
+              n.li do |n|
+                n.push '<bold>%s</bold>: ' % name
+                n.push opt[:type]
+
+                data = []
+                data.push 'required' if opt[:required]
+                data.push 'default: %s' % opt[:default].to_s unless opt[:default].nil?
+                n.push ' &mdash; (%s)' % data.join(', ') if data.length > 0
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def list_errors
+      tag.div do |n|
+        n.push name_link :api_errors
+        n.push icon ICONS[:error][:image], style: 'position: absolute; margin-left: -40px; margin-top: 1px; fill: #777;'
+        n.h4 { 'Named errors' }
+
+        n._box do |n|
+          if RESCUE_FROM.keys.length == 0
+            n.p 'No named errors defiend via'
+            n.code "rescue from :name, 'Error description'"
+          end
+
+          n._row({ style: 'margin-bottom: 30px;' }) do |n|
+            for key, desc in RESCUE_FROM
+              next if key == :all
+              next unless key.is_a?(Symbol) && desc.is_a?(String)
+
+              n._col_4 { "<code>#{key}</code>" }
+              n._col_8 { desc }
+            end
+          end
+        end
+      end
+    end
+
+    def modal_dialog
+      %[
+        <script>#{misc_file('doc.js')}</script>
+        <div id="modal" class="modal" tabindex="-1" role="dialog">
+          <div style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; background: rgba(99,99,99,0.3)"></div>
+          <div class="modal-dialog modal-lg" role="document">
+            <div class="modal-content">
+              <div class="modal-header">
+                <h5 class="modal-title"></h5>
+                <button type="button" class="close" data-dismiss="modal" aria-label="Close" onclick="Modal.close()">
+                  <span aria-hidden="true">&times;</span>
+                </button>
+              </div>
+              <div class="modal-body">
+              </div>
+            </div>
+          </div>
+        </div>
+      ]
+    end
+  end
+end

data/lib/doc/special.rb

@@ -0,0 +1,20 @@
+# reponse from /api/_/foo
+
+class Joshua
+  module DocSpecial
+    extend self
+
+    def postman
+      raw
+    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]) }
+        end
+      end
+    end
+  end
+end

data/lib/joshua.rb

@@ -0,0 +1,39 @@
+unless ''.respond_to?(:dasherize)
+  require 'dry/inflector'
+
+  class String
+    %w(
+      classify
+      constantize
+      dasherize
+      ordinalize
+      pluralize
+      singularize
+      tableize
+      underscore
+    ).each do |name|
+      define_method name do
+        Dry::Inflector.new.send(name, self)
+      end
+    end
+  end
+end
+
+require 'json'
+require 'html-tag'
+require 'clean-hash'
+
+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/response'
+
+require_relative './doc/doc'
+require_relative './doc/special'
+
+
+

data/lib/joshua/base.rb

@@ -0,0 +1,312 @@
+class Joshua
+  INSTANCE ||= Struct.new 'JoshuaOpts',
+    :action,
+    :bearer,
+    :development,
+    :id,
+    :method_opts,
+    :opts,
+    :params,
+    :raw,
+    :rack_response,
+    :request,
+    :response,
+    :uid
+
+  attr_reader :api
+
+  class << self
+    # 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, PARAMS.fetch_and_clear_opts
+
+      alias_method "_api_#{@method_type}_#{name}", name
+      remove_method name
+    end
+
+    # 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, mount_on: '/', development: ENV['RACK_ENV'] == 'development'
+
+        if data.is_a?(Hash)
+          [
+            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 request:, response: nil, mount_on: nil, bearer: nil, development: false
+      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[:request]     = request
+        opts[:response]    = response
+        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('/')
+
+          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
+
+    def render action, opts={}
+      return error 'Action not defined' unless action[0]
+
+      api_class =
+      if klass = opts.delete(:class)
+        # /api/_/foo
+        if klass == '_'
+          if Joshua::DocSpecial.respond_to?(action.first)
+            return Joshua::DocSpecial.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
+    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
+  end
+
+  ###
+
+  def initialize action, id: nil, bearer: nil, params: {}, opts: {}, request: nil, response: nil, development: false
+    @api = INSTANCE.new
+
+    if action.is_a?(Array)
+      # unpack id and action is action is given in path form # [123, :show]
+      @api.id, @api.action = action[1] ? action : [nil, action[0]]
+    else
+      @api.action = action
+    end
+
+    @api.bearer   = bearer
+    @api.id          ||= id
+    @api.action        = @api.action.to_sym
+    @api.request       = request
+    @api.method_opts   = self.class.opts.dig(@api.id ? :member : :collection, @api.action) || {}
+    @api.development   = !!development
+    @api.rack_response = response
+    @api.params        = ::CleanHash::Indifferent.new params
+    @api.opts          = ::CleanHash::Indifferent.new opts
+    @api.response      = ::Joshua::Response.new @api
+  end
+
+  def message data
+    response.message data
+  end
+
+  def execute_call
+    if !@api.development && @api.request && @api.request_method == 'GET' && !@api.method_opts[:gettable]
+      response.error 'GET request is not allowed'
+    else
+      parse_api_params
+      parse_annotations unless response.error?
+      resolve_api_body unless response.error?
+    end
+
+    @api.raw || response.render
+  end
+
+  def resolve_api_body &block
+    begin
+      # execute before "in the wild"
+      # model @api.pbject should be set here
+      execute_callback :before_all
+
+      instance_exec &block if block
+
+      # if we have model defiend, we execute member otherwise collection
+      type   = @api.id ? :member : :collection
+
+      execute_callback 'before_%s' % type
+      api_method = '_api_%s_%s' % [type, @api.action]
+      raise Joshua::Error, "Api method #{type}:#{@api.action} not found" unless respond_to?(api_method)
+      data = send api_method
+      response.data data unless response.data?
+
+      # after blocks
+      execute_callback 'after_%s' % type
+    rescue Joshua::Error => error
+      # controlled error raised via error "message", ignore
+      response.error error.message
+    rescue => error
+      Joshua.error_print error
+
+      block = RESCUE_FROM[error.class] || RESCUE_FROM[:all]
+
+      if block
+        instance_exec error, &block
+      else
+        # uncontrolled error, should be logged
+        # search to response[:code] 500 in after block
+        response.error error.message
+        response.error :class, error.class.to_s
+        response.error :code, 500
+      end
+    end
+
+    # we execute generic after block in case of error or no
+    execute_callback :after_all
+  end
+
+  def to_json
+    execute_call.to_json
+  end
+
+  def to_h
+    execute_call
+  end
+
+  private
+
+  def parse_api_params
+    return unless @api.method_opts[:params]
+
+    parse = Joshua::Params::Parse.new
+
+    for name, opts in @api.method_opts[:params]
+      # enforce required
+      if opts[:required] && @api.params[name].to_s == ''
+        response.error_detail name, 'Argument missing'
+        next
+      end
+
+      begin
+        # check and coerce value
+        @api.params[name] = parse.check opts[:type], @api.params[name], opts
+      rescue Joshua::Error => error
+        # add to details if error found
+        response.error_detail name, error.message
+      end
+    end
+  end
+
+  def parse_annotations
+    for key, opts in (@api.method_opts[:annotations] || {})
+      instance_exec *opts, &ANNOTATIONS[key]
+    end
+  end
+
+  def execute_callback name
+    self.class.ancestors.reverse.map(&:to_s).each do |klass|
+      if before_list = (OPTS.dig(klass, name.to_sym) || [])
+        for before in before_list
+          instance_exec &before
+        end
+      end
+    end
+  end
+
+  def response content_type=nil
+    if block_given?
+      @api.raw = yield
+
+      if @api.rack_response
+        @api.rack_response.header['Content-Type'] = content_type || (@api.raw[0] == '{' ? 'application/json' : 'text/plain')
+      end
+    else
+      @api.response
+    end
+  end
+
+  def params
+    @api.params
+  end
+
+end