jiveapps 0.0.9 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jiveapps (0.0.8.alpha)
+    jiveapps (0.1.0.alpha)
       activesupport (= 2.3.5)
       rest-client (= 1.6.1)
       rubigen (= 1.5.5)
@@ -34,9 +34,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (= 2.3.5)
   jiveapps!
-  rest-client (= 1.6.1)
   rspec (>= 2.2.0)
-  rubigen (= 1.5.5)
   webmock (>= 1.6.1)

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.1.0 2011-02-16
+* Major enhancements
+  * Multi Developer Collaboration features. Added jiveapps sharing:list, sharing:add, and sharing:remove commands.
+  * Updated app templates to include more examples of commonly used Jive App features.
+
+=== 0.0.9 2011-01-28
+* Minor enhancement
+  * Updated app code generator to require feature "jive-core-v2" instead of "jive-core-5.0.0"
+
 === 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.

data/app_generators/create/create_generator.rb

@@ -28,7 +28,9 @@ class CreateGenerator < RubiGen::Base
       m.template "hello.html",               "hello.html"
       m.template "stylesheets/main.css",     "stylesheets/main.css"
       m.template "javascripts/main.js",      "javascripts/main.js"
-      m.file     "images/j-icon-jaf-48.png", "images/j-icon-jaf-48.png"
+      m.file     "images/icon16.png",        "images/icon16.png"
+      m.file     "images/icon48.png",        "images/icon48.png"
+      m.file     "images/icon128.png",       "images/icon128.png"
 
       # Samples
       # m.template_copy_each ["template.rb", "template2.rb"]

data/app_generators/create/templates/app.xml

@@ -1,16 +1,62 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<Module>
+<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' %>"
                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">
+               thumbnail="<%= Jiveapps::WEBHOST %>/apps/<%= name %>/images/thumbnail.png"
+               screenshot="<%= Jiveapps::WEBHOST %>/apps/<%= name %>/images/screenshot.png">
+
+    <!-- Commonly used features -->
     <Require feature="dynamic-height" />
     <Require feature="jive-core-v2" />
-    <Require feature="opensocial-1.0"/>
     <Require feature="osapi"/>
     <Require feature="settitle"/>
     <Require feature="views" />
+
+    <!-- Icons - 3 sizes, 16x16, 48x48, 128x128 -->
+    <Link rel="Icon"       href="<%= Jiveapps::WEBHOST %>/apps/<%= name %>/images/icon16.png" />
+    <Link rel="MediumIcon" href="<%= Jiveapps::WEBHOST %>/apps/<%= name %>/images/icon48.png" />
+    <Link rel="LargeIcon"  href="<%= Jiveapps::WEBHOST %>/apps/<%= name %>/images/icon128.png" />
+
+    <!-- OAuth Services: https://developers.jivesoftware.com/community/docs/DOC-1161 -->
+    <!--
+    <OAuth>
+      <Service name="example">
+        <Access url="http://api.example.com/oauth/access_token" method="POST" />
+        <Request url="http://api.example.com/oauth/request_token" method="POST" />
+        <Authorization url="http://api.example.com/oauth/authorize" />
+      </Service>
+    </OAuth>
+    -->
+
+    <!-- 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" />
+    -->
+
+    <!-- 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="difficulty"
+         display_name="Difficulty"
+         datatype="enum"
+         default_value="2">
+      <EnumValue value="1" display_value="Easy"/>
+      <EnumValue value="2" display_value="Medium"/>
+      <EnumValue value="3" display_value="Hard"/>
+    </UserPref>
+    -->
+
+    <!-- Preloaded Content: http://wiki.opensocial.org/index.php?title=Remote_Data_Requests_%28v0.9%29#Preloading_data -->
+    <!--
+    <Preload href="http://www.example.com" />
+    -->
+
   </ModulePrefs>
 
   <!-- To begin development, remove the hello view and uncomment the home and canvas views below -->

data/lib/jiveapps/client.rb

@@ -48,7 +48,7 @@ class Jiveapps::Client
     rescue => e
       if e.response.body =~ /^\{/ # assume this is JSON if it starts with "{"
         errors = ActiveSupport::JSON.decode(e.response.body)
-        return {"errors" => errors}
+        return errors
       else
         nil
       end
@@ -117,6 +117,29 @@ class Jiveapps::Client
     delete("/apps/#{app_name}/oauth_services/#{name}")
   end
 
+  ### Collaborators
+
+  # Get a list of collaborators on the app, returns an array of hashes each with :email
+  def list_collaborators(app_name)
+    collaborators = get("/apps/#{app_name}/collaborators")
+
+    if collaborators.class == Array
+      collaborators.map { |item| {:username => item['collaborator']['user']['username']} }
+    else
+      return []
+    end
+  end
+
+  # Invite a person by username to collaborate on the app.
+  def add_collaborator(app_name, username)
+    post("/apps/#{app_name}/collaborators", {:collaborator => {:username => username}})
+  end
+
+  # Remove a collaborator.
+  def remove_collaborator(app_name, username)
+    delete("/apps/#{app_name}/collaborators/#{escape(username)}").to_s
+  end
+
   ### General
 
   def version

data/lib/jiveapps/command.rb

@@ -70,21 +70,22 @@ module Jiveapps
       end
 
       def extract_error(body)
-        msg = parse_error_xml(body) || parse_error_json(body) || 'Internal server error'
+        msg = parse_error_json(body) || 'Internal server error'
         msg.split("\n").map { |line| ' !   ' + line }.join("\n")
       end
 
-      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 parse_error_json(body)
-        json = JSON.parse(body.to_s)
-        json['error']
-      rescue JSON::ParserError
+        json = ActiveSupport::JSON.decode(body.to_s)
+        error_hash = json['errors']
+        return if error_hash.nil?
+        results = ["Errors:"]
+        error_hash.each do |key, errors|
+          errors.each do |error|
+            results << "- #{key} #{error}"
+          end
+        end
+        results.join("\n")
+      rescue StandardError
       end
 
     end

data/lib/jiveapps/commands/app.rb

@@ -48,8 +48,9 @@ module Jiveapps::Command
     end
 
     def install
-      display "Installing \"#{app_name}\" on the Jive App Sandbox: ", false
-      app = jiveapps.install(app_name)
+      name = (args.first && !args.first =~ /^\-\-/) ? args.first : extract_app
+      display "Installing \"#{name}\" on the Jive App Sandbox: ", false
+      app = jiveapps.install(name)
       handle_response_errors
       if app == nil
         display "App not found."

data/lib/jiveapps/commands/base.rb

@@ -86,4 +86,14 @@ module Jiveapps::Command
     end
 
   end
+
+  class BaseWithApp < Base
+    attr_accessor :app
+
+    def initialize(args, jiveapps=nil)
+      super(args, jiveapps)
+      @app ||= extract_app
+    end
+  end
+
 end

data/lib/jiveapps/commands/help.rb

@@ -24,6 +24,10 @@ oauth                                      # show the oauth services for this ap
 oauth:add <service_name> <key> <secret>    # add an oauth service for this app
 oauth:remove <service_name>                # remove an oauth service for this app
 
+sharing                                    # list collaborators
+sharing:add <username>                     # add a collaborator
+sharing:remove <username>                  # remove a collaborator
+
 === Simple Workflow Example:
 
 $ jiveapps create myapp                    # create a new app named "myapp"

data/lib/jiveapps/commands/sharing.rb

@@ -0,0 +1,34 @@
+module Jiveapps::Command
+  class Sharing < BaseWithApp
+    def list
+      display_collaborators
+    end
+    alias :index :list
+
+    def add
+      username = args.shift.downcase rescue ''
+      raise(CommandFailed, "Specify a username to give commit access to.") if username == ''
+      display "=== Adding commit access to #{app} for \"#{username}\""
+      jiveapps.add_collaborator(app, username)
+      display_collaborators
+    end
+
+    def remove
+      username = args.shift.downcase rescue ''
+      raise(CommandFailed, "Specify a username to remove commit access from.") if username == ''
+      if confirm("Are you sure you wish to remove commit access to #{app} for \"#{username}\"? (y/n)?")
+        display "=== Removing commit access to #{app} for \"#{username}\""
+        jiveapps.remove_collaborator(app, username)
+        display_collaborators
+      end
+    end
+
+    def display_collaborators
+      collaborators = jiveapps.list_collaborators(app)
+      display "=== #{collaborators.length} #{collaborators.length == 1 ? 'user has' : 'users have'} commit access to #{app}"
+      collaborators.each_with_index do |collaborator, index|
+        display "#{index+1}. #{collaborator[:username]}"
+      end
+    end
+  end
+end

data/lib/jiveapps/helpers.rb

@@ -58,6 +58,7 @@ module Jiveapps
       end
     end
 
+    # Ask user for input, trim the response
     def ask
       gets.strip
     end

data/lib/jiveapps/version.rb

@@ -1,3 +1,3 @@
 module Jiveapps
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

data/spec/client_spec.rb

@@ -6,72 +6,74 @@ describe Jiveapps::Client do
     @client = Jiveapps::Client.new(nil, nil)
   end
 
-  it "list -> get a list of this user's apps" do
-    stub_api_request(:get, "/apps").to_return(:body => <<-EOXML)
-      [
-        {
-          "app": {
-            "name"       : "foo",
-            "created_at" : "2010-10-15T23:59:10Z",
-            "updated_at" : "2010-10-15T23:59:10Z",
-            "id"         : 1
+  describe "apps" do
+    it "list -> get a list of this user's apps" do
+      stub_api_request(:get, "/apps").to_return(:body => <<-EOJSON)
+        [
+          {
+            "app": {
+              "name"       : "foo",
+              "created_at" : "2010-10-15T23:59:10Z",
+              "updated_at" : "2010-10-15T23:59:10Z",
+              "id"         : 1
+            }
+          },
+          {
+            "app": {
+              "name"       : "bar",
+              "created_at" : "2010-10-16T01:12:16Z",
+              "updated_at" : "2010-10-16T01:12:16Z",
+              "id"         : 2
+            }
           }
+        ]
+      EOJSON
+      @client.list.should == [
+        {
+          "name"       => "foo",
+          "created_at" => "2010-10-15T23:59:10Z",
+          "updated_at" => "2010-10-15T23:59:10Z",
+          "id"         => 1
         },
         {
-          "app": {
-            "name"       : "bar",
-            "created_at" : "2010-10-16T01:12:16Z",
-            "updated_at" : "2010-10-16T01:12:16Z",
-            "id"         : 2
-          }
+          "name"       => "bar",
+          "created_at" => "2010-10-16T01:12:16Z",
+          "updated_at" => "2010-10-16T01:12:16Z",
+          "id"         => 2
         }
       ]
-    EOXML
-    @client.list.should == [
-      {
-        "name"       => "foo",
+    end
+
+    it "info -> get app attributes" do
+      stub_api_request(:get, "/apps/myapp?extended=true").to_return(:body => <<-EOJSON)
+        {"app":{"name":"myapp","created_at":"2010-10-15T23:59:10Z","updated_at":"2010-10-15T23:59:10Z","id":1}}
+      EOJSON
+
+      @client.info('myapp').should == {
+        "name"       => "myapp",
         "created_at" => "2010-10-15T23:59:10Z",
         "updated_at" => "2010-10-15T23:59:10Z",
         "id"         => 1
-      },
-      {
-        "name"       => "bar",
-        "created_at" => "2010-10-16T01:12:16Z",
-        "updated_at" => "2010-10-16T01:12:16Z",
-        "id"         => 2
       }
-    ]
-  end
-
-  it "info -> get app attributes" do
-    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
-
-    @client.info('myapp').should == {
-      "name"       => "myapp",
-      "created_at" => "2010-10-15T23:59:10Z",
-      "updated_at" => "2010-10-15T23:59:10Z",
-      "id"         => 1
-    }
-  end
+    end
 
-  it "create -> should create a new app and return it's attributes" do
-    stub_api_request(:post, "/apps").to_return(:body => <<-EOXML)
-      {"app":{"name":"myapp","created_at":"2010-10-15T23:59:10Z","updated_at":"2010-10-15T23:59:10Z","id":1}}
-    EOXML
+    it "create -> should create a new app and return it's attributes" do
+      stub_api_request(:post, "/apps").to_return(:body => <<-EOJSON)
+        {"app":{"name":"myapp","created_at":"2010-10-15T23:59:10Z","updated_at":"2010-10-15T23:59:10Z","id":1}}
+      EOJSON
 
-    @client.create('myapp').should == {
-      "name"       => "myapp",
-      "created_at" => "2010-10-15T23:59:10Z",
-      "updated_at" => "2010-10-15T23:59:10Z",
-      "id"         => 1
-    }
+      @client.create('myapp').should == {
+        "name"       => "myapp",
+        "created_at" => "2010-10-15T23:59:10Z",
+        "updated_at" => "2010-10-15T23:59:10Z",
+        "id"         => 1
+      }
+    end
   end
 
   describe "ssh keys" do
     it "fetches a list of the user's current keys" do
-      stub_api_request(:get, "/ssh_keys").to_return(:body => <<-EOXML)
+      stub_api_request(:get, "/ssh_keys").to_return(:body => <<-EOJSON)
         [
             {
                 "ssh_key": {
@@ -84,7 +86,7 @@ describe Jiveapps::Client do
                 }
             }
         ]
-      EOXML
+      EOJSON
       @client.keys.should == [
         {
           "name"       => "foobar",
@@ -98,9 +100,9 @@ describe Jiveapps::Client do
     end
 
     it "add_key(key) -> add an ssh key (e.g., the contents of id_rsa.pub) to the user" do
-      stub_api_request(:post, "/ssh_keys").to_return(:body => <<-EOXML)
+      stub_api_request(:post, "/ssh_keys").with(:body => "{\"ssh_key\":{\"key\":\"a key\"}}").to_return(:body => <<-EOJSON)
         {"ssh_key":{"key":"a key"}}
-      EOXML
+      EOJSON
       @client.add_key('a key')
     end
 
@@ -117,5 +119,58 @@ describe Jiveapps::Client do
     # end
   end
 
+  describe "collaborators" do
+    it "list(app_name) -> list app collaborators" do
+      stub_api_request(:get, "/apps/myapp/collaborators").to_return(:body => <<-EOJSON)
+          [
+              {
+                  "collaborator": {
+                      "created_at": "2011-02-04T11:16:55-08:00",
+                      "updated_at": "2011-02-04T11:16:55-08:00",
+                      "app_id": 135,
+                      "id": 637,
+                      "user_id": 120,
+                      "user": {
+                          "created_at": "2011-02-04T11:16:51-08:00",
+                          "updated_at": "2011-02-04T11:16:51-08:00",
+                          "username": "scott.becker",
+                          "id": 120
+                      }
+                  }
+              },
+              {
+                  "collaborator": {
+                      "created_at": "2011-02-07T17:45:26-08:00",
+                      "updated_at": "2011-02-07T17:45:26-08:00",
+                      "app_id": 135,
+                      "id": 657,
+                      "user_id": 70,
+                      "user": {
+                          "created_at": "2011-02-04T11:16:51-08:00",
+                          "updated_at": "2011-02-04T11:16:51-08:00",
+                          "username": "aron.racho",
+                          "id": 70
+                      }
+                  }
+              }
+          ]
+      EOJSON
+      @client.list_collaborators('myapp').should == [
+        { :username => 'scott.becker' },
+        { :username => 'aron.racho' }
+      ]
+    end
+
+    it "add_collaborator(app_name, username) -> adds collaborator to app" do
+      stub_api_request(:post, "/apps/myapp/collaborators").with(:body => "{\"collaborator\":{\"username\":\"joe@example.com\"}}")
+      @client.add_collaborator('myapp', 'joe@example.com')
+    end
+
+    it "remove_collaborator(app_name, username) -> removes collaborator from app" do
+      stub_api_request(:delete, "/apps/myapp/collaborators/joe%40example%2Ecom")
+      stub_api_request(:delete, "/apps/myapp/collaborators/joe%2540example%252Ecom") # Stub double encoded version too
+      @client.remove_collaborator('myapp', 'joe@example.com')
+    end
+  end
 
 end

data/spec/commands/sharing_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Jiveapps::Command
+  describe Sharing do
+    before do
+      @cli = prepare_command(Sharing)
+    end
+
+    it "lists collaborators" do
+      @cli.jiveapps.should_receive(:list_collaborators).and_return([])
+      @cli.list
+    end
+
+    it "adds collaborators with default access to view only" do
+      @cli.stub!(:args).and_return(['joe_coworker'])
+      @cli.jiveapps.should_receive(:add_collaborator).with('myapp', 'joe_coworker')
+      @cli.add
+    end
+
+    it "removes collaborators" do
+      @cli.stub!(:args).and_return(['joe_coworker'])
+      @cli.jiveapps.should_receive(:remove_collaborator).with('myapp', 'joe_coworker')
+      @cli.remove
+    end
+
+    # it "transfers ownership" do
+    #   @cli.stub!(:args).and_return(['joe_coworker'])
+    #   @cli.jiveapps.should_receive(:update).with('myapp', :transfer_owner => 'joe_coworker')
+    #   @cli.transfer
+    # end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jiveapps
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Scott Becker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-28 00:00:00 -08:00
+date: 2011-02-16 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -137,7 +137,9 @@ files:
 - app_generators/create/templates/canvas.html
 - app_generators/create/templates/hello.html
 - app_generators/create/templates/home.html
-- app_generators/create/templates/images/j-icon-jaf-48.png
+- app_generators/create/templates/images/icon128.png
+- app_generators/create/templates/images/icon16.png
+- app_generators/create/templates/images/icon48.png
 - app_generators/create/templates/javascripts/main.js
 - app_generators/create/templates/stylesheets/main.css
 - autotest/discover.rb
@@ -152,12 +154,14 @@ files:
 - lib/jiveapps/commands/help.rb
 - lib/jiveapps/commands/keys.rb
 - lib/jiveapps/commands/oauth.rb
+- lib/jiveapps/commands/sharing.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/commands/sharing_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/jivesoftware/jiveapps-gem
@@ -189,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: The "jiveapps" gem is a set of command line tools for building and hosting Jive App front-ends.
@@ -198,4 +202,5 @@ test_files:
 - spec/commands/app_spec.rb
 - spec/commands/base_spec.rb
 - spec/commands/keys_spec.rb
+- spec/commands/sharing_spec.rb
 - spec/spec_helper.rb