zend 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06d8a9f8dfc7a58be94400d7f2895ae4414b6c82
+  data.tar.gz: 510f86a5312ce14fc1aabfc679061dc24cdb1ebb
+SHA512:
+  metadata.gz: 503627f9466251962d5999cebc51452592036c556cb204cb3027015b1d59b69bfd9c76b6a55fb368d646e1214eefef01906f350b7806abee03d72a659b1ca20e
+  data.tar.gz: 7a14d6722f3878d64960822113b2e291c002c0b302d273119d698b917808ebc6faf2d4f065a19a0626811ddbaa3905af9b26f114251f8a294643c81c64e23ac0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.1.0 (September 7, 2013)
+
+Features:
+
+  - `zend login` to log in to your Zendesk account
+  - `zend logout` to remove local Zendesk credentials
+  - `zend show <ticket id>` to show basic ticket information
+  - set `ZEND_ACCOUNT` environment variable to skip account detail
+    requests for each command

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zend.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jean Mertz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Zend
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zend'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zend
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/zend

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'zend'
+Zend::CLI.start

data/lib/zend/auth.rb

@@ -0,0 +1,138 @@
+require 'zendesk_api'
+require 'netrc'
+require 'highline/import'
+
+module Zend
+  class Auth
+    class << self
+      def api
+        unless @api
+          @api = ZendeskAPI::Client.new do |config|
+            config.url = "https://#{domain}/api/v2"
+            config.username = user
+            config.token = password
+          end
+          unauthorized_callback(@api)
+        end
+
+        @api
+      end
+
+      def login
+        delete_credentials
+        get_credentials
+      end
+
+      def logout
+        delete_credentials
+      end
+
+      def domain
+        "#{get_account}.zendesk.com"
+      end
+
+      def user
+        get_credentials[0]
+      end
+
+      def password
+        get_credentials[1]
+      end
+
+    private
+
+      def get_account
+        @account ||= (ENV['ZEND_ACCOUNT'] || ask_for_account)
+      end
+
+      def unauthorized_callback(api)
+        api.insert_callback do |response|
+          if response[:status] == 401
+            Kernel.abort 'Incorrect Zendesk API authentication credentials'
+          end
+        end
+      end
+
+      def verify
+        api.users.first
+      end
+
+      def netrc_path
+        default = Netrc.default_path
+        encrypted = default + '.gpg'
+        if File.exists?(encrypted)
+          encrypted
+        else
+          default
+        end
+      end
+
+      def netrc
+        @netrc ||= begin
+          File.exists?(netrc_path) && Netrc.read(netrc_path)
+        rescue => error
+          if error.message =~ /^Permission bits for/
+            perm = File.stat(netrc_path).mode & 0777
+            Kernel.abort "Permissions #{perm} for '#{netrc_path}' are too
+            open. You should run `chmod 0600 #{netrc_path}` so that your
+            credentials are NOT accessible by others."
+          else
+            raise error
+          end
+        end
+      end
+
+      def get_credentials
+        @credentials ||= (read_credentials || ask_for_and_save_credentials)
+      end
+
+      def delete_credentials
+        if netrc
+          netrc.delete(domain)
+          netrc.save
+        end
+        @email, @token = nil
+      end
+
+      def read_credentials
+        netrc[domain] if netrc
+      end
+
+      def write_credentials
+        FileUtils.mkdir_p(File.dirname(netrc_path))
+        FileUtils.touch(netrc_path)
+        FileUtils.chmod(0600, netrc_path)
+        netrc[domain] = @credentials
+        netrc.save
+      end
+
+      def ask_for_account
+        say "Enter your Zendesk account (subdomain). Set a ZEND_ACCOUNT environment variable to skip this step.\n\n"
+        @account = ask 'Zendesk subdomain: '
+      end
+
+      def ask_for_credentials
+        say 'Enter your Zendesk credentials.' if ENV['ZEND_ACCOUNT']
+
+        email = ask 'E-mail address: '
+        token = ask_token 'Secret token (typing will be hidden): '
+
+        [email, token]
+      end
+
+      def ask_for_and_save_credentials
+        @credentials = ask_for_credentials
+        write_credentials
+        verify
+
+        @credentials
+      end
+
+      def ask_token(message)
+        HighLine.new.ask(message) do |q|
+          q.echo = false
+        end
+      end
+    end
+  end
+end

data/lib/zend/cli.rb

@@ -0,0 +1,19 @@
+module Zend
+  class CLI < Thor
+
+    desc 'login', 'Starts prompt to login to your Zendesk account'
+    def login
+      Zend::Auth.login
+    end
+
+    desc 'logout', 'Remove credentials from local machine'
+    def logout
+      Zend::Auth.logout
+    end
+
+    desc 'ticket details', 'Get details of a Zendesk ticket'
+    def show(ticket_id)
+      puts Zend::Command::Ticket.new(ticket_id).print
+    end
+  end
+end

data/lib/zend/command/base.rb

@@ -0,0 +1,31 @@
+class Zend::Command::Base
+  def api
+    Zend::Auth.api
+  end
+
+  def terminal_width
+    result = unix? ? dynamic_width : 80
+    (result < 10) ? 80 : result
+  rescue
+    80
+  end
+
+private
+
+  def unix?
+    RUBY_PLATFORM =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+  end
+
+  def dynamic_width
+    @dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
+  end
+
+  def dynamic_width_stty
+    %x{stty size 2>/dev/null}.split[1].to_i
+  end
+
+  def dynamic_width_tput
+    %x{tput cols 2>/dev/null}.to_i
+  end
+
+end

data/lib/zend/command/ticket.rb

@@ -0,0 +1,56 @@
+module Zend
+  module Command
+    class Ticket < Base
+      attr_reader :ticket
+
+      def initialize(ticket_id)
+        @ticket = api.tickets.find(id: ticket_id, include: :users)
+      end
+
+      def print
+        rows = Array.new
+        rows << [value: col_subject, colspan: 3]
+        rows << :separator
+        rows << [col_requester, col_created, col_updated]
+
+        puts Terminal::Table.new(
+          style: {
+            width: terminal_width,
+            padding_left: 3
+          },
+          rows: rows
+        )
+
+        puts col_description
+      end
+
+    private
+
+      def col_subject
+        "##{ticket.id}: #{ticket.subject}"
+      end
+
+      def col_requester
+        "By: #{requester}"
+      end
+
+      def col_created
+        %Q{Created: #{ticket.created_at.getlocal.strftime("%-d %B, %H:%M")}}
+      end
+
+      def col_updated
+        %Q{Updated: #{ticket.updated_at.getlocal.strftime("%-d %B, %H:%M")}}
+      end
+
+      def col_description
+        "\n#{ticket.description}"
+        #.scan(/.{1,80}/m).join("\n")
+      end
+
+      def requester
+        ticket.requester.name
+      end
+
+    end
+  end
+end

data/lib/zend/command.rb

@@ -0,0 +1,4 @@
+module Zend
+  module Command
+  end
+end

data/lib/zend/version.rb

@@ -0,0 +1,3 @@
+module Zend
+  VERSION = '0.1.0'
+end

data/lib/zend.rb

@@ -0,0 +1,13 @@
+require 'thor'
+require 'highline'
+require 'terminal-table'
+
+require 'zend/version'
+require 'zend/auth'
+require 'zend/cli'
+require 'zend/command'
+require 'zend/command/base'
+require 'zend/command/ticket'
+
+module Zend
+end

data/zend.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zend/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zend'
+  spec.version       = Zend::VERSION
+  spec.authors       = ['Jean Mertz']
+  spec.email         = ['jean@mertz.fm']
+  spec.description   = %q{Interact with Zendesk through your terminal.}
+  spec.summary       = %q{A command line interface to everything Zendesk}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'zendesk_api', '~> 1.0.3'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'highline'
+  spec.add_dependency 'terminal-table'
+  spec.add_dependency 'netrc'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: zend
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean Mertz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zendesk_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Interact with Zendesk through your terminal.
+email:
+- jean@mertz.fm
+executables:
+- zend
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/zend
+- lib/zend.rb
+- lib/zend/auth.rb
+- lib/zend/cli.rb
+- lib/zend/command.rb
+- lib/zend/command/base.rb
+- lib/zend/command/ticket.rb
+- lib/zend/version.rb
+- zend.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A command line interface to everything Zendesk
+test_files: []
+has_rdoc: