mno-enterprise-core 3.0.7 → 3.1.0

data/lib/mno_enterprise/core.rb

@@ -17,9 +17,7 @@ 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/model/associations/belongs_to_association"
 require "her_extension/middleware/mnoe_api_v1_parse_json"
-require "her_extension/middleware/mnoe_raise_error"
 require "faraday_middleware"
 require "mno_enterprise/engine"
 
@@ -29,7 +27,6 @@ require 'mno_enterprise/database_extendable'
 require 'config'
 require 'figaro'
 
-require 'mandrill'
 require "mandrill_client"
 
 require 'accountingjs_serializer'
@@ -161,11 +158,26 @@ module MnoEnterprise
   #====================================
   # Emailing
   #====================================
+  # @deprecated: Use ENV['MANDRILL_API_KEY']
   # Mandrill Key for sending emails
-  # Points to the default maestrano enterprise account
-  mattr_accessor :mandrill_key
+  def self.mandrill_key
+    warn "[DEPRECATION] `mandrill_key` is deprecated. Use `ENV['MANDRILL_API_KEY']`."
+    @@mandrill_key
+  end
+  def self.mandrill_key=(mandrill_key)
+    warn "[DEPRECATION] `mandrill_key` is deprecated. Use `ENV['MANDRILL_API_KEY']`."
+    @@mandrill_key = mandrill_key
+  end
   @@mandrill_key = nil
 
+  # Adapter used to send emails
+  # Default to :mandrill
+  mattr_reader(:mail_adapter) { Rails.env.test? ? :test : :mandrill }
+  def self.mail_adapter=(adapter)
+    @@mail_adapter = adapter
+    MnoEnterprise::MailClient.adapter = self.mail_adapter
+  end
+
   # The support email address
   mattr_accessor :support_email
   @@support_email = "support@example.com"
@@ -236,6 +248,10 @@ module MnoEnterprise
     yield self
     self.configure_styleguide
     self.configure_api
+
+    # Mail config
+    # We can't use the setter before MailClient is loaded
+    self.mail_adapter = self.mail_adapter
   end
 
   # Create a JSON web token with the provided payload
@@ -294,9 +310,6 @@ module MnoEnterprise
 
         # Adapter
         c.use Faraday::Adapter::NetHttpNoProxy
-
-        # Error Handling
-        c.use Her::Middleware::MnoeRaiseError
       end
     end
 end

data/lib/mno_enterprise/mail_adapters/adapter.rb

@@ -0,0 +1,51 @@
+module MnoEnterprise
+  module MailAdapters
+    # @abstract Subclass and override {#client} and {#deliver} to implement
+    #   a custom Mailer Adapter.
+    class Adapter
+      class << self
+        # Store the list of emails that are pending to be sent.
+        # @note Only used for testing
+        #
+        # @example
+        #   expect { some_action }.to change(Adapter.base_deliveries,:count).by(1)
+        #
+        # @return [Array]
+        def base_deliveries
+          @base_deliveries ||= []
+        end
+
+        # Check whether mailers are in test mode or not.
+        # Emails should not be sent in test mode.
+        #
+        # @return [Boolean]
+        def test?
+          (Rails.configuration.action_mailer.delivery_method || '').to_sym == :test
+        end
+
+        def client
+          raise NotImplementedError
+        end
+
+        # Send a template
+        #
+        # @param [String] template the immutable name of the template to send
+        #
+        # @param [Hash] from a hash describing the sender
+        # @option from [String] :name optional from name to be used
+        # @option from [String] :email the sender email address
+        #
+        # @param [Array, Hash] to an array or hash describing the recipient
+        # @option to [String] :name optional recipient name
+        # @option to [String] :email the recipient email address
+        #
+        # @param [Hash] vars substitution variables
+        # @param [Hash] opts additional parameters to pass to the client
+        #
+        def deliver(template,from,to,vars = {},opts = {})
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/mno_enterprise/mail_adapters/mandrill_adapter.rb

@@ -0,0 +1,39 @@
+gem 'mandrill-api', '~> 1.0.53'
+require 'mandrill'
+
+module MnoEnterprise
+  module MailAdapters
+    class MandrillAdapter < Adapter
+      class << self
+        # Return a mandrill client configured with the right API key
+        def client
+          @client ||= Mandrill::API.new(ENV['MANDRILL_API_KEY'] || MnoEnterprise.mandrill_key)
+        end
+
+        # Send a template
+        # @see Adapter#deliver
+        def deliver(template, from, to, vars={}, opts={})
+          # Prepare message from args
+          message = { from_name: from[:name], from_email: from[:email]}
+          message[:to] = [to].flatten.map { |t| {name: t[:name], email: t[:email], type: (t[:type] || :to) } }
+          message[:global_merge_vars] = vars.map { |k,v| {name: k.to_s, content: v} }
+
+          # Merge additional mandrill options
+          message.merge!(opts)
+
+          self.send_template(template,[],message)
+        end
+
+        # Send the provided template with options
+        # MandrillClient.send_template(template_name(string), template_content(array), message(hash))
+        def send_template(*args)
+          if self.test?
+            self.base_deliveries.push(args)
+          else
+            self.client.messages.send_template(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mno_enterprise/mail_adapters/smtp_adapter.rb

@@ -0,0 +1,21 @@
+module MnoEnterprise
+  module MailAdapters
+    # SMTP Adapter for MnoEnterprise::MailClient
+    class SmtpAdapter < Adapter
+      class << self
+        # Return a smtp client configured with the SMTP settings
+        # @return [SmtpClient]
+        def client
+          @client = MnoEnterprise::SmtpClient.send :new
+        end
+
+        # Send a template
+        # @See Adapter#deliver
+        def deliver(template, from, to, vars={}, opts={})
+          client.deliver(template, from, to, vars, opts).deliver
+        end
+
+      end
+    end
+  end
+end

data/lib/mno_enterprise/mail_adapters/sparkpost_adapter.rb

@@ -0,0 +1,56 @@
+gem 'sparkpost'
+require 'sparkpost'
+
+module MnoEnterprise
+  module MailAdapters
+    # SparkPost Adapter for MnoEnterprise::MailClient
+    class SparkpostAdapter < Adapter
+      class << self
+        # Return a sparkpost client configured with the right API key
+        # api key is set in ENV through ENV['SPARKPOST_API_KEY']
+        # @return [SparkPost::Client]
+        def client
+          @client ||= SparkPost::Client.new
+        end
+
+        # Send a template
+        # @see Adapter#deliver
+        def deliver(template, from, to, vars={}, opts={})
+          # Prepare message from args
+          message = {
+            recipients: prepare_recipients(to),
+            content: {
+              from: from,
+              template_id: template
+            },
+            substitution_data: vars
+          }
+
+          # Merge additional options
+          message.merge!(opts)
+
+          # Send
+          send_template(template,[],message)
+        end
+
+        # Send the provided template with options
+        # SparkpostClient.send_template(template_name(string), template_content(array), message(hash))
+        def send_template(template_name, _, message)
+          if test?
+            base_deliveries.push([template_name, message])
+          else
+            message[:content][:template_id] = template_name
+            client.transmission.send_payload(message)
+          end
+        end
+
+        private
+
+        # TODO: Use delegate?
+        def prepare_recipients(recipients)
+          client.transmission.prepare_recipients(recipients)
+        end
+      end
+    end
+  end
+end

data/lib/mno_enterprise/mail_adapters/test_adapter.rb

@@ -0,0 +1,21 @@
+module MnoEnterprise
+  module MailAdapters
+    # Test Adapter for MnoEnterprise::MailClient
+    # Add messages to an internal array instead of sending them
+    class TestAdapter < Adapter
+      class << self
+        # Send a template
+        # @see Adapter#deliver
+        def deliver(*args)
+          send_template(*args)
+        end
+
+        # Send the provided template with options
+        # SparkpostClient.send_template(template_name(string), template_content(array), message(hash))
+        def send_template(*args)
+          base_deliveries.push(*args)
+        end
+      end
+    end
+  end
+end

data/lib/mno_enterprise/mail_client.rb

@@ -0,0 +1,28 @@
+module MnoEnterprise
+  # Abstract the email sending logic
+  #
+  class MailClient
+    cattr_reader(:adapter)
+
+    # Specify the mail adapter. The default email adapter is the :mandrill adapter.
+    def self.adapter=(name_or_adapter)
+      @@adapter = \
+        case name_or_adapter
+        when Symbol, String
+          load_adapter(name_or_adapter)
+        else
+          name_or_adapter if name_or_adapter.respond_to?(:deliver)
+        end
+    end
+
+    # @see Adapter#deliver
+    def self.deliver(*args)
+      adapter.deliver(*args)
+    end
+
+    private
+    def self.load_adapter(name)
+      "MnoEnterprise::MailAdapters::#{name.to_s.camelize}Adapter".constantize
+    end
+  end
+end

data/lib/mno_enterprise/smtp_client.rb

@@ -0,0 +1,32 @@
+require 'action_mailer/railtie'
+
+module MnoEnterprise
+  # Base class (instantiable) for SMTP adapter
+  class SmtpClient < ActionMailer::Base
+    # Send SMTP template - terminal mailing part
+    def deliver(template, from, to, vars={}, opts={})
+      @info = vars
+      @info[:company] = from[:name]
+
+      mail(
+        from: format_sender(from),
+        to: to[:email],
+        subject: humanize(template),
+        template_path: 'system_notifications',
+        template_name: template
+      )
+    end 
+
+    # Returns Actionmailer-compliant :from string
+    # @Format : "Sender name <sender@email.com>"
+    def format_sender(from)
+      "#{from[:name]} <#{from[:email]}>"
+    end
+    
+    # Returns humanized template subject
+    # @i.e. "reset-password-instructions" to "Reset password instructions"
+    def humanize(template_slug)
+      template_slug.tr("-", "_").humanize
+    end
+  end
+end

data/lib/mno_enterprise/testing_support/factories/apps.rb

@@ -22,7 +22,7 @@ FactoryGirl.define do
     stack 'cube'
     terms_url "http://opensource.org/licenses/MIT"
     appinfo { {} }
-
+    sequence(:rank) { |n| n }
     pricing_plans {{
       'default' =>[{name: 'Monthly Plan', price: '20.0', currency: 'AUD', factor: '/month'}]
     }}
@@ -41,5 +41,4 @@ FactoryGirl.define do
     # Properly build the resource with Her
     initialize_with { new(attributes).tap { |e| e.clear_attribute_changes! } }
   end
-  
 end

data/lib/mno_enterprise/testing_support/factories/impac/kpis.rb

@@ -4,6 +4,7 @@ FactoryGirl.define do
     factory :impac_kpi, class: MnoEnterprise::Impac::Kpi do
       
       sequence(:id) { |n| n }
+      sequence(:name) { |n| "Random Kpi #{n}" }
       dashboard { build(:impac_dashboard).attributes }
       endpoint "an/endpoint"
       element_watched "a_watchable"

data/lib/mno_enterprise/testing_support/factories/tenant.rb

@@ -1,8 +1,6 @@
 FactoryGirl.define do
 
-  # Tenant from an old MnoHub (<= v1.0.2)
-  # TODO: Remove once all mnohub are migrated to newer versions
-  factory :old_tenant, class: MnoEnterprise::Tenant do
+  factory :tenant, class: MnoEnterprise::Tenant do
     last_portfolio_amount Money.new(65644,'AUD')
     last_customers_invoicing_amount Money.new(687994,'AUD')
     last_customers_outstanding_amount Money.new(178986,'AUD')
@@ -11,8 +9,4 @@ FactoryGirl.define do
     # Properly build the resource with Her
     initialize_with { new(attributes).tap { |e| e.clear_attribute_changes! } }
   end
-
-  factory :tenant, parent: :old_tenant do
-    current_billing_amount Money.new(123456, 'AUD')
-  end
 end

data/lib/mno_enterprise/testing_support/mno_enterprise_api_test_helper.rb

@@ -124,8 +124,7 @@ module MnoEnterpriseApiTestHelper
 
         # Response
         c.use Her::Middleware::MnoeApiV1ParseJson
-        c.use Her::Middleware::MnoeRaiseError
-
+      
         # Add stubs on the test adapter
         c.use MnoeFaradayTestAdapter do |receiver|
           @_stub_list.each do |key,stub|

data/lib/mno_enterprise/version.rb

@@ -1,3 +1,3 @@
 module MnoEnterprise
-  VERSION = '3.0.7'
+  VERSION = '3.1.0'
 end

data/spec/lib/her_extension/model/relation_spec.rb

@@ -3,76 +3,5 @@ require 'rails_helper'
 module MnoEnterprise
   RSpec.describe Her::Model::Relation do
     pending "add specs for Her::Model::Relation monkey patch: #{__FILE__}"
-
-    before(:all) { Object.const_set('DummyClass', Class.new).send(:include, Her::Model) }
-    let(:dummy_class) { DummyClass }
-
-    describe '.where' do
-      it 'adds the filter to params[:filter]' do
-        rel = Her::Model::Relation.new(dummy_class).where('uid.in' => [1, 2], 'foo' => 'bar')
-        expect(rel.params[:filter]).to eq('uid.in' => [1, 2], 'foo' => 'bar')
-      end
-
-      it 'replaces empty array values with nil' do
-        rel = Her::Model::Relation.new(dummy_class).where('id.in' => [])
-        expect(rel.params[:filter]).to eq('id.in' => nil)
-      end
-    end
-
-    # We mostly test our request expectations
-    describe '.first_or_create' do
-      let(:relation) { Her::Model::Relation.new(dummy_class) }
-      subject { relation.where(foo: 'bar').first_or_create(baz: 'bar') }
-
-      context 'when matching record' do
-        let(:record) { dummy_class.new(foo: 'bar') }
-        before do
-          expect(dummy_class).to receive(:request).with(hash_including(filter: {foo: 'bar'}, _method: :get)).and_return([record])
-        end
-
-        it 'returns the record' do
-          expect(subject).to eq(record)
-        end
-      end
-
-      context 'when no matching record' do
-        before do
-          expect(dummy_class).to receive(:request).with(hash_including(filter: {foo: 'bar'}, _method: :get)).and_return([])
-          expect(dummy_class).to receive(:request).with(hash_including(foo: 'bar', baz: 'bar', _method: :post)).and_return(dummy_class.new)
-        end
-
-        it 'creates a new record' do
-          expect(subject).to eq(dummy_class.new(foo: 'bar', baz: 'bar'))
-        end
-      end
-    end
-
-    # We mostly test our request expectations
-    describe '.first_or_initialize' do
-      let(:relation) { Her::Model::Relation.new(dummy_class) }
-      subject { relation.where(foo: 'bar').first_or_initialize(baz: 'bar') }
-
-      context 'when matching record' do
-        let(:record) { dummy_class.new(foo: 'bar') }
-        before do
-          expect(dummy_class).to receive(:request).with(hash_including(filter: {foo: 'bar'}, _method: :get)).and_return([record])
-        end
-
-        it 'returns the record' do
-          expect(subject).to eq(record)
-        end
-      end
-
-      context 'when no matching record' do
-        before do
-          expect(dummy_class).to receive(:request).with(hash_including(filter: {foo: 'bar'}, _method: :get)).and_return([])
-          # No POST stub
-        end
-
-        it 'build a new record' do
-          expect(subject).to eq(dummy_class.new(foo: 'bar', baz: 'bar'))
-        end
-      end
-    end
   end
 end