ddc 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3a6ee066211a5a1664cda8df754f8dd14d6bc07
-  data.tar.gz: 23a9ecdcb2c841d6b78e51e1dce499f90197e2ea
+  metadata.gz: beb0a92f622097983064f83fe5b0cb85a4e10361
+  data.tar.gz: e1ae80d57029d1b62605d28313555e597138c7f9
 SHA512:
-  metadata.gz: dffde5c7259d6cc663a5efcb354b4a4549009a6ea360fedeaf58ff48f4e7a0dd17700deb71fa124e5770bd9e9550cb925c575329d111407abc9501cfce4db85a
-  data.tar.gz: fb195d4f69292e9481af00a52d03fe8e2cb8c56cfd4f9fdc713397512448b154e80b6fbea2af0704fdef5a2c803af96760fb900cfa26c7a03751730823888826
+  metadata.gz: d8af2e9a626edd66add56d57db5f196c8217eb22f8582894a7263ff435896b2a1477f365ae598853f50bc54f43052727da7da415e735c67d1e7d3c4045f4269c
+  data.tar.gz: 0549ba0e5c2f500909b946a286ae511ada100f6a5d6d0f9d2098d472f81b3e1b574bde7c21d7c9eba3dcfbc11db173aed7e67882416a85b070afcec5ef26b4ac

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# DDC Changelog
+
+### 0.1.0
+
+* API updates to be more consistent
+* Add ServiceBuilder that delegats to AR Model or XxxxxFinder
+
+### 0.0.1
+
+* Initial release

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
 
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

data/ddc.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
   spec.add_dependency "actionpack", "~> 4.1"
   spec.add_dependency "activesupport", "~> 4.1"
 

data/lib/ddc/controller_builder.rb

@@ -9,7 +9,7 @@ module DDC
       error: 500
     }
     class << self
-      def build_controller(controller_name, config)
+      def build(controller_name, config)
         klass = find_or_create_class(controller_name)
         setup_before_actions!(klass, config)
         setup_actions!(controller_name, klass, config)
@@ -39,18 +39,18 @@ module DDC
         raise "Must specify actions" if actions.blank?
 
         actions.each do |action, action_desc|
-          setup_action! controller_name, klass, action, action_desc
+          setup_action! controller_name, klass, action, action_desc, config
         end
       end
 
-      def setup_action!(controller_name, klass, action, action_desc)
+      def setup_action!(controller_name, klass, action, action_desc, config)
         raise "Must specify a service for each action" unless action_desc[:service].present?
         raise "Must specify a context for each action" unless action_desc[:context].present?
         proc_klass, proc_method = parse_class_and_method(action_desc[:service])
         context_klass, context_method = parse_class_and_method(action_desc[:context])
 
         klass.send :define_method, action do
-          context_params = (action_desc[:params] || DEFAULT_CONTEXT_PARAMS).inject({}) do |h, param|
+          context_params = (action_desc[:context_params] || config[:context_params] || DEFAULT_CONTEXT_PARAMS).inject({}) do |h, param|
             h[param] = send param
             h
           end

data/lib/ddc/response_builder.rb

@@ -1,11 +1,13 @@
-module ResponseBuilder
-  def not_found
-    {status: :not_found}
-  end
-  def ok(obj)
-    {status: :ok, object: obj}
-  end
-  def created(obj)
-    {status: :created, object: obj}
+module DDC
+  module ResponseBuilder
+    def not_found
+      {status: :not_found}
+    end
+    def ok(obj)
+      {status: :ok, object: obj}
+    end
+    def created(obj)
+      {status: :created, object: obj}
+    end
   end
 end

data/lib/ddc/service_builder.rb

@@ -1,19 +1,27 @@
 module DDC
   class ServiceBuilder
     def self.build(model_type)
-      Class.new  do
-        include ResponseBuilder
+      Class.new do
+        include DDC::ResponseBuilder
         class << self
-          attr_accessor :model_type, :ar_model
+          attr_accessor :model_type, :ar_model, :finder
         end
 
         @model_type = model_type
         ar_class_name = model_type.to_s.camelize
         @ar_model = Object.const_get(ar_class_name)
 
+        @finder = nil
+        begin
+          @finder = Object.const_get("#{ar_class_name}Finder")
+        rescue NameError
+          # we use the AR Model as a fallback 
+        end
+
         def find(context)
-          id = context.values_at :id
-          me = self.class.ar_model.where id: id
+          id = context[:id]
+          me = custom_finder ? custom_finder.find(context) : 
+                               ar_model.where(id: id)
           if me.present?
             ok(me)
           else
@@ -21,8 +29,9 @@ module DDC
           end
         end
 
-        def find_all(context)
-          mes = self.class.ar_model.all
+        def find_all(context={})
+          mes = custom_finder ? custom_finder.find_all(context) : 
+                                ar_model.all
           ok(mes)
         end
 
@@ -45,9 +54,14 @@ module DDC
         end
 
         private
-        def find_for_user(user, id)
-          return nil if id.nil? || !UUIDUtil.valid?(id)
+        def custom_finder
+          self.class.finder
         end
+
+        def ar_model
+          self.class.ar_model
+        end
+
       end
     end
   end

data/lib/ddc/version.rb

@@ -1,3 +1,3 @@
 module Ddc
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/ddc.rb

@@ -1,5 +1,7 @@
 require "ddc/version"
+require "ddc/response_builder"
 require "ddc/controller_builder"
+require "ddc/service_builder"
 
 module Ddc
   # Your code goes here...

data/spec/controller_builder_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe DDC::ControllerBuilder do
   subject { described_class }
 
-  describe '.build_controller' do
+  describe '.build' do
     let(:json_format) {
       format = double('json format')
       expect(format).to receive(:json).and_yield
@@ -20,9 +20,9 @@ describe DDC::ControllerBuilder do
     end
 
     it 'defines the controller class' do
-      subject.build_controller :foo, actions: {
+      subject.build :foo, actions: {
         index: {
-          params: [:current_user, :params],
+          context_params: [:current_user, :params],
           context: 'foo_context_builder#bar',
           service: 'baz_service#qux'
         }
@@ -31,19 +31,19 @@ describe DDC::ControllerBuilder do
     end
 
     it 'raises if there are no actions defined' do
-      expect(->{subject.build_controller :foo, actions: {}}).to raise_exception
-      expect(->{subject.build_controller :foop, {}}).to raise_exception
+      expect(->{subject.build :foo, actions: {}}).to raise_exception
+      expect(->{subject.build :foop, {}}).to raise_exception
     end
 
     it 'raises if an action is missing context' do
-      expect(->{subject.build_controller :foo, actions: {foo: {
-        params: [:current_user, :params],
+      expect(->{subject.build :foo, actions: {foo: {
+        context_params: [:current_user, :params],
         service: 'baz_service#qux'
       }}}).to raise_exception
     end
 
     it 'raises if an action is missing service' do
-      expect(->{subject.build_controller :foo, actions: {foo: {
+      expect(->{subject.build :foo, actions: {foo: {
         context: 'foo_context_builder#bar',
       }}}).to raise_exception
     end
@@ -54,7 +54,7 @@ describe DDC::ControllerBuilder do
       end
 
       expect(FooController).to receive(:before_action).with(:my_before_action)
-      subject.build_controller :foo, 
+      subject.build :foo, 
         before_actions: [:my_before_action],
         actions: {
           index: {
@@ -93,9 +93,9 @@ describe DDC::ControllerBuilder do
         { object: :some_obj, status: :ok }
       end
 
-      subject.build_controller :foo, actions: {
+      subject.build :foo, actions: {
         index: {
-          params: [:current_user, :params],
+          context_params: [:current_user, :params],
           context: 'foo_context_builder#bar',
           service: 'baz_service#qux'
         }
@@ -113,9 +113,9 @@ describe DDC::ControllerBuilder do
         def respond_to; end
       end
 
-      subject.build_controller :foo, actions: {
+      subject.build :foo, actions: {
         index: {
-          params: [:current_user, :params],
+          context_params: [:current_user, :params],
           context: 'foo_context_builder#bar',
           service: 'baz_service#qux'
         }
@@ -151,7 +151,7 @@ describe DDC::ControllerBuilder do
         def some_user; end
         def render(args); end
       end
-      subject.build_controller :foo, 
+      subject.build :foo, 
         params: [:current_user, :params],
         actions: {
           index: {

data/spec/service_builder_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe DDC::ServiceBuilder do
+  subject { described_class }
+
+  describe '.build' do
+    before do
+      Object.send(:remove_const, :FooFinder) if defined? FooFinder
+    end
+
+    class Foo
+    end
+
+    it 'defines a class that responds to CRUD' do
+      foo_service_klass = subject.build :foo
+      service = foo_service_klass.new
+      expect(service).to respond_to(:find)
+      expect(service).to respond_to(:find_all)
+      expect(service).to respond_to(:update)
+      expect(service).to respond_to(:create)
+    end
+
+    describe '#find' do
+      it 'uses the AR model by default and returns DDC status hash' do
+        foo_service_klass = subject.build :foo
+        service = foo_service_klass.new
+
+        expect(Foo).to receive(:where).with(id: 'monkey').and_return :myfoo
+        found_data = service.find({id: 'monkey'})
+        expect(found_data[:object]).to eq(:myfoo)
+        expect(found_data[:status]).to eq(:ok)
+      end
+
+      it 'returns a not_found status' do
+        foo_service_klass = subject.build :foo
+        service = foo_service_klass.new
+
+        expect(Foo).to receive(:where).with(id: 'monkey').and_return nil
+        found_data = service.find({id: 'monkey'})
+        expect(found_data[:object]).to eq(nil)
+        expect(found_data[:status]).to eq(:not_found)
+      end
+
+      it 'uses the FooFinder if present' do
+        FooFinder = Class.new
+        foo_service_klass = subject.build :foo
+        service = foo_service_klass.new
+
+        expect(FooFinder).to receive(:find).with(id: 'monkey').and_return :myfoo
+        found_data = service.find({id: 'monkey'})
+        expect(found_data[:object]).to eq(:myfoo)
+        expect(found_data[:status]).to eq(:ok)
+      end
+    end
+
+    describe '#find_all' do
+      it 'uses the AR model by default and returns DDC status hash' do
+        foo_service_klass = subject.build :foo
+        service = foo_service_klass.new
+
+        expect(Foo).to receive(:all).and_return :myfoo
+        found_data = service.find_all
+        expect(found_data[:object]).to eq(:myfoo)
+        expect(found_data[:status]).to eq(:ok)
+      end
+
+      it 'uses the FooFinder if present' do
+        FooFinder = Class.new
+        foo_service_klass = subject.build :foo
+        service = foo_service_klass.new
+
+        expect(FooFinder).to receive(:find_all).with(user: 'monkey').and_return :myfoo
+        found_data = service.find_all({user: 'monkey'})
+        expect(found_data[:object]).to eq(:myfoo)
+        expect(found_data[:status]).to eq(:ok)
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -4,5 +4,6 @@ require 'action_controller'
 class ApplicationController < ActionController::Base
 end
 
+require 'pry'
 require_relative '../lib/ddc'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Shawn Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -99,6 +114,7 @@ files:
 - lib/ddc/service_builder.rb
 - lib/ddc/version.rb
 - spec/controller_builder_spec.rb
+- spec/service_builder_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -126,5 +142,6 @@ specification_version: 4
 summary: Data Driven Controllers for Rails
 test_files:
 - spec/controller_builder_spec.rb
+- spec/service_builder_spec.rb
 - spec/spec_helper.rb
 has_rdoc: