godfather 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0142891706b8057ccd00221c9e94a58cd5557a7a
+  data.tar.gz: 650ea8d82a17877fbcde40bed58d98a39e25f05e
+SHA512:
+  metadata.gz: eb80a2e065907ef9844d55dc0fc7c10a5f04a5c4ef760b2b117eeccbb6f2540f634ec63cb9efe1dc30bfe7123d36eaaa4bf99c50859844d4d5fd5a3cc6680a98
+  data.tar.gz: 48e9485326c3a2c3f69180fc53b3ff01c8e4a5c08ad7a38aff629172ac05df29f93d635bffe0460da03a2a572c85e0f3770603f32ebbb13a75a06138bb7200f7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in godfather.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Domas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Godfather
+
+Exposes ActiveRecord records to the Javascript side.
+
+This is the **Ruby on Rails** backend part for the ``Godfather.js`` lib.
+
+For more information go to [Godfather.js repo](https://github.com/Nedomas/godfather.js).
+
+## Javascript library
+
+It does something like this out of the box.
+
+```js
+  User = new Godfather('/users');
+
+  User.update({ id: 15, name: 'Saint John' }).then(function(updated_user) {
+  });
+```
+
+## Installation
+
+The library has two parts and has Lodash as a dependency.
+
+#### I. Javascript part
+
+Follow the guide on [Godfather.js repo](https://github.com/Nedomas/godfather.js).
+
+#### II. Ruby on Rails part
+
+**1.** Add ``gem 'godfather'`` to ``Gemfile``.
+
+**2.** Create a controller with method ``model`` which returns the model to be accessed.
+Also include ``Godfather::Controller``
+
+```ruby
+class UsersController < ApplicationController
+  include Godfather
+
+  private
+  
+  def model
+    User
+  end
+end
+```
+
+**3.** Add a route to ``routes.rb``
+
+```ruby
+# This creates POST routes on /users to UsersController
+# For where, create, update, destroy
+
+godfather_of :users
+```
+
+## Additional features
+
+All features are described in [Godfather.js repo](https://github.com/Nedomas/godfather.js).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/godfather.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'godfather/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'godfather'
+  spec.version       = Godfather::VERSION
+  spec.authors       = ['Domas Bitvinskas']
+  spec.email         = ['domas.bitvinskas@me.com']
+  spec.summary       = %q{ActiveRecord exposed to the Javascript side and guarded by guns}
+  spec.description   = %q{This is the Ruby on Rails backend part for the Godfather.js lib.}
+  spec.homepage      = 'https://github.com/Nedomas/godfather'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/godfather.rb

@@ -0,0 +1,66 @@
+require 'godfather/version'
+require 'godfather/data'
+require 'godfather/manager'
+require 'godfather/rails/routes'
+
+module Godfather
+  def self.included(base)
+    base.send(:before_action, :init_crud, only: %i(where create update destroy))
+  end
+
+  def where
+    records = @crud.find_scoped_records
+
+    render json: serialized(records)
+  end
+
+  def create
+    record = @crud.create_from_data
+
+    render json: {
+      success: true,
+      id: record.id,
+    }
+  end
+
+  def update
+    record = @crud.update_from_data
+
+    render json: {
+      success: true,
+      id: record.id,
+    }
+  end
+
+  def destroy
+    @crud.destroy_from_data
+
+    render json: {
+      success: true,
+    }
+  end
+
+  private
+
+  def serialized(records)
+    return records unless defined?(ActiveModel::Serializer)
+
+    serializer = ActiveModel::Serializer.serializer_for(records.first)
+    return records unless serializer
+
+    ActiveModel::ArraySerializer.new(records).to_json
+  end
+
+  def model
+    raise 'Override model method to specify a model to be used in CRUD'
+  end
+
+  def override!(name, value, data)
+    value
+  end
+
+  def init_crud
+    @crud = Godfather::Manager.new(self, model, params[:scope],
+      params[:data], params[:extra_find_scopes])
+  end
+end

data/lib/godfather/data.rb

@@ -0,0 +1,32 @@
+module Godfather
+  class Data
+    def initialize(controller, json)
+      @controller = controller
+
+      return unless json
+      hash = JSON.parse(json) if json.is_a?(String)
+      hash = json if json.is_a?(Hash)
+      @data = with_overrides(hash)
+    end
+
+    def records(model)
+      model.where(@data)
+    end
+
+    def to_h
+      @data
+    end
+
+    private
+
+    def with_overrides(hash)
+      result = {}
+
+      hash.each do |key, val|
+        result[key] = @controller.send(:override!, key.to_sym, val, hash)
+      end
+
+      result
+    end
+  end
+end

data/lib/godfather/manager.rb

@@ -0,0 +1,45 @@
+module Godfather
+  class Manager
+    def initialize(controller, model, scope_js, data_js, extra_find_scopes_js = '[]')
+      @model = model
+      @scope = Godfather::Data.new(controller, scope_js)
+      @data = Godfather::Data.new(controller, data_js).to_h
+
+      @extra_find_scopes = JSON.parse(extra_find_scopes_js).map do |extra_scope|
+        Godfather::Data.new(controller, extra_scope)
+      end
+    end
+
+    def find_scoped_records
+      records = []
+      records << @scope.records(@model)
+
+      @extra_find_scopes.each do |extra_scope|
+        records << extra_scope.records(@model)
+      end
+
+      records.map { |record| record.where(@data) }.flatten
+    end
+
+    def create_from_data
+      @model.where(@scope.to_h).create(@data)
+    end
+
+    def update_from_data
+      new_data = @data
+      id = new_data.delete('id')
+
+      permitted_cols = @model.column_names
+      updatable_data = new_data.slice(*permitted_cols)
+
+      record = @model.find(id)
+      record.update(updatable_data)
+
+      record
+    end
+
+    def destroy_from_data
+      @model.find(@data['id']).destroy
+    end
+  end
+end

data/lib/godfather/rails/routes.rb

@@ -0,0 +1,17 @@
+class ActionDispatch::Routing::Mapper
+  def godfather_of(*resources)
+    namespace = @scope[:path]
+    namespace = namespace[1..-1] if namespace
+
+    resources.each do |resource|
+      Rails.application.routes.draw do
+        %i(where create update destroy).each do |name|
+          path = [namespace, resource, name].compact.join('/')
+          controller = [namespace, resource].compact.join('/')
+          to = [controller, name].join('#')
+          post path => to
+        end
+      end
+    end
+  end
+end

data/lib/godfather/version.rb

@@ -0,0 +1,3 @@
+module Godfather
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: godfather
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Domas Bitvinskas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This is the Ruby on Rails backend part for the Godfather.js lib.
+email:
+- domas.bitvinskas@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- godfather.gemspec
+- lib/godfather.rb
+- lib/godfather/data.rb
+- lib/godfather/manager.rb
+- lib/godfather/rails/routes.rb
+- lib/godfather/version.rb
+homepage: https://github.com/Nedomas/godfather
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord exposed to the Javascript side and guarded by guns
+test_files: []
+has_rdoc: