zendesk_polly 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 269764c0e5de3cb725c7c4ebfba2cea5c2647351
+  data.tar.gz: e74d1ef832be18aaec6d6aa1da83d8744f800a32
+SHA512:
+  metadata.gz: f437279099fff99f89ef812077e467b655395bcf26656967f1f4a38f3e58839af3ec1d1e7e0f008188a9ffb67ce2a3a772834e7f9ad3ac11ce777b04e05a94c8
+  data.tar.gz: abbe6e29888222feeb8add23de6343b63ccccf84f943ea51ed79733f668eb7dca37bef274f1a2bb2dcaf64d04a7088b9e0b08b556c9f1e8996a148facea65e55

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.zp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,100 @@
+# Zendesk Polly
+
+Too shy to record your own voice for __Zendesk Talk__ greetings? How about letting someone else read your text?
+__ZendeskPolly__ uses __Amazon Polly__ text-to-speech engine to convert your text messages into audio files.
+
+This gem is far from being production ready. As of now, it's just a spike to get to know a bit of Zendesk's API.
+
+
+## Installation
+
+Install the gem and use the command line:
+
+```bash
+$ gem install zendesk_polly
+```
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'zendesk_polly'
+```
+
+And then provide ZendeskPolly with the required credentials and account details:
+
+```bash
+$ zp init
+```
+This command will start an interactive shell session and will save your credentials at `~/.zendesk_polly`.
+
+## Usage
+
+```
+$ zp --help
+
+NAME:
+
+  ZendeskPolly
+
+DESCRIPTION:
+
+  Client to create zendesk greetings with Aws Polly
+
+COMMANDS:
+      
+  categories Lists available greeting categories              
+  create     Creates a Zendesk greeting with Aws Polly                
+  help       Display global or [command] help documentation           
+  init       Configures ZendeskPolly          
+  voices     Lists available voices
+```
+
+
+## Usage
+
+Most commands have interactive mode, but can be initialized with some options.
+Use `zp [command] --help` for details.
+
+# Examples
+
+```bash
+# creating an IVR greeting
+$ zp create --name 'My new greeting' --category 'ivr' --voice 'Joanna' --text 'This will be read by Joanna'
+
+# or just 
+$ zp create
+```
+
+You can also use ZendeskPolly's client inside your own application.
+
+```ruby
+client = ZendeskPolly::Client.new do |c|
+  c.aws_region         = ... # defaults to 'us-east-1'
+  c.zendesk_token      = ... # create an API token at `[your_zd_url]agent/admin/api/settings`
+  c.zendesk_username   = ... # your email
+  c.zendesk_url        = ... # https://{your_zd_portal}.zendesk.com/api/v2
+  c.aws_key            = ... # Create an AMI user and grant access to Polly services
+  c.aws_secret         = ...
+end
+
+# This won't create the greeting just yet. You have a change to listen to it before submitting to Zendesk.
+greeting = client.polly_greeting.new(name: 'greeting name', text: "I've just initialized a voice message")
+
+# Opens your default player and plays the converted audio file
+greeting.play 
+
+# To submit to zendesk use:
+greeting.save
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/angelim/zendesk_polly.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zendesk_polly"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/zp

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zendesk_polly"
+require 'commander/import'
+LANGUAGES          = [
+                        "all",
+                        "en-US",
+                        "en-AU",
+                        "en-GB",
+                        "en-GB-WLS",
+                        "en-IN",
+                        "cy-GB",
+                        "da-DK",
+                        "de-DE",
+                        "es-ES",
+                        "es-US",
+                        "fr-CA",
+                        "fr-FR",
+                        "is-IS",
+                        "it-IT",
+                        "ja-JP",
+                        "nb-NO",
+                        "nl-NL",
+                        "pl-PL",
+                        "pt-BR",
+                        "pt-PT",
+                        "ro-RO",
+                        "ru-RU",
+                        "sv-SE",
+                        "tr-TR"
+                      ]
+
+program :name, 'ZendeskPolly'
+program :version, ZendeskPolly::VERSION
+program :description, 'Client to create zendesk greetings with Aws Polly'
+
+command :create do |c|
+  c.syntax = 'zp create'
+  c.description = 'Creates a Zendesk greeting with Aws Polly'
+
+  c.option '--name STRING', String, 'Greeting name'
+  c.option '--category STRING', String, 'Greeting category'
+  c.option '--voice STRING', String, 'Greeting voice'
+  c.option '--text STRING', String, 'Greeting text'
+
+  c.action do |args, options|
+    client        = ZendeskPolly::Client.new
+    client.check_configurations
+    
+    name          = options.name      || ask("Greeting name: ")
+    category      = options.category  || choose("Greeting Category", *ZendeskPolly::Greeting::CATEGORIES.keys)
+    voice         = options.voice     || choose("Choose a voice from the list", *client.voice_names)
+    text          = options.text      || ask("Type your message:")
+    
+    greeting      = client.poly_greeting(
+                      name:       name,
+                      category:   category,
+                      voice:      voice,
+                      text:       text
+                    )
+    
+    should_play   = agree("Would you like to play the message(y/n)?")
+    greeting.play if should_play
+    
+    if agree("Would you like to save the message(y/n)?")
+      say "Creating... #{name}"
+      greeting.save
+    else
+      say "Message was not created"
+    end
+  end
+end
+
+command :init do |c|
+  c.syntax = 'zp init .'
+  c.description = 'Configures ZendeskPolly'
+  c.action do |args, options|
+    say 'Initializing Configuration'
+    config = ZendeskPolly::Config.new
+    config.aws_key = ask("AWS key: ")
+    config.aws_secret = ask("AWS secret: ")
+    config.aws_region = ask("AWS region: ")
+    config.zendesk_username = ask("Zendesk username: ")
+    config.zendesk_token = ask("Zendesk token: ")
+    config.zendesk_url = ask("Zendesk url: ")
+    config.serialize_to_file
+  end
+end
+
+command :voices do |c|
+  c.syntax      = 'zp voices'
+  c.description = 'Lists available voices'
+  c.option '--language String', String, 'Language code'
+  c.action do |args, options|
+    code = options.language || choose('Which language', *LANGUAGES)
+    say 'These are the available voices:'
+    client = ZendeskPolly::Client.new
+    client.voices(code)
+  end
+end
+
+command :categories do |c|
+  c.syntax      = 'zp categories'
+  c.description = 'Lists available greeting categories'
+  c.action do |args, options|
+    say 'These are the available greeting categories'
+    say ZendeskPolly::Greeting::CATEGORIES.keys.map(&:to_s)
+  end
+end

data/lib/zendesk_polly.rb

@@ -0,0 +1,15 @@
+require "zendesk_polly/version"
+require 'aws-sdk-core'
+require 'zendesk_api'
+require 'zendesk_polly/client'
+require 'zendesk_polly/greeting'
+require 'pry-nav'
+
+module ZendeskPolly
+  
+  # uri = "http://www.ruby-lang.org"
+  # Launchy.open( uri ) do |exception|
+  #   puts "Attempted to open #{uri} and failed because #{exception}"
+  # end
+
+end

data/lib/zendesk_polly/client.rb

@@ -0,0 +1,88 @@
+require 'zendesk_polly/config'
+require 'command_line_reporter'
+
+module ZendeskPolly
+  class Client
+    include CommandLineReporter
+    
+    ZendeskPollyError  = Class.new(ArgumentError)
+    
+    attr_reader :polly, :zendesk, :config
+    
+    def initialize
+      @config = Config.new(self)
+      yield config if block_given?
+    end
+
+    # Call when config is dirty
+    def reset!
+      @polly_client   = nil
+      @zendesk_client = nil
+    end
+
+    def polly
+      check_polly_configuration
+      @polly_client ||= begin
+        Aws::Polly::Client.new(
+          access_key_id:      config.aws_key,
+          secret_access_key:  config.aws_secret,
+          region:             config.aws_region
+        )
+      end
+    end
+
+    def zendesk
+      check_zendesk_configuration
+      @zendesk_client ||= begin
+        ZendeskAPI::Client.new do |z|
+          z.token     = config.zendesk_token
+          z.username  = config.zendesk_username
+          z.url       = config.zendesk_url
+        end
+      end
+    end
+
+    def check_configurations
+      check_zendesk_configuration
+      check_polly_configuration
+    end
+
+    def check_zendesk_configuration
+      if attr = config.zendesk_configuration.find{ |_, v| v.nil? }
+        raise ZendeskPollyError.new("missing #{attr}")
+      end
+    end
+
+    def check_polly_configuration
+      if attr = config.polly_configuration.find{ |_, v| v.nil? }
+        raise ZendeskPollyError.new("missing #{attr}")
+      end
+    end
+
+    def poly_greeting(options = {})
+      Greeting.new(self, options)   
+    end
+
+    def voice_names
+      polly.describe_voices.voices.map(&:id)
+    end
+
+    def voices(code)
+      code = nil if code == "all"
+      table border: true do
+        row do
+          column 'Voice'
+          column 'Language'
+          column 'Gender'
+        end
+        polly.describe_voices({language_code: code}).voices.each do |voice|
+          row do
+            column voice.id
+            column voice.language_name
+            column voice.gender
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_polly/config.rb

@@ -0,0 +1,56 @@
+require 'fileutils'
+require 'yaml'
+
+module ZendeskPolly
+  class Config
+    attr_accessor :zendesk_token, :zendesk_username, :zendesk_url
+    attr_accessor :aws_key, :aws_secret, :aws_region
+    attr_reader   :client
+
+    def initialize(client = nil)
+      @client = client # retrieves the client to allow reseting when changing attributes
+      deserialize_from_file if File.exist?(config_file)
+      @aws_region ||= 'us-east-1'
+    end
+
+    def config_file
+      @config_file ||= File.join(File.expand_path('~'), '.zendesk_polly')
+    end
+
+    def deserialize_from_file
+      self.attributes = YAML.load_file(config_file)
+    end
+
+    def serialize_to_file
+      File.write(config_file, attributes.to_yaml)
+    end
+
+    def attributes=(options)
+      self.zendesk_token      = options[:zendesk_token]
+      self.zendesk_username   = options[:zendesk_username]
+      self.zendesk_url        = options[:zendesk_url]
+      self.aws_region         = options[:aws_region]
+      self.aws_key            = options[:aws_key]
+      self.aws_secret         = options[:aws_secret]
+    end
+
+    def attributes
+      {
+        zendesk_token:          zendesk_token,
+        zendesk_username:       zendesk_username,
+        zendesk_url:            zendesk_url,
+        aws_key:                aws_key,
+        aws_secret:             aws_secret,
+        aws_region:             aws_region
+      }
+    end
+
+    def zendesk_configuration
+      attributes.select{ |k, _| k =~ /\Azendesk/ }
+    end
+
+    def polly_configuration
+      attributes.select{ |k, _| k =~ /\Aaws/ }
+    end
+  end
+end

data/lib/zendesk_polly/greeting.rb

@@ -0,0 +1,70 @@
+require 'forwardable'
+require 'launchy'
+require 'tempfile'
+require 'digest'
+
+module ZendeskPolly
+  class Greeting
+    extend Forwardable
+
+    AUDIO_CONTENT_TYPE = 'audio/mpeg'
+    OUTPUT_FORMAT      = 'mp3'
+
+    CATEGORIES = {
+                    voicemail:              1,
+                    available:              2,
+                    wait:                   3,
+                    hold:                   4,
+                    ivr:                    5,
+                    callback:               6,
+                    callback_confirmation:  7
+                  }
+
+    attr_accessor :name, :category, :text, :mp3_file, :voice
+    attr_reader :client
+    
+    def initialize(client, options = {})
+      @client     = client
+      @text       = options[:text]
+      raise ArgumentError.new("text is required") unless text
+      
+      @voice      = options[:voice] || 'Joanna'
+      @name       = options[:name] || encoded_text
+      @category   = options[:category] || :ivr
+      @category   = category.to_sym
+      @mp3_file = "/tmp/#{encoded_text}.mp3" if options[:text]
+      synthesize_speech
+    end
+
+    def encoded_text
+      @et ||= Digest::MD5.hexdigest(text)
+    end
+
+    def play
+      Launchy.open("file://#{mp3_file}")
+    end
+
+    def save
+      placeholder = client.zendesk.greetings.create!(name: name, category_id: CATEGORIES[category])
+      upload(placeholder.id)
+    end
+
+    def synthesize_speech
+      client.polly.synthesize_speech({
+        voice_id: voice,
+        text: text,
+        output_format: OUTPUT_FORMAT,
+        response_target: mp3_file
+      })
+    end
+
+    def upload(greeting_id)
+      raise ArgumentError.new("voice was not generated") unless mp3_file
+      client.zendesk.greetings.update!(
+        id: greeting_id,
+        upload_attributes: { uploaded_data: Faraday::UploadIO.new(mp3_file, AUDIO_CONTENT_TYPE) }
+      )
+    end
+
+  end
+end

data/lib/zendesk_polly/version.rb

@@ -0,0 +1,3 @@
+module ZendeskPolly
+  VERSION = "0.0.1"
+end

data/zendesk_polly.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zendesk_polly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zendesk_polly"
+  spec.version       = ZendeskPolly::VERSION
+  spec.authors       = ["Alexandre Angelim"]
+  spec.email         = ["angelim@angelim.com.br"]
+
+  spec.summary       = %q{Zendesk Talk integration with AWS Polly}
+  spec.description   = %q{Create Zendesk Talk greetings using AWS Polly text-to-speech engine}
+  spec.homepage      = "http://github.com/angelim/zendesk_polly"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'commander', '~> 4.4'
+  spec.add_runtime_dependency 'aws-sdk', '~> 2.10'
+  spec.add_runtime_dependency 'zendesk_api', '~> 1.14'
+  spec.add_runtime_dependency 'launchy', '~> 2.4'
+  spec.add_runtime_dependency 'command_line_reporter', '~> 3.0'
+  
+  spec.add_development_dependency "pry-nav", "~> 0.2"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: zendesk_polly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexandre Angelim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: zendesk_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: command_line_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Create Zendesk Talk greetings using AWS Polly text-to-speech engine
+email:
+- angelim@angelim.com.br
+executables:
+- console
+- setup
+- zp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/zp
+- lib/zendesk_polly.rb
+- lib/zendesk_polly/client.rb
+- lib/zendesk_polly/config.rb
+- lib/zendesk_polly/greeting.rb
+- lib/zendesk_polly/version.rb
+- zendesk_polly.gemspec
+homepage: http://github.com/angelim/zendesk_polly
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Zendesk Talk integration with AWS Polly
+test_files: []