Class: SupplejackApi::Generators::InstallGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/supplejack_api/install_generator.rb

Instance Method Summary collapse

Instance Method Details

#add_assetsObject


93
94
95
96
97
98
# File 'lib/generators/supplejack_api/install_generator.rb', line 93

def add_assets
  insert_into_file "app/assets/javascripts/application.js", "//= require highcharts/highcharts\n", :after => "jquery_ujs\n"
  insert_into_file "app/assets/javascripts/application.js", "//= require highcharts/highcharts-more\n", :after => "jquery_ujs\n"
  insert_into_file "app/assets/javascripts/application.js", "//= require highcharts/highstock\n", :after => "jquery_ujs\n"
  insert_into_file "app/assets/stylesheets/application.css", "\n *= require supplejack_api/application", :after => "require_self"
end

#config_filesObject


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# File 'lib/generators/supplejack_api/install_generator.rb', line 18

def config_files
  puts "\nInstalling config files into config/"

  copy_file('config/application.yml.example', 'config/application.yml')
  copy_file 'config/mongoid.yml'
  copy_file 'config/resque-pool.yml'
  copy_file 'config/resque_schedule.yml'
  copy_file 'config/sunspot.yml'

  puts "\nGenerating secret token"

  inject_into_file('config/application.yml', before: /^\sdevelopment:/) do
    "  SECRET_TOKEN: '#{Digest::SHA1.hexdigest([Time.now, rand].join)}'\n"
  end
end

#create_schemaObject


85
86
87
88
89
90
91
# File 'lib/generators/supplejack_api/install_generator.rb', line 85

def create_schema
  puts "\nCreating Schemas in app/supplejack_api/"

  empty_directory 'app/supplejack_api'
  copy_file 'app/supplejack_api/record_schema.txt', 'app/supplejack_api/record_schema.rb'
  copy_file 'app/supplejack_api/concept_schema.rb'
end

#documentationObject


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/generators/supplejack_api/install_generator.rb', line 100

def documentation
  if options.documentation?
    string = []
    string << 'Welcome to Supplejack API.'
    string << "Installation process is complete.\n"
    string << 'In order to have have a working API, follow the steps below:'
    string << '1. Implement your data schema in app/supplejack_api/schema.rb. See comments for DSL documentation'
    string << '2. Edit config/application.yml and set all the keys to the correct values for your environments'
    string << "3. Start Solr via via `bundle exec rake sunspot:solr:start|stop`. Ensure it's working by going to http://localhost:8983/solr/, you should see the Solr dashboard"
    string << "4. Start the rails console via `bundle exec rails console`. Perform the next commands in the rails console"
    string << "5. Use a local Solr session so updates are immediate via `Sunspot.session = Sunspot::Rails.build_session`"
    string << "6. Create a user via `user = SupplejackApi::User.create(email: '[email protected]', name: 'Test User')`"
    string << "7. Create a record via `record = SupplejackApi::Record.create(internal_identifier: 'abc123', status: 'active', source_url: 'http://boost.co.nz/')`"
    string << "8. Add your custom data (from schema.rb) to the record's primary fragment via `record.primary_fragment.<field_name>=<value>`. Then `record.save!`"
    string << "9. Start the rails server via `bundle exec rails server -p 3000`"
    string << "10. Retrieve a specific record by going to http://localhost:3000/records/<record.record_id>.json?api_key=<user.api_key>"
    string << "11. Perform a search by going to http://localhost:3000/records.json?api_key=<user.api_key>"
    string << "12. You now have a working API!"

    puts string.join("\n")
  end
end

#environment_filesObject


54
55
56
57
58
59
# File 'lib/generators/supplejack_api/install_generator.rb', line 54

def environment_files
  puts "\nInstalling environment files into config/environments/"

  copy_file 'config/environments/production.rb'
  gsub_file('config/environments/production.rb', 'Dummy::Application', Rails.application.class.to_s)
end

#initializersObject


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/generators/supplejack_api/install_generator.rb', line 38

def initializers
  puts "\nInstalling initializers into config/initializers/"

  copy_file 'config/initializers/devise.rb'
  copy_file 'config/initializers/kaminari_config.rb'
  copy_file 'config/initializers/quiet_logger.rb'
  copy_file 'config/initializers/resque.rb'
  copy_file 'config/initializers/simple_form.rb'
  copy_file 'config/initializers/simple_form_foundation.rb'
  copy_file 'config/initializers/state_machine.rb'
  copy_file 'config/initializers/sunspot.rb'
  copy_file 'config/initializers/mongoid.rb'

  directory 'config/locales'
end

#mount_engineObject


66
67
68
69
70
# File 'lib/generators/supplejack_api/install_generator.rb', line 66

def mount_engine
  puts "\nMounting SupplejackApi::Engine at / in config/routes.rb"

  inject_into_file('config/routes.rb', "\n  mount SupplejackApi::Engine => '/', as: 'supplejack_api'\n\n", :before => /^end/)
end

#solr_config_filesObject


61
62
63
64
# File 'lib/generators/supplejack_api/install_generator.rb', line 61

def solr_config_files
  puts "\nInstalling Solr config files into solr/"
  directory 'solr'
end

#update_gemfileObject


72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/generators/supplejack_api/install_generator.rb', line 72

def update_gemfile
  puts "\nAdding dependencies into Gemfile"

  inject_into_file('Gemfile', after: /^gem.*supplejack_api.*/) do
    string = [""]
    string << "gem 'sunspot_rails', '~> 2.2.0'"
    string << "gem 'active_model_serializers', git: 'https://github.com/boost/active_model_serializers.git'"
    string << "gem 'mongoid_auto_inc', git: 'https://github.com/boost/mongoid_auto_inc.git'"

    string.join("\n")
  end
end

#workersObject


34
35
36
# File 'lib/generators/supplejack_api/install_generator.rb', line 34

def workers
  directory 'app/workers'
end