sinatra-admin 0.1.0

data/features/support/database_cleaner.rb

@@ -0,0 +1,17 @@
+begin
+  require 'database_cleaner'
+  require 'database_cleaner/cucumber'
+
+  DatabaseCleaner.orm = "mongoid"
+  DatabaseCleaner.strategy = :truncation
+rescue NameError
+  raise "You need to add database_cleaner to your Gemfile (in the :test group) if you wish to use it."
+end
+
+Around do |scenario, block|
+  DatabaseCleaner.cleaning(&block)
+end
+
+Before do |scenario|
+  DatabaseCleaner.clean
+end

data/features/support/env.rb

@@ -0,0 +1,18 @@
+ENV['RACK_ENV'] = 'test'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'dummy/dummy.rb')
+require 'capybara'
+require 'capybara/cucumber'
+require 'rspec'
+
+Capybara.app = Rack::Builder.parse_file('./dummy/config.ru').first
+
+class DummyWorld
+  include Capybara::DSL
+  include RSpec::Matchers
+  include RSpec::Expectations
+end
+
+World do
+  DummyWorld.new
+end

data/features/support/paths.rb

@@ -0,0 +1,30 @@
+# Taken from the cucumber-rails project.
+
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in web_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+
+    when /the home page/
+      '/admin'
+    when /the login page/
+      '/admin/login'
+    when /my custom page/
+      '/admin/customs'
+    when /users listing/
+      '/admin/users'
+    when /users custom page/
+      '/admin/users/custom'
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/features/support/sinatra_admin.rb

@@ -0,0 +1,3 @@
+Before do |scenario|
+  SinatraAdmin.config.reset!
+end

data/features/support/warden.rb

@@ -0,0 +1,9 @@
+After do |scenario| 
+  Warden.test_reset!
+end
+
+module WardenWorld
+  include Warden::Test::Helpers
+end
+
+World(WardenWorld)

data/features/user_details.feature

@@ -0,0 +1,31 @@
+Feature: User show
+  In order to use SinatraAdmin
+  As an Admin
+  I want to see the details for each user when I register the "User" resource
+  And I clik on an id link
+
+  Scenario: Admin tries to see user details thithout login
+    Given I add SinatraAdmin as middleware
+    And I register "User" resource
+    And I am an Admin
+    And There are users
+    When I go to users listing
+    Then I should see "Login - SinatraAdmin"
+    And I should see "You must log in"
+
+  Scenario: Admin sees user details when clicks the _id link
+    Given I add SinatraAdmin as middleware
+    And I register "User" resource
+    And I am an Admin
+    And I am logged in as admin
+    And There are users
+    And I am on users listing
+    When I click on Carlo id
+    Then I should see "User - Show"
+    And I should see "_id"
+    And I should see "first_name"
+    And I should see "last_name"
+    And I should see "email"
+    And I should see "Carlo"
+    And I should see "Cajucom"
+    And I should see "carlo@herbalife.com"

data/lib/sinatra-admin.rb

@@ -0,0 +1,42 @@
+require 'active_support/inflector'
+
+require "sinatra-admin/version"
+require 'sinatra-admin/app'
+require 'sinatra-admin/register'
+require 'sinatra-admin/config'
+require 'sinatra-admin/models/admin'
+
+module SinatraAdmin
+  class << self
+    def register(constant_name, &block)
+      begin
+        model = constant_name.constantize
+        Register::Model.add(model, &block)
+      rescue NameError => error #Model does not exist
+        Register::Custom.add(constant_name, &block)
+      end
+    end
+
+    def config
+      @config ||= Config.new
+    end
+
+    def root(default)
+      config.root = default
+    end
+
+    def admin_model(constant_name)
+      config.admin_model = constant_name.constantize
+    end
+
+    def extend_views_from(target)
+      if target.instance_of?(String)
+        SinatraAdmin::App.views << "#{target}/admin"
+      else #Sinatra app
+        Array(target.views).each do |view|
+          SinatraAdmin::App.views << "#{view}/admin"
+        end
+      end
+    end
+  end #class << self
+end #SinatraAdmin

data/lib/sinatra-admin/app.rb

@@ -0,0 +1,74 @@
+require 'mongoid'
+require 'warden'
+require 'sinatra/base'
+require 'sinatra/namespace'
+require 'sinatra/flash'
+require 'sinatra-admin/warden_strategies/sinatra_admin'
+require 'sinatra-admin/helpers/session'
+require "sinatra-admin/helpers/template_lookup"
+
+module SinatraAdmin
+  class App < Sinatra::Base
+    Mongoid.raise_not_found_error = false
+    I18n.config.enforce_available_locales = false
+
+    set :sessions, true
+    set :views, [views]
+    set :session_secret, ENV['SINATRA_ADMIN_SECRET']
+
+    register Sinatra::Flash
+    register Sinatra::Namespace
+
+    helpers SinatraAdmin::SessionHelper
+    helpers SinatraAdmin::TemplateLookupHelper
+
+    use Rack::MethodOverride
+    use Warden::Manager do |config|
+      config.serialize_into_session(:sinatra_admin){|admin| admin.id }
+      config.serialize_from_session(:sinatra_admin){|id| SinatraAdmin.config.admin_model.find(id) }
+      config.scope_defaults :sinatra_admin,
+        strategies: [:sinatra_admin],
+        action: '/admin/unauthenticated'
+      config.failure_app = SinatraAdmin::App
+    end
+
+    Warden::Manager.before_failure do |env,opts|
+      env['REQUEST_METHOD'] = 'POST'
+    end
+
+    before do
+      unless public_routes.include?(request.path)
+        authenticate!
+      end
+    end
+
+    get '/?' do
+      redirect SinatraAdmin.config.default_route
+    end
+
+    get '/login/?' do
+      haml 'auth/login'.to_sym, format: :html5, layout: false
+    end
+
+    post '/login/?' do
+      if warden.authenticate(:sinatra_admin, scope: :sinatra_admin)
+        redirect SinatraAdmin.config.default_route
+      else
+        flash.now[:error] = warden.message
+        haml 'auth/login'.to_sym, format: :html5, layout: false
+      end
+    end
+
+    get '/logout/?' do
+      warden.logout(:sinatra_admin)
+      flash[:success] = 'Successfully logged out'
+      redirect '/admin/login'
+    end
+
+
+    post '/unauthenticated/?' do
+      flash[:error] = warden.message || "You must log in"
+      redirect '/admin/login'
+    end
+  end
+end

data/lib/sinatra-admin/config.rb

@@ -0,0 +1,45 @@
+module SinatraAdmin
+  class Config
+    ATTRIBUTES = [:root, :admin_model]
+
+    ATTRIBUTES.each do |attr|
+      attr_accessor attr
+    end
+
+    def default_route
+      @default_route ||=
+        if root
+          route = root.underscore.pluralize
+          raise RegistrationException, "The resource #{root} was not registered" unless routes.include?(route)
+          "/admin/#{route}"
+        else
+          raise RegistrationException, 'You should register at least one resource' if routes.empty?
+          "/admin/#{routes.first}"
+        end
+    end
+
+    def admin_model
+      @admin_model ||= SinatraAdmin::Admin
+    end
+
+    # Store all registered routes.
+    # Executing:
+    #   SinatraAdmin.register('User')
+    #   SinatraAdmin.register('Tags')
+    #
+    # The result is going  to be:
+    #   @routes => ['users', 'tags']
+    def routes
+      @routes ||= []
+    end
+
+    ########## USE THIS METHOD CAREFULLY! ###########
+    # Sets ALL config to nil and remove ALL registered
+    # routes. It means that this method is going to remove
+    # the WHOLE SinatraAdmin functionality
+    def reset!
+      ATTRIBUTES.each {|attr| send("#{attr.to_s}=", nil)}
+      routes.clear
+    end
+  end
+end

data/lib/sinatra-admin/helpers/session.rb

@@ -0,0 +1,24 @@
+module SinatraAdmin
+  module SessionHelper
+    def public_routes
+      [
+        '/admin/login',
+        '/admin/login/',
+        '/admin/unauthenticated',
+        '/admin/unauthenticated/',
+        '/admin/not_found/'
+      ]
+    end
+
+    def authenticate!
+      unless warden.authenticated?(:sinatra_admin)
+        flash[:error] = "You must log in"
+        redirect to('login')
+      end
+    end
+
+    def warden
+      env['warden']
+    end
+  end
+end

data/lib/sinatra-admin/helpers/template_lookup.rb

@@ -0,0 +1,7 @@
+module SinatraAdmin
+  module TemplateLookupHelper
+    def find_template(views, name, engine, &block)
+      Array(views).each { |v| super(v, name, engine, &block) }
+    end
+  end #TemplateLookupHelper
+end #SinatraAdmin

data/lib/sinatra-admin/models/admin.rb

@@ -0,0 +1,40 @@
+require 'mongoid'
+require 'bcrypt'
+
+class EmailValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless value =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+      record.errors[attribute] << (options[:message] || "is not an email")
+    end
+  end
+end
+
+module SinatraAdmin
+  class Admin
+    include Mongoid::Document
+    include BCrypt
+
+    field :first_name, type: String
+    field :last_name, type: String
+    field :email, type: String
+    field :password_hash, type: String
+
+    validates :email,
+              :password_hash, presence: true
+
+    validates :email, email: true
+
+    def authenticate(attemp_password)
+      password == attemp_password
+    end
+
+    def password
+      @password ||= Password.new(password_hash)
+    end
+
+    def password=(new_password)
+      @password = Password.create(new_password)
+      self.password_hash = @password
+    end
+  end
+end

data/lib/sinatra-admin/register.rb

@@ -0,0 +1,8 @@
+require 'sinatra-admin/register/base'
+require 'sinatra-admin/register/model'
+require 'sinatra-admin/register/custom'
+
+module SinatraAdmin
+  class RegistrationException < Exception; end
+  module Register; end
+end

data/lib/sinatra-admin/register/base.rb

@@ -0,0 +1,29 @@
+module SinatraAdmin
+  module Register
+    class Base
+      class << self
+        def add(resource_constant, &block)
+          route = resource_constant.to_s.downcase.split.join('_').pluralize
+          if SinatraAdmin.config.routes.include?(route)
+            raise RegistrationException, "The resource #{resource_constant.to_s} is already registered"
+          else
+            SinatraAdmin.config.routes << route
+            new(resource_constant, route).generate!(&block)
+          end
+        end
+      end
+
+      attr_reader :app, :resource_constant, :route
+
+      def initialize(resource_constant, route)
+        @app   = SinatraAdmin::App
+        @route = route
+        @resource_constant = resource_constant
+      end
+
+      def generate!
+        raise NotImplementedError, 'You must implement me!'
+      end
+    end #Base
+  end #Register
+end #SinatraAdmin

data/lib/sinatra-admin/register/custom.rb

@@ -0,0 +1,10 @@
+module SinatraAdmin
+  module Register
+    class Custom < Base
+      def generate!(&block)
+        raise RegistrationException, "You should pass a block in order to register #{resource_constant} custom resource" unless block_given?
+        app.namespace("/#{route}", &block)
+      end
+    end #Custom
+  end #Register
+end #SinatraAdmin

data/lib/sinatra-admin/register/model.rb

@@ -0,0 +1,75 @@
+module SinatraAdmin
+  module Register
+    class Model < Base
+      def generate!(&block)
+        app.namespace("/#{route}", &block) if block_given?
+        app.instance_exec(resource_constant, route) do |model, route|
+          before "/#{route}/?*" do
+            @model = model
+            @route = route
+          end
+
+          #INDEX
+          get "/#{route}/?" do
+            @collection ||= model.all.entries
+            haml :index, format: :html5
+          end
+
+          #NEW
+          get "/#{route}/new/?" do
+            @resource = model.new
+            haml :new, format: :html5
+          end
+
+          #CREATE
+          post "/#{route}/?" do
+            @resource = model.new(params[:data])
+            if @resource.save
+              puts "Resource was created"
+              redirect "/admin/#{@route}/#{@resource.id}"
+            else
+              puts "Validation Errors"
+              haml :new, format: :html5
+            end
+          end
+
+          #SHOW
+          get "/#{route}/:id/?" do
+            @resource = model.find(params[:id])
+            haml :show, format: :html5
+          end
+
+          #EDIT
+          get "/#{route}/:id/edit/?" do
+            @resource = model.find(params[:id])
+            haml :edit, format: :html5
+          end
+
+          #UPDATE
+          put "/#{route}/:id/?" do
+            @resource = model.find(params[:id])
+            if @resource.update_attributes(params[:data])
+              puts "Resource was updated"
+              redirect "/admin/#{@route}/#{@resource.id}"
+            else
+              puts "Validation Errors"
+              haml :edit, format: :html5
+            end
+          end
+
+          #DESTROY
+          delete "/#{route}/:id/?" do
+            @resource = model.find(params[:id])
+            if @resource.destroy
+              puts "Resource was destroyed"
+              redirect "/admin/#{route}/"
+            else
+              puts "Something wrong"
+              status 400
+            end
+          end
+        end
+      end
+    end #Model
+  end #Register
+end #SinatraAdmin