zendesk_apps_tools 2.12.2 → 2.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 81d1d14e680a0767baee661d22e0fe97abecce96
-  data.tar.gz: 5ebc1cc78b823ed7da4c771fcf19ffa63247abbf
+SHA256:
+  metadata.gz: 74674fe4161270694ce0357838a66ffeb431ea51577db11e323a559de1430160
+  data.tar.gz: cf485b548d4ee0d0e46c23b6101466794287fca0a0731e00122c478f30099922
 SHA512:
-  metadata.gz: b993d22b624470ef4b2654fceedd478ccb212150320853624753f82cf528d381c77c8155f45878e3a0f435d3fdd2bbb1ac3f62075f0d86db1fa86a41aa700602
-  data.tar.gz: b8d52c5e0166437aafee5093320cefcf6b50da930e7153dacebb651d27c035c7e8ef87e95ad2fcd527c3ef03d7ecaf5322fed3be9fdab54cb8dd1241fc1c90ac
+  metadata.gz: 9d53fb13befc32158c5bd83f68a152c044f96a4f8557f2b5bbe524f213f71bb16a756bb8e0145eb8f085f0ddc9afc764d83d49b79c60bf64bf8983002acf25c8
+  data.tar.gz: 76a32b9a948d65a74143514178037c1fb2650bd0d0a64c07387e702e9c38249276c3cbc8616a79f1494cc68ba8bdd8b04e16ae0129275a01622d564ffb75153d

data/README.md

@@ -13,7 +13,7 @@ To install, run `gem install zendesk_apps_tools`.
 
 To get the latest version, run `gem update zendesk_apps_tools`.
 
-For information on using the tools, see  [Zendesk App Tools](https://developer.zendesk.com/apps/docs/apps-v2/getting_started#zendesk-app-tools) on developer.zendesk.com.
+For information on using the tools, see  [Zendesk App Tools](https://developer.zendesk.com/apps/docs/developer-guide/zat) on developer.zendesk.com.
 
 ## Work on ZAT
 If you want to help **develop** this tool, clone this repo and run `bundle install`.

data/lib/zendesk_apps_tools/api_connection.rb

@@ -10,7 +10,7 @@ module ZendeskAppsTools
     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 full URL, follow the example format 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')
 
@@ -22,14 +22,13 @@ module ZendeskAppsTools
       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
     end
 
     def get_connection(encoding = :url_encoded)
       require 'net/http'
       require 'faraday'
-      prepare_api_auth
+      prepare_api_auth unless @subdomain && @username && @password
+
       Faraday.new full_url do |f|
         f.request encoding if encoding
         f.adapter :net_http

data/lib/zendesk_apps_tools/command.rb

@@ -208,10 +208,11 @@ module ZendeskAppsTools
       setup_path(options[:path])
       @command = 'Update'
 
-      app_id = cache.fetch('app_id') || find_app_id
+      product_name = product_names(manifest).first
+      app_id = cache.fetch('app_id') || find_app_id(product_name)
       app_url = "/api/v2/apps/#{app_id}.json"
       unless /\d+/ =~ app_id.to_s && app_exists?(app_id)
-        say_error_and_exit "App id not found\nPlease try running command with --clean or check your internet connection"
+        say_error_and_exit "App ID not found. Please try running command with --clean or check your internet connection."
       end
 
       deploy_app(:put, app_url, {})

data/lib/zendesk_apps_tools/common.rb

@@ -69,7 +69,7 @@ module ZendeskAppsTools
       require 'json'
       JSON.parse(value)
     rescue JSON::ParserError
-      say_error_and_exit "\"#{value}\" is an invalid JSON"
+      say_error_and_exit "\"#{value}\" is an invalid JSON."
     end
 
     private
@@ -77,7 +77,7 @@ module ZendeskAppsTools
     def error_or_default_if_unattended(prompt, opts = {})
       if options[:unattended]
         return opts[:default] if opts.key? :default
-        say_error 'Would have prompted for a value interactively, but zat is not listening to keyboard input.'
+        say_error 'Would have prompted for a value interactively, but ZAT is not listening to keyboard input.'
         say_error_and_exit prompt
       else
         yield

data/lib/zendesk_apps_tools/deploy.rb

@@ -6,13 +6,12 @@ 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
 
-      response = connection.send(connection_method) do |req|
+      response = cached_connection.send(connection_method) do |req|
         req.url url
         req.headers[:content_type] = 'application/json'
         req.body = JSON.generate body
@@ -26,7 +25,7 @@ module ZendeskAppsTools
 
     def app_exists?(app_id)
       url = "/api/v2/apps/#{app_id}.json"
-      response = connection.send(:get) do |req|
+      response = cached_connection.send(:get) do |req|
         req.url url
       end
 
@@ -34,7 +33,7 @@ module ZendeskAppsTools
     end
 
     def install_app(poll_job, product_name, installation)
-      response = connection.post do |req|
+      response = cached_connection.post do |req|
         req.url "api/#{product_name}/apps/installations.json"
         req.headers[:content_type] = 'application/json'
         req.body = JSON.generate(installation)
@@ -56,33 +55,35 @@ module ZendeskAppsTools
         uploaded_data: Faraday::UploadIO.new(package_path, 'application/zip')
       }
 
-      response = connection(:multipart).post('/api/v2/apps/uploads.json', payload)
+      response = cached_connection(:multipart).post('/api/v2/apps/uploads.json', payload)
       json_or_die(response.body)['id']
 
     rescue Faraday::Error::ClientError => e
       say_error_and_exit e.message
     end
 
-    def find_app_id
+    def find_app_id(product_name = 'v2') # use the v2 endpoint if no product name is provided
       say_status 'Update', 'app ID is missing, searching...'
-      app_name = get_value_from_stdin('Enter the name of the app:')
+      app_name = get_value_from_stdin('Enter the name of the installed app:')
 
-      all_apps_json = connection.get('/api/apps.json').body
+      response = cached_connection.get("/api/#{product_name}/apps/installations.json")
+      installations_json = json_or_die(response.body)
 
-      app =
-        unless all_apps_json.empty?
-          json_or_die(all_apps_json)['apps'].find { |app| app['name'] == app_name }
-        end
+      unless response.success? && installations_json.has_key?('installations')
+        say_error_and_exit "Unable to retrieve installations. Please check your credentials and internet connection."
+      else
+        installation = installations_json['installations'].find {
+          |i| i['settings'] && i['settings']['name'] == app_name
+        }
+      end
 
-      unless app
-        say_error_and_exit(
-          "App not found. " \
-          "Please verify that your credentials, subdomain, and app name are correct."
-        )
+      unless installation
+        say_error_and_exit "App not found. Please check that your app name is correct."
       end
 
-      cache.save 'app_id' => app['id']
-      app['id']
+      app_id = installation['app_id']
+      cache.save 'app_id' => app_id
+      app_id
 
     rescue Faraday::Error::ClientError => e
       say_error_and_exit e.message
@@ -100,21 +101,18 @@ module ZendeskAppsTools
     end
 
     def check_job(job_id)
-      http_client = connection
-
       loop do
-        response = http_client.get("/api/v2/apps/job_statuses/#{job_id}")
-        info     = json_or_die(response.body)
-        status   = info['status']
+        request  = cached_connection.get("/api/v2/apps/job_statuses/#{job_id}")
+        response = json_or_die(request.body)
+        status   = response['status']
 
         if %w(completed failed).include? status
           case status
           when 'completed'
-            app_id = info['app_id']
-            cache.save 'app_id' => app_id if app_id
+            cache.save zat_contents(response)
             say_status @command, 'OK'
           when 'failed'
-            say_status @command, info['message'], :red
+            say_status @command, response['message'], :red
             exit 1
           end
           break
@@ -126,5 +124,21 @@ module ZendeskAppsTools
     rescue Faraday::Error::ClientError => e
       say_error_and_exit e.message
     end
+
+    private
+
+    def zat_contents(response)
+      zat = {}
+      zat['subdomain'] = @subdomain
+      zat['username'] = @username
+      zat['app_id'] = response['app_id'] if response['app_id']
+
+      zat
+    end
+
+    def cached_connection(encoding = :url_encoded)
+      @connection ||= {}
+      @connection[encoding] ||= get_connection(encoding)
+    end
   end
 end

data/lib/zendesk_apps_tools/theme.rb

@@ -60,7 +60,7 @@ module ZendeskAppsTools
             say_status 'Error', error_hash
           end
         rescue JSON::ParserError
-          say_error_and_exit 'Server error 😭'
+          say_error_and_exit 'Server error.'
         end
       end
 

data/lib/zendesk_apps_tools/theming/common.rb

@@ -34,7 +34,7 @@ module ZendeskAppsTools
         full_manifest_path = theme_package_path('manifest.json')
         JSON.parse(File.read(full_manifest_path))
       rescue Errno::ENOENT
-        say_error_and_exit "There's no manifest file in #{full_manifest_path}"
+        say_error_and_exit "There is no manifest file in #{full_manifest_path}"
       rescue JSON::ParserError
         say_error_and_exit "The manifest file is invalid at #{full_manifest_path}"
       end

data/lib/zendesk_apps_tools/translate.rb

@@ -176,9 +176,9 @@ module ZendeskAppsTools
 
         return json_or_die(locale_response.body)['locales'] if locale_response.status == 200
         if locale_response.status == 401
-          say_error_and_exit 'Authentication failed'
+          say_error_and_exit 'Authentication failed.'
         else
-          say_error_and_exit "Failed to download locales, got HTTP status #{locale_response.status}"
+          say_error_and_exit "Failed to download locales, got HTTP status #{locale_response.status}."
         end
       end
 
@@ -228,13 +228,13 @@ module ZendeskAppsTools
       def package_name_from_json(error_out: false)
         package = en_json && en_json['app']['package']
         return package if package
-        say_error_and_exit 'No package defined inside en.json!' if error_out
+        say_error_and_exit 'No package defined inside en.json.' if error_out
       end
 
       def package_name(error_out: false)
         package = en_hash && en_hash['app']['package']
         return package if package
-        say_error_and_exit 'No package defined inside en.yml!' if error_out
+        say_error_and_exit 'No package defined inside en.yml.' if error_out
       end
     end
   end

data/lib/zendesk_apps_tools/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_tools
 version: !ruby/object:Gem::Version
-  version: 2.12.2
+  version: 2.12.3
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-13 00:00:00.000000000 Z
+date: 2019-01-08 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.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Tools to help you develop Zendesk Apps.
 test_files:
-- features/clean.feature
 - features/create.feature
-- features/fixtures/quote_character_translation.json
+- features/validate.feature
 - features/new.feature
-- features/package.feature
-- features/step_definitions/app_steps.rb
-- features/support/env.rb
+- features/clean.feature
 - features/support/helpers.rb
 - features/support/webmock.rb
-- features/validate.feature
+- features/support/env.rb
+- features/step_definitions/app_steps.rb
+- features/fixtures/quote_character_translation.json
+- features/package.feature