mno-enterprise 3.0.7 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 819f497bc543c37d9c22ee8912c1477695267308
-  data.tar.gz: 1165ab475abb3e30b223ec68ce2801ea654f0b35
+  metadata.gz: 2d2d6dcd42e6df47e98018eed8e3b5fd7b53569d
+  data.tar.gz: c5fb8d12b8310cb8e205a1c957d48971d0e3f8ba
 SHA512:
-  metadata.gz: 31d3f6deb8be8fc23fc9644bbbd417fff368d7c157dc3d150289e8a43fca836b44f499fcaab4823322746651d576b63fe549d42d3fdc427b947a3dbddb9923ab
-  data.tar.gz: 8f81e6eb485f05d158a8afd875571d6cab5c6a70e1908a3843646278afdd171381bdf5895685ad1bb845cc630984e374bdeaf18ba7b748b8d6831fe990e72bc2
+  metadata.gz: d51d76eb36dc20cbac2f1586ed1592bb19815c42a75d5684064485bc587fd7244300e7461fff9b5b4db189b4f872c8c641d0c8b3eea5e2167777fe23b4b98c87
+  data.tar.gz: 111fafe66029ab4ff15d7920249cc060f4f4ac5403a3a4948c2ed4be3589c95c8e7e759c61e8de25dff06bcc77c1baed2e60a939b4cd402b221762076c27c448

data/README.md

@@ -5,6 +5,10 @@
 </p>
 
 [![Gem Version](https://badge.fury.io/rb/mno-enterprise.svg)](https://rubygems.org/gems/mno-enterprise)
+[![Build Status](https://travis-ci.org/maestrano/mno-enterprise.svg?branch=master)](https://travis-ci.org/maestrano/mno-enterprise)
+[![Dependency Status](https://gemnasium.com/badges/github.com/maestrano/mno-enterprise.svg)](https://gemnasium.com/github.com/maestrano/mno-enterprise)
+[![Code Climate](https://codeclimate.com/github/maestrano/mno-enterprise/badges/gpa.svg)](https://codeclimate.com/github/maestrano/mno-enterprise)
+[![Test Coverage](https://codeclimate.com/github/maestrano/mno-enterprise/badges/coverage.svg)](https://codeclimate.com/github/maestrano/mno-enterprise/coverage)
 
 The Maestrano Enterprise Engine can be included in a Rails project to bootstrap an instance of Maestrano Enterprise Express.
 
@@ -13,17 +17,18 @@ The goal of this engine is to provide a base that you can easily extend with cus
 - - -
 
 1.  [Install](#install)
-2.  [Building the Frontend](#building-the-frontend)
-3.  [Modifying the style - Theme Previewer](#modifying-the-style---theme-previewer)
-4.  [Extending the Frontend](#extending-the-frontend)
-5.  [Replacing the Frontend](#replacing-the-frontend)
-6.  [Generating a database extension](#generating-a-database-extension)
-7.  [Deploying](#deploying)
+2.  [Configuration](#configuration)
+3.  [Building the Frontend](#building-the-frontend)
+4.  [Modifying the style - Theme Previewer](#modifying-the-style---theme-previewer)
+5.  [Extending the Frontend](#extending-the-frontend)
+6.  [Replacing the Frontend](#replacing-the-frontend)
+7.  [Generating a database extension](#generating-a-database-extension)
+8.  [Deploying](#deploying)
     1.  [Deploy a Puma stack on EC2 via Webistrano/Capistrano](#deploy-a-puma-stack-on-ec2-via-webistranocapistrano)
     2.  [Sample nginx config for I18n](#sample-nginx-config-for-i18n)
     3.  [Health Checks](#health-checks)
-8.  [Migrating from v2 to v3](#migrating-from-v2-to-v3)
-9.  [Contributing](#contributing)
+9.  [Migrating from v2 to v3](#migrating-from-v2-to-v3)
+10. [Contributing](#contributing)
 
 - - -
 
@@ -33,7 +38,7 @@ The goal of this engine is to provide a base that you can easily extend with cus
 
 You can generate a complete rails project using the application template:
 ```ruby
-rails new [project_name] -TSOJ -m https://raw.githubusercontent.com/maestrano/mno-enterprise/master/rails-template/mnoe-app-template.rb
+rails new [project_name] -TOJ -m https://raw.githubusercontent.com/maestrano/mno-enterprise/master/rails-template/mnoe-app-template.rb
 ```
 
 For more details see the template [README](rails-template/README.md).
@@ -70,6 +75,86 @@ Once node is installed, you can run the following commands to ensure that all de
 bin/rake mnoe:frontend:install_dependencies
 ```
 
+## Configuration
+
+### Emailing platform
+
+Maestrano Enterprise support either [Mandrill](https://www.mandrill.com/) or [SparkPost](https://www.sparkpost.com/).
+
+You can use either provider as long as your account has the [required templates](https://maestrano.atlassian.net/wiki/display/MNOE/Emailing).
+
+If you  want to copy the default templates to your own account you can use the tools in `tools/emails`
+
+#### Mandrill
+
+```ruby
+# Gemfile
+gem 'mandrill-api', '~> 1.0.53'
+
+# config/application.yml
+MANDRILL_API_KEY: api_key
+
+# config/initializers/mno_enterprise.rb
+MnoEnterprise.configure do |config|
+  config.mail_adapter = :mandrill
+end
+```
+
+#### SparkPost
+
+```ruby
+# Gemfile
+gem 'sparkpost', '~> 0.1.4'
+
+# config/application.yml
+SPARKPOST_API_KEY: api_key
+
+# config/initializers/mno_enterprise.rb
+MnoEnterprise.configure do |config|
+  config.mail_adapter = :sparkpost
+end
+```
+
+#### SMTP
+SMTP server settings are needed to send emails via SMTP. In case there's no SMTP server, a personal gmail account could be used as an alternative.
+To use gmail to send SMTP emails, the gmail account should be set to allow "less secure apps".
+Typically for security reasons, system environment variables 'SMTP_USERNAME' and 'SMTP_PASSWORD' should be used to set the SMTP credentials.
+
+```ruby
+# Gemfile
+gem 'premailer-rails'
+
+# config/environments/production.rb
+Rails.application.configure do
+  config.action_mailer.raise_delivery_errors = false
+  config.action_mailer.default_url_options = { :host => host_domain, :port => port_number }
+  config.action_mailer.asset_host = your_apps_root_url
+  config.action_mailer.delivery_method = :smtp
+  ActionMailer::Base.smtp_settings = {
+    address:              'smtp.gmail.com',
+    port:                 587,
+    domain:               'gmail.com',
+    user_name:            ENV['SMTP_USERNAME'],
+    password:             ENV['SMTP_PASSWORD'],
+    authentication:       'plain',
+    enable_starttls_auto: true  
+  }
+end
+
+# config/initializers/mno_enterprise.rb
+MnoEnterprise.configure do |config|
+  config.mail_adapter = :smtp
+end
+
+# config/initializers/assets.rb
+Rails.application.config.assets.precompile += %w( mno_enterprise/mail.css )
+```
+
+##### Customization of mail templates
+- You can override the default mail templates by adding template files ( template-name.html.erb, template-name.text.erb ) to the mail view directory (/app/views/system_notifications).
+- Logo can also be overriden by adding your own logo image (main-logo.png) to the image assets directory (/app/assets/images/mno_enterprise).
+- Write your own stylesheet by adding mail.css file to the stylesheets directory (/app/assets/stylesheets/mno_enterprise). The css rules you write will be applied to all the mail templates including the default ones.
+
 ## Building the frontend
 The Maestrano Enterprise frontend is a Single Page Application (SPA) that is separate from the Rails project. The source code for this frontend can be found on the [mno-enterprise-angular Github repository](https://github.com/maestrano/mno-enterprise-angular)
 
@@ -113,6 +198,21 @@ foreman start -f Procfile.dev
 
 This will accelerate your development as the gulp serve task use BrowserSync to reload the browser any time a file is changed.
 
+### Adding a custom font
+
+It is possible to add custom fonts, shared all over the rails application screens and the AngularJS SPA.
+
+Simply copy the font files under the directory `/frontend/src/fonts/` of your host application and create a `font-faces.less` file containing your *font-face* definitions.
+
+An example of a project using a custom font can be seen on the [mno-enterprise-demo](https://github.com/maestrano/mno-enterprise-demo) project.
+
+NB: Your host project may have been generated or created before the implementation of this feature, in this case make sure the the file `/app/assets/stylesheets/main.less` contains:
+```less
+// Import custom fonts
+//--------------------------------------------
+@import "../../../frontend/src/fonts/font-faces";
+```
+
 ## Replacing the Frontend
 
 In some cases you may decide that the current [mno-enterprise-angular](https://github.com/maestrano/mno-enterprise-angular) frontend is not appropriate at all.
@@ -197,27 +297,11 @@ There are various endpoints to perform health checks:
 {
   "app-version": "9061048-6811c4a",
   "mno-enterprise-version": "0.0.1",
-  "env": "test",
-  "mno-api-host": "https://api-hub.maestrano.com"
+  "env": "test"
 }
 ```
 
-`/mnoe/health_check` & `/mnoe/health_check/full`: Complete health check (cache, smtp, database, ...).
-See [health_check](https://github.com/ianheggie/health_check) and the [initalizer](api/config/initializers/health_check.rb) for the default configuration.
-
-You can override it by creating an initalizer in the host app, eg:
-
-```ruby
-# my-mnoe-app/config/initializers/health_check.rb
-HealthCheck.setup do |config|
-  # You can customize which checks happen on a standard health check
-  config.standard_checks = %w(cache site)
-
-  # You can set what tests are run with the 'full' or 'all' parameter
-  config.full_checks = %w(cache site custom database migrations)
-end
-```
-
+`/mnoe/health_check` & `/mnoe/health_check/full`: Complete health check (cache, smtp, database, ...). See [health_check](https://github.com/ianheggie/health_check)
 
 ## Migrating from v2 to v3
 
@@ -227,7 +311,7 @@ First switch to a new branch such as v2-to-v3.
 git co -b v2-to-v3
 ```
 
-Open your Gemfile and ensure that your project points to the v3.0-dev of Maestrano Enterprise. You gemfile should look like this:
+Open your Gemfile and ensure that your project points to the v3.0-dev branch of Maestrano Enterprise. You gemfile should look like this:
 ```ruby
 gem 'mno-enterprise', git: 'https://some-token:x-oauth-basic@github.com/alachaum/mno-enterprise.git', branch: 'v3.0-dev'
 ```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mno-enterprise
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 3.1.0
 platform: ruby
 authors:
 - Arnaud Lachaume
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mno-enterprise-core
@@ -17,42 +17,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.7
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.7
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: mno-enterprise-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.7
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.7
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: mno-enterprise-frontend
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.7
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.7
+        version: 3.1.0
 description: Maestrano Enterprise is your application marketplace, out of the box.
 email:
 - developers@maestrano.com