ninetails 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83a860c0c94b90e7a5d698bf1d094ea30ddd5d02
-  data.tar.gz: a5df117519887e875affca3ecd3a2cdb07e75620
+  metadata.gz: bf825500b2284d3a0d28a013d01cd244f777a340
+  data.tar.gz: e2dc5d6215e849d76dbc5288b26212b8e16453ab
 SHA512:
-  metadata.gz: 99b0aa847e1b4700ef1fa8c6005f488a55b4fdd57ad03316b3702a5ce6939b4ecc50e7d46bd2dfdea16a2fe7fb7198d5b70bbaff9a643914840f4e18251aa3b9
-  data.tar.gz: 6ed7b22e94609b662e391d0a89ad18270c630a726e7839dbd82275dd6834167d0ead1d08bf767714f5001dbef41eead94bd5ac791cc9d5e14e299a073a080cce
+  metadata.gz: 6475bd8ed8242c51e4acae2778f5db16a1e1116e76b6004634eb6df4080daa8671de7af17e55c8efd96a80da0f57c0faf81055a20d1e5a4763d4d20131f16c97
+  data.tar.gz: 833c7d437b231c5568a0f0d67cd076f0808fa6c1c2ef5a64de9ffcf7342be5229296024d45e4e7e9a9a9b564fb9aa23962279b769182e5da861b1ada21003953

data/README.md

@@ -1,10 +1,14 @@
 ![Ninetails](http://i.imgur.com/jv28Kg3.png)
 
 [![Build Status](https://travis-ci.org/iZettle/ninetails.svg)](https://travis-ci.org/iZettle/ninetails)
+[![Code Climate](https://codeclimate.com/github/iZettle/ninetails/badges/gpa.svg)](https://codeclimate.com/github/iZettle/ninetails)
+[![Test Coverage](https://codeclimate.com/github/iZettle/ninetails/badges/coverage.svg)](https://codeclimate.com/github/iZettle/ninetails/coverage)
 
-Ninetails is a simple CMS API engine. It is designed on the idea of a CMS which is limited in scope in that not all aspects of a page should be editable. Instead, you can define Sections, Elements, and Properties which are editable and can then be loaded in and styled in a reliable manner. It gives you the control to decide exactly what should and what should not be editable in your project.
+Ninetails is a simple Rails engine to create an API for a content management system to run on. It is designed on the idea of a CMS which is limited in scope in that not all aspects of a page should be editable. Instead, you can define Sections, Elements, and Properties which are editable and can then be loaded in and styled in a reliable manner. It gives you the control to decide exactly what should and what should not be editable in your project.
 
-## Getting started
+**WARNING: Ninetails is very much a work in progress and is not ready to be fully used yet!**
+
+# Getting started
 
 Ninetails is a mountable Rails engine, so it needs to be loaded into your app. You app is also where you will define your components which Ninetails should expose. Start by adding it to your Gemfile:
 
@@ -12,6 +16,25 @@ Ninetails is a mountable Rails engine, so it needs to be loaded into your app. Y
 gem "ninetails"
 ```
 
-## Thinking in sections
+Then you need to mount the engine in `config/routes.rb`
+
+```ruby
+Rails.application.routes.draw do
+  mount Ninetails::Engine, at: "/api"
+end
+```
+
+## Usage guide
 
-## Setting up Sections, Elements, and Components
+* [Thinking in sections](https://github.com/iZettle/ninetails/wiki/Thinking-in-sections)
+* [Creating pages](https://github.com/iZettle/ninetails/wiki/Creating-pages)
+* [Publishing pages](https://github.com/iZettle/ninetails/wiki/Publishing-pages)
+* [Validating properties](https://github.com/iZettle/ninetails/wiki/Validating-properties)
+
+## Configuration
+
+By default, Ninetails will force all keys in JSON responses to be camelcase with the first letter lowercase, to conform with JSON standards. If you would prefer the output to be as underscored, you can set this in an initializer:
+
+```ruby
+Ninetails::Config.key_style = :underscore
+```

data/Rakefile

@@ -9,11 +9,11 @@ load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
 desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
-task :default => :spec
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+task default: :spec

data/app/components/ninetails/element.rb

@@ -6,6 +6,10 @@ module Ninetails
       @reference ||= SecureRandom.uuid
     end
 
+    def name
+      @name ||= self.class.name.demodulize
+    end
+
     def deserialize(input)
       properties_instances.collect do |property|
         property.serialized_values = input[property.name.to_s]
@@ -41,7 +45,7 @@ module Ninetails
 
     def generate_structure
       properties_instances.each_with_object({}) do |property_type, hash|
-        hash[:type] = self.class.name.demodulize
+        hash[:type] = name
         hash[:reference] = reference
         hash[property_type.name] = property_type.serialize
 

data/app/components/ninetails/element_definition.rb

@@ -36,7 +36,7 @@ module Ninetails
     end
 
     def all_elements_valid?
-      elements.all? &:valid?
+      elements.all?(&:valid?)
     end
 
     private
@@ -51,7 +51,7 @@ module Ninetails
 
     def multiple_element_structure
       if elements.present?
-        elements.collect &:properties_structure
+        elements.collect(&:properties_structure)
       else
         [properties_structure]
       end

data/app/components/ninetails/property_type.rb

@@ -18,8 +18,6 @@ module Ninetails
         serialized_values
       elsif type.respond_to? :serialize
         type.serialize
-      else
-        type.new
       end
     end
 

data/app/components/ninetails/{section_template.rb → section.rb}

@@ -1,5 +1,5 @@
 module Ninetails
-  class SectionTemplate
+  class Section
     ALLOWED_POSITIONS = [:head, :body]
 
     attr_accessor :elements_instances
@@ -16,6 +16,11 @@ module Ninetails
       @position
     end
 
+    def self.define_element(name, type, count)
+      @elements ||= []
+      @elements << Ninetails::ElementDefinition.new(name, type, count)
+    end
+
     def self.has_element(name, type)
       define_element name, type, :single
     end
@@ -55,12 +60,5 @@ module Ninetails
       end
     end
 
-    private
-
-    def self.define_element(name, type, count)
-      @elements ||= []
-      @elements << Ninetails::ElementDefinition.new(name, type, count)
-    end
-
   end
 end

data/app/controllers/ninetails/application_controller.rb

@@ -1,4 +1,5 @@
 module Ninetails
   class ApplicationController < ActionController::API
+    include ActionController::ImplicitRender
   end
 end

data/app/controllers/ninetails/page_revisions_controller.rb

@@ -4,16 +4,15 @@ module Ninetails
     before_action :find_page
 
     def index
-      render json: { revisions: @page.revisions }
     end
 
     def create
       @page.build_revision_from_params revision_params
 
       if @page.revision.save
-        render json: @page.to_builder.target!, status: :created
+        render "/ninetails/pages/show", status: :created
       else
-        render json: @page.to_builder.target!, status: :bad_request
+        render "/ninetails/pages/show", status: :bad_request
       end
     end
 

data/app/controllers/ninetails/pages_controller.rb

@@ -1,14 +1,33 @@
 module Ninetails
   class PagesController < ApplicationController
 
+    def index
+      @pages = Page.all
+    end
+
     def show
       @page = Page.find_by! url: params[:id]
       @page.revision = @page.revisions.find params[:revision_id] if params[:revision_id]
 
-      render json: @page.to_builder.target!
     rescue ActiveRecord::RecordNotFound
       render json: {}, status: :not_found
     end
 
+    def create
+      @page = Page.new page_params
+
+      if @page.save
+        render :show, status: :created
+      else
+        render :show, status: :bad_request
+      end
+    end
+
+    private
+
+    def page_params
+      params.require(:page).permit(:url, :name)
+    end
+
   end
 end

data/app/controllers/ninetails/sections_controller.rb

@@ -0,0 +1,35 @@
+module Ninetails
+  class SectionsController < ApplicationController
+
+    def index
+      sections = Dir.glob(Rails.root.join("app", "components", "section", "*.rb")).collect do |entry|
+        empty_section_from_name File.basename(entry, ".rb")
+      end
+
+      render json: { sections: sections }
+    end
+
+    def show
+      render json: empty_section_from_name(params[:id])
+    end
+
+    def validate
+      @section = Ninetails::PageSection.new section_params
+
+      unless @section.valid?
+        render status: :bad_request
+      end
+    end
+
+    private
+
+    def empty_section_from_name(id)
+      "Section::#{id.classify}".safe_constantize.new.serialize
+    end
+
+    def section_params
+      params.require(:section).permit!
+    end
+
+  end
+end

data/app/models/ninetails/page.rb

@@ -3,29 +3,16 @@ module Ninetails
     has_many :revisions, class_name: "PageRevision"
     has_one :current_revision, class_name: "PageRevision"
 
+    validates :url, presence: true, uniqueness: true
+
     attr_writer :revision
 
     def revision
       @revision || current_revision
     end
 
-    def to_builder
-      Jbuilder.new do |json|
-        json.page do
-          json.call(self, :id, :name, :url)
-          json.revision_id revision.id
-          json.sections sections_to_builder
-        end
-      end
-    end
-
-    def sections_to_builder
-      revision.sections.collect do |section|
-        section.to_builder.attributes!
-      end
-    end
-
     def build_revision_from_params(page_revision)
+      page_revision = page_revision.convert_keys(:underscore).with_indifferent_access
       self.revision = revisions.build message: page_revision[:message]
 
       page_revision[:sections].each do |section_json|

data/app/models/ninetails/page_revision.rb

@@ -12,15 +12,9 @@ module Ninetails
     # contain error messages
     def sections_are_all_valid
       sections.each do |section|
-        deserialized_section = section.deserialize
-
-        deserialized_section.elements_instances.each do |element_definition|
-          unless element_definition.all_elements_valid?
-            errors.add :base, "Element #{element_definition.name} is not valid"
-          end
+        unless section.valid?
+          errors.add :base, section.errors.messages[:base]
         end
-
-        section.elements = deserialized_section.serialize[:elements]
       end
     end
 

data/app/models/ninetails/page_revision_section.rb

@@ -1,6 +1,6 @@
 module Ninetails
   class PageRevisionSection < ActiveRecord::Base
     belongs_to :page_revision
-    belongs_to :section
+    belongs_to :section, class_name: "PageSection"
   end
 end

data/app/models/ninetails/page_section.rb

@@ -0,0 +1,40 @@
+module Ninetails
+  class PageSection < ActiveRecord::Base
+    self.inheritance_column = nil
+    has_many :page_revision_sections
+    has_many :page_revisions, through: :page_revision_sections
+
+    validate :validate_elements
+
+    def section
+      @section ||= "Section::#{type}".safe_constantize.new
+    end
+
+    def deserialize
+      section.elements_instances = []
+
+      elements.each do |name, element_json|
+        element = section.class.find_element name
+        element.deserialize element_json
+        section.elements_instances << element
+      end
+
+      section
+    end
+
+    private
+
+    def validate_elements
+      deserialized_section = deserialize
+
+      deserialized_section.elements_instances.each do |element_definition|
+        unless element_definition.all_elements_valid?
+          errors.add :base, "Element #{element_definition.name} is not valid"
+        end
+      end
+
+      self.elements = deserialized_section.serialize[:elements]
+    end
+
+  end
+end

data/app/views/ninetails/page_revisions/index.json.jbuilder

@@ -0,0 +1 @@
+json.revisions @page.revisions, :id, :page_id, :created_at, :updated_at, :message

data/app/views/ninetails/pages/_page.json.jbuilder

@@ -0,0 +1,13 @@
+json.page do
+  json.call page, :id, :name, :url
+
+  if page.revision.present?
+    json.revision_id page.revision.id
+
+    json.sections page.revision.sections, partial: "/ninetails/sections/section", as: :section
+  end
+
+  if page.errors.present?
+    json.errors page.errors
+  end
+end

data/app/views/ninetails/pages/index.json.jbuilder

@@ -0,0 +1 @@
+json.pages @pages, :id, :url, :name

data/app/views/ninetails/pages/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "/ninetails/pages/page", page: @page

data/app/views/ninetails/sections/_section.json.jbuilder

@@ -0,0 +1 @@
+json.call section, :id, :name, :type, :tags, :elements

data/app/views/ninetails/sections/validate.json.jbuilder

@@ -0,0 +1,3 @@
+json.section do
+  json.partial! "section", section: @section
+end

data/config/routes.rb

@@ -1,9 +1,13 @@
 Ninetails::Engine.routes.draw do
-  root 'pages#index'
+  with_options defaults: { format: :json } do
+    root 'pages#index'
 
-  resources :pages, only: :show do
-    resources :page_revisions, only: [:create, :show, :index], path: "revisions"
-  end
+    resources :pages, only: [:show, :create, :index] do
+      resources :page_revisions, only: [:create, :show, :index], path: "revisions"
+    end
 
-  resources :section_templates, only: [:show, :index]
+    resources :sections, only: [:show, :index] do
+      post :validate, on: :collection
+    end
+  end
 end

data/config/spring.rb

@@ -0,0 +1 @@
+Spring.application_root = './spec/dummy'

data/db/migrate/20151120120538_rename_sections_to_page_sections.rb

@@ -0,0 +1,5 @@
+class RenameSectionsToPageSections < ActiveRecord::Migration
+  def change
+    rename_table :ninetails_sections, :ninetails_page_sections
+  end
+end

data/lib/ninetails/config.rb

@@ -0,0 +1,8 @@
+module Ninetails
+  class Config
+
+    cattr_accessor :key_style
+    self.key_style = :camelcase
+
+  end
+end

data/lib/ninetails/engine.rb

@@ -9,6 +9,9 @@ require "jbuilder"
 require "hash-pipe"
 require "virtus"
 
+require "ninetails/config"
+require "ninetails/key_conversion"
+
 begin
   require "pry"
 rescue LoadError
@@ -18,6 +21,8 @@ module Ninetails
   class Engine < ::Rails::Engine
     isolate_namespace Ninetails
 
+    middleware.use "Ninetails::KeyConversion"
+
     config.generators do |g|
       g.test_framework :rspec, fixture: false
       g.fixture_replacement :factory_girl, dir: 'spec/factories'

data/lib/ninetails/key_conversion.rb

@@ -0,0 +1,28 @@
+module Ninetails
+  class KeyConversion
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @status, @headers, @response = @app.call(env)
+
+      if @response.respond_to? :body
+        [@status, @headers, [modify_keys(@response.body)]]
+      else
+        [@status, @headers, @response]
+      end
+    end
+
+    def modify_keys(body)
+      if @headers["Content-Type"].include?("application/json") && Ninetails::Config.key_style == :camelcase
+        body = JSON.parse(body).convert_keys -> (key) { key.camelcase :lower }
+        body.to_json
+      else
+        body
+      end
+    end
+
+  end
+end