cadenero 0.0.2.a3 → 0.0.2.b1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2Y4NzhjNmE2MmVlYTlkNjNjMWFlYzI4MTYwZTkwMTQyMDk1MzBjNQ==
+  data.tar.gz: !binary |-
+    MWVkNDAwNjIwMDEwNjM2YWYzZmNiOTQxNTdkZGE2OTJjMmU5YjQ2Mg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2RiYTg0YTM0NzdiOGQwYWEzZWZjNGU3NGUwNzU5MjZhYmU0NjcxZTllY2I0
+    OWE2YTJkMmMzMDE0ZGFhNzY0N2YxMGQ1ZDg2Yjk1MWFiMjU0OGYzYjBlOTk4
+    ZWUzNmEyMjYwMDIyZmU0YjQ4MjgwM2I0NjcxZGIzOWFmYWE3OTA=
+  data.tar.gz: !binary |-
+    MjNlM2Y3YmEyZmQ2MjU0MzZlNmEwYzJlZTgwNGUxZTc3NWY5NGE1OGY4NjIy
+    NzYyOTlhYzAyOGFhMzhjZDBjN2M5NWExYjdkMDUyY2MxNTdiOTlkMGJmYjQ2
+    MzVjNzhjYTM4NzVjZjQzODdjYmU1ZDdlZDYyNWZjMWM5Yjg3NmE=

data/README.md

@@ -6,7 +6,6 @@ By [![Agiltec Logo](https://launchrock-assets.s3.amazonaws.com/logo-files/Gpujzv
 [![Code Climate](https://codeclimate.com/github/AgilTec/cadenero.png)](https://codeclimate.com/github/AgilTec/cadenero)
 [![Coverage Status](https://coveralls.io/repos/AgilTec/cadenero/badge.png?branch=master)](https://coveralls.io/r/AgilTec/cadenero?branch=master)
 [![Dependency Status](https://gemnasium.com/AgilTec/cadenero.png)](https://gemnasium.com/AgilTec/cadenero)
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/AgilTec/cadenero/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
 Authentication Engine for Rails.API multitenant RESTful APIs based on Warden. It:
 * Is Racked based
@@ -28,7 +27,7 @@ Generate first your Rails.API app as usual using:
 
 In the `Gemfile` add the following lines:
 ```ruby
-    gem 'cadenero', '~> 0.0.2.a3'
+    gem 'cadenero', '~> 0.0.2.b1'
     gem 'pg'
 ```
 
@@ -110,10 +109,12 @@ You can check them running:
 ```
     rake routes
 ```
+### Documentation
+You can review the YARD docs in: http://rubydoc.info/github/AgilTec/cadenero/frames
 
 ### The Cadenero Task List
 - [x] Specs for the code 100% Coverage using BDD with [Rspec](https://github.com/rspec/rspec) and [Capybara](https://github.com/jnicklas/capybara)
-- [ ] Documatation for all the code
+- [x] Documatation for all the code
 - [ ] Examples of use and demo
 
 ### Versions

data/app/controllers/cadenero/v1/account/sessions_controller.rb

@@ -1,6 +1,7 @@
 require_dependency "cadenero/application_controller"
-# COntroller for managing sessions for the API if you are using the :password Strategy
+#NameSpace for the V1 API in Cadenero
 module Cadenero::V1
+  # Controller for managing sessions for the API if you are using the :password Strategy
   class Account::SessionsController < Cadenero::ApplicationController
     # create the session for the user using the password strategy and returning the user JSON
     def create
@@ -13,6 +14,7 @@ module Cadenero::V1
       end
     end
 
+    # destroy the session for the user using params id
     def delete
       user = Cadenero::User.find_by_id(params[:id])
       if user_signed_in?

data/app/controllers/cadenero/v1/account/users_controller.rb

@@ -7,21 +7,27 @@ require_dependency "cadenero/application_controller"
 
 module Cadenero
   module V1
+    # Controller for managing users for specific accounts
     class Account::UsersController < Cadenero::ApplicationController
       # Create a [Cadenero::User] based on the params sended by the client as a JSON with the user inrormation
       #
       # @example Posting the user data to be created in an account via the subdomain
-      #   post "http://#{account.subdomain}.example.com/v1/sign_up", 
+      #   post "http://#{account.subdomain}.example.com/v1/users", 
       #   user: { email: "user@example.com", password: "password", password_confirmation: "password" }
       #
       # @return render JSON of [Cadenero::User] created and the status 201 Created: The request has been 
-      #   fulfilled and resulted in a new resource being created..
+      #   fulfilled and resulted in a new resource being created.
       def create
         account = Cadenero::V1::Account.where(subdomain: request.subdomain).first
         @user = account.users.create(params[:user])
         force_authentication!(@user)
         render json: @user, status: :created
       end
+      # Send as JSON the user that match the params[:user]
+      def show
+        @user = account.users.where(params[:user]).first
+        render json: @user, status: :ok
+      end
     end
   end
 end

data/app/controllers/cadenero/v1/accounts_controller.rb

@@ -2,11 +2,23 @@ require_dependency "cadenero/application_controller"
 
 module Cadenero
   module V1
+    # Handles the Accounts for the multitenant. An account creates a subdomain in the server as a route
+    # the account has an owner that is the default admin for that account
     class AccountsController < Cadenero::ApplicationController
+      # For API consistency provides the example for creating a new account
       def new
         errors = %Q{Please sign up. posting the account json data as {account: { name: "Testy", subdomain: "test", owner_attributes: {email: "testy@example.com", password: "changeme", password_confirmation: "changeme"} }} to /v1/accounts/sign_up}
-        render json: {errors: errors, links: "/v1/accounts/sign_up"}, status: 422
+        render json: {errors: errors, links: "/v1/accounts/sign_up"}, status: :unprocessable_entity
       end
+      # Create a [Cadenero::V1::Account] based on the params sended by the client as a JSON with the account inrormation
+      #
+      # @example Posting the account data to be created in a subdomain
+      #   post "http://www.example.com/v1/accounts", 
+      #   account: { name: "Testy", subdomain: "test", 
+      #     owner_attributes: {email: "testy@example.com", password: "changeme", password_confirmation: "changeme"} }
+      #
+      # @return render JSON of [Cadenero::V1::Account] created and the status 201 Created: The request has been 
+      #   fulfilled and resulted in a new resource being created.
       def create
         @account = Cadenero::V1::Account.create_with_owner(params[:account])
         if @account.valid?

data/app/extenders/middleware/robustness.rb

@@ -0,0 +1,19 @@
+# Intercepts excpetion from the middlewares to handled those as JSON responses
+class Robustness
+
+  def initialize(app)
+    @app = app
+  end
+
+  # Rack API call for rescue from the exceptions
+  def call(env)
+    @app.call(env)
+  rescue Apartment::SchemaNotFound => ex
+    [422, { 'Content-Type' => 'application/json' }, [ {errors: {subdomain:["Invalid subdomain"]}}.to_json ] ]  # suppose the message can be safely used
+  rescue SecurityError => ex
+    [403, { 'Content-Type' => 'application/json' }, [ ex.message ] ]
+  ensure
+    env['rack.errors'].write(ex.message) if ex
+  end
+
+end

data/app/models/cadenero/member.rb

@@ -1,4 +1,5 @@
 module Cadenero
+  # Defines that a Cadenero::User is member of an Cadenero::V1::Account
   class Member < ActiveRecord::Base
     belongs_to :account,  :class_name => "Cadenero::V1::Account"
     belongs_to :user,  :class_name => "Cadenero::User"

data/app/models/cadenero/user.rb

@@ -1,4 +1,5 @@
 module Cadenero
+  # Defines a user of one or more accounts for the multitenant  Rails App
   class User < ActiveRecord::Base
     attr_accessible :email, :password, :password_confirmation
     has_secure_password
@@ -6,6 +7,7 @@ module Cadenero
     has_many :members, class_name: "Cadenero::Member"
     has_many :memberships, through: :members, source: :account
 
+    # Obtain the authentication_token from the account to be use for the User
     def auth_token      
       accounts[0].authentication_token if accounts[0]
     end

data/app/models/cadenero/v1/account.rb

@@ -1,4 +1,5 @@
 module Cadenero::V1
+  # Defines a subdomain with a default admin (owner) as a tenant in the Rails App
   class Account < ActiveRecord::Base
     belongs_to :owner,  :class_name => "Cadenero::User"
     has_many :members, :class_name => "Cadenero::Member"
@@ -9,7 +10,7 @@ module Cadenero::V1
     validates :subdomain, :presence => true, :uniqueness => true
     validates :owner, :presence => true
 
-    # Creates an accout and assign the provided [Cadenero::User] as owner to the account
+    # Creates an account and assign the provided [Cadenero::User] as owner to the account
     # @param [Hash] params list 
     # @example
     #    Example for the params JSON: {name: "Testy", subdomain: "test", 
@@ -25,6 +26,20 @@ module Cadenero::V1
       account
     end
 
+    # Gets the account for the specified subdomain and guards errors 
+    # @param [String] params subdomain 
+    # @example
+    #    get_by_subdomain("www")
+    # @return the [Cadenero::V1::Account] for that subdomain  
+    def self.get_by_subdomain(subdomain)
+      account = find_by_subdomain(subdomain)
+      if account
+        account
+      else
+        raise Apartment::SchemaNotFound, "Subdomain is not valid"
+      end
+    end
+
     # Create a database schema using the subdomain
     def create_schema
       Apartment::Database.create(subdomain)

data/app/serializers/cadenero/account_serializer.rb

@@ -1,4 +1,5 @@
 module Cadenero
+  # JSON Serializaer for the Cadenero::V1::Account Model
   class AccountSerializer < ActiveModel::Serializer
     embed :ids
     attributes :id, :name, :subdomain, :authentication_token

data/app/serializers/cadenero/user_serializer.rb

@@ -1,4 +1,5 @@
 module Cadenero
+  # JSON Serializaer for the Cadenero::User Model
   class UserSerializer < ActiveModel::Serializer
     embed :ids
     attributes :id, :email, :auth_token

data/config/initializers/apartment.rb

@@ -1,4 +1,7 @@
-Rails.application.config.middleware.use 'Apartment::Elevators::Subdomain'
+require File.expand_path('../../../app/extenders/middleware/robustness', __FILE__)
+
+Rails.application.config.middleware.use(Robustness)
+Rails.application.config.middleware.use(Apartment::Elevators::Subdomain)
 
 
 Apartment.configure do |config|

data/config/initializers/warden/strategies/password.rb

@@ -17,7 +17,7 @@ Warden::Strategies.add(:password) do
   end
   
   def authenticate!
-    account = Cadenero::V1::Account.find_by_subdomain(subdomain)
+    account = Cadenero::V1::Account.get_by_subdomain(subdomain)
     if account
       u = account.users.find_by_email(json_params["user"]["email"])
       if u.nil? || u.blank?

data/config/routes.rb

@@ -8,6 +8,7 @@ Cadenero::Engine.routes.draw do
         post '/sessions', :to => "sessions#create", default: :json
         delete '/sessions', :to => "sessions#delete", default: :json
         post '/users', :to => "users#create", default: :json
+        get '/users', :to => "users#show", :as => :users, default: :json
       end
     end
     post '/accounts', :to => "accounts#create", :as => :accounts, default: :json

data/lib/cadenero/constraints/subdomain_required.rb

@@ -1,5 +1,7 @@
 module Cadenero
+  # Constraints for the routes
   module Constraints
+    # For the routes require that a subdomain is defined
     class SubdomainRequired
       def self.matches?(request)
         request.subdomain.present? && request.subdomain != "www"

data/lib/cadenero/engine.rb

@@ -1,6 +1,6 @@
 require 'warden'
 module Cadenero
-  
+  # Defines Cadenero as a Rails Engine using the passworf strategy as default for Warden
   class Engine < ::Rails::Engine
     isolate_namespace Cadenero
     config.middleware.use Warden::Manager do |manager|

data/lib/cadenero/testing_support/subdomain_helpers.rb

@@ -0,0 +1,15 @@
+module Cadenero
+  # Helper Methods for testing
+  module TestingSupport
+    # RSpec Helper for subdomains
+    module SubdomainHelpers
+      # To be use for RSpec features for defining and account with a subdomain visible for Capybara
+      def within_account_subdomain
+        let(:subdomain_url) { "http://#{account.subdomain}.example.com" }
+        before { Capybara.default_host = subdomain_url } 
+        after { Capybara.default_host = "http://example.com" }
+        yield
+      end
+    end
+  end
+end

data/lib/cadenero/version.rb

@@ -1,3 +1,3 @@
 module Cadenero
-  VERSION = "0.0.2.a3"
+  VERSION = "0.0.2.b1" # Current VERSION of Cadenero
 end

data/lib/cadenero.rb

@@ -34,10 +34,12 @@ module Cadenero
                   :default_user_password 
 
   class << self
+    # @return the base path for the Cadenero named routes
     def base_path
       @@base_path ||= Rails.application.routes.named_routes[:cadenero].path
     end
 
+    # defines which class will be used as User Class in Cadenero
     def user_class
       if @@user_class.is_a?(Class)
         raise "You can no longer set Cadenero.user_class to be a class. Please use a string instead."

data/lib/generators/cadenero/install_generator.rb

@@ -1,6 +1,8 @@
 require 'rails/generators'
 module Cadenero
+  # Bootstrap Cadenero in a new Rails App
   module Generators
+    # Cadenero generator to be used as `rails-api g cadenero:install`
     class InstallGenerator < Rails::Generators::Base 
       class_option "user-class", :type => :string
       class_option "default-account-name", :type => :string
@@ -13,6 +15,7 @@ module Cadenero
       source_root File.expand_path("../install/templates", __FILE__)
       desc "Used to install Cadenero"
 
+      # Copy the Cadenero Migrations in the New App
       def install_migrations
         puts "Copying over Cadenero migrations..."
         Dir.chdir(Rails.root) do
@@ -20,12 +23,14 @@ module Cadenero
         end
       end
 
+      # Defines which class will be used as User Class for Cadenero
       def determine_user_class
         @user_class = options["user-class"].presence ||
                       ask("What will be the name for your user class? [User]").presence ||
                       'User'
       end
 
+      # Defines which helper will be used as User Class Helper for Cadenero and inject that in the application_controller.rb
       def determine_current_user_helper
         current_user_helper = options["current-user-helper"].presence ||
                               ask("What will be the current_user helper called in your app? [current_user]").presence ||
@@ -47,30 +52,35 @@ module Cadenero
 
       end
 
+      # Define which will be the Root Account for the Multitnant Rails App
       def determine_default_account_name
         Cadenero.default_account_name = options["default-account-name"].presence ||
                       ask("What will be the name for the default account? [Root Account]").presence ||
                       'Root Account'
       end
 
+      # Define which will be the root subdomain for the Multitnant Rails App. (Default: www)
       def determine_default_account_subdomain
         Cadenero.default_account_subdomain = options["default-account-subdomain"].presence ||
                       ask("What will be the subdomain for the default account? [www]").presence ||
                       'www'
       end
 
+      # Define which will be the root owner for the defaul accout Multitnant Rails App.
       def determine_default_user_email
         Cadenero.default_user_email = options["default-user-email"].presence ||
                       ask("What will be the email for the default user owner of the default account? [testy@example.com]").presence ||
                       'testy@example.com'
       end
 
+      # Define which will be the password for the root owner for the defaul accout Multitnant Rails App.
       def determine_default_user_password 
         Cadenero.default_user_password  = options["default-user-password"].presence ||
                       ask("What will be the password for the default user owner of the default account? [change-me]").presence ||
                       'change-me'
       end
 
+      # Create the Cadenero initilizar based on the Template.
       def add_cadenero_initializer
         path = "#{Rails.root}/config/initializers/cadenero.rb"
         if File.exists?(path)
@@ -82,6 +92,7 @@ module Cadenero
         end
       end
 
+      # Run the Cadenero Migrations in the New App
       def run_migrations
         unless options["no-migrate"]
           puts "Running rake db:migrate"
@@ -89,6 +100,7 @@ module Cadenero
         end
       end
 
+      # Seed the databas using the options selected as defaults
       def seed_database
         puts "default_account_name: #{Cadenero.default_account_name}"
         puts "default_account_subdomain: #{Cadenero.default_account_subdomain}"
@@ -102,6 +114,7 @@ module Cadenero
         end
       end
 
+      # Injects the code in the `routes.rb` for mounting the Cadenero Engine
       def mount_engine
         puts "Mounting Cadenero::Engine at \"/\" in config/routes.rb..."
         insert_into_file("#{Rails.root}/config/routes.rb", :after => /routes.draw.do\n/) do
@@ -115,6 +128,7 @@ module Cadenero
         end
       end
 
+      # Wrap-ups the installation giving appropiate messages
       def finished
         output = "\n\n" + ("*" * 53)
         output += %Q{\nDone! Cadenero has been successfully installed. Yaaaaay! He will keep the intoxicated JSON's out
@@ -146,16 +160,19 @@ output += step("`rake db:migrate` was run, running all the migrations against yo
 
       private
 
+      # Keep track of the step number for the installation process
       def step(words)
         @step ||= 0
         @step += 1
         "#{@step}) #{words}\n"
       end
 
+      # @return the user_class
       def user_class
         @user_class
       end
 
+      # keep track of the migration numbers
       def next_migration_number
         last_migration = Dir[Rails.root + "db/migrate/*.rb"].sort.last.split("/").last
         current_migration_number = /^(\d+)_/.match(last_migration)[1]