sp-duh 2.0.6

data/lib/sp-duh.rb

@@ -0,0 +1,32 @@
+#
+# Copyright (c) 2011-2017 Cloudware S.A. All rights reserved.
+#
+# This file is part of sp-duh.
+#
+# sp-duh is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# sp-duh is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with sp-duh.  If not, see <http://www.gnu.org/licenses/>.
+#
+# encoding: utf-8
+#
+def require_silently(require_name)
+  begin
+    require require_name
+  rescue LoadError
+  end
+end
+
+require 'highline/import'
+require_silently 'byebug'
+require_silently 'awesome_print'
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'sp', 'duh'))

data/lib/sp/duh.rb

@@ -0,0 +1,180 @@
+#
+# Copyright (c) 2011-2017 Cloudware S.A. All rights reserved.
+#
+# This file is part of sp-duh.
+#
+# sp-duh is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# sp-duh is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with sp-duh.  If not, see <http://www.gnu.org/licenses/>.
+#
+# encoding: utf-8
+#
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'version'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'engine'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'exceptions'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'repl'))
+
+# JSONAPI library classes
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'exceptions'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'resource_publisher'))
+# Parameters class
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'parameters'))
+# Service classes
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'service'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'configuration'))
+# Adpater classes
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'adapters', 'base'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'adapters', 'raw_db'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'adapters', 'db'))
+# PG Adapters
+require 'pg'
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'adapters', 'pg', 'text_decoder', 'json'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'adapters', 'pg', 'text_encoder', 'json'))
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'model', 'base'))
+
+# Migrations library classes
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'migrations'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'migrations', 'migrator'))
+
+# Backup and restore (transfer) library classes
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'db', 'transfer', 'backup'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'db', 'transfer', 'restore'))
+
+# API documentationlibrary classes
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'jsonapi', 'doc', 'generator'))
+
+# i18n classes
+require File.expand_path(File.join(File.dirname(__FILE__), 'duh', 'i18n', 'excel_loader'))
+
+# SP helper lib
+require 'sp-excel-loader'
+
+module SP
+  module Duh
+    def self.root
+      File.expand_path '../../..', __FILE__
+    end
+
+    def self.initsee (a_pg_conn, a_recreate = false)
+      if a_recreate
+        a_pg_conn.exec(%Q[
+
+          DROP FUNCTION IF EXISTS see (
+            a_module          text,
+            a_version         text,
+            a_query_map       text,
+            a_calc_parameters text
+          );
+
+          DROP FUNCTION IF EXISTS see (
+            a_module          text,
+            a_version         text,
+            a_query_map       text,
+            a_calc_parameters text,
+            a_log             text,
+            a_debug           boolean
+          );
+
+          DROP FUNCTION IF EXISTS see_payroll (
+            a_module          text,
+            a_version         text,
+            a_query_map       text,
+            a_calc_parameters text,
+            a_clones          text,
+            a_log             text,
+            a_debug           boolean
+          );
+
+          DROP FUNCTION IF EXISTS see_evaluate_expression (
+            a_expression text
+          );
+          DROP TYPE IF EXISTS see_record;
+          DROP TABLE IF EXISTS pg_see_json_table;
+        ]);
+      end
+      begin
+        a_pg_conn.exec(%Q[
+          CREATE TYPE see_record AS (json text, status text);
+        ])
+      rescue Exception => e
+        if a_recreate
+          raise e
+        end
+      end
+      begin
+        a_pg_conn.exec(%Q[
+          CREATE OR REPLACE FUNCTION see (
+            a_module          text,
+            a_version         text,
+            a_query_map       text,
+            a_calc_parameters text,
+            a_log             text default null,
+            a_debug           boolean default false
+          ) RETURNS see_record AS '$libdir/pg-see.so', 'see' LANGUAGE C STRICT;
+
+          CREATE OR REPLACE FUNCTION see_payroll (
+            a_module          text,
+            a_version         text,
+            a_query_map       text,
+            a_calc_parameters text,
+            a_clones          text,
+            a_log             text default null,
+            a_debug           boolean default false
+          ) RETURNS see_record AS '$libdir/pg-see.so', 'see_payroll' LANGUAGE C STRICT;
+
+          CREATE OR REPLACE FUNCTION see_evaluate_expression (
+            a_expression text
+          ) RETURNS see_record AS '$libdir/pg-see.so', 'see_evaluate_expression' LANGUAGE C STRICT;
+
+          ])
+      rescue Exception => e
+        if a_recreate
+          raise e
+        end
+      end
+      begin
+        a_pg_conn.exec(%Q[
+           CREATE TABLE pg_see_json_table (
+             namespace   character varying(255),
+             table_name  character varying(255),
+             version     character varying(20),
+             is_model    boolean NOT NULL DEFAULT FALSE,
+             json        text,
+             commit_hash character varying(255),
+             CONSTRAINT pg_see_json_table_pkey PRIMARY KEY(namespace, table_name, version)
+           );
+        ])
+      rescue => e
+        if a_recreate
+          raise e
+        end
+      end
+
+    end
+  end
+end
+
+def _log(message, prefix = nil)
+  message = message.is_a?(String) ? message : message.inspect
+  prefix = "SP::Duh#{prefix.blank? ? '' : ' [' + prefix + ']'}: "
+  if Rails.logger && !defined?(Rails::Console)
+    Rails.logger.debug "#{prefix}#{message}"
+  else
+    puts "#{prefix}#{message}"
+  end
+end
+
+# Configure the I18n module for correct usage when outside a Rails app (tests)
+I18n.load_path += Dir[File.join(SP::Duh.root, 'config', 'locales', '*.{rb,yml}')]
+I18n.default_locale = :pt

data/lib/sp/duh/adapters/pg/text_decoder/json.rb

@@ -0,0 +1,15 @@
+module SP
+  module Duh
+    module Adapters
+      module PG
+        module TextDecoder
+          class Json < ::PG::SimpleDecoder
+            def decode(string, tuple=nil, field=nil)
+              JSON.parse string
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sp/duh/adapters/pg/text_encoder/json.rb

@@ -0,0 +1,15 @@
+module SP
+  module Duh
+    module Adapters
+      module PG
+        module TextEncoder
+          class Json < ::PG::SimpleEncoder
+            def decode(string, tuple=nil, field=nil)
+              JSON.parse string
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sp/duh/db/transfer/backup.rb

@@ -0,0 +1,71 @@
+module SP
+  module Duh
+    module Db
+      module Transfer
+
+        def self.log_with_time(message)
+          puts "[#{Time.now.strftime('%d-%m-%Y %H:%M')}] #{message}"
+        end
+
+        class Backup
+
+          attr_reader :status
+
+          def initialize(source_pg_connection)
+            @connection = source_pg_connection
+          end
+
+          def execute(company_id, dump_file = nil)
+            self.status = :ok
+            @company_id = company_id
+            yield(:before_execute) if block_given?
+            before_execute
+            yield(:do_execute) if block_given?
+            do_execute(dump_file) if self.status == :ok
+            yield(:after_execute) if block_given?
+            after_execute if self.status == :ok
+          end
+
+          protected
+
+            def before_execute
+              SP::Duh::Db::Transfer.log_with_time "STARTED backing up company #{@company_id}"
+              SP::Duh::Db::Transfer.log_with_time "Preparing backup..."
+              @started_at = Time.now
+              @schemas = @connection.exec %Q[
+                SELECT * FROM transfer.backup_before_execute(#{@company_id});
+              ]
+              @schemas = @schemas.map { |result| result['schema_name'] }
+            end
+
+            def do_execute(dump_file = nil)
+              SP::Duh::Db::Transfer.log_with_time "Executing backup..."
+              dump_file = "#{Time.now.strftime('%Y%m%d%H%M')}_c#{@company_id}.dump"  if dump_file.nil?
+              command = "pg_dump -Fc -O --quote-all-identifiers --data-only -n #{@schemas.join(' -n ')} -h #{@connection.host} -p #{@connection.port} -U #{@connection.user} #{@connection.db} > #{dump_file}"
+              SP::Duh::Db::Transfer.log_with_time command
+              %x[ #{command} ]
+              if $?.exitstatus != 0
+                File.delete dump_file
+                self.status = :error_dumping_company
+              end
+            end
+
+            def after_execute
+              @ended_at = Time.now
+              SP::Duh::Db::Transfer.log_with_time "FINISHED backing up company #{@company_id} in #{(@ended_at - @started_at).round(2)}s"
+            end
+
+            def status=(value)
+              @status = value
+              if value != :ok
+                @ended_at = Time.now
+                SP::Duh::Db::Transfer.log_with_time "CANCELED backing up company #{@company_id} in #{(@ended_at - @started_at).round(2)}s"
+              end
+            end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/sp/duh/db/transfer/restore.rb

@@ -0,0 +1,89 @@
+module SP
+  module Duh
+    module Db
+      module Transfer
+
+        class Restore
+
+          def initialize(destination_pg_connection)
+            @connection = destination_pg_connection
+          end
+
+          def execute(company_id, dump_file, skip = false)
+
+            @company_id = company_id
+            @dump_file = dump_file
+
+            yield(:before, :before_execute) if block_given?
+            results = before_execute(skip)
+            yield(:after, :before_execute, results) if block_given?
+
+            return results if skip
+
+            yield(:before, :do_execute) if block_given?
+            results = do_execute
+            yield(:after, :do_execute, results) if block_given?
+
+            yield(:before, :after_execute) if block_given?
+            results = after_execute
+            yield(:after, :after_execute, results) if block_given?
+
+            return results
+
+          end
+
+          protected
+
+            def before_execute(skip = false)
+              services_configuration_file = File.join(Dir.pwd, "config", "cloudware_services.yml")
+              raise "Configuration file #{services_configuration_file} not found." if !File.exist?(services_configuration_file)
+              services_configuration = YAML.load_file(services_configuration_file)
+              raise "Invalid configuration in file #{services_configuration_file}." if services_configuration.nil?
+              @template_company_id = services_configuration[:company_id] || services_configuration['company_id']
+              raise "No template company id found in file #{services_configuration_file}." if @template_company_id.nil?
+              @template_company_id = @template_company_id.to_i
+              SP::Duh::Db::Transfer.log_with_time "STARTED restoring company #{@company_id} from dump #{@dump_file}"
+              SP::Duh::Db::Transfer.log_with_time "Preparing restore..."
+              @started_at = Time.now
+              meta_schema = @connection.exec %Q[
+                SELECT * FROM transfer.restore_before_before_execute(#{@company_id});
+              ]
+              meta_schema = meta_schema.first.values.first
+              raise "Backup file #{@dump_file} not found." if !File.exist?(@dump_file)
+              command = "pg_restore -Fc -n #{meta_schema} --data-only -h #{@connection.host} -p #{@connection.port} -U #{@connection.user} -d #{@connection.db} < #{@dump_file}"
+              SP::Duh::Db::Transfer.log_with_time "Restoring the backup metadata..."
+              SP::Duh::Db::Transfer.log_with_time command
+              result = %x[ #{command} ]
+              if skip
+                SP::Duh::Db::Transfer.log_with_time "Processing metadata..."
+              else
+                SP::Duh::Db::Transfer.log_with_time "Processing metadata and foreign records..."
+              end
+              @schemas = @connection.exec %Q[
+                SELECT * FROM transfer.restore_after_before_execute(#{@company_id}, #{@template_company_id}, #{skip});
+              ]
+              @schemas = @schemas.map { |result| result['schema_name'] }
+            end
+
+            def do_execute
+              SP::Duh::Db::Transfer.log_with_time "Executing restore..."
+              command = "pg_restore -Fc -n #{@schemas.join(' -n ')} -h #{@connection.host} -p #{@connection.port} -U #{@connection.user} -d #{@connection.db} < #{@dump_file}"
+              SP::Duh::Db::Transfer.log_with_time command
+              result = %x[ #{command} ]
+            end
+
+            def after_execute
+              SP::Duh::Db::Transfer.log_with_time "Finishing restore..."
+              @connection.exec %Q[
+                SELECT * FROM transfer.restore_after_execute(#{@company_id}, #{@template_company_id});
+              ]
+              @ended_at = Time.now
+              SP::Duh::Db::Transfer.log_with_time "FINISHED restoring company #{@company_id} in #{(@ended_at - @started_at).round(2)}s"
+            end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/sp/duh/engine.rb

@@ -0,0 +1,35 @@
+#
+# Copyright (c) 2011-2017 Cloudware S.A. All rights reserved.
+#
+# This file is part of sp-duh.
+#
+# sp-duh is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# sp-duh is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with sp-duh.  If not, see <http://www.gnu.org/licenses/>.
+#
+# encoding: utf-8
+#
+require 'rails'
+
+module SP
+  module Duh
+    class Engine < ::Rails::Engine
+      isolate_namespace SP::Duh
+
+      initializer :append_migrations do |app|
+        unless app.root.to_s.match root.to_s
+          app.config.paths["db/migrate"] += config.paths["db/migrate"].expanded
+        end
+      end
+    end
+  end
+end

data/lib/sp/duh/exceptions.rb

@@ -0,0 +1,70 @@
+#
+# Copyright (c) 2011-2017 Cloudware S.A. All rights reserved.
+#
+# This file is part of sp-duh.
+#
+# sp-duh is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# sp-duh is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with sp-duh.  If not, see <http://www.gnu.org/licenses/>.
+#
+# encoding: utf-8
+#
+module SP
+  module Duh
+    module Exceptions
+
+      # Generic errors
+
+      class GenericError < StandardError
+
+        attr_reader :nested
+        attr_reader :raw_backtrace
+
+        def initialize(message = nil, nested = $!)
+          if message.nil?
+            message = I18n.t("sp-duh.exceptions.#{type.underscore.gsub('/','.')}") if I18n.exists?("sp-duh.exceptions.#{type.underscore.gsub('/','.')}")
+          end
+          super(message)
+          @nested = nested
+        end
+
+        def set_backtrace(backtrace)
+          @raw_backtrace = backtrace
+          if nested
+            backtrace = backtrace - nested_raw_backtrace
+            backtrace += ["#{nested.backtrace.first}: #{nested.message} (#{nested.class.name})"]
+            backtrace += nested.backtrace[1..-1] || []
+          end
+          super(backtrace)
+        end
+
+        protected
+
+          def type ; self.class.name.sub("SP::Duh::", "").sub("Exceptions::", "") ; end
+
+        private
+
+          def nested_raw_backtrace
+            nested.respond_to?(:raw_backtrace) ? nested.raw_backtrace : nested.backtrace
+          end
+      end
+
+      class GenericDetailedError < GenericError
+        def initialize(details = {})
+          message = I18n.t("sp-duh.exceptions.#{type.underscore.gsub('/','.')}", details)
+          super(message)
+        end
+      end
+
+    end
+  end
+end