ruby-api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e92e373ca61cca2ea400c3f3f1c36926498e8ae2
+  data.tar.gz: a6f8698555978a338d7820602042461c5c393d58
+SHA512:
+  metadata.gz: 3378c144ee95281ab186d290ccb01d2cf96259df32719f7fcee6e7d2edec913079007955178bfc8399b86136e9f2ed11c4f9373f91de1308d15e92cae0da1ca1
+  data.tar.gz: 6b3eabf0941b0a526e96b10b5b8e2935e9d11c4e986b5bf47f531136371839c34d471be818bc1e761a37a6770d177e7e65e4a7a488e9e22ad0252af070b6731e

data/bin/rapi

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/ruby_api/cli'
+RubyAPI::Cli::Main.start(ARGV)

data/lib/ruby_api/application.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module RubyAPI
+  # Application
+  class Application
+    APP_MODULE_NAME = 'APP'
+    APP_SOURCE_PATH = 'app/app'
+
+    attr_reader :config, :logger, :routes
+
+    def initialize(cfg = {})
+      @config = load_config(cfg)
+      @routes = load_routes
+    end
+
+    def load_config(cfg)
+      require_hash_or_string(cfg, 'Invalid configuration: %s')
+      cfg = YAML.load_file cfg if cfg.is_a?(String)
+      Config.new(cfg)
+    end
+
+    def load_routes
+      return {} unless config.key?(:routes)
+
+      routes = config.routes
+      require_hash_or_string(routes, 'Invalid routes config: %s')
+      routes = YAML.load_file routes if routes.is_a?(String)
+      @routes = routes.deep_symbolize_keys!
+    end
+
+    def boot
+      @logger = Logger.new log_path[:info]
+      @logger_err = Logger.new log_path[:error]
+      require boot_script if boot_script?
+      require app_path
+      self
+    end
+
+    def call(env)
+      @env = env
+      response = process Request.new(self, env, routes)
+      return handle_error(response) if response.failure?
+      handle_success(response)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def app_module
+      Kernel.const_get(app_name)
+    end
+
+    private
+
+    def log_path
+      if config.key?(:log)
+        { info: config.log[:info], error: config.log[:error] }
+      else
+        { info: $stdout, error: $stderr }
+      end
+    end
+
+    def app_name
+      name = config.app[:name] if config.key?(:app) && config.app[:name]
+      name || APP_MODULE_NAME
+    end
+
+    def app_path
+      return APP_SOURCE_PATH unless config.key?(:app)
+      return APP_SOURCE_PATH unless config.app.key?(:source)
+      config.app[:source]
+    end
+
+    def boot_script
+      config.boot_script
+    end
+
+    def boot_script?
+      return false unless config.key?(:boot_script)
+      path = config.boot_script
+      logger.warn "Boot script not found at: #{path}" unless File.exist?(path)
+      path
+    end
+
+    def process(request)
+      operation = request.operation
+      result = operation.process(self, request)
+      Response.operation(result)
+    end
+
+    def handle_success(response)
+      rack_response response.status, response.headers, response.data
+    end
+
+    def handle_error(response)
+      @logger_err.error response.data
+      rack_response Response::OK, response.headers, response.data
+    end
+
+    def handle_exception(error)
+      @logger_err.error error
+      rack_response Response::FAIL, Response::DEFAULT_HEADERS,
+                    Response.exception(error).data
+    end
+
+    def rack_response(status, headers, data)
+      data = [data] unless data.is_a?(Array)
+      [status, headers || {}, data]
+    end
+
+    def require_hash_or_string(object, message = 'Invalid Hash/String: %s')
+      return if object.is_a?(Hash) || object.is_a?(String)
+      raise format(message, object.inspect)
+    end
+  end
+end

data/lib/ruby_api/cli/main.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RubyAPI
+  module Cli
+    # RubyAPI Main CLI command
+    class Main < Thor
+      desc 'hello [MESSAGE]', 'say: Hello MESSAGE'
+      def hello(message = 'World')
+        puts "Hello #{message}"
+      end
+    end
+  end
+end

data/lib/ruby_api/cli.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module RubAPI
+  # RubyAPI CLI Commands
+  module Cli
+    require_relative 'cli/main'
+  end
+end

data/lib/ruby_api/config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RubyAPI
+  # Config data
+  class Config
+    def self.from_file(path)
+      new(YAML.load_file(path))
+    end
+
+    def initialize(data)
+      @data = prep_data(data)
+    end
+
+    def merge!(data)
+      @data.merge! prep_data(data)
+    end
+
+    def key?(key)
+      @data.key?(key)
+    end
+
+    def respond_to_missing?(name, *)
+      @data.key?(name)
+    end
+
+    def method_missing(name, *args)
+      return @data[name.to_sym] if respond_to_missing?(name.to_sym)
+      super
+    end
+
+    private
+
+    def prep_data(hash)
+      hash.deep_symbolize_keys!
+    end
+  end
+end

data/lib/ruby_api/operation.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RubyAPI
+  # Operation Error
+  class Operation < Trailblazer::Operation
+    def self.process(app, request)
+      call(request.arguments.merge(logger: app.logger))
+    end
+
+    def result(opts, data)
+      data = { class_key => data } unless data.is_a?(Hash)
+      opts['result'] = data
+    end
+
+    private
+
+    def class_key
+      self.class.name.split('::').last.underscore
+    end
+  end
+end

data/lib/ruby_api/request.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'rack/multipart'
+require 'rack/request'
+
+module RubyAPI
+  # Request
+  class Request
+    def initialize(app, env, routes = {})
+      @app = app
+      @env = env
+      @routes = routes
+      @rack_req = Rack::Request.new(env)
+    end
+
+    def feature
+      class_name = feature_name.camelize
+      unless app_module.const_defined?(class_name)
+        raise "Feature `#{feature_name}` not found"
+      end
+      app_module.const_get(class_name)
+    end
+
+    def operation
+      class_name = operation_name.camelize
+      unless feature.const_defined?(class_name)
+        fname = feature.name.split('::').last.underscore
+        raise "Operation `#{fname}/#{operation_name}` not found"
+      end
+      feature.const_get class_name
+    end
+
+    def arguments
+      @rack_req.params.merge json_arguments
+    end
+
+    def json_arguments
+      JSON.parse @rack_req.body.read
+    rescue JSON::ParserError
+      {}
+    end
+
+    def app_module
+      @app.app_module
+    end
+
+    def root_route
+      @routes[:root]
+    end
+
+    def root_feature
+      root_route.split('/')[0].to_s
+    end
+
+    def root_operation
+      root_route.split('/')[1].to_s
+    end
+
+    def feature_name
+      slices[0].to_s.empty? ? root_feature : slices[0].to_s
+    end
+
+    def operation_name
+      slices[1].to_s.empty? ? root_operation : slices[1].to_s
+    end
+
+    def slices
+      return route_slices(path) if routes?(path)
+      path.split('/')
+    end
+
+    def path
+      @env['REQUEST_PATH'].to_s.gsub(%r{^\/}, '')
+    end
+
+    def routes?(path)
+      @routes.key?(path.to_sym)
+    end
+
+    def route_slices(path)
+      @routes[path.to_sym].split('/')
+    end
+
+    def method
+      @env['REQUEST_METHOD'].to_s.downcase
+    end
+  end
+end

data/lib/ruby_api/response.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RubyAPI
+  # Response
+  class Response
+    FAIL = 500
+    OK = 200
+
+    DEFAULT_HEADERS = {
+      'Content-Type' => 'application/json; charset=utf-8'
+    }.freeze
+
+    class << self
+      def error(data)
+        new(data, error: true)
+      end
+
+      def exception(err)
+        data = { message: err.message }
+        data[:backtrace] = err.backtrace if RubyAPI.development?
+        new(data, error: true)
+      end
+
+      def ok(data)
+        new(data)
+      end
+
+      def operation(result)
+        return new(result['errors'], error: true) if result.failure?
+        new(result['result'])
+      end
+    end
+
+    def status
+      success? ? OK : (@status || FAIL)
+    end
+
+    def headers
+      @headers || DEFAULT_HEADERS
+    end
+
+    def failure?
+      @error
+    end
+
+    def success?
+      !failure?
+    end
+
+    def data
+      @data.is_a?(String) ? @data : @data.to_json
+    end
+
+    private
+
+    def initialize(data, error: false)
+      @data = data
+      @error = error ? true : false
+    end
+  end
+end

data/lib/ruby_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyAPI
+  VERSION = '1.0.1'
+end

data/lib/ruby_api.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rubygems'
+require 'bundler'
+require 'trailblazer/operation'
+require 'active_support/core_ext/string'
+require 'dry-validation'
+require 'dry-struct'
+
+# RubyAPI
+module RubyAPI
+  require_relative 'ruby_api/version'
+  require_relative 'ruby_api/config'
+  require_relative 'ruby_api/operation'
+  require_relative 'ruby_api/response'
+  require_relative 'ruby_api/request'
+  require_relative 'ruby_api/application'
+
+  CONFIG_DIR = 'config'
+  BOOT_SCRIPT = 'boot'
+
+  def self.application(config = nil)
+    return @app if @app
+    @app = Application.new(config)
+                      .boot
+  end
+
+  def self.environment
+    ENV['RACK_ENV'] || 'development'
+  end
+
+  def self.development?
+    %w[development test].include? environment
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: ruby-api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Voislav Jovanovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: trailblazer-operation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: ruby api framework
+email: voislavj@gmail.com
+executables:
+- rapi
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/rapi
+- lib/ruby_api.rb
+- lib/ruby_api/application.rb
+- lib/ruby_api/cli.rb
+- lib/ruby_api/cli/main.rb
+- lib/ruby_api/config.rb
+- lib/ruby_api/operation.rb
+- lib/ruby_api/request.rb
+- lib/ruby_api/response.rb
+- lib/ruby_api/version.rb
+homepage: http://bitbucket.org/voislavj/ruby-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: summary
+test_files: []