mno-enterprise-core 2.0.0

data/lib/mno_enterprise/concerns/controllers/auth/sessions_controller.rb

@@ -0,0 +1,54 @@
+module MnoEnterprise::Concerns::Controllers::Auth::SessionsController
+  extend ActiveSupport::Concern
+  
+  #==================================================================
+  # Included methods
+  #==================================================================
+  # 'included do' causes the included code to be evaluated in the
+  # context where it is included rather than being executed in the module's context
+  included do
+    prepend_before_filter :capture_return_to_redirection
+    # before_filter :configure_sign_in_params, only: [:create]
+  end
+  
+  #==================================================================
+  # Class methods
+  #==================================================================
+  module ClassMethods
+    # def some_class_method
+    #   'some text'
+    # end
+  end
+  
+  #==================================================================
+  # Instance methods
+  #==================================================================
+  # GET /resource/sign_in
+  # def new
+  #   super
+  # end
+  
+  # POST /resource/sign_in
+  # def create
+  #   super
+  # end
+  # def create
+  #   self.resource = warden.authenticate!(auth_options)
+  #   set_flash_message(:notice, :signed_in) if is_flashing_format?
+  #   sign_in(resource_name, resource)
+  #   yield resource if block_given?
+  #   respond_with resource, location: after_sign_in_path_for(resource)
+  # end
+
+  # DELETE /resource/sign_out
+  # def destroy
+  #   super
+  # end
+
+  # protected
+
+  # You can put the params you want to permit in the empty array.
+  # def configure_sign_in_params
+  #   devise_parameter_sanitizer.for(:sign_in) << :attribute
+  # end
+end

data/lib/mno_enterprise/concerns/controllers/auth/unlocks_controller.rb

@@ -0,0 +1,50 @@
+module MnoEnterprise::Concerns::Controllers::Auth::UnlocksController
+  extend ActiveSupport::Concern
+  
+  #==================================================================
+  # Included methods
+  #==================================================================
+  # 'included do' causes the included code to be evaluated in the
+  # context where it is included rather than being executed in the module's context
+  included do
+  end
+  
+  #==================================================================
+  # Class methods
+  #==================================================================
+  module ClassMethods
+    # def some_class_method
+    #   'some text'
+    # end
+  end
+  
+  #==================================================================
+  # Instance methods
+  #==================================================================
+  # GET /resource/unlock/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/unlock
+  # def create
+  #   super
+  # end
+
+  # GET /resource/unlock?unlock_token=abcdef
+  # def show
+  #   super
+  # end
+
+  # protected
+
+  # The path used after sending unlock password instructions
+  # def after_sending_unlock_instructions_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after unlocking the resource
+  # def after_unlock_path_for(resource)
+  #   super(resource)
+  # end
+end

data/lib/mno_enterprise/concerns/models.rb

@@ -0,0 +1,6 @@
+module MnoEnterprise
+  module Concerns
+    module Models
+    end
+  end
+end

data/lib/mno_enterprise/concerns/models/ability.rb

@@ -0,0 +1,108 @@
+module MnoEnterprise::Concerns::Models::Ability
+  extend ActiveSupport::Concern
+
+  #==================================================================
+  # Included methods
+  #==================================================================
+  included do
+  end
+
+  #==================================================================
+  # Class methods
+  #==================================================================
+  module ClassMethods
+    # def some_class_method
+    #   'some text'
+    # end
+  end
+
+  #==================================================================
+  # Instance methods
+  #==================================================================
+  def initialize(user)
+    user ||= MnoEnterprise::User.new
+
+    #===================================================
+    # Organization
+    #===================================================
+    can :create, MnoEnterprise::Organization
+
+    can :read, MnoEnterprise::Organization do |organization|
+      !!user.role(organization)
+    end
+
+    can [:update, :destroy, :manage_billing], MnoEnterprise::Organization do |organization|
+      user.role(organization) == 'Super Admin'
+    end
+
+    can [:upload,
+         :purchase,
+         :invite_member,
+         :administrate,
+         :manage_app_instances,
+         :manage_teams], MnoEnterprise::Organization do |organization|
+      ['Super Admin','Admin'].include? user.role(organization)
+    end
+
+    # To be updated
+    can :sync_apps, MnoEnterprise::Organization do |organization|
+      user.role(organization)
+    end
+
+    # To be updated
+    can :check_apps_sync, MnoEnterprise::Organization do |organization|
+      user.role(organization)
+    end
+
+    #===================================================
+    # AppInstance
+    #===================================================
+    can :access, MnoEnterprise::AppInstance do |app_instance|
+      !!user.role(app_instance.owner) && (
+      ['Super Admin','Admin'].include?(user.role(app_instance.owner)) ||
+          user.teams.empty? ||
+          user.teams.map(&:app_instances).compact.flatten.map(&:id).include?(app_instance.id)
+      )
+    end
+
+    #===================================================
+    # Impac
+    #===================================================
+    impac_abilities(user)
+
+    # Define abilities for the passed in user here. For example:
+    #
+    #   user ||= User.new # guest user (not logged in)
+    #   if user.admin?
+    #     can :manage, :all
+    #   else
+    #     can :read, :all
+    #   end
+    #
+    # The first argument to `can` is the action you are giving the user
+    # permission to do.
+    # If you pass :manage it will apply to every action. Other common actions
+    # here are :read, :create, :update and :destroy.
+    #
+    # The second argument is the resource the user can perform the action on.
+    # If you pass :all it will apply to every resource. Otherwise pass a Ruby
+    # class of the resource.
+    #
+    # The third argument is an optional hash of conditions to further filter the
+    # objects.
+    # For example, here the user can only update published articles.
+    #
+    #   can :update, Article, :published => true
+    #
+    # See the wiki for details:
+    # https://github.com/CanCanCommunity/cancancan/wiki/Defining-Abilities
+  end
+
+  def impac_abilities(user)
+    can :manage_impac, MnoEnterprise::Impac::Dashboard do |dhb|
+      dhb.organizations.any? && dhb.organizations.all? do |org|
+        !!user.role(org) && ['Super Admin', 'Admin'].include?(user.role(org))
+      end
+    end
+  end
+end

data/lib/mno_enterprise/concerns/models/app_instance.rb

@@ -0,0 +1,100 @@
+# == Schema Information
+#
+# Endpoint:
+#  - /v1/app_instances
+#  - /v1/organizations/:organization_id/app_instances
+#
+#  id                   :integer         not null, primary key
+#  uid                  :string(255)
+#  name                 :string(255)
+#  status               :string(255)
+#  app_id               :integer
+#  created_at           :datetime        not null
+#  updated_at           :datetime        not null
+#  started_at           :datetime
+#  stack                :string(255)
+#  owner_id             :integer
+#  owner_type           :string(255)
+#  terminated_at        :datetime
+#  stopped_at           :datetime
+#  billing_type         :string(255)
+#  autostop_at          :datetime
+#  autostop_interval    :integer
+#  next_status          :string(255)
+#  soa_enabled          :boolean         default(FALSE)
+#
+# ===> to be confirmed
+#  http_url
+#  durations                :text
+#  microsoft_licence_id :integer
+#
+
+module MnoEnterprise::Concerns::Models::AppInstance
+  extend ActiveSupport::Concern
+
+  #==================================================================
+  # Included methods
+  #==================================================================
+  # 'included do' causes the included code to be evaluated in the
+  # context where it is included rather than being executed in the module's context
+  included do
+    attributes :id, :uid, :name, :status, :app_id, :created_at, :updated_at, :started_at, :stack, :owner_id,
+    :owner_type, :terminated_at, :stopped_at, :billing_type, :autostop_at, :autostop_interval,
+    :next_status, :soa_enabled, :oauth_keys_valid, :oauth_company
+
+    #==============================================================
+    # Constants
+    #==============================================================
+    ACTIVE_STATUSES = [:running,:stopped,:staged,:provisioning,:starting,:stopping,:updating]
+    TERMINATION_STATUSES = [:terminating,:terminated]
+
+    #==============================================================
+    # Associations
+    #==============================================================
+    belongs_to :owner, class_name: 'MnoEnterprise::Organization'
+    belongs_to :app, class_name: 'MnoEnterprise::App'
+
+    # Define connector_stack?, cloud_stack? etc. methods
+    [:cube,:cloud,:connector].each do |stackname|
+      define_method("#{stackname}_stack?") do
+        self.stack == stackname.to_s
+      end
+    end
+
+    scope :active, -> { where('status.in' => ACTIVE_STATUSES) }
+  end
+
+  #==================================================================
+  # Class methods
+  #==================================================================
+  module ClassMethods
+    # def some_class_method
+    #   'some text'
+    # end
+  end
+
+  #==================================================================
+  # Instance methods
+  #==================================================================
+  # Send a request to terminate the AppInstance
+  # Alias of destroy
+  # TODO: specs
+  def terminate
+    self.destroy
+  end
+
+  # Return true if the instance can be considered active
+  # Route53 DNS propagation may take up to a minute, so we force a minimum of 60 seconds before considering the application online
+  def active?
+    ACTIVE_STATUSES.include?(self.status.to_sym)
+  end
+
+  def running?
+    self.status == 'running'
+  end
+
+  def online?
+    running? && [self.created_at, self.started_at].compact.max < 70.seconds.ago
+  end
+
+end

data/lib/mno_enterprise/concerns/models/organization.rb

@@ -0,0 +1,102 @@
+# == Schema Information
+#
+# Endpoint:
+#  - /v1/organizations
+#  - /v1/users/:user_id/organizations
+#
+#  id                       :integer         not null, primary key
+#  uid                      :string(255)
+#  name                     :string(255)
+#  created_at               :datetime        not null
+#  updated_at               :datetime        not null
+#  account_frozen           :boolean         default(FALSE)
+#  free_trial_end_at        :datetime
+#  soa_enabled              :boolean         default(TRUE)
+#  mails                    :text
+#  logo                     :string(255)
+#  latitude                 :float           default(0.0)
+#  longitude                :float           default(0.0)
+#  geo_country_code         :string(255)
+#  geo_state_code           :string(255)
+#  geo_city                 :string(255)
+#  geo_tz                   :string(255)
+#  geo_currency             :string(255)
+#  meta_data                :text
+#  industry                 :string(255)
+#  size                     :string(255)
+#
+
+module MnoEnterprise::Concerns::Models::Organization
+  extend ActiveSupport::Concern
+
+  #==================================================================
+  # Included methods
+  #==================================================================
+  # 'included do' causes the included code to be evaluated in the
+  # context where it is included rather than being executed in the module's context
+  included do
+    attributes :uid, :name, :account_frozen, :free_trial_end_at, :soa_enabled, :mails, :logo,
+      :latitude, :longitude, :geo_country_code, :geo_state_code, :geo_city, :geo_tz, :geo_currency,
+      :meta_data, :industry, :size
+
+    scope :in_arrears, -> { where(in_arrears?: true) }
+
+    #================================
+    # Associations
+    #================================
+    has_many :users, class_name: 'MnoEnterprise::User'
+    has_many :org_invites, class_name: 'MnoEnterprise::OrgInvite'
+    has_many :app_instances, class_name: 'MnoEnterprise::AppInstance'
+    has_many :invoices, class_name: 'MnoEnterprise::Invoice'
+    has_one  :credit_card, class_name: 'MnoEnterprise::CreditCard'
+    has_many :teams, class_name: 'MnoEnterprise::Team'
+    has_many :dashboards, class_name: 'MnoEnterprise::Impac::Dashboard'
+    has_one :raw_last_invoice, class_name: 'MnoEnterprise::Invoice', path: '/last_invoice'
+    has_one :app_instances_sync, class_name: 'MnoEnterprise::AppInstancesSync'
+  end
+
+  #==================================================================
+  # Class methods
+  #==================================================================
+  module ClassMethods
+    # def some_class_method
+    #   'some text'
+    # end
+  end
+
+  #==================================================================
+  # Instance methods
+  #==================================================================
+  # Return the list of users + active invites
+  # TODO: specs
+  def members
+    [self.users,self.org_invites.active].flatten
+  end
+
+  # Add a user to the organization with the provided role
+  # TODO: specs
+  def add_user(user,role = 'Member')
+    self.users.create(id: user.id, role: role)
+  end
+
+  def last_invoice
+    inv = self.raw_last_invoice
+    inv.id ? inv : nil
+  end
+  # def last_invoice_with_nil
+  #   last_invoice.respond_to?(:id) ? last_invoice : nil
+  # end
+  # alias_method_chain :last_invoice, :nil
+
+  # Remove a user from the organization
+  # TODO: specs
+  def remove_user(user)
+    self.users.destroy(id: user.id)
+  end
+
+  # Change a user role in the organization
+  # TODO: specs
+  def update_user(user, role = 'Member')
+    self.users.update(id: user.id, role: role)
+  end
+end

data/lib/mno_enterprise/core.rb

@@ -0,0 +1,279 @@
+require 'prawn'
+require 'prawn/table'
+require 'money'
+require 'deepstruct'
+require 'jwt'
+require 'countries'
+require 'cancancan'
+require 'devise'
+require 'devise/strategies/remote_authenticatable'
+require 'devise_extension'
+require "her"
+require "her_extension/her_orm_adapter"
+require "her_extension/model/orm"
+require "her_extension/model/relation"
+require "her_extension/model/attributes"
+require "her_extension/model/parse"
+require "her_extension/model/associations/association"
+require "her_extension/model/associations/association_proxy"
+require "her_extension/model/associations/has_many_association"
+require "her_extension/middleware/mnoe_api_v1_parse_json"
+require "faraday_middleware"
+require "mno_enterprise/engine"
+
+require 'mno_enterprise/database_extendable'
+
+require 'mandrill'
+require "mandrill_client"
+
+require 'accountingjs_serializer'
+
+module MnoEnterprise
+
+  #==================================================================
+  # MnoEnterprise Router
+  # Centralizes all URLs available on the Maestrano Enterprise side
+  #==================================================================
+  class Router
+    attr_accessor :terms_url
+
+    # Customise after_sign_out url
+    attr_accessor :after_sign_out_url
+
+    def terms_url
+      @terms_url || '#'
+    end
+
+    def launch_url(id,opts = {})
+      host_url("/launch/#{id}",opts)
+    end
+
+    def authorize_oauth_url(id,opts = {})
+      host_url("/oauth/#{id}/authorize",opts)
+    end
+
+    def disconnect_oauth_url(id,opts = {})
+      host_url("/oauth/#{id}/disconnect",opts)
+    end
+
+    def sync_oauth_url(id,opts = {})
+      host_url("/oauth/#{id}/sync",opts)
+    end
+
+    def impac_root_url
+      URI.join(MnoEnterprise.impac_api_host,MnoEnterprise.impac_api_root_path)
+    end
+
+    private
+      def base_path
+        MnoEnterprise.mno_api_root_path
+      end
+
+      def host
+        MnoEnterprise.mno_api_host
+      end
+
+      def host_url(path,opts = {})
+        url = URI.join(host,"#{base_path}#{path}").to_s
+        url += "?#{opts.to_query}" if opts.any?
+        url
+      end
+  end
+
+  #==================================================================
+  # Module definition
+  #==================================================================
+
+  #====================================
+  # Tenant
+  #====================================
+  # Maestrano Enterprise Tenant name
+  mattr_accessor :app_name
+  @@tenant_name = 'Maestrano Enterprise'
+
+  # Maestrano Enterprise Default Country
+  mattr_accessor :app_country
+  @@app_country = 'US'
+
+  # Maestrano Enterprise Default Currency
+  mattr_accessor :app_currency
+  @@app_currency = 'USD'
+
+  # Maestrano Enterprise Tenant ID
+  mattr_accessor :tenant_id
+  @@tenant_id = nil
+
+  # Maestrano Enterprise Tenant Key
+  mattr_accessor :tenant_key
+  @@tenant_key = nil
+
+  #====================================
+  # Impac
+  #====================================
+  mattr_accessor :impac_api_host
+  @@impac_api_host = 'https://api-impac-uat.maestrano.io'
+
+  mattr_accessor :impac_api_root_path
+  @@impac_api_root_path = "/api/v1"
+
+  #====================================
+  # Enterprise API
+  #====================================
+  # The Maestrano Enterprise API Host
+  mattr_accessor :mno_api_host
+  @@mno_api_host = "https://api-enterprise.maestrano.com"
+
+  # The Maestrano Enterprise API Private Host
+  # Used within VPCs for making calls to mno_api using
+  # private DNS
+  mattr_accessor :mno_api_private_host
+  @@mno_api_private_host = nil
+
+  # The Maestrano Enterprise API base path
+  mattr_accessor :mno_api_root_path
+  @@mno_api_root_path = "/v1"
+
+  # Hold the Her API configuration (see configure_api method)
+  mattr_reader :mnoe_api_v1
+  @@mnoe_api_v1 = nil
+
+  # Hold the Maestrano enterprise router (redirection to central enterprise platform)
+  mattr_reader :router
+  @@router = Router.new
+
+
+  #====================================
+  # Emailing
+  #====================================
+  # Mandrill Key for sending emails
+  # Points to the default maestrano enterprise account
+  mattr_accessor :mandrill_key
+  @@mandrill_key = 'QcrLVdukhBi7iYrTeWHRPQ'
+
+  # The support email address
+  mattr_accessor :support_email
+  @@support_email = "support@example.com"
+
+  # Default sender name
+  mattr_accessor :default_sender_name
+  @@default_sender_name = nil
+
+  # Default sender email
+  mattr_accessor :default_sender_email
+  @@default_sender_email = "no-reply@example.com"
+
+  #===============================================
+  # Optional Modules
+  #===============================================
+  # Angular CSRF
+  mattr_accessor :include_angular_csrf
+  @@include_angular_csrf = false
+
+  #====================================
+  # Third Party Plugins
+  #====================================
+  mattr_accessor :google_tag_container
+  @@google_tag_container = nil
+
+  #====================================
+  # Layout & Styling
+  #====================================
+  # Nested structure defining the general style of the application
+  mattr_accessor :styleguide
+  mattr_accessor :style
+  @@styleguide = nil
+  @@style = nil
+
+  #====================================
+  # Marketplace
+  #====================================
+  # List of applications that should be offered on
+  # the marketplace
+  mattr_accessor :marketplace_listing
+  @@marketplace_listing = nil
+
+  #====================================
+  # Module Methods
+  #====================================
+
+  # Always reload style in development
+  def self.style
+    self.configure_styleguide if Rails.env.development?
+    @@style
+  end
+
+  # Default way to setup MnoEnterprise. Run rails generate mno-enterprise:install to create
+  # a fresh initializer with all configuration values.
+  def self.configure
+    yield self
+    self.configure_styleguide
+    self.configure_api
+  end
+
+  # Create a JSON web token with the provided payload
+  # E.g.: MnoEnterprise.jwt({ user_id: 'usr-427431' })
+  def self.jwt(payload)
+    secret = "#{self.tenant_id}:#{self.tenant_key}"
+    iat = Time.now.utc.to_i
+
+    JWT.encode(payload.merge(
+      iss: MnoEnterprise.tenant_id,
+      iat: iat,
+      jit: Digest::MD5.hexdigest("#{secret}:#{iat}")
+    ), secret)
+  end
+
+  private
+    # Return the options to use in the setup of the API
+    def self.api_options
+      api_host = @@mno_api_private_host || @@mno_api_host
+      {
+          url: "#{URI.join(api_host,@@mno_api_root_path).to_s}",
+          send_only_modified_attributes: true
+      }
+    end
+
+    # Load the provided styleguide hash into nested structure or load a default one
+    def self.configure_styleguide
+      # Load default gem configuration
+      hash = YAML.load(File.read(File.join(MnoEnterprise::Engine.root,'config','styleguide.yml')))
+
+      # Load default app styleguide, unless explicitly specified
+      default_path = File.join(Rails.root,'config','mno_enterprise_styleguide.yml')
+      if !@@styleguide && File.exists?(default_path)
+        @@styleguide = YAML.load(File.read(default_path))
+      end
+
+      @@styleguide.is_a?(Hash) && hash.deep_merge!(@@styleguide)
+      @@style = DeepStruct.wrap(hash)
+    end
+
+    # Configure the Her for Maestrano Enterprise API V1
+    def self.configure_api
+      # Configure HER for Maestrano Enterprise Endpoints
+      @@mnoe_api_v1 = Her::API.new
+      @@mnoe_api_v1.setup self.api_options  do |c|
+        # Request
+        c.use Faraday::Request::BasicAuthentication, @@tenant_id, @@tenant_key
+        # c.use Faraday::Request::UrlEncoded
+        c.request :json
+
+        # Instrumentation in development
+        c.use :instrumentation if Rails.env.development?
+
+        # Response
+        c.use Her::Middleware::MnoeApiV1ParseJson
+
+        # Adapter
+        c.use Faraday::Adapter::NetHttpNoProxy
+      end
+    end
+end
+
+# Instrumentation in development
+ActiveSupport::Notifications.subscribe('request.faraday') do |name, starts, ends, _, env|
+  url = env[:url]
+  http_method = env[:method].to_s.upcase
+  duration = ends - starts
+  Rails.logger.debug '[%s] %s %s (%.3f s)' % [url.host, http_method, url.request_uri, duration]
+end if Rails.env.development?