sztywny-smsonrails 0.1.2

data/db/migrate/sms_on_rails_carrier_tables.rb

@@ -0,0 +1,9 @@
+
+    create_table :sms_phone_carriers, :force => true do |t|
+      t.string :name,           :length => 100, :null => false
+      t.string :email_domain,   :length => 100, :default => nil
+      t.string :notes,                          :default => nil
+      t.string :options,                        :default => nil
+    end
+
+    add_index :sms_phone_carriers, :name, :unique => 'true', :name => 'uk_phone_carriers_name'

data/db/migrate/sms_on_rails_model_tables.rb

@@ -0,0 +1,48 @@
+    use_fk = respond_to?(:add_foreign_key)
+    puts "#{use_fk ? '': 'NOT'} USING FOREIGN KEYS"
+    
+    create_table :sms_drafts, :force => true do |t|
+      t.column :message, :string, :default => nil
+      t.column :header, :string, :default => nil
+      t.column :footer, :string, :default => nil
+      t.column :status, :string, :limit => 15, :null => false, :default => 'NOT_PROCESSED'
+      t.column :deliver_after, :datetime, :default => nil
+      t.column :delivery_date, :datetime, :default => nil
+      t.column :sender_id, :integer, :default => nil
+      t.column :lock_version, :integer, :null => false, :default => 0, :limit => 1
+      t.column :options, :string, :default => nil
+      t.column :updated_at, :string, :default => nil
+      t.column :created_at, :string, :default => nil
+    end
+
+
+    #Add a unique id to track vendor
+    create_table :sms_outbounds, :force => true do |t|
+      t.column :sms_phone_number_id, :integer, :null => false, :references => :phone_number, :on_delete => :cascade
+      t.column :sms_draft_id, :integer, :default => nil, :on_delete => :cascade
+      t.column :status, :string, :limit => 15, :null => false, :default => 'NOT_PROCESSED'
+      t.column :retry_count,  :integer, :limit => 1, :null => false, :default => 0
+      t.column :sub_status, :string, :limit => 35, :default => nil
+      t.column :notes, :string, :limit => 80, :default => nil
+      t.column :created_at, :datetime, :default => nil
+      t.column :processed_on, :datetime, :default => nil
+      t.column :lock_version, :integer, :null => false, :default => 0, :limit => 1
+      t.column :sms_service_provider_id, :integer, :limit => 4, :default => nil, :references => nil
+      t.column :options, :string, :default => nil
+      t.column :send_priority,  :integer, :limit => 4, :null => false, :default => 0
+      t.column :actual_message, :string, :limit => 160, :null => true, :default => nil
+      t.column :unique_id, :string, :default => nil
+    end
+
+    add_index :sms_outbounds, :unique_id, :unique => 'true', :name => 'uk_sms_outbounds_unique_id'
+    add_index :sms_outbounds, [:sms_draft_id, :sms_phone_number_id], :unique => 'true', :name => 'uk_sms_outbounds_draft_phone_number'
+
+    # Add composite accross sms_outbounds for lookup speed
+    #add_index :sms_outbounds, [:status, :send_priority, :sms_draft_id], :name => 'idx_sms_outbounds_status_priority_draft'
+
+    #Add a unique id to track vendor
+    unless use_fk
+      #add_index :sms_outbounds, :sms_draft_id
+      #do not index :sms_draft_id because their is already a composite on
+      add_index :sms_outbounds, :sms_phone_number_id
+    end

data/db/migrate/sms_on_rails_phone_number_tables.rb

@@ -0,0 +1,11 @@
+    create_table :phone_numbers, :force => true do |t|
+      t.string  :number,       :length => 20,  :null => false
+      t.integer :carrier_id,                                   :default => nil
+      t.integer :owner_id,                                     :default => nil
+      t.boolean :white_list,                   :null => false, :default => false
+      t.string  :do_not_send,  :length => 30,                  :default => nil
+      t.integer :country_code, :length => 2,                   :default => 1
+    end
+
+    add_index :phone_numbers, :number, :unique => 'true', :name => 'uk_phone_numbers_number'
+    

data/db/seed_data.rb

@@ -0,0 +1,16 @@
+require 'active_record/fixtures'
+
+unless defined?(SmsOnRails::PhoneCarrier)
+  require 'sms_on_rails/phone_carrier'
+end
+
+fixture_class_names = {
+  :sms_phone_carriers => 'SmsOnRails::PhoneCarrier',
+}
+
+fixture_path = File.dirname(__FILE__) + '/data/fixtures'
+
+fixture_files = Dir.glob(fixture_path + '/*.yml').collect{|f| File.basename(f, '.yml')}
+fixture_class_names.values.each {|klass| klass.constantize.delete_all }
+
+Fixtures.create_fixtures(fixture_path, fixture_files, fixture_class_names)

data/generators/sms_on_rails/USAGE

@@ -0,0 +1,31 @@
+Description:
+    Setup Sms On Rails
+
+    The following actions can be specified seperately or together
+
+    environment (default)
+      - add the configuration to config/environment.rb and runs dependencies
+    models
+      - copy the vanilla models up to app/models/sms_on_rails so they can be
+        edited/overwritten accordingly
+    dependencies
+      - install dependent plugins and gems (enviroment does this automatically)
+    migration (default)
+      - creates three migration templates for sms tables. To skip one, for example if
+        only the carriers and phone numbers are desired,
+        use --skip-models, --skip-phone-number or --skip-carriers to skip
+
+Example:
+  Set up the environment and create models in app/models/sms_on_rails
+    ./script/generate sms_on_rails setup environment models
+
+  Just setup the environment and create the migration
+    ./script/generate sms_on_rails setup
+
+  Setup the views
+    ./script/generate sms_on_rails setup views
+
+  Create a migration skipping models migration
+    ./script/generate sms_on_rails setup migration --skip-models
+
+

data/generators/sms_on_rails/commands/inserts.rb

@@ -0,0 +1,63 @@
+# Most of this was derived from the clearance gem work
+Rails::Generator::Commands::Base.class_eval do
+
+  # Return true if the file contains the line (String or Regexp)
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).scan(line).any?
+  end
+
+  def margin_text(options={})
+    margin = ' ' * (options[:margin]||2)
+    margin
+  end
+
+  def append_to_file(relative_destination, content)
+    path = destination_path(relative_destination)
+    File.open(path, 'ab') { |file| file.write("\n" + content + "\n") }
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+
+  # Insert the new line into the file
+  # +file+ - the name of the file to update
+  # +new_line+ - the new line to insert
+  # == Options
+  # <tt>:quiet</tt> - turn off logging
+  # <tt>:append</tt> - when true append to the end of the file instead of <tt>:insert_after</tt>
+  # <tt>:match</tt> - (String or Regexp). If the file contents matches then do not add this line again. This defaults to the actual line itself
+  # <tt>:replace</tt> - (Regexp) Replace the matching regexp completely with the new line. If nothing matches the replace regexp, append to the end of the file. <tt>:insert_after</tt> value is ignored.
+  # <tt>:insert_after</tt> (Regexp) Insert the new line after this match. By default, the line is inserted after a class or module
+  # <tt>:margin</tt> - length of the margin to add before the line. Defaults to 2.
+  def insert_into(file, new_line, options={})
+    logger.insert "#{new_line} into #{file}" unless options[:quiet]
+    
+    line = margin_text(options) + new_line
+
+    unless options[:pretend] || file_contains?(file, options[:match]||line)
+      if options[:append] || (options[:replace] && !file_contains?(file, options[:replace]))
+        append_to_file file, line
+      else
+        regex = options[:insert_after]||options[:replace]||/^(class|module) .+$/
+        gsub_file file, regex do |match|
+          options[:replace] ? line : "#{match}\n#{line}"
+        end
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def insert_into(file, line, options={})
+    logger.remove "#{line} from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n#{margin_text(options)}#{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+  end
+end

data/generators/sms_on_rails/commands/timestamps.rb

@@ -0,0 +1,33 @@
+Rails::Generator::Commands::Create.class_eval do
+
+  #overwrite next migration string to add a count to the timestamp
+  def next_migration_string(padding = 3)#:nodoc:
+    if ActiveRecord::Base.timestamped_migrations
+      time_str = Time.now.utc.strftime("%Y%m%d%H%M%S")
+      time_str << "#{migration_count}" if migration_count > 1
+      time_str
+    else
+      "%.#{padding}d" % next_migration_number
+    end
+  end
+
+  def migration_count
+    @@mig_count||=0
+  end
+
+  def increment_migration_count
+    @@mig_count = migration_count + 1
+  end
+
+  # When creating a migration, it knows to find the first available file in db/migrate and use the migration.rb template.
+  def migration_template(relative_source, relative_destination, template_options = {})#:nodoc:
+    increment_migration_count
+    migration_directory relative_destination
+    migration_file_name = template_options[:migration_file_name] || file_name
+    if migration_exists?(migration_file_name)
+      logger.exists "#{existing_migrations(migration_file_name).first}"
+    else
+      template(relative_source, "#{relative_destination}/#{next_migration_string}_#{migration_file_name}.rb", template_options)
+    end
+  end
+end

data/generators/sms_on_rails/runners/add_all_models.rb

@@ -0,0 +1,6 @@
+append_file 'config/environment.rb', <<-EOS
+# Include vanilla sms models. If you wish to make changes and create your own
+# models/sms_on_rails this line should be removed.
+require 'sms_on_rails/all_models'
+
+EOS

data/generators/sms_on_rails/runners/dependencies.rb

@@ -0,0 +1 @@
+plugin 'static_record_cache', :git => 'git://github.com/blythedunham/static_record_cache.git'

data/generators/sms_on_rails/runners/remove_all_models.rb

@@ -0,0 +1,5 @@
+
+sentinel = "[^#](require\\s+['|\"]sms_on_rails/all_models['|\"])"
+gsub_file 'config/environment.rb', Regexp.new(sentinel) do |match|
+  "\n##{match.strip}"
+end

data/generators/sms_on_rails/runners/sms_on_rails_routes.rb

@@ -0,0 +1,14 @@
+
+  route <<-EOS
+
+  #Resources for sms on rails admin routes
+  #url: localhost:3000/admin/sms/drafts goes to the app/controllers/admin/sms_on_rails/draft_controller.rb
+  map.resources :sms_drafts,         :as => 'admin/sms/drafts',         :controller => 'admin/sms_on_rails/drafts'  do |draft|
+    draft.resources :outbounds,      :controller => 'admin/sms_on_rails/outbounds'
+  end
+  map.resources :sms_phone_numbers,  :as => 'admin/sms/phone_numbers',  :controller => 'admin/sms_on_rails/phone_numbers'
+  map.resources :sms_outbounds,      :as => 'admin/sms/outbounds',      :controller => 'admin/sms_on_rails/outbounds'
+  map.resources :sms_phone_carriers, :as => 'admin/sms/phone_carriers', :controller => 'admin/sms_on_rails/phone_carriers'
+EOS
+
+ 

data/generators/sms_on_rails/sms_on_rails_generator.rb

@@ -0,0 +1,255 @@
+require 'rails_generator/generators/applications/app/template_runner'
+require File.dirname(__FILE__) + '/commands/inserts.rb'
+require File.dirname(__FILE__) + '/commands/timestamps.rb'
+
+class SmsOnRailsGenerator < Rails::Generator::NamedBase
+
+  default_options  :skip_models => false,         :skip_carriers => false,
+                   :skip_phone_numbers => false,  :skip_migration => false,
+                   :default_service_provider =>   :email_gateway
+
+  unless defined?(SERVICE_PROVIDERS)
+    SERVICE_PROVIDERS           = [:clickatell, :email_gateway]
+    SET_SERVICE_PROVIDER_CONFIG = "SmsOnRails::ServiceProviders::Base.set_default_service_provider"
+  end
+  
+  def manifest
+    @actions = (actions.blank?) ? %w(environment migration phone_collision assets) : self.actions
+    @actions.sort! #we want environment to run first
+    @actions.delete('dependencies') if @actions.include?('environment')
+
+    record do |m|
+      @actions.each do |action|
+         case(action)
+           when 'views'           then create_views(m)
+           when 'models'          then copy_models(m)
+           when 'environment'     then add_configuation_options(m)
+           when 'dependencies'    then add_dependencies(m)
+           when 'migration'       then generate_migration_templates(m)
+           when 'phone_collision' then handle_phone_number_collision(m)
+           when 'assets'          then copy_assets(m)
+         end
+      end
+    end
+  end
+
+  def after_generate
+  end
+
+  protected
+
+  def banner
+    "Usage: #{$0} sms_on_rails setup [models views environment]"
+  end
+
+  # options specific to sms on rails generator
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("-m", "--skip-models",
+           "Skip the models migration",
+           "Default: false") { |v| options[:skip_models] = v }
+    opt.on("-c", "--skip-carriers",
+           "Skip the phone carriers migrations",
+           "Default: false") { |v| options[:skip_carriers] = v }
+    opt.on("-p", "--skip-phone-numbers",
+           "Skip the phone numbers migrations",
+           "Default: false") { |v| options[:skip_phone_numbers] = v }
+    opt.on("-s", "--default-service-provider=[name]",
+           "Name of the default service provider: clickatell or email_gateway",
+           "Default: email_gateway") { |v| options[:default_service_provider] = v.to_s.downcase.underscore.to_sym }
+  end
+
+  # If app/models/phone_number.rb exists, add include the Sms functionality
+  # and define app/models/sms_on_rails/phone_number.rb to point to PhoneNumber
+  def handle_phone_number_collision(m)
+    #if the phone_number.rb file exists on the main
+    phone_number_model = "app/models/phone_number.rb"
+    if File.exists?(phone_number_model)
+      m.insert_into phone_number_model, "include SmsOnRails::ModelSupport::PhoneNumber             # include custom sms on rails phone number handling"
+      m.insert_into phone_number_model, "include SmsOnRails::ModelSupport::PhoneNumberAssociations # remove this for custom sms on rails associations"
+
+      sms_on_rails_dir = File.join("app", "models", "sms_on_rails")
+      m.directory sms_on_rails_dir
+      m.file "phone_number_collision.rb", File.join(sms_on_rails_dir, "phone_number.rb")
+    end
+  end
+
+  # add sms on rails dependencies such as the clickatell gem and static record cache
+  def add_dependencies(m)
+    add_clickatell_gem(m) if options[:default_service_provider] == :clickatell
+    logger.log 'plugin', 'static_record_cache'
+    run_template 'dependencies'
+  end
+
+  # add the clickatell gem dependency to the app's config/enviornment.rb file
+  def add_clickatell_gem(m)
+    logger.log 'gem', 'clickatell'
+    m.insert_into 'config/environment.rb', "config.gem 'clickatell'\n",
+                  :margin => 2, :insert_after => /Rails::Initializer\.run.*\n/, :quiet => true
+  end
+  
+  #copy up the public folder
+  def copy_assets(m)
+    create_app_files(m, 'public', :dest_base => '.', :relative_src => '/../../../')
+  end
+
+  # Use template runner to run specified template and output message
+  def run_template(template_name, message = nil)
+    logger.log message.first, message.last if message
+    logger.quiet = true
+    Rails::TemplateRunner.new(File.join(File.dirname(__FILE__),'runners', template_name + '.rb'), @destination_root)
+  ensure
+    logger.quiet = options[:quiet]
+  end
+
+  # generate the 3 sms on rails migrations by creating them in the main app dir
+  def generate_migration_templates(m)
+    generate_migration_template(m, :carrier)                          unless options[:skip_carriers]
+    generate_migration_template(m, :phone_number, phone_mig_options)  unless options[:skip_phone_numbers]
+    generate_migration_template(m, :model)                            unless options[:skip_models]
+  end
+
+  #change to update if phone number exists
+  def phone_mig_options
+    if ActiveRecord::Base.connection.table_exists?(:phone_numbers)
+      {:migration_file_name => 'sms_on_rails_update_phone_numbers' }
+    else
+      {}
+    end
+  end
+
+  #generate the specified migration template
+  def generate_migration_template(m, migration_name, options={})
+    return if options[:skip_migration]
+
+    migration_file_name =  options[:migration_file_name]||"sms_on_rails_create_#{migration_name}s"
+    template_file_name  = (options[:migration_file_name]||'schema_migration') +'.rb'
+
+    m.migration_template "migrate/#{template_file_name}", 'db/migrate', :assigns => {
+      :migration_name => "#{migration_file_name.classify}s",
+      :files => ["sms_on_rails_#{migration_name}_tables"]
+    }, :migration_file_name => migration_file_name
+
+  end
+
+  def add_configuation_options(m)
+    add_require_all_models unless supports_engines?
+    add_dependencies(m)
+
+    logger.update "configuration options in environment.rb"
+    disable_logger do
+      add_service_provider_configuration(m)
+      add_default_service_provider(m)
+    end
+  end
+
+  protected
+
+  def disable_logger(&block)
+   logger.quiet = true
+   yield
+  ensure
+    logger.quiet = options[:quiet]
+  end
+
+  def add_service_provider_configuration(m)
+    SERVICE_PROVIDERS.each do |sp_name|
+      config_file = File.dirname(__FILE__) + "/templates/configuration/#{sp_name}.rb"
+      if File.exists?(config_file)
+        m.insert_into 'config/environment.rb', File.read(config_file),
+          :margin => 0, :append => true, :quiet => true,
+          :match => "SmsOnRails::ServiceProviders::#{sp_name.to_s.classify}.config"
+      end
+    end
+  end
+
+
+  def add_default_service_provider(m)
+    line = "#{SET_SERVICE_PROVIDER_CONFIG} #{options[:default_service_provider].to_sym.inspect}"
+
+    m.insert_into "config/environment.rb", line, :margin => 0, :quiet => true,
+      :replace => Regexp.new("#{SET_SERVICE_PROVIDER_CONFIG}.*(\\n|$)")
+  end
+
+
+  ##############################################################################
+  # Pre Rails engine support: copy to app directly
+  ##############################################################################
+
+  def create_views(m)
+    create_admin_view_files m
+    create_helper_files m
+    create_controller_files m
+    add_sms_routes
+  end
+  
+  def copy_models(m)
+    create_app_files(m, 'models/sms_on_rails')
+    remove_require_all_models
+  end
+
+  def add_sms_routes
+    return if supports_engines?
+    run_template 'sms_on_rails_routes', ['routes', 'sms_on_rails routes']
+  end
+
+  #return true if the rails version has support for engines
+  def supports_engines?
+    @@supports_engines ||= ActiveRecord::VERSION::STRING >= '2.3.0'
+  end
+
+  # remove the require 'sms_on_rails/all_models.rb from environment.rb'
+  def remove_require_all_models
+    run_template 'remove_all_models', ['removing', 'references to vanilla models']
+  end
+
+  # add the require 'sms_on_rails/all_models.rb from environment.rb'
+  def add_require_all_models
+    if !@actions.include?('models') && !File.exists?(File.join(@destination_root, 'app/models/sms_on_rails'))
+      run_template 'add_all_models', ['using', 'all vanilla models']
+    end
+  end
+
+  # create admin views by copying to main app/views
+  def create_admin_view_files(m)
+    create_app_files(m, 'views/admin/sms_on_rails')
+  end
+
+  # create admin views by copying to main app/helper
+  def create_helper_files(m)
+    create_app_files(m, 'helpers/admin/sms_on_rails')
+    create_app_files(m, 'helpers/sms_on_rails')
+  end
+
+  # create admin views by copying to main app/controller
+  def create_controller_files(m)
+    create_app_files(m, 'controllers/admin/sms_on_rails')
+  end
+
+  #recursively copy files from templates/* to app/*
+  def create_app_files(m, dir, options={})
+    
+    dest_base = options[:dest_base]||'app'
+    relative_src = (options[:relative_src]||'/../../../app').to_s
+    actual_src = File.join(source_root, relative_src)
+
+    m.directory(File.join(dest_base, dir))
+
+    Dir.glob(File.join(actual_src, dir, '*')) do |f|
+      relative_path = relative_source_path(f, actual_src)
+      if File.directory?(f)
+        create_app_files(m, relative_path, options)
+      else
+        m.file(File.join(relative_src, relative_path) , File.join(dest_base, relative_path))
+      end
+    end
+  end
+
+  #path relative to the source root
+  def relative_source_path(path, src_base = source_root)
+    File.expand_path(path).gsub(File.expand_path(src_base) + '/', '')
+  end
+
+end
+