zendesk_apps_tools 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8906f30379d39459e50f199c75e9080c72796969
-  data.tar.gz: 312e91d0b90ee05f68cc0a4d2763c53e1081fd66
+  metadata.gz: 4d8f580eb9d40e157571b7340cd6c8293cb710d5
+  data.tar.gz: 8f2dac8f3c3fafc16de94349b0b85ca439640fd8
 SHA512:
-  metadata.gz: 026582f412996276ded39df7acb3b041ef80d5f60a636718f417970f874a670a6ef30c72d1f5d06bdaef09d5230aadc1df44c4bdd3348610fb57fa51586d4c0b
-  data.tar.gz: 9eb01efdff61af498867468ccac8402ce6b5c4b963781111ddc1b96d5e6b5adb3a5f75bc6f421d7af8938b09b7e347c0aa787d45a4d0a35c21ec8ac195d2ecea
+  metadata.gz: 7bb1297c754608cee26d0dfc17c55232ff298878ec08893279ab22f3164067daa82ecc12a356094cc7854ccde2a3ee93e3fb7673e8157ad9259704dbc3c35c58
+  data.tar.gz: eff9068eb5f589721875bae8b4e228b5a3b2c16f4b4a83a46732b1529190cfd5f895d4d2be5f35881615ed5d57fc39c320ec4050438653b7fe9e8220d2d5610d

data/app_template_iframe/translations/en.json

@@ -1,16 +1,7 @@
 {
   "app": {
-    "description": "Play the famous zen tunes in your help desk.",
-    "name": "Buddha Machine"
-  },
-  "loading": "Welcome to this Sample App",
-  "fetch": {
-    "done": "Good",
-    "fail": "failed to fetch information from the server"
-  },
-  "id": "ID",
-  "email": "Email",
-  "name": "Name",
-  "role": "Role",
-  "groups": "Groups"
+    "short_description": "Play the famous zen tunes in your help desk.",
+    "long_description": "Play the famous zen tunes in your help desk and \n listen to the beats it has to offer.",
+    "installation_instructions": "Simply click install."
+  }
 }

data/features/fixtures/quote_character_translation.json

@@ -1,6 +1,7 @@
 {
   "app": {
-    "description":  "Play the famous zen tunes in your help desk.",
-    "name":         "Buddha \"Machine\""
+    "short_description": "Play the famous zen tunes in your help desk.",
+    "long_description": "Play the famous zen tunes in your help desk and \n listen to the beats it has to offer.",
+    "installation_instructions": "Simply click install."
   }
 }

data/features/new.feature

@@ -14,79 +14,6 @@ Feature: create a template for a new zendesk app
    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 --v1' command
-    Given an app directory "tmp/aruba" exists
-    When I run "zat new --v1" command with the following details:
-      | author name  | John Citizen      |
-      | author email | john@example.com  |
-      | author url   | http://myapp.com  |
-      | app name     | John Test App     |
-      | app dir      | tmp/aruba         |
-
-    Then the app file "tmp/aruba/manifest.json" is created with:
-    """
- {
-   "name": "John Test App",
-   "author": {
-     "name": "John Citizen",
-     "email": "john@example.com",
-     "url": "http://myapp.com"
-   },
-   "defaultLocale": "en",
-   "private": true,
-   "location":["ticket_sidebar"],
-   "version": "1.0",
-   "frameworkVersion": "1.0"
- }
-    """
-    And the app file "tmp/aruba/app.js" is created with:
-    """
- (function() {
-
-   return {
-     events: {
-       'app.activated':'doSomething'
-     },
-
-     doSomething: function() {
-     }
-   };
-
- }());
-    """
-    And the app file "tmp/aruba/templates/layout.hdbs" is created with:
-    """
- <header>
-   <span class="logo"></span>
-   <h3>{{setting "name"}}</h3>
- </header>
- <section data-main></section>
- <footer>
-   <a href="mailto:{{author.email}}">
-     {{author.name}}
-   </a>
- </footer>
-    """
-    And the app file "tmp/aruba/translations/en.json" is created with:
-    """
- {
-   "app": {
-     "description": "Play the famous zen tunes in your help desk.",
-     "name": "Buddha Machine"
-   },
-   "loading": "Welcome to this Sample App",
-   "fetch": {
-     "done": "Good",
-     "fail": "failed to fetch information from the server"
-   },
-   "id": "ID",
-   "email": "Email",
-   "name": "Name",
-   "role": "Role",
-   "groups": "Groups"
- }
-    """
-
   Scenario: create a template for a new iframe only app by running 'zat new' command
     Given an app directory "tmp/aruba" exists
     And I move to the app directory

data/features/package.feature

@@ -14,18 +14,6 @@ Feature: package a zendesk app into a zip file
     And the command output should contain "created"
     And the zip file should exist in directory "tmp/aruba/tmp"
 
-    Scenario: package a v1 zendesk app by running 'zat package' command
-      Given a v1 app is created in directory "tmp/aruba"
-      When I run the command "zat package --path tmp/aruba" to package the app
-      And the command output should contain "adding app.js"
-      And the command output should contain "adding templates/layout.hdbs"
-      And the command output should contain "adding assets/logo-small.png"
-      And the command output should contain "adding assets/logo.png"
-      And the command output should contain "adding manifest.json"
-      And the command output should contain "adding translations/en.json"
-      And the command output should contain "created"
-      And the zip file should exist in directory "tmp/aruba/tmp"
-
   Scenario: package a zendesk app by running 'zat package' command
     Given an app is created in directory "tmp/aruba"
     When I create a symlink from "./templates/translation.erb.tt" to "tmp/aruba/assets/translation.erb.tt"

data/lib/zendesk_apps_tools/command.rb

@@ -27,7 +27,8 @@ module ZendeskAppsTools
                                   aliases: ['--v2']
     method_option :v1, type: :boolean, default: false, desc: 'Create a version 1 app template'
     def new
-      check_new_options
+      deprecated_message('error', '1.0') if options[:v1]
+
       enter = ->(variable) { "Enter this app author's #{variable}:\n" }
       invalid = ->(variable) { "Invalid #{variable}, try again:" }
       @author_name  = get_value_from_stdin(enter.call('name'),
@@ -52,10 +53,8 @@ module ZendeskAppsTools
 
       prompt_new_app_dir
 
-      skeleton = options[:v1] ? 'app_template' : 'app_template_iframe'
-      is_custom_iframe = !options[:v1] && @iframe_location != 'assets/iframe.html'
-      directory_options = is_custom_iframe ? { exclude_pattern: /iframe.html/ } : {}
-      directory(skeleton, @app_dir, directory_options)
+      directory_options = @iframe_location != 'assets/iframe.html' ? { exclude_pattern: /iframe.html/ } : {}
+      directory('app_template_iframe', @app_dir, directory_options)
     end
 
     desc 'validate', 'Validate your app'
@@ -77,6 +76,7 @@ module ZendeskAppsTools
 
       if valid
         app_package.warnings.each { |w| say w.to_s, :yellow }
+        deprecated_message
         say_status 'validate', 'OK'
       else
         errors.each do |e|
@@ -191,17 +191,6 @@ module ZendeskAppsTools
 
     protected
 
-    def check_new_options
-      if options[:'iframe-only']
-        if options[:v1]
-          say_error_and_exit "Apps can't be created with both --v1 and --v2 (or --iframe-only)."
-        else
-          warning = 'v2 is the default for new apps, the --v2 and --iframe-only options have no effect.'
-          say_status 'warning', warning, :yellow
-        end
-      end
-    end
-
     def setup_path(path)
       @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
     end
@@ -217,5 +206,20 @@ module ZendeskAppsTools
         ZendeskAppsTools::Settings.new(self)
       end
     end
+
+    def deprecated_message(type = 'warning', target_version = manifest.framework_version)
+      require 'zendesk_apps_support/app_version'
+      zas = ZendeskAppsSupport::AppVersion.new(target_version)
+
+      version_status = zas.sunsetting? ? 'being sunset' : 'deprecated'
+      deprecated_message = zas.sunsetting? ? "No new v#{target_version} app framework submissions will be accepted from August 1st, 2017" : "No new v#{target_version} app framework submissions or updates will be accepted"
+      message = "You are targeting the v#{target_version} app framework, which is #{version_status}. #{deprecated_message}. Consider migrating to the v#{zas.current} framework. For more information: http://goto.zendesk.com/zaf-sunset"
+
+      if zas.deprecated? || type == 'error'
+        say_error_and_exit message
+      elsif zas.sunsetting?
+        say_status 'warning', message, :yellow
+      end
+    end
   end
 end

data/lib/zendesk_apps_tools/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ZendeskAppsTools
-  VERSION = '2.0.4'
+  VERSION = '2.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_tools
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -191,15 +191,6 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- app_template/README.md
-- app_template/app.css
-- app_template/app.js
-- app_template/assets/logo-small.png
-- app_template/assets/logo.png
-- app_template/assets/logo.svg
-- app_template/manifest.json.tt
-- app_template/templates/layout.hdbs
-- app_template/translations/en.json
 - app_template_iframe/README.md
 - app_template_iframe/assets/iframe.html
 - app_template_iframe/assets/logo-small.png
@@ -256,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Tools to help you develop Zendesk Apps.

data/app_template/README.md

@@ -1,14 +0,0 @@
-# App name
-
-[brief description of the app]
-
-### The following information is displayed:
-
-* info1
-* info2
-* info3
-
-Please submit bug reports to [Insert Link](). Pull requests are welcome.
-
-### Screenshot(s):
-[put your screenshots down here.]

data/app_template/app.js

@@ -1,12 +0,0 @@
-(function() {
-
-  return {
-    events: {
-      'app.activated':'doSomething'
-    },
-
-    doSomething: function() {
-    }
-  };
-
-}());

data/app_template/assets/logo.svg

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 18 18" style="enable-background:new 0 0 18 18;" xml:space="preserve">
-<path id="Fill-3" d="M1.5,6.1C1.3,5.9,1,6,1,6.4l0,7c0,0.3,0.2,0.7,0.5,0.9l6,3.6C7.8,18.1,8,18,8,17.6l0-7.1c0-0.3-0.2-0.7-0.5-0.9
-	L1.5,6.1z"/>
-<path id="Fill-5" d="M10.5,17.9c-0.3,0.2-0.5,0-0.5-0.3l0-7c0-0.3,0.2-0.7,0.5-0.9l6-3.6C16.8,5.9,17,6,17,6.4l0,7.1
-	c0,0.3-0.2,0.7-0.5,0.9L10.5,17.9z"/>
-<path id="Fill-1" d="M2.2,3.7c-0.3,0.2-0.3,0.4,0,0.6l6.2,3.6C8.7,8,9.2,8,9.4,7.9l6.3-3.6c0.3-0.2,0.3-0.4,0-0.6L9.5,0.1
-	C9.2,0,8.8,0,8.5,0.1L2.2,3.7z"/>
-</svg>

data/app_template/manifest.json.tt

@@ -1,13 +0,0 @@
-{
-  "name": "<%= @app_name %>",
-  "author": {
-    "name": "<%= @author_name %>",
-    "email": "<%= @author_email %>",
-    "url": "<%= @author_url %>"
-  },
-  "defaultLocale": "en",
-  "private": true,
-  "location":  ["ticket_sidebar"],
-  "version": "1.0",
-  "frameworkVersion": "1.0"
-}

data/app_template/templates/layout.hdbs

@@ -1,10 +0,0 @@
-<header>
-  <span class="logo"></span>
-  <h3>{{setting "name"}}</h3>
-</header>
-<section data-main></section>
-<footer>
-  <a href="mailto:{{author.email}}">
-    {{author.name}}
-  </a>
-</footer>

data/app_template/translations/en.json

@@ -1,16 +0,0 @@
-{
-  "app": {
-    "description": "Play the famous zen tunes in your help desk.",
-    "name": "Buddha Machine"
-  },
-  "loading": "Welcome to this Sample App",
-  "fetch": {
-    "done": "Good",
-    "fail": "failed to fetch information from the server"
-  },
-  "id": "ID",
-  "email": "Email",
-  "name": "Name",
-  "role": "Role",
-  "groups": "Groups"
-}