rhail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 056abf1008fba20421c9ba46138ed29b6e5bf034
+  data.tar.gz: 05716cad7a09486017c33edc8b8a818bbb6150f7
+SHA512:
+  metadata.gz: 64da155c38b307723f7233a7801a65b78d48041208b74b3a71f422d2fbd2a452cfd1a19afd2cfaabc9fd8e4b76dcdbc1942d62de8edd08eeb38a359f795858c4
+  data.tar.gz: 9a6d19cffba546c95747eb6613c7b48fe4b51786581e91f68ed97606f1fd9e1f10f75e07663544012bf7720604d0f5f5f0ffcc09e5fe08b064c50ce5ea1df89a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Maksim Sundukov
+
+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,77 @@
+# Ruby Hail
+
+## About
+
+Ruby Hail is Rack-based nano framework. It's the fastest-by-design Rack-based framework. It requires less learning (besides Rack, you suppose to know it by this time) than any other framework. It works great for simple dynamic web-sites, single-page web-apps and microservices.
+
+
+## Why
+
+I was looking for balance between simplicity and development speed. If you go bellow Rack it's a lot of extra work for simple things. If you put a lot of abstractions on top of Rack then you loose track of what's going on under the hood and with high probability slowing things down.
+
+I believe in right tool for the right job. If you look for fully-featured framework you might need Rails, something simpler - Sinatra, static site - Jekyll, blog - Wordpress. When you need simple web app or API that can do just couple of things really fast and easy - go Ruby Hail.
+
+It was born when I was looking for web frameworks for Go and people advocated to not to use any except for the very basic ones. Otherwise you can't get the performance you're aiming for. So I took this concept to my favorite language - Ruby. I wanted to use as bare metal approach much as possible and to implement only the most necessary things so everyone can solve one task per app with high efficiency.
+
+## Use
+
+```
+gem install rhail
+rhail generate <plain|json|spa> path/to/folder # it will create directory with app structure
+cd path/to/folder
+# Install ruby via rvm if needed
+gem install bundler
+bundle install
+bundle exec rackup # Go to http://127.0.0.1:9292 or wherever output tells you.
+```
+
+To run it in production treat it as any other Rack-based (Rails or Sinatra) app. For example Passenger should be ponted to `<the folder>/public`.
+
+Enjoy!
+
+## Generators
+
+### Plain
+
+```
+rhail generate plain path/to/folder
+```
+
+Traditional server-side-based web-app, with example of (relatively secured) form, database and very simple html templating. You can chain htmls and utilize ruby string interpolation.
+
+### JSON
+
+```
+rhail generate json path/to/folder
+```
+
+JSON Web-API with authentication.
+
+#### Play with it
+
+```
+curl -i -H 'Authorization: Token token="afbadb4ff8485c0adcba486b4ca90cc4"' http://127.0.0.1:9292/
+curl -i -H 'Authorization: Token token="afbadb4ff8485c0adcba486b4ca90cc4"' http://127.0.0.1:9292/example_one
+curl -i -H 'Authorization: Token token="afbadb4ff8485c0adcba486b4ca90cc4"' -H "Content-Type: application/json" -X POST -d '{"city":"asd","state":"asd","zipcode":"123","name":"asd"}' http://127.0.0.1:9292/example_two
+```
+
+### SPA
+
+```
+rhail generate spa path/to/folder
+```
+
+Single-page app based on Ruby Hail with VueJS. VueJS has a lot of similarities to AngularJS 1, minus performance issues.
+
+## Custom code
+
+Once you play with automatically generated code you will want to extend it with your real functionality.
+
+```
+RhailHelper.render_json(response_structure: {}, headers: {}
+RhailHelper.render_html files: %w(head body foot), local_vars: {}, headers: {}
+```
+
+## Benchmarks
+
+[In another repo](https://github.com/E-Xor/rhail-benchmark "Ruby Hail Benchmark")

data/bin/rhail

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+require 'rhail'
+
+##
+# Exception in the bin/rhail for the case when user specifies wrong arguments for the rhail command.
+#
+class ArgError < StandardError; end
+
+begin
+  case ARGV[0]
+  when 'g', 'gen', 'generate'
+    type = ARGV[1]
+    raise ArgError unless type
+
+    puts
+    gen = Rhail::Generator.new(type: type, folder: ARGV[2])
+    puts 'Creating file structure ...'
+    gen.create_folder_with_app
+
+    install_dependencies = false # Later get from parameter
+    if type == 'json'
+      further_instructions = %Q(    Test it\n\tcurl -i -H 'Authorization: Token token="afbadb4ff8485c0adcba486b4ca90cc4"' http://127.0.0.1:9292/\n)
+    else
+      further_instructions = "    Go to http://127.0.0.1:9292 or wherever output tells you."
+    end
+
+    if install_dependencies
+      puts 'Installing dependencies ...'
+      gen.install_dependencies
+      done_message = %Q(
+
+  \e[32mDone!
+
+  What to do next?
+
+    $ cd #{gen.folder}/#{gen.type}
+    $ bundle exec rackup
+
+    #{further_instructions}
+
+    Enjoy!
+
+  \e[0m
+
+)
+    else
+      done_message = %Q(
+
+  \e[32mDone!
+
+  What to do next?
+
+    $ cd #{gen.folder}/#{gen.type}
+    $ gem install bundler
+    $ bundle install
+    $ bundle exec rackup
+
+    #{further_instructions}
+
+    Enjoy!
+
+  \e[0m
+
+)
+  end
+
+  puts done_message
+
+  else
+    raise ArgError
+  end
+rescue ArgError => e
+  puts Rhail::USAGE
+rescue => e
+  puts "\e[31mError happened: #{e.message}\e[0m"
+  raise e
+end

data/generator_folders/json/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0@rhail_json

data/generator_folders/json/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'rack', '~> 2.0.1'
+gem 'sequel', '~> 4.41.0'
+gem 'sqlite3', '~> 1.3.12'
+gem 'rhail', path: '/Users/maksim/other-apps/rhail/'

data/generator_folders/json/Gemfile.lock

@@ -0,0 +1,17 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rack (2.0.1)
+    sequel (4.41.0)
+    sqlite3 (1.3.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack (~> 2.0.1)
+  sequel (~> 4.41.0)
+  sqlite3 (~> 1.3.12)
+
+BUNDLED WITH
+   1.13.7

data/generator_folders/json/config.ru

@@ -0,0 +1,61 @@
+require 'rhail/helper'
+require 'yaml'
+require 'sequel'
+
+use Rack::Static, :urls => ['/img'], :root => 'public' # http://www.rubydoc.info/github/rack/rack/Rack/Static
+
+SETTINGS    = YAML.load_file(File.expand_path('../settings.yml',__FILE__))
+TOKEN_VALUE = SETTINGS['token']
+DB          = Sequel.sqlite('db/database.sqlite3')
+
+class WebApi
+
+  def self.call(env)
+    req = Rack::Request.new(env)
+
+    case 
+    when req.get? && req.path_info == '/'
+
+      h = {
+        one: '584c5915f896067cb0927bd6',
+        two: 0,
+        three: 'f5ef49a3-2b82-46f5-aa8f-1180f7dbef98',
+        four: true,
+        five: '$2,343.28',
+        six: 33,
+        seven: 'blue',
+        eight: 'dot'
+      }
+      Rhail::Helper.token_auth(env['HTTP_AUTHORIZATION'], TOKEN_VALUE) do |t|
+        Rhail::Helper.render_json(response_structure: h)
+      end
+
+    when req.get? && req.path_info == '/example_one'
+      Rhail::Helper.token_auth(env['HTTP_AUTHORIZATION'], TOKEN_VALUE) do |t|
+        people_with_addresses = DB[:people].left_join(:addresses, id: :address_id).select(:name, :city, :state, :zipcode).all
+        Rhail::Helper.render_json(response_structure: people_with_addresses)
+      end
+
+    when req.post? && req.path_info == '/example_two'
+      Rhail::Helper.token_auth(env['HTTP_AUTHORIZATION'], TOKEN_VALUE) do |t|
+        params = Rhail::Helper.params_from_json_request(req)
+
+        address_id = DB[:addresses].insert(city: params['city'], state: params['state'], zipcode: params['zipcode'])
+        DB[:people].insert(name: params['name'], address_id: address_id)
+
+        people_with_addresses = DB[:people].left_join(:addresses, id: :address_id).select(:name, :city, :state, :zipcode).all
+        Rhail::Helper.render_json(response_structure: people_with_addresses)
+      end
+    end
+
+  rescue => e
+    Rhail::Helper.render_json(response_structure: {status: '500', code: 'Internal Server Error', detail: e.message}, status: 500)
+  end
+
+end
+
+run WebApi
+
+# curl -i -H 'Authorization: Token token="afbadb4ff8485c0adcba486b4ca90cc4"' http://127.0.0.1:9292/
+# curl -i -H 'Authorization: Token token="afbadb4ff8485c0adcba486b4ca90cc4"' http://127.0.0.1:9292/example_one
+# curl -i -H 'Authorization: Token token="afbadb4ff8485c0adcba486b4ca90cc4"' -H "Content-Type: application/json" -X POST -d '{"city":"asd","state":"asd","zipcode":"123","name":"asd"}' http://127.0.0.1:9292/example_two

data/generator_folders/json/db/seed.rb

@@ -0,0 +1,31 @@
+require 'sequel'
+
+DB = Sequel.sqlite('db/database.sqlite3')
+
+DB.run "DROP TABLE IF EXISTS addresses"
+DB.run "DROP TABLE IF EXISTS people"
+
+DB.create_table :addresses do
+  primary_key :id
+  String      :street_1,  :size => 255
+  String      :street_2,  :size => 255
+  String      :city
+  String      :state,   :size => 2
+  String      :zipcode, :size => 5
+end
+
+DB.run "INSERT INTO addresses(city, state, zipcode) VALUES('Atlanta', 'GA', '30305')"
+DB.run "INSERT INTO addresses(city, state, zipcode) VALUES('Houston', 'TX', '77001')"
+DB.run "INSERT INTO addresses(city, state, zipcode) VALUES('Fargo', 'ND', '58102')"
+
+
+DB.create_table :people do
+  primary_key :id
+  String      :name,  :size => 255
+  Integer     :address_id
+end
+
+DB.run "INSERT INTO people(name, address_id) VALUES('George', 1)"
+DB.run "INSERT INTO people(name, address_id) VALUES('Thomas', 2)"
+DB.run "INSERT INTO people(name, address_id) VALUES('Douglas', 3)"
+

data/generator_folders/json/settings.yml

@@ -0,0 +1 @@
+token: 'afbadb4ff8485c0adcba486b4ca90cc4'

data/generator_folders/plain/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0@rhail_plain

data/generator_folders/plain/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'rack', '~> 2.0.1'
+gem 'sequel', '~> 4.41.0'
+gem 'sqlite3', '~> 1.3.12'
+gem 'rhail', path: '/Users/maksim/other-apps/rhail/'

data/generator_folders/plain/Gemfile.lock

@@ -0,0 +1,17 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rack (2.0.1)
+    sequel (4.41.0)
+    sqlite3 (1.3.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack (~> 2.0.1)
+  sequel (~> 4.41.0)
+  sqlite3 (~> 1.3.12)
+
+BUNDLED WITH
+   1.13.6

data/generator_folders/plain/config.ru

@@ -0,0 +1,59 @@
+require 'rhail/helper'
+require 'sequel'
+require 'securerandom'
+
+use Rack::Static, :urls => ['/img', '/css'], :root => 'public' # http://www.rubydoc.info/github/rack/rack/Rack/Static
+use Rack::Session::Pool
+
+DB = Sequel.sqlite('db/database.sqlite3')
+
+class RhailPlain
+  def self.call(env)
+
+    req = Rack::Request.new(env)
+
+    case 
+    when req.get? && req.path_info == '/'
+
+      Rhail::Helper.render_html files: %w(head home foot), local_vars: {page: 'home'}
+
+    when req.get? && req.path_info == '/example_one'
+
+      Rhail::Helper.render_html files: %w(head example_one foot), local_vars: {page: 'example_one'}
+
+    when req.get? && req.path_info == '/example_two'
+
+      Rhail::Helper.render_html files: %w(head example_two foot), local_vars: {page: 'example_two'}
+
+    when req.post? && req.path_info == '/example_two' # post
+
+      Rhail::Helper.render_html files: %w(head example_two foot), local_vars: {page: 'example_two', results: req.params}
+
+    when req.get? && req.path_info == '/example_three'
+
+      req.session['csrf.token'] = SecureRandom.urlsafe_base64(32)
+
+      people_with_addresses = DB[:people].left_join(:addresses, id: :address_id).select(:name, :city, :state, :zipcode).all
+
+      Rhail::Helper.render_html files: %w(head example_three foot), local_vars: {page: 'example_three', results: people_with_addresses, csrf_token: env['rack.session']['csrf.token']}
+
+    when req.post? && req.path_info == '/example_three' # post
+
+      params = req.params
+
+      if params['csrf_token'] == req.session['csrf.token']
+
+        address_id = DB[:addresses].insert(city: params['city'], state: params['state'], zipcode: params['zipcode'])
+        DB[:people].insert(name: params['name'], address_id: address_id)
+
+      else
+        puts "CSRF check failed."
+      end
+
+      [302, {'Location' => '/example_three', 'Content-Type' => 'text/html'}, ['302 found']]
+    end
+
+  end
+end
+
+run RhailPlain

data/generator_folders/plain/db/seed.rb

@@ -0,0 +1,31 @@
+require 'sequel'
+
+DB = Sequel.sqlite('db/database.sqlite3')
+
+DB.run "DROP TABLE IF EXISTS addresses"
+DB.run "DROP TABLE IF EXISTS people"
+
+DB.create_table :addresses do
+  primary_key :id
+  String      :street_1,  :size => 255
+  String      :street_2,  :size => 255
+  String      :city
+  String      :state,   :size => 2
+  String      :zipcode, :size => 5
+end
+
+DB.run "INSERT INTO addresses(city, state, zipcode) VALUES('Atlanta', 'GA', '30305')"
+DB.run "INSERT INTO addresses(city, state, zipcode) VALUES('Houston', 'TX', '77001')"
+DB.run "INSERT INTO addresses(city, state, zipcode) VALUES('Fargo', 'ND', '58102')"
+
+
+DB.create_table :people do
+  primary_key :id
+  String      :name,  :size => 255
+  Integer     :address_id
+end
+
+DB.run "INSERT INTO people(name, address_id) VALUES('George', 1)"
+DB.run "INSERT INTO people(name, address_id) VALUES('Thomas', 2)"
+DB.run "INSERT INTO people(name, address_id) VALUES('Douglas', 3)"
+