traim 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f905b5beabf9f73c766a104fcf98618ff5849263
-  data.tar.gz: ab123a3a6068bd2a45e9ffd1acbff56e6f22ee99
+  metadata.gz: ece137da93d77a125ef001c07c3d259e5ccb0128
+  data.tar.gz: dd4af9b6a0c3078182eaeb210c20faf17d427592
 SHA512:
-  metadata.gz: 615d1dff8a603429d0f8e19259ef416fe838bf611ee94a3c40d6dc885300cf1c0a5b02393627163a39d6dfb5586dc5846fe8b09e19504e3aaa4d1078552058a5
-  data.tar.gz: ffbe8f31ef7893f9463a8b03328bbcdc45d1471853b30243b8a5a90efe3d9a83011a899229450699a92d60f223168d0ed07242a3d4ea03e97c344c293a9ceb52
+  metadata.gz: a93dbdabe1d31e39e4b687de31e09d193e7b88f3e16f9a3283b5c7e8d55ec14bf19f96d0869cd18681d233eacdc7debb710a3bd2f2a38e396ac82e9e04452f34
+  data.tar.gz: 19dad77694405744df974cb015b5346f24bbf2a79b76af75b02655c2c038946a89c4ed3e44b6ddeb49dd4fb0bf1b4338b6f6445e3a22847fffbfe63667ccc63d

data/README.md

@@ -69,8 +69,8 @@ Traim.application do
     attribute :id
     attribute :name
 
-    action :show do |params|
-      user = model.find_by_email params["payload"]["email"]
+    action :show do
+      user = model.find_by_email params["email"]
       user.name = "[admin] #{user.name}"
       user
     end
@@ -140,7 +140,7 @@ Traim.application do
     member :blurred do
 
       # GET /users/1/blurred
-      show do |params|
+      show do
         record.name[1..2] = 'xx'
         record
       end
@@ -162,13 +162,13 @@ Traim.application do
     collection :admin do
 
       # GET /users/admin
-      show do |params|
+      show do
         model.all
       end
 
       # POST /users/admin
-      create do |params|
-        model.create(params["payload"])
+      create do
+        model.create(params)
       end
     end
   end
@@ -223,10 +223,9 @@ Traim.application do
     attribute :id
     attribute :name
 
-    action :show do |params|
+    action :show do
       auth(params["id"])
-      model.find params["id"]
-      user
+      record
     end
   end
 end

data/lib/traim.rb

@@ -78,6 +78,11 @@ class Traim
       app = @applications[name] ||= Application.new(name)
     end
 
+    def show(&block);    @resource.action(:show,  &block) end
+    def create(&block);  @resource.action(:create,  &block) end
+    def update(&block);  @resource.action(:update,  &block) end
+    def destory(&block); @resource.action(:destory, &block) end
+
     def helpers(&block)
       @helpers_block = block
     end
@@ -91,124 +96,44 @@ class Traim
       if app = @applications[segment]
         app.route(request, seg)
       else 
-        router = Router.new(@resources)
-        router.instance_eval(&@helpers_block) unless @helpers_block.nil?
-        router.run(seg, inbox)
-        router.render(request)
+        model = run(seg, inbox, request)
+        render(request, model)
       end
     end
 
-    def compile(&block)
-      logger.debug("Compile application: #{@name}")
-      instance_eval(&block)
-    end
-  end
-
-  class Error < StandardError
-
-    def initialize(options = {})
-      @message = options[:message] || error_message 
-      @body    = options[:body]    || error_message
-      super(@message)
-    end
-
-    def status; 500 end
-    def error_message; 'Internal Server Error' end
-    def header; DEFAULT_HEADER end
-    def body; {message: @body} end
-  end
-  class NotImplementedError < Error
-    def error_message; "Not Implemented Error" end
-    def status; 501 end
-  end
-  class BadRequestError < Error
-    def error_message; "Bad Request Error" end
-    def status; 400 end
-  end
-  class NotFoundError < Error
-    def error_message; "Not Found Error" end
-    def status; 404 end
-  end
-   
-  class Router
-
-    def status; @status || ok end
-    def logger; Traim.logger  end 
-
-    # status code sytax suger
-    def ok;        @status = 200 end
-    def created;   @status = 201 end
-    def no_cotent; @status = 204 end
-
-    def headers(key, value)
-      @headers[key] = value 
-    end
-
-    def initialize(resources) 
-      @status    = nil
-      @resources = resources
-      @headers   = {}
-    end
-
-    def self.resources; @resources ||= {} end
-
-    def resources(name)
-      @resources[name]
-    end
-
-    def show(&block);    @resource.action(:show,    &block) end
-    def create(&block);  @resource.action(:create,  &block) end
-    def update(&block);  @resource.action(:update,  &block) end
-    def destory(&block); @resource.action(:destory, &block) end
-
-    def run(seg, inbox)  
+    def run(seg, inbox, request) 
+      model = nil 
       begin
         segment = inbox[:segment].to_sym
 
-        if @resource.nil?
-          raise BadRequestError unless @resource = resources(segment)
+        if model.nil?
+          raise BadRequestError unless @resource = @resources[segment]
+          model = Model.new(@resource.model, request) 
           next
         end 
 
-        if @id.nil? && !defined?(@collection_name)
+        if model.id.nil?
           if collection = @resource.collections[segment]
-            @collection_name = segment
-            return instance_eval(&collection)
+            instance_eval(&collection)
+            break
           else
-            @id = segment.to_s.to_i
-            @record = @resource.model_delegator.show(@id)
+            model.id = segment.to_s.to_i
             next 
           end
         end
 
-        if !defined?(@member_name)
-          if member = @resource.members[segment]
-            @member_name = segment
-            return instance_eval(&member)
-          end
+        if member = @resource.members[segment]
+          instance_eval(&member)
+          break
         end
 
         raise BadRequestError 
       end while seg.capture(:segment, inbox) 
+
+      model.instance_eval(&@helpers_block)  unless @helpers_block.nil?
+      model
     end
     
-    def to_json
-      if @result.kind_of?(ActiveRecord::Relation)
-        hash = @result.map do |object|
-          @resource.to_hash(object, @resources) 
-        end
-        JSON.dump(hash)
-      else
-        new_hash = {}
-        if @result.errors.size == 0
-          new_hash = @resource.to_hash(@result, @resources)
-        else
-          new_hash = @result.errors.messages
-        end
-        JSON.dump(new_hash)
-      end
-    end
-
     def action(name)
       raise NotImplementedError unless action = @resource.actions[name] 
 
@@ -219,43 +144,89 @@ class Traim
     def default_actions
       @default_actions ||= begin 
         actions = {}
-        delegator = @resource.model_delegator
-        actions["POST"] = lambda do |params|
-          delegator.create(params["payload"])
+        actions["POST"] = lambda do 
+          create(params)
         end
-        actions["GET"] = lambda do |params|
-          delegator.show(params["id"])
+        actions["GET"] = lambda do 
+          show(id)
         end
-        actions["PUT"] = lambda do |params|
-          result = delegator.update(params["id"], params["payload"])
+        actions["PUT"] = lambda do 
+          result = update(id, params)
           result
         end
-        actions["DELETE"] = lambda do |params|
-          delegator.delete(@id)
+        actions["DELETE"] = lambda do 
+          delete(id)
         end
         actions
       end
     end
 
-    def model;  @resource.model end
-    def record; @record; end
+    def to_json(resources, model)
+      if @result.kind_of?(ActiveRecord::Relation)
+        hash = @result.map do |object|
+          @resource.to_hash(object, resources, model) 
+        end
+        JSON.dump(hash)
+      else
+        new_hash = {}
+        if @result.errors.size == 0
+          new_hash = @resource.to_hash(@result, resources, model)
+        else
+          new_hash = @result.errors.messages
+        end
+        JSON.dump(new_hash)
+      end
+    end
 
-    def render(request)
+    def render(request, model)
       method_block = action(request.request_method)
-      payload = request.params
+
       if (method_block[:options][:permit])
-        if not_permmited_payload = payload.detect { |key, value| !method_block[:options][:permit].include?(key) }  
+        if not_permmited_payload = request.params.detect { |key, value| !method_block[:options][:permit].include?(key) }  
           raise BadRequestError.new(message: "Not permitted payload: #{not_permmited_payload}") 
         end
       end
-      params = {"payload" => payload}
-      params["id"] = @id unless @id.nil?
-      @result = @resource.execute(params, &method_block[:block])
 
-      [status, @headers, [to_json]]
+      model.params = request.params 
+      @result = model.instance_eval(&method_block[:block])
+      [model.status, model.headers, [to_json(@resources, model)]]
+    end
+
+    def compile(&block)
+      logger.debug("Compile application: #{@name}")
+      instance_eval(&block)
     end
   end
 
+  class Error < StandardError
+    def initialize(options = {})
+      @message = options[:message] || error_message 
+      @body    = options[:body]    || error_message
+      super(@message)
+    end
+
+    def status; 500 end
+    def error_message; 'Internal Server Error' end
+    def header; DEFAULT_HEADER end
+    def body; {message: @body} end
+  end
+  class NotImplementedError < Error
+    def error_message; "Not Implemented Error" end
+    def status; 501 end
+  end
+  class BadRequestError < Error
+    def error_message; "Bad Request Error" end
+    def status; 400 end
+  end
+  class ForbiddenError < Error
+    def error_message; "Forbidden Error" end
+    def status; 403 end
+  end
+  class NotFoundError < Error
+    def error_message; "Not Found Error" end
+    def status; 404 end
+  end
+
   class Resource 
     ACTION_METHODS = {create: 'POST', show: 'GET', update: 'PUT', destory: 'DELETE'}
 
@@ -264,19 +235,11 @@ class Traim
       instance_eval(&block) 
     end
 
-    def execute(params, &block)
-      yield params
-    end
-
     def model(object = nil, options = {})
       @model = object unless object.nil? 
       @model
     end
 
-    def model_delegator
-      @model_delegator ||= Model.new(model)
-    end
-
     def actions; @actions ||= {} end
     def action(name, options = {}, &block)
       actions[ACTION_METHODS[name]] = {block: block, options: options}
@@ -314,7 +277,7 @@ class Traim
       fields << {name: name, type: 'connection'}
     end
 
-    def to_hash(object, resources, nested_associations = []) 
+    def to_hash(object, resources, model, nested_associations = []) 
       return if object.nil?
 
       fields.inject({}) do | hash, attr|
@@ -323,20 +286,20 @@ class Traim
           if attr[:block].nil?
             object.attributes[name.to_s]
           else
-            execute(object, &attr[:block])
+            model.instance_exec(object, &attr[:block])
           end
         elsif  attr[:type] == 'association'
           raise Error if nested_associations.include?(name)
           nested_associations << name
           object.send(name).map do |association|
-            resources[name].to_hash(association, resources, nested_associations.dup) 
+            resources[name].to_hash(association, resources, model, nested_associations.dup) 
           end
         else
           resource_name = name.to_s.pluralize.to_sym
           raise Error.new(message: "Inifinite Association") if nested_associations.include?(resource_name)
           raise Error if object.class.reflections[name.to_s].blank?
           nested_associations << resource_name 
-          resources[resource_name].to_hash(object.send(name), resources, nested_associations.dup)
+          resources[resource_name].to_hash(object.send(name), resources, model, nested_associations.dup)
         end
         hash
       end
@@ -345,10 +308,39 @@ class Traim
 
   class Model
 
-    def initialize(model)
-      @model = model 
+    def initialize(model, request = nil)
+      @model   = model 
+      @request = request
+      @headers = {}
+      ok
+    end
+
+    attr_accessor :id
+    attr_accessor :model
+    attr_accessor :record
+    attr_accessor :params
+    attr_accessor :request
+    attr_accessor :status
+
+    def logger; Traim.logger  end 
+
+    # status code sytax suger
+    def ok;        @status = 200 end
+    def created;   @status = 201 end
+    def no_cotent; @status = 204 end
+
+    def instance_record(id)
+      @id     = id
+      @record = show(@id)
     end
 
+    def headers(key = nil, value = nil)
+      return @headers if key.nil?
+      @headers[key] = value 
+    end
+
+    def record; @record ||= show(id) end
+
     def create(params)
       resource = @model.new(params)
       resource.save

data/test/resource.rb

@@ -3,7 +3,7 @@ require_relative "../lib/traim"
 
 Traim.config do |app| 
   app.logger = Logger.new(STDOUT)
-  app.logger.level = Logger::DEBUG
+  app.logger.level = Logger::INFO
 end
 
 class User < ActiveRecord::Base 
@@ -73,10 +73,9 @@ test "customize functionality" do |user|
       attribute :id
       attribute :name
 
-      action :show do |params|
-        user = model.find params["id"]
-        user.name = "[admin] #{user.name}"
-        user
+      action :show do 
+        record.name = "[admin] #{record.name}"
+        record 
       end
     end
   end
@@ -95,19 +94,20 @@ test "member create, read, update and destory functionality" do |user|
       attribute :name
 
       member :blurred do 
-        show do |params|
+        show do 
           logger.info("show blurred")
+          logger.info("class #{self.class.name}")
           record.name[1..2] = "xx" 
           record 
         end
 
-        update do |params|
-          record.assign_attributes(params["payload"])
+        update do 
+          record.assign_attributes(params)
           record.save
           record 
         end
 
-       destory do |params|
+       destory do 
           record.delete
         end
       end 
@@ -138,12 +138,12 @@ test "collection create, read, update and destory functionality" do |user|
       attribute :name
 
       collection :admin do
-        show do |params|
+        show do 
           model.all
         end
 
-        create do |params|
-          model.create(params["payload"])
+        create do 
+          model.create(params)
         end
       end
     end
@@ -193,13 +193,13 @@ test "has many functionality" do |user|
       action :show
 
       collection :admin do
-        show do |params|
+        show do 
           model.all
         end
 
-        create do |params|
+        create do 
           # what to response?   
-          model.create(params["payload"])
+          model.create(params)
         end
       end
     end
@@ -322,19 +322,19 @@ test "helpers functionality" do |user|
       attribute :name
 
       member :blurred do 
-        show do |params|
+        show do
           auth('test')
           record.name[1..2] = "xx" 
           record 
         end
 
-        update do |params|
-          record.assign_attributes(params["payload"])
+        update do
+          record.assign_attributes(params)
           record.save
           record 
         end
 
-       destory do |params|
+       destory do
           record.delete
         end
       end 
@@ -362,7 +362,7 @@ test "headers functionality" do |user|
       attribute :name
 
       member :headers do 
-        show do |params|
+        show do 
           headers("test", "yeah")
           record 
         end

data/traim.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "traim"
-  s.version = "0.1.3"
+  s.version = "0.2.0"
   s.summary = %{Resource-oriented microframework for RESTful API}
   s.description = %Q{Resource-oriented microframework for RESTful API}
   s.authors = ["Travis Liu"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traim
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Travis Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack