zenpush 0.2.0 → 0.3.0

data/Gemfile.lock

@@ -1,28 +1,34 @@
 PATH
   remote: .
   specs:
-    zenpush (0.1.1)
+    zenpush (0.2.0)
       awesome_print (~> 1.0.0)
       boson (~> 1.0)
       httparty (~> 0.8.0)
       json_pure (~> 1.5.1)
+      pygments.rb (~> 0.4.2)
       redcarpet (~> 2.1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     awesome_print (1.0.2)
-    boson (1.1.0)
-    httparty (0.8.1)
-      multi_json
+    boson (1.2.4)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
       multi_xml
-    json_pure (1.5.4)
+    json_pure (1.5.5)
       spruz (~> 0.2.8)
-    multi_json (1.4.0)
-    multi_xml (0.4.1)
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
+    posix-spawn (0.3.6)
+    pygments.rb (0.4.2)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.1.0)
     rake (0.9.2.2)
-    redcarpet (2.1.0)
+    redcarpet (2.1.1)
     spruz (0.2.13)
+    yajl-ruby (1.1.0)
 
 PLATFORMS
   ruby

data/History.md

@@ -0,0 +1,19 @@
+## 0.3.0
+
+* [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) support, with the `-F github` option. ([alexkwolfe](https://github.com/alexkwolfe))
+* [Zendesk API v2](http://www.zendesk.com/blog/zendesk-api). `entries` become `topics`. ([alexkwolfe](https://github.com/alexkwolfe))
+* Automatically create category and forum if either does not exist. ([alexkwolfe](https://github.com/alexkwolfe))
+
+## 0.2.0
+
+* HTML support: don't convert topics to HTML if they're not `.md` or `.markdown` files. ([nfo](https://github.com/nfo))
+
+## 0.1.1
+
+* New option `:filenames_use_dashes_instead_of_spaces`. ([torandu](https://github.com/torandu))
+
+## 0.1.0
+
+* Original version. ([nfo](https://github.com/nfo))
+* List categories, forums, entries. ([nfo](https://github.com/nfo))
+* Convert entries from Markdown to HTML before pushing them to Zendesk. ([nfo](https://github.com/nfo))

data/README.markdown

@@ -44,18 +44,18 @@ Additional configuration (optional):
 
     $ zp forums
 
-### Listing entries in a forum
+### Listing topics in a forum
 
-    $ zp entries -f <forum_id>
+    $ zp topics -f <forum_id>
 
-### Creating/updating an entry
+### Creating/updating a topic
 
-Keep an organized folder of your categories, forums, and entries. Let's say I have the category "Documentation", containing a forum "REST API", and the entries "Introduction" and "Authentication"; you'll want to keep this file structure:
+Keep an organized folder of your categories, forums, and topics. Let's say I have the category "Documentation", containing a forum "REST API", and the topics "Introduction" and "Authentication"; you'll want to keep this file structure:
 
     Documentation/REST API/Introduction.md
     Documentation/REST API/Authentication.md
 
-Creating or updating an entry:
+Creating or updating a topic:
 
     $ zp push -f <path_to_markdown_file>
     $ zp push -f <path_to_html_file>
@@ -66,13 +66,24 @@ Following the previous example, you would type:
     [~/KB/Documentation]$ zp push -f REST API/Authentication.md
     [~/KB]$ zp push -f REST Documentation/API/Authentication.md
 
-The gem will automatically discover the category and forum name of a given entry file. It will also convert your Markdown syntax in HTML before sending it to Zendesk.
+The gem will automatically discover the category and forum name of a given topic file. It will also convert your Markdown syntax in HTML before sending it to Zendesk.
 
-### Check if an entry exists
+### Check if a topic exists
 
     $ zp exists? -f <path_to_markdown_file>
 
+### Markdown Flavors
+
+ZenPush supports two different flavors of markdown: 'standard' and 'github'. The latter flavor supports Github specific
+syntax such as fenced code blocks and language specific highlighting.
+
+Language highlighting alters the HTML inside code blocks to support styling. You will still need to specify the
+appropriate CSS in your Zendesk account. Highlighting uses Pygments and any of the Pygments styles can be applied.
+
+    $ zp push -f <path_to_markdown_file> -F github
+
 ## Contributors
 
-* @nfo
-* @torandu
+* [nfo](https://github.com/nfo)
+* [torandu](https://github.com/torandu)
+* [alexkwolfe](https://github.com/alexkwolfe)

data/bin/zenpush

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'zenpush'
-ZenPush::Runner.start
+ZenPush::Runner.start

data/bin/zp

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'zenpush'
-ZenPush::Runner.start
+ZenPush::Runner.start

data/lib/zenpush/flavors/github.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+require 'redcarpet'
+require 'pygments'
+
+module ZenPush
+  module Flavors
+
+    class SyntaxRenderer < Redcarpet::Render::HTML
+      def block_code(code, language)
+        if language && !language.empty?
+          Pygments.highlight(code, :options => {:lexer => language.to_sym, :encoding => 'utf-8'})
+        else
+          "<pre>#{code}</pre>"
+        end
+      end
+    end
+
+    module Github
+      def self.to_html(text)
+        renderer = SyntaxRenderer.new(optionize [
+          :with_toc_data,
+          :hard_wrap,
+          :xhtml
+        ])
+        markdown = Redcarpet::Markdown.new(renderer, optionize([
+          :fenced_code_blocks,
+          :no_intra_emphasis,
+          :tables,
+          :autolink,
+          :strikethrough,
+          :space_after_headers
+        ]))
+        markdown.render(text)
+      end
+
+      def self.optionize(options)
+        options.each_with_object({}) { |option, memo| memo[option] = true }
+      end
+    end
+  end
+end

data/lib/zenpush/flavors/standard.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+require 'redcarpet/compat'
+
+module ZenPush
+  module Flavors
+    module Standard
+      def self.to_html(content)
+        ::Markdown.new(content).to_html.gsub(/<\/?code>/, '')
+      end
+    end
+  end
+end
+

data/lib/zenpush/markdown.rb

@@ -1,13 +1,29 @@
 # encoding: UTF-8
-require 'redcarpet/compat'
 
 module ZenPush
+  module Flavors
+    FILES = Dir[File.join(File.dirname(__FILE__), 'flavors', '**', '*.rb')].freeze
+    NAMES = FILES.collect { |f| File.basename(f, '.rb') }.freeze
+    FILES.each do |file|
+      require file
+    end
+  end
+
   class Markdown
+    def self.to_zendesk_html(file, flavor=nil)
+      select_flavor(flavor).to_html(File.read(file))
+    end
 
-    # Convert a markdown file to HTML, removing all <code> tags,
-    # which make Zendesk remove carriage returns.
-    def self.to_zendesk_html(file)
-      ::Markdown.new(File.read(file)).to_html.gsub(/<\/?code>/, '')
+    def self.select_flavor(flavor)
+      flavor ||= :standard
+      flavor_class_name = flavor.to_s.capitalize.to_sym
+      if ZenPush::Flavors.const_defined?(flavor_class_name)
+        ZenPush::Flavors.const_get(flavor_class_name)
+      else
+        raise "The '#{flavor}' flavor is not supported. Use: #{ZenPush::Flavors::NAMES.join(', ')}."
+      end
     end
   end
-end
+end
+
+

data/lib/zenpush/runner.rb

@@ -16,40 +16,41 @@ module ZenPush
     end
 
     option :forum_id, :type => :numeric
-    desc 'List entries'
-    def entries(options = {})
-      ap ZenPush.z.entries(options[:forum_id])
+    desc 'List topics'
+    def topics(options = {})
+      ap ZenPush.z.topics(options[:forum_id])
     end
 
-    desc 'Does the entry matching the given file exist ?'
+    desc 'Does the topic matching the given file exist?'
     option :file, :type => :string
     def exists?(options = {})
-      category_name, forum_name, entry_title = ZenPush.file_to_category_forum_entry(options[:file])
-      entry = ZenPush.z.find_entry(category_name, forum_name, entry_title)
-      ap !!entry
+      category_name, forum_name, topic_title = ZenPush.file_to_category_forum_topic(options[:file])
+      topic = ZenPush.z.find_topic(category_name, forum_name, topic_title)
+      ap !!topic
     end
 
-    desc 'Create or update an entry from the given file'
+    desc 'Create or update a topic from the given file'
     option :file, :type => :string
+    option :flavor, :type => :string
     def push(options = {})
-      category_name, forum_name, entry_title = ZenPush.file_to_category_forum_entry(options[:file])
+      category_name, forum_name, topic_title = ZenPush.file_to_category_forum_topic(options[:file])
 
-      entry_body =
+      topic_body =
         if options[:file].end_with?('.md') || options[:file].end_with?('.markdown')
-          ZenPush::Markdown.to_zendesk_html(options[:file])
+          ZenPush::Markdown.to_zendesk_html(options[:file], options[:flavor])
         else
           File.read(options[:file])
         end
 
-      entry = ZenPush.z.find_entry(category_name, forum_name, entry_title)
-      if entry
-        # UPDATE THE ENTRY
-        ap ZenPush.z.put_entry(entry['id'], entry_body)
+      topic = ZenPush.z.find_topic(category_name, forum_name, topic_title)
+      if topic
+        # UPDATE THE TOPIC
+        ap ZenPush.z.put_topic(topic['id'], topic_body)
       else
-        forum = ZenPush.z.find_forum(category_name, forum_name)
+        forum = ZenPush.z.find_or_create_forum(category_name, forum_name)
         if forum
-          # CREATE THE ENTRY
-          ap ZenPush.z.post_entry(forum['id'], entry_title, entry_body)
+          # CREATE THE TOPIC
+          ap ZenPush.z.post_topic(forum['id'], topic_title, topic_body)
         else
           ap "Could not find a forum named '#{forum_name}' in the category '#{category_name}'"
           exit(-1)

data/lib/zenpush/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module ZenPush
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/zenpush/zendesk.rb

@@ -33,7 +33,7 @@ module ZenPush
 
       @options = opts
 
-      self.class.base_uri opts[:uri] + '/api/v1'
+      self.class.base_uri opts[:uri] + '/api/v2'
       self.class.basic_auth opts[:user], opts[:password]
     end
 
@@ -54,7 +54,7 @@ module ZenPush
     end
 
     def categories(options = {})
-      self.get('/categories.json', options).parsed_response
+      self.get('/categories.json', options).parsed_response['categories']
     end
 
     def category(category_id, options = {})
@@ -62,7 +62,7 @@ module ZenPush
     end
 
     def forums(options = {})
-      self.get('/forums.json', options).parsed_response
+      self.get('/forums.json', options).parsed_response['forums']
     end
 
     def forum(forum_id, options = {})
@@ -70,20 +70,32 @@ module ZenPush
     end
 
     def users(options = {})
-      self.get('/users.json', options).parsed_response
+      self.get('/users.json', options).parsed_response['users']
     end
 
-    def entries(forum_id, options = {})
-      self.get("/forums/#{forum_id}/entries.json", options).parsed_response
+    def topics(forum_id, options = { })
+      self.get("/forums/#{forum_id}/topics.json", options).parsed_response['topics']
     end
 
-    def entry(entry_id, options = {})
-      self.get("/entries/#{entry_id}.json", options).parsed_response
+    def topic(topic_id, options = {})
+      self.get("/topics/#{topic_id}.json", options).parsed_response
     end
 
     # Find category by name
     def find_category(category_name, options = {})
-      self.categories.detect {|c| c['name'] == category_name}
+      categories = self.categories
+      if categories.is_a?(Array)
+        categories.detect { |c| c['name'] == category_name }
+      else
+        raise "Could not retrieve categories: #{categories}"
+      end
+    end
+
+    # Find category by name, creating it if it doesn't exist
+    def find_or_create_category(category_name, options={ })
+      find_category(category_name, options) || begin
+        post_category(category_name, options={ })
+      end
     end
 
     # Find forum by name, knowing the category name
@@ -94,32 +106,63 @@ module ZenPush
       end
     end
 
-    # Find entry by name, knowing the forum name and category name
-    def find_entry(category_name, forum_name, entry_title, options = {})
+    # Given a category name, find a forum by name. Create the category and forum either doesn't exist.
+    def find_or_create_forum(category_name, forum_name, options={ })
+      category = self.find_or_create_category(category_name, options)
+      if category
+        self.forums.detect { |f| f['name'] == forum_name } || post_forum(category['id'], forum_name)
+      end
+    end
+
+    # Find topic by name, knowing the forum name and category name
+    def find_topic(category_name, forum_name, topic_title, options = {})
       forum = self.find_forum(category_name, forum_name, options)
       if forum
-        self.entries(forum['id'], options).detect {|e| e['title'] == entry_title}
+        self.topics(forum['id'], options).detect {|t| t['title'] == topic_title}
       end
     end
 
-    # Create an entry in the given forum id
-    def post_entry(forum_id, entry_title, entry_body, options = {})
-      self.post("/entries.json",
-        options.merge(
-          :body => { :entry => {
-            :forum_id => forum_id, :title => entry_title, :body => entry_body
-          } }.to_json
-        )
-      )
-    end
-
-    # Update an entry in the given forum id
-    def put_entry(entry_id, entry_body, options = {})
-      self.put("/entries/#{entry_id}.json",
-        options.merge(
-          :body => { :entry => { :body => entry_body } }.to_json
-        )
-      )
+    # Create a category with a given name
+    def post_category(category_name, options={ })
+      self.post('/categories.json',
+                options.merge(
+                  :body => { :category => {
+                    :name => category_name
+                  } }.to_json
+                )
+      )['category']
+    end
+
+    # Create a forum in the given category id
+    def post_forum(category_id, forum_name, options={ })
+      self.post('/forums.json',
+                options.merge(
+                  :body => { :forum => {
+                    :name        => forum_name,
+                    :category_id => category_id
+                  } }.to_json
+                )
+      )['forum']
+    end
+
+    # Create a topic in the given forum id
+    def post_topic(forum_id, title, body, options = { })
+      self.post("/topics.json",
+                options.merge(
+                  :body => { :topic => {
+                    :forum_id => forum_id, :title => title, :body => body
+                  } }.to_json
+                )
+      )['topic']
+    end
+
+    # Update a topic in the given forum id
+    def put_topic(id, body, options = { })
+      self.put("/topics/#{id}.json",
+               options.merge(
+                 :body => { :topic => { :body => body } }.to_json
+               )
+      )['topic']
     end
 
   end

data/lib/zenpush.rb

@@ -11,7 +11,7 @@ module ZenPush
     @z ||= ZenPush::Zendesk.new
   end
 
-  def file_to_category_forum_entry(file)
+  def file_to_category_forum_topic(file)
     absolute_path = File.realpath(file)
     file_extension = File.extname(file)
 
@@ -21,10 +21,10 @@ module ZenPush
       parts.each { |el| el.gsub!(/-/, ' ') }
     end
 
-    entry_name = File.basename(parts[-1], file_extension)
+    topic_name = File.basename(parts[-1], file_extension)
     forum_name = parts[-2]
     category_name = parts[-3]
 
-    return category_name, forum_name, entry_name
+    return category_name, forum_name, topic_name
   end
 end

data/zenpush.gemspec

@@ -17,12 +17,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.rdoc_options  = ["--charset=UTF-8"]
-  
+
   s.add_dependency "boson", "~> 1.0" # Command line
   s.add_dependency "httparty", "~> 0.8.0" # Zendesk API calls
   s.add_dependency "redcarpet", "~> 2.1.0" # Markdown to HTML
+  s.add_dependency "pygments.rb", "~> 0.4.2" # Code highlighting for Github flavored markdown
   s.add_dependency "awesome_print", "~> 1.0.0" # Colorized output of Zendesk responses
   s.add_dependency "json_pure", "~> 1.5.1" # The C-gem "json" will still be used instead if it's installed
 
   s.add_development_dependency "rake"
-end
+end

metadata

@@ -2,14 +2,14 @@
 name: zenpush
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nicolas Fouché
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,6 +59,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.1.0
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+    none: false
+  name: pygments.rb
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+    none: false
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -119,13 +135,15 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
-- History.txt
+- History.md
 - LICENSE
 - README.markdown
 - Rakefile
 - bin/zenpush
 - bin/zp
 - lib/zenpush.rb
+- lib/zenpush/flavors/github.rb
+- lib/zenpush/flavors/standard.rb
 - lib/zenpush/markdown.rb
 - lib/zenpush/runner.rb
 - lib/zenpush/version.rb

data/History.txt

@@ -1,13 +0,0 @@
-== 0.2.0
-
-* HTML support: don't convert file before pushing it to Zendesk if it's not a .md or .markdown file.
-
-== 0.1.1
-
-* New option `:filenames_use_dashes_instead_of_spaces` (@torandu)
-
-== 0.1.0
-
-* Original version
-* List categories, forums, entries
-* Convert entries from Markdown to HTML push them to Zendesk