foreign_office 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4254304d99a94d05606529febec28a0f05aeae25
+  data.tar.gz: 48c9c8aaaffb9e772de1012ce13e646b12ce0231
+SHA512:
+  metadata.gz: f31c46cf51b00ca4781404b15c401f8df3debbf228c808e649ea1e4f066b73a9909858f4a04b160cf75af6f38aabbc5791c606e60cca2fecaf3e30f6e2314b41
+  data.tar.gz: d59728edeb29b3d3e5af8ac3145d2c5852ada7194a153fa578a1324078c7de7abb634dc34d506f50ba3827d06feaa57fa62a6c06adf797a9ffd47aedbcacd7b4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= ForeignOffice
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'ForeignOffice'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/debug_logger.js

@@ -0,0 +1,22 @@
+// This is a bit heavy for what it does, but should be super-easy to extend/enhance
+var DebugLogger = Class.extend({
+  init: function($debug_settings){
+    if($debug_settings.data('logging_on')){
+      this.logging_on = true;
+    } else {
+      this.logging_on = false;
+    }
+  },
+  log: function(msg){
+    if(this.logging_on){
+      console.log(msg)
+    }
+  }
+})
+
+$(document).ready(function(){
+  if($('[data-debug_logger]')){
+    jqobj = $('[data-debug_logger]');
+    debug_logger = new DebugLogger(jqobj);
+  }
+})

data/app/assets/javascripts/foreign_office.js

@@ -0,0 +1,229 @@
+//= require debug_logger
+var ForeignOffice = Class.extend({
+  init: function(){
+    this.pubnub = PUBNUB.init({
+      publish_key   : 'pub-c-1146120f-14f7-4649-9dee-3b21a519d573',
+      subscribe_key : 'sub-c-9d1b308c-a5f1-11e2-87b3-12313f022c90',
+      ssl           : true
+    });
+    this.channels = [];
+    this.channels_by_name = [];
+  },
+  connection: function(){
+    return this.pubnub;
+  },
+  addListener: function($listener){
+    var listener_class = eval(getSubClass($listener.data('listener'),'ForeignOfficeListener'));
+    var listener = new listener_class($listener);
+    var this_channel;
+    if($.inArray(listener.channel,this.channelNames()) == -1){
+      this_channel = new ForeignOfficeChannel(listener.channel)
+      this.channels.push(this_channel);
+      this.channels_by_name[listener.channel] = this_channel;
+    } else {
+      var this_channel = this.channels_by_name[listener.channel];
+    }
+    this_channel.addListener(listener);
+  },
+  channelNames: function(){
+    return $.map(this.channels,function(channel){return channel.channel_name});
+  }
+});
+
+foreign_office = new ForeignOffice();
+
+var ForeignOfficeChannel = Class.extend({
+  init: function(channel_name){
+    var foreign_office_channel = this;
+    foreign_office.connection().subscribe({
+      channel : channel_name,
+      backfill: true,
+      message : function(m){
+        debug_logger.log("Got a message: ");
+        debug_logger.log(m);
+        $.each(foreign_office_channel.listeners,function(i,listener){
+          debug_logger.log("sending message to listener: ");
+          debug_logger.log(listener);
+          listener.handleMessage(m);
+        });
+      }
+    });
+    this.channel_name = channel_name;
+    this.listeners = [];
+  },
+  addListener: function(listener){
+    this.listeners.push(listener);
+  }
+});
+
+var ForeignOfficeListener = Class.extend({
+  init: function($listener){
+    console.log("ForeignOfficeListener initializer:")
+    console.log($listener);
+    this.$listener = $listener;
+    this.endpoint = $listener.data('endpoint');
+    this.object_key = $listener.data('key');
+    this.delete_key = $listener.data('delete-key');
+    this.channel = $listener.data('channel');
+    if(this.$listener.data('progress-indicator')){
+      this.progress_indicator = new AjaxProgress(this.$listener);
+    }
+  },
+  handleMessage: function(m){
+    var $listener = this.$listener;
+    if(this.endpoint){
+      if (m.object[this.object_key] == true) {
+        $.get(this.endpoint, function(data){
+          $listener.html(data);
+        })
+      }
+      if (m.object[this.delete_key] == true) {
+        $listener.remove;
+      }
+    }else{
+      var new_value = m.object[this.object_key];
+      switch(this.$listener.get(0).nodeName.toLowerCase()){
+        case 'input': case 'select':
+          this.$listener.val(new_value);
+        break;
+
+        case 'a':
+          if(this.$listener.data('trigger-on-message')){
+            this.$listener.attr('href',new_value);
+            if(this.progress_indicator){
+              this.progress_indicator.stop();
+            }
+            if(this.$listener.data('ajax_link')){
+              this.$listener.trigger('click');
+            }else{
+              window.location = new_value;
+            }
+          }else{
+            this.$listener.html(new_value);
+          }
+        break;
+
+        case 'img':
+          this.$listener.prop('src',new_value);
+        break;
+
+        default:
+          this.$listener.html(new_value);
+        break;
+      }
+    }
+    this.getForeignOfficeProgressIndicator();
+    this.removeProgressIndicator();
+  },
+  getForeignOfficeProgressIndicator: function(){
+    var this_listener = this;
+    $('[data-foreign-office-progress-indicator="' + this.channel + '"]').each(function(){
+      this_listener.foreign_office_progress_indicator = $(this).data('foreign-office-progress-indicator-object');
+      console.log($(this).data());
+      this_listener.foreign_office_flash = $(this).data('ajax-foreign-office-flash').notice;
+    })
+  },
+  removeProgressIndicator: function(){
+    if(this.foreign_office_progress_indicator){
+      this.foreign_office_progress_indicator.stop();
+      if(this.foreign_office_flash){
+        new AjaxFlash('success',this.foreign_office_flash,this.$listener);
+      }
+    }
+  }
+});
+
+var ForeignNewListItems = ForeignOfficeListener.extend({
+  handleMessage: function(m){
+    var $listener = this.$listener;
+    $.get(m.object[this.object_key], function(data){
+      $listener.append(data);
+    })
+  }
+});
+
+var ForeignOfficeRevealer = ForeignOfficeListener.extend({
+  handleMessage: function(m){
+    var current_value = m.object[this.object_key];
+    if(!current_value || current_value == 'false' || current_value == 'hide'){
+      this.$listener.hide();
+    } else if(current_value == true || current_value == 'true' || current_value == 'show'){
+      this.$listener.removeClass('hidden');
+      this.$listener.show();
+    }
+  }
+});
+
+var ForeignOfficeColor = ForeignOfficeListener.extend({
+  handleMessage: function(m){
+     var new_value = m.object[this.object_key];
+     this.$listener.html(new_value);
+     if(new_value == "Yes") {
+        this.$listener.removeClass('red').addClass('green');
+     } else {
+        this.$listener.removeClass('green').addClass('red');
+     }
+  }
+});
+
+//Anytime loader, needs to be extracted into its own library
+
+var AnyTimeManager = Class.extend({
+  init: function(){
+    this.loader_array = []
+  },
+  register: function(data_attribute,base_class,load_method){
+    this.loader_array.push({data_attribute: data_attribute, base_class: base_class, load_method: load_method});
+  },
+  instantiate: function(jq_obj, class_name){
+    if(!jq_obj.data('anytime_loaded')){
+      jq_obj.data('anytime_loaded',true);
+      var this_class = eval(class_name);
+      new this_class(jq_obj);
+    }
+  },
+  run: function (jq_obj, resource, method_name){
+    if(!jq_obj.data('anytime_run')){
+      jq_obj.data('anytime_run',true);
+      resource[method_name](jq_obj);
+    }
+  },
+  load: function(){
+    var any_time_manager = this;
+    $.each(any_time_manager.loader_array,function(){
+      var data_attribute = this['data_attribute'];
+      var base_class = this['base_class'];
+      var this_method = this['load_method'];
+      console.log(this_method);
+      $('[data-' + data_attribute + ']').each(function(){
+        if('instantiate' == this_method){
+          var declared_class = $(this).data(data_attribute);
+          var this_class = getSubClass(declared_class,base_class);
+          any_time_manager.instantiate($(this),this_class);
+        }else{
+          console.log('running...')
+          console.log(base_class);
+          any_time_manager.run($(this),base_class,this_method);
+        }
+
+      });
+    });
+  }
+});
+var AnytimeLoader = Class.extend({
+  init: function(jq_obj){
+    this.jq_obj = jq_obj;
+    jq_obj.data('anytime_loaded',true);
+  }
+});
+any_time_manager = new AnyTimeManager();
+$(document).ajaxComplete(function(){
+  any_time_manager.load();
+});
+$(document).ready(function(){
+  any_time_manager.load();
+});
+
+// End AnyTime library
+
+any_time_manager.register('listener',foreign_office,'addListener');

data/lib/foreign_office.rb

@@ -0,0 +1,68 @@
+require 'request_store'
+module ForeignOffice
+
+  class Engine < ::Rails::Engine
+    isolate_namespace ForeignOffice
+  end
+
+  def self.bus=(bus)
+    @bus = bus
+  end
+
+  def self.bus
+    @bus
+  end
+  
+  def self.set_publish_method(&block)
+    @publish_method = block
+  end
+
+  def self.publish_method
+    @publish_method
+  end
+
+  def self.publish(message)
+    Rails.logger.debug("ForeignOffice.publish: #{message.inspect}")
+    if !!@cache_messages
+      RequestStore.store[:foreign_office_messages][message[:channel]] = message
+    else
+      self.handle_publish_request(message)
+    end
+  end
+
+  def self.cache_messages
+    @cache_messages = true
+    RequestStore.store[:foreign_office_messages] = {}
+  end
+
+  def self.publish_directly
+    @cache_messages = false
+  end
+
+  def self.flush_messages
+    messages = RequestStore.store[:foreign_office_messages].dup
+    RequestStore.store[:foreign_office_messages] = {}
+    messages.each do |channel,message|
+      self.handle_publish_request(message)
+    end
+  end
+
+  def self.handle_publish_request(message)
+    if self.publish_method
+      self.publish_method.call(message)
+    else
+      self.publish!(message)
+    end
+  end
+
+  def self.publish!(message, attempts = 0)
+    attempts += 1
+    Rails.logger.debug("ForeignOffice#publish! attempt: #{attempts} message: #{message.inspect}")
+    self.bus.publish(message)
+  end
+
+  module Busses
+  end
+end
+require 'foreign_office/busses/generic_bus'
+require 'foreign_office/busses/pubnub_bus'

data/lib/foreign_office/busses/generic_bus.rb

@@ -0,0 +1,4 @@
+class ForeignOffice::Busses::GenericBus
+  def publish(message)
+  end
+end

data/lib/foreign_office/busses/pubnub_bus.rb

@@ -0,0 +1,34 @@
+class ForeignOffice::Busses::PubnubBus < ForeignOffice::Busses::GenericBus
+
+  def self.settings
+    @settings ||= Sekrets.settings_for(Rails.root.join('config', 'pubnub.yml.enc'))
+  end
+
+  def self.connection
+    @pubnub ||= ::Pubnub.new(
+      publish_key:    self.settings['PUBNUB_PUBLISH_KEY'], # publish_key only required if publishing.
+      subscribe_key:  self.settings['PUBNUB_SUBSCRIBE_KEY'], # required
+      secret_key:     self.settings['PUBNUB_SECRET_KEY'],
+      error_callback: lambda { |msg| Rails.logger.error( msg.inspect )}
+    )
+  end
+
+  def self.publish(message)
+    message.symbolize_keys!
+    self.connection.publish(
+      channel:  message[:channel],
+      message:  message,
+      http_sync: true,
+      callback: lambda{|response|
+        if 0 == JSON.parse(response.instance_variable_get(:@response)).first #pubnub publishing failed
+          if attempts <= 3
+            self.publish!(message, attempts) #retry if we failed
+          else
+            Rails.logger.debug("ForeignOffice#publish! failed after #{attempts} attempts. message: #{message.inspect}")
+          end
+        end
+      }
+    )
+  end
+
+end

data/lib/foreign_office/busses/pusher_bus.rb

@@ -0,0 +1,2 @@
+class PusherBus < GenericBus
+end

data/lib/foreign_office/version.rb

@@ -0,0 +1,3 @@
+module ForeignOffice
+  VERSION = "0.0.2"
+end

data/lib/tasks/foreign_office_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :foreign_office do
+#   # Task goes here
+# end