json-crud-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d29a60e6d78b872ce5373491643e567e2c6131d8
-  data.tar.gz: ec36f07906e2cb7c7fa18811b586c33331879ddf
+  metadata.gz: 4018cb35450e8da438cc7ff5bc87ec1b97deba51
+  data.tar.gz: 2c8b73bc85c0732e240e9e465fe76c814b3b9cbc
 SHA512:
-  metadata.gz: 58cb2c22a099f4898bf5ccea53481e7ee8e1ae625991f319603cc58e824058e17c232242f7b0715e02283004225b6b51ad09d64a061411b8ed03b02f09a5d7c7
-  data.tar.gz: 7e4112a6b627e591b1017a9ceed570f880dddf526e8589368e6eb1c544f7c92f824877a9e04df0634f40602f6e6a6254a5ed585dc1a0ba8d3a1d153dfc1e3164
+  metadata.gz: 8d94888ebcfe5da8fe37d14b642ce09e3e34dc1eba72325cda431f7134a244fa9821a2153217a6c810ed4dce0033fff8f3b1398e6c5eacce8a84c42cb1fc126c
+  data.tar.gz: 529751ff66be5745f916ebea5d75eeb63388ad210e32635ebfc24f2d272fc8f120a8b9a1d495dfa1060fadb1efb29db7001621c506a8f047b09c77230744e619

data/lib/json-crud-api.rb

@@ -1,3 +1,4 @@
+require "json-crud-api/presenter"
 require "json-crud-api/service"
 require "json-crud-api/crud"
 require "json-crud-api/api"

data/lib/json-crud-api/crud.rb

@@ -13,7 +13,7 @@ module JsonCrudApi
             entities = service.get_all
             fail_not_found if entities.nil?
 
-            JSON.fast_generate settings.presenters[key].render(entities)
+            JSON.fast_generate settings.presenters[key].render(entities, :get_all)
           end
         end
 
@@ -25,7 +25,7 @@ module JsonCrudApi
             entity = service.get(params["id"])
             fail_not_found if entity.nil?
 
-            JSON.fast_generate settings.presenters[key].render(entity)
+            JSON.fast_generate settings.presenters[key].render(entity, :get)
           end
         end
 
@@ -38,9 +38,9 @@ module JsonCrudApi
             service = settings.services[key]
             presenter = settings.presenters[key]
             fail_unauthorized 'create' unless service.user_authorized_for? :create
-            entity = service.create(presenter.parse(@payload))
+            entity = service.create(presenter.parse(@payload, :post))
 
-            JSON.fast_generate settings.presenters[key].render(entity)
+            JSON.fast_generate settings.presenters[key].render(entity, :post)
           end
         end
 
@@ -49,9 +49,9 @@ module JsonCrudApi
             service = settings.services[key]
             presenter = settings.presenters[key]
             fail_unauthorized 'update' unless service.user_authorized_for? :update
-            fail_not_found unless service.update(params["id"], presenter.parse(@payload))
+            fail_not_found unless service.update(params["id"], presenter.parse(@payload, :put))
             entity = service.get(params["id"])
-            JSON.fast_generate settings.presenters[key].render(entity)
+            JSON.fast_generate settings.presenters[key].render(entity, :put)
           end
         end
 

data/lib/json-crud-api/presenter.rb

@@ -0,0 +1,38 @@
+module JsonCrudApi
+  class Presenter
+
+    attr_accessor :model, :exclude
+
+    def initialize(options)
+      @model = options[:model]
+      @exclude = options[:exclude]
+
+      throw "Model must be defined" if @model.nil?
+    end
+
+    def render(data, operation = nil)
+      return data.map {|d| render(d, operation) } if data.is_a?(Array)
+
+      properties = @model.properties.map { |p| p.name.to_sym }
+      unless @exclude.nil? or @exclude[:render].nil? 
+        properties -= @exclude[:render][:all] unless @exclude[:render][:all].nil?
+        properties -= @exclude[:render][operation] unless @exclude[:render][operation].nil?
+      end
+
+      Hash[properties.map { |p| [p, data.send(p)] }]
+    end
+
+    def parse(data, operation = nil)
+      return data.map {|d| parse(d, operation) } if data.is_a?(Array)
+
+      properties = @model.properties.map { |p| p.name.to_sym }
+      unless @exclude.nil? or @exclude[:parse].nil? 
+        properties -= @exclude[:parse][:all] unless @exclude[:parse][:all].nil?
+        properties -= @exclude[:parse][operation] unless @exclude[:parse][operation].nil?
+      end
+
+      Hash[properties.map { |p| [p,data[p]] }]
+    end
+
+  end
+end

data/lib/json-crud-api/service.rb

@@ -3,11 +3,11 @@ require 'rubygems'
 module JsonCrudApi
   class Service
 
-    attr_accessor :log_service, :repo, :user, :scope_map, :user_scopes
+    attr_accessor :log_service, :model, :user, :scope_map, :user_scopes
 
     def initialize(options)
       @log_service = options[:log_service]
-      @repo = options[:repository]
+      @model = options[:model]
       @scope_map = options[:scope_map]
       @user = nil
       @user_scopes = nil
@@ -15,37 +15,37 @@ module JsonCrudApi
 
     # Create a record with the given attributes
     def create(params)
-      @repo.create(params)
+      @model.create(params)
     end
 
-    # Determine if a record with the given id exists
-    def exists?(id)
-      @repo.all(:id => id).count > 0
+    # Determine if a record with the given key exists
+    def exists?(key)
+      @model.all(@model.key.first.name => key).count > 0
     end
 
     # Get all records
     def get_all
-      @repo.all
+      @model.all
     end
 
-    # Get the first record with the given id
-    def get(id)
-      @repo.first(:id => id)
+    # Get the first record with the given key
+    def get(key)
+      @model.first(@model.key.first.name => key)
     end
 
-    # Update a record with the given id with the given attributes
+    # Update a record with the given key with the given attributes
     # Returns false if the record does not exist.
-    def update(id, params)
-      record = get(id)
+    def update(key, params)
+      record = get(key)
       return false if record.nil?
 
       record.update(params)
     end
 
-    # Delete a record with the given id
+    # Delete a record with the given key
     # Returns false if the record does not exist.
-    def delete(id)
-      record = get(id)
+    def delete(key)
+      record = get(key)
       return false if record.nil?
 
       record.destroy

data/spec/unit/presenter_spec.rb

@@ -0,0 +1,154 @@
+require "helper"
+
+describe JsonCrudApi::Presenter do
+  before(:each) do
+    @mock_model = double('model')
+
+    @presenter = JsonCrudApi::Presenter.new({
+      :model => @mock_model,
+    })
+  end
+
+  describe '#initialize' do
+    it 'should inject dependencies correctly' do
+      @presenter.model.should be @mock_model
+    end
+
+    it 'should throw an exception if model is not set' do
+    end
+  end
+
+  describe '#render' do
+    it 'should output a single property in data based on model properties' do
+      @mock_model.should_receive(:properties)
+        .and_return([OpenStruct.new(:name => :one)])
+      data = OpenStruct.new(:one => "Test")
+
+      @presenter.render(data).should eq({ :one => "Test" })
+    end
+
+    it 'should not return data properties that do not have model properties' do
+      @mock_model.should_receive(:properties)
+        .and_return([OpenStruct.new(:name => :one)])
+      data = OpenStruct.new(:one => "YES", :two => "OK")
+
+      @presenter.render(data).should eq({ :one => "YES" })
+    end
+
+    it 'should return nil for model properties that do not have data' do
+      @mock_model.should_receive(:properties)
+        .and_return([
+          OpenStruct.new(:name => :one),
+          OpenStruct.new(:name => :two),
+        ])
+      data = OpenStruct.new(:two => "OK")
+
+      @presenter.render(data).should eq({ :one => nil, :two => 'OK' })
+    end
+
+    it 'should call itself when supplied with an array and return an array of the results' do
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one)]
+      end
+      data = [OpenStruct.new(:one => "Test"), OpenStruct.new(:one => "TEST2")]
+
+      @presenter.render(data).should eq([{ :one => "Test" }, { :one => "TEST2" }])
+    end
+
+    it 'should exclude render:all properties' do
+      @presenter.exclude = { :render => { :all => [:one] } }
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one), OpenStruct.new(:name => :two)]
+      end
+      data = OpenStruct.new(:one => "Test",:two => "Two")
+
+      @presenter.render(data).should eq({ :two => "Two" }) 
+    end
+
+    it 'should exclude render:operation properties' do
+      @presenter.exclude = { :render => { :test => [:one] } }
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one), OpenStruct.new(:name => :two)]
+      end
+      data = OpenStruct.new(:one => "Test",:two => "Two")
+
+      @presenter.render(data, :test).should eq({ :two => "Two" }) 
+    end
+
+    it 'should exclude combinations of render:all and render:operation properties' do
+      @presenter.exclude = { :render => { :all => [:two] , :test => [:one] } }
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one), OpenStruct.new(:name => :two), OpenStruct.new(:name => :three)]
+      end
+      data = OpenStruct.new(:one => "Test",:two => "Two",:three => "Three")
+
+      @presenter.render(data, :test).should eq({ :three => "Three" }) 
+    end
+  end
+
+  describe '#parse' do
+    it 'should output a single property in data based on model properties' do
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one)]
+      end
+      data = { :one => 1 }
+      @presenter.parse(data).should eq({:one => 1})
+    end
+
+    it 'should not output properties of data that are not in model properties' do
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one)]
+      end
+      data = { :one => 1, :two => 2 }
+      @presenter.parse(data).should eq({:one => 1})
+    end
+
+    it 'should not output model properties with no data property' do
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one)]
+        [OpenStruct.new(:name => :two)]
+      end
+      data = { :two => 2 }
+      @presenter.parse(data).should eq({:two => 2})
+    end
+
+    it 'should call itself when supplied with an array and return an array of the results' do
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one)]
+      end
+      data = [{ :one => 1 }]
+
+      @presenter.parse(data).should eq([{ :one => 1 }])
+    end
+
+    it 'should exclude parse:all properties' do
+      @presenter.exclude = { :parse => { :all => [:one] } }
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one), OpenStruct.new(:name => :two)]
+      end
+      data = OpenStruct.new(:one => "Test",:two => "Two")
+
+      @presenter.parse(data).should eq({ :two => "Two" }) 
+    end
+
+    it 'should exclude parse:operation properties' do
+      @presenter.exclude = { :parse => { :test => [:one] } }
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one), OpenStruct.new(:name => :two)]
+      end
+      data = OpenStruct.new(:one => "Test",:two => "Two")
+
+      @presenter.parse(data, :test).should eq({ :two => "Two" }) 
+    end
+
+    it 'should exclude combinations of parse:all and parse:operation properties' do
+      @presenter.exclude = { :parse => { :all => [:two] , :test => [:one] } }
+      @mock_model.stub :properties do
+        [OpenStruct.new(:name => :one), OpenStruct.new(:name => :two), OpenStruct.new(:name => :three)]
+      end
+      data = OpenStruct.new(:one => "Test",:two => "Two",:three => "Three")
+
+      @presenter.parse(data, :test).should eq({ :three => "Three" }) 
+    end
+  end
+end

data/spec/unit/service_spec.rb

@@ -2,13 +2,13 @@ require "helper"
 
 describe JsonCrudApi::Service do
   before(:each) do
-    @mock_repo = double('repo')
+    @mock_model = double('model')
     @mock_log = double('Log')
     @mock_map = double('Map')
 
     @service = JsonCrudApi::Service.new({
       :log_service => @mock_log,
-      :repository => @mock_repo,
+      :model => @mock_model,
       :scope_map => @mock_map
     })
   end
@@ -16,7 +16,7 @@ describe JsonCrudApi::Service do
   describe '#initialize' do
     it 'should inject dependencies correctly' do
       @service.log_service.should be @mock_log
-      @service.repo.should be @mock_repo
+      @service.model.should be @mock_model
       @service.scope_map.should be @mock_map
     end
 
@@ -27,53 +27,63 @@ describe JsonCrudApi::Service do
   end
 
   describe '#create' do
-    it 'should call create on repo with params' do
+    it 'should call create on model with params' do
       params = { :one => 'one', :two => 'two' }
-      @mock_repo.should_receive(:create).with(params).and_return(2)
+      @mock_model.should_receive(:create).with(params).and_return(2)
       @service.create(params).should eq 2
     end
   end
 
   describe '#exists?' do
-    it 'should call all on repo with correct id' do
+    it 'should call all on model with correct id' do
       query_object = OpenStruct.new :count => 1
-      @mock_repo.should_receive(:all).with(:id => 3)
+      @mock_model.should_receive(:key)
+        .and_return(OpenStruct.new(:first => OpenStruct.new(:name => :id)))
+      @mock_model.should_receive(:all).with(:id => 3)
         .and_return(query_object)
       @service.exists?(3).should eq true
     end
 
     it 'should return false when count is zero' do
       query_object = OpenStruct.new :count => 0
-      @mock_repo.should_receive(:all).with(:id => 3)
+      @mock_model.should_receive(:key)
+        .and_return(OpenStruct.new(:first => OpenStruct.new(:name => :id)))
+      @mock_model.should_receive(:all).with(:id => 3)
         .and_return(query_object)
       @service.exists?(3).should eq false
     end
 
     it 'should return true when count is one' do
       query_object = OpenStruct.new :count => 1
-      @mock_repo.should_receive(:all).with(:id => 3)
+      @mock_model.should_receive(:key)
+        .and_return(OpenStruct.new(:first => OpenStruct.new(:name => :id)))
+      @mock_model.should_receive(:all).with(:id => 3)
         .and_return(query_object)
       @service.exists?(3).should eq true
     end
 
     it 'should return true when count is more than one' do
       query_object = OpenStruct.new :count => 2
-      @mock_repo.should_receive(:all).with(:id => 3)
-        .and_return(query_object)
+      @mock_model.should_receive(:key)
+        .and_return(OpenStruct.new(:first => OpenStruct.new(:name => :id)))
+      @mock_model.should_receive(:all).with(:id => 3)
+      .and_return(query_object)
       @service.exists?(3).should eq true
     end
   end
 
   describe '#get_all' do
-    it 'should call all on repo and return output' do
-      @mock_repo.should_receive(:all).with().and_return(67)
+    it 'should call all on model and return output' do
+      @mock_model.should_receive(:all).with().and_return(67)
       @service.get_all.should eq 67
     end
   end
 
   describe '#get' do
-    it 'should call first on repo with correct id and return result' do
-      @mock_repo.should_receive(:first).with({:id=>8}).and_return(123)
+    it 'should call first on model with correct id and return result' do
+        @mock_model.should_receive(:key)
+          .and_return(OpenStruct.new(:first => OpenStruct.new(:name => :id)))
+        @mock_model.should_receive(:first).with({:id=>8}).and_return(123)
       @service.get(8).should eq 123
     end
   end
@@ -93,9 +103,9 @@ describe JsonCrudApi::Service do
       params = { :one => 'one', :two => 'two' }
       record = double('entity')
       @service.should_receive(:get).with(5)
-        .and_return(record)
+      .and_return(record)
       record.should_receive(:update).with(params)
-        .and_return(789)
+      .and_return(789)
       @service.update(5,params).should eq 789
     end
   end
@@ -114,7 +124,7 @@ describe JsonCrudApi::Service do
     it 'should call delete on record' do
       record = double('entity')
       @service.should_receive(:get).with(5)
-        .and_return(record)
+      .and_return(record)
       record.should_receive(:destroy).and_return(109)
       @service.delete(5).should eq 109
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-crud-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tom Cully
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-30 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -203,11 +203,13 @@ files:
 - lib/json-crud-api/api.rb
 - lib/json-crud-api/auth_client.rb
 - lib/json-crud-api/crud.rb
+- lib/json-crud-api/presenter.rb
 - lib/json-crud-api/service.rb
 - lib/json-crud-api.rb
 - spec/helper.rb
 - spec/helpers_spec.rb
 - spec/unit/auth_client_spec.rb
+- spec/unit/presenter_spec.rb
 - spec/unit/service_spec.rb
 homepage: http://rubygems.org/gems/json-crud-api
 licenses:
@@ -237,4 +239,5 @@ test_files:
 - spec/helper.rb
 - spec/helpers_spec.rb
 - spec/unit/auth_client_spec.rb
+- spec/unit/presenter_spec.rb
 - spec/unit/service_spec.rb