cadenero 0.0.1 → 0.0.2.a

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 YOURNAME
+Copyright 2013 Manuel Vidaurre @mvidaurre AgilTec Soluciones
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -38,6 +38,9 @@ v1_user_sign_up POST /v1/sign_up(.:format)   cadenero/v1/account/users#create
 - [ ] Documatation for all the code
 - [ ] Examples of use and demo
 
+### Versions
+**Cadenero** use [Semantic Versioning 2.0.0](http://semver.org/) the current version is: 0.0.2-alpha meaning MAJOR.MINOR.PATCH format
+
 ### Bug reports
 
 If you discover a problem with **Cadenero**, we would like to know about it. However, we ask that you please review these guidelines before submitting a bug report:

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

@@ -5,7 +5,7 @@ module Cadenero::V1
     has_many :users, :through => :members
     
     accepts_nested_attributes_for :owner
-    attr_accessible :name, :subdomain, :owner_attributes
+    attr_accessible :name, :subdomain, :owner_attributes, :owner
     validates :subdomain, :presence => true, :uniqueness => true
 
     # Creates an accout and assign the provided [Cadenero::User] as owner to the account

data/db/migrate/20130612061604_create_cadenero_v1_accounts.rb

@@ -3,10 +3,12 @@ class CreateCadeneroV1Accounts < ActiveRecord::Migration
     create_table :cadenero_accounts do |t|
       t.string :name
       t.string :subdomain
+      t.string :authentication_token    
       t.references :owner
 
       t.timestamps
     end
     add_index :cadenero_accounts, :owner_id
+    add_index :cadenero_accounts, :authentication_token
   end
 end

data/db/seeds.rb

@@ -0,0 +1,2 @@
+user = Cadenero::User.create(email: "testy@example.com", password: "changeme", password_confirmation: "changeme")
+Cadenero::V1::Account.create(name: 'Root Account for the Site', subdomain: 'www', owner: user)

data/lib/cadenero/version.rb

@@ -1,3 +1,3 @@
 module Cadenero
-  VERSION = "0.0.1"
-end
+  VERSION = "0.0.2.a"
+end

data/lib/generators/cadenero/install/templates/initializer.rb

@@ -0,0 +1,16 @@
+Cadenero.user_class = "<%= user_class %>"
+Cadenero.email_from_address = "please-change-me@example.com"
+# If you do not want to use gravatar for avatars then specify the method to use here:
+# Cadenero.avatar_user_method = :custom_avatar_url
+#Cadenero.per_page = <%= Cadenero.per_page.inspect %>
+
+
+# Rails.application.config.to_prepare do
+#   If you want to change the layout that Cadenero uses, uncomment and customize the next line:
+#   Cadenero::ApplicationController.layout "forem"
+#
+#   If you want to add your own cancan Abilities to Cadenero, uncomment and customize the next line:
+#   Cadenero::Ability.register_ability(Ability)
+# end
+#
+# By default, these lines will use the layout located at app/views/layouts/forem.html.erb in your application.

data/lib/generators/cadenero/install_generator.rb

@@ -0,0 +1,143 @@
+require 'rails/generators'
+module Cadenero
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option "user-class", :type => :string
+      class_option "no-migrate", :type => :boolean
+      class_option "current-user-helper", :type => :string
+
+      source_root File.expand_path("../install/templates", __FILE__)
+      desc "Used to install Cadenero"
+
+      def install_migrations
+        puts "Copying over Cadenero migrations..."
+        Dir.chdir(Rails.root) do
+          `rake cadenero:install:migrations`
+        end
+      end
+
+      def determine_user_class
+        @user_class = options["user-class"].presence ||
+                      ask("What is your user class called? [User]").presence ||
+                      'User'
+      end
+
+      def determine_current_user_helper
+        current_user_helper = options["current-user-helper"].presence ||
+                              ask("What is the current_user helper called in your app? [current_user]").presence ||
+                              :current_user
+
+        puts "Defining cadenero_user method inside ApplicationController..."
+
+        cadenero_user_method = %Q{
+  def cadenero_user
+    #{current_user_helper}
+  end
+  helper_method :cadenero_user
+
+}
+
+        inject_into_file("#{Rails.root}/app/controllers/application_controller.rb",
+                         cadenero_user_method,
+                         :after => "ActionController::API\n")
+
+      end
+
+      def add_cadenero_initializer
+        path = "#{Rails.root}/config/initializers/cadenero.rb"
+        if File.exists?(path)
+          puts "Skipping config/initializers/cadenero.rb creation, as file already exists!"
+        else
+          puts "Adding cadenero initializer (config/initializers/cadenero.rb)..."
+          template "initializer.rb", path
+          require path # Load the configuration per issue #415
+        end
+      end
+
+      def run_migrations
+        unless options["no-migrate"]
+          puts "Running rake db:migrate"
+          `rake db:migrate`
+        end
+      end
+
+      def seed_database
+        load "#{Rails.root}/config/initializers/cadenero.rb"
+        unless options["no-migrate"]
+          puts "Creating default cadenero account and owner"
+          Cadenero::Engine.load_seed
+        end
+      end
+
+      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
+          %Q{
+  # This line mounts Cadenero's routes at / by default.
+  # This means, any requests to the / URL of your application will go to Cadenero::V1:Account::DashboardController#index.
+  # If you would like to change where this extension is mounted, simply change the :at option to something different
+  # but that is discourage, the idea is to protect the whole site
+}
+        end
+      end
+
+      def finished
+        output = "\n\n" + ("*" * 53)
+        output += %Q{\nDone! Cadenero has been successfully installed. Yaaaaay! He will keep the intoxicated JSON's out
+
+Here's what happened:\n\n}
+
+        output += step("Cadenero's migrations were copied over into db/migrate.\n")
+        output += step("We created a new migration called AddCadeneroAdminToTable.
+   This creates a new field called \"cadenero_admin\" on your #{user_class} model's table.\n")
+        output += step("A new method called `cadenero_user` was inserted into your ApplicationController.
+   This lets Cadenero know what the current user of your application is.\n")
+        output += step("A new file was created at config/initializers/cadenero.rb
+   This is where you put Cadenero's configuration settings.\n")
+
+        unless options["no-migrate"]
+output += step("`rake db:migrate` was run, running all the migrations against your database.\n")
+        output += step("Seed forum and topic were loaded into your database.\n")
+        end
+        output += step("The engine was mounted in your config/routes.rb file using this line:
+
+   mount Cadenero::Engine, :at => \"/\"
+
+   If you want to change where the forums are located, just change the \"/forums\" path at the end of this line to whatever you want.")
+        output += %Q{\nAnd finally:
+
+#{step("We told you that Cadenero has been successfully installed and walked you through the steps.")}}
+        unless defined?(Devise)
+          output += %Q{We have detected you're not using Devise (which is OK with us, really!), so there's one extra step you'll need to do.
+
+   You'll need to define a "sign_in_path" method for Cadenero to use that points to the sign in path for your application. You can set Cadenero.sign_in_path to a String inside config/initializers/cadenero.rb to do this, or you can define it in your config/routes.rb file with a line like this:
+
+          get '/users/sign_in', :to => "users#sign_in"
+
+   Either way, Cadenero needs one of these two things in order to work properly. Please define them!}
+        end
+        output += "\nIf you have any questions, comments or issues, please post them on our issues page: http://github.com/AgilTec/cadenero/issues.\n\n"
+        output += "Thanks for using Cadenero!"
+        puts output
+      end
+
+      private
+
+      def step(words)
+        @step ||= 0
+        @step += 1
+        "#{@step}) #{words}\n"
+      end
+
+      def user_class
+        @user_class
+      end
+
+      def next_migration_number
+        last_migration = Dir[Rails.root + "db/migrate/*.rb"].sort.last.split("/").last
+        current_migration_number = /^(\d+)_/.match(last_migration)[1]
+        current_migration_number.to_i + 1
+      end
+    end
+  end
+end

data/spec/controllers/cadenero/v1/accounts_controller_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Cadenero
+  describe V1::AccountsController do
+    context "creates the account's schema" do
+
+      let!(:account) { stub_model(Cadenero::V1::Account) }
+      
+      before do
+        Cadenero::V1::Account.should_receive(:create_with_owner).and_return(account)
+        account.stub :valid? => true
+        controller.stub(:force_authentication!)
+      end
+      
+      it "should create a schema and ensure a token is returned for the account on successful creation" do
+        account.should_receive(:create_schema)
+        account.should_receive(:ensure_authentication_token!)
+        post :create, account: { name: "First Account", subdomain: "first" }, use_route: :cadenero
+        expect(account.authentication_token).not_to eq nil
+      end
+
+    end  
+  end
+end
+

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,63 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "cadenero"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,14 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: postgresql
+  database: cadenero_development 
+  min_messages: warning
+
+test:
+  adapter: postgresql
+  database: cadenero_test 
+  min_messages: warning

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  config.ember.variant = :development
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end