easymarklet 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 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.md

@@ -0,0 +1,64 @@
+Easymarklet
+===================
+
+The easiest way to create bookmarklets for your rails app.
+
+Installation
+-------------------
+
+Add this to your Gemfile:
+
+    gem 'easymarklet'
+
+Then run:
+
+    bundle install
+
+Building your bookmarklet code
+---------------------------------
+
+Add a file to your app/assets/javascripts directory that will hold the
+code for your bookmarklet.  For example :
+
+app/assets/javascripts/foobaz_bookmarklet.js
+
+    (function(){
+      var p = document.createElement('p');
+      p.appendChild(document.createTextNode('Foo vs. Baz'));
+      document.body.appendChild(p);
+    })();
+
+Linking to your bookmarklet
+---------------------------------
+
+Then in a view template you can link to your bookmarklet using the
+easymarklet_js helper.
+
+    <%= link_to "Foo Baz!", easymarklet_js('foobaz_bookmarklet.js') %>
+
+The resulting link will contain a small snippet of javascript that will
+load your bookmarklet code into the current page and execute it.  Place
+some instructions for your users near the link that tells them to drag
+the link into their bookmark bar.  
+
+XDM Bookmarklets
+----------------------------------
+
+* Note : XDM is a work in progress.
+
+To enable cross domain communictaion between your site and other pages
+on the 'net we need to be able to generate a fully qualified URL to your
+bookmarklet code.  To set the correct host you should add this to each
+of your confing/environment/*.rb files.  Adjust the :host accordingly.
+:port is optional.
+
+    config.action_controller.default_url_options = {:host =>
+'localhost', :port => 3000}
+
+XDM bookmarklet code acts as a consumer for data or a service that is
+supplied by the provider, a page on your app.  
+
+
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Easymarklet'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/easymarklet/consumer.js.erb

@@ -0,0 +1,181 @@
+(function(){
+
+  var Easymarklet = window.Easymarklet || {}
+
+  Easymarklet.Consumer = function(bookmarklet){
+    if(bookmarklet == null){ alert('You must pass some bookmarklet to Easymarklet.Consumer.'); return;}
+    if(bookmarklet.consumer == null){ alert('Your bookmarklet definition is missing a consumer.'); return; }
+    if(bookmarklet.producer == null){ alert('Your bookmarklet definition is missing a producer.'); return; }
+
+    var _this = this;
+    //console.log('Easymarklet.Consumer : init');
+    var bookmarklet = bookmarklet
+    var s1, s2, isLoaded = false, xhr, head = document.getElementsByTagName('head')[0];
+    var easymarkletDiv = null;
+
+    var consumer_url = encodeURIComponent(document.location);
+    var protocol = 'http://'
+    var host = '<%= Rails.application.config.action_controller.default_url_options[:host] %>';
+    var port = '<%= Rails.application.config.action_controller.default_url_options[:port] %>';
+    port = port === '' ? '' : ':' + port;
+    var full_host = protocol + host + port;
+
+    // Once easyXDM is available this will create an iframe and set up the RPC channel
+    function scriptOnLoad(){
+        
+        if (isLoaded || typeof easyXDM === "undefined" || typeof JSON === "undefined") {
+            return;
+        }
+        isLoaded = true;
+        
+        if(bookmarklet.visible){
+          easymarkletDiv = document.createElement('div');
+          easymarkletDiv.id = "easymarklet_div";
+          easymarkletDiv.className = 'easymarklet_iframe_div';
+          //easymarkletDiv.appendChild(document.createTextNode("Loading bookmarklet"));
+          document.body.appendChild(easymarkletDiv);
+        }
+
+        //var dest = full_host + "/bookmarklet_frame?dest=";
+        //dest += encodeURIComponent("/bookmarklet/court_cases/check?court_case[url]=" + caseUrl);
+        
+        var dest = full_host + bookmarklet.producer.path
+        
+        // here we put the main code, in this case we expose an ajax endpoint
+        xhr = new easyXDM.Rpc({
+          remote: dest,
+          container: easymarkletDiv,
+            onReady: function(){
+                //xhr.post("example/glossary.php", {
+                //    param1: "a",
+                //    param2: "b"
+                //}, function(json){
+                //    alert(json.glossary.title);
+                //});
+            }
+        }, _this.createRpcConfig() /*{
+          remote: {
+            
+                post: {}
+            },
+            local : {
+              alertMessage: {
+                method : function(msg){
+                    alert(msg);
+                }
+              },
+              closeFrame: {
+                method : function(){
+                  //alert('closing!');
+                  var cdiv = document.getElementById('bookmarklet_div');
+                  cdiv.parentNode.removeChild(cdiv);
+                }
+              },
+              resizeFrame : {
+                method : function(height){
+                  //console.log("resizing outter frame : " + height);
+                  var cdiv = document.getElementById('bookmarklet_div');
+                  //console.log(cdiv);
+                  //console.log(cdiv.style)
+                  cdiv.style.height = height + "px";
+                  cdiv.getElementsByTagName("iframe")[0].style.height = height + "px";
+                }
+              }
+            }
+        }*/
+      );
+    }
+
+    this.loadEasyXdmLib = function(){
+      // load easyXDM
+      s1 = document.createElement("script");
+      s1.type = "text/javascript";
+      s1.src = full_host + "/assets/easyXDM.js";
+      s1.onreadystatechange = function(){
+          if (this.readyState === "complete" || this.readyState === "loaded") {
+              scriptOnLoad();
+          }
+      };
+      s1.onload = scriptOnLoad;
+      head.appendChild(s1);
+    }
+    
+    this.loadJsonLib = function(){
+      // load JSON if needed
+      if (typeof JSON === "undefined" || !JSON) {
+          s2 = document.createElement("script");
+          s2.type = "text/javascript";
+          s2.src = full_host + "/assets/json2.js";
+          s2.onreadystatechange = function(){
+              if (this.readyState === "complete" || this.readyState === "loaded") {
+                  scriptOnLoad();
+              }
+          };
+          s2.onload = scriptOnLoad;
+          head.appendChild(s2);
+      }
+    }
+
+    this.loadCss = function(){
+      //Load the css   
+      bookmarklet.consumer.css = [].concat(bookmarklet.consumer.css)
+      for(var i = 0; i<bookmarklet.consumer.css.length; i++){
+        var src = bookmarklet.consumer.css[i]
+        var css = document.createElement('LINK');
+        css.href = full_host + src;
+        css.type = 'text/css';
+        css.media = 'screen';
+        css.rel = 'stylesheet';
+        head.appendChild(css); 
+      }
+    }
+
+    this.init = function(){
+      this.loadEasyXdmLib();
+      this.loadJsonLib();
+      this.loadCss();
+    }
+
+    this.createRpcConfig = function(){
+      var rpcConfig = {};
+
+      rpcConfig.local = {};
+      for (var key in bookmarklet.consumer.methods) {
+        if (bookmarklet.consumer.methods.hasOwnProperty(key)) {
+          //console.log(key);
+          rpcConfig.local[key] = bookmarklet.consumer.methods[key];
+        }
+      }
+      rpcConfig.local.closeFrame = this.closeFrame;
+
+      rpcConfig.remote = {};
+      for (var key in bookmarklet.producer.methods) {
+        if (bookmarklet.producer.methods.hasOwnProperty(key)) {
+          //console.log(key);
+          rpcConfig.remote[key] = {}; //We just stub these since they're not called on this side
+        }
+      }
+
+      return rpcConfig;
+    }
+
+    this.closeFrame = function(){
+      if(easymarkletDiv){
+        easymarkletDiv.parentNode.removeChild(easymarkletDiv)
+      }
+    }
+
+    this.resizeFrame = function(height){
+      easymarkletDiv.style.height = height + "px";
+      easymarkletDiv.getElementsByTagName("iframe")[0].style.height = height + "px";
+    }
+
+  } // Easymarklet.Consumer = function(){
+
+  
+  // Now expose the Easymarklet to the global object
+  window.Easymarklet = Easymarklet;
+     
+        
+})();
+

data/app/assets/javascripts/easymarklet/producer.js.erb

@@ -0,0 +1,69 @@
+(function(){
+
+  var Easymarklet = window.Easymarklet || {}
+
+  Easymarklet.Producer = function(bookmarklet){
+    if(bookmarklet == null){ alert('You must pass a bookmarklet to Easymarklet.Producer.'); return;}
+    if(bookmarklet.consumer == null){ alert('Your bookmarklet definition is missing a consumer.'); return; }
+    if(bookmarklet.producer == null){ alert('Your bookmarklet definition is missing a producer.'); return; }
+
+    var _this = this;
+    _this.consumer = null;
+    //console.log('Easymarklet.Producert : init');
+
+    this.init = function(){
+      _this.createRpcChannel();
+    }
+
+    this.createRpcConfig = function(){
+      var rpcConfig = {};
+
+      rpcConfig.remote = {};
+      for (var key in bookmarklet.consumer.methods) {
+        if (bookmarklet.consumer.methods.hasOwnProperty(key)) {
+          //console.log(key);
+          rpcConfig.remote[key] = bookmarklet.consumer.methods[key];
+          _this[key]
+        }
+      }
+      rpcConfig.remote.closeFrame = {};
+      _this.closeFrame  = function(){ _this.consumer.closeFrame() };
+
+      rpcConfig.local = {};
+      for (var key in bookmarklet.producer.methods) {
+        if (bookmarklet.producer.methods.hasOwnProperty(key)) {
+          //console.log(key);
+          rpcConfig.local[key] = {}; //We just stub these since they're not called on this side
+        }
+      }
+
+      return rpcConfig;
+    }
+
+    this.createRpcChannel = function(){
+      _this.consumer = new easyXDM.Rpc(
+        /** The channel configuration*/
+        {
+          local: "/assets/cors/index.html",
+          swf: "/assets/easyxdm.swf",
+          onReady: function(){
+            //console.log("calling the remote test....");
+            //Cicero.EasymarkletFrame.remote.alertMessage("just a test...");
+          }
+        },  _this.createRpcConfig()
+      );
+    }
+
+    this.call = function(func){
+      _this.consumer[func]();
+    }
+
+  } // Easymarklet.Producer = function(){
+
+    
+  // Now expose the Easymarklet to the global object
+  window.Easymarklet = Easymarklet;
+
+})();
+
+

data/app/helpers/easymarklet/link_helper.rb

@@ -0,0 +1,7 @@
+module Easymarklet::LinkHelper
+
+  def easymarklet_js(manifest = 'bookmarklet.js')
+    "javascript:(function(){var script=document.createElement('SCRIPT');script.src='#{root_url}assets/#{manifest}';document.body.appendChild(script);})()"
+  end
+
+end

data/config/initializers/jasminerice.rb

@@ -0,0 +1,5 @@
+if Rails.env.test? || Rails.env.development?
+    Rails.application.config.assets.paths << Easymarklet::Engine.root.join("spec", "javascripts") << Easymarklet::Engine.root.join("spec", "stylesheets")
+    # Add engine to view path so that spec/javascripts/fixtures are accessible
+    ActionController::Base.prepend_view_path Easymarklet::Engine.root
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/easymarklet.rb

@@ -0,0 +1,4 @@
+require "easymarklet/engine"
+
+module Easymarklet
+end

data/lib/easymarklet/engine.rb

@@ -0,0 +1,9 @@
+module Easymarklet
+
+  require 'easyxdm-rails'
+  
+  class Engine < ::Rails::Engine
+    config.generators.integration_tool :rspec
+    config.generators.test_framework :rspec
+  end
+end

data/lib/easymarklet/version.rb

@@ -0,0 +1,3 @@
+module Easymarklet
+  VERSION = "0.0.1"
+end

data/lib/generators/easymarklet/simple/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Generate a simple (non-xdm) bookmarklet.
+
+Example:
+    rails generate easymarklet:simple foobaz
+
+    This will create:
+        app/assets/javascripts/foobaz_bookmarklet.js
+
+    Then you could link to it with:
+        <%= link_to "FooBaz Simple", easymarklet_js('foobaz_bookmarklet.js') %>
+

data/lib/generators/easymarklet/simple/simple_generator.rb

@@ -0,0 +1,19 @@
+module Easymarklet
+  class SimpleGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+    
+    def copy_js_file
+      copy_file "simple_bookmarklet.js", "app/assets/javascripts/#{file_name}_bookmarklet.js"
+    end
+
+    def display_msg
+      puts ""
+      puts "You can link to your new bookmarklet with this :"
+      puts ""
+      puts "<%= link_to '#{file_name.titleize}', easymarklet_js('#{file_name}_bookmarklet.js') %>"
+      puts ""
+    end
+
+  end
+end
+

data/lib/generators/easymarklet/simple/templates/simple_bookmarklet.js

@@ -0,0 +1,6 @@
+(function(){
+
+  // Your simple bookmarklet code goes here.
+
+
+})();

data/lib/generators/easymarklet/xdm/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Generate a new xdm bookmarklet.
+
+Example:
+    rails generate easymarklet:xdm foobaz
+
+    This will create:
+        app/assets/javascripts/foobaz_bookmarklet.js
+        app/assets/javascripts/foobaz_consumer.js
+        app/assets/javascripts/foobaz_producer.js
+
+
+    Then you could link to it with:
+        <%= link_to "FooBaz XDM", easymarklet_js('foobaz_consumer.js') %>
+

data/lib/generators/easymarklet/xdm/templates/xdm_bookmarklet.js

@@ -0,0 +1,23 @@
+(function(){
+  
+  var <%= name.titleize %>Bookmarklet = {
+
+    visible : true,
+    consumer : {
+      css : [], // could be an array or a string
+      methods : { // The methods that the producer can call
+      
+      }
+    },
+    producer : {
+      path : "/<%= name %>_producer", // The path on your app that provides your data service
+      methods : { // The methods that the consumer can call
+      
+      }
+    }
+  }
+  
+  window.<%= name.titleize %>Bookmarklet = <%= name.titleize %>Bookmarklet;
+
+})();
+

data/lib/generators/easymarklet/xdm/templates/xdm_consumer.js

@@ -0,0 +1,5 @@
+//= require easymarklet/consumer
+//= require <%= name %>_xdm
+//
+var <%= name %>_consumer = new Easymarklet.Consumer(<%= name.titleize %>Bookmarklet);
+<%= name %>_consumer.init();

data/lib/generators/easymarklet/xdm/templates/xdm_producer.js

@@ -0,0 +1,6 @@
+//= require easymarklet/producer
+//= require <%= name %>_xdm
+//= require easyXDM
+
+var <%= name %>_producer = new Easymarklet.Producer(<%= name.titleize %>Bookmarklet);
+<%= name %>_producer.init();

data/lib/generators/easymarklet/xdm/xdm_generator.rb

@@ -0,0 +1,20 @@
+module Easymarklet
+  class XdmGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_js_file
+      template "xdm_bookmarklet.js", "app/assets/javascripts/#{file_name}_bookmarklet.js"
+      template "xdm_consumer.js", "app/assets/javascripts/#{file_name}_consumer.js"
+      template "xdm_producer.js", "app/assets/javascripts/#{file_name}_producer.js"
+    end
+
+    def display_msg
+      puts ""
+      puts "You can link to your new bookmarklet with this :"
+      puts ""
+      puts "<%= link_to '#{file_name.titleize}', bookmarklet_js('#{file_name}_consumer.js') %>"
+      puts ""
+    end
+
+  end
+end

data/lib/tasks/easymarklet_tasks.rake

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

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: easymarklet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Green
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: easyxdm-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jasminerice
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The easiest way to create bookmarklets in your rails app.
+email:
+- jeremy@octolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/easymarklet/consumer.js.erb
+- app/assets/javascripts/easymarklet/producer.js.erb
+- app/helpers/easymarklet/link_helper.rb
+- config/initializers/jasminerice.rb
+- config/routes.rb
+- lib/easymarklet/engine.rb
+- lib/easymarklet/version.rb
+- lib/easymarklet.rb
+- lib/generators/easymarklet/simple/simple_generator.rb
+- lib/generators/easymarklet/simple/templates/simple_bookmarklet.js
+- lib/generators/easymarklet/simple/USAGE
+- lib/generators/easymarklet/xdm/templates/xdm_bookmarklet.js
+- lib/generators/easymarklet/xdm/templates/xdm_consumer.js
+- lib/generators/easymarklet/xdm/templates/xdm_producer.js
+- lib/generators/easymarklet/xdm/USAGE
+- lib/generators/easymarklet/xdm/xdm_generator.rb
+- lib/tasks/easymarklet_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/Octo-Labs/easymarklet
+licenses: []
+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: -4490360310275386110
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4490360310275386110
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: The easiest way to create bookmarklets in your rails app.
+test_files: []