xat 1.32.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 899c2fa1a60bb8969f568f82bb1b9826ce0c979d
+  data.tar.gz: 0a0b600ae881e98a8f6f9d89931e38edfd10e3ba
+SHA512:
+  metadata.gz: 4982753829a0b0189d1329fbcd348eddb27b39ae80b81bafc2bb59ed052da6863ab56dbc7c962602e9ff2e34cb8a9e6348001428e631247109a74faf0245730d
+  data.tar.gz: 6343f1fb11c0ba1510f2ac59cb4b8296ecdac2d466b8de2fb418c0fc5d3e377fca62c282cb590b30c935f5d24424a9d2d865ba58480462f528a873f9ea9a69a8

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,38 @@
+# Zendesk Apps Tools
+
+## Description
+Zendesk Apps Tools (ZAT) is the only tool needed for developing Zendesk Apps. It makes it easy to develop [Zendesk Apps](http://developer.zendesk.com/documentation/apps/). We have a [guide](http://developer.zendesk.com/documentation/apps/reference/tools.html) that explains how to use this tool.
+
+## Owners
+This repo is owned and maintained by the Zendesk Apps team. You can reach us on vegemite@zendesk.com. We are located in Melbourne!
+
+## Getting Started To **Use** ZAT
+If you want to **use** this tool, all you need to do is `gem install zendesk_apps_tools` and periodically run `gem update zendesk_apps_tools` because we will keep updating this tool.
+
+## Getting Started To **Develop** ZAT
+When you want to help **develop** this tool, you will need to clone this repo and run `bundle install` to get it going.
+
+ZAT uses a gem called [ZAS](https://github.com/zendesk/zendesk_apps_support/). In the case you are developing ZAT, it is likely you want to edit code in ZAS too, which means you will need to clone the ZAS repo and change the `Gemfile` (in the ZAT project) to say `gem 'zendesk_apps_support', path: '../zendesk_apps_support'`. The path should point to your local ZAS directory. This way your clone of ZAT will use a local version of ZAS which is very helpful for development. Run a `bundle install` after changing the Gemfile.
+
+## Testing
+This project uses rspec, which can be run with `bundle exec rake`.
+
+## Contribute
+Improvements are always welcome. To contribute, please:
+
+* Put up a PR into the master branch.
+* CC and get two +1 from @zendesk/vegemite.
+
+## Bugs
+Bugs can be reported as an issue here on github, or submitted to support@zendesk.com. By mentioning this project it will assigned to the right team.
+
+# Copyright and license
+Copyright 2013 Zendesk
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and limitations under the License.

data/app_template/README.md

@@ -0,0 +1,14 @@
+# 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

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

data/app_template/manifest.json.tt

@@ -0,0 +1,13 @@
+{
+  "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

@@ -0,0 +1,10 @@
+<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

@@ -0,0 +1,16 @@
+{
+  "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"
+}

data/app_template_iframe/README.md

@@ -0,0 +1,14 @@
+# 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_iframe/assets/iframe.html

@@ -0,0 +1,13 @@
+<html>
+<body>
+  <h2>Zendesk Apps Tools Iframe Scaffold</h2>
+  <!-- https://github.com/zendesk/zendesk_app_framework_sdk -->
+  <script type="text/javascript" src="http://assets.zendesk.com/apps/sdk/2.0.0-beta1/zaf_sdk.js"></script>
+  <script>
+    // Initialise the Zendesk JavaScript API client
+    // https://developer.zendesk.com/apps/docs/agent/zaf_v2
+    var client = ZAFClient.init();
+    client.invoke('resize', { width: '100%', height: '400px' });
+  </script>
+</body>
+</html>

data/app_template_iframe/manifest.json.tt

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

data/app_template_iframe/translations/en.json

@@ -0,0 +1,16 @@
+{
+  "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"
+}

data/bin/xat

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+lib_dir = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+require 'xat'
+ZendeskAppsTools::Command.start

data/features/clean.feature

@@ -0,0 +1,9 @@
+Feature: clean tmp folder inside the zendesk app
+
+  Background: create a new zendesk app package
+    Given an app is created in directory "tmp/aruba"
+    And I run the command "xat package --path tmp/aruba" to package the app
+
+  Scenario: clean tmp folder
+    When I run the command "xat clean --path tmp/aruba" to clean the app
+    Then the zip file in "tmp/aruba/tmp" folder should not exist

data/features/fixtures/quote_character_translation.json

@@ -0,0 +1,6 @@
+{
+  "app": {
+    "description":  "Play the famous zen tunes in your help desk.",
+    "name":         "Buddha \"Machine\""
+  }
+}

data/features/new.feature

@@ -0,0 +1,117 @@
+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 "xat new" 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      |                   |
+
+   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 'xat new' command
+     Given an app directory "tmp/aruba" exists
+     When I run "xat new" 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 'xat new --v2' command
+   Given an app directory "tmp/aruba" exists
+   And I move to the app directory
+   When I run "xat new --v2" command with the following details:
+     | author name  | John Citizen      |
+     | author email | john@example.com  |
+     | author url   | http://myapp.com  |
+     | app name     | John Test App     |
+     | iframe uri   | assets/index.html |
+     | 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": { "zendesk":
+   { "ticket_sidebar": "assets/index.html" }
+ },
+ "version": "1.0",
+ "frameworkVersion": "1.0"
+}
+"""