joshua 0.2.2 → 0.2.4

data/lib/joshua/base_instance.rb

@@ -0,0 +1,195 @@
+class Joshua
+  class Error < StandardError
+  end
+
+  ANNOTATIONS   ||= {}
+  RESCUE_FROM   ||= {}
+  OPTS          ||= { api: {} }
+  PLUGINS       ||= {}
+  MODELS        ||= {}
+  DOCUMENTED    ||= []
+  INSTANCE      ||= Struct.new 'JoshuaOpts',
+    :action,
+    :bearer,
+    :development,
+    :id,
+    :method_opts,
+    :opts,
+    :params,
+    :raw,
+    :api_host,
+    :request,
+    :response,
+    :uid
+
+  attr_reader :api
+
+  def initialize action, params: {}, opts: {}, development: false, id: nil, bearer: nil, api_host: nil
+    @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       = api_host ? api_host.request : nil
+    @api.method_opts   = self.class.opts.dig(@api.id ? :member : :collection, @api.action) || {}
+    @api.development   = !!development
+    @api.params        = HashWia.new params
+    @api.opts          = HashWia.new opts
+    @api.api_host      = api_host
+    @api.response      = ::Joshua::Response.new @api
+  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
+      begin
+        parse_api_params
+        parse_annotations unless response.error?
+        resolve_api_body  unless response.error?
+      rescue Joshua::Error => error
+        # controlled error raised via error "message", ignore
+        response.error error.message
+      rescue => error
+        # uncontrolled error, should be logged
+        Joshua.error_print error if @api.development
+
+        block = RESCUE_FROM[error.class] || RESCUE_FROM[:all]
+
+        if block
+          instance_exec error, &block
+        else
+          response.error error.message, status: 500
+        end
+      end
+
+      # we execute generic after block in case of error or no
+      execute_callback :after_all
+    end
+
+    @api.raw || response.render
+  end
+
+  def to_json
+    execute_call.to_json
+  end
+
+  def to_h
+    execute_call
+  end
+
+  private
+
+  def parse_api_params
+    params = @api.method_opts[:params]
+    typero = @api.method_opts[:_typero]
+
+    if params && typero
+      # add validation errors
+      typero.validate @api.params do |name, error|
+        response.error_detail name, error
+      end
+    end
+  end
+
+  def resolve_api_body &block
+    # 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
+  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 response.data, &before
+        end
+      end
+    end
+  end
+
+  def response content_type=nil
+    if block_given?
+      @api.raw = yield
+
+      api_host do
+        response.header['Content-Type'] = content_type || (@api.raw[0] == '{' ? 'application/json' : 'text/plain')
+      end
+    elsif content_type
+      response.data = content_type
+    else
+      @api.response
+    end
+  end
+
+  def params
+    @api.params
+  end
+
+  # inline error raise
+  def error text, args={}
+    puts 'JOSHUA API Error: %s (%s)' % [text, caller[0]] if @api.development
+
+    if err = RESCUE_FROM[text]
+      if err.is_a?(Proc)
+        err.call
+        return
+      else
+        response.error err, args
+      end
+    else
+      response.error text, args
+    end
+
+    raise Joshua::Error, text
+  end
+
+  def message data
+    response.message data
+  end
+
+  def super! name=nil
+    type   = @api.id ? :member : :collection
+    name ||= caller[0].split('`')[1].sub("'", '')
+    name   = "_api_#{type}_#{name}"
+    self.class.superclass.instance_method(name).bind(self).call
+  end
+
+  # execute actions on api host
+  def api_host &block
+    if block_given? && @api.api_host
+      @api.api_host.instance_exec self, &block
+    end
+
+    @api.api_host
+  end
+
+end

data/lib/joshua/client.rb

@@ -0,0 +1 @@
+require_relative '../../client/ruby/client'

data/lib/joshua/render_proxy.rb

@@ -0,0 +1,28 @@
+# Proxy class for simplified more user friendly render
+#
+# UserApi.render.login(123, foo: 'bar') -> UserApi.render :login, id: 133, params: { foo: 'bar' }
+# 
+# spec/tests/proxy_spec.rb
+# UserApi.render.login(user: 'foo', pass: 'bar')
+# CompanyApi.render.show(1)
+
+class Joshua
+  class RenderProxy
+    def initialize api
+      @api = api
+    end
+
+    def method_missing method_name, *args
+      # if first param present, it must be resource ID
+      api_id = args.shift unless args.first.is_a?(Hash)
+
+      # convinience, second param is params hash, options follw
+      params, opts = [args[0], args[1] || {}]
+      
+      # merge id and params to options
+      opts.merge! params: params, id: api_id
+
+      @api.render method_name, opts
+    end
+  end
+end

data/lib/joshua/response.rb

@@ -2,6 +2,16 @@
 
 class Joshua
   class Response
+    attr_reader :errors
+
+    def self.auto_format error
+      response = new nil
+      response.error error.message, code: error.is_a?(Joshua::Error) ? 400 : 500
+      response.render
+    end
+
+    ###
+
     def initialize api
       @api         = api
       @out         = {}
@@ -23,8 +33,12 @@ class Joshua
     end
 
     # human readable response message
-    def message value
-      @message = value
+    def message value, force=false
+      if force
+        @message = value
+      else
+        @message ||= value
+      end
     end
 
     # api meta response, any data is allowed
@@ -37,14 +51,19 @@ class Joshua
     end
 
     # add api response error
-    def error *args
-      return @errors unless args[0]
+    def error text, args={}
+      code   = args.delete(:code)
+      status = args.delete(:status)
+
+      raise 'Key %s is not supported' % args.keys.first if args.keys.first
+
+      @status ||= status if status
 
-      desc, code = args.reverse
+      text = text.to_s
 
-      @errors[:code]       = code if code
+      @errors[:code]     ||= code if code
       @errors[:messages] ||= []
-      @errors[:messages].push desc unless @errors[:messages].include?(desc)
+      @errors[:messages].push text unless @errors[:messages].include?(text)
     end
 
     def error?
@@ -58,9 +77,14 @@ class Joshua
       @errors[:details][name] = desc
     end
 
-    def data value
-      @data ||= value
+    def data value=:_undefind
+      if value == :_undefind
+        @data
+      else
+        @data = value
+      end
     end
+    alias :data= :data
 
     def data?
       !@data.nil?
@@ -79,7 +103,7 @@ class Joshua
         out[:meta]    = @meta
         out[:message] = @message if @message
         out[:data]    = @data unless @data.nil?
-        out[:status]  = error? ? 400 : 200
+        out[:status]  = @status || (error? ? 400 : 200)
       end
     end
   end

data/lib/misc/doc.js

@@ -44,7 +44,7 @@ window.ModalForm = {
     let data = []
 
     data.push(`<form onsubmit="TabResponse.render('${title}', this); return false;">`)
-    data.push(`  <table>`)
+    data.push(`  <table class="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>`)
@@ -55,7 +55,7 @@ window.ModalForm = {
       data.push(`    <td><label>${name}</label></td><td>`)
 
       if (vals.type == 'boolean') {
-        data.push(`    <input type="checkbox" class="form-control" name="${name}" />`)
+        data.push(`    <input type="checkbox" class="form-control" name="${name}" style="width: 20px; height: 20px;" />`)
       } else {
         data.push(`    <input type="text" class="form-control" name="${name}" value="" autocomplete="off" />`)
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joshua
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Dino Reic
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2021-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
@@ -53,7 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: clean-hash
+  name: hash_wia
+  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: typero
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +94,20 @@ 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: []
@@ -91,24 +119,19 @@ files:
 - "./lib/doc/doc.rb"
 - "./lib/doc/special.rb"
 - "./lib/joshua.rb"
-- "./lib/joshua/base.rb"
-- "./lib/joshua/error.rb"
-- "./lib/joshua/opts.rb"
-- "./lib/joshua/params/define.rb"
-- "./lib/joshua/params/parse.rb"
-- "./lib/joshua/params/types.rb"
-- "./lib/joshua/params/types_errors.rb"
+- "./lib/joshua/base_class.rb"
+- "./lib/joshua/base_instance.rb"
+- "./lib/joshua/client.rb"
+- "./lib/joshua/render_proxy.rb"
 - "./lib/joshua/response.rb"
-- "./lib/misc/api_example.coffee"
 - "./lib/misc/doc.css"
 - "./lib/misc/doc.js"
 - "./lib/misc/favicon.png"
-- "./lib/misc/ruby_client.rb"
 homepage: http://github.com/dux/joshua
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Joshua
 test_files: []

data/lib/joshua/base.rb

@@ -1,301 +0,0 @@
-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
-    # 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