rhail 0.0.1

data/lib/rhail/generator.rb

@@ -0,0 +1,46 @@
+require 'fileutils'
+
+module Rhail
+  class Generator # :nodoc:
+    attr_reader :folder, :type
+
+    def initialize(type: 'plain', folder: './', rvm_ruby: '2.3.3', rvm_gemset: nil)
+      @type       = type
+      folder      = (folder == nil || folder.size == 0) ? './' : folder
+      @folder     = File.expand_path(folder)
+      @rvm_ruby   = rvm_ruby
+      @rvm_gemset = rvm_gemset || "ruby-hail-generated-#{@type}"
+    end
+
+    def create_folder_with_app
+      unless Dir.exists? @folder
+        FileUtils.mkdir_p @folder
+      end
+
+      FileUtils.cp_r File.expand_path("../../../generator_folders/#{@type}", __FILE__), @folder
+
+      if @rvm_ruby
+        File.open("#{@folder}/#{@type}/.ruby-version", 'w+') do |f|
+          f.write "#{@rvm_ruby}@#{@rvm_gemset}\n"
+        end
+      end
+    end
+
+    def install_dependencies
+      rvm_cmd = `which rvm`.chomp
+      rvm_full_cmd = ''
+      if rvm_cmd.length > 0
+        rvm_full_cmd = "#{rvm_cmd} #{@rvm_ruby}@#{@rvm_gemset} do"
+      end
+
+      install_bundler_cmd = "cd #{@folder}/#{@type} && #{rvm_full_cmd} gem install bundler"
+      puts install_bundler_cmd
+      system(install_bundler_cmd)
+
+      bundle_install_cmd = "cd #{@folder}/#{@type} && #{rvm_full_cmd} bundle install"
+      puts bundle_install_cmd
+      system(bundle_install_cmd)
+    end
+
+  end
+end

data/lib/rhail/helper.rb

@@ -0,0 +1,117 @@
+require 'json'
+
+module Rhail
+
+  ##
+  #
+  # Helper for all http response related needs.
+  #
+  class Helper
+    ##
+    #
+    # Exception for the case when Rhail::Helper.token_auth doesn't receive right parameters.
+    #
+    class FailedTokenAuth < Exception; end
+
+    ##
+    #
+    # Renders html.
+    # It concatenates files specified in +files+ parameter.
+    # If +local_vars+ specified it also make Ruby string evaluation so var value will appera in html.
+    # If +headers+ provided also adds them, good for caching headers.
+    #
+    # Example:
+    #
+    #   Rhail::Helper.render_html files: %w(head home foot), local_vars: {page: 'home'}
+    #
+    def self.render_html(files: ['index'], local_vars: nil, headers: {})
+
+      res = Rack::Response.new
+
+      html = ''
+      if local_vars
+        files.each {|fn| html +=  eval('%Q(' + File.read("public/html/#{fn}.html") + ')') }
+      else
+        files.each {|fn| html += File.read("public/html/#{fn}.html") }
+      end
+
+      res['Content-Type'] = 'text/html'
+      headers.each do |k, v|
+        res[k] = v
+      end if headers
+      res.write html
+
+      res.finish
+
+    end
+
+    ##
+    #
+    # Renders json form hash in +response_structure+.
+    # If +status+ provided overwrites 200.
+    # If +headers+ provided adds them to response. Good for caching headers.
+    #
+    # Example:
+    #
+    #   Rhail::Helper.render_json(response_structure: some_hash)
+    #
+    def self.render_json(response_structure: {}, status: 200, headers: {})
+
+
+      res = Rack::Response.new([], status, {})
+
+      res['Content-Type'] = 'application/json'
+      headers.each do |k, v|
+        res[k] = v
+      end if headers
+      res.write response_structure.to_json
+
+      res.finish
+
+    end
+
+    ##
+    #
+    # When JSON request is expected converts it to Hash.
+    #
+    # Example:
+    #
+    #   req = Rack::Request.new(env)
+    #   params = Rhail::Helper.params_from_json_request(req)
+    #
+    def self.params_from_json_request(req)
+      JSON.parse(req.body.read)
+    end
+
+    ##
+    # Authenticates request based on token.
+    # +valid_token+ source is up to developer, in generators it's just in a config file.
+    # In real life you can use database or key-value storage and get it from there.
+    # If token is not valid renders 401 with error in json.
+    #
+    # Example:
+    #
+    #   Rhail::Helper.token_auth(env['HTTP_AUTHORIZATION'], valid_token) do |t|
+    #     Rhail::Helper.render_json(response_structure: some_hash)
+    #   end
+    #
+    def self.token_auth(http_auth_header, valid_token)
+
+
+      raise FailedTokenAuth unless http_auth_header
+      type, token = http_auth_header.split(' ')
+
+      raise FailedTokenAuth if type != 'Token'
+      token_value = token.sub('token="', '').chop rescue raise(FailedTokenAuth)
+      raise FailedTokenAuth if token_value != valid_token
+
+      puts "Access granted"
+      yield token_value
+
+    rescue FailedTokenAuth, ::StandardError => e
+      puts e.message
+      render_json(response_structure: {status: '401', code: 'Unauthorized', detail: 'Access denied'}, status: 401)
+    end
+
+  end
+end

data/lib/rhail/main.rb

@@ -0,0 +1,8 @@
+require 'rhail/generator'
+require 'rhail/helper'
+
+module Rhail
+  class Main # :nodoc:
+
+  end
+end

data/rhail.gemspec

@@ -0,0 +1,46 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require 'rhail'
+
+Gem::Specification.new do |s|
+  s.name        = 'rhail'
+  s.version     = '0.0.1'
+  s.date        = '2017-02-12'
+  s.summary     = "Bunch of generators and functions to make you up and running fast in Rack web-app."
+
+  s.description = <<-EOF
+
+|````\\     |    ||
+|____//     |____||
+|    \\     |    ||
+|     \\uby |    ||ail
+
+Ruby Hail is fast-by-design Rack-based nano-framework.
+It provides generator and helper to quickly create Rack-based web-apps.
+
+You have options to make plain html-based app with basic templates. You can chain htmls and utilize ruby string interpolation.
+
+You can generate simple json API with authentication.
+
+Or you can go with SPA (single-page app). It uses Vue.js for UI because it shares 
+fast-by-design philosophy and very similar to AngularJS 1.
+
+In all cases you have database (sqlite by default) available out of the box.
+
+EOF
+
+  s.authors     = ["Maksim Sundukov"]
+  s.email       = 'max.sundukov@gmail.com'
+  s.files       =  Dir['{bin/*.*,lib/**/*.*,generator_folders/**/*,generator_folders/**/.*,generator_folders/**/*.*}'] + %w(LICENSE rhail.gemspec README.md) # simplify for generator_folders
+  s.bindir      = 'bin'
+  s.executables << 'rhail'
+  s.homepage    = 'https://github.com/E-Xor/rhail'
+  s.license     = 'MIT'
+
+  s.extra_rdoc_files = []
+  s.rdoc_options += ['-m', 'README.md', '-x', '/generator_folders/.*|rhail.gemspec', '--title', 'Ruby Hail']
+
+  s.post_install_message = Rhail::USAGE
+
+  s.required_ruby_version = '~> 2.0' # Generated code was written and testend in ruby 2.3.0, however there's nothing specific to this ruby versions.
+  s.add_dependency 'rack', '~> 2.0'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: rhail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Maksim Sundukov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: "\n|````\\     |    ||\n|____//     |____||\n|    \\     |    ||\n|     \\uby
+  |    ||ail\n\nRuby Hail is fast-by-design Rack-based nano-framework.\nIt provides
+  generator and helper to quickly create Rack-based web-apps.\n\nYou have options
+  to make plain html-based app with basic templates. You can chain htmls and utilize
+  ruby string interpolation.\n\nYou can generate simple json API with authentication.\n\nOr
+  you can go with SPA (single-page app). It uses Vue.js for UI because it shares \nfast-by-design
+  philosophy and very similar to AngularJS 1.\n\nIn all cases you have database (sqlite
+  by default) available out of the box.\n\n"
+email: max.sundukov@gmail.com
+executables:
+- rhail
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/rhail
+- generator_folders/.DS_Store
+- generator_folders/json/.DS_Store
+- generator_folders/json/.ruby-version
+- generator_folders/json/Gemfile
+- generator_folders/json/Gemfile.lock
+- generator_folders/json/config.ru
+- generator_folders/json/db/database.sqlite3
+- generator_folders/json/db/seed.rb
+- generator_folders/json/public/.DS_Store
+- generator_folders/json/public/img/.DS_Store
+- generator_folders/json/public/img/favicon.png
+- generator_folders/json/settings.yml
+- generator_folders/plain/.DS_Store
+- generator_folders/plain/.ruby-version
+- generator_folders/plain/Gemfile
+- generator_folders/plain/Gemfile.lock
+- generator_folders/plain/config.ru
+- generator_folders/plain/db/database.sqlite3
+- generator_folders/plain/db/seed.rb
+- generator_folders/plain/public/.DS_Store
+- generator_folders/plain/public/css/styles.css
+- generator_folders/plain/public/html/example_one.html
+- generator_folders/plain/public/html/example_three.html
+- generator_folders/plain/public/html/example_two.html
+- generator_folders/plain/public/html/foot.html
+- generator_folders/plain/public/html/head.html
+- generator_folders/plain/public/html/home.html
+- generator_folders/plain/public/img/favicon.png
+- generator_folders/plain/public/img/jumbotron.jpg
+- generator_folders/spa/.DS_Store
+- generator_folders/spa/.ruby-version
+- generator_folders/spa/Gemfile
+- generator_folders/spa/Gemfile.lock
+- generator_folders/spa/config.ru
+- generator_folders/spa/db/database.sqlite3
+- generator_folders/spa/db/seed.rb
+- generator_folders/spa/public/.DS_Store
+- generator_folders/spa/public/css/styles.css
+- generator_folders/spa/public/html/index.html
+- generator_folders/spa/public/img/favicon.png
+- generator_folders/spa/public/img/jumbotron.jpg
+- generator_folders/spa/public/js/another-component.js
+- generator_folders/spa/public/js/app.js
+- lib/rhail.rb
+- lib/rhail/generator.rb
+- lib/rhail/helper.rb
+- lib/rhail/main.rb
+- rhail.gemspec
+homepage: https://github.com/E-Xor/rhail
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\n  \e[32mUSAGE: rhail generate <plain|json|spa> [folder]\e[0m\n\n"
+rdoc_options:
+- "-m"
+- README.md
+- "-x"
+- "/generator_folders/.*|rhail.gemspec"
+- "--title"
+- Ruby Hail
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Bunch of generators and functions to make you up and running fast in Rack
+  web-app.
+test_files: []