koromo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 274989dcaa69f9b1c7d25faa5697bc9a645c43b1
+  data.tar.gz: f2f827427f6fd76bfb0fa7fd871ac8a3bef99b9f
+SHA512:
+  metadata.gz: 29d602aeb709c3564889119de0e6f2f850e62e4d8febfbdeaed197875d0f24867e15221e92464dac57f1b6cf208492384cd767933e61dd71cb9dc9e990e68586
+  data.tar.gz: 2d0bb77811fe6f7dd17a67b06e9ce55251586dd82a6b9807e472d2fadec56785bf9ba8c6aebafaa5eae56a9092c04d139c6f061433e5c384ebb4ae10c5f991f3

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ken J.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,33 @@
+# koromo
+
+[![Gem Version](https://badge.fury.io/rb/koromo.svg)](https://badge.fury.io/rb/koromo) [![Code Climate](https://codeclimate.com/github/kenjij/koromo/badges/gpa.svg)](https://codeclimate.com/github/kenjij/koromo)
+
+A proxy server for MS SQL Server to present as a RESTful service.
+
+## Requirements
+
+- Ruby 2.0.0 <=
+- FreeTDS library (uses the [tiny_tds](https://rubygems.org/gems/tiny_tds/) gem)
+
+## Getting Started
+
+### Install
+
+```
+$ gem install koromo
+```
+
+### Use
+
+```
+$ koromo start -c config.yml
+```
+
+### Examples
+
+Config file.
+
+```
+$ koromo_config
+```
+

data/bin/koromo

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require 'kajiki'
+require 'thin'
+require 'koromo'
+
+
+opts = Kajiki.preset_options(:server, {config: true})
+
+Kajiki.run(opts) do |cmd|
+  case cmd
+  when 'start'
+    Thin::Server.start(opts[:address], opts[:port]) do
+      run Koromo::Server.new(opts)
+    end
+  end
+end

data/bin/koromo_config

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+puts IO.read(File.expand_path('../../lib/koromo/config-example.yml',__FILE__))

data/koromo.gemspec

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'koromo/version'
+
+
+Gem::Specification.new do |s|
+  s.name          = 'koromo'
+  s.version       = Koromo::Version
+  s.authors       = ['Ken J.']
+  s.email         = ['kenjij@gmail.com']
+  s.summary       = %q{MS SQL Server RESTful access proxy}
+  s.description   = %q{A proxy server for MS SQL Server to present as a RESTful service.}
+  s.homepage      = 'https://github.com/kenjij/koromo'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'kajiki', '~> 1.1'
+  s.add_runtime_dependency 'thin', '~> 1.6'
+  s.add_runtime_dependency 'sinatra', '~> 1.4'
+  s.add_runtime_dependency 'tiny_tds', '~> 1.0'
+  s.add_runtime_dependency 'sequel', '~> 4.0'
+end

data/lib/koromo/config-example.yml

@@ -0,0 +1,64 @@
+---
+# TDS options
+:mssql:
+  # The database server user
+  :user: username
+  # The user password
+  :password: p4sSw0rD
+  # Used if :dataserver blank; can be an hostname or an IP address
+  :host: 192.168.0.100
+  # Defaults to 1433; only used if :host is configured
+  :port: 1433
+  # The default database to use
+  :database: master
+  # Other TDS options can be configure as well; default examples below
+  # :login_timeout: 60
+  # :timeout: 5
+  # :encoding: UTF-8
+  # :azure: false
+
+:global:
+  :pretty_json: YES
+  # Basic security by requiring strings below to be passed in "auth" param
+  :auth_tokens:
+    :any:
+      - sEcReT_sTrInG_0N3
+      - SeCrEt_StRiNg_7W0
+
+# API definitions
+:resources:
+  # Name of the resource available via API
+  :resource1:
+    # Name of the DB table
+    :table: :table1
+    # Name of columns to return from the table
+    :columns:
+      - :id
+      - :name
+      - :description
+      - :date
+    # Name of the column to search when resource ID is present
+    :key: :id
+    # Optional; otherwise restricted to 10
+    :limit: 25
+    # Optional
+    :order: :date
+    # Optional; defaults to ASC without this option present
+    :desc: true
+    # Settings for GET calls
+    :get:
+      # Return as Hash or Array
+      :class: Hash
+      # Optional only with Hash; response will become a simple key-value pair
+      :value: :name
+  :books:
+    :table: :books
+    :columns:
+      - :id
+      - :isbn
+      - :title
+      - :author
+      - :date
+    :key: :isbn
+    :get:
+      :class: Array

data/lib/koromo/config.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+
+module Koromo
+
+  # Load YAML config file
+  # @param path [String] config file
+  # @return [Object] config; a shared instance
+  def self.load_config(path)
+    raise 'config file missing' unless path
+    @config ||= YAML.load_file(path)
+    if file = @config[:require_file]
+      require File.expand_path(file, path)
+    end
+  end
+
+  # see #self.load_config
+  def self.config
+    @config
+  end
+
+end

data/lib/koromo/helper.rb

@@ -0,0 +1,54 @@
+require 'json'
+
+module Koromo
+
+  module Helper
+
+    # Convert object into JSON, optionally pretty-format
+    # @param obj [Object] any Ruby object
+    # @param opts [Hash] any JSON options
+    # @return [String] JSON string
+    def json_with_object(obj, pretty: nil, opts: nil)
+      return '{}' if obj.nil?
+      pretty ||= Koromo.config[:global][:pretty_json]
+      if pretty
+        opts = {
+          indent: '  ',
+          space: ' ',
+          object_nl: "\n",
+          array_nl: "\n"
+        }
+      end
+      JSON.fast_generate(json_format_value(obj), opts)
+    end
+
+    # Return Ruby object/value to JSON standard format
+    # @param val [Object]
+    # @return [Object]
+    def json_format_value(val)
+      case val
+      when Array
+        val.map { |v| json_format_value(v) }
+      when Hash
+        val.reduce({}) { |h, (k, v)| h.merge({k => json_format_value(v)}) }
+      when BigDecimal
+        # val.to_s('F')
+        val.to_f
+      when String
+        val.encode!('UTF-8', {invalid: :replace, undef: :replace})
+      when Time
+        val.utc.iso8601
+      else
+        val
+      end
+    end
+
+    def valid_token?(token, method = :any)
+      tokens = Koromo.config[:global][:auth_tokens][method]
+      return true if tokens.nil?
+      tokens.include?(token)
+    end
+
+  end
+
+end

data/lib/koromo/server.rb

@@ -0,0 +1,87 @@
+require 'sinatra/base'
+require 'logger'
+require 'koromo/config'
+require 'koromo/helper'
+require 'koromo/sql'
+
+module Koromo
+
+  # The Sinatra server
+  class Server < Sinatra::Base
+
+    attr_reader :rack_opts
+    # attr_reader :config
+
+    def initialize(opts)
+      super()
+      @rack_opts = opts
+      Koromo.load_config(rack_opts[:config])
+    end
+
+    def slogger
+      return logger if settings.logging
+      @slogger ||= Logger.new(STDOUT)
+      return @slogger
+    end
+
+    helpers Helper, SQL
+
+    configure do
+      set :environment, :production
+      enable :logging
+      disable :static, :dump_errors
+    end
+
+    before do
+      # @jsonp_callback = params[:callback]
+      halt 401 unless valid_token?(params[:auth])
+      setup_sql(Koromo.config)
+    end
+
+    get '/:resource' do |r|
+      result = get_resource(r, params: params)
+      if result
+        json_with_object(result)
+      else
+        fail Sinatra::NotFound
+      end
+    end
+
+    get '/:resource/:id' do |r, id|
+      fail Sinatra::NotFound if /\W/ =~ id
+      result = get_resource(r, id: id, params: params)
+      if result
+        json_with_object(result)
+      else
+        fail Sinatra::NotFound
+      end
+    end
+
+    not_found do
+      json_with_object({message: 'Huh, nothing here.'})
+    end
+
+    error 401 do
+      json_with_object({message: 'Oops, need a valid auth.'})
+    end
+
+    error do
+      status 500
+      err = env['sinatra.error']
+      slogger.error "#{err.class.name} - #{err}"
+      json_with_object({message: 'Yikes, internal error.'})
+    end
+
+    after do
+      content_type 'application/json'
+      # if @jsonp_callback
+      #   content_type 'application/javascript'
+      #   body @jsonp_callback + '(' + json_with_object(@body_object) + ')'
+      # else
+      #   content_type 'application/json'
+      #   body json_with_object(@body_object, {pretty: config[:global][:pretty_json]})
+      # end
+    end
+
+  end
+end

data/lib/koromo/sql.rb

@@ -0,0 +1,96 @@
+require 'sequel'
+
+
+module Koromo
+
+  module SQL
+
+    def setup_sql(conf)
+      @config = conf
+      # Sequel connection setup
+      # Sequel.application_timezone = :local
+      # Sequel.database_timezone = :utc
+      Sequel::Model.db = Sequel.connect({adapter: 'tinytds'}.merge(config[:mssql]))
+    end
+
+    def config
+      @config
+    end
+
+    def config_for_resource(name)
+      name = name.to_sym
+      c = config[:resources][name]
+      c[:limit] ||= 10
+      c
+    end
+
+    # Get model classes
+    def model_for_resource(name)
+      name = name.to_sym
+      @models ||= {}
+      return nil unless rc = config_for_resource(name)
+      if @models[name].nil?
+        m = Class.new(Sequel::Model)
+        m.set_dataset(rc[:table])
+        @models[name] = m
+      end
+      @models[name]
+    end
+
+    def run_query(query)
+      result = mssql.execute(query)
+      records = []
+      result.each(cache_rows: false) do |row|
+        record = {}
+        row.each { |k, v| record[k] = convert_value(v) }
+        records.push record
+      end
+      records
+    # rescue => e
+    #   puts e.message
+    #   raise
+    end
+
+    def get_resource(name, **args)
+      return nil unless model = model_for_resource(name)
+      p args[:params]
+      conf = config_for_resource(name)
+      set = model.select(*conf[:columns])
+      if args[:id]
+        array = set.where(conf[:key] => args[:id]).all
+      else
+        if args[:params]
+          p_limit = args[:params][:limit]
+          p_limit = p_limit.to_i if p_limit.class == String
+          p_order = args[:params][:order]
+          p_desc = true if args[:params][:desc]
+          p_desc = false if args[:params][:asc]
+        end
+        p_limit ||= conf[:limit]
+        p_order ||= conf[:order]
+        p_desc ||= conf[:desc]
+        set = set.limit(p_limit)
+        set = (p_desc ? set.reverse_order(p_order) : set.order(p_order))
+        p set.sql
+        array = set.all
+      end
+      return nil if array.empty?
+      case conf[:get][:class]
+      when 'Hash'
+        result = {}
+        key = conf[:key]
+        val = conf[:get][:value]
+        array.each do |r|
+          rec = r.values
+          result.store(rec.delete(key), val ? rec[val] : rec)
+        end
+      when 'Array'
+        result = array.map{ |r| r.values }
+      end
+      return result[0] if args[:id] && result.class == Array
+      result
+    end
+
+  end
+
+end

data/lib/koromo/version.rb

@@ -0,0 +1,5 @@
+module Koromo
+
+  Version = '0.0.1'
+
+end

data/lib/koromo.rb

@@ -0,0 +1 @@
+require 'koromo/server'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: koromo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ken J.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kajiki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: tiny_tds
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A proxy server for MS SQL Server to present as a RESTful service.
+email:
+- kenjij@gmail.com
+executables:
+- koromo
+- koromo_config
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/koromo
+- bin/koromo_config
+- koromo.gemspec
+- lib/koromo.rb
+- lib/koromo/config-example.yml
+- lib/koromo/config.rb
+- lib/koromo/helper.rb
+- lib/koromo/server.rb
+- lib/koromo/sql.rb
+- lib/koromo/version.rb
+homepage: https://github.com/kenjij/koromo
+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.4.3
+signing_key: 
+specification_version: 4
+summary: MS SQL Server RESTful access proxy
+test_files: []