zendesk_apps_tools 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd3a1e249d27b455dc9b32604783ea161468ca26
-  data.tar.gz: 6f85e644712b7eefcf16b2c01d0823454ea7109b
+  metadata.gz: a1ee115dae07f1e761072c56bd6031e32e90b67d
+  data.tar.gz: 34da3b3f22b42e3da9b9d570b0c8db87e80dcbce
 SHA512:
-  metadata.gz: 71666498cc72bead4b0afa3b443f4ccf4c0399947f07b4bc11d942fbe0d7d42aa51970d7eda8e2b1bd71c58cbf897e350ca10506e62929d0cba4955cf4b06d8e
-  data.tar.gz: 25b87b26c4f45ca74fb79f7c561ac040aabc706eabec59d5e241884ae0011dfa51f44abdf30efc0162d20dff96d8972782519cf30ea96a5c5cd1f30215a12c1d
+  metadata.gz: 62046dd8e89eb2f80f598dfef722a9cebfaa3eface9ccf0955cebd946fab3c7737dba5246a9093de55ebaa80b5d6d604114fcfd0ac8fabe17523bea9adcae153
+  data.tar.gz: 8c158f7f1ab9c747d1075b2b866d12f71b43e75b1885e871e45bf0a9a964d5a585e60993b433b86a7bd5232deca3157bb9702cf26cce98488858ef7b24b49b95

data/lib/zendesk_apps_tools/api_connection.rb

@@ -0,0 +1,36 @@
+module ZendeskAppsTools
+  module APIConnection
+    FULL_URL     = /https?:\/\//
+    URL_TEMPLATE = 'https://%s.zendesk.com/'
+
+    def prepare_api_auth
+      @subdomain ||= get_cache('subdomain') || get_value_from_stdin('Enter your Zendesk subdomain or full Zendesk URL:')
+      @username  ||= get_cache('username') || get_value_from_stdin('Enter your username:')
+
+      unless @password
+        print 'Enter your password: '
+        @password ||= STDIN.noecho(&:gets).chomp
+        puts
+
+        set_cache 'subdomain' => @subdomain, 'username' => @username
+      end
+    end
+
+    def get_full_url
+      if FULL_URL =~ @subdomain
+        @subdomain
+      else
+        URL_TEMPLATE % @subdomain
+      end
+    end
+
+    def get_connection(encoding = :url_encoded)
+      prepare_api_auth
+      Faraday.new get_full_url do |f|
+        f.request encoding
+        f.adapter :net_http
+        f.basic_auth @username, @password
+      end
+    end
+  end
+end

data/lib/zendesk_apps_tools/cache.rb

@@ -0,0 +1,25 @@
+module ZendeskAppsTools
+  module Cache
+    CACHE_FILE_NAME = '.zat'
+
+    def set_cache(hash)
+      return if options[:zipfile]
+
+      @cache = File.exists?(cache_path) ? JSON.parse(File.read(@cache_path)).update(hash) : hash
+      File.open(@cache_path, 'w') { |f| f.write JSON.pretty_generate(@cache) }
+    end
+
+    def get_cache(key)
+      @cache ||= File.exists?(cache_path) ? JSON.parse(File.read(@cache_path)) : {}
+      @cache[key] if @cache
+    end
+
+    def clear_cache
+      File.delete cache_path if options[:clean] && File.exists?(cache_path)
+    end
+
+    def cache_path
+      @cache_path ||= File.join options[:path], CACHE_FILE_NAME
+    end
+  end
+end

data/lib/zendesk_apps_tools/command.rb

@@ -3,20 +3,25 @@ require 'zip/zip'
 require 'pathname'
 require 'net/http'
 require 'json'
-require 'zendesk_apps_tools/translate'
-require 'zendesk_apps_tools/common'
-require 'zendesk_apps_tools/settings'
+require 'faraday'
+require 'io/console'
+
+require 'zendesk_apps_tools/command_helpers'
 
 module ZendeskAppsTools
+
   require 'zendesk_apps_support'
 
   class Command < Thor
 
-    DEFAULT_ZENDESK_URL = "http://support.zendesk.com"
+    SHARED_OPTIONS      = {
+      :path =>  './',
+      :clean => false
+    }
 
     include Thor::Actions
     include ZendeskAppsSupport
-    include ZendeskAppsTools::Common
+    include ZendeskAppsTools::CommandHelpers
 
     source_root File.expand_path(File.join(File.dirname(__FILE__), "../.."))
 
@@ -29,35 +34,15 @@ module ZendeskAppsTools
       @author_email = get_value_from_stdin("Enter this app author's email:\n", :valid_regex => /^.+@.+\..+$/, :error_msg => "Invalid email, try again:")
       @app_name = get_value_from_stdin("Enter a name for this new app:\n", :error_msg => "Invalid app name, try again:")
 
-      prompt = "Enter a directory name to save the new app (will create the dir if it does not exist, default to current dir):\n"
-      opts = { :valid_regex => /^(\w|\/|\\)*$/, :allow_empty => true }
-      while @app_dir = get_value_from_stdin(prompt, opts) do
-        @app_dir = './' and break if @app_dir.empty?
-        if !File.exists?(@app_dir)
-          break
-        elsif !File.directory?(@app_dir)
-          puts "Invalid dir, try again:"
-        else
-          break
-        end
-      end
+      get_new_app_directory
 
       directory('app_template', @app_dir)
     end
 
     desc "validate", "Validate your app"
-    method_option :path, :default => './', :required => false
+    method_options SHARED_OPTIONS
     def validate
-      prompt = "Enter a zendesk URL that you'd like to install the app (for example: 'http://abc.zendesk.com', default to '#{DEFAULT_ZENDESK_URL}'):\n"
-      zendesk = get_value_from_stdin(prompt, :valid_regex => /^http:\/\/\w+\.\w+|^$/, :error_msg => 'Invalid url, try again:')
-      zendesk = DEFAULT_ZENDESK_URL if zendesk.empty?
-      url = URI.parse(zendesk)
-      response = Net::HTTP.start(url.host, url.port) { |http| http.get('/api/v2/apps/framework_versions.json') }
-      version = JSON.parse(response.body, :symbolize_names => true)
-      if ZendeskAppsSupport::AppVersion::CURRENT != version[:current]
-        puts 'This tool is using an out of date Zendesk App Framework. Please upgrade!'
-        exit 1
-      end
+      test_framework_version
 
       setup_path(options[:path])
       errors = app_package.validate
@@ -78,27 +63,16 @@ module ZendeskAppsTools
     end
 
     desc "package", "Package your app"
-    method_option :path, :default => './', :required => false
+    method_options SHARED_OPTIONS
     def package
+      return false unless invoke(:validate, [])
+
       setup_path(options[:path])
       archive_path = File.join(tmp_dir, "app-#{Time.now.strftime('%Y%m%d%H%M%S')}.zip")
 
-      return false unless invoke(:validate, [])
-
       archive_rel_path = relative_to_original_destination_root(archive_path)
 
-      Zip::ZipFile.open(archive_path, 'w') do |zipfile|
-        app_package.files.each do |file|
-          path = file.relative_path
-          say_status "package", "adding #{path}"
-
-          # resolve symlink to source path
-          if File.symlink? file.absolute_path
-            path = File.readlink(file.absolute_path)
-          end
-          zipfile.add(file.relative_path, app_dir.join(path).to_s)
-        end
-      end
+      zip archive_path
 
       say_status "package", "created at #{archive_rel_path}"
       true
@@ -136,26 +110,40 @@ module ZendeskAppsTools
       end
     end
 
-    protected
+    desc "create", "Create app on your account"
+    method_options SHARED_OPTIONS
+    method_option :zipfile, :default => nil, :required => false, :type => :string
+    def create
+      clear_cache
+      @command = 'Create'
 
-    def setup_path(path)
-      @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
+      if options[:zipfile]
+        app_name = get_value_from_stdin('Enter app name:')
+      else
+        app_name = JSON.parse(File.read(File.join options[:path], 'manifest.json'))['name']
+      end
+      deploy_app(:post, '/api/v2/apps.json', { :name => app_name })
     end
 
-    def app_dir
-      @app_dir ||= Pathname.new(destination_root)
-    end
+    desc "update", "Update app on the server"
+    method_options SHARED_OPTIONS
+    method_option :zipfile, :default => nil, :required => false, :type => :string
+    def update
+      clear_cache
+      @command = 'Update'
 
-    def tmp_dir
-      @tmp_dir ||= Pathname.new(File.join(app_dir, "tmp")).tap do |dir|
-        FileUtils.mkdir_p(dir)
+      app_id = get_cache('app_id') || find_app_id
+      unless /\d+/ =~ app_id.to_s
+        say_error_and_exit "App id not found\nPlease try running command with --clean or check your internet connection"
       end
+      deploy_app(:put, "/api/v2/apps/#{app_id}.json", {})
     end
 
-    def app_package
-      @app_package ||= Package.new(self.app_dir.to_s)
+    protected
+
+    def setup_path(path)
+      @destination_stack << relative_to_original_destination_root(path) unless @destination_stack.last == path
     end
 
   end
 end
-

data/lib/zendesk_apps_tools/command_helpers.rb

@@ -0,0 +1,21 @@
+require 'zendesk_apps_tools/cache'
+require 'zendesk_apps_tools/common'
+require 'zendesk_apps_tools/api_connection'
+require 'zendesk_apps_tools/deploy'
+require 'zendesk_apps_tools/directory'
+require 'zendesk_apps_tools/package_helper'
+require 'zendesk_apps_tools/settings'
+require 'zendesk_apps_tools/translate'
+require 'zendesk_apps_tools/validate_helper'
+
+module ZendeskAppsTools
+  module CommandHelpers
+    include ZendeskAppsTools::Cache
+    include ZendeskAppsTools::Common
+    include ZendeskAppsTools::APIConnection
+    include ZendeskAppsTools::Deploy
+    include ZendeskAppsTools::Directory
+    include ZendeskAppsTools::PackageHelper
+    include ZendeskAppsTools::ValidateHelper
+  end
+end

data/lib/zendesk_apps_tools/common.rb

@@ -6,6 +6,11 @@ module ZendeskAppsTools
       request.get(url)
     end
 
+    def say_error_and_exit(msg)
+      say msg, :red
+      exit 1
+    end
+
     def get_value_from_stdin(prompt, opts = {})
       options = {
         :valid_regex => opts[:allow_empty] ? /^.*$/ : /\S+/,

data/lib/zendesk_apps_tools/deploy.rb

@@ -0,0 +1,95 @@
+module ZendeskAppsTools
+  module Deploy
+    def deploy_app(connection_method, url, body)
+      body[:upload_id] = upload(options[:path]).to_s
+
+      connection = get_connection
+
+      response = connection.send(connection_method) do |req|
+        req.url url
+        req.headers[:content_type] = 'application/json'
+
+        req.body = JSON.generate body
+      end
+
+      check_status response
+
+    rescue Faraday::Error::ClientError => e
+      say_error_and_exit e.message
+    end
+
+    def upload(path)
+      connection = get_connection :multipart
+      zipfile_path  = options[:zipfile]
+
+      if zipfile_path
+        package_path = zipfile_path
+      else
+        package
+        package_path = Dir[File.join path, '/tmp/*.zip'].sort.last
+      end
+
+      payload = { :uploaded_data => Faraday::UploadIO.new(package_path, 'application/zip') }
+
+      response = connection.post('/api/v2/apps/uploads.json', payload)
+      JSON.parse(response.body)['id']
+
+    rescue Faraday::Error::ClientError => e
+      say_error_and_exit e.message
+    rescue JSON::ParserError => e
+      say_error_and_exit e.message
+    end
+
+    def find_app_id
+      say_status 'Update', 'app ID is missing, searching...'
+      name = get_value_from_stdin('Enter the name of the app:')
+
+      connection = get_connection
+
+      all_apps = connection.get('/api/v2/apps.json').body
+
+      app = JSON.parse(all_apps)['apps'].find { |app| app['name'] == name }
+
+      set_cache 'app_id' => app['id']
+      app['id']
+    rescue Faraday::Error::ClientError => e
+      say_error_and_exit e.message
+    end
+
+    def check_status(response)
+      job = response.body
+      job_id = JSON.parse(job)['job_id']
+
+      check_job job_id
+    end
+
+    def check_job(job_id)
+      connection = get_connection
+
+      loop do
+        response = connection.get("/api/v2/apps/job_statuses/#{job_id}")
+        info     = JSON.parse(response.body)
+        status   = info['status']
+        message  = info['message']
+        app_id   = info['app_id']
+
+        if ['completed', 'failed'].include? status
+          case status
+          when 'completed'
+            set_cache 'app_id' => app_id
+            say_status @command, 'OK'
+          when 'failed'
+            say_status @command, message
+          end
+          break
+        end
+
+        say_status 'Status', status
+        sleep 3
+      end
+    rescue Faraday::Error::ClientError => e
+      say_error_and_exit e.message
+    end
+
+  end
+end

data/lib/zendesk_apps_tools/directory.rb

@@ -0,0 +1,30 @@
+module ZendeskAppsTools
+  module Directory
+
+    def app_dir
+      @app_dir ||= Pathname.new(destination_root)
+    end
+
+    def tmp_dir
+      @tmp_dir ||= Pathname.new(File.join(app_dir, "tmp")).tap do |dir|
+        FileUtils.mkdir_p(dir)
+      end
+    end
+
+    def get_new_app_directory
+      prompt = "Enter a directory name to save the new app (will create the dir if it does not exist, default to current dir):\n"
+      opts = { :valid_regex => /^(\w|\/|\\)*$/, :allow_empty => true }
+      while @app_dir = get_value_from_stdin(prompt, opts) do
+        @app_dir = './' and break if @app_dir.empty?
+        if !File.exists?(@app_dir)
+          break
+        elsif !File.directory?(@app_dir)
+          puts "Invalid dir, try again:"
+        else
+          break
+        end
+      end
+    end
+
+  end
+end

data/lib/zendesk_apps_tools/package_helper.rb

@@ -0,0 +1,29 @@
+module ZendeskAppsTools
+
+  require 'zendesk_apps_support'
+
+  module PackageHelper
+
+    include ZendeskAppsSupport
+
+    def app_package
+      @app_package ||= Package.new(self.app_dir.to_s)
+    end
+
+    def zip(archive_path)
+      Zip::ZipFile.open(archive_path, 'w') do |zipfile|
+        app_package.files.each do |file|
+          path = file.relative_path
+          say_status "package", "adding #{path}"
+
+          # resolve symlink to source path
+          if File.symlink? file.absolute_path
+            path = File.readlink(file.absolute_path)
+          end
+          zipfile.add(file.relative_path, app_dir.join(path).to_s)
+        end
+      end
+    end
+
+  end
+end

data/lib/zendesk_apps_tools/validate_helper.rb

@@ -0,0 +1,21 @@
+module ZendeskAppsTools
+  module ValidateHelper
+
+    DEFAULT_ZENDESK_URL = 'http://support.zendesk.com'
+
+    def test_framework_version
+      prompt = "Enter a zendesk URL that you'd like to install the app (for example: 'http://abc.zendesk.com', default to '#{DEFAULT_ZENDESK_URL}'):\n"
+      zendesk  = get_value_from_stdin(prompt, :valid_regex => /^http:\/\/\w+\.\w+|^$/, :error_msg => 'Invalid url, try again:')
+      zendesk  = DEFAULT_ZENDESK_URL if zendesk.empty?
+      url      = URI.parse(zendesk)
+      response = Net::HTTP.start(url.host, url.port) { |http| http.get('/api/v2/apps/framework_versions.json') }
+      version  = JSON.parse(response.body, :symbolize_names => true)
+
+      if ZendeskAppsSupport::AppVersion::CURRENT != version[:current]
+        puts 'This tool is using an out of date Zendesk App Framework. Please upgrade!'
+        exit 1
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_apps_tools
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - James A. Rosen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -139,6 +139,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Tools to help you develop Zendesk Apps.
 email:
 - dev@zendesk.com
@@ -147,26 +161,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/zat
-- lib/zendesk_apps_tools/command.rb
-- lib/zendesk_apps_tools/common.rb
-- lib/zendesk_apps_tools/locale_identifier.rb
-- lib/zendesk_apps_tools/server.rb
-- lib/zendesk_apps_tools/settings.rb
-- lib/zendesk_apps_tools/translate.rb
-- lib/zendesk_apps_tools.rb
+- 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/promotion-image.png
 - app_template/manifest.json.tt
-- app_template/README.md
 - app_template/templates/layout.hdbs
 - app_template/translations/en.json
-- templates/translation.erb.tt
-- README.md
-- LICENSE
+- bin/zat
 - features/clean.feature
 - features/fixtures/quote_character_translation.json
 - features/new.feature
@@ -174,6 +180,21 @@ files:
 - features/step_definitions/app_steps.rb
 - features/support/env.rb
 - features/validate.feature
+- lib/zendesk_apps_tools.rb
+- lib/zendesk_apps_tools/api_connection.rb
+- lib/zendesk_apps_tools/cache.rb
+- lib/zendesk_apps_tools/command.rb
+- lib/zendesk_apps_tools/command_helpers.rb
+- lib/zendesk_apps_tools/common.rb
+- lib/zendesk_apps_tools/deploy.rb
+- lib/zendesk_apps_tools/directory.rb
+- lib/zendesk_apps_tools/locale_identifier.rb
+- lib/zendesk_apps_tools/package_helper.rb
+- lib/zendesk_apps_tools/server.rb
+- lib/zendesk_apps_tools/settings.rb
+- lib/zendesk_apps_tools/translate.rb
+- lib/zendesk_apps_tools/validate_helper.rb
+- templates/translation.erb.tt
 homepage: http://github.com/zendesk/zendesk_apps_tools
 licenses:
 - Apache License Version 2.0
@@ -194,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Tools to help you develop Zendesk Apps.