databound 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22275b2aa2e135427ffb2cccc53091c913706ef5
+  data.tar.gz: 93ad22a8162a45950b0bee675b03a098c6fa663c
+SHA512:
+  metadata.gz: 1e9ae816ef58f24a27a57cdc819fcaea49b250ae8bf9feffca6c4fa7b998c1f1629863b044a6f27bf60bff641c9df200f7b372a72f3529acb20483e7f45be6be
+  data.tar.gz: 27dbd28d0751ba595b92836eb2c271a7a45a8b127cf31a04de620dc79c08044485635713824fe373dc0cdc123657e07b68a3653d5fb2de09671d96f87f978398

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.3
+  - 2.0.0
+script: bundle exec rspec --pattern "spec/**/*_spec.rb"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in databound.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,63 @@
+[![Code Climate](https://codeclimate.com/github/Nedomas/databound/badges/gpa.svg)](https://codeclimate.com/github/Nedomas/databound-rails)
+[![Gem Version](https://badge.fury.io/rb/databound.svg)](http://badge.fury.io/rb/databound)
+[![Build Status](https://travis-ci.org/Nedomas/databound.svg?branch=master)](https://travis-ci.org/Nedomas/databound-rails)
+[![Dependency Status](https://gemnasium.com/Nedomas/databound.svg)](https://gemnasium.com/Nedomas/databound-rails)
+
+![Databound](https://cloud.githubusercontent.com/assets/1877286/4743542/df89dcec-5a28-11e4-9114-6f383fe269cb.png)
+
+Exposes ActiveRecord records to the Javascript side.
+
+This is the **Ruby on Rails** backend part for the ``Databound`` javascript lib.
+
+For more information go to [javascript Databound repo](https://github.com/Nedomas/databound).
+
+## Javascript library
+
+It does something like this out of the box.
+
+```js
+  User = new Databound('/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 [javascript Databound repo](https://github.com/Nedomas/databound).
+
+#### II. Ruby on Rails part
+
+**1.** Add ``gem 'databound'`` to ``Gemfile``.
+
+**2.** Create a controller with method ``model`` which returns the model to be accessed.
+Also include ``Databound``
+
+```ruby
+class UsersController < ApplicationController
+  include Databound
+
+  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
+
+databound :users
+```
+
+## Additional features
+
+All features are described in [javascript Databound repo](https://github.com/Nedomas/databound).

data/Rakefile

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

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/databound.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'databound/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'databound'
+  spec.version       = Databound::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 Databound javascript lib.}
+  spec.homepage      = 'https://github.com/Nedomas/databound'
+  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_dependency 'andand'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'combustion', '~> 0.5.2'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-stack_explorer'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/databound.rb

@@ -0,0 +1,83 @@
+require 'andand'
+
+require 'databound/version'
+require 'databound/data'
+require 'databound/manager'
+require 'databound/rails/routes'
+
+module Databound
+  def self.included(base)
+    base.send(:before_action, :init_crud, only: %i(where create update destroy))
+    base.extend(ClassMethods)
+  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 permitted_columns
+    # permit all by default
+    model.column_names
+  end
+
+  def init_crud
+    @crud = Databound::Manager.new(self)
+  end
+
+  module ClassMethods
+    attr_reader :dsls
+    attr_reader :stricts
+
+    def dsl(name, value, strict: true, &block)
+      @stricts ||= {}
+      @stricts[name.to_s] = strict
+
+      @dsls ||= {}
+      @dsls[name.to_s] ||= {}
+      @dsls[name.to_s][value.to_s] = block
+    end
+  end
+end

data/lib/databound/data.rb

@@ -0,0 +1,51 @@
+module Databound
+  class Data
+    def initialize(controller, json)
+      return unless json
+
+      @controller = controller
+      @params = JSON.parse(json) if json.is_a?(String)
+      @params = json if json.is_a?(Hash)
+      @data = interpolated_params
+    end
+
+    def records(model)
+      model.where(@data)
+    end
+
+    def to_h
+      @data
+    end
+
+    private
+
+    def interpolated_params
+      @params.each_with_object({}) do |(key, val), obj|
+        check_strict!(key, val)
+
+        block = dsl_block(key, val)
+        obj[key] = block ? block.call(@params.to_options) : val
+      end
+    end
+
+    def dsl_block(key, val)
+      dsl_key(key).andand[val]
+    end
+
+    def dsl_key(key)
+      @controller.class.dsls.andand[key]
+    end
+
+    def check_strict!(key, val)
+      return unless dsl_key(key)
+      return unless strict?(key) and !dsl_block(key, val)
+
+      raise NotPermittedError, "DSL column '#{key}' received unmatched string '#{val}'." \
+        " Use 'strict: false' in DSL definition to allow everything."
+    end
+
+    def strict?(key)
+      @controller.class.stricts.andand[key]
+    end
+  end
+end

data/lib/databound/manager.rb

@@ -0,0 +1,60 @@
+module Databound
+  class NotPermittedError < RuntimeError; end
+  class Manager
+    def initialize(controller)
+      @model = controller.send(:model)
+      @permitted_columns = controller.send(:permitted_columns)
+
+      scope_js = controller.params[:scope]
+      data_js = controller.params[:data]
+      extra_find_scopes_js = controller.params[:extra_find_scopes] || '[]'
+
+      @scope = Databound::Data.new(controller, scope_js)
+      @data = Databound::Data.new(controller, data_js).to_h
+
+      @extra_find_scopes = JSON.parse(extra_find_scopes_js).map do |extra_scope|
+        Databound::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
+      check_params!
+      @model.where(@scope.to_h).create(@data)
+    end
+
+    def update_from_data
+      id = @data.delete('id')
+
+      check_params!
+      record = @model.find(id)
+      record.update(@data)
+
+      record
+    end
+
+    def destroy_from_data
+      @model.find(@data['id']).destroy
+    end
+
+    private
+
+    def check_params!
+      requested = [@scope, @data].map(&:to_h).flat_map(&:keys)
+      unpermitted = requested - @permitted_columns.map(&:to_s)
+      return if unpermitted.empty?
+
+      raise NotPermittedError, "Request includes unpermitted columns: #{unpermitted.join(', ')}"
+    end
+  end
+end

data/lib/databound/rails/routes.rb

@@ -0,0 +1,17 @@
+class ActionDispatch::Routing::Mapper
+  def databound(*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/databound/version.rb

@@ -0,0 +1,3 @@
+module Databound
+  VERSION = '0.0.3'
+end

data/spec/controllers/databound_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe UsersController, type: :controller do
+  describe '#create' do
+    before :each do
+      data = {
+        data: {
+          name: 'John',
+        },
+        scope: {},
+        extra_find_scopes: [],
+      }
+
+      post(:create, javascriptize(data))
+    end
+
+    it 'responds consistently to js' do
+      expect(rubize(response)).to eq(success: true, id: 1)
+    end
+
+    it 'creates the record' do
+      user = User.find(1)
+      user_attributes = user.attributes.to_options
+      expect(user_attributes.slice(:id, :name)).to eq(id: 1, name: 'John')
+    end
+  end
+
+  describe '#where' do
+    before :each do
+      User.create(name: 'John', city: 'New York')
+      User.create(name: 'Peter', city: 'New York')
+      User.create(name: 'Nikki', city: 'Hollywood')
+    end
+
+    it 'respond with empty records' do
+      data = {
+        data: {
+          city: 'Los Angeles',
+        },
+        scope: {},
+        extra_find_scopes: [],
+      }
+
+      post(:where, javascriptize(data))
+      expect(rubize(response)).to eq([])
+    end
+
+    it 'respond with correct records' do
+      data = {
+        data: {
+          city: 'New York',
+        },
+        scope: {},
+        extra_find_scopes: [],
+      }
+
+      post(:where, javascriptize(data))
+      expect(gather(:name, response)).to eq(%w(John Peter))
+    end
+  end
+
+  describe '#update' do
+    before :each do
+      @user = User.create(name: 'John', city: 'New York')
+    end
+
+    describe 'update record correctly' do
+      before :each do
+        data = {
+          data: {
+            id: @user.id,
+            city: 'Moved to Los Angeles',
+          },
+          scope: {},
+          extra_find_scopes: [],
+        }
+
+        post(:update, javascriptize(data))
+      end
+
+      it 'respond with updated record id' do
+        expect(rubize(response)).to eq(success: true, id: @user.id)
+      end
+
+      it 'do the update' do
+        expect(@user.reload.city).to eq('Moved to Los Angeles')
+      end
+    end
+
+    it 'respond with error when id is missing' do
+      data = {
+        data: {
+          city: 'Moved to Los Angeles',
+        },
+        scope: {},
+        extra_find_scopes: [],
+      }
+
+      expect { post(:update, javascriptize(data)) }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  describe '#destroy' do
+    before :each do
+      @user = User.create(name: 'John', city: 'New York')
+    end
+
+    describe 'destroy record correctly' do
+      before :each do
+        data = {
+          data: {
+            id: @user.id,
+          },
+          scope: {},
+          extra_find_scopes: [],
+        }
+
+        post(:destroy, javascriptize(data))
+      end
+
+      it 'respond with success' do
+        expect(rubize(response)).to eq(success: true)
+      end
+    end
+
+    it 'respond with error when id is missing' do
+      data = {
+        data: {
+          id: 2,
+        },
+        scope: {},
+        extra_find_scopes: [],
+      }
+
+      expect { post(:update, javascriptize(data)) }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+end