dakwak 1.0.3 → 1.6.5

data/lib/dakwak.rb

@@ -1,15 +1,246 @@
-require "dakwak/version"
+require 'amqp'
+require 'socket'
+
+require 'dakwak/log_manager'
+require 'dakwak/logger'
+require 'dakwak/analytics/sheet'
+require 'dakwak/messaging/station'
+require 'dakwak/messaging/channel'
+require 'dakwak/messaging/private_channel'
+require 'dakwak/messaging/communicator'
+require 'dakwak/messaging/message'
+require 'dakwak/configurator'
+require 'dakwak/configurable'
 
 module Dakwak
-  def self.intro
-    %Q{
-  dakwak is a website translation and localization technology that helps businesses in going global by having up and running translated versions of their website with no technical involvement and no integration. 
+  attr_reader :logger, :log_manager, :station # :nodoc:
+
+  class << self
+
+    # :main:  README.rdoc
+    # :title: dakwak Gem API Reference
+
+    # ----------------------------------------
+    # :section: !Public
+    # ----------------------------------------
+
+    # Initializes the logging system and other sub-systems.
+    # This must be called before attempting to use anything!
+    #
+    # Params:
+    # +info+::
+    #  { name: String, version: [ MAJOR, MINOR, PATCH, BUILD ] }
+    #
+    # +foreground+::
+    #  Whether dakwak should be run in the foreground or in a detached
+    #  thread. If passing false, the init and teardown routines will
+    #  force a sleep of 250 milliseconds.
+    #
+    # +install_trap+::
+    #  When true, SIGINT will be trapped to call ::cleanup and
+    #  stop the EventMachine, terminating gracefully. If you need
+    #  to trap SIGINT and define custom behaviour, make sure to call
+    #  ::cleanup in your signal handler.
+    #
+    #  *Note*: this parameter is ignored when foreground = false
+    def init(info, foreground = true, install_trap = true, &callback)
+
+      @@sleep_ms = 100 / 1000.0
+
+      booter = lambda {
+        @@worker = nil
+        @@cleanup_handlers = []
+        @@app_name = info[:name]
+        @@app_fqn = format_name(info)
+
+        @@log_manager = LogManager.new
+        @@logger = Object.new
+        @@logger.extend(Logger)
+        @@logger.logging_context("")
+
+        @@station = Station.new
+
+        callback.call if callback
+
+        logger.log_info "dakwak: running in debug mode" if Dakwak.debugging?
+        logger.log_info "dakwak: dakwak initialized"
+
+        if install_trap
+          __die_gracefully
+        end
+      }
+
+      if foreground then
+        __start do booter.call end          
+      else
+        @@worker = Thread.new {
+          __start do booter.call end
+        }
+        sleep(@@sleep_ms)
+      end
+
+    end
+
+    def __start
+      if defined?(PhusionPassenger)
+        PhusionPassenger.on_event(:starting_worker_process) do |forked|
+          @@my_own_reactor = true
+          # for passenger, we need to avoid orphaned threads
+          if forked && EM.reactor_running?
+            Dakwak.cleanup
+          end
+          Thread.new { EM.run do yield end }
+          # __die_gracefully
+          sleep(@@sleep_ms * 2)
+        end
+      else
+        if EventMachine.reactor_running?
+          puts "EM reactor seems to be running, will hook into it"
+          @@my_own_reactor = false
+          yield
+        else
+          @@my_own_reactor = true
+          puts "EM reactor doesn't seem to be running, will fire it up"
+          if defined?(Thin)
+            return yield
+          end
+
+          EventMachine.run do
+            yield
+          end
+
+        end
+      end # no phusion passenger
+    end
+
+    def __die_gracefully
+      logger.log_notice "dakwak: installing traps for SIGINT and SIGTERM"
+      Signal.trap("INT") { Dakwak.cleanup }
+      Signal.trap("TERM") { Dakwak.cleanup }
+    end
+
+    def init?
+      !@@log_manager.nil?
+    end
+
+    def light_init(info)
+      @@app_name = info[:name]
+      @@app_fqn = format_name(info)
+
+      @@log_manager = LogManager.new
+      @@logger = Object.new
+      @@logger.extend(Logger)
+      @@logger.logging_context("")
+
+      @@cleanup_handlers = []
+    end
+
+    def light_init?
+      !EventMachine.reactor_running?
+    end
+
+    # Call this when you're done using dakwak.
+    def cleanup(&callback)
+      logger.log_info "dakwak: dakwak cleaning up..."
 
-  Translation quality is user-controlled through dakwak's multi-layered translation system offering machine, team, and professional translation options.
+      cleaner = Proc.new {
+        @@cleanup_handlers.each { |handler| handler.call }
 
-  Translated versions of the website run initially under a temporary subdomain provided by dakwak till the user configures his DNS and makes those versions run under his own domain name.
+        callback.call if callback
 
-  Once the translated website is running under your own domain name, translated pages will start being indexed in search engines making your website visible to people searching in their native language.  
-    }
+        logger.log_info "dakwak: dakwak cleaned up"
+
+        @@logger = nil
+        @@log_manager = nil
+      }
+
+      if light_init? then
+        cleaner.call
+      else
+        EventMachine.next_tick do
+          @@station.shutdown {
+            EventMachine.stop if @@my_own_reactor
+
+            cleaner.call
+
+            @@worker.join if @@worker
+          }
+        # sleep(@@sleep_ms)
+        end
+      end
+    end
+
+    def add_cleanup_handler(handler)
+      raise RuntimeError "cleanup handler must be a Proc or a lambda" unless handler.respond_to?(:call)
+
+      @@cleanup_handlers << handler
+    end
+
+    # An anonymous Logger that objects can use when they won't/can't
+    # include an instance of Dakwak::Logger themseles
+    def logger()
+      @@logger
+    end
+
+    # ----------------------------------------
+    # :section: Utility
+    # ----------------------------------------
+
+    # The fully-qualified application name that is unique across the network.
+    # Format:
+    #  name-version@hostname
+    #  # an example
+    #  ruby_test-0.1.0-a1@localhost.com
+    def app_fqn()
+      @@app_fqn
+    end
+
+
+    # The registered application name
+    def app_name
+      @@app_name
+    end
+
+
+    # The runtime environment, if the environment variable DAKWAK_DEBUG
+    # is defined, then the environment is set to :development, otherwise
+    # it is :production.
+    def environment
+      Dakwak.debugging? ? :development : :production
+    end
+
+    # :category: Utility
+    #
+    def debugging?
+      ENV["DAKWAK_DEBUG"] or app_fqn.include?("cornholio")
+    end
+
+    alias :development? :debugging?
+
+
+    def production?
+      !debugging?
+    end
+
+    # ----------------------------------------
+    # :section: Internal
+    # ----------------------------------------
+
+    # Used by Logger instances
+    def log_manager()
+      @@log_manager
+    end
+
+    # Use Dakwak::Station.instance instead
+    def station
+      @@station
+    end
+
+    private
+
+    def format_name(info)
+      "#{info[:name]}-#{info[:version][0]}.#{info[:version][1]}.#{info[:version][2]}-#{info[:version][3]}@#{Socket.gethostbyname(Socket.gethostname).first}"
+    end
   end
+
 end

metadata

@@ -1,81 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: dakwak
 version: !ruby/object:Gem::Version
-  version: 1.0.3
-  prerelease: 
+  version: 1.6.5
 platform: ruby
 authors:
+- Ahmad Amireh
 - dakwak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2023-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: mongo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.15.0
+- !ruby/object:Gem::Dependency
+  name: amqp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "dakwak is a website localization service that offers both machine
-  and professional translation \n    in 54 different languages.You can quickly and
-  easily translate your websites to your languages of choice, \n    and have your
-  translated websites up and running in no time."
-email:
-- nour.h@dakwak.com
-executables:
-- dakwak
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+description: A collection of interfaces and helpers for integrating an application
+  with the dakwak platform. This gem strives to be the counterpart to libdakwak, the
+  C++ library.
+email: info@dakwak.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
-- bin/dakwak
-- dakwak.gemspec
 - lib/dakwak.rb
-- lib/dakwak/version.rb
-homepage: https://dakwak.com
+- lib/dakwak/admin/bot.rb
+- lib/dakwak/admin/console.rb
+- lib/dakwak/admin/message.rb
+- lib/dakwak/analytics/sheet.rb
+- lib/dakwak/configurable.rb
+- lib/dakwak/configurator.rb
+- lib/dakwak/log_manager.rb
+- lib/dakwak/logger.rb
+- lib/dakwak/messaging/channel.rb
+- lib/dakwak/messaging/communicator.rb
+- lib/dakwak/messaging/message.rb
+- lib/dakwak/messaging/private_channel.rb
+- lib/dakwak/messaging/station.rb
+- lib/dakwak/mongo_adapter.rb
+- lib/dakwak/utility.rb
+homepage: http://github.com/dakwak/rb_dakwak
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 142627955
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 142627955
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
-summary: dakwak is a website localization service that offers both machine and professional
-  translation  in 54 different languages.
+specification_version: 4
+summary: The dakwak platform Ruby bindings.
 test_files: []

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.rvmrc

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in dakwak.gemspec
-gemspec

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2013 nour
-
-MIT License
-
-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

@@ -1,28 +0,0 @@
-# Dakwak
-
-dakwak is a website localization service that offers both machine and professional translation in 54 different languages.
-
-You can quickly and easily translate your websites to your languages of choice, and have your translated websites up and running in no time.
-
-Start your 14 day trial at dakwak now: https://dakwak.com
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'dakwak'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install dakwak
-
-## Usage
-
-For more information about dakwak, type into terminal:
-
-    $ dakwak
-

data/Rakefile

@@ -1,2 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"

data/bin/dakwak

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'dakwak'
-
-puts Dakwak.intro

data/dakwak.gemspec

@@ -1,22 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/dakwak/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["dakwak"]
-  gem.email         = ["nour.h@dakwak.com"]
-  gem.description   = %q{dakwak is a website localization service that offers both machine and professional translation 
-    in 54 different languages.You can quickly and easily translate your websites to your languages of choice, 
-    and have your translated websites up and running in no time.}
-  gem.summary       = %q{dakwak is a website localization service that offers both machine and professional translation 
-    in 54 different languages.}
-  gem.homepage      = "https://dakwak.com"
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "dakwak"
-  gem.require_paths = ["lib"]
-  gem.version       = Dakwak::VERSION
-
-  gem.add_development_dependency 'rake'
-end

data/lib/dakwak/version.rb

@@ -1,3 +0,0 @@
-module Dakwak
-  VERSION = "1.0.3"
-end