joshua 0.2.4 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 890a0ef798280cde7effdabc9a385aa7adc07b52579bea110af04ab714c98e46
-  data.tar.gz: 749d50df471c4ee8d2badfe598b174a3eb3bf4190f88b70cc13da320b5a2386b
+  metadata.gz: 9b4b55be6527e985a667ab6ae564cca2ecef5ded3e48dfa951eeee31a1c13b9f
+  data.tar.gz: b5c1dab428666a5d34f2a12ef31a01e934e9e229f11754fffab2d2d74cf26119
 SHA512:
-  metadata.gz: 4fb42a8f389bea6fe2be92224ede26f06f3b8328d22c06c2c744a2cac4345ca819fc0c9d1a64af92d899de3f4a94b2d3e0cc96a031fcbec91a877dc808a519c5
-  data.tar.gz: aef74afb03695d3be2b5d7bfa15b94b0c5497080c314c135f7c075b07c4a019d03bd88edaa42b5650861758990e001d1dd0aaf94db88131bdeb37485977115d8
+  metadata.gz: 024c5b93c567fc38985b02a77b4f666e4012c833ee396e7484fe9ad47b66c4a80ef2a988fcc4abb8186c72d5df3363d4c436083d023f75c272e6ef29711381b7
+  data.tar.gz: 6b131eb846f72f571def2ddb2bd566f81581809333f086d8adae7884f6fa505cffe6c49b6ab474fa370dc2e619517fad0de2487f1d8ef063953c330caa3eb283

data/.version

@@ -1 +1 @@
-0.2.4
+0.2.7

data/lib/doc/doc.rb

@@ -2,7 +2,9 @@ class Joshua
   module Doc
     extend self
 
-    ICONS = {
+    HtmlTag 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>',
@@ -21,10 +23,6 @@ class Joshua
       }
     }
 
-    def tag
-      HtmlTagBuilder
-    end
-
     def misc_file name
       File.read [__dir__, '../misc/%s' % name].join('/')
     end
@@ -34,15 +32,15 @@ class Joshua
       mount_on ||= request.url.split('?').first+'/'
       mount_on.sub! %r{//$}, '/'
 
-      tag.html do |n|
-        n.head  do |n|
+      HtmlTag.html do |n|
+        n.tag(: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://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
-        n.body do |n|
+        n.tag(: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|
@@ -52,7 +50,7 @@ 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.img src:"https://camo.githubusercontent.com/4b5b5447d6af920f58a030740bc8e9cf52dc490a8a560492c6ad3a5c6a0ad076/68747470733a2f2f692e696d6775722e636f6d2f48576f557a356b2e706e67", style: 'width: 40px; z-index: 1; position: absolute; top: 10px; left: 50%;', onclick: "window.open('https://github.com/dux/joshua')"
 
           n.push modal_dialog
 
@@ -77,8 +75,8 @@ 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/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="https://github.com/dux/joshua/tree/master/client/ruby" target="capi_ruby">Ruby</a>]
+                    n.push %[<a class="badge badge-light" href="https://github.com/dux/joshua/tree/master/client/javascript" 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
@@ -114,17 +112,17 @@ class Joshua
 
     # top side navigation icons
     def top_icons
-      tag.div({ style: 'float: right; margin-top: 18px;' }) do |n|
+      tag.div style: 'float: right; margin-top: 18px;' do
         for icon in ICONS.values
           next unless icon[:url]
-          n.push %[<a target="_new" href="#{icon[:url]}">#{icon icon[:image]}</a>]
+          a icon(icon[:image]), target: '_new', href: icon[:url]
         end
       end
     end
 
     # left side navigation
     def left_nav
-      tag.div do |n|
+      HtmlTag.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)
@@ -139,7 +137,7 @@ class Joshua
 
     # render doc for all documented classes
     def index
-      tag.div do |n|
+      HtmlTag.div do |n|
         for @klass in Joshua.documented
           @opts = @klass.opts
           icon = @opts.dig(:opts, :icon)
@@ -172,7 +170,7 @@ class Joshua
     def render_type name
       base = @opts[name] || return
 
-      tag.div do |n|
+      HtmlTag.div do |n|
         n.br
         n.h5 '<gray>%s methods</gray>' % name
 
@@ -186,23 +184,16 @@ class Joshua
 
     # render api method
     def render_method name:, m_name:, opts:
-      tag._box do |n|
+      HtmlTag._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.h5 style: 'margin-bottom: 20px;' 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]
@@ -224,11 +215,18 @@ class Joshua
             end
           end
         end
+
+        n.p style: 'margin: 30px 0 10px 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
       end
     end
 
     def list_errors
-      tag.div do |n|
+      HtmlTag.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' }
@@ -273,4 +271,4 @@ class Joshua
       ]
     end
   end
-end
+end

data/lib/doc/{special.rb → postman_schema.rb}

@@ -1,7 +1,7 @@
 # reponse from /api/_/foo
 
 class Joshua
-  class DocSpecial
+  class PostmanSchema
     def initialize api
       @api = api
     end
@@ -17,10 +17,9 @@ class Joshua
         item: []
       }
 
-      for table, data in raw
-        raw_data = raw[table.to_s]
+      for api_name, raw_data in raw
         hash = {}
-        hash[:name] = table
+        hash[:name] = api_name
         hash[:item] = []
 
         for type in [:collection, :member]
@@ -30,14 +29,17 @@ class Joshua
             items = []
 
             for key, value in raw_data[type]
-              items.push postman_add_method(type, table, key, value)
+              items.push postman_add_method(
+                type: type,
+                object_name: api_name,
+                name: key,
+                item: value
+              )
             end
 
             hash[:item].push *items
-            # hash[:item].push({
-            #   name: type,
-            #   item: items
-            # })
+            # to have it grouped by collection or member methods
+            # hash[:item].push(name: type, item: items)
           end
         end
 
@@ -69,7 +71,7 @@ class Joshua
 
     private
 
-    def postman_add_method type, table, name, item
+    def postman_add_method type:, object_name:, name:, item:
       path = []
 
       base = request.url.split('/_/').first
@@ -78,24 +80,24 @@ class Joshua
       path.push base.pop
       base = base.join('/')
 
-      path.push table
+      path.push object_name
       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
-          },
+      out = {}
+      out[:name] = name
+      out[:description] = item[:desc] if item[:desc]
+      out[:request] = {
+        method: item[:allow] || 'POST',
+        header: [],
+        url: {
+          raw:      ([base] + path).join('/'),
+          protocol: base.split(':').first,
+          host:     request.host.split('.'),
+          port:     request.port,
+          path:     path
         }
       }
 
@@ -106,9 +108,8 @@ class Joshua
 
         # 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 }
+        formdata_value = if respond_to?(formdata_custom)
+          opts = { key: key, value: value, name: name, type: type, group: object_name }
           [send(formdata_custom, opts.to_hwia)].flatten
         else
           { key: key, description: value[:type] }

data/lib/joshua/base_class.rb

@@ -4,7 +4,9 @@ class Joshua
 
   class << self
     # perform auto_mount from a rake call
-    def call env
+    def call env = nil
+      return render unless env
+
       request = Rack::Request.new env
 
       if request.path == '/favicon.ico'
@@ -102,18 +104,19 @@ class Joshua
     end
 
     # renders api doc or calls api class + action
-    def render action=nil, opts={}
+    def render action = nil, opts = {}
       if action
-        return error 'Action not defined' unless action[0]
+        unless action[0]
+          return error 'Action not defined'
+        end
       else
         return RenderProxy.new self
       end
 
-      api_class =
-      if klass = opts.delete(:class)
+      api_class = if klass = opts.delete(:class)
         # /api/_/foo
         if klass == '_'
-          klass = Joshua::DocSpecial.new(opts)
+          klass = Joshua::PostmanSchema.new(opts)
 
           if klass.respond_to?(action.first)
             return klass.send action.first.to_sym
@@ -124,9 +127,10 @@ class Joshua
 
         klass = klass.split('/') if klass.is_a?(String)
         klass[klass.length-1] += '_api'
+        klass = klass.join('/').classify
 
         begin
-          klass.join('/').classify.constantize
+          klass.constantize
         rescue NameError => e
           return error 'API class "%s" not found' % klass
         end
@@ -141,6 +145,11 @@ class Joshua
       Response.auto_format error
     end
 
+    def render_data action, opts = {}
+      response = render action, params: opts
+      response && (response[:data] || [])
+    end
+
     # rescue_from CustomError do ...
     # for unhandled
     # rescue_from :all do
@@ -175,7 +184,7 @@ class Joshua
 
     def error_print error
       puts
-      puts 'Joshua error dump'.red
+      puts 'Joshua error dump'
       puts '---'
       puts '%s: %s' % [error.class, error.message]
       puts '---'
@@ -192,9 +201,9 @@ class Joshua
     # if you want to make API DOC public use "documented"
     def documented
       if self == Joshua
-        DOCUMENTED.map(&:to_s).sort.map(&:constantize)
+        DOCUMENTED.sort.uniq.map(&:constantize)
       else
-        DOCUMENTED.push self unless DOCUMENTED.include?(self)
+        DOCUMENTED.push to_s unless DOCUMENTED.include?(to_s)
       end
     end
 
@@ -295,21 +304,37 @@ class Joshua
       end
     end
 
+    # allow alternative method access
+    # allow :get
+    # if defined, access will be allowed via POST + allowed method
     def allow type
       if @method_type
-        @@opts[:allow] = type
+        type = type.to_s.to_sym
+
+        unless %i(get head post put patch delete trace).include?(type)
+          raise ArgumentError.new('"%s" is not allowed http method type' % type)
+        end
+
+        @@opts[:allow] = type.to_s.upcase
       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')
+    # define response content type (defaults to JSON)
+    def content_type name
+      if name.is_class == Symbol
+        name = case name
+        when :json
+          'application/json'
+        when :text
+          'text/plain'
+        else
+          raise ArgumentError.new('content-type "%s" is not recognized')
+        end
       end
+
+      @@opts[:content_type] = name
     end
 
     # allow methods without @api.bearer token set
@@ -390,6 +415,16 @@ class Joshua
       remove_method name
     end
 
+    def make_hash_html_safe hash
+      (hash || {}).each do |k, v|
+        if v.is_a?(Hash)
+          make_hash_html_safe v
+        elsif v.class == String
+          hash[k] = v.gsub('<', '#LT;')
+        end
+      end
+    end
+
     private
 
     def only_in_api_methods!

data/lib/joshua/base_instance.rb

@@ -24,7 +24,7 @@ class Joshua
 
   attr_reader :api
 
-  def initialize action, params: {}, opts: {}, development: false, id: nil, bearer: nil, api_host: nil
+  def initialize action, params: {}, opts: {}, development: false, id: nil, bearer: nil, api_host: nil, html_safe: true
     @api = INSTANCE.new
 
     if action.is_a?(Array)
@@ -34,6 +34,10 @@ class Joshua
       @api.action = action
     end
 
+    if html_safe
+      params = Joshua.make_hash_html_safe params
+    end
+
     @api.bearer        = bearer
     @api.id          ||= id
     @api.action        = @api.action.to_sym
@@ -47,9 +51,11 @@ class Joshua
   end
 
   def execute_call
-    if !@api.development && @api.request && @api.request.request_method == 'GET' && !@api.method_opts[:gettable]
-      response.error 'GET request is not allowed'
-    else
+    allow_type   = @api.method_opts[:allow] || 'POST'
+    request_type = @api.request&.request_method || 'POST'
+    is_allowed   = @api.development || ['POST', allow_type].include?(request_type)
+
+    if is_allowed
       begin
         parse_api_params
         parse_annotations unless response.error?
@@ -72,6 +78,8 @@ class Joshua
 
       # we execute generic after block in case of error or no
       execute_callback :after_all
+    else
+      response.error '%s request is not allowed' % request_type
     end
 
     @api.raw || response.render
@@ -100,18 +108,21 @@ class Joshua
   end
 
   def resolve_api_body &block
+    # if we have model defiend, we execute member otherwise collection
+    type = @api.id ? :member : :collection
+    api_method = '_api_%s_%s' % [type, @api.action]
+
+    unless respond_to?(api_method)
+      raise Joshua::Error, "Api method #{type}:#{@api.action} not found"
+    end
+
     # 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?
@@ -156,7 +167,9 @@ class Joshua
 
   # inline error raise
   def error text, args={}
-    puts 'JOSHUA API Error: %s (%s)' % [text, caller[0]] if @api.development
+    if @api.development
+      puts 'JOSHUA API Error: %s (%s)' % [text, caller[0]]
+    end
 
     if err = RESCUE_FROM[text]
       if err.is_a?(Proc)
@@ -166,6 +179,7 @@ class Joshua
         response.error err, args
       end
     else
+      rr text
       response.error text, args
     end
 

data/lib/joshua/response.rb

@@ -39,6 +39,8 @@ class Joshua
       else
         @message ||= value
       end
+
+      nil
     end
 
     # api meta response, any data is allowed
@@ -51,7 +53,7 @@ class Joshua
     end
 
     # add api response error
-    def error text, args={}
+    def error messages, args={}
       code   = args.delete(:code)
       status = args.delete(:status)
 
@@ -59,11 +61,18 @@ class Joshua
 
       @status ||= status if status
 
-      text = text.to_s
-
       @errors[:code]     ||= code if code
       @errors[:messages] ||= []
-      @errors[:messages].push text unless @errors[:messages].include?(text)
+
+      unless messages.class == Array
+        messages = [messages.to_s]
+      end
+
+      for text in messages
+        if text.present? && text[0, 2] != '["' && !@errors[:messages].include?(text)
+          @errors[:messages].push text
+        end
+      end
     end
 
     def error?

data/lib/joshua.rb

@@ -1,22 +1,6 @@
-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
+unless ''.respond_to?(:classify)
+  require 'sequel'
+  Sequel.extension :inflector
 end
 
 require 'json'
@@ -30,7 +14,7 @@ require_relative './joshua/response'
 require_relative './joshua/render_proxy'
 
 require_relative './doc/doc'
-require_relative './doc/special'
+require_relative './doc/postman_schema'
 
 
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: joshua
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.7
 platform: ruby
 authors:
 - Dino Reic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dry-inflector
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Ruby language based, framework agnostic API request/response lib
 email: rejotl@gmail.com
 executables: []
@@ -115,9 +87,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - "./.version"
-- "./lib/.DS_Store"
 - "./lib/doc/doc.rb"
-- "./lib/doc/special.rb"
+- "./lib/doc/postman_schema.rb"
 - "./lib/joshua.rb"
 - "./lib/joshua/base_class.rb"
 - "./lib/joshua/base_instance.rb"
@@ -146,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Joshua