binda 0.0.2

data/lib/generators/binda/install/install_generator.rb

@@ -0,0 +1,107 @@
+require 'colorize'
+require 'securerandom'
+
+module Binda
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+      
+      def check_previous_install
+        # Ensure Binda is not installed
+        if Component.table_exists?
+          puts "Binda has already been installed on this database.".colorize(:red)
+          puts "Please ensure Binda is completely removed from the database before trying to install it again.".colorize(:red)
+          exit
+        end
+      end
+
+      def add_route
+        return if Rails.env.production?
+        return if Rails.application.routes.routes.detect { |route| route.app.app == Binda::Engine }
+        route "mount Binda::Engine => '/admin_panel'"
+      end
+
+      def copy_migrations
+        return if Rails.env.production?
+
+        # Check if there is any previous Binda migration
+        previous_binda_migrations = Dir.glob( Rails.root.join('db', 'migrate', '*.binda.rb' ))
+        previous_migrations = Dir.glob( Rails.root.join('db', 'migrate', '*.rb' ))
+
+        # If it's the first time you run the installation
+        unless previous_binda_migrations.any?
+          rake 'binda:install:migrations'
+        else
+          # If there is any previous Binda migration
+          if previous_migrations.size != previous_binda_migrations.size
+            puts "You have several migrations, please manually delete Binda's ones then run 'rails g binda:install' again.".colorize(:red)
+            puts "Keep in mind that Binda will place the new migration after the existing ones.".colorize(:red)
+            exit
+          else
+            # Remove previous Binda migrations
+            FileUtils.rm_rf( previous_binda_migrations )
+            # Install Binda migrations
+            rake 'binda:install:migrations'
+          end
+        end
+      end
+      
+      def run_migrations
+        rake 'db:migrate'
+      end
+
+      def setup_devise
+        return if Rails.env.production?
+        return if Dir.glob( Rails.root.join('config', 'initializers', 'devise.rb' )).any?
+
+        # Copy the initilializer on the application folder
+        template 'config/initializers/devise.rb'
+
+        # Add secret key
+        inject_into_file 'config/initializers/devise.rb', after: "# binda.hook.1" do 
+          "\n  config.secret_key = '#{ SecureRandom.hex(64) }'"
+        end
+        # Add pepper
+        inject_into_file 'config/initializers/devise.rb', after: "# binda.hook.2" do 
+          "\n  config.pepper = '#{ SecureRandom.hex(64) }'"
+        end
+
+        application( nil, env: [ "development", "test" ] ) do
+          "\n  config.action_mailer.default_url_options = { host: 'localhost:3000' }\n  config.action_mailer.raise_delivery_errors = true\n"
+        end
+        application( nil, env: "production" ) do
+          "\n  # PLEASE UPDATE THIS WITH THE FINAL URL OF YOUR DOMAIN\n  # config.action_mailer.default_url_options = { host: 'yourdomain.com' }\n  # config.action_mailer.delivery_method = :smtp\n  # config.action_mailer.perform_deliveries = true\n  # config.action_mailer.raise_delivery_errors = false\n  # config.action_mailer.default :charset => 'utf-8'\n  # config.action_mailer.smtp_settings = {\n  #   address: 'smtp.gmail.com',\n  #   port: 587,\n  #   domain: ENV['MAIL_DOMAIN'],\n  #   authentication: 'plain',\n  #   enable_starttls_auto: true,\n  #   user_name: ENV['MAIL_USERNAME'],\n  #   password: ENV['MAIL_PASSWORD']\n  # }"
+
+            # which returns the snippet below:
+            # 
+            #  # PLEASE UPDATE THIS WITH THE FINAL URL OF YOUR DOMAIN
+            #  # for setup see https://rubyonrailshelp.wordpress.com/2014/01/02/setting-up-mailer-using-devise-for-forgot-password/
+            #  config.action_mailer.default_url_options = { host: 'yourdomain.com' }
+            #  config.action_mailer.delivery_method = :smtp
+            #  config.action_mailer.perform_deliveries = true
+            #  config.action_mailer.raise_delivery_errors = false
+            #  config.action_mailer.default :charset => 'utf-8'
+            #  config.action_mailer.smtp_settings = {
+            #    address: 'smtp.gmail.com',
+            #    port: 587,
+            #    domain: ENV['MAIL_DOMAIN'],
+            #    authentication: 'plain',
+            #    enable_starttls_auto: true,
+            #    user_name: ENV['MAIL_USERNAME'],
+            #    password: ENV['MAIL_PASSWORD']
+            #  }
+        end
+      end
+
+      def setup_carrierwave
+        return if Rails.env.production?
+        return if Dir.glob( Rails.root.join('config', 'initializers', 'carrierwave.rb' )).any?
+        
+        template 'config/initializers/carrierwave.rb'
+      end
+
+      def setup_settings
+        exec 'rails g binda:setup'
+      end
+
+  end
+end

data/lib/generators/binda/install/templates/config/initializers/carrierwave.rb

@@ -0,0 +1,32 @@
+CarrierWave.configure do |config|
+  config.storage = :file
+
+  # # Use Google if you want
+  # config.fog_provider = 'fog/google'                        # required
+  # config.fog_credentials = {
+  #   provider:                 'Google',
+  #   google_project:           '',
+  #   google_client_email:      '',
+  #   google_json_key_location: ''
+  # }
+  # # config.storage must go after config.fog_credentials
+  # # https://github.com/carrierwaveuploader/carrierwave/issues/2023#issuecomment-252407542
+  # config.storage = :fog
+  # config.fog_directory = ''
+
+  # # Use S3 if you want
+  # config.fog_credentials = {
+  #   provider:               'AWS',
+  #   region:                 '',
+  #   aws_access_key_id:      '',
+  #   aws_secret_access_key:  ''
+  # }
+  # # config.storage must go after config.fog_credentials
+  # # https://github.com/carrierwaveuploader/carrierwave/issues/2023#issuecomment-252407542
+  # config.storage = :fog
+  # config.fog_directory  = ''
+  # config.fog_public     = true
+  # config.fog_attributes = { 'Cache-Control' => 'max-age=315576000' }
+
+  config.enable_processing = !Rails.env.test?
+end

data/lib/generators/binda/install/templates/config/initializers/devise.rb

@@ -0,0 +1,280 @@
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+
+  # https://github.com/plataformatec/devise/wiki/How-To:-Use-devise-inside-a-mountable-engine
+  # You probably want Devise's controllers to inherit from 
+  # your engine's controller and not the main controller. 
+  # ============== DON'T CHANGE IT ===============
+  config.parent_controller = 'Binda::ApplicationController'
+  # ============== =============== ===============
+
+  # The secret key used by Devise. Devise uses this key to generate
+  # random tokens. Changing this key will render invalid all existing
+  # confirmation, reset password and unlock tokens in the database.
+  # Devise will use the `secret_key_base` as its `secret_key`
+  # by default. You can change it below and use your own secret key.
+  # config.secret_key = 'a8395fa034e067da620d70f7f39ad4765d163e44ce05d5c243393e1bbfdc10f9a464aaf34fcac3291a6746424ea2b9f9564a01c31820e28bf1737c16d139cd5c'
+  # binda.hook.1
+
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class
+  # with default "from" parameter.
+  # config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Devise::Mailer'
+
+  # Configure the parent class responsible to send e-mails.
+  # config.parent_mailer = 'ActionMailer::Base'
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  # config.authentication_keys = [:email]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [:email]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [:email]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:database]` will
+  # enable it only for database authentication. The supported strategies are:
+  # :database      = Support basic authentication with authentication key + password
+  # config.http_authenticatable = false
+
+  # If 401 status code should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. 'Application' by default.
+  # config.http_authentication_realm = 'Application'
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # particular strategies by setting this option.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing skip: :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # By default, Devise cleans up the CSRF token on authentication to
+  # avoid CSRF token fixation attacks. This means that, when using AJAX
+  # requests for sign in and sign up, you need to get a new CSRF token
+  # from the server. You can disable this option at your own risk.
+  # config.clean_up_csrf_token_on_authentication = true
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 11. If
+  # using other algorithms, it sets how many times you want the password to be hashed.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments. Note that, for bcrypt (the default
+  # algorithm), the cost increases exponentially with the number of stretches (e.g.
+  # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
+  config.stretches = Rails.env.test? ? 1 : 11
+
+  # Set up a pepper to generate the hashed password.
+  # config.pepper = '124ef1b08a92f891a392a9594b868887c945ca8438bd7852f8ac4d91e51f2cc699b8b6c7b12057c0f0e6dc03d04f8ee4eab72278b0f948e2c1e43f8b449c2262'
+  # binda.hook.2
+
+  # Send a notification email when the user's password is changed
+  # config.send_password_change_notification = false
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming their account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming their account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming their account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # A period that the user is allowed to confirm their account before their
+  # token becomes invalid. For example, if set to 3.days, the user can confirm
+  # their account within 3 days after the mail was sent, but on the fourth day
+  # their account can't be confirmed with the token any more.
+  # Default is nil, meaning there is no restriction on how long a user can take
+  # before confirming their account.
+  # config.confirm_within = 3.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed, new email is stored in
+  # unconfirmed_email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [:email]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # Invalidates all the remember me tokens when the user signs out.
+  config.expire_all_remember_me_on_sign_out = true
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # secure: true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length.
+  config.password_length = 8..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  config.email_regexp = /\A[^@\s]+@[^@\s]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [:email]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # Warn on the last attempt before the account is locked.
+  # config.last_attempt_warning = true
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [:email]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # When set to false, does not sign a user in automatically after their password is
+  # reset. Defaults to true, so a user is signed in automatically after a reset.
+  # config.sign_in_after_reset_password = true
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another hashing or encryption algorithm besides bcrypt (default).
+  # You can use :sha1, :sha512 or algorithms from others authentication tools as
+  # :clearance_sha1, :authlogic_sha512 (then you should set stretches above to 20
+  # for default behavior) and :restful_authentication_sha1 (then you should set
+  # stretches to 10, and copy REST_AUTH_SITE_KEY to pepper).
+  #
+  # Require the `devise-encryptable` gem when using anything other than bcrypt
+  # config.encryptor = :sha512
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ['*/*', :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :delete
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(scope: :user).unshift :some_external_strategy
+  # end
+
+  # ==> Mountable engine configurations
+  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
+  # is mountable, there are some extra configurations to be taken into account.
+  # The following options are available, assuming the engine is mounted as:
+  #
+  #     mount MyEngine, at: '/my_engine'
+  #
+  # The router that invoked `devise_for`, in the example above, would be:
+  # ============== DON'T CHANGE IT ===============
+  config.router_name = :binda
+  # ============== =============== ===============
+
+  # When using OmniAuth, Devise cannot automatically set OmniAuth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = '/my_engine/users/auth'
+end

data/lib/generators/binda/setup/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate binda:setup
+
+    This will populate the database with initial settings.
+        

data/lib/generators/binda/setup/setup_generator.rb

@@ -0,0 +1,43 @@
+require 'colorize'
+require 'securerandom'
+
+module Binda
+  class SetupGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+    def setup_settings
+      puts 
+      puts "============================================================================="
+      puts "                               BINDA SETUP"
+      puts "============================================================================="
+      puts 
+      puts "We need few details. Don't worry you can modify them later. \n\n"
+
+      # MAINTENANCE MODE
+      Setting.find_or_create_by( name: 'Maintenance Mode' )
+
+      # WEBSITE NAME
+      @website_name = ask("What would you like to name your website? ['MySite']\n").presence || 'MySite'
+      Setting.find_or_create_by( name: 'Website Name' ).update_attribute( :content, @website_name )
+
+      # WEBSITE CONTENT
+      @website_description = ask("What is it about? ['A website about the world']\n").presence || 'A website about the world'
+      Setting.find_or_create_by( name: 'Website Description' ).update_attribute( :content, @website_description )
+    end
+
+    def create_credentials
+      rake 'binda_create_initial_user'
+    end
+
+    def feedback
+      puts
+      puts "Binda CMS has been succesfully installed! ".colorize(:green)
+      puts
+      puts "Before deploying to production, remember to uncomment and update the"
+      puts "'config.action_mailer.default_url_options' in 'config/environments/production.rb'"
+      puts
+      puts "============================================================================="
+    end
+
+  end
+end