mks_rate 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdddd615859351798ad5352bc5b9aece53c2aceaa97c5f4e802764ef5a77fd53
+  data.tar.gz: a756a3efd07103d423b16608242fe36d3ef89e3b5d84d879263b27e9fbc55369
+SHA512:
+  metadata.gz: 8004ef8847a3a38ea3a2d123ae3e738a9732d0211e5173333a42dfc79fbd85468b9a066ed773207d67f8753bd10dd6917a8ce2b64862d97c262dcfb4edc4c2f2
+  data.tar.gz: ec2132c974cc51c0bc7b21e2988cddb7f23c604f7a6a58e227e1082f751d2654d5f596e54650223d2071a777d081edbe88085b2999419bb13adcb329ab3fa6d1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Henock L.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# MksRate
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mks_rate'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install mks_rate
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,38 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MksRate'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec
+

data/app/controllers/mks/rate/application_controller.rb

@@ -0,0 +1,8 @@
+require 'mks/common/methodresponse'
+
+module Mks
+  module Rate
+    class ApplicationController < Mks::Auth::ApplicationController
+    end
+  end
+end

data/app/controllers/mks/rate/chargeable_services_controller.rb

@@ -0,0 +1,52 @@
+module Mks
+  module Rate
+    class ChargeableServicesController < ApplicationController
+      before_action :set_chargeable_service, only: [:update]
+      def index
+        result = ChargeableService.includes(:service_delivery_unit).order(:name)
+        render json: result
+      end
+
+      def create
+        cs = ChargeableService.new(chargeable_service_params)
+        if cs.save
+          render json: Mks::Common::MethodResponse.success_response(cs, 'Chargeable service saved successfully !')
+        else
+          render json: Mks::Common::MethodResponse.failure_response(cs), status: :unprocessable_entity
+        end
+      end
+
+      def update
+        if @cs.update(chargeable_service_params)
+          render json: Mks::Common::MethodResponse.success_response(@cs, 'Chargeable service updated successfully !')
+        else
+          render json: Mks::Common::MethodResponse.failure_response(@cs), status: :unprocessable_entity
+        end
+      end
+
+      def sdu_services
+        result = ChargeableService.where(service_delivery_unit_id: params[:id])
+        render json: result
+      end
+
+      def filter
+        search = "%#{params[:search].downcase}%"
+        services = ChargeableService.joins(:service_delivery_unit)
+                                           .where('lower(mks_rate_chargeable_services.name) LIKE ? OR lower(mks_rate_service_delivery_units.name) LIKE ?',
+                                                  search, search)
+        render json: ApplicationRecord.as_json(services)
+      end
+
+      private
+
+      def chargeable_service_params
+        params.require(:chargeable_service).permit(:id, :code, :name, :service_delivery_unit_id, :base_unit_id,
+                                                   :utilization_unit_id, :service_type_id)
+      end
+
+      def set_chargeable_service
+        @cs = ChargeableService.find(params[:id])
+      end
+    end
+  end
+end

data/app/controllers/mks/rate/rate_change_requests_controller.rb

@@ -0,0 +1,62 @@
+module Mks
+  module Rate
+    class RateChangeRequestsController < ApplicationController
+      before_action :set_rate_change_request, only: %i[show update approve]
+      before_action :set_change_request_service, only: %i[create approve]
+
+      def index
+        @rate_change_requests = RateChangeRequest.all
+        render json: @rate_change_requests
+      end
+
+      def show
+        render json: @rate_change_request
+      end
+
+      def create
+        rate_change_request, success = @service.create(rate_change_request_params, current_user)
+
+        if success
+          render json: Mks::Common::MethodResponse.success_response(rate_change_request), status: :created
+        else
+          render json: Mks::Common::MethodResponse.failure_response(rate_change_request), status: :unprocessable_entity
+        end
+      end
+
+      def update
+        if @rate_change_request.update(rate_change_request_params)
+          render json: Mks::Common::MethodResponse.success_response(@rate_change_request)
+        else
+          render json: Mks::Common::MethodResponse.failure_response(@rate_change_request), status: :unprocessable_entity
+        end
+      end
+
+      def approve
+        if @service.approve(@rate_change_request, current_user)
+          render json: Mks::Common::MethodResponse.success_response(@rate_change_request, 'Rate change request approved!')
+        else
+          render json: Mks::Common::MethodResponse.failure_response(@rate_change_request)
+        end
+      end
+
+
+      private
+
+      def set_change_request_service
+        @service = RateChangeRequestService.new
+      end
+
+      def set_rate_change_request
+        @rate_change_request = RateChangeRequest.find(params[:id])
+      end
+
+      def rate_change_request_params
+        params.require(:rate_change_request).permit(:reference_number, :authorized_by, :effective_on, :authorized_on,
+                                                    :status, :created_by_id, :approved_by_id, :remark,
+                                                    rates: %i[chargeable_service_id chargeable_service_name equipment_item_id
+                                                              equipment_item_name base_rate utilization_rate],
+                                                   )
+      end
+    end
+  end
+end

data/app/controllers/mks/rate/service_bundles_controller.rb

@@ -0,0 +1,72 @@
+module Mks
+  module Rate
+    class ServiceBundlesController < ApplicationController
+      before_action :set_service_bundle, only: %i[show update services add_services]
+      before_action :set_bundle_service, only: %i[add_services]
+      def index
+        @service_bundles = ServiceBundle.all
+        render json: @service_bundles
+      end
+
+      def sdu_bundles
+        result = ServiceBundle.where(service_delivery_unit_id: params[:id])
+        render json: result
+      end
+
+      def show
+        render json: @service_bundle
+      end
+
+      def create
+        @service_bundle = ServiceBundle.new(service_bundle_params)
+        if @service_bundle.save
+          render json: @service_bundle, status: :created, location: @service_bundle
+        else
+          render json: @service_bundle.errors, status: :unprocessable_entity
+        end
+      end
+
+      def update
+        if @service_bundle.update(service_bundle_params)
+          render json: @service_bundle
+        else
+          render json: @service_bundle.errors, status: :unprocessable_entity
+        end
+      end
+
+      def filter
+        search = "%#{params[:search].downcase}%"
+        bundles = ServiceBundle.where('lower(mks_rate_service_bundles.name) LIKE ?', search)
+        render json: bundles
+      end
+
+      def services
+        render json: @service_bundle.chargeable_services
+      end
+
+      def add_services
+        result = @service.add_services(@service_bundle, add_services_params[:ids])
+        render json: { success: result }
+      end
+
+
+      private
+
+      def set_service_bundle
+        @service_bundle = ServiceBundle.find(params[:id])
+      end
+
+      def set_bundle_service
+        @service = ServiceBundleService.new
+      end
+
+      def add_services_params
+        params.permit(ids: [])
+      end
+
+      def service_bundle_params
+        params.require(:service_bundle).permit(:code, :name, :description, :percent_discount, :service_delivery_unit_id)
+      end
+    end
+  end
+end

data/app/controllers/mks/rate/service_delivery_units_controller.rb

@@ -0,0 +1,39 @@
+module Mks
+  module Rate
+    class ServiceDeliveryUnitsController < ApplicationController
+      before_action :set_service_delivery_unit, only: [:update]
+
+      def index
+        result = ServiceDeliveryUnit.all
+        render json: result
+      end
+
+      def create
+        sdu = ServiceDeliveryUnit.new(service_delivery_unit_params)
+        if sdu.save
+          render json: Mks::Common::MethodResponse.success_response(sdu, 'Service delivery unit saved successfully !')
+        else
+          render json: Mks::Common::MethodResponse.failure_response(sdu), status: :unprocessable_entity
+        end
+      end
+
+      def update
+        if @sdu.update(service_delivery_unit_params)
+          render json: Mks::Common::MethodResponse.success_response(@sdu, 'Service delivery unit updated successfully !')
+        else
+          render json: Mks::Common::MethodResponse.failure_response(@sdu), status: :unprocessable_entity
+        end
+      end
+
+      private
+
+      def service_delivery_unit_params
+        params.require(:service_delivery_unit).permit(:id, :code, :name, :address)
+      end
+
+      def set_service_delivery_unit
+        @sdu = ServiceDeliveryUnit.find(params[:id])
+      end
+    end
+  end
+end

data/app/controllers/mks/rate/service_rates_controller.rb

@@ -0,0 +1,14 @@
+module Mks
+  module Rate
+    class ServiceRatesController < ApplicationController
+      def index
+        render json: Mks::Common::MethodResponse.success_response(ServiceRate.all)
+      end
+
+      def working_rates
+        rates = ServiceRate.all
+        render json: rates, each_serializer: WorkingRateSerializer
+      end
+    end
+  end
+end

data/app/controllers/mks/rate/service_types_controller.rb

@@ -0,0 +1,45 @@
+module Mks
+  module Rate
+    class ServiceTypesController < ApplicationController
+      before_action :set_service_type, only: %i[show update]
+
+      def index
+        @service_types = ServiceType.all
+        render json: @service_types
+      end
+
+      def show
+        render json: @service_type
+      end
+
+      def create
+        @service_type = ServiceType.new(service_type_params)
+
+        if @service_type.save
+          render json: @service_type, status: :created, location: @service_type
+        else
+          render json: @service_type.errors, status: :unprocessable_entity
+        end
+      end
+
+      def update
+        if @service_type.update(service_type_params)
+          render json: @service_type
+        else
+          render json: @service_type.errors, status: :unprocessable_entity
+        end
+      end
+
+
+      private
+
+      def set_service_type
+        @service_type = ServiceType.find(params[:id])
+      end
+
+      def service_type_params
+        params.require(:service_type).permit(:code, :name)
+      end
+    end
+  end
+end

data/app/controllers/mks/rate/unit_of_charges_controller.rb

@@ -0,0 +1,11 @@
+module Mks
+  module Rate
+    class UnitOfChargesController < ApplicationController
+      def index
+        uocs = UnitOfCharge.all
+        res = Mks::Common::MethodResponse.success_response(uocs)
+        render json: res
+      end
+    end
+  end
+end

data/app/models/mks/rate/application_record.rb

@@ -0,0 +1,21 @@
+require 'active_model_serializers'
+
+module Mks
+  module Rate
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+
+      def json(data = nil)
+        if data.nil?
+          ActiveModelSerializers::SerializableResource.new(self).as_json
+        else
+          ActiveModelSerializers::SerializableResource.new(data).as_json
+        end
+      end
+
+      def self.as_json(data)
+        ActiveModelSerializers::SerializableResource.new(data).as_json
+      end
+    end
+  end
+end

data/app/models/mks/rate/chargeable_service.rb

@@ -0,0 +1,27 @@
+module Mks
+  module Rate
+    class ChargeableService < ApplicationRecord
+      after_save :generate_bundle
+
+      validates :code, :name, presence: true
+      validates :code, uniqueness: { scope: :service_delivery_unit_id }
+
+      belongs_to :service_type
+      belongs_to :base_unit, class_name: 'UnitOfCharge'
+      belongs_to :utilization_unit, class_name: 'UnitOfCharge', optional: true
+      belongs_to :service_delivery_unit
+
+      delegate(:name, to: :service_delivery_unit, prefix: true)
+      delegate(:name, to: :base_unit, prefix: true)
+      delegate(:name, to: :utilization_unit, prefix: true, allow_nil: true)
+      delegate(:name, to: :service_type, prefix: true)
+
+      def generate_bundle
+        sb = ServiceBundle.create(code: code, name: name, percent_discount: 0,
+                                  description: "Default bundle for service '#{name}'",
+                                  service_delivery_unit_id: service_delivery_unit_id)
+        sb.chargeable_services << self
+      end
+    end
+  end
+end

data/app/models/mks/rate/chargeable_service_discount.rb

@@ -0,0 +1,31 @@
+module Mks
+  module Rate
+    class ChargeableServiceDiscount < ApplicationRecord
+      validates :unit_variable, :from, :to, :value, :chargeable_service_id, presence: true
+      validate :compare_from_and_to
+      validate :check_for_negative_value
+
+      belongs_to :chargeable_service
+
+      private
+
+      def compare_from_and_to
+        if !from.nil? && !to.nil?
+          if from > to
+            errors.add(:from, 'The value of from can not exced the value of to')
+          end
+        end
+      end
+
+      def check_for_negative_value
+        if !from.nil? && !to.nil?
+          if from.negative?
+            errors.add(:from, 'The value of from can not be less than zero')
+          elsif to.negative?
+            errors.add(:to, 'The value of to can not be less than zero')
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/mks/rate/rate_change_request.rb

@@ -0,0 +1,16 @@
+module Mks
+  module Rate
+    class RateChangeRequest < ApplicationRecord
+      SUBMITTED = 'SUBMITTED'
+      APPROVED = 'APPROVED'
+      DECLINED = 'DECLINED'
+
+      validates :reference_number, :authorized_by, :effective_on, :authorized_on, :rates, :status, presence: true
+      validates :reference_number, uniqueness: true
+      validates_inclusion_of :status, in: %w[SUBMITTED APPROVED DECLINED]
+
+      belongs_to :created_by, class_name: 'Mks::Auth::User'
+      belongs_to :approved_by, class_name: 'Mks::Auth::User', optional: true
+    end
+  end
+end

data/app/models/mks/rate/service_bundle.rb

@@ -0,0 +1,14 @@
+module Mks
+  module Rate
+    class ServiceBundle < ApplicationRecord
+      belongs_to :service_delivery_unit
+      has_and_belongs_to_many :chargeable_services, join_table: 'mks_rate_service_bundles_chargeable_services'
+
+      validates :code, :name, :percent_discount, presence: true
+      validates :code, uniqueness: true
+      validates_numericality_of :percent_discount, greater_than_or_equal_to: 0, less_than_or_equal_to: 100
+
+      delegate(:name, to: :service_delivery_unit, prefix: true)
+    end
+  end
+end

data/app/models/mks/rate/service_delivery_unit.rb

@@ -0,0 +1,8 @@
+module Mks
+  module Rate
+    class ServiceDeliveryUnit < ApplicationRecord
+      validates :code, :name, presence: true
+      validates :code, uniqueness: true
+    end
+  end
+end

data/app/models/mks/rate/service_rate.rb

@@ -0,0 +1,17 @@
+module Mks
+  module Rate
+    class ServiceRate < ApplicationRecord
+      validates :base_rate, :utilization_rate, :chargeable_service_id, presence: true
+      belongs_to :chargeable_service
+      belongs_to :equipment_item, class_name: 'Mks::Edm::EquipmentItem', optional: true
+
+      delegate(:name, to: :chargeable_service, prefix: true)
+      delegate(:name, to: :equipment_item, prefix: true, allow_nil: true)
+      delegate(:service_delivery_unit_id, to: :chargeable_service, prefix: false)
+      delegate(:service_delivery_unit_name, to: :chargeable_service, prefix: false)
+
+      alias_method :sdu_id, :service_delivery_unit_id
+      alias_method :sdu_name, :service_delivery_unit_name
+    end
+  end
+end

data/app/models/mks/rate/service_type.rb

@@ -0,0 +1,7 @@
+module Mks
+  module Rate
+    class ServiceType < ApplicationRecord
+      validates :code, :name, presence: true, uniqueness: true
+    end
+  end
+end

data/app/models/mks/rate/unit_of_charge.rb

@@ -0,0 +1,8 @@
+module Mks
+  module Rate
+    class UnitOfCharge < ApplicationRecord
+      validates :name, :unit_variables, presence: true
+      validates :name, uniqueness: true
+    end
+  end
+end

data/app/serializers/mks/rate/bundle_discount_serializer.rb

@@ -0,0 +1,8 @@
+module Mks
+  module Rate
+    class BundleDiscountSerializer < ActiveModel::Serializer
+      attributes :id, :service_bundle_id, :service_bundle_name, :chargeable_service_id, :chargeable_service_name,
+                 :percent_discount
+    end
+  end
+end

data/app/serializers/mks/rate/chargeable_service_serializer.rb

@@ -0,0 +1,8 @@
+module Mks
+  module Rate
+    class ChargeableServiceSerializer < ActiveModel::Serializer
+      attributes :id, :code, :name, :service_delivery_unit_id, :service_delivery_unit_name, :base_unit_id,
+                 :base_unit_name, :utilization_unit_id, :utilization_unit_name, :service_type_id, :service_type_name
+    end
+  end
+end

data/app/serializers/mks/rate/service_bundle_serializer.rb

@@ -0,0 +1,7 @@
+module Mks
+  module Rate
+    class ServiceBundleSerializer < ActiveModel::Serializer
+      attributes :id, :code, :name, :description, :percent_discount, :service_delivery_unit_id, :service_delivery_unit_name
+    end
+  end
+end

data/app/serializers/mks/rate/service_rate_serializer.rb

@@ -0,0 +1,8 @@
+module Mks
+  module Rate
+    class ServiceRateSerializer < ActiveModel::Serializer
+      attributes :id, :base_rate, :utilization_rate, :chargeable_service_id, :chargeable_service_name,
+                 :equipment_item_id, :equipment_item_name
+    end
+  end
+end

data/app/serializers/mks/rate/working_rate_serializer.rb

@@ -0,0 +1,8 @@
+module Mks
+  module Rate
+    class WorkingRateSerializer < ActiveModel::Serializer
+      attributes :id, :base_rate, :utilization_rate, :chargeable_service_id, :chargeable_service_name,
+                 :equipment_item_id, :equipment_item_name, :sdu_id, :sdu_name
+    end
+  end
+end