ucb_rails 0.0.5 → 0.0.6

data/app/controllers/ucb_rails/admin/force_exception_controller.rb

@@ -0,0 +1,7 @@
+class UcbRails::Admin::ForceExceptionController < UcbRails::Admin::BaseController
+  
+  def index
+    raise 'Exception raised to text ExceptionNotifier'
+  end
+  
+end

data/app/mailers/ucb_rails/test_mailer.rb

@@ -0,0 +1,15 @@
+module UcbRails
+  class TestMailer < ActionMailer::Base
+    layout false
+
+    # Verify email configuration, from irb (e.g.):
+    #
+    #   TestMailer.test('email@example.com').deliver
+    def test(email)
+      subject = "#{UcbRails[:email_subject_prefix]} Test Email"
+
+      mail(to: email, subject: subject)
+    end
+
+  end
+end

data/app/models/ucb_rails/configuration/configuration.rb

@@ -0,0 +1,72 @@
+module UcbRails
+  module Configuration
+  
+  # Manage configuration from file.  Per environment or overall.
+  #
+  # @example
+  #   # config/config.yml
+  #   test:
+  #     ldap:
+  #       username: test_username
+  #       password: test_password
+  # 
+  #   ldap:
+  #     username: top_username
+  #     password: top_password
+  #
+  #   # in config/initializers/ucb_rails.rb  (e.g.)
+  #   config = UcbRails::Credentials.new
+  #   
+  #   # in production -- pulls from top level, since no 'production' key
+  #   config.for('ldap') #=> { 'username' => 'top_username', 'password' => 'top_password' }
+  #
+  #   # in test -- pulls from 'test' key
+  #   config.for('ldap') #=> { 'username' => 'test_username', 'password' => 'test_password' }
+  class Configuration
+    FileNotFound = Class.new(StandardError)
+    KeyNotFound = Class.new(StandardError)
+    
+    attr_accessor :config_filename, :config_yaml
+    
+    def initialize(filename=Rails.root.join('config/config.yml'))
+      self.config_filename = filename.to_s
+      load_file
+    end
+    
+    # Return configuration value for _key_.
+    # @param key [String]
+    def for(key)
+      from_environment(key) || from_top_level(key)
+    end
+    
+    # Return configuration value for _key_.
+    # @raise [UcbRails::Configuration::KeyNotFound] if _key_ not in configuration file.
+    def for!(key)
+      self.for(key) or raise(KeyNotFound, key.inspect)
+    end
+    
+    private
+    
+    def from_environment(key)
+      environmet_value && environmet_value[key]
+    end
+
+    def from_top_level(key)
+      config_yaml[key]
+    end
+    
+    def environmet_value
+      config_yaml[RailsEnvironment.rails_env]
+    end
+    
+    def load_file
+      if File.exists?(config_filename) 
+        self.config_yaml = YAML.load_file(config_filename)
+      else
+        raise(FileNotFound, config_filename)
+      end
+    end
+  end
+  
+end
+end

data/app/models/ucb_rails/configuration/email.rb

@@ -0,0 +1,73 @@
+module UcbRails
+  module Configuration
+    class Email
+      ArgumentError = Class.new(StandardError)
+
+      attr_accessor :hash
+
+      def self.configure(config)
+        new(config)
+      end
+      
+      def initialize(configuration_hash)
+        return if configuration_hash.nil?
+        raise(ArgumentError, "expected a Hash, got: #{configuration_hash.inspect}") unless configuration_hash.is_a?(Hash)
+        
+        self.hash = configuration_hash
+        process_configuration
+      end
+
+      private
+
+      def process_configuration
+        process_default
+        process_delivery_method
+        process_default_url_options
+        process_raise_delivery_errors
+        process_sendmail_settings
+        process_smtp_settings
+        process_subject_prefix
+      end
+
+      # This merges values with existing values
+      def process_default
+        if hash.has_key?('default')
+          ActionMailer::Base.default hash['default']
+        end
+      end
+
+      def process_delivery_method
+        ActionMailer::Base.delivery_method = hash.fetch('delivery_method', :smtp).to_sym
+      end
+
+      def process_default_url_options
+        if hash.has_key?('default_url_options')
+          ActionMailer::Base.default_url_options = hash.fetch('default_url_options')
+        end
+      end
+
+      def process_raise_delivery_errors
+        ActionMailer::Base.raise_delivery_errors = hash.fetch('raise_delivery_errors', true)
+      end
+
+      def process_sendmail_settings
+        if hash.has_key?('sendmail_settings')
+          ActionMailer::Base.sendmail_settings = hash.fetch('sendmail_settings').symbolize_keys
+        end
+      end
+
+      def process_smtp_settings
+        if hash.has_key?('smtp_settings')
+          ActionMailer::Base.smtp_settings = hash.fetch('smtp_settings').symbolize_keys
+        end
+      end
+
+      def process_subject_prefix
+        prefix = hash.fetch('subject_prefix', '')
+        prefix = prefix.gsub("{env}", RailsEnvironment.short)
+        UcbRails.config.email_subject_prefix = prefix
+      end
+    end
+
+  end
+end

data/app/models/ucb_rails/configuration/exception_notification.rb

@@ -0,0 +1,21 @@
+module UcbRails
+  module Configuration
+    
+    class ExceptionNotification
+      
+      class << self
+        
+        def configure(config)
+          return if config.blank?
+          
+          config = config.symbolize_keys
+          config[:email].symbolize_keys!
+          config[:email][:email_prefix] = config[:email][:email_prefix].gsub("{env}", RailsEnvironment.short)
+          
+          Rails.application.config.middleware.use ::ExceptionNotification::Rack, config
+        end
+      end
+    end
+    
+  end
+end

data/config/routes.rb

@@ -18,6 +18,7 @@ Rails.application.routes.draw do
     
     namespace :admin do
       resources :announcements
+      get 'force_exception' => 'force_exception#index'
       resources :users do
         get 'ldap_search', on: :collection
         get 'typeahead_search', on: :collection

data/lib/generators/ucb_rails/templates/README

@@ -6,6 +6,7 @@
 rails generate user_announcements:install
 rails generate simple_form:install --bootstrap
 rake db:migrate
+cp config/config.yml.example config/config.yml
 rm public/index.html
 rm app/views/layouts/application.html.erb  
   

data/lib/generators/ucb_rails/templates/app/views/layouts/_developer.html.haml

@@ -1,5 +1,6 @@
 = nav_dropdown("Developer") do
   = dropdown_item("Bootstrap Examples", bvh_path)
+  = dropdown_item(icon('exclamation-sign', "Force Exception"), ucb_rails_admin_force_exception_path)
 
   - if RailsEnvironment.development?
     = dropdown_divider

data/lib/generators/ucb_rails/templates/config/config.yml.example

@@ -0,0 +1,56 @@
+# You can have configuration per-environment by nesting under the
+# environment key, or have a top level.
+
+
+    
+# ldap:
+#   username: <username>
+#   password: <password>
+
+development:
+
+  # email:
+  #   default:
+  #     from: user@gmail.com
+  #   default_url_options:
+  #     host: example.com
+  #   delivery_method: :smtp
+  #   # delivery_method: :sendmail
+  #   # delivery_method: :test
+  #   # delivery_method: :file
+  #   raise_delivery_errors: true
+  #   # send_mail_settings:
+  #   #   location: "/usr/sbin/sendmail"
+  #   #   arguments: "-i -t"
+  #   smtp_settings:
+  #     address: smtp.gmail.com
+  #     port: 587
+  #     domain: gmail.com
+  #     user_name: <username>
+  #     password: <password>
+  #     authentication: plain
+  #     enable_starttls_auto: true
+  #   subject_prefix: '[My App {env}] '
+
+  # exception_notification:
+  #   email:
+  #     email_prefix: '[My App - Error {env}] '
+  #     sender_address: user@example.com
+  #     exception_recipients:
+  #       - user1@example.com
+  #       - user2@example.com
+
+  # ldap:
+  #   username: <username>
+  #   password: <password>
+
+test:
+  email:
+    default:
+      from: test-user@examle.com
+    default_url_options:
+      host: example.com
+    delivery_method: :test
+    raise_delivery_errors: true
+    subject_prefix: '[My App {env}] '
+

data/lib/generators/ucb_rails/templates/config/initializers/local/ucb_rails.rb

@@ -1,18 +1,33 @@
 ############################################################
-# Load credentials from config/credentials.yml
+# Load configuration from config/config.yml
 ############################################################
 
-credentials_file = Rails.root.join('config/credentials.yml')
-credentials = File.exists?(credentials_file) ? YAML.load_file(credentials_file) : {}
+config = UcbRails::Configuration::Configuration.new
+
+############################################################
+# ActionMailer
+############################################################
+
+UcbRails::Configuration::Email.configure(config.for('email'))
+
+############################################################
+# Exception Notification
+############################################################
+
+UcbRails::Configuration::ExceptionNotification.configure(config.for('exception_notification'))
 
 ############################################################
 # UCB::LDAP
 ############################################################
 
 UCB::LDAP.host = 'nds.berkeley.edu'
-ldap_credentials = credentials["ldap"] || credentials[Rails.env].try(:[], "ldap")
-UCB::LDAP.authenticate(ldap_credentials['username'], ldap_credentials['password']) if ldap_credentials
-
+if ldap_credentials = config.for('ldap')
+  puts "[UcbRails] Using ldap credentials from #{config.config_filename}"
+  UCB::LDAP.authenticate(ldap_credentials['username'], ldap_credentials['password'])
+else
+  puts "[UcbRails] No ldap credentials found.  Using anonymous bind."
+end
+  
 ############################################################
 # OmniAuth
 ############################################################

data/lib/ucb_rails.rb

@@ -11,6 +11,8 @@ require 'bootstrap-sass'
 require 'active_attr'
 require 'simple_form'
 require 'jquery-datatables-rails'
+require 'exception_notification'
+require 'bootstrap-datepicker-rails'
 
 require 'rails_environment'
 require 'ucb_ldap'

data/lib/ucb_rails/version.rb

@@ -1,3 +1,3 @@
 module UcbRails
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ucb_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,6 +59,22 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.0.0.pre1
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: omniauth
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +219,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bootstrap-datepicker-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails_environment
   requirement: !ruby/object:Gem::Requirement
@@ -210,7 +242,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -218,7 +250,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: bootstrap-view-helpers
   requirement: !ruby/object:Gem::Requirement
@@ -531,6 +563,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - app/controllers/ucb_rails/admin/base_controller.rb
+- app/controllers/ucb_rails/admin/force_exception_controller.rb
 - app/controllers/ucb_rails/admin/users_controller.rb
 - app/controllers/ucb_rails/bootstrap_controller.rb
 - app/controllers/ucb_rails/controller_methods.rb
@@ -547,6 +580,10 @@ files:
 - app/helpers/ucb_rails/renderer/base.rb
 - app/helpers/ucb_rails/renderer/ldap_person_search_result_link.rb
 - app/helpers/ucb_rails/renderer/lps_typeahead_search_field.rb
+- app/mailers/ucb_rails/test_mailer.rb
+- app/models/ucb_rails/configuration/configuration.rb
+- app/models/ucb_rails/configuration/email.rb
+- app/models/ucb_rails/configuration/exception_notification.rb
 - app/models/ucb_rails/ldap_person/entry.rb
 - app/models/ucb_rails/ldap_person/finder.rb
 - app/models/ucb_rails/ldap_person/test_finder.rb
@@ -584,6 +621,7 @@ files:
 - lib/generators/ucb_rails/templates/app/views/layouts/_footer.html.haml
 - lib/generators/ucb_rails/templates/app/views/layouts/_navigation.html.haml
 - lib/generators/ucb_rails/templates/app/views/layouts/application.html.haml
+- lib/generators/ucb_rails/templates/config/config.yml.example
 - lib/generators/ucb_rails/templates/config/initializers/local/active_record/dom_and_haml.rb
 - lib/generators/ucb_rails/templates/config/initializers/local/haml_buffer.rb
 - lib/generators/ucb_rails/templates/config/initializers/local/simple_form.rb