zendesk_apps_tools 2.12.0 → 2.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 96bae990144484c85c9a51b4008e1aed20c55cf45fc912ddb32321a297e548e8
-  data.tar.gz: f5c245e354a317b97b93de231dbfed59a1bd9f91d49ecb2933a7d85d99983144
+SHA1:
+  metadata.gz: 1ee308e4dfdc555c1b6c864fa7516d08cafe7f0f
+  data.tar.gz: 8fc3c41e0d56a395891f402b478944436ff9c806
 SHA512:
-  metadata.gz: 2081cc4b5c7754b20d3cb3b644c133656c9ef6cf9014a705c01449ed1e7200e1dbebfe3b3a4fb2f62dd83460531526db3440586db304dd0858a1d01583fdf20b
-  data.tar.gz: 5031f40fb8f8b667fb2593f9b2b9cd6e781eeea414e7a6bcbb8750e09dd08164d01bae4d70b2661475ecbfcf500734531079a6856392c13e2d0d95c47b4e3722
+  metadata.gz: adb8c79e5bd5a625e9914c9bff76ed0a0cf37a209662e76aef57f9a445568890b90ee9847ee197587cfc328ed7c350dc3b70f5f58687fe065ed0862b1e28ed65
+  data.tar.gz: 60b4dba4543aef673189ced75f7b643047e4e1c87973fe576ffbfca09d591765c98f196872229c700d009a3670457ba3f6bec60913e1004bf40d8c72213ea952

data/README.md

@@ -18,10 +18,16 @@ For information on using the tools, see  [Zendesk App Tools](https://developer.z
 ## Work on ZAT
 If you want to help **develop** this tool, clone this repo and run `bundle install`.
 
-ZAT uses a gem called [ZAS](https://github.com/zendesk/zendesk_apps_support/). If you're developing ZAT, you'll probably want to edit code in ZAS too. To do so, you need to clone the ZAS repo and change the `Gemfile` in the ZAT project to say:
+ZAT uses a gem called [ZAS](https://github.com/zendesk/zendesk_apps_support/). If you're developing ZAT, you'll probably want to edit code in ZAS too. To do so, you need to clone the ZAS repo and add the following line at the end of `Gemfile` in the ZAT project:
 
 `gem 'zendesk_apps_support', path: '../zendesk_apps_support'`
 
+Then, comment-out the line referring to `zendesk_apps_support` in this project's `.gemspec` file.
+
+```
+# s.add_runtime_dependency 'zendesk_apps_support', '~> X.YY.ZZ'
+```
+
 The path should point to your local ZAS directory. In 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

data/lib/zendesk_apps_tools/api_connection.rb

@@ -1,11 +1,26 @@
 module ZendeskAppsTools
   module APIConnection
-    FULL_URL     = /https?:\/\//
-    URL_TEMPLATE = 'https://%s.zendesk.com/'
+    DEFAULT_URL_TEMPLATE = 'https://%s.zendesk.com/'
+    # taken from zendesk/lib/vars.rb
+    SUBDOMAIN_VALIDATION_PATTERN = /^[a-z0-9][a-z0-9\-]{1,}[a-z0-9]$/i
+    ZENDESK_URL_VALIDATION_PATTERN = /^(https?):\/\/[a-z0-9]+(([\.]|[\-]{1,2})[a-z0-9]+)*\.([a-z]{2,16}|[0-9]{1,3})((:[0-9]{1,5})?(\/?|\/.*))?$/ix
+    EMAIL_REGEX  = /^([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})$/i
+
+    EMAIL_ERROR_MSG = 'Please enter a valid email address.'
+    PROMPT_FOR_URL  = 'Enter your Zendesk subdomain or full URL (including protocol):'
+    URL_ERROR_MSG   = [
+      'URL error. Example URL: https://mysubdomain.zendesk.com',
+      'If you are using a full URL, follow the url as shown above.',
+      'If you are using a subdomain, ensure that it contains only valid characters (a-z, A-Z, 0-9, and hyphens).'
+    ].join('\n')
 
     def prepare_api_auth
-      @subdomain ||= cache.fetch('subdomain') || get_value_from_stdin('Enter your Zendesk subdomain or full Zendesk URL:')
+      @subdomain ||= cache.fetch('subdomain') || get_value_from_stdin(PROMPT_FOR_URL)
+      say_error_and_exit URL_ERROR_MSG unless valid_subdomain? || valid_full_url?
+
       @username  ||= cache.fetch('username', @subdomain) || get_value_from_stdin('Enter your username:')
+      say_error_and_exit EMAIL_ERROR_MSG unless valid_email?
+
       @password  ||= cache.fetch('password', @subdomain) || get_password_from_stdin('Enter your password:')
 
       cache.save 'subdomain' => @subdomain, 'username' => @username
@@ -25,11 +40,19 @@ module ZendeskAppsTools
     private
 
     def full_url
-      if FULL_URL =~ @subdomain
-        @subdomain
-      else
-        URL_TEMPLATE % @subdomain
-      end
+      valid_full_url? ? @subdomain : (DEFAULT_URL_TEMPLATE % @subdomain)
+    end
+
+    def valid_full_url?
+      !!ZENDESK_URL_VALIDATION_PATTERN.match(@subdomain)
+    end
+
+    def valid_subdomain?
+      !!SUBDOMAIN_VALIDATION_PATTERN.match(@subdomain)
+    end
+
+    def valid_email?
+      !!EMAIL_REGEX.match(@username)
     end
   end
 end

data/lib/zendesk_apps_tools/deploy.rb

@@ -1,9 +1,16 @@
+require 'faraday'
+require 'zendesk_apps_tools/common'
+require 'zendesk_apps_tools/api_connection'
+
 module ZendeskAppsTools
   module Deploy
+    include ZendeskAppsTools::Common
+    include ZendeskAppsTools::APIConnection
+    alias_method :connection, :get_connection
+
     def deploy_app(connection_method, url, body)
       body[:upload_id] = upload(options[:path]).to_s
       sleep 2 # Because the DB needs time to replicate
-      connection = get_connection
 
       response = connection.send(connection_method) do |req|
         req.url url
@@ -19,7 +26,6 @@ module ZendeskAppsTools
 
     def app_exists?(app_id)
       url = "/api/v2/apps/#{app_id}.json"
-      connection = get_connection
       response = connection.send(:get) do |req|
         req.url url
       end
@@ -28,7 +34,6 @@ module ZendeskAppsTools
     end
 
     def install_app(poll_job, product_name, installation)
-      connection = get_connection
       response = connection.post do |req|
         req.url "api/#{product_name}/apps/installations.json"
         req.headers[:content_type] = 'application/json'
@@ -38,7 +43,6 @@ module ZendeskAppsTools
     end
 
     def upload(path)
-      connection = get_connection :multipart
       zipfile_path = options[:zipfile]
 
       if zipfile_path
@@ -48,9 +52,11 @@ module ZendeskAppsTools
         package_path = Dir[File.join path, '/tmp/*.zip'].sort.last
       end
 
-      payload = { uploaded_data: Faraday::UploadIO.new(package_path, 'application/zip') }
+      payload = {
+        uploaded_data: Faraday::UploadIO.new(package_path, 'application/zip')
+      }
 
-      response = connection.post('/api/v2/apps/uploads.json', payload)
+      response = connection(:multipart).post('/api/v2/apps/uploads.json', payload)
       json_or_die(response.body)['id']
 
     rescue Faraday::Error::ClientError => e
@@ -59,25 +65,32 @@ module ZendeskAppsTools
 
     def find_app_id
       say_status 'Update', 'app ID is missing, searching...'
-      name = get_value_from_stdin('Enter the name of the app:')
+      app_name = get_value_from_stdin('Enter the name of the app:')
+
+      all_apps_json = connection.get('/api/apps.json').body
 
-      connection = get_connection
+      app =
+        unless all_apps_json.empty?
+          json_or_die(all_apps_json)['apps'].find { |app| app['name'] == app_name }
+        end
 
-      all_apps = connection.get('/api/apps.json').body
+      unless app
+        say_error_and_exit(
+          "App not found. " \
+          "Please verify that your credentials, subdomain, and app name are correct."
+        )
+      end
 
-      app_json = all_apps.empty? ? nil : json_or_die(all_apps)['apps'].find { |app| app['name'] == name }
-      say_error_and_exit('The app was not found. Please verify your credentials, subdomain, and app name are correct.') unless app_json
-      app_id = app_json['id']
+      cache.save 'app_id' => app['id']
+      app['id']
 
-      cache.save 'app_id' => app_id
-      app_id
     rescue Faraday::Error::ClientError => e
       say_error_and_exit e.message
     end
 
     def check_status(response, poll_job = true)
-      job = response.body
-      job_response = json_or_die(job)
+      job_response = json_or_die(response.body)
+
       say_error_and_exit job_response['error'] if job_response['error']
 
       if poll_job
@@ -87,22 +100,21 @@ module ZendeskAppsTools
     end
 
     def check_job(job_id)
-      connection = get_connection
+      http_client = connection
 
       loop do
-        response = connection.get("/api/v2/apps/job_statuses/#{job_id}")
+        response = http_client.get("/api/v2/apps/job_statuses/#{job_id}")
         info     = json_or_die(response.body)
         status   = info['status']
-        message  = info['message']
-        app_id   = info['app_id']
 
         if %w(completed failed).include? status
           case status
           when 'completed'
+            app_id = info['app_id']
             cache.save 'app_id' => app_id if app_id
             say_status @command, 'OK'
           when 'failed'
-            say_status @command, message, :red
+            say_status @command, info['message'], :red
             exit 1
           end
           break

data/lib/zendesk_apps_tools/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_tools
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.12.1
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-30 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -321,18 +321,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Tools to help you develop Zendesk Apps.
 test_files:
+- features/clean.feature
 - features/create.feature
-- features/validate.feature
+- features/fixtures/quote_character_translation.json
 - features/new.feature
-- features/clean.feature
+- features/package.feature
+- features/step_definitions/app_steps.rb
+- features/support/env.rb
 - features/support/helpers.rb
 - features/support/webmock.rb
-- features/support/env.rb
-- features/step_definitions/app_steps.rb
-- features/fixtures/quote_character_translation.json
-- features/package.feature
+- features/validate.feature