jiveapps 0.0.7 → 0.0.8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jiveapps (0.0.7)
+    jiveapps (0.0.8.alpha)
       activesupport (= 2.3.5)
       rest-client (= 1.6.1)
       rubigen (= 1.5.5)

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.0.8 2011-01-28
+* Major Enhancements
+  * OAuth Services management for 3rd party services. Added jiveapps oauth:list, oauth:add, and oauth:remove commands.
+  * Display OAuth Services when running "jiveapps info"
+  * Auto-detect app name from within an app directory. No longer need to pass app name to "jiveapps info"
+  * Add recommended default module prefs and required features to template.
+
 === 0.0.7 2011-01-07
 * Bug fixes
   * If Git push fails, delete app and clean up. 

data/app_generators/create/templates/app.xml

@@ -1,8 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Module>
-  <ModulePrefs title="<%= name %>">
-    <Require feature="views" />
+  <ModulePrefs title="<%= name %>"
+               author="<%= author_name = `git config --global user.name`.to_s.strip; author_name.length > 0 ? author_name : 'TODO: Author Name' %>"
+               height="300"
+               description="TODO: Replace with real description of <%= name %> inside app.xml: Module/ModulePrefs/description"
+               thumbnail="<%= Jiveapps::WEBHOST %>/apps/<%= name %>/images/j-icon-jaf-48.png">
     <Require feature="dynamic-height" />
+    <Require feature="jive-core-5.0.0" />
+    <Require feature="opensocial-1.0"/>
+    <Require feature="osapi"/>
+    <Require feature="settitle"/>
+    <Require feature="views" />
   </ModulePrefs>
 
   <!-- To begin development, remove the hello view and uncomment the home and canvas views below -->

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

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

data/lib/jiveapps/client.rb

@@ -30,7 +30,7 @@ class Jiveapps::Client
 
   def info(name)
     begin
-      item = get("/apps/#{escape(name)}")
+      item = get("/apps/#{escape(name)}?extended=true")
       item.class == Hash && item['app'] ? item['app'] : item
     rescue RestClient::ResourceNotFound
       nil
@@ -97,12 +97,32 @@ class Jiveapps::Client
     delete("/ssh_keys/#{escape(name)}").to_s
   end
 
-  def version
-    get("/gem_version").to_s
+  ### OAuth Services
+
+  def oauth_services(app_name)
+    services = get("/apps/#{app_name}/oauth_services")
+
+    if services.class == Array
+      services.map { |item| item['oauth_service'] }
+    else
+      return []
+    end
+  end
+
+  def add_oauth_service(app_name, name, key, secret)
+    post("/apps/#{app_name}/oauth_services", {:oauth_service => {:name => name, :key => key, :secret => secret}})
+  end
+
+  def remove_oauth_service(app_name, name)
+    delete("/apps/#{app_name}/oauth_services/#{name}")
   end
 
   ### General
 
+  def version
+    get("/gem_version").to_s
+  end
+
   def on_warning(&blk)
     @warning_callback = blk
   end
@@ -195,4 +215,8 @@ class Jiveapps::Client
     end
   end
 
+  def git_host
+    host.gsub(/^(http|https):\/\//, '')
+  end
+
 end

data/lib/jiveapps/command.rb

@@ -25,6 +25,16 @@ module Jiveapps
           else
             error "Authentication failure"
           end
+        rescue RestClient::ResourceNotFound => e
+          error extract_not_found(e.http_body)
+        rescue RestClient::RequestFailed => e
+          error extract_error(e.http_body) unless e.http_code == 402
+        rescue RestClient::RequestTimeout
+          error "API request timed out. Please try again, or contact Jive via the community at https://developers.jivesoftware.com if this issue persists."
+        rescue CommandFailed => e
+          error e.message
+        rescue Interrupt => e
+          error "\n[canceled]"
         end
       end
 
@@ -55,12 +65,26 @@ module Jiveapps
         end
       end
 
+      def extract_not_found(body)
+        body =~ /^[\w\s]+ not found$/ ? body : "Resource not found"
+      end
+
+      def extract_error(body)
+        msg = parse_error_xml(body) || parse_error_json(body) || 'Internal server error'
+        msg.split("\n").map { |line| ' !   ' + line }.join("\n")
+      end
 
-      ### Helpers
+      def parse_error_xml(body)
+        xml_errors = REXML::Document.new(body).elements.to_a("//errors/error")
+        msg = xml_errors.map { |a| a.text }.join(" / ")
+        return msg unless msg.empty?
+      rescue Exception
+      end
 
-      def error(msg)
-        STDERR.puts(msg)
-        exit 1
+      def parse_error_json(body)
+        json = JSON.parse(body.to_s)
+        json['error']
+      rescue JSON::ParserError
       end
 
     end

data/lib/jiveapps/commands/app.rb

@@ -24,17 +24,13 @@ module Jiveapps::Command
     end
 
     def info
-      if app_name == nil
-        display "No app specified."
-        display "Run this command from app folder or set it by running: jiveapps info <app name>"
+      name = (args.first && !args.first =~ /^\-\-/) ? args.first : extract_app
+      app = jiveapps.info(name)
+      if app == nil
+        display "App not found."
       else
-        app = jiveapps.info(app_name)
-        if app == nil
-          display "App not found."
-        else
-          display "=== #{app['name']}"
-          display_app_info(app)
-        end
+        display "=== #{app['name']}"
+        display_app_info(app)
       end
     end
 
@@ -152,6 +148,10 @@ module Jiveapps::Command
       display "Sandbox Dashboard URL: #{app['sandbox_dashboard_url']}"
       display "OAuth Consumer Key:    #{app['oauth_consumer_key']}"
       display "OAuth Consumer Secret: #{app['oauth_consumer_secret']}"
+      if app['oauth_services'] && app['oauth_services'].length > 0
+        oauth_services = app['oauth_services'].map{ |o| o['oauth_service'] }
+        display_oauth_services(oauth_services, app['name'])
+      end
     end
     
     def app_name

data/lib/jiveapps/commands/base.rb

@@ -3,17 +3,87 @@ module Jiveapps::Command
     include Jiveapps::Helpers
 
     attr_accessor :args
-    def initialize(args)
+    attr_reader :autodetected_app
+    def initialize(args, jiveapps=nil)
       @args = args
-    end
-
-    def ask
-      gets.strip
+      @jiveapps = jiveapps
+      @autodetected_app = false
     end
 
     def jiveapps
       @jiveapps ||= Jiveapps::Command.run_internal('auth:client', args)
     end
 
+    def extract_app(force=true)
+      app = extract_option('--app', false)
+      raise(CommandFailed, "You must specify an app name after --app") if app == false
+      unless app
+        app = extract_app_in_dir(Dir.pwd) ||
+        raise(CommandFailed, "No app specified.\nRun this command from app folder or set it adding --app <app name>") if force
+        @autodetected_app = true
+      end
+      app
+    end
+
+    def extract_app_in_dir(dir)
+      return unless remotes = git_remotes(dir)
+
+      if remote = extract_option('--remote')
+        remotes[remote]
+      elsif remote = extract_app_from_git_config
+        remotes[remote]
+      else
+        apps = remotes.values.uniq
+        case apps.size
+          when 0; return nil
+          when 1; return apps.first
+          else
+            current_dir_name = dir.split('/').last.downcase
+            apps.select { |a| a.downcase == current_dir_name }.first
+        end
+      end
+    end
+
+    def extract_app_from_git_config
+      remote = %x{ git config jiveapps.remote }.strip
+      remote == "" ? nil : remote
+    end
+
+    def git_remotes(base_dir)
+      git_config = "#{base_dir}/.git/config"
+      unless File.exists?(git_config)
+        parent = base_dir.split('/')[0..-2].join('/')
+        return git_remotes(parent) unless parent.empty?
+      else
+        remotes = {}
+        current_remote = nil
+        File.read(git_config).split(/\n/).each do |l|
+          current_remote = $1 if l.match(/\[remote \"([\w\d-]+)\"\]/)
+          app = (l.match(/url = git@#{jiveapps.git_host}:([\w\d-]+)\.git/) || [])[1]
+          if current_remote && app
+            remotes[current_remote.downcase] = app
+            current_remote = nil
+          end
+        end
+        return remotes
+      end
+    end
+
+    def extract_option(options, default=true)
+      values = options.is_a?(Array) ? options : [options]
+      return unless opt_index = args.select { |a| values.include? a }.first
+      opt_position = args.index(opt_index) + 1
+      if args.size > opt_position && opt_value = args[opt_position]
+        if opt_value.include?('--')
+          opt_value = nil
+        else
+          args.delete_at(opt_position)
+        end
+      end
+      opt_value ||= default
+      args.delete(opt_index)
+      block_given? ? yield(opt_value) : opt_value
+    end
+
   end
 end

data/lib/jiveapps/commands/help.rb

@@ -12,13 +12,18 @@ The "jiveapps" program is a command line tool for building and hosting Jive App
 help                                       # show this usage
 
 list                                       # list your apps
-create <name>                              # create a new app
-install <name>                             # install an app on the sandbox (if you removed it, you can reinstall)
+create <app_name>                          # create a new app
+info [--app <app_name>]                    # displays information about an app
+install [--app <app_name>]                 # install an app on the sandbox (if you removed it, you can reinstall)
 
 keys                                       # show your user's public keys
 keys:add [<path to keyfile>]               # add a public key. optionally include path
 keys:remove <keyname>                      # remove a key by name (user@host)
 
+oauth                                      # show the oauth services for this app
+oauth:add <service_name> <key> <secret>    # add an oauth service for this app
+oauth:remove <service_name>                # remove an oauth service for this app
+
 === Simple Workflow Example:
 
 $ jiveapps create myapp                    # create a new app named "myapp"

data/lib/jiveapps/commands/oauth.rb

@@ -0,0 +1,41 @@
+module Jiveapps::Command
+  class Oauth < Base
+
+    # Lists OAuth Services registered for this app
+    def list
+      app_name = extract_app
+
+      oauth_services = jiveapps.oauth_services(app_name)
+      display_oauth_services(oauth_services, app_name)
+    end
+    alias :index :list
+
+    # Register a new OAuth Service for use with this app
+    def add
+      usage    = "\n  Usage:\n  $ jiveapps oauth:add <servicename> <key> <secret>"
+      app_name = extract_app
+      raise CommandFailed, "Missing 3 parameters: <servicename>, <key>, and <secret>#{usage}" unless servicename = args.shift
+      raise CommandFailed, "Missing 2 parameters: <key> and <secret>#{usage}"                 unless key         = args.shift
+      raise CommandFailed, "Missing 1 parameter: <secret>#{usage}"                            unless secret      = args.shift
+
+      display "=== Registering a new OAuth Service: \"#{servicename}\""
+      response = jiveapps.add_oauth_service(app_name, servicename, key, secret)
+      Jiveapps::Command.run_internal('oauth:list', ["--app", app_name])
+    end
+
+    # Remove an OAuth Service
+    def remove
+      usage    = "\n  Usage:\n  $ jiveapps oauth:remove <servicename>"
+      app_name = extract_app
+      raise CommandFailed, "Missing 1 parameter: <servicename>#{usage}" unless servicename = args.shift
+
+      if confirm "Are you sure you wish to remove the OAuth service \"#{servicename}\"? (y/n)?"
+        display "=== Removing Oauth Service \"#{servicename}\""
+        response = jiveapps.remove_oauth_service(app_name, servicename)
+        Jiveapps::Command.run_internal('oauth:list', ["--app", app_name])
+      end
+    end
+
+  end
+
+end

data/lib/jiveapps/helpers.rb

@@ -25,5 +25,62 @@ module Jiveapps
       STDERR.puts(msg)
       exit 1
     end
+
+    def confirm(message="Are you sure you wish to continue? (y/n)?")
+      display("#{message} ", false)
+      ask.downcase == 'y'
+    end
+
+    def confirm_command(app = app)
+      if extract_option('--force')
+        display("Warning: The --force switch is deprecated, and will be removed in a future release. Use --confirm #{app} instead.")
+        return true
+      end
+
+      raise(Jiveapps::Command::CommandFailed, "No app specified.\nRun this command from app folder or set it adding --app <app name>") unless app
+
+      confirmed_app = extract_option('--confirm', false)
+      if confirmed_app
+        unless confirmed_app == app
+          raise(Jiveapps::Command::CommandFailed, "Confirmed app #{confirmed_app} did not match the selected app #{app}.")
+        end
+        return true
+      else
+        display "\n !    Potentially Destructive Action"
+        display " !    To proceed, type \"#{app}\" or re-run this command with --confirm #{@app}"
+        display "> ", false
+        if ask.downcase != app
+          display " !    Input did not match #{app}. Aborted."
+          false
+        else
+          true
+        end
+      end
+    end
+
+    def ask
+      gets.strip
+    end
+
+    # Display Oauth Service list
+    # Example Output:
+    # === 2 OAuth services for app-name
+    # 1. "foo" Service
+    #      Consumer Key:     bar
+    #      Consumer Secret:  baz
+    # 2. "foo2" Service
+    #      Consumer Key:     bar
+    #      Consumer Secret:  baz
+    def display_oauth_services(oauth_services, app_name)
+      if oauth_services.empty?
+        display "No OAuth Services for #{app_name}"
+      else
+        display "=== #{oauth_services.size} OAuth Service#{'s' if oauth_services.size > 1} for #{app_name}"
+        oauth_services.each_with_index do |oauth_service, index|
+          display "#{index+1}. \"#{oauth_service['name']}\" Service\n     Consumer Key:     #{oauth_service['key']}\n     Consumer Secret:  #{oauth_service['secret']}"
+        end
+      end
+    end
+
   end
 end

data/lib/jiveapps/version.rb

@@ -1,3 +1,3 @@
 module Jiveapps
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/spec/client_spec.rb

@@ -44,7 +44,7 @@ describe Jiveapps::Client do
   end
 
   it "info -> get app attributes" do
-    stub_api_request(:get, "/apps/myapp").to_return(:body => <<-EOXML)
+    stub_api_request(:get, "/apps/myapp?extended=true").to_return(:body => <<-EOXML)
       {"app":{"name":"myapp","created_at":"2010-10-15T23:59:10Z","updated_at":"2010-10-15T23:59:10Z","id":1}}
     EOXML
 

data/spec/commands/app_spec.rb

@@ -39,17 +39,21 @@ module Jiveapps::Command
       end
 
       it "shows 'App not found.' when name specified and rest client does not return an app" do
-        @cli.stub!(:args).and_return(['invalid_app'])
-        @cli.jiveapps.should_receive(:info).with('invalid_app').and_return(nil)
+        @cli.jiveapps.should_receive(:info).with('myapp').and_return(nil)
         @cli.should_receive(:display).with('App not found.')
         @cli.info
       end
 
-      it "shows 'No app specified.' when no name specified" do
+      it "shows app info using the --app syntax" do
+        @cli.stub!(:args).and_return(['--app', 'myapp'])
+        @cli.jiveapps.should_receive(:info).with('myapp').and_return({ :collaborators => [], :addons => []})
+        @cli.info
+      end
+
+      it "shows app info reading app from current git dir" do
         @cli.stub!(:args).and_return([])
-        @cli.jiveapps.should_not_receive(:info)
-        @cli.should_receive(:display).with('No app specified.')
-        @cli.should_receive(:display).with('Run this command from app folder or set it by running: jiveapps info <app name>')
+        @cli.stub!(:extract_app_in_dir).and_return('myapp')
+        @cli.jiveapps.should_receive(:info).with('myapp').and_return({ :collaborators => [], :addons => []})
         @cli.info
       end
 

data/spec/commands/base_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+module Jiveapps::Command
+  describe Base do
+    before do
+      @args = [1, 2]
+      @base = Base.new(@args)
+      @base.stub!(:display)
+      @client = mock('jiveapps client', :host => 'jiveapps.com', :git_host => 'jiveapps.com')
+    end
+
+    it "initializes the jiveapps client with the Auth command" do
+      Jiveapps::Command.should_receive(:run_internal).with('auth:client', @args)
+      @base.jiveapps
+    end
+
+    context "detecting the app" do
+      before do
+        @base.stub!(:jiveapps).and_return(@client)
+      end
+
+      it "attempts to find the app via the --app argument" do
+        @base.stub!(:args).and_return(['--app', 'myapp'])
+        @base.extract_app.should == 'myapp'
+      end
+
+      it "read remotes from git config" do
+        File.stub!(:exists?).with('/home/dev/myapp/.git/config').and_return(true)
+        File.stub!(:read).with('/home/dev/myapp/.git/config').and_return("
+[core]
+  repositoryformatversion = 0
+  filemode = true
+  bare = false
+  logallrefupdates = true
+[remote \"staging\"]
+  url = git@jiveapps.com:myapp-staging.git
+  fetch = +refs/heads/*:refs/remotes/staging/*
+[remote \"production\"]
+  url = git@jiveapps.com:myapp.git
+  fetch = +refs/heads/*:refs/remotes/production/*
+[remote \"github\"]
+  url = git@github.com:myapp.git
+  fetch = +refs/heads/*:refs/remotes/github/*
+        ")
+        @base.git_remotes('/home/dev/myapp').should == { 'staging' => 'myapp-staging', 'production' => 'myapp' }
+      end
+
+      it "attempts to find the git config file in parent folders" do
+        File.should_receive(:exists?).with('/home/dev/myapp/app/models/.git/config').and_return(false)
+        File.should_receive(:exists?).with('/home/dev/myapp/app/.git/config').and_return(false)
+        File.should_receive(:exists?).with('/home/dev/myapp/.git/config').and_return(true)
+        File.should_receive(:read).with('/home/dev/myapp/.git/config').and_return('')
+        @base.git_remotes('/home/dev/myapp/app/models')
+      end
+
+      it "gets the app from remotes when there's only one app" do
+        @base.stub!(:git_remotes).and_return({ 'jiveapps' => 'myapp' })
+        @base.extract_app.should == 'myapp'
+      end
+
+      it "uses the remote named after the current folder name when there are multiple" do
+        @base.stub!(:git_remotes).and_return({ 'staging' => 'myapp-staging', 'production' => 'myapp' })
+        Dir.stub!(:pwd).and_return('/home/dev/myapp')
+        @base.extract_app.should == 'myapp'
+      end
+
+      it "accepts a --remote argument to choose the app from the remote name" do
+        @base.stub!(:git_remotes).and_return({ 'staging' => 'myapp-staging', 'production' => 'myapp' })
+        @base.stub!(:args).and_return(['--remote', 'staging'])
+        @base.extract_app.should == 'myapp-staging'
+      end
+
+      it "raises when cannot determine which app is it" do
+        @base.stub!(:git_remotes).and_return({ 'staging' => 'myapp-staging', 'production' => 'myapp' })
+        lambda { @base.extract_app }.should raise_error(Jiveapps::Command::CommandFailed)
+      end
+    end
+
+    context "option parsing" do
+      it "extracts options from args" do
+        @base.stub!(:args).and_return(%w( a b --something value c d ))
+        @base.extract_option('--something').should == 'value'
+      end
+
+      it "accepts options without value" do
+        @base.stub!(:args).and_return(%w( a b --something))
+        @base.extract_option('--something').should be_true
+      end
+
+      it "doesn't consider parameters as a value" do
+        @base.stub!(:args).and_return(%w( a b --something --something-else c d))
+        @base.extract_option('--something').should be_true
+      end
+
+      it "accepts a default value" do
+        @base.stub!(:args).and_return(%w( a b --something))
+        @base.extract_option('--something', 'default').should == 'default'
+      end
+
+      it "is not affected by multiple arguments with the same value" do
+        @base.stub!(:args).and_return(%w( --arg1 val --arg2 val ))
+        @base.extract_option('--arg1').should == 'val'
+        @base.args.should == ['--arg2', 'val']
+      end
+    end
+
+    describe "confirming" do
+      it "confirms the app via --confirm" do
+        @base.stub(:app).and_return("myapp")
+        @base.stub(:args).and_return(["--confirm", "myapp"])
+        @base.confirm_command.should be_true
+      end
+
+      it "does not confirms the app via --confirm on a mismatch" do
+        @base.stub(:app).and_return("myapp")
+        @base.stub(:args).and_return(["--confirm", "badapp"])
+        lambda { @base.confirm_command}.should raise_error CommandFailed
+      end
+
+      it "confirms the app interactively via ask" do
+        @base.stub(:app).and_return("myapp")
+        @base.stub(:ask).and_return("myapp")
+        @base.confirm_command.should be_true
+      end
+
+      it "fails if the interactive confirm doesn't match" do
+        @base.stub(:app).and_return("myapp")
+        @base.stub(:ask).and_return("badresponse")
+        @base.confirm_command.should be_false
+      end
+    end
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jiveapps
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Scott Becker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-07 00:00:00 -08:00
+date: 2011-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -151,10 +151,12 @@ files:
 - lib/jiveapps/commands/base.rb
 - lib/jiveapps/commands/help.rb
 - lib/jiveapps/commands/keys.rb
+- lib/jiveapps/commands/oauth.rb
 - lib/jiveapps/helpers.rb
 - lib/jiveapps/version.rb
 - spec/client_spec.rb
 - spec/commands/app_spec.rb
+- spec/commands/base_spec.rb
 - spec/commands/keys_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -187,12 +189,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.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.
 test_files: 
 - spec/client_spec.rb
 - spec/commands/app_spec.rb
+- spec/commands/base_spec.rb
 - spec/commands/keys_spec.rb
 - spec/spec_helper.rb