sinatra-admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec4cc4370873a4a162ba234e9751b4efbaa24399
+  data.tar.gz: fdd0d626c74e68e08e2515358b4aad04eac33290
+SHA512:
+  metadata.gz: a26d7a34c0de58a89125553c82e840d291bdf1887a0b4ccfd8048f9520be31966268e22c10df10adcae4a292cccd5432ea7f01d53a83d3dc7aff90c9dcb2b83c
+  data.tar.gz: c2586581a6eceab9b8992913d0dcd87d108936b3c3190186ea1cade3c2d36b24d527c01964e2c7b938691653e8f0363429a6eb979e6089c319169475ea7a4106

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Fco. Delgado
+
+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,176 @@
+# SinatraAdmin
+
+Sinatra application that allows us to have an admin dashboard with 
+minimal effort.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sinatra-admin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-admin
+
+## Usage
+
+By default SinatraAdmin assumes that it's mounted over an "admin"
+namespace. This is how SinatraAdmin should be configured:
+
+1. Define your project namespace and your Sinatra applications.
+    ```ruby
+    module MyApp
+      class API < Sinatra::Base
+        #Config for API here
+      end
+
+      class Admin < Sinatra::Base
+        #Config for Admin here
+      end
+    end
+    ```
+
+2. Add SinatraAdmin::App middleware to your admin application.
+    ```ruby
+    class MyApp::Admin
+      use SinatraAdmin::App
+    end
+    ```
+
+3. Register model resources(let's assume that we have User and Comment
+   models). It creates the 7 REST actions to /create/update/remove
+   records.
+    ```ruby
+    class MyApp::Admin
+      SinatraAdmin.register 'User'
+      SinatraAdmin.register 'Comment'
+    end
+    ```
+
+4. Define your root resource(optional). This is going to be the first
+   page where the application is going to redirect you after the login.
+   SinatraAdmin defines the first registered resource as the default root. 
+   In this case it will get 'User'(according to point number 3). If you
+   want, you can set a different resource as the default one.
+    ```ruby
+    class MyApp::Admin
+      SinatraAdmin.root 'Comment'
+    end
+    ```
+
+5. Define your custom resources. Having model resources sometimes is not
+   enough and we might want to see some stats about our application. An
+   example could be: "As an admin I want to see how many user accounts has
+   been registered". Let's take a look at how to define custom resources.
+    ```ruby
+    class MyApp::Admin
+      SinatraAdmin.register 'Stats' do
+        get '/?' do
+          @message = 'Welcome to SinatraAdmin custom pages!'
+          @accounts_counter = User.count
+          haml 'stats/index'.to_sym
+        end
+      end
+    end
+    ```
+   If you try to access that custom page you are going to see an exception
+   saying something like: "Errno::ENOENT at /admin/stats No such file or
+   directory - /path/to/the/gem/sinatra-admin/views/stats/index.haml"
+   It's because SinatraAdmin tries to find the template in the views
+   folder of sinatra-admin. Obviously, that custom template does not exist 
+   in the gem. SinatraAdmin has a method to extend the views path and it 
+   allows us to find the template that we are looking for. This takes us to 
+   the next point.
+
+6. Extend your views path(Only for custom resources). SinatraAdmin has
+   the method :extend_views_from. This method receives a value that
+   should either be a String instance with the path to views folder or
+   be a Sinatra application. SinatraAdmin expects to be mounted over an 
+   "admin" namespace, that's why it's going to look the view in: 
+   the/extented/path/admin
+    ```ruby
+    class MyApp::Admin
+      SinatraAdmin.extend_views_from(MyApp::API) #It'll look at path/to/my_app/api/views/admin/stats/index.haml
+      SinatraAdmin.extend_views_from('path/to/views/folder') #It'll look at path/to/views/folder/admin/stats/index.haml
+    end
+    ```
+
+7. Wrapping it up.
+    ```ruby
+    class MyApp::Admin < Sinatra::Base
+      use SinatraAmin::App
+      SinatraAdmin.root 'Post'
+      SinatraAdmin.resource 'User'
+      SinatraAdmin.resource 'Comment'
+      SinatraAdmin.resource 'Post'
+      SinatraAdmin.register 'Stats' do
+        get '/?' do
+          @message = 'Welcome to SinatraAdmin custom pages!'
+          @accounts_counter = User.count
+          haml 'stats/index'.to_sym
+        end
+      end
+      SinatraAdmin.extend_views_from(MyApp::API)
+    end
+    ```
+
+8. Run it. We assume you're using a config.ru file to run your Sinatra
+   application. This is how it should look like:
+    ```ruby
+    require 'path/to/my_app/api'
+    require 'path/to/my_app/admin'
+
+    map "/api"
+      run MyApp::API
+    end
+
+    map "/admin" do #mounted over "/admin" namespace(mandatory)
+      run MyApp::Admin
+    end
+    ```
+
+## Constraints
+
+* SinatraAdmin only works if you mount it over "admin" namespace like in
+the example(Point 8).
+
+* Even when you pass a block with get/post/put/patch/delete when you
+register a model resource(like User), SinatraAdmin does not have a way to access
+them(only the URL). This is a TODO feature.
+
+* Even when you pass a block with post/put/patch/delete when you
+register a custom resource(Like MyStats), SinatraAdmin does not have a way to
+access them(only the URL). This is a TODO feature.
+
+## Notes
+
+* SinatraAdmin uses Mongoid by default. TODO: Add activeRecord support.
+ 
+* SinatraAdmin uses Warden for authentication.
+
+* SinatraAdmin comes with an Admin model by default. The constant is
+SinatraAdmin::Admin. It has :first_name, :last_name, :email and
+:password fields. Password is encrypted and stored in :password_hash
+field. :email and :password are required fields and :email should have a correct format.
+
+* You can contribute to this Project. Contributing means not only adding
+features but also writing documentation, adding issues, refactoring code
+or just sending us either a <3 if you liked the project or a </3 if you
+did not like it ;)
+
+* Current version: 0.1.0
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sinatra-admin/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/dummy/config.ru

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require
+require  './dummy/dummy'
+
+map "/" do
+  run Dummy::API
+end
+
+map "/admin" do
+  run Dummy::Admin
+end

data/dummy/config/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: dummy_test
+      hosts:
+        - localhost:27017

data/dummy/dummy.rb

@@ -0,0 +1,19 @@
+require 'sinatra-admin'
+require 'sinatra/base'
+
+require_relative 'models/user'
+require_relative 'models/comment'
+
+module Dummy
+  class Base < Sinatra::Base
+    set :root, File.dirname(__FILE__)
+    Mongoid.load!("dummy/config/mongoid.yml")
+    I18n.enforce_available_locales = false
+  end
+
+  class API < Base
+  end
+
+  class Admin < Base
+  end
+end

data/dummy/models/admin.rb

@@ -0,0 +1,6 @@
+require 'mongoid'
+
+class Admin < User
+  field :password, type: String
+  validates :password, presence: true
+end

data/dummy/models/comment.rb

@@ -0,0 +1,5 @@
+class Comment
+  include Mongoid::Document
+
+  field :body, type: String
+end

data/dummy/models/user.rb

@@ -0,0 +1,11 @@
+require 'mongoid'
+
+class User
+  include Mongoid::Document
+
+  field :first_name, type: String
+  field :last_name, type: String
+  field :email, type: String
+
+  validates :email, presence: true
+end

data/dummy/views/admin/customs/index.haml

@@ -0,0 +1,4 @@
+%h1= @welcome_msg
+
+.admin-count
+  %h4= "Admin Count: #{@admin_count}"

data/dummy/views/admin/users/custom.haml

@@ -0,0 +1,2 @@
+%h1= @message
+Hello!!!

data/features/admin_login.feature

@@ -0,0 +1,36 @@
+Feature: Admin login
+  In order to use SinatraAdmin
+  As an Admin
+  I want to login and use the admin application
+
+  Scenario: Admin is able to login with valid credentials
+    Given I add SinatraAdmin as middleware
+    And I am an Admin
+    And I register "User" resource
+    And I am on the login page
+    When I fill in "email" with "admin@mail.com"
+    And I fill in "password" with "admin"
+    And I press "Login"
+    Then I should see "Users - Index"
+
+  Scenario: Admin is not able to login with invalid email
+    Given I add SinatraAdmin as middleware
+    And I am an Admin
+    And I register "User" resource
+    And I am on the login page
+    When I fill in "email" with "invalidemail@mail.com"
+    And I fill in "password" with "admin"
+    And I press "Login"
+    Then I should see "Login - SinatraAdmin"
+    Then I should see "The email you entered does not exist"
+
+  Scenario: Admin is not able to login with invalid password
+    Given I add SinatraAdmin as middleware
+    And I am an Admin
+    And I register "User" resource
+    And I am on the login page
+    When I fill in "email" with "admin@mail.com"
+    And I fill in "password" with "invalid_password"
+    And I press "Login"
+    Then I should see "Login - SinatraAdmin"
+    Then I should see "You entered an incorrect password"

data/features/admin_logout.feature

@@ -0,0 +1,14 @@
+Feature: Admin login
+  In order to use SinatraAdmin
+  As a logged in Admin
+  I want to logout when I click the "Lougout" link
+
+  Scenario: Admin is able to logout
+    Given I add SinatraAdmin as middleware
+    And I am an Admin
+    And I register "User" resource
+    And I am logged in as admin
+    And I am on the home page
+    When I follow "Logout"
+    Then I should see "Login - SinatraAdmin"
+    Then I should see "Successfully logged out"

data/features/creating_users.feature

@@ -0,0 +1,44 @@
+Feature: Creating Users
+  In order to use SinatraAdmin
+  As an Admin
+  I want to create users when I register the "User" resource
+
+  Scenario: Admin tries to create a user without login
+    Given I add SinatraAdmin as middleware
+    And I register "User" resource
+    And I am an Admin
+    When I go to users listing
+    Then I should see "Login - SinatraAdmin"
+    And I should see "You must log in"
+
+  Scenario: Admin creates user
+    Given I add SinatraAdmin as middleware
+    And I register "User" resource
+    And I am an Admin
+    And I am logged in as admin
+    And I am on users listing
+    When I follow "New"
+    And I fill in "first_name" with "Vahak"
+    And I fill in "last_name" with "Matavosian"
+    And I fill in "email" with "vahak@herbalife.com"
+    And I press "Create"
+    Then I should see "User - Show"
+    Then I should see "_id"
+    Then I should see "first_name"
+    Then I should see "last_name"
+    Then I should see "email"
+    Then I should see "Vahak"
+    Then I should see "Matavosian"
+    Then I should see "vahak@herbalife.com"
+
+  Scenario: Admin creates user with errors
+    Given I add SinatraAdmin as middleware
+    And I register "User" resource
+    And I am an Admin
+    And I am logged in as admin
+    And I am on users listing
+    When I follow "New"
+    And I fill in "first_name" with "Vahak"
+    And I fill in "last_name" with "Matavosian"
+    And I press "Create"
+    Then I should see "email ["can't be blank"]"

data/features/custom_pages.feature

@@ -0,0 +1,34 @@
+Feature: Custom Pages
+  In order to use SinatraAdmin 
+  As an Admin
+  I want to add a custom page
+
+  Scenario: Admin tries to see custom page without login
+    Given I add SinatraAdmin as middleware
+    And I add main app views to SinatraAdmin views
+    And I register my custom page
+    And I am an Admin
+    When I go to my custom page
+    Then I should see "Login - SinatraAdmin"
+    And I should see "You must log in"
+
+  Scenario: Admin sees custom page
+    Given I add SinatraAdmin as middleware
+    And I add main app views to SinatraAdmin views
+    And I register my custom page
+    And I am an Admin
+    And I am logged in as admin
+    And There are users
+    When I go to my custom page
+    And I should see "Welcome to SinatraAdmin custom pages!"
+    And I should see "Admin Count: 1"
+
+  Scenario: Admin adds custom page to a Resource(model)
+    Given I add SinatraAdmin as middleware
+    And I add main app views to SinatraAdmin views
+    And I am an Admin
+    And I am logged in as admin
+    And There are users
+    And I register "User" resource with custom route
+    When I go to users custom page
+    And I should see "Welcome to Resource model custom page"