mno-enterprise-core 2.0.0

data/app/models/mno_enterprise/credit_card.rb

@@ -0,0 +1,40 @@
+# == Schema Information
+#
+# Endpoint: 
+#  - /v1/credit_cards
+#  - /v1/organizations/:organization_id/credit_card
+#
+#  id               :integer         not null, primary key
+#  title            :string(255)
+#  first_name       :string(255)
+#  last_name        :string(255)
+#  country          :string(255)
+#  masked_number    :string(255)
+#  month            :integer
+#  year             :integer
+#  user_id          :integer
+#  token            :string(255)
+#  created_at       :datetime        not null
+#  updated_at       :datetime        not null
+#  owner_id         :integer
+#  owner_type       :string(255)
+#  billing_address  :text
+#  billing_city     :string(255)
+#  billing_postcode :string(255)
+#  billing_country  :string(255)
+#  duplicated       :boolean         default(FALSE)
+#
+
+module MnoEnterprise
+  class CreditCard < BaseResource
+    
+    attributes :id, :created_at, :updated_at, :title, :first_name, :last_name, :country, :masked_number, :number,
+    :month, :year, :billing_address, :billing_city, :billing_postcode, :billing_country, :verification_value, :organization_id
+    
+    #==============================================================
+    # Associations
+    #==============================================================
+    belongs_to :organization, class_name: 'MnoEnterprise::Organization'
+    
+  end
+end

data/app/models/mno_enterprise/deletion_request.rb

@@ -0,0 +1,35 @@
+# == Schema Information
+#
+# Table name: deletion_requests
+#
+#  id             :integer         not null, primary key
+#  token          :string(255)
+#  status         :string(255)
+#  created_at     :datetime        not null
+#  updated_at     :datetime        not null
+#
+
+module MnoEnterprise
+  class DeletionRequest < BaseResource
+    attributes :id, :token, :status, :user_id
+
+    #==============================================================
+    # Associations
+    #==============================================================
+    belongs_to :user, class_name: 'MnoEnterprise::User'
+
+    #============================================
+    # Instance methods
+    #============================================
+    # We want to use the token instead of the id
+    def to_param
+      self.token
+    end
+
+    # TODO: specs
+    # Freeze user acocunt and update the deletion request
+    def freeze_account!
+      self.put(operation: 'freeze')
+    end
+  end
+end

data/app/models/mno_enterprise/impac/dashboard.rb

@@ -0,0 +1,36 @@
+module MnoEnterprise
+  class Impac::Dashboard < BaseResource
+
+    attributes :name, :widgets_order, :organization_ids, :widgets_templates, :currency
+
+	  has_many :widgets, class_name: 'MnoEnterprise::Impac::Widget', dependent: :destroy
+	  has_many :kpis, class_name: 'MnoEnterprise::Impac::Kpi', dependent: :destroy
+	  belongs_to :owner, polymorphic: true
+	  
+	  #============================================
+	  # Instance methods
+	  #============================================
+	  # Return the full name of this dashboard
+	  # Currently a simple accessor to the dashboard name (used to include the company name)
+	  def full_name
+	    self.name
+	  end
+	  
+	  # Return all the organizations linked to this dashboard and to which
+	  # the user has access
+	  def organizations
+	  	self.organization_ids.map do |uid|
+	    	MnoEnterprise::Organization.find_by(uid: uid)
+	  	end
+	  end
+
+	  def sorted_widgets
+	    order = self.widgets_order.map(&:to_i) | self.widgets.map{|w| w.id }
+	    order.map { |id| self.widgets.to_a.find{ |w| w.id == id} }.compact
+	  end
+
+    def to_audit_event
+      name
+    end
+  end
+end

data/app/models/mno_enterprise/impac/dashboard_provisioner.rb

@@ -0,0 +1,5 @@
+module MnoEnterprise
+  class Impac::DashboardProvisioner < BaseResource
+    attributes :dashboards
+  end
+end

data/app/models/mno_enterprise/impac/kpi.rb

@@ -0,0 +1,9 @@
+module MnoEnterprise
+  class Impac::Kpi < BaseResource
+
+    attributes :name, :settings, :targets, :extra_params, :endpoint, :source, :element_watched
+
+    belongs_to :dashboard, class_name: 'MnoEnterprise::Impac::Dashboard'
+    
+  end
+end

data/app/models/mno_enterprise/impac/widget.rb

@@ -0,0 +1,13 @@
+module MnoEnterprise
+  class Impac::Widget < BaseResource
+
+  	attributes :name, :width, :widget_category, :settings
+
+    belongs_to :dashboard, class_name: 'MnoEnterprise::Impac::Dashboard'
+
+    def to_audit_event
+      name
+    end
+
+  end
+end

data/app/models/mno_enterprise/invoice.rb

@@ -0,0 +1,53 @@
+# == Schema Information
+#
+# Endpoint:
+#  - /v1/invoices
+#  - /v1/organizations/:organization_id/invoices
+#
+#  id                     :integer         not null, primary key
+#  price_cents            :integer
+#  currency               :string(255)
+#  invoicable_type        :string(255)
+#  invoicable_id          :integer
+#  started_at             :datetime
+#  ended_at               :datetime
+#  created_at             :datetime        not null
+#  updated_at             :datetime        not null
+#  paid_at                :datetime
+#  pdf                    :string(255)
+#  payment_id             :integer
+#  transferred_from_id    :integer
+#  transferred_from_type  :string(255)
+#  transferred_at         :datetime
+#  account_transaction_id :integer
+#  resolver_invoice_id    :integer
+#  resolving_invoice_id   :integer
+#  slug                   :string(255)
+#  promo_voucher_id       :integer
+#  tax_pips_applied       :integer
+#  billing_address        :text
+#  partner_invoice_id     :integer
+#  mnoe_tenant_id         :integer
+#
+
+module MnoEnterprise
+  class Invoice < BaseResource
+    #==============================================================
+    # Associations
+    #==============================================================
+    belongs_to :organization, class_name: 'MnoEnterprise::Organization'
+    
+    # Return a label describing the time period
+    # this invoice covers
+    def period_label
+      return '' unless self.started_at && self.ended_at
+      "#{self.started_at.strftime("%b %d,%Y")} to #{self.ended_at.strftime("%b %d,%Y")}"
+    end
+    
+    # Return true if the invoice has been paid
+    # false otherwise
+    def paid?
+      !self.paid_at.blank?
+    end
+  end
+end

data/app/models/mno_enterprise/org_invite.rb

@@ -0,0 +1,50 @@
+# == Schema Information
+#
+# Endpoint:
+#  - /v1/org_invites
+#  - /v1/organizations/:organization_id/org_invites
+#
+#  id              :integer         not null, primary key
+#  user_id         :integer
+#  user_email      :string(255)
+#  organization_id :integer
+#  referrer_id     :integer
+#  token           :string(255)
+#  status          :string(255)
+#  created_at      :datetime        not null
+#  updated_at      :datetime        not null
+#  user_role       :string(255)
+#  team_id         :integer
+#
+
+module MnoEnterprise
+  class OrgInvite < BaseResource
+    scope :active, -> { where(status: 'pending') }
+    
+    #==============================================================
+    # Associations
+    #==============================================================
+    belongs_to :user, class_name: 'MnoEnterprise::User'
+    belongs_to :referrer, class_name: 'MnoEnterprise::User'
+    belongs_to :organization, class_name: 'MnoEnterprise::Organization'
+    belongs_to :team, class_name: 'MnoEnterprise::Team'
+    
+    # TODO: specs
+    # Add the user to the organization and update the status of the invite
+    # Add team
+    def accept!(user = self.user)
+      self.put(operation: 'accept', data: { user_id: user.id})
+    end
+    
+    # TODO: specs
+    def cancel!
+      self.put(operation: 'cancel')
+    end
+    
+    # TODO: specs
+    # Check whether the invite is expired or not
+    def expired?
+      self.status != 'pending' || self.created_at < 3.days.ago
+    end
+  end
+end

data/app/models/mno_enterprise/organization.rb

@@ -0,0 +1,33 @@
+# == 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
+  class Organization < BaseResource
+    include MnoEnterprise::Concerns::Models::Organization
+  end
+end

data/app/models/mno_enterprise/team.rb

@@ -0,0 +1,50 @@
+# == Schema Information
+#
+# Endpoint:
+#  - /v1/teams
+#  - /v1/organizations/:organization_id/teams
+#
+#  id              :integer         not null, primary key
+#  name            :string(255)
+#  created_at      :datetime        not null
+#  updated_at      :datetime        not null
+#  organization_id :integer
+#
+
+module MnoEnterprise
+  class Team < BaseResource
+    
+    attributes :id, :name, :organization_id
+    
+    #=====================================
+    # Associations
+    #=====================================
+    belongs_to :organization, class_name: 'MnoEnterprise::Organization'
+    has_many :users, class_name: 'MnoEnterprise::User'
+    has_many :app_instances, class_name: 'MnoEnterprise::AppInstance'
+    
+    
+    # Add a user to the team
+    # TODO: specs
+    def add_user(user)
+      self.users.create(id: user.id)
+    end
+    
+    # Remove a user from the team
+    # TODO: specs
+    def remove_user(user)
+      self.users.destroy(id: user.id)
+    end
+    
+    # Set the app_instance permissions of this team
+    # Accept a collection of hashes or an array of ids
+    # TODO: specs
+    def set_access_to(collection_or_array)
+      # Empty arrays do not seem to be passed in the request. Force value in this case
+      list = collection_or_array.empty? ? [""] : collection_or_array
+      self.put(data: { set_access_to: list })
+      self.reload
+      self
+    end
+  end
+end

data/app/models/mno_enterprise/tenant.rb

@@ -0,0 +1,5 @@
+module MnoEnterprise
+  class Tenant < BaseResource
+
+  end
+end

data/app/models/mno_enterprise/tenant_invoice.rb

@@ -0,0 +1,5 @@
+module MnoEnterprise
+  class TenantInvoice < BaseResource
+
+  end
+end

data/app/models/mno_enterprise/user.rb

@@ -0,0 +1,183 @@
+# == Schema Information
+#
+# Endpoint: 
+#   - /v1/users
+#   - /v1/organizations/:organization_id/users
+#
+#  id                             :string          e.g.: 1
+#  uid                            :string          e.g.: usr-k3j23npo
+#  email                          :string(255)     default(""), not null
+#  authenticatable_salt           :string(255)     used for session authentication
+#  encrypted_password             :string(255)     default(""), not null
+#  reset_password_token           :string(255)
+#  reset_password_sent_at         :datetime
+#  remember_created_at            :datetime
+#  sign_in_count                  :integer         default(0)
+#  current_sign_in_at             :datetime
+#  last_sign_in_at                :datetime
+#  current_sign_in_ip             :string(255)
+#  last_sign_in_ip                :string(255)
+#  confirmation_token             :string(255)
+#  confirmed_at                   :datetime
+#  confirmation_sent_at           :datetime
+#  unconfirmed_email              :string(255)
+#  failed_attempts                :integer         default(0)
+#  unlock_token                   :string(255)
+#  locked_at                      :datetime
+#  created_at                     :datetime        not null
+#  updated_at                     :datetime        not null
+#  name                           :string(255)
+#  surname                        :string(255)            
+#  company                        :string(255)   
+#  phone                          :string(255)
+#  phone_country_code             :string(255)
+#  geo_country_code               :string(255)
+#  geo_state_code                 :string(255)
+#  geo_city                       :string(255)  
+#  website                        :string(255)  
+#
+
+module MnoEnterprise
+  class User < BaseResource
+    extend Devise::Models
+    
+    # Note: password and encrypted_password are write-only attributes and are never returned by
+    # the remote API. If you are looking for a session token, use authenticatable_salt
+    attributes :uid, :email, :password, :current_password, :password_confirmation, :authenticatable_salt, :encrypted_password, :reset_password_token, :reset_password_sent_at, 
+      :remember_created_at, :sign_in_count, :current_sign_in_at, :last_sign_in_at, :current_sign_in_ip, 
+      :last_sign_in_ip, :confirmation_token, :confirmed_at, :confirmation_sent_at, :unconfirmed_email, 
+      :failed_attempts, :unlock_token, :locked_at, :name, :surname, :company, :phone, :phone_country_code, 
+      :geo_country_code, :geo_state_code, :geo_city, :website, :orga_on_create, :sso_session, :current_password_required
+    
+    define_model_callbacks :validation #required by Devise
+    devise :remote_authenticatable, :registerable, :recoverable, :rememberable,
+      :trackable, :validatable, :lockable, :confirmable, :timeoutable, :password_expirable
+
+    #================================
+    # Validation
+    #================================
+    validates_uniqueness_of :email, allow_blank: true, if: :email_changed?
+
+    if Devise.password_regex
+      validates :password, format: { with: Devise.password_regex, message: Devise.password_regex_message }, if: :password_required?
+    end
+
+    #================================
+    # Associations
+    #================================
+    has_many :organizations, class_name: 'MnoEnterprise::Organization'
+    has_many :org_invites, class_name: 'MnoEnterprise::OrgInvite'
+    has_one :deletion_request, class_name: 'MnoEnterprise::DeletionRequest'
+    has_many :dashboards, class_name: 'MnoEnterprise::Impac::Dashboard'
+    has_many :teams, class_name: 'MnoEnterprise::Team'
+
+    #================================
+    # Callbacks
+    #================================
+    before_save :expire_user_cache
+
+    #================================
+    # Class Methods
+    #================================
+    # The auth_hash includes an email and password
+    # Return nil in case of failure
+    def self.authenticate(auth_hash)
+      u = self.post("user_sessions", auth_hash)
+      
+      if u && u.id
+        u.clear_attribute_changes!
+        return u
+      end
+      
+      nil
+    end
+    
+    #================================
+    # Devise Confirmation
+    # TODO: should go in a module
+    #================================
+    
+    
+    # Override Devise to allow confirmation via original token
+    # Less secure but useful if user has been created by Maestrano Enterprise
+    # (happens when an orga_invite is sent to a new user)
+    #  
+    # Find a user by its confirmation token and try to confirm it.
+    # If no user is found, returns a new user with an error.
+    # If the user is already confirmed, create an error for the user
+    # Options must have the confirmation_token
+    def self.confirm_by_token(confirmation_token)
+      confirmable = self.find_for_confirmation(confirmation_token)
+      confirmable.perform_confirmation(confirmation_token)
+      confirmable
+    end
+    
+    # Find a user using a confirmation token
+    def self.find_for_confirmation(confirmation_token)
+      original_token     = confirmation_token
+      confirmation_token = Devise.token_generator.digest(self, :confirmation_token, confirmation_token)
+      
+      confirmable = find_or_initialize_with_error_by(:confirmation_token, confirmation_token)
+      confirmable = find_or_initialize_with_error_by(:confirmation_token, original_token) if confirmable.errors.any?
+      confirmable
+    end
+    
+    # Confirm the user and store confirmation_token
+    def perform_confirmation(confirmation_token)
+      self.confirm if self.persisted?
+      self.confirmation_token = confirmation_token
+    end
+    
+    # It may happen that that the errors attribute become nil, which breaks the controller logic (rails responder)
+    # This getter ensures that 'errors' is always initialized
+    def errors
+      @errors ||= ActiveModel::Errors.new(self)
+    end
+
+    #================================
+    # Instance Methods
+    #================================
+
+    def to_s
+      "#{name} #{surname}"
+    end
+
+    # Format for audit log
+    def to_audit_event
+      {
+        user_name: to_s,
+        user_email: email
+      }
+    end
+
+    # Default value for failed attempts
+    def failed_attempts
+      read_attribute(:failed_attempts) || 0
+    end
+    
+    # Override Devise default method
+    def authenticatable_salt
+      read_attribute(:authenticatable_salt)
+    end
+    
+    # Return the role of this user for the provided
+    # organization
+    def role(organization = nil)
+      # Return cached version if available
+      return self.read_attribute(:role) if !organization
+      
+      org = self.organizations.to_a.find { |o| o.id.to_s == organization.id.to_s }
+      org ? org.role : nil
+    end
+
+    def expire_user_cache
+      Rails.cache.delete(['user', self.to_key])
+      true # Don't skip save if above return false (memory_store)
+    end
+
+    def refresh_user_cache
+      self.reload
+      Rails.cache.write(['user', self.to_key], self)
+    end
+  end
+end