jiveapps 1.0.4 → 1.0.5

data/History.txt

@@ -1,4 +1,13 @@
-=== 1.0.4
+=== 1.0.5 2011-07-29
+* Enhancements
+  * Update app template to use preferred height of 400 px on home view
+  * Don't run gadgets.window.adjustHeight onload by default, so 400 px height persists
+  * Escape HTML entities in ModulePref attributes to prevent invalid XML
+  * Detect if git errors occur during app creation or livedev, and display if so
+* Bug Fixes:
+  * Fix example link tags for lifecycle events to have capital L
+
+=== 1.0.4 2011-06-14
 * Enhancements
   * after app has been pushed to git remote, check for existence of web copy. if it does not exist, halt and delete app
   * validate SSH key format before uploading. halt if its invalid, show user why and how to fix it
@@ -80,7 +89,7 @@
 
 === 0.0.7 2011-01-07
 * Bug fixes
-  * If Git push fails, delete app and clean up. 
+  * If Git push fails, delete app and clean up.
   * Sync SSH key whenever creating a new app to avoid Git push failures.
   * Require "fileutils" for older versions of ruby 1.8.6 that do not load it by default
 

data/app_generators/create/create_generator.rb

@@ -1,3 +1,4 @@
+require 'cgi'
 class CreateGenerator < RubiGen::Base
 
   include Jiveapps::Helpers
@@ -50,6 +51,11 @@ class CreateGenerator < RubiGen::Base
     end
   end
 
+  # Escape HTML entities
+  def h(str)
+    CGI.escapeHTML(str)
+  end
+
   protected
     def banner
       <<-EOS

data/app_generators/create/templates/app.xml

@@ -1,11 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Module specificationVersion="1">
-  <ModulePrefs title="<%= title %>"
-               description="<%= description %>"
-               author="<%= author_name %>"
-               author_affiliation="<%= author_affiliation %>"
-               author_email="<%= author_email %>"
-               height="300">
+  <ModulePrefs title="<%= h title %>"
+               description="<%= h description %>"
+               author="<%= h author_name %>"
+               author_affiliation="<%= h author_affiliation %>"
+               author_email="<%= h author_email %>">
 
     <!-- Commonly used features -->
     <Require feature="dynamic-height" />
@@ -42,8 +41,8 @@
 
     <!-- Lifecycle Events: https://developers.jivesoftware.com/community/docs/DOC-1119 -->
     <!--
-    <link rel="event.addapp" href="http://www.example.com/add" />
-    <link rel="event.removeapp" href="http://www.example.com/remove" />
+    <Link rel="event.addapp" href="http://www.example.com/add" />
+    <Link rel="event.removeapp" href="http://www.example.com/remove" />
     -->
 
     <!-- Preloaded Content: http://wiki.opensocial.org/index.php?title=Remote_Data_Requests_%28v0.9%29#Preloading_data -->
@@ -56,7 +55,7 @@
   <!-- User Preferences: http://code.google.com/apis/gadgets/docs/reference.html#Userprefs_Ref -->
   <!--
   <UserPref name="where_i_live" display_name="Where I Live" datatype="string" default_value="" required="false" />
-  <UserPref name="subscribe_to_newsletter" display_name="Subscribe to Newsletter" datatype="bool"   default_value="" required="false" />
+  <UserPref name="subscribe_to_newsletter" display_name="Subscribe to Newsletter" datatype="bool" default_value="" required="false" />
   <UserPref name="difficulty"
        display_name="Difficulty"
        datatype="enum"
@@ -68,10 +67,10 @@
   -->
 
   <!-- To begin development, remove the hello view and uncomment the home and canvas views below -->
-  <Content type="html" view="home,canvas" href="hello.html" />
+  <Content type="html" view="home,canvas" href="hello.html" preferred_height="400" />
 
   <!--
-  <Content type="html" view="home" href="home.html" />
+  <Content type="html" view="home" href="home.html" preferred_height="400" />
   <Content type="html" view="canvas" href="canvas.html" />
   -->
 

data/app_generators/create/templates/hello.html

@@ -12,11 +12,10 @@
           autoHeight: false,
           navigation: true
         });
-        gadgets.window.adjustHeight();
       });
     </script>
     <style type="text/css" media="screen">
-      body {background: #fff; font-size:90%;color:#333;font-family: arial, helvetica, sans-serif;}
+      body {background: #fff; font-size:80%;color:#333;font-family: arial, helvetica, sans-serif;}
       #wrapper {width:350px;}
       #wrapper div {padding:0;margin:0;}
       #wrapper p {padding:0;margin:0;}
@@ -33,7 +32,7 @@
       #devlinks div.documentation {padding:0;margin:0;background: url('images/icon48.png') no-repeat; background-position: 10px 2px ; height:70px;}
       #devlinks div.login {padding:0;margin:0;background: url('images/icon48.png') no-repeat; background-position: 10px 2px ; height:70px;}
       #devlinks div.market {padding:0;margin:0;background: url('images/icon48.png') no-repeat; background-position: 10px 2px ; height:70px;}
-      #devlinks div p {margin:10px 0px 0px 80px;}
+      #devlinks div p {margin:0px 0px 0px 80px;}
       #devlinks h3 a,a:hover {text-decoration:none;}
       #devlinks ul {margin:5px 0px 0px 50px;}
       #devlinks li a {font-size:95%;}

data/app_generators/create/templates/javascripts/main.js

@@ -2,5 +2,5 @@ gadgets.util.registerOnLoadHandler(function() {
   // add code that should run on page load here
 
   // resize app window to fit content
-  gadgets.window.adjustHeight();
+  // gadgets.window.adjustHeight();
 });

data/jiveapps.gemspec

@@ -39,6 +39,7 @@ Other features:
   s.add_dependency 'directory_watcher', '1.3.2'
   s.add_dependency 'rest-client',       '1.6.1'
   s.add_dependency 'rubigen',           '1.5.5'
+  s.add_dependency 'systemu',           '2.2.0'
 
   s.add_development_dependency 'rspec',   '>= 2.2.0'
   s.add_development_dependency 'rcov',    '>= 0.9.9'

data/lib/jiveapps/command.rb

@@ -1,4 +1,5 @@
 require 'jiveapps/helpers'
+require 'jiveapps/shell'
 require 'jiveapps/commands/base'
 
 Dir["#{File.dirname(__FILE__)}/commands/*.rb"].each { |c| require c }

data/lib/jiveapps/commands/app.rb

@@ -47,7 +47,7 @@ module Jiveapps::Command
           display "=== #{@appname} folder already exists."
         else
           display "=== Cloning #{@appname}..."
-          run("git clone #{app['git_url']} --origin jiveapps")
+          run("git clone #{app['git_url']} --origin jiveapps", :exec => true)
         end
       end
     end
@@ -106,32 +106,30 @@ module Jiveapps::Command
       return unless current_app
       display "Step 3 of 4. Creating local Git repository and pushing to remote... ", false
 
+      result = nil
       Dir.chdir(File.join(Dir.pwd, @appname)) do
-
-        run("git init")
-        run("git add .")
-        run('git commit -m "initial commit"')
-        run("git remote add jiveapps #{current_app['git_url']}")
-        run("git push jiveapps master")
-
-        # configure master branch to track to remote branch.
-        # was using "git branch --set-upstream master jiveapps/master"
-        # but it is only supported in git 1.7 and higher
-        run("git config branch.master.remote jiveapps")
-        run("git config branch.master.merge refs/heads/master")
-        run("git config push.default tracking")
+        result = run("git init")
+        result = run("git add .")                                         unless result.error?
+        result = run("git commit -m \"initial commit\"")                  unless result.error?
+        result = run("git remote add jiveapps #{current_app['git_url']}") unless result.error?
+        result = run("git push jiveapps master")                          unless result.error?
       end
 
-      if $? == 0
-        display "SUCCESS"
-      else
+      if result.error?
         display "FAILURE"
+        display result.error
         display_git_push_fail_info
         delete_app
+      else
+        display "SUCCESS"
+        Dir.chdir(File.join(Dir.pwd, @appname)) do
+          run("git branch --set-upstream master jiveapps/master")
+        end
       end
     end
 
     def check_app_push
+      return unless current_app
       response_code = get_response_code(current_app['app_url'])
       if response_code != 200
         display_git_push_fail_info

data/lib/jiveapps/commands/help.rb

@@ -15,8 +15,11 @@ module Jiveapps::Command
       display "create <app_name>                          # create a new app"
       display "clone <app_name>                           # clone the repository of an existing app"
       display ""
-      display "info [--app <app_name>]                    # displays information about an app"
-      display "install [--app <app_name>]                 # install an app on the sandbox (if you removed it, you can reinstall)"
+      display "=== App Specific Commands"
+      display "    NOTE: run these within app directory, or pass app name with: --app <app_name>"
+      display ""
+      display "info                                       # displays information about an app"
+      display "install                                    # install an app on the sandbox (if you removed it, you can reinstall)"
       display ""
       display "keys                                       # show your user\'s public keys"
       display "keys:add [<path to keyfile>]               # add a public key. optionally include path"

data/lib/jiveapps/commands/livedev.rb

@@ -47,9 +47,7 @@ module Jiveapps::Command
       display "\n\n\n=== Stopping LiveDev: #{app}"
 
       # remove livedev run file if it exists
-      if File.exist?(".git/livedev")
-        File.delete(".git/livedev")
-      end
+      remove_livedev_run_file
 
       # switch server to run in normal mode
       display "1/3: Switching the Jive App Sandbox to point to master branch."
@@ -98,6 +96,33 @@ module Jiveapps::Command
 
     private
 
+      # This calls the normal Jiveapps::Helper run() method,
+      # detects if there is an error, and if there is, removes
+      # the livedev run/lock file and quits with an error.
+      def run(cmd)
+        result = super(cmd)
+        if result.error?
+          display "FAILURE"
+          display result.error
+          remove_livedev_run_file
+          exit 1
+        end
+      end
+
+      # Because STDIN.gets() blocks on Windows with the systemu library
+      # We use this inside the livedev listener loop instead of the normal
+      # run() which calls systemu(). Less error handling is possible.
+      def nonblock_run(command)
+        if debug_mode?
+          puts "DEBUG: $ #{command}"
+          `#{command}`
+        elsif running_on_windows?
+          `#{command} > NUL 2>&1`
+        else
+          `#{command} > /dev/null 2>&1` # silent
+        end
+      end
+
       def livedev_branch_name
         "livedev/#{jiveapps.user}"
       end
@@ -167,22 +192,22 @@ module Jiveapps::Command
       def watch_dir_and_commit_changes
         @dw = DirectoryWatcher.new '.', :glob => '**/*', :pre_load => true
         @dw.interval = 1
-        @dw.add_observer do |*args| 
+        @dw.add_observer do |*args|
           verify_livedev_branch
 
-          changes = ""
+          changes = []
           args.each do |event|
             if event.type == :added || event.type == :modified
-              run("git add #{event.path}")
+              nonblock_run("git add #{event.path}")
             elsif event.type == :removed
-              run("git rm #{event.path}")
+              nonblock_run("git rm #{event.path}")
             end
             display "  - [#{Time.now.strftime("%Y-%m-%d %T")}] LiveDev: #{event.type} #{event.path}"
-            changes << "  #{event.type} '#{event.path}'\n"
+            changes << "#{event.type} '#{event.path}'"
           end
 
-          run("git commit -m \"LiveDev Changes\n#{changes}\"")
-          run("git push -f jiveapps #{livedev_branch_name}")
+          nonblock_run("git commit -m \"LiveDev Changes: #{changes.join(', ')}\"")
+          nonblock_run("git push -f jiveapps #{livedev_branch_name}")
         end
 
         @dw.start
@@ -219,6 +244,12 @@ module Jiveapps::Command
         end
       end
 
+      def remove_livedev_run_file
+        if File.exist?(".git/livedev")
+          File.delete(".git/livedev")
+        end
+      end
+
   end
 
 end

data/lib/jiveapps/helpers.rb

@@ -74,17 +74,22 @@ module Jiveapps
       raise Jiveapps::Command::CommandFailed, "Missing #{list.length} parameter#{list.length > 1 ? 's' : ''}: #{list.map{|l| '<' + l.to_s + '>'}.join(' ')}#{@usage}" if list.length > 0
     end
 
-    def run(command)
-      if debug_mode?
-        puts "DEBUG: $ #{command}"
-        `#{command}`
-      elsif running_on_windows?
-        `#{command} > NUL 2>&1`
+    def run(command, options={})
+      options[:exec] ||= false
+
+      puts "DEBUG: $ #{command}" if debug_mode?
+
+      if options[:exec] == true
+        exec command
       else
-        `#{command} > /dev/null 2>&1` # silent
+        sh(command)
       end
     end
 
+    def sh(command)
+      Shell.new(command).run
+    end
+
     def debug_mode?
       return @debug_mode if @debug_mode.nil? == false
 

data/lib/jiveapps/shell.rb

@@ -0,0 +1,45 @@
+# Originally taken (and modified) from GitHub-Gem: https://github.com/defunkt/github-gem/blob/master/lib/github/command.rb
+
+require 'systemu'
+
+module Jiveapps
+class Shell < String
+  attr_reader :error
+  attr_reader :out
+  attr_reader :exit_status
+
+  def initialize(command)
+    @command = command
+  end
+
+  def run
+    out = err = nil
+
+    begin
+      status, out, err = systemu(@command)
+    rescue => e
+      puts e.inspect
+    end
+
+    @exit_status = status.exitstatus
+
+    replace @error = err unless err.empty?
+    replace @out   = out unless out.empty?
+
+    self
+  end
+
+  def command
+    @command.join(' ')
+  end
+
+  def error?
+    @exit_status != 0
+  end
+
+  def out?
+    !!@out
+  end
+
+end
+end

data/lib/jiveapps/version.rb

@@ -1,3 +1,3 @@
 module Jiveapps
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jiveapps
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 1
   - 0
-  - 4
-  version: 1.0.4
+  - 5
+  version: 1.0.5
 platform: ruby
 authors: 
 - Scott Becker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-14 00:00:00 -07:00
+date: 2011-08-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -83,9 +83,25 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: systemu
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -97,11 +113,11 @@ dependencies:
         - 0
         version: 2.2.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rcov
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -113,11 +129,11 @@ dependencies:
         - 9
         version: 0.9.9
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: webmock
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -129,7 +145,7 @@ dependencies:
         - 1
         version: 1.6.1
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 description: |+
   == Jiveapps
   
@@ -197,6 +213,7 @@ files:
 - lib/jiveapps/commands/oauth.rb
 - lib/jiveapps/commands/sharing.rb
 - lib/jiveapps/helpers.rb
+- lib/jiveapps/shell.rb
 - lib/jiveapps/version.rb
 - spec/client_spec.rb
 - spec/commands/app_spec.rb
@@ -237,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.9.1
+rubygems_version: 1.3.9.2
 signing_key: 
 specification_version: 3
 summary: The "jiveapps" gem is a set of command line tools for building and hosting Jive App front-ends.