traim 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a3cd06341db0633e95bded7bd7e6a45a5348511
-  data.tar.gz: 3ab56f6e5470c5fe0cb5693619a8251be0f3bf0c
+  metadata.gz: f905b5beabf9f73c766a104fcf98618ff5849263
+  data.tar.gz: ab123a3a6068bd2a45e9ffd1acbff56e6f22ee99
 SHA512:
-  metadata.gz: a1d83bcf7a6c86db7f0d61ee147d1bcfebe3d4f913361443aca879d679b46cd3f7838cbcf1d6d84aa860c16c21f009afd6dda120fb5c544c8a26b93c9c1b38bc
-  data.tar.gz: f7afe6353577ad2ac32e698bd7d4cc6584ac4110bf80ac5c86b1bbd94584bfaaea04e9aa9482e3881278d60b960ceb6495c9545f7f55a08f177f467ead290f5a
+  metadata.gz: 615d1dff8a603429d0f8e19259ef416fe838bf611ee94a3c40d6dc885300cf1c0a5b02393627163a39d6dfb5586dc5846fe8b09e19504e3aaa4d1078552058a5
+  data.tar.gz: ffbe8f31ef7893f9463a8b03328bbcdc45d1471853b30243b8a5a90efe3d9a83011a899229450699a92d60f223168d0ed07242a3d4ea03e97c344c293a9ceb52

data/README.md

@@ -1,12 +1,12 @@
 # Traim
 
-Traim is a microframework for Building a RESTful API service from your existing ActiveRecord models.
+Traim is a microframework for building a RESTful API service from your existing Active Record models.
 
 ## Getting started
 
 ### Installation
 ``` ruby
-gem install train
+gem install traim
 ```
 
 ### Usage
@@ -21,7 +21,7 @@ end
 class User < ActiveRecord::Base
 end
 
-Train.application do
+Traim.application do
   resource :users do
     # Inject user model
     model User
@@ -40,11 +40,11 @@ Train.application do
     action :update
 
     # DELETE /users/:id
-    action :destory
+    action :destroy
   end
 end
 ```
-put your activerecord config in
+Put your Active Record configuration in
 ` config/database.yml `
 
 To run it, you can create a config.ru file
@@ -57,10 +57,10 @@ run Traim
 
 Then run `rackup`.
 
-Now, you already get basic CURD RESTful API from the user ActiveRecord model.
+Now, you already get a basic CRUD RESTful API from the User ActiveRecord model.
 
 ## Customizable action
-By default, `action` can be easily used to create an endpoint for CRUD operations. you can write your own endpoint as well.
+By default, `action` can be easily used to create an endpoint for CRUD operations. You can write your own endpoint as well.
 ``` ruby
 Traim.application do
   resources :users do
@@ -84,7 +84,7 @@ Response
 ```
 
 ## Associations
-create nestea json reponse with activerecord association
+Create a nested JSON reponse with an Active Record association
 ``` ruby
 class User < ActiveRecord::Base
   has_many :books
@@ -118,7 +118,7 @@ Response
 ``` json
 {
   "id": 1,
-  "name": "travis"
+  "name": "travis",
   "books": [
     {"isbn": "978-1-61-729109-8"},
     {"isbn": "561-6-28-209847-7"},
@@ -232,7 +232,7 @@ Traim.application do
 end
 ```
 
-## Visual attributes
+## Virtual attributes
 Built-in attribute is generate response fields from model. Visual can help you present fields outside of model attributes. 
 ``` ruby
 Traim.application do

data/lib/traim.rb

@@ -314,7 +314,9 @@ class Traim
       fields << {name: name, type: 'connection'}
     end
 
-    def to_hash(object, resources, nest_associations = []) 
+    def to_hash(object, resources, nested_associations = []) 
+      return if object.nil?
+
       fields.inject({}) do | hash, attr|
         name = attr[:name]
         hash[name] = if attr[:type] == 'attribute'
@@ -324,18 +326,17 @@ class Traim
             execute(object, &attr[:block])
           end
         elsif  attr[:type] == 'association'
-          raise Error if nest_associations.include?(name)
-          raise Error if object.class.reflections[name.to_s].blank?
-          nest_associations << name
+          raise Error if nested_associations.include?(name)
+          nested_associations << name
           object.send(name).map do |association|
-            resources[name].to_hash(association, nest_associations) 
+            resources[name].to_hash(association, resources, nested_associations.dup) 
           end
         else
           resource_name = name.to_s.pluralize.to_sym
-          raise Error.new(message: "Inifinite Association") if nest_associations.include?(resource_name)
+          raise Error.new(message: "Inifinite Association") if nested_associations.include?(resource_name)
           raise Error if object.class.reflections[name.to_s].blank?
-          nest_associations << resource_name 
-          resources[resource_name].to_hash(object.send(name), nest_associations)
+          nested_associations << resource_name 
+          resources[resource_name].to_hash(object.send(name), resources, nested_associations.dup)
         end
         hash
       end

data/traim.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "traim"
-  s.version = "0.1.2"
+  s.version = "0.1.3"
   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.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Travis Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-22 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack