RubyGems - zendesk_apps_tools - Versions diffs - 1.31.1 → 1.32.0 - Mend

zendesk_apps_tools 1.31.1 → 1.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

checksums.yaml +4 -4
data/README.md +17 -13
data/app_template_iframe/assets/iframe.html +6 -9
data/features/new.feature +2 -2
data/lib/zendesk_apps_tools/command.rb +1 -1
data/lib/zendesk_apps_tools/server.rb +14 -1
metadata +4 -3

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71a5badd2d115faf91cdb7f5698724e26e0d93a8
-  data.tar.gz: faf59ab9b57fc4ad4fa7e2ae46ea6ebdedfb669e
+  metadata.gz: 905f51cc9ffcf70b1a6df1de22eb0023786238a5
+  data.tar.gz: 3fee92c2981350c12f52bce5a3dd4eb938088529
 SHA512:
-  metadata.gz: a7d0912dc5875a9691968200a9967d32337d803c868ee77a416626280fd87d11d556f5bfb60a21663f9b0b609d8217709552d9d0ea4a8cf660ea340b974e920a
-  data.tar.gz: d2889508aa558a7effb92a62d2f633a9e6c6a7c5b64e82b35ae103273fecb56945d89803f16043c6590f32bbafc90e4d212c21bf296a2e918bcf9e22a0d75d0e
+  metadata.gz: cc6043a99f828a98dc300e630fee32e81c3aff6429d1069cc1b389f18fba83f099e06d844f03216e579e7401ad9bc1c6431aa843479ac9a33e8e849f232e6ec9
+  data.tar.gz: fed72c3e4d2eb82de52930b11523c6bbf50e87d305922cb874e4ec7259f5823046666ce7a0740db6841644f80a1fd774e6bc8a3f7c43eee87762f941c54b7d72

data/README.md CHANGED

@@ -1,26 +1,30 @@
 # Zendesk Apps Tools
-These tools make it easy to develop [Zendesk Apps](http://developer.zendesk.com/documentation/apps/).
+## 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.
-# How to use
+## 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!
-Please refer to [our guide](http://developer.zendesk.com/documentation/apps/reference/tools.html).
+## 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.
-# Features
+## 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.
-Please refer to [our guide](http://developer.zendesk.com/documentation/apps/reference/tools.html).
+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.
-# Supported Ruby Versions
+## Testing
+This project uses rspec, which can be run with `bundle exec rake`.
-Tested with Ruby 2+
+## Contribute
+Improvements are always welcome. To contribute, please:
-# Contribution
+* Put up a PR into the master branch.
+* CC and get two +1 from @zendesk/vegemite.
-Improvements are always welcome. To contribute, please submit detailed Pull Requests.
-# Issues
-Please <a href="https://support.zendesk.com/requests/new">submit bug reports to Zendesk</a>.
+## 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

data/app_template_iframe/assets/iframe.html CHANGED

@@ -1,16 +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/latest/zaf_sdk.js"></script>
+  <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/iframes_in_apps
-    var app = window.ZAFClient.init(function(context) {
-      var currentUser = context.currentUser;
-      console.log('Hi ' + currentUser.name);
-    });
-    app.postMessage('helloApp', { works: true });
+    // 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>
-  <p>It works!</p>
 </body>
 </html>

data/features/new.feature CHANGED

@@ -86,10 +86,10 @@ Feature: create a template for a new zendesk app
  }
  """
- Scenario: create a template for a new iframe only app by running 'zat new --iframe-only' command
+ Scenario: create a template for a new iframe only app by running 'zat new --v2' command
    Given an app directory "tmp/aruba" exists
    And I move to the app directory
-   When I run "zat new --iframe-only" command with the following details:
+   When I run "zat new --v2" command with the following details:
      | author name  | John Citizen      |
      | author email | john@example.com  |
      | author url   | http://myapp.com  |

data/lib/zendesk_apps_tools/command.rb CHANGED

@@ -32,7 +32,7 @@ module ZendeskAppsTools
     method_option :'iframe-only', type: :boolean,
                                   default: false,
                                   desc: 'Create an iFrame Only app template',
-                                  aliases: '-i'
+                                  aliases: ['-i', '--v2']
     def new
       enter = ->(variable) { "Enter this app author's #{variable}:\n" }
       invalid = ->(variable) { "Invalid #{variable}, try again:" }

data/lib/zendesk_apps_tools/server.rb CHANGED

@@ -4,7 +4,6 @@ require 'zendesk_apps_support/package'
 module ZendeskAppsTools
   class Server < Sinatra::Base
     set :protection, :except => :frame_options
-    set :public_folder, proc { "#{settings.root}/assets" }
     last_mtime = Time.new(0)
     ZENDESK_DOMAINS_REGEX = /^http(?:s)?:\/\/[a-z0-9-]+\.(?:zendesk|zopim|zd-(?:dev|master|staging))\.com$/
@@ -44,6 +43,20 @@ module ZendeskAppsTools
       ZendeskAppsSupport::Installed.new([app_js], [installation]).compile_js
     end
+    get "/:file" do |file|
+      access_control_allow_origin
+      send_file File.join(settings.root, 'assets', file)
+    end
+    # This is for any preflight request
+    # It reads 'Access-Control-Request-Headers' to set 'Access-Control-Allow-Headers'
+    # And also sets 'Access-Control-Allow-Origin' header
+    options "*" do
+      access_control_allow_origin
+      headers 'Access-Control-Allow-Headers' => request.env['HTTP_ACCESS_CONTROL_REQUEST_HEADERS'] if request.env['HTTP_ORIGIN'] =~ ZENDESK_DOMAINS_REGEX
+    end
+    # This sets the 'Access-Control-Allow-Origin' header for requests coming from zendesk
     def access_control_allow_origin
       origin = request.env['HTTP_ORIGIN']
       headers 'Access-Control-Allow-Origin' => origin if origin =~ ZENDESK_DOMAINS_REGEX

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_tools
 version: !ruby/object:Gem::Version
-  version: 1.31.1
+  version: 1.32.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -226,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.4
+rubygems_version: 2.4.5.1
 signing_key:
 specification_version: 4
 summary: Tools to help you develop Zendesk Apps.
@@ -238,3 +238,4 @@ test_files:
 - features/step_definitions/app_steps.rb
 - features/support/env.rb
 - features/validate.feature
+has_rdoc: