sp-duh 2.0.6

data/lib/sp/duh/version.rb

@@ -0,0 +1,25 @@
+#
+# 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
+    VERSION = File.read(File.expand_path('../../../../VERSION', __FILE__))
+  end
+end

data/lib/tasks/db_utils.rake

@@ -0,0 +1,98 @@
+require 'yaml'
+require 'pg'
+
+def load_db_from_yml_spec (a_spec)
+  a_spec["folders"].each do |elem|
+    Pathname.glob("#{MOD_PATH}/db/#{elem}/**/").sort.each do |folder|
+      Dir["#{folder}/*.sql"].sort.each do |file|
+        puts "file #{file}"
+        $db.exec( File.read(file) )
+      end
+    end
+  end
+
+  return if a_spec["execute"].nil?
+
+  a_spec["folders"].each do |folder|
+    next unless a_spec["execute"].has_key?(folder)
+    next unless a_spec["execute"][folder].is_a?(Array)
+    a_spec["execute"][folder].each do |to_execute|
+      puts to_execute
+      $db.exec( "SELECT #{ to_execute};" )
+    end
+  end
+end
+
+def load_db_config
+  ENV['RAILS_ENV'] ||= 'development'
+  $db_config = YAML.load_file(File.join('config', 'database.yml'))[ENV['RAILS_ENV']]
+end
+
+def connect_to_pg
+  load_db_config()
+  $db = PG.connect(host: $db_config['host'], port: $db_config['port'], dbname: $db_config['database'], user: $db_config['username'], password: $db_config['password'])
+end
+
+def config_json_api
+  jsonapi_service = SP::Duh::JSONAPI::Service.new($db, JSONAPI_PREFIX)
+  jsonapi_service.setup()
+  jsonapi_service.configuration.reload!
+end
+
+task :pg_connect do
+  $db.close unless $db.nil?
+  connect_to_pg()
+  $db
+end
+
+desc 'Reload jsonapi'
+task :config_jsonapi => :pg_connect do
+  config_json_api()
+end
+
+task :production_safety do
+  load_db_config()
+  unless Object.const_defined?('FORBIDDEN_HOSTS')
+    raise "To run this task you must define 'FORBIDDEN_HOSTS' No, you don't know what you are doing!!!!"
+  end
+  if FORBIDDEN_HOSTS.include? %x[hostname -s].strip
+    raise "For safety reasons this task can't be run on this machine, no you don't know what you are doing"
+  end
+  unless %w(localhost tocstaging cloudex 127.0.0.1).include? $db_config['host']
+    raise "For safety reasons database host #{$db_config['host']} is not allowed"
+  end
+end
+
+desc 'Reload GEM functions defined in db_functions.yml (FOR LOCAL GEM ONLY)'
+task :reload_functions => [:production_safety, :pg_connect] do
+  unless Object.const_defined?('MOD_PATH')
+    raise "To run this task you must define 'MOD_PATH'!"
+  end
+  load_db_from_yml_spec(YAML.load_file(File.join(MOD_PATH, 'config', 'db_functions.yml')))
+end
+
+desc 'Create a new database seed using db_seed.yml spec'
+task :create_db => :production_safety do
+
+  begin
+    connect_to_pg()
+    unless $db.nil?
+      $db.close
+      nuke_db = ask('Are you sure? The current database will be destroyed!!!!') { |q| q.default = 'no' }
+      if nuke_db.downcase == 'yes'
+        %x[dropdb -p #{$db_config['port']} -U #{$db_config['username']} -h #{$db_config['host']} #{$db_config['database']}]
+        raise 'dropdb failed, bailing out' unless $?.success?
+      end
+    end
+  rescue
+  end
+
+  %x[PGPASSWORD=#{$db_config['password']} createdb -h #{$db_config['host']} -U #{$db_config['username']} #{$db_config['database']}]
+  raise 'createdb failed, bailing out' unless $?.success?
+  connect_to_pg()
+  load_db_from_yml_spec(YAML.load_file(File.join(MOD_PATH, 'config', 'db_seed.yml')))
+  load_db_from_yml_spec(YAML.load_file(File.join(MOD_PATH, 'config', 'db_functions.yml')))
+  config_json_api()
+end
+
+

data/lib/tasks/doc.rake

@@ -0,0 +1,27 @@
+namespace :sp do
+  namespace :duh do
+    namespace :jsonapi do
+      namespace :doc do
+
+        desc "Generate (JSONAPI) API documentation"
+        task :generate, [ :publisher, :version, :folder ] => :environment do |task, arguments|
+
+          if arguments[:publisher].nil? || arguments[:version].nil?
+            raise "Usage: rake sp:duh:jsonapi:doc:generate[<resource publisher>,<API version>[,<documentation_folder; default = ./apidoc>]"
+          end
+
+          Rails.logger = Logger.new(STDOUT)
+          
+          generator = SP::Duh::JSONAPI::Doc::Generator.new($db || ActiveRecord::Base.connection.raw_connection)
+          if arguments[:folder].nil?
+            generator.generate(arguments[:publisher], arguments[:version])
+          else
+            generator.generate(arguments[:publisher], arguments[:version], arguments[:folder])
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/tasks/i18n.rake

@@ -0,0 +1,23 @@
+namespace :i18n do
+
+  desc "Reload all i18n entries into the database"
+  task :reload => :environment do
+
+    # Can we use the Rails' connection
+    if defined?($db)
+      pg_connection = $db
+    elsif defined?(Rails)
+      pg_connection = ActiveRecord::Base.connection.raw_connection
+    else
+      raise "No connection to Postgres!"
+    end
+
+    # For now, this is the only Excel file we will handle
+    excel_filename = File.join(SP::Duh.root, 'config', 'i18n', 'i18n.xlsx')
+    loader = SP::Duh::I18n::ExcelLoader.new(excel_filename, pg_connection)
+    loader.clear
+    loader.reload
+
+  end
+
+end

data/lib/tasks/oauth.rake

@@ -0,0 +1,29 @@
+require 'redis'
+
+namespace :sp do
+  namespace :duh do
+
+    desc "Copy OAuth configurations to Redis"
+    task :oauth, [ :root_path ] do |task, args|
+
+      root_path = args.to_hash[:root_path] || '.'
+      redis_config = HashWithIndifferentAccess[YAML.load_file(File.join(root_path, 'config/redis.yml'))]
+      oauth_config = HashWithIndifferentAccess[YAML.load_file(File.join(root_path, 'config/oauth.yml'))]
+
+      redis = Redis.new(:host => redis_config[:casper][:hostname], :port => redis_config[:casper][:port])
+      oauth_config[:'oauth-apps'].each do |service|
+        service['clients'].each do |client|
+          # First, remove old key
+          redis.del "#{service['service_id']}:oauth:#{client['client_id']}"
+          client.each do |key, value|
+            redis.hmset(
+               "#{service['service_id']}:oauth:#{client['client_id']}"   ,
+               "#{key}"                 , "#{value}"
+            )
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/tasks/transfer.rake

@@ -0,0 +1,48 @@
+namespace :sp do
+  namespace :duh do
+    namespace :transfer do
+
+      desc "Backup a sharded company for restoring to a different database"
+      task :backup, [ :company_id, :backup_file ] => :environment do |task, arguments|
+
+        if arguments[:company_id].nil?
+          raise "Usage: rake sp:duh:transfer:backup[<company_id> [, <backup_file> ]]"
+        end
+
+        company_id = arguments[:company_id].to_i
+        backer = SP::Duh::Db::Transfer::Backup.new(ActiveRecord::Base.connection.raw_connection)
+        backer.execute(company_id, arguments[:backup_file])
+
+      end
+
+      desc "Restore a sharded company backed up from a different database"
+      task :restore, [ :company_id, :backup_file ] => :environment do |task, arguments|
+
+        if arguments[:company_id].nil? || arguments[:backup_file].nil?
+          raise "Usage: rake sp:duh:transfer:backup[<company_id>, <backup_file>]"
+        end
+
+        company_id = arguments[:company_id].to_i
+        backup_file = arguments[:backup_file].to_s
+        restorer = SP::Duh::Db::Transfer::Restore.new(ActiveRecord::Base.connection.raw_connection)
+        restorer.execute(company_id, backup_file)
+
+      end
+
+      desc "Validate and get info from a sharded company backup"
+      task :check, [ :company_id, :backup_file ] => :environment do |task, arguments|
+
+        if arguments[:company_id].nil? || arguments[:backup_file].nil?
+          raise "Usage: rake sp:duh:transfer:check[<company_id>, <backup_file>]"
+        end
+
+        company_id = arguments[:company_id].to_i
+        backup_file = arguments[:backup_file].to_s
+        restorer = SP::Duh::Db::Transfer::Restore.new(ActiveRecord::Base.connection.raw_connection)
+        restorer.execute(company_id, backup_file, true)
+
+      end
+
+    end
+  end
+end

data/lib/tasks/xls2jrxml.rake

@@ -0,0 +1,15 @@
+
+desc 'Convert excel model to JRXML'
+task :xls2jrxml, [:xls_file] do |task, args|
+  args = args.to_hash()
+  args[:xls_file] = "#{args[:xls_file]}.xlsx" unless args[:xls_file].end_with?('.xlsx')
+
+  jrxml_base = File.basename(args[:xls_file], '.xlsx')
+  Dir.mkdir './tmp' unless Dir.exists?('./tmp')
+
+  converter = ::Sp::Excel::Loader::Jrxml::ExcelToJrxml.new(args[:xls_file], nil, true, true, false)
+  File.rename("#{jrxml_base}.jrxml", "./tmp/#{jrxml_base}_compat.jrxml")
+
+  converter = ::Sp::Excel::Loader::Jrxml::ExcelToJrxml.new(args[:xls_file], nil, true, true, true)
+  File.rename("#{jrxml_base}.jrxml", "./tmp/#{jrxml_base}.jrxml")
+end

data/test/jsonapi/server.rb

@@ -0,0 +1,67 @@
+require 'sinatra'
+require 'json'
+require 'yaml'
+require 'pg'
+require 'byebug'
+
+Bundler.require
+
+# Load test configuration
+
+configuration = YAML.load_file(File.join(File.expand_path(File.dirname(__FILE__)), 'config.yml'))
+
+server_configuration = configuration['server'] || {}
+test_port = server_configuration['port'] || 9001
+
+set :logging, true
+set :port, test_port
+
+# Open connection to the test database
+
+pg_configuration = configuration['database'] || {}
+pg_connection = PG.connect({
+    host: pg_configuration['host'],
+    port: pg_configuration['port'],
+    dbname: pg_configuration['database'],
+    user: pg_configuration['username'],
+    password: pg_configuration['password']
+})
+
+# Initialize and configure the test JSONAPI service
+
+jsonapi_configuration = configuration['jsonapi'] || {}
+url = jsonapi_configuration['url'] || "http://localhost:#{test_port}"
+
+# The testing environment will include all JSONAPI resources defined for the given url
+# No reloading of resources is done, since this gem does not know which publishers are available
+jsonapi_service = SP::Duh::JSONAPI::Service.new(pg_connection, url)
+$jsonapi_adapter = SP::Duh::JSONAPI::Adapters::RawDb.new(jsonapi_service)
+
+get '/*' do
+  process_request
+end
+
+post '/*' do
+  process_request
+end
+
+put '/*' do
+  process_request
+end
+
+patch '/*' do
+  process_request
+end
+
+delete '/*' do
+  process_request
+end
+
+def process_request
+  content_type 'application/vnd.api+json', :charset => 'utf-8'
+  # Send the sharding parameters in the request headers
+  schema = request.env['HTTP_X_JSONAPI_SCHEMA'] || ''
+  prefix = request.env['HTTP_X_JSONAPI_PREFIX'] || ''
+  $jsonapi_adapter.request(request.fullpath, schema, prefix, request.body.read, request.request_method.upcase)
+end
+

data/test/tasks/test.rake

@@ -0,0 +1,10 @@
+namespace :test do
+
+  namespace :jsonapi do
+    desc "Start the JSONAPI test server"
+    task :server do
+      system "ruby test/jsonapi/server.rb"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: sp-duh
+version: !ruby/object:Gem::Version
+  version: 2.0.6
+platform: ruby
+authors:
+- Jorge Morais
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sp-excel-loader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Gem to manage JSONAPI requests to a resourceful database
+email:
+- jorge.morais@cldware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- config/i18n/i18n.xlsx
+- config/initializers/active_record/connection_adapters_postgre_sql_adapter.rb
+- config/initializers/active_record/migration_without_transaction.rb
+- config/initializers/active_record/migrator.rb
+- config/initializers/rails/generators.rb
+- config/jsonapi/settings.yml
+- config/locales/pt.yml
+- lib/generators/accounting_migration/accounting_migration_generator.rb
+- lib/generators/accounting_migration/templates/migration.rb
+- lib/generators/accounting_payroll_migration/accounting_payroll_migration_generator.rb
+- lib/generators/accounting_payroll_migration/templates/migration.rb
+- lib/generators/sharded_migration/sharded_migration_generator.rb
+- lib/generators/sharded_migration/templates/migration.rb
+- lib/sp-duh.rb
+- lib/sp/duh.rb
+- lib/sp/duh/adapters/pg/text_decoder/json.rb
+- lib/sp/duh/adapters/pg/text_encoder/json.rb
+- lib/sp/duh/db/transfer/backup.rb
+- lib/sp/duh/db/transfer/restore.rb
+- lib/sp/duh/engine.rb
+- lib/sp/duh/exceptions.rb
+- lib/sp/duh/i18n/excel_loader.rb
+- lib/sp/duh/jsonapi/adapters/base.rb
+- lib/sp/duh/jsonapi/adapters/db.rb
+- lib/sp/duh/jsonapi/adapters/raw_db.rb
+- lib/sp/duh/jsonapi/configuration.rb
+- lib/sp/duh/jsonapi/doc/apidoc_documentation_format_generator.rb
+- lib/sp/duh/jsonapi/doc/generator.rb
+- lib/sp/duh/jsonapi/doc/schema_catalog_helper.rb
+- lib/sp/duh/jsonapi/doc/victor_pinus_metadata_format_parser.rb
+- lib/sp/duh/jsonapi/exceptions.rb
+- lib/sp/duh/jsonapi/model/base.rb
+- lib/sp/duh/jsonapi/model/concerns/attributes.rb
+- lib/sp/duh/jsonapi/model/concerns/model.rb
+- lib/sp/duh/jsonapi/model/concerns/persistence.rb
+- lib/sp/duh/jsonapi/model/concerns/serialization.rb
+- lib/sp/duh/jsonapi/parameters.rb
+- lib/sp/duh/jsonapi/resource_publisher.rb
+- lib/sp/duh/jsonapi/service.rb
+- lib/sp/duh/migrations.rb
+- lib/sp/duh/migrations/migrator.rb
+- lib/sp/duh/repl.rb
+- lib/sp/duh/version.rb
+- lib/tasks/db_utils.rake
+- lib/tasks/doc.rake
+- lib/tasks/i18n.rake
+- lib/tasks/oauth.rake
+- lib/tasks/transfer.rake
+- lib/tasks/xls2jrxml.rake
+- test/jsonapi/server.rb
+- test/tasks/test.rake
+homepage: https://github.com/vpfpinho/sp-duh
+licenses:
+- AGPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Gem to manage JSONAPI requests to a resourceful database
+test_files:
+- test/jsonapi/server.rb
+- test/tasks/test.rake