devcenter 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devcenter.gemspec
+gemspec
+
+# Temporary
+# gem 'sinatra', :git => 'https://github.com/sinatra/sinatra.git', :ref => '9984d0d2b3f1ea12273c6c25f8e102b2329f33e9'
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Heroku
+
+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,39 @@
+# Devcenter
+
+CLI to interact with Heroku's Dev Center
+
+## Installation
+
+    $ gem install devcenter
+
+## Usage
+
+### Open a published article
+
+    $ devcenter open error-pages
+
+### Save a local copy of an article
+
+    $ devcenter pull error-pages
+
+This will save an `article-slug.md` text file in your local directory. The file includes some metadata (article title and id) followed by the article content in markdown format. You can edit both the title and the content, but **never overwrite the article id**.
+
+### Preview a local copy of an article
+
+    $ devcenter preview dynos
+
+This will open a preview in your default browser and get it refreshed when you save the file. You can specify `--port` and `--host` options to customize the preview web server.
+
+### Help
+
+Get available commands
+
+    $ devcenter help
+
+Get help about a specific command
+
+    $ devcenter help pull
+
+## License
+
+See LICENSE.txt file.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/devcenter

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# Trap interrupts to quit cleanly. See
+# https://twitter.com/mitchellh/status/283014103189053442
+Signal.trap("INT") { exit 1 }
+
+require_relative '../lib/devcenter.rb'

data/devcenter.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devcenter/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "devcenter"
+  gem.version       = Devcenter::VERSION
+  gem.authors       = ["Raul Murciano"]
+  gem.email         = ["raul@heroku.com"]
+  gem.description   = %q{CLI to interact with Heroku's Dev Center}
+  gem.summary       = %q{CLI to interact with Heroku's Dev Center}
+  gem.homepage      = "https://devcenter.heroku.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = %w{ devcenter }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w{ lib vendor }
+  gem.add_runtime_dependency('commander', '~> 4.1.3')
+  gem.add_runtime_dependency('json', '~>1.7.6')
+  gem.add_runtime_dependency('excon', '~>0.15.4')
+  gem.add_runtime_dependency('launchy', '~>2.1.0')
+  gem.add_runtime_dependency('maruku', '~>0.6.1')
+  gem.add_runtime_dependency('nokogiri', '~>1.5.5')
+  gem.add_runtime_dependency('coderay', '~>1.0.8')
+  gem.add_runtime_dependency('thin', '~>1.5.0')
+  gem.add_runtime_dependency('rack', '~>1.4.4')
+  gem.add_runtime_dependency('rack-protection', '~>1.3.2')
+  gem.add_runtime_dependency('tilt', '~>1.3.3')
+end

data/lib/devcenter.rb

@@ -0,0 +1,6 @@
+require_relative '../vendor/sinatra/lib/sinatra'
+require_relative 'devcenter/version'
+require_relative 'devcenter/helpers'
+require_relative 'devcenter/previewer'
+require_relative 'devcenter/coderay_extensions'
+require_relative 'devcenter/cli'

data/lib/devcenter/cli.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+
+program :version, Devcenter::VERSION
+program :description, "CLI to interact with Heroku's Dev Center"
+
+require_relative './commands'
+
+command :open do |c|
+  c.syntax = 'devcenter open [options]'
+  c.summary = 'Open the article with the given slug in the default browser'
+  c.description = c.summary
+  c.example 'devcenter open process-model', 'Opens https://devcenter.heroku.com/articles/process-model in the default browser'
+  c.action do |args, options|
+    Devcenter::Commands::Open.run(args[0])
+  end
+end
+
+command :pull do |c|
+  c.syntax = 'devcenter pull [options]'
+  c.summary = 'Save an editable copy of an article in your current directory'
+  c.description = c.summary
+  c.example 'devcenter pull process-model', 'Saves the content of the article with the "process-model" slug to a local process-model.md file in the current directory'
+  c.option '--force', 'Skip confirmation and overwrite existing local file'
+  c.action do |args, options|
+    options.default :force => false
+    Devcenter::Commands::Pull.run(args[0], options.force)
+  end
+end
+
+command :preview do |c|
+  c.syntax = 'devcenter preview [options]'
+  c.summary = 'Opens a live preview for a given article file'
+  c.description = c.summary
+  c.example 'devcenter preview process-model', 'Opens a live preview of the local process-model.md file'
+
+  c.option '--host HOST', String, 'Host where the preview will be available'
+  c.option '--port PORT_NUMBER', Integer, 'Port where the preview will be available'
+  c.action do |args, options|
+    options.default :host => '127.0.0.1', :port => 3000
+    Devcenter::Commands::Preview.run(args[0], options.host, options.port)
+  end
+end

data/lib/devcenter/coderay_extensions.rb

@@ -0,0 +1,70 @@
+module CodeRay
+
+  # Silent warnings
+  module Encoders
+    class Encoder
+      def << token
+        # unless @@CODERAY_TOKEN_INTERFACE_DEPRECATION_WARNING_GIVEN
+        #   warn 'Using old Tokens#<< interface.'
+        #   @@CODERAY_TOKEN_INTERFACE_DEPRECATION_WARNING_GIVEN = true
+        # end
+        self.token(*token)
+      end
+    end
+  end
+
+  # Add terminal scanner
+  # author: Vincent Landgraf <setcool@gmx.de>
+  # modified by Raul Murciano <raul@murciano.net>
+  # licence: GPLv2.1
+  module Scanners
+
+    class Term < Scanner
+
+      register_for :term
+
+      def scan_tokens(tokens, options)
+        prev = nil
+
+        until eos?
+          line = scan(/.*?(\n|\z)/)
+          if line =~ /\A(\s*\$)/ # command
+            tokens << [$1, :comment] # prompt
+            line = line[($1.size)..-1]
+            if comment_index = line.index('#')
+              command = line[0..comment_index-1]
+              comment = line[comment_index-1..-1]
+              tokens << [command, :method] if command
+              tokens << [comment, :comment] if comment
+            else
+              tokens << [line, :method]
+            end
+          else
+            tokens << [line, :string]
+          end
+          prev = line
+        end
+        return tokens
+      end
+    end
+  end
+end
+
+
+CodeRay::Scanners['java_script'].register_for :nodejs
+
+module Rack
+  class Codehighlighter
+    def coderay(string)
+      lang = 'unknown'
+      refs = @opts[:pattern].match(string)  # extract language name
+      if refs
+        lang = refs[1]
+        str = unescape_html(string.sub(@opts[:pattern], ""))
+        "<pre class='CodeRay' lang='#{lang}'>#{::CodeRay.encoder(:html).encode str, lang}</pre>"
+      else
+        "<pre class='CodeRay' lang='#{lang}'>#{string}</pre>"
+      end
+    end
+  end
+end

data/lib/devcenter/commands.rb

@@ -0,0 +1,4 @@
+require_relative 'commands/base'
+require_relative 'commands/open'
+require_relative 'commands/pull'
+require_relative 'commands/preview'

data/lib/devcenter/commands/base.rb

@@ -0,0 +1,47 @@
+require 'excon'
+require 'launchy'
+require 'json'
+require 'yaml'
+
+module Devcenter::Commands
+
+  class Base
+
+    include Devcenter::Helpers
+
+    def self.run(*args)
+      command = self.new(*args)
+    end
+
+    def initialize(*args)
+      @validation_errors = []
+      validate
+      if @validation_errors.any?
+        @validation_errors.each{ |e| say e }
+      else
+        run
+      end
+    end
+
+    def validate; end # add error messages to @validation_errors
+    def run; end
+
+    protected
+
+    def article_not_found!(slug)
+      message = ["No #{slug} article found."]
+      suggestions = JSON.parse(Excon.get(search_api_url, :query => { :q => slug, :source => 'devcenter-cli' }).body)['devcenter']
+      suggestions.select!{ |s| article_url?(s['full_url']) }
+      suggestions.each{ |s| s['slug'] = slug_from_article_url(s['full_url']) }
+      unless suggestions.empty?
+        message << "Perhaps you meant one of these:"
+        longest = suggestions.map {|suggestion| suggestion['slug'].size }.max
+        suggestions.each do |suggestion|
+          message << "  %-#{longest}s # %s" % [suggestion['slug'], suggestion['title']]
+        end
+      end
+      say message.join("\n")
+      exit
+    end
+  end
+end

data/lib/devcenter/commands/open.rb

@@ -0,0 +1,34 @@
+module Devcenter::Commands
+
+  class Open < Base
+
+    def initialize(*args)
+      @slug = args[0]
+      super
+    end
+
+    def validate
+      unless @slug && !@slug.strip.empty?
+        @validation_errors << 'Please provide a slug (e.g: ps is the slug for https://devcenter.heroku.com/articles/ps)'
+      end
+    end
+
+    def run
+      url = article_url(@slug)
+      head = Excon.head(url)
+      case head.status
+      when 200
+        say("Opening #{@slug} docs")
+        launchy = Launchy.open(url)
+        if launchy.respond_to?(:join)
+          launchy.join
+        end
+      when 301, 302
+        say "Redirected to #{head.headers['Location']}"
+      when 404
+        article_not_found!(@slug)
+      end
+    end
+
+  end
+end

data/lib/devcenter/commands/preview.rb

@@ -0,0 +1,28 @@
+module Devcenter::Commands
+
+  class Preview < Base
+
+    def initialize(*args)
+      @slug = args[0].to_s.gsub(/.md\z/, '') # maybe the user provides the filename by mistake
+      @host = args[1]
+      @port = args[2]
+      @md_path = md_file_path(@slug)
+      super
+    end
+
+    def validate
+      empty_slug = @slug.nil? || @slug.to_s.strip.empty?
+      file_exists = !empty_slug && File.exists?(@md_path)
+      if empty_slug
+        @validation_errors << 'Please provide an article slug'
+      elsif !file_exists
+        @validation_errors << "Can't find #{@md_path} file - you may want to `devcenter pull #{@slug}`"
+      end
+    end
+
+    def run
+      ::Devcenter::Previewer.preview(@slug, @md_path, @host, @port)
+    end
+
+  end
+end

data/lib/devcenter/commands/pull.rb

@@ -0,0 +1,37 @@
+module Devcenter::Commands
+
+  class Pull < Base
+
+    def initialize(*args)
+      @slug = args[0]
+      @force_overwrite = args[1]
+      super
+    end
+
+    def validate
+      unless @slug && !@slug.strip.empty?
+        @validation_errors << 'Please provide a slug (e.g: ps is the slug for https://devcenter.heroku.com/articles/ps)'
+      end
+    end
+
+    def run
+      response = Excon.get(article_api_url(@slug))
+      article_received = response.status == 200 && JSON.parse(response.body)['article'] && JSON.parse(response.body)['article']['id']
+      article_not_found!(@slug) unless article_received
+
+      article = JSON.parse(response.body)['article']
+      metadata = {'title' => article['title'], 'id' => article['id']}
+      file_path = md_file_path(@slug)
+
+      unless @force_overwrite
+        cancel_save = File.exists?(file_path) && !agree("The file #{file_path} already exists - overwrite? (yes/no)")
+        return if cancel_save
+      end
+
+      file_content = [metadata.to_yaml, article['content']].join("\n\n")
+      write_file(file_path, file_content)
+      say "\"#{metadata['title']}\" article saved as #{file_path}"
+    end
+
+  end
+end

data/lib/devcenter/helpers.rb

@@ -0,0 +1,41 @@
+module Devcenter::Helpers
+
+  def devcenter_base_url
+    ENV['DEVCENTER_BASE_URL'] || 'https://devcenter.heroku.com'
+  end
+
+  def article_url(slug)
+    "#{devcenter_base_url}/articles/#{slug}"
+  end
+
+  def article_api_url(slug)
+    "#{article_url(slug)}.json"
+  end
+
+  def search_api_url
+    "#{devcenter_base_url}/articles.json"
+  end
+
+  def article_url?(url)
+    escaped_base_url = devcenter_base_url.gsub('/','\\/')
+    url.match(/\A#{escaped_base_url}\/articles\/.+/)
+    true
+  end
+
+  def slug_from_article_url(url)
+    url.split('/articles/').last
+  end
+
+  def md_file_path(slug)
+    File.expand_path("#{slug}.md")
+  end
+
+  def html_file_path(slug)
+    File.expand_path("#{slug}.html")
+  end
+
+  def write_file(filename, content)
+    File.open(filename, 'w'){ |f| f.write(content) }
+  end
+
+end