genki 0.1.0.beta1 → 0.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00a55d670e65a428c6e1c35b237585bfda9b3ab6
-  data.tar.gz: 9c651d223273e9d3ea783f0731aff5a7fea0e643
+  metadata.gz: cf3e4aa7266f53faf1b6413a3f893f50929cb2a8
+  data.tar.gz: 2077f807cdd492edc7b7c0b4fb57c66b3acc0c7b
 SHA512:
-  metadata.gz: 7781178a2c90815a311eb742ac31b402fe85dc542acdd4198f117c347cccf2bb773159c8e509a6ddb6123810609ff0d56b01f7a8a1d7c2da8cba9e4bafb563c8
-  data.tar.gz: 93434de97688da2d78482d1c7b8810792d468593582d1542dc43fcb954b1328733dce24067dd7ea45929c691c9fbf0c43e60bfdf0c53566147a7a451c6d76b98
+  metadata.gz: a1313133aae4be8b691957634d2f6bae09050697da2b17eb5653dfbfcdedb54204eddd180f1fbc29822bccead51f6e505809a296d630c75de9bec03990b547de
+  data.tar.gz: 190e996f028e7c2cc0eb84a70f660f42b55793b18d2ddfd7ad0376c2b6d47fe90796d7980d514f6df82425691ca2d39311128373540ed7e9b1acbde4b9e61c1d

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--order random

data/.rubocop.yml

@@ -1,7 +1,7 @@
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 90
+  Max: 120
   Exclude:
     - 'spec/**/*'
     - './genki.gemspec'
@@ -9,3 +9,8 @@ Metrics/LineLength:
 Lint/Eval:
   Exclude:
     - 'spec/support/capture.rb'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/genki.rb'

data/.travis.yml

@@ -9,3 +9,7 @@ matrix:
     - rvm: ruby-head
   fast_finish: true
 before_install: gem install bundler -v 1.11.2
+notifications:
+  email: false
+  slack:
+    secure: eGCFU2I8/LIeCuo6cWBatBoLwL8+eDRlcJJH194pMr12S4qkE7mDMeaRUhMvxruZGo/mzvbKzXBJ9SXo8Yyaa4q7DlRH8c4MijIE2VcCNNYeEDp1VC4su/alpEWtxatXNXlc+ZiRAFRvCADjrPXLmeFPhCP20nlfNrX8z6z8Iew/Jzh07GWyyXNIIz83lw/O6PFHNWudEugYpnQf1Z8QnIC18o2l5JKEJIa6W++EJ9Wi9MCBHVQdTNodb4TLVdbKJDtZxUOdTzkPblEVjnFTZQUhuX+NzwVxTdlyonUPypBGqFEhjTbYuxHQawRkfRM1QlLewynvzo+QR2D03EX5tKyqDuUmd4ISoNuKNmXxHuEYLDJJcLiJaL7oae02CYZe3Oayw0AYrhZBWKyfiMN7eFeQN4IG05ox0z1zJ3hy/Il/uWUIuQUp1ai2DnSqnG+fOwV9ivrv1YDA4XX3EIA3FxbU8EsZc9aQBIzIFFrBzwO2u0+Yy/M465n5/EL6R/FA6xIrKmNqcV7ZuXUdfqpsxtA82AG4M1mFps5UVs8roSFfe0nTPPHtL5NANmUbM5TuJS9ZbtOmClRf6jNAiTn9N2iAe9U2SL8b9MKJZTlvReNN6mt21DogKpsvas6uOIhigEu4m07iqtc89gyzWP8RPwM8EZhpr2nsAOMOtSHRPP0=

data/README.md

@@ -1,32 +1,52 @@
 # Genki
 
+[![Gem Version](https://badge.fury.io/rb/genki.svg)](https://badge.fury.io/rb/genki)
+
 [![Build Status](https://travis-ci.org/genkirb/genki.svg?branch=master)](https://travis-ci.org/genkirb/genki)
 [![Code Climate](https://codeclimate.com/github/genkirb/genki/badges/gpa.svg)](https://codeclimate.com/github/genkirb/genki)
 [![Test Coverage](https://codeclimate.com/github/genkirb/genki/badges/coverage.svg)](https://codeclimate.com/github/genkirb/genki/coverage)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/genki`. To experiment with that code, run `bin/console` for an interactive prompt.
+A fast and minimalist framework to generate APIs in Ruby.
 
-TODO: Delete this and the text above, and describe your gem
+Genki is a full-stack framework optimized for quick and easy creation of beautiful APIs.
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+1. Install Genki:
 
-```ruby
-gem 'genki'
-```
+        $ gem install genki --pre
 
-And then execute:
+  You only need `--pre`  while we are in beta.
 
-    $ bundle
+2. Create a new Genki application:
 
-Or install it yourself as:
+        $ genki new app
 
-    $ gem install genki
+3. Change directory to `app` and start the server:
 
-## Usage
+        $ cd app
+        $ genki server
+
+You may run `genki help` for more information on the available commands.
 
-TODO: Write usage instructions here
+### Controllers
+
+Genki uses controllers to process requests. It differs from `rails`, as we don't enforce any directory structure (except having your files inside an `app` folder), and from `sinatra`, since we have a controller super class that should be inherited from.
+
+To handle your requests you can simply create a class that inherits from `Genki::Controller` and place it inside `app` folder and it will start processing the matching ones.
+
+As per the following example:
+
+```ruby
+# app/home.rb
+class Home < Genki::Controller
+
+  get '/' do
+    #params will be available at `params`
+    render 'Hello World'
+  end
+end
+```
 
 ## Development
 
@@ -36,7 +56,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/genki. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/genkirb/genki. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/genki.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors       = ['Diego Silva', 'Leonardo Siqueira']
   s.email         = ['diego.silva@live.com', 'leonardo.prg@gmail.com']
 
-  s.summary       = 'Fast and minimalist framework to generate API\'s in ruby.'
-  s.description   = 'Genki is a full-stack framework optimized to create API\'s, quicly, easy and beatiful.'
+  s.summary       = 'A fast and minimalist framework to generate APIs in Ruby.'
+  s.description   = 'Genki is a full-stack framework optimized for quick and easy creation of beautiful APIs.'
   s.homepage      = 'https://github.com/genkirb/genki'
   s.license       = 'MIT'
 
@@ -23,8 +23,9 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rack', '~> 2.x'
   s.add_dependency 'thor', '~> 0.19.1'
+  s.add_dependency 'bundler', '~> 1.11'
 
-  s.add_development_dependency 'bundler', '~> 1.11'
+  s.add_development_dependency 'erubis', '>= 2.7.0', '< 3.0'
   s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rubocop', '~> 0.37'

data/lib/genki.rb

@@ -1,9 +1,19 @@
 require 'rack'
 require 'genki/version'
+require 'genki/utils/logger'
 require 'genki/cli'
-require 'genki/http/server'
+require 'genki/errors/route_already_defined_error'
+require 'genki/errors/route_not_found_error'
+require 'genki/http/application'
 require 'genki/http/router'
 require 'genki/http/route'
 require 'genki/http/controller'
 require 'genki/http/request'
 require 'genki/http/response'
+require 'genki/http/server'
+
+module Genki
+  class << self
+    attr_accessor :env
+  end
+end

data/lib/genki/cli.rb

@@ -1,5 +1,6 @@
 require 'thor'
 require 'genki/generators/app'
+require 'genki/http/server'
 
 module Genki
   #--
@@ -22,6 +23,20 @@ module Genki
       say "Genki #{Genki::VERSION}"
     end
 
+    desc 'server', 'Runs Genki server'
+    method_option :port, aliases: '-p', default: 3000, type: :numeric,
+                         banner: 'PORT', desc: 'Run the server on the specified port.'
+    method_option :binding, aliases: '-b', default: 'localhost', type: :string,
+                            banner: 'IP', desc: 'The IP to listen on.'
+    method_option :environment, aliases: '-e', default: 'development', type: :string,
+                                banner: 'name', desc: 'Specifies with environment to run'
+    def server
+      opt = { Port: options['port'],
+              Host: options['binding'],
+              environment: options['environment'] }
+      Genki::Server.new(opt).start
+    end
+
     register Generators::App, 'new', 'new APP_NAME', 'Create a new Genki application.'
     tasks['new'].options = Generators::App.class_options
   end

data/lib/genki/errors/route_already_defined_error.rb

@@ -0,0 +1,12 @@
+module Genki
+  #--
+  # Genki::RouteAlreadyDefinedError
+  #
+  # RouteAlreadyDefinedError class
+  #++
+  class RouteAlreadyDefinedError < StandardError
+    def initialize(route)
+      super("Trying to redefine already defined route '#{route}'.")
+    end
+  end
+end

data/lib/genki/errors/route_not_found_error.rb

@@ -0,0 +1,9 @@
+module Genki
+  #--
+  # Genki::RouteNotFoundError
+  #
+  # RouteNotFound error class
+  #++
+  class RouteNotFoundError < StandardError
+  end
+end

data/lib/genki/generators/app.rb

@@ -36,6 +36,11 @@ module Genki
         template 'Gemfile'
       end
 
+      def create_sample
+        empty_directory 'app'
+        template 'app/home.rb'
+      end
+
       def run_bundle
         inside do
           Bundler.with_clean_env { run 'bundle' }

data/lib/genki/generators/app/files/app/home.rb.tt

@@ -0,0 +1,6 @@
+class Home < Genki::Controller
+
+  get '/' do
+    render({ message: 'Hello World from <%= app_name %>' })
+  end
+end

data/lib/genki/generators/app/files/config.ru

@@ -1,4 +1,3 @@
 require 'genki'
-Dir['./**/*.rb'].each { |file| require file }
-app = Genki::Server.new
+app = Genki::Application.new
 run app

data/lib/genki/http/application.rb

@@ -0,0 +1,28 @@
+require 'bundler/setup'
+
+module Genki
+  #--
+  # Genki::Application
+  #
+  # APPLICATION CLASS
+  #++
+  class Application
+    def initialize
+      Bundler.require(:default, Genki.env)
+      Dir['./app/**/*.rb'].each { |file| require file }
+    end
+
+    def call(env)
+      Request.current = Request.new(env)
+
+      response = Router.instance.process
+    rescue RouteNotFoundError
+      response = Response.new('', 404)
+    rescue StandardError => e
+      Logger.error(e)
+      response = Response.new('', 500)
+    ensure
+      response.finish
+    end
+  end
+end

data/lib/genki/http/controller.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Genki
   #--
   # Genki::Controller
@@ -5,32 +7,84 @@ module Genki
   # CONTROLLER CLASS
   #++
   class Controller
+    def self.namespace(path, &block)
+      @namespace ||= []
+      @namespace << path
+
+      instance_eval(&block)
+
+      @namespace = nil
+    end
+
     def self.get(path, &block)
-      Router.instance.route(Route.new(:GET, path), &block)
+      Router.instance.route('GET', Route.new((@namespace || []).push(path).join, &block))
     end
 
     def self.post(path, &block)
-      Router.instance.route(Route.new(:POST, path), &block)
+      Router.instance.route('POST', Route.new((@namespace || []).push(path).join, &block))
     end
 
     def self.put(path, &block)
-      Router.instance.route(Route.new(:PUT, path), &block)
+      Router.instance.route('PUT', Route.new((@namespace || []).push(path).join, &block))
     end
 
     def self.delete(path, &block)
-      Router.instance.route(Route.new(:DELETE, path), &block)
+      Router.instance.route('DELETE', Route.new((@namespace || []).push(path).join, &block))
+    end
+
+    def self.options(path, &block)
+      Router.instance.route('OPTIONS', Route.new((@namespace || []).push(path).join, &block))
+    end
+
+    def self.patch(path, &block)
+      Router.instance.route('PATCH', Route.new((@namespace || []).push(path).join, &block))
+    end
+
+    def render(json: nil, erb: nil, headers: {}, status: 200)
+      body = render_json(json, headers) || render_erb(erb, headers) || ''
+
+      response = Response.new(body, status, headers)
+      cookies.each do |key, value|
+        response.set_cookie(key, value) if cookie_changed?(key, value)
+      end
+      response
     end
 
-    def self.render(body, status = 200, header = [])
-      Response.new(body, status, header)
+    def request
+      Request.current
     end
 
-    def self.request
-      Thread.current[:request]
+    def params
+      Request.current.params
+    end
+
+    def cookies
+      @_cookies ||= request.cookies.dup
+    end
+
+    private
+
+    def render_json(json, headers)
+      return if json.nil?
+
+      headers['content-type'] ||= 'application/json'
+      JSON.dump(json)
+    end
+
+    def render_erb(view, headers)
+      return if view.nil?
+
+      require 'erubis'
+      file = File.expand_path(view, './app/views')
+      headers['content-type'] ||= 'text/html'
+
+      context = instance_variables.map { |var| [var[1..-1], instance_variable_get(var)] }.to_h
+
+      Erubis::Eruby.new(File.read(file)).evaluate(context)
     end
 
-    def self.params
-      request.params
+    def cookie_changed?(key, value)
+      request.cookies[key] != value
     end
   end
 end

data/lib/genki/http/request.rb

@@ -5,11 +5,16 @@ module Genki
   # REQUEST CLASS
   #++
   class Request < Rack::Request
-    attr_reader :route
+    def self.current=(request)
+      Thread.current[:request] = request
+    end
+
+    def self.current
+      Thread.current[:request]
+    end
 
-    def initialize(env)
-      super(env)
-      @route = Route.new(env['REQUEST_METHOD'], env['PATH_INFO'])
+    def json_data?
+      media_type == 'application/json'
     end
   end
 end

data/lib/genki/http/route.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Genki
   #--
   # Genki::Route
@@ -5,10 +7,53 @@ module Genki
   # ROUTE CLASS
   #++
   class Route
-    attr_reader :signature
+    attr_reader :path
+
+    def initialize(path, &block)
+      @path = path
+      @params = path.scan(/:[a-z_]+/)
+      @path_regex = '^'.concat(path.gsub(/:[a-z_]+/, '([a-z0-9]+)')).concat('/?$')
+      @action = block
+    end
+
+    def match?(current_path)
+      @parsed_path = current_path.match(@path_regex).to_a[1..-1]
+    end
+
+    def process
+      process_params
+
+      klass = @action.binding.receiver
+      controller = klass.new
+
+      Logger.info("Request processed by #{klass}")
+
+      controller.instance_eval(&@action)
+    end
+
+    def ==(other)
+      other.is_a?(Route) && @path_regex == other.path_regex
+    end
+
+    protected
+
+    attr_reader :path_regex
+
+    private
+
+    def process_params
+      params = {}
+
+      @params.each_with_index do |param, index|
+        params[param[1..-1]] = @parsed_path[index]
+      end
+
+      if Request.current.json_data?
+        raw_data = Request.current.env['rack.input'].read
+        params.merge!(JSON.parse(raw_data))
+      end
 
-    def initialize(verb, path)
-      @signature = "#{verb}#{path}"
+      Request.current.params.merge!(params)
     end
   end
 end

data/lib/genki/http/router.rb

@@ -13,16 +13,25 @@ module Genki
       @routes = {}
     end
 
-    def route(route, &block)
-      @routes[route.signature] = block
+    def route(method, route)
+      @routes[method] ||= []
+      raise RouteAlreadyDefinedError, "#{method} #{route.path}" if @routes[method].include? route
+      @routes[method] << route
     end
 
-    def process(request)
-      Thread.current[:request] = request
+    def process
+      current_route = nil
 
-      action = @routes[request.route.signature]
-      return Response.new 'Not Found', 404 unless action
-      action.call
+      if @routes[Request.current.request_method]
+        @routes[Request.current.request_method].each do |route|
+          current_route = route.match?(Request.current.path) ? route : nil
+          break if current_route
+        end
+      end
+
+      raise RouteNotFoundError unless current_route
+
+      current_route.process
     end
   end
 end

data/lib/genki/http/server.rb

@@ -1,14 +1,23 @@
+require 'genki'
+require 'rack'
+
 module Genki
   #--
   # Genki::Server
   #
   # SERVER CLASS
   #++
-  class Server
-    def call(env)
-      response = Router.instance.process(Request.new(env))
+  class Server < Rack::Server
+    def initialize(options = {})
+      options = default_options.merge(options)
+      Genki.env = options[:environment]
+      super
+    end
 
-      response.finish
+    def start
+      uri = "http://#{options[:Host]}:#{options[:Port]}"
+      puts "Genki application starting in #{options[:environment]} on #{uri}"
+      super
     end
   end
 end

data/lib/genki/utils/logger.rb

@@ -0,0 +1,23 @@
+require 'logger'
+require 'singleton'
+
+module Genki
+  #--
+  # Genki::Logger
+  #
+  # Logger class
+  #++
+  class Logger < ::Logger
+    include Singleton
+
+    def initialize
+      super(STDOUT, ::Logger::INFO)
+    end
+
+    class << self
+      ::Logger::Severity.constants.each do |level|
+        define_method(level.downcase) { |msg| Logger.instance.method(level.downcase).call(msg) }
+      end
+    end
+  end
+end

data/lib/genki/version.rb

@@ -1,3 +1,3 @@
 module Genki
-  VERSION = '0.1.0.beta1'.freeze
+  VERSION = '0.1.0.beta2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: genki
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0.beta2
 platform: ruby
 authors:
 - Diego Silva
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -46,13 +46,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -123,8 +143,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Genki is a full-stack framework optimized to create API's, quicly, easy
-  and beatiful.
+description: Genki is a full-stack framework optimized for quick and easy creation
+  of beautiful APIs.
 email:
 - diego.silva@live.com
 - leonardo.prg@gmail.com
@@ -144,20 +164,24 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- config.ru
 - exe/genki
 - genki.gemspec
 - lib/genki.rb
 - lib/genki/cli.rb
+- lib/genki/errors/route_already_defined_error.rb
+- lib/genki/errors/route_not_found_error.rb
 - lib/genki/generators/app.rb
 - lib/genki/generators/app/files/Gemfile.tt
+- lib/genki/generators/app/files/app/home.rb.tt
 - lib/genki/generators/app/files/config.ru
+- lib/genki/http/application.rb
 - lib/genki/http/controller.rb
 - lib/genki/http/request.rb
 - lib/genki/http/response.rb
 - lib/genki/http/route.rb
 - lib/genki/http/router.rb
 - lib/genki/http/server.rb
+- lib/genki/utils/logger.rb
 - lib/genki/version.rb
 homepage: https://github.com/genkirb/genki
 licenses:
@@ -179,8 +203,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
-summary: Fast and minimalist framework to generate API's in ruby.
+summary: A fast and minimalist framework to generate APIs in Ruby.
 test_files: []

data/config.ru

@@ -1,3 +0,0 @@
-require 'genki'
-app = Genki::Server.new
-run app