jiveapps 1.0.3 → 1.0.4

data/.gitignore

@@ -1,5 +1,6 @@
 pkg/*
 *.gem
+*.tmproj
 .bundle
 Gemfile.lock
 coverage/*

data/History.txt

@@ -1,8 +1,22 @@
-=== 1.0.3
+=== 1.0.4
+* 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
+  * Set git user name and email properties if not set
+  * Add git affiliation property for company name
+  * Prompt for app title and description
+  * Include jquery-1.6 feature in app template features
+  * Change boolean user preference example to something that makes sense - subscribe_to_newsletter
+  * Check that git exists before creating an app
+  * Check that git version is 1.7 or higher
+* Bug Fixes
+  * Re-add hack to double escape URL parameters in production to work around nginx/passenger bug. it was behaving correctly but seems to have regressed upstream somewhere in Passenger/Nginx/Rack
+
+=== 1.0.3 2011-05-20
 * Enhancements
   * change icon and screenshot hrefs to be relative urls
   * change screenshot rel attributes to be numbered 1-5
-* Bug fix
+* Bug Fixes
   * fix issue where new app is deleted if using older version of Git (<1.7) that doesn't support "git branch --set-upstream"
   * fix invalid reference to "images/j-icon-jaf-48.png", changed to "images/icon48.png"
   * remove hack to double escape URL parameters in production to work around old nginx/passenger bug
@@ -11,12 +25,12 @@
 
 === 1.0.2 2011-04-29
 * Minor Enhancement
-  * update app template with new syntax for screenhots in <Link> tags. remove 'screenshot' and 'thumbnail' attributes from <ModulePrefs>
+  * update app template with new syntax for screenshots in <Link> tags. remove 'screenshot' and 'thumbnail' attributes from <ModulePrefs>
 
 === 1.0.1 2011-04-18
 * Minor Enhancement
   * app template - add type="html" to <Content> elements
-* Bug Fix
+* Bug Fixes
   * app template - move example UserPrefs outside of ModulePrefs in gadget xml
 
 === 1.0.0 2011-04-06

data/app_generators/create/create_generator.rb

@@ -1,5 +1,7 @@
 class CreateGenerator < RubiGen::Base
 
+  include Jiveapps::Helpers
+
   DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
                               Config::CONFIG['ruby_install_name'])
 
@@ -7,6 +9,12 @@ class CreateGenerator < RubiGen::Base
 
   attr_reader :name
 
+  attr_reader :title,
+              :description,
+              :author_name,
+              :author_affiliation,
+              :author_email
+
   def initialize(runtime_args, runtime_options = {})
     super
     usage if args.empty?
@@ -67,6 +75,12 @@ EOS
       # Templates can access these value via the attr_reader-generated methods, but not the
       # raw instance variable value.
       # @author = options[:author]
+
+      @title              = get_app_prop_with_default('App Title',           name)
+      @description        = get_app_prop_with_default('App Description',     'Description of ' + name)
+      @author_name        = get_or_set_git_prop('--global user.name',        'Author Name')
+      @author_affiliation = get_or_set_git_prop('--global user.affiliation', 'Author Affiliation / Company Name')
+      @author_email       = get_or_set_git_prop('--global user.email',       'Author Email')
     end
 
     # Installation skeleton.  Intermediate directories are automatically

data/app_generators/create/templates/app.xml

@@ -1,15 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Module specificationVersion="1">
-  <ModulePrefs title="<%= name %>"
-               description="TODO: Replace with real description of <%= name %> inside app.xml: Module/ModulePrefs/description"
-               author="<%= author_name = `git config --global user.name`.to_s.strip; author_name.length > 0 ? author_name : 'TODO: Author Name' %>"
-               author_affiliation="Company Name"
-               author_email="<%= author_email = `git config --global user.email`.to_s.strip; author_email.length > 0 ? author_email : 'TODO: Author Email' %>"
+  <ModulePrefs title="<%= title %>"
+               description="<%= description %>"
+               author="<%= author_name %>"
+               author_affiliation="<%= author_affiliation %>"
+               author_email="<%= author_email %>"
                height="300">
 
     <!-- Commonly used features -->
     <Require feature="dynamic-height" />
     <Require feature="jive-core-v2" />
+    <Require feature="jquery-1.6" />
     <Require feature="osapi"/>
     <Require feature="settitle"/>
     <Require feature="views" />
@@ -55,7 +56,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="where_i_work" display_name="Where I Work" 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"

data/lib/jiveapps/client.rb

@@ -207,6 +207,16 @@ class Jiveapps::Client
   end
 
   def escape(value) # :nodoc:
+    ### Ugly hack - nginx/passenger unescapes the name before it gets
+    ### to rails, causing routes to fail. double encode in production
+    if Jiveapps::MODE == 'production'
+      _escape(_escape(value))
+    else
+      _escape(value)
+    end
+  end
+
+  def _escape(value)  # :nodoc:
     escaped = URI.escape(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
     escaped.gsub('.', '%2E') # not covered by the previous URI.escape
   end

data/lib/jiveapps/commands/app.rb

@@ -57,13 +57,15 @@ module Jiveapps::Command
       catch_args :appname
 
       debug "Running in debug mode."
+      check_git_version
       app_list = Jiveapps::Command.run_internal('auth:check', []) # check auth credentials and ssh key before generating app
       return unless app_list.class == Array
-      Jiveapps::Command.run_internal('keys:add', [])
+      Jiveapps::Command.run_internal('keys:add', ["--silent"])
       display "=== Creating new Jive App \"#{@appname}\"..."
       create_remote_app
       generate_app
       create_local_git_repo_and_push_to_remote
+      check_app_push
       register_app
       create_notify_user
     end
@@ -84,14 +86,14 @@ module Jiveapps::Command
     private
 
     def create_remote_app
-      display "Step 1 of 4. Check availability and create remote repository: ", false
+      display "Step 1 of 4. Checking availability and creating remote repository... ", false
       @current_app = jiveapps.create(@appname)
       handle_response_errors
     end
 
     def generate_app
       return unless current_app
-      display "Step 2 of 4. Generate app scaffolding."
+      display "Step 2 of 4. Generating app scaffolding..."
 
       require 'rubygems'
       require 'rubigen'
@@ -102,7 +104,7 @@ module Jiveapps::Command
 
     def create_local_git_repo_and_push_to_remote
       return unless current_app
-      display "Step 3 of 4. Creating local Git repository and push to remote: ", false
+      display "Step 3 of 4. Creating local Git repository and pushing to remote... ", false
 
       Dir.chdir(File.join(Dir.pwd, @appname)) do
 
@@ -124,18 +126,22 @@ module Jiveapps::Command
         display "SUCCESS"
       else
         display "FAILURE"
-        display "Git Push failed. Deleting app and cleaning up. Check SSH key and try again:\n\n" +
-                "$ jiveapps keys:list\n" +
-                "$ jiveapps keys:remove <user@machine>\n" +
-                "$ jiveapps keys:add\n" +
-                "$ jiveapps create #{@appname}"
+        display_git_push_fail_info
+        delete_app
+      end
+    end
+
+    def check_app_push
+      response_code = get_response_code(current_app['app_url'])
+      if response_code != 200
+        display_git_push_fail_info
         delete_app
       end
     end
 
     def register_app
       return unless current_app
-      display "Step 4 of 4. Registering app on the Jive Apps Dev Center and installing on sandbox: ", false
+      display "Step 4 of 4. Registering app on the Jive Apps Dev Center and installing on sandbox... ", false
 
       @current_app = jiveapps.register(@appname)
       handle_response_errors
@@ -172,11 +178,23 @@ module Jiveapps::Command
       end
     end
 
+    def display_git_push_fail_info
+      display "Git Push failed. Deleting app and cleaning up. Check SSH key and try again:\n\n" +
+              "$ jiveapps keys:list\n" +
+              "$ jiveapps keys:remove <user@machine>\n" +
+              "$ jiveapps keys:add\n" +
+              "$ jiveapps create #{@appname}"
+    end
+
     def handle_response_errors
       if @current_app.class == Hash && @current_app["errors"]
         display "FAILURE"
         @current_app["errors"].each do |key, value|
-          display "Error on \"#{key}\": #{value}"
+          if key == 'base'
+            display "Error: #{value}"
+          else
+            display "Error on \"#{key}\": #{value}"
+          end
         end
         @current_app = nil
       else
@@ -184,5 +202,13 @@ module Jiveapps::Command
       end
     end
 
+    def get_response_code(url)
+      begin
+        RestClient.get(url).code
+      rescue => e
+        e.respond_to?(:response) ? e.response.code : -1
+      end
+    end
+
   end
 end

data/lib/jiveapps/commands/keys.rb

@@ -1,6 +1,8 @@
 module Jiveapps::Command
   class Keys < Base
 
+    KEY_REGEX = /^((?:[A-Za-z0-9-]+(?:="[^"]+")?,?)+ *)?(ssh-(?:dss|rsa)) *([^ ]*) *(.*)/
+
     # Lists uploaded SSH keys
     def list
       long = args.any? { |a| a == '--long' }
@@ -19,10 +21,12 @@ module Jiveapps::Command
     # Uploads an SSH Key
     # - args.first can either be a path to a key file or be nil. if nil, looks in default paths
     def add
+      silent = extract_option("--silent").present?
       keyfile = find_key(args.first)
       key = File.read(keyfile)
+      validate_key(key, keyfile)
 
-      display "Uploading ssh public key #{keyfile}"
+      display "Uploading ssh public key #{keyfile}" unless silent
       jiveapps.add_key(key)
     end
 
@@ -71,6 +75,14 @@ module Jiveapps::Command
         end
       end
 
+      def validate_key(key, keyfile)
+        if KEY_REGEX.match(key.strip).nil?
+          fake_key = "ssh-rsa NAyG4kbVIZyokH/hMDkLbrFBktxPgsQKBgQDshif7w5RgOTK0eaNC6AJbjX0NTOgoTtbjQIX0s9fAUiakcxU3Qqna9ONXlL1mgf+WZ3KgOyUyNcgz2JPWinZseoTDNukRixqcLS9HO8qOWoLUHJZID1q1xf/btESt4UylEMiykEn712YGqCpVdFxX+q7z7b6Z5G/9n49hKWN22wKBgQCBDM1DUeqOX5Li2Hnj/EF/PfhGypAlhz/Klh40foNq7TziwFtkTZz06HpRNIhK2VcoLhU49f2v6CrcaEmll9Zs5Hw2VMrSeTNReO5gRfxlrId1imhfBkYUaZImEKSWAe3HgdyihCmXqf5SCQOtVmm5lxbgaSBjz== your.name@machine.name"
+
+          raise CommandFailed, "Invalid SSH public key format found at \"#{keyfile}\":\n\n#{key}\n\nExample of correct format:\n\n#{fake_key}\n\nCheck and fix, or regenerate key with this command:\n$ ssh-keygen -t rsa"
+        end
+      end
+
       # Formats an SSH key for display by trimming out the middle
       # Example Output:
       # ssh-rsa AAAAB3NzaC...Fyoke4MQ== pablo@jive

data/lib/jiveapps/helpers.rb

@@ -102,6 +102,31 @@ module Jiveapps
       end
     end
 
+    def has_program?(program)
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |directory|
+        path = File.join(directory, program.to_s)
+        if running_on_windows?
+          File.exists?("#{path}.cmd") || File.exists?("#{path}.exe")
+        else
+          File.executable?(path)
+        end
+      end
+    end
+
+    def user_git_version
+      return @git_version if @git_version
+      error("Git not found. Please install Git 1.7 or higher. http://git-scm.com/download") unless has_program?("git")
+      version_string = `git --version`.split(/\s+/).last
+      @git_version = Gem::Version.new(version_string)
+    end
+
+    def check_git_version
+      minimum_git_version = Gem::Version.new("1.7")
+      if user_git_version < minimum_git_version
+        error("Running Git version #{user_git_version}. Please install Git #{minimum_git_version} or higher. http://git-scm.com/download")
+      end
+    end
+
     # Display Oauth Service list
     # Example Output:
     # === 2 OAuth services for app-name
@@ -122,5 +147,39 @@ module Jiveapps
       end
     end
 
+    # Checks for existance of a git property. If it exists, return it.
+    # If it doesn't, prompt for it, set it, and return it.
+    #
+    # Example:
+    #   get_or_set_git_prop("--global user.name", "Author Name")
+    #
+    def get_or_set_git_prop(prop, title)
+      val = `git config #{prop}`.to_s.strip
+      while val.blank?
+        display "Enter #{title}: ", false
+        val = gets.strip
+        if val.blank?
+          display "#{title} cannot be blank."
+        else
+          `git config #{prop} "#{val}"`
+        end
+      end
+      val
+    end
+
+    # Prompt for an app property. If user enters a value, return it, otherwise return the default
+    #
+    # Example:
+    #   get_app_prop_with_default("App Name", "foobarbaz")
+    #
+    # Example Output:
+    #   Enter App Name or hit enter for default [foobarbaz]:
+    #
+    def get_app_prop_with_default(title, default="")
+      display "  Enter #{title} or hit enter for default [#{default}]: ", false
+      val = gets.strip
+      val.blank? ? default : val
+    end
+
   end
 end

data/lib/jiveapps/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jiveapps
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Scott Becker
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 Z
+date: 2011-06-14 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -206,6 +207,7 @@ files:
 - spec/commands/oauth_spec.rb
 - spec/commands/sharing_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: https://github.com/jivesoftware/jiveapps-gem
 licenses: []
 
@@ -235,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.2
+rubygems_version: 1.3.9.1
 signing_key: 
 specification_version: 3
 summary: The "jiveapps" gem is a set of command line tools for building and hosting Jive App front-ends.