zendesk_apps_tools 1.2.2 → 1.3.0

data/app_template/manifest.json.tt

@@ -7,5 +7,6 @@
   "defaultLocale": "en",
   "private": true,
   "location": "ticket_sidebar",
+  "version": "1.0",
   "frameworkVersion": "0.5"
 }

data/features/new.feature

@@ -1,5 +1,17 @@
 Feature: create a template for a new zendesk app
 
+  Scenario: Create a new app in an existing directory
+    Given an app directory "tmp/aruba" exists
+    And I move to the app directory
+    When I run "zat new" command with the following details:
+      | author name  | John Citizen      |
+      | author email | john@example.com  |
+      | app name     | John Test App     |
+      | app dir      |                   |
+
+   Then the app file "manifest.json" is created
+   And I reset the working directory
+
   Scenario: create a template for a new zendesk app by running 'zat new' command
     Given an app directory "tmp/aruba" exists
     When I run "zat new" command with the following details:
@@ -19,6 +31,7 @@ Feature: create a template for a new zendesk app
   "defaultLocale": "en",
   "private": true,
   "location": "ticket_sidebar",
+  "version": "1.0",
   "frameworkVersion": "0.5"
 }
 """

data/features/step_definitions/app_steps.rb

@@ -1,5 +1,14 @@
 require 'fileutils'
 
+When /^I move to the app directory$/ do
+  @previous_dir = Dir.pwd
+  Dir.chdir(@app_dir)
+end
+
+When /^I reset the working directory$/ do
+  Dir.chdir(@previous_dir)
+end
+
 Given /^an app directory "(.*?)" exists$/ do |app_dir|
   @app_dir = app_dir
   FileUtils.rm_rf(@app_dir)
@@ -42,6 +51,10 @@ Then /^the app file "(.*?)" is created with:$/ do |file, content|
   File.read(file).chomp.gsub(' ', '').should == content.gsub(' ', '')
 end
 
+Then /^the app file "(.*?)" is created$/ do |filename|
+  File.exists?(filename).should be_true
+end
+
 Then /^the fixture "(.*?)" is used for "(.*?)"$/ do |fixture, app_file|
   fixture_file = File.join('features', 'fixtures', fixture)
   app_file_path = File.join(@app_dir, app_file)

data/lib/zendesk_apps_tools/command.rb

@@ -3,6 +3,9 @@ require 'zip/zip'
 require 'pathname'
 require 'net/http'
 require 'json'
+require 'zendesk_apps_tools/translate'
+require 'zendesk_apps_tools/common'
+require 'zendesk_apps_tools/settings'
 
 module ZendeskAppsTools
   require 'zendesk_apps_support'
@@ -13,6 +16,7 @@ module ZendeskAppsTools
 
     include Thor::Actions
     include ZendeskAppsSupport
+    include ZendeskAppsTools::Common
 
     source_root File.expand_path(File.join(File.dirname(__FILE__), "../.."))
 
@@ -21,17 +25,13 @@ module ZendeskAppsTools
 
     desc "new", "Generate a new app"
     def new
-      puts "Enter this app author's name:"
-      @author_name = get_value_from_stdin(/^\w.*$/, "Invalid name, try again:")
+      @author_name = get_value_from_stdin("Enter this app author's name:\n", :error_msg => "Invalid name, try again:")
+      @author_email = get_value_from_stdin("Enter this app author's email:\n", :valid_regex => /^.+@.+\..+$/, :error_msg => "Invalid email, try again:")
+      @app_name = get_value_from_stdin("Enter a name for this new app:\n", :error_msg => "Invalid app name, try again:")
 
-      puts "Enter this app author's email:"
-      @author_email = get_value_from_stdin(/^.+@.+\..+$/, "Invalid email, try again:")
-
-      puts "Enter a name for this new app:"
-      @app_name = get_value_from_stdin(/^\w.*$/, "Invalid app name, try again:")
-
-      puts "Enter a directory name to save the new app (will create the dir if it does not exist, default to current dir):"
-      while @app_dir = $stdin.readline.chomp.strip do
+      prompt = "Enter a directory name to save the new app (will create the dir if it does not exist, default to current dir):\n"
+      opts = { :valid_regex => /^(\w|\/|\\)*$/, :allow_empty => true }
+      while @app_dir = get_value_from_stdin(prompt, opts) do
         @app_dir = './' and break if @app_dir.empty?
         if !File.exists?(@app_dir)
           break
@@ -48,8 +48,8 @@ module ZendeskAppsTools
     desc "validate", "Validate your app"
     method_option :path, :default => './', :required => false
     def validate
-      puts "Enter a zendesk URL that you'd like to install the app (for example: 'http://abc.zendesk.com', default to '#{DEFAULT_ZENDESK_URL}'):"
-      zendesk = get_value_from_stdin(/^http:\/\/\w+\.\w+|^$/, 'Invalid url, try again:')
+      prompt = "Enter a zendesk URL that you'd like to install the app (for example: 'http://abc.zendesk.com', default to '#{DEFAULT_ZENDESK_URL}'):\n"
+      zendesk = get_value_from_stdin(prompt, :valid_regex => /^http:\/\/\w+\.\w+|^$/, :error_msg => 'Invalid url, try again:')
       zendesk = DEFAULT_ZENDESK_URL if zendesk.empty?
       url = URI.parse(zendesk)
       response = Net::HTTP.start(url.host, url.port) { |http| http.get('/api/v2/apps/framework_versions.json') }
@@ -64,6 +64,7 @@ module ZendeskAppsTools
       valid = errors.none?
 
       if valid
+        app_package.warnings.each { |w| say w.to_s, :yellow }
         say_status 'validate', 'OK'
       else
         errors.each do |e|
@@ -117,7 +118,8 @@ module ZendeskAppsTools
       setup_path(options[:path])
       manifest = app_package.manifest_json
 
-      settings = settings_for_parameters(manifest[:parameters])
+      settings_helper = ZendeskAppsTools::Settings.new
+      settings = settings_helper.get_settings_from(self, manifest[:parameters])
 
       require 'zendesk_apps_tools/server'
       ZendeskAppsTools::Server.tap do |server|
@@ -130,18 +132,6 @@ module ZendeskAppsTools
 
     protected
 
-    def get_value_from_stdin(valid_regex, error_msg)
-      while input = $stdin.readline.chomp.strip do
-        unless input =~ valid_regex
-          puts error_msg
-        else
-          break
-        end
-      end
-
-      return input
-    end
-
     def setup_path(path)
       @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
     end
@@ -160,26 +150,6 @@ module ZendeskAppsTools
       @app_package ||= Package.new(self.app_dir.to_s)
     end
 
-    def settings_for_parameters(parameters)
-      return {} if parameters.nil?
-
-      parameters.inject({}) do |settings, param|
-        if param[:required]
-          puts "Enter a value for required parameter '#{param[:name]}':"
-          input = get_value_from_stdin(/\S+/, 'Invalid, try again:')
-        else
-          puts "Enter a value for optional parameter '#{param[:name]}': (press 'Return' to skip)"
-          input = $stdin.readline.chomp.strip
-        end
-
-        unless input.empty?
-          input = (input =~ /^(true|t|yes|y|1)$/i) ? true : false if param[:type] == 'checkbox'
-          settings[param[:name]] = input
-        end
-
-        settings
-      end
-    end
   end
 end
 

data/lib/zendesk_apps_tools/common.rb

@@ -7,10 +7,17 @@ module ZendeskAppsTools
       request.get(url)
     end
 
-    def get_value_from_stdin(prompt, valid_regex, error_msg)
+    def get_value_from_stdin(prompt, opts = {})
+      options = {
+        :valid_regex => opts[:allow_empty] ? /^\w*$/ : /\S+/,
+        :error_msg => 'Invalid, try again:',
+        :allow_empty => false
+      }.merge(opts)
+
       while input = ask(prompt)
-        unless input =~ valid_regex
-          say(error_msg, :red)
+        return "" if input.empty? && options[:allow_empty]
+        unless input =~ options[:valid_regex]
+          say(options[:error_msg], :red)
         else
           break
         end

data/lib/zendesk_apps_tools/settings.rb

@@ -0,0 +1,30 @@
+require 'zendesk_apps_tools/common'
+
+module ZendeskAppsTools
+  class Settings
+
+    def get_settings_from(user_input, parameters)
+      return {} if parameters.nil?
+
+      parameters.inject({}) do |settings, param|
+        if param[:default]
+          input = user_input.get_value_from_stdin("Enter a value for parameter '#{param[:name]}' or press 'Return' to use the default value '#{param[:default]}':\n", :allow_empty => true)
+          input = param[:default] if input.empty?
+        elsif param[:required]
+          input = user_input.get_value_from_stdin("Enter a value for required parameter '#{param[:name]}':\n")
+        else
+          input = user_input.get_value_from_stdin("Enter a value for optional parameter '#{param[:name]}' or press 'Return' to skip:\n", :allow_empty => true)
+        end
+
+        unless input.empty?
+          input = (input =~ /^(true|t|yes|y|1)$/i) ? true : false if param[:type] == 'checkbox'
+          settings[param[:name]] = input
+        end
+
+        settings
+      end
+    end
+
+  end
+end
+

data/lib/zendesk_apps_tools/translate.rb

@@ -18,19 +18,19 @@ module ZendeskAppsTools
       app_name = manifest['name']
 
       unless app_name
-        app_name = get_value_from_stdin('What is the name of this app?', /^\w.*$/, "Invalid name, try again:")
+        app_name = get_value_from_stdin('What is the name of this app?', :error_msg => "Invalid name, try again:")
       end
 
-      package = get_value_from_stdin('What is the package name for this app?', /^[a-z_]+$/, "Invalid package name, try again:")
+      package = get_value_from_stdin('What is the package name for this app?', :valid_regex => /^[a-z_]+$/, :error_msg => "Invalid package name, try again:")
 
       write_yaml(app_name, package)
     end
 
     desc 'update', 'Update translation files from Zendesk'
     def update(request_builder = Faraday.new)
-      app_package = get_value_from_stdin("What is the package name for this app? (without app_)", /^[a-z_]+$/, "Invalid package name, try again:")
-      user = get_value_from_stdin("What is your support.zendesk.com username?", /^.+@.+\..+$/, "Invalid email, try again:")
-      token = get_value_from_stdin("What is your support.zendesk.com API token?", /^\w*$/, "Invalid API token, try again:")
+      app_package = get_value_from_stdin("What is the package name for this app? (without app_)", :valid_regex => /^[a-z_]+$/, :error_msg => "Invalid package name, try again:")
+      user = get_value_from_stdin("What is your support.zendesk.com username?", :valid_regex => /^.+@.+\..+$/, :error_msg => "Invalid email, try again:")
+      token = get_value_from_stdin("What is your support.zendesk.com API token?", :error_msg => "Invalid API token, try again:")
 
       user = "#{user}/token"
       key_prefix = "txt.apps.#{app_package}."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_tools
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -85,7 +85,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -93,7 +93,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +142,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  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: Tools to help you develop Zendesk Apps.
 email:
 - dev@zendesk.com
@@ -155,6 +171,7 @@ files:
 - lib/zendesk_apps_tools/common.rb
 - lib/zendesk_apps_tools/locale_identifier.rb
 - lib/zendesk_apps_tools/server.rb
+- lib/zendesk_apps_tools/settings.rb
 - lib/zendesk_apps_tools/translate.rb
 - lib/zendesk_apps_tools.rb
 - app_template/app.css