joshua 0.1.0

data/lib/joshua/params/types_errors.rb

@@ -0,0 +1,33 @@
+class Joshua
+  module Params
+    class Parse
+      ERRORS = {
+        en:{
+          bad_format:    'Bad value format',
+          not_integer:   'Not an integer',
+          min_value:     'Minimal allowed value is: %s',
+          max_value:     'Maximal allowed value is: %s',
+          email_min:     'Email requireds min of 8 characters',
+          email_missing: 'Email is missing @',
+          url_start:     'URL is not starting with http or https',
+          point_format:  'Point should be in format 1.2345678,1.2345678',
+          min_date:      'Minimal allow date is %s',
+          max_date:      'Maximal allow date is %s'
+        },
+
+        hr: {
+          bad_format:    'Format vrijednosti ne zadovoljava',
+          not_integer:   'Nije cijeli broj',
+          min_value:     'Minimalna dozvoljena vrijednost je: %s',
+          max_value:     'Maksimalna dozvoljena vrijednost je: %s',
+          email_min:     'Email zatjeva minimalno 8 znakova',
+          email_missing: 'U email-u nedostaje @',
+          url_start:     'URL ne započinje sa http ili https',
+          point_format:  'Geo točka bi trebala biti u formatu 1.2345678,1.2345678',
+          min_date:      'Minimalni dozvoljeni datum je %s',
+          max_date:      'Maksimalni dozvoljeni datum je %s'
+        }
+      }
+    end
+  end
+end

data/lib/joshua/response.rb

@@ -0,0 +1,86 @@
+# Api response is constructed from this object
+
+class Joshua
+  class Response
+    def initialize api
+      @api         = api
+      @out         = {}
+      @meta        = {}
+      @errors      = {}
+    end
+
+    def []= key, value
+      meta key, value
+    end
+
+    # forward header to rack_response.header
+    def header *args
+      if args.first
+        @api.rack_response.header[args.first] = args[1] if @api.rack_response
+      else
+        @api.rack_response.header
+      end
+    end
+
+    # human readable response message
+    def message value
+      @message = value
+    end
+
+    # api meta response, any data is allowed
+    def meta key, value = nil
+      if value
+        @meta[key] = value
+      else
+        @meta[key]
+      end
+    end
+
+    # add api response error
+    def error *args
+      return @errors unless args[0]
+
+      desc, code = args.reverse
+
+      @errors[:code]       = code if code
+      @errors[:messages] ||= []
+      @errors[:messages].push desc unless @errors[:messages].include?(desc)
+    end
+
+    def error?
+      !!(@errors[:messages] || @errors[:details])
+    end
+
+    def error_detail name, desc
+      error '%s (%s)' % [desc, name]
+
+      @errors[:details]     ||= {}
+      @errors[:details][name] = desc
+    end
+
+    def data value
+      @data ||= value
+    end
+
+    def data?
+      !@data.nil?
+    end
+
+    # render full api response
+    def render
+      {}.tap do |out|
+        if @errors.keys.empty?
+          out[:success] = true
+        else
+          out[:success] = false
+          out[:error] = @errors
+        end
+
+        out[:meta]    = @meta
+        out[:message] = @message if @message
+        out[:data]    = @data unless @data.nil?
+        out[:status]  = error? ? 400 : 200
+      end
+    end
+  end
+end

data/lib/misc/api_example.coffee

@@ -0,0 +1,75 @@
+# Coffee code example for chainable CleaApi access that is easy to read
+# fell free to compile to JS here https://coffeescript.org/#try
+#
+# just execute action and trigger Info.api() buy default
+# Api(path, opts)
+#
+# silent execute
+# Api(path, opts).silent()
+#
+# trigger info and custom function on success
+# Api(path, opts).done(function() { ... }) - info + done
+#
+# silent and redirect on sucess
+# Api(path, opts).silent().redirect(path) - info and redirect on success
+#
+# silent on success, custom error func
+# Api(path, opts).silent().error(error_func)
+#
+# real life example: update product, on success to not show info, just redirect to product page
+# Api('product/123/update', {name: 'Foo', description: 'Bar', value: 5}).silent().follow()
+
+window.Api = (path, opts={}) ->
+  if typeof(path) != 'string'
+    form = $ path
+    path = form.attr 'action'
+    opts = form.serializeHash()
+
+  path    = "/api/#{path}" unless path.indexOf('/api/') == 0
+  request = new RequestBase()
+
+  $.ajax
+    type: 'POST'
+    url:  path,
+    data: opts,
+    complete: request.complete
+
+  request
+
+class RequestBase
+  refresh:  (node) => @do_refresh  = node || true; @
+  reload:   =>        @do_reload   = true;   @
+  follow:   (func) => @do_follow   = true;   @
+  error:    (func) => @error_func  = func;   @
+  done:     (func) => @done_func   = func;   @
+  redirect: (path) => @do_redirect = path;   @
+  silent:   (info) => @is_silent   = [info]; @
+  complete: (data, http_status) =>
+    response = JSON.parse(data.responseText)
+
+    if response.error
+      if request.error_func
+        request.error_func(response.error)
+      else
+        Info.api(response)
+
+    if http_status == 'success'
+      Info.api(response)      unless @is_silent
+      @done_func(response)    if @done_func
+      Pjax.load(@do_redirect) if @do_redirect
+      Pjax.reload()           if @do_reload
+
+      if node = @do_refresh
+        if typeof(node) == 'object'
+          Svelte('ajax', node).reload()
+        else
+          Pjax.refresh()
+
+      if @do_follow
+        location = data.getResponseHeader('location') || response.meta.path
+
+        if location
+          Pjax.load(location)
+        else
+          Info.error 'Follow URL not found'
+

data/lib/misc/doc.css

@@ -0,0 +1,29 @@
+* { font-family: 'Inter', sans-serif; }
+.gutter { margin-left: 20px; }
+.sticky  { position: -webkit-sticky; position: sticky; top: 0; }
+.btn-outline-info svg { fill: #17a2b8; }
+.btn-outline-info:hover svg { fill: #eee; }
+button.request { float: right; display: none; }
+.box { border-top: 1px solid #ccc; padding: 20px 20px 10px 20px; border-top-color: #ccc; background-color: #fff; margin-bottom: 20px; }
+.box:hover button.request { display: inline; }
+.anchor  { display: block; position: relative; top: -95px; visibility: hidden; }
+.btn { background-color: #fff; }
+body     { background-color: #f7f7f7; margin-bottom: 200px; }
+header   { background-color: #fff; box-shadow:0 1px 4px rgba(0,0,0,.15); }
+pre      { padding-bottom: 10px; font-family: inherit;}
+h1.nav a { font-size: 22px; color: #383838; padding: 17px 0 18px 0; }
+h5       { font-size: 18px; font-weight: 600; }
+h5 a     { color: #333 !important; }
+h6       { color: #888; margin-bottom: 10px; -font-size: 13px; }
+gray     { color: #707070;  }
+b        { color: #666975; }
+svg      { margin: 0 5px; }
+bold     { font-weight: 600; }
+ul       { margin-left: -10px; margin-top: -5px;}
+form label { font-weight: bold; display: block; }
+code     { background: '#f8f8f8'; color: #e01e5a; border: 1px solid rgb(221, 221, 221); padding: 2px 7px; border-radius: 4px; font-size: 14px; font-family: Monospace; }
+
+pre.code { font-family: monospace; font-size: 13px; background:#f7f7f7; padding: 10px 10px; margin-top: 15px; }
+
+#modal table td { padding-bottom: 15px; vertical-align: top; }
+#modal table td:first-child { padding: 10px 30px 0 0; }

data/lib/misc/doc.js

@@ -0,0 +1,279 @@
+// global state
+window.State = {
+  active_tab: 'response',
+  request:    {},
+  full_url:   '',
+
+  set_request: (full_url) => {
+    State.full_url = full_url
+
+    parts    = full_url.split('?')
+    parts[1] = parts[1] || ''
+
+    State.request = {
+      host:   api_opts.mount_on,
+      path:   parts[0].replace(api_opts.mount_on, ''),
+      params: parts[1],
+      object: {}
+    }
+
+    for (el of parts[1].split('&')) {
+      let [key, value] = el.split('=', 2)
+      State.request.object[key] = value
+    }
+
+    return State.request
+  },
+}
+
+// generic modal interface
+window.Modal = {
+  render: (title, data) => {
+    $('#modal .modal-title').html(title)
+    $('#modal .modal-body').html(data)
+    $('#modal').show()
+  },
+  close: () => {
+    $('#modal').hide()
+  }
+}
+
+// form in modal box
+window.ModalForm = {
+  render: (title, params) => {
+    let data = []
+
+    data.push(`<form onsubmit="TabResponse.render('${title}', this); return false;">`)
+    data.push(`  <table>`)
+
+      if (title.includes('/:id/')) {
+        data.push(`    <tr><td><label>ID</label></td><td><input id="api_id_value" type="text" class="form-control" value="" autocomplete="off"  /></td></tr>`)
+      }
+
+    for (let [name, vals] of Object.entries(params)) {
+      data.push(`  <tr>`)
+      data.push(`    <td><label>${name}</label></td><td>`)
+
+      if (vals.type == 'boolean') {
+        data.push(`    <input type="checkbox" class="form-control" name="${name}" />`)
+      } else {
+        data.push(`    <input type="text" class="form-control" name="${name}" value="" autocomplete="off" />`)
+      }
+
+      if (vals.default) {
+        data.push(`<small class="form-text text-muted">default: ${vals.default}</small>`)
+      }
+
+      data.push(`    </td></tr>`)
+    }
+
+    data.push(`  <tr><td></td><td><button class="btn btn-outline-primary">Execute API request</button></td></tr>`)
+    data.push(`  </table>`)
+    data.push(`</form>`)
+
+    data = `${data.join("\n")}<div id="api_result"></div>`
+
+    Modal.render(title, data);
+  }
+}
+
+// backend api call
+window.TabResponse = {
+  render: (url, form) => {
+    let post   = $(form).serialize()
+    let id_val = $('#api_id_value').val()
+
+    if (id_val) {
+      url = url.replace('/:id/', () => '/'+id_val+'/' )
+    }
+
+    full_url = url
+    if (post) full_url += `?${post}`
+
+    if (url.includes('/:id/')) {
+      alert('ID is not defined')
+      return
+    }
+
+    State.set_request(full_url)
+
+    TabResponse.render_tab_data()
+
+    let bearer = AuthButton.get()
+    if (bearer) {
+      post += post ? '&' : ''
+      post += 'api_token=' + bearer
+    }
+
+    $.post(url, post, (data) => {
+      State.response = data;
+      TabResponse.render_tab_data()
+    })
+  },
+
+  setActiveTab: (node, name) => {
+    let el = $(node)
+    // debugger
+    el.parents('ul').find('a').removeClass('active')
+    el.addClass('active')
+
+    State.active_tab = name
+    TabResponse.render_tab_data()
+  },
+
+  render_tab_data: () => {
+    let tabs   = ['response', 'curl', 'javascript', 'ruby']
+
+    let out = []
+    out.push(`<div id="api_response"><br /><button class="btn btn-sm btn-outline-info" style="float: right; margin-top: -4px; margin-bottom: -30px;" onclick="$('#api_response').remove()">close</button>`)
+
+    out.push(`<ul class="nav nav-tabs" style="margin-left:0; margin-bottom: 15px;">`)
+
+    for (name of tabs) {
+      let is_active = State.active_tab == name ? ' active' : ''
+      out.push(`<li class="nav-item"><a class="nav-link ${is_active}" href="#" onclick="TabResponse.setActiveTab(this, '${name}'); return false;">${name}</a></li>`)
+    }
+
+    out.push(`</ul>`)
+
+    out.push(TabResponse.format[State.active_tab]())
+    $('#api_result').html(out.join("\n\n"))
+  },
+
+  format: {
+    response: () => {
+      let data = JSON.stringify(State.response || {}, null, 2)
+      let url  = `<a href="${State.full_url}">${State.full_url}</a>`
+
+      return `<p>${url}</p><pre class="code">${data}</pre></div>`
+    },
+
+    curl: () => {
+      out = []
+
+      out.push(`# PS: you can send post data as JSON as well`)
+      out.push(`# JSON export is a default, "Accept: application/json" header is not needed`)
+      out.push(``)
+
+      out.push(`curl -s -X POST\\`)
+
+      let token = AuthButton.get()
+      if (token) {
+        out.push(`  -H "Authorization: Bearer ${token}"\\`)
+      }
+
+      url = State.request
+
+      if (url.params) out.push(`  --data '${url.params}'\\`)
+
+      out.push(`  ${url.host}${url.path}`)
+
+      let parts = url.path.split('/')
+
+      let opts = {
+        id:     'foo-rand',
+        class:  parts.shift(),
+        action: parts,
+        params: State.request.object,
+        token:  token
+      }
+
+      out.push(``)
+      out.push(`# or json rpc style`)
+      out.push(`curl -s -X POST\\`)
+      out.push(`  --data '${JSON.stringify(opts)}'\\`)
+      out.push(`  ${url.host.replace(/\/$/, '')}`)
+
+      return `<pre class="code">${out.join("\n")}</pre></div>`
+    },
+
+    ruby: () => {
+      out = []
+
+      let params = JSON.stringify(State.request.object)
+      let parts  = State.request.path.split('/')
+
+      out.push `# gem install 'joshua'`
+      out.push `require 'joshua/remote'\n`
+
+      out.push(`api = JoshuaRemote.new '${State.request.host.replace(/\/$/, '')}'`)
+
+      let token = AuthButton.get()
+      if (token) {
+        out.push(`api.auth_token = '${token}'`)
+      }
+
+      if (parts[2]) {
+        out.push(`api.${parts[0]}(${parts[1]}).${parts[2]}(${params})`)
+        out.push(`# or -> api.call('${parts[0]}/${parts[1]}/${parts[2]}', ${params})`)
+        out.push(`# or -> api.call(:${parts[0]}, ${parts[1]}, :${parts[2]}, ${params})`)
+      } else {
+        out.push(`api.${parts[0]}.${parts[1]}(${params})`)
+        out.push(`# or -> api.call('${parts[0]}/${parts[1]}', ${params})`)
+        out.push(`# or -> api.call(:${parts[0]}, :${parts[1]}, ${params})`)
+      }
+
+      out.push(`api.success?`)
+      out.push(`api.response`)
+      return `<pre class="code">${out.join("\n")}</pre></div>`
+    },
+
+    javascript: () => {
+      out = []
+      out.push(`const axios = require('axios').default;`)
+      out.push(``)
+      out.push(`axios.post(`)
+      out.push(`  '${State.full_url.split('?')[0]}',`)
+      out.push(`  ${JSON.stringify(State.request.object)},`)
+
+      let token = AuthButton.get()
+      if (token) {
+        out.push(`  { headers: { Authorization: 'Bearer ${token}' } }`)
+      }
+
+      out.push(`).then((response) => { });`)
+      return `<pre class="code">${out.join("\n")}</pre></div>`
+    }
+  }
+}
+
+// auth botton
+window.AuthButton = {
+  set: () => {
+    if (api_opts.bearer) {
+      Modal.render('Bearer token', api_opts.bearer)
+    } else {
+      let token = prompt('Bearer token?', AuthButton.get() || '')
+
+      if (token != null) {
+        localStorage.setItem('auth_token', token)
+      }
+   }
+
+    AuthButton.draw()
+  },
+
+  get: () => {
+    return api_opts.bearer || localStorage.getItem('auth_token')
+  },
+
+  draw: () => {
+    let value = AuthButton.get()
+    let text  = value ? `Yes` : 'n/a'
+
+    $('#bearer_button').html(`Bearer Auth: <bold>${text}</bold>`)
+  }
+}
+
+AuthButton.draw()
+
+
+// close dialog on escape
+document.onkeydown = (evt) => {
+  evt = evt || window.event;
+  if (evt.keyCode == 27) {
+    Modal.close();
+  }
+};
+
+