devcenter 1.0.7 → 1.1.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: f8cf248735847c0a751bf6947c723d2dcff7245a
-  data.tar.gz: a4c53ace9bb2948333ba95fee47651129b05c5fa
+  metadata.gz: 592c9194f39d3e37bf58ec40370e83df3f157c14
+  data.tar.gz: d2f34c3bdf1ac94219fd567a821e01b98306aeff
 !binary "U0hBNTEy":
-  metadata.gz: 4cc8bf967f1c7c381bf33417f413a95982bd92b6b6985d9d8749f1b22204af885cb117fd23f0be240495e8d4ad9736facd62b8a96191696cd82f70692ea207e8
-  data.tar.gz: a7705b6253fb6dade4c4a0739b941485005557c2ba56029dd0a41c49d0ecae98241f0e60153081aaee9c52ab57e39d222a5225353d5ad1a6b3e065d1b2201650
+  metadata.gz: f7ec004380727c6a826b2a8efab3610b5704734fdbb09054b3419c315eac0aa7fe6d7cf5a8a88078afbf722cfd5b09642edba40325dd4e7988b118ace13e12f2
+  data.tar.gz: 001e0ec246f33908a0632579efb6f55d20905d2a74558ca4bef740a6d514d264fac6c94a70433d7e5618a75139d80082f1c5a5e785124b27a4d73f67e19e9691

data/README.md

@@ -1,4 +1,4 @@
-# Devcenter
+# Dev Center CLI
 
 CLI to interact with Heroku's Dev Center
 
@@ -30,6 +30,12 @@ This will save an `article-slug.md` text file in your local directory. The file
 
 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.
 
+### Update an article in Dev Center from a local file
+
+    $ devcenter push dynos
+
+This will save the title and content from your local article in Dev Center. You'll be asked to authenticate to verify that you have permissions to update the article.
+
 ### Help
 
 Get available commands
@@ -48,4 +54,4 @@ If you have a Dev Center instance, you can point your CLI to it by setting the `
 
 See LICENSE.txt file.
 
-The `preview` command uses the [Font Awesome](http://fontawesome.io/) vector icons, which have their own [License](https://github.com/FortAwesome/Font-Awesome#license).
+The `preview` command uses the [Font Awesome](http://fontawesome.io/) vector icons, which have their own [License](https://github.com/FortAwesome/Font-Awesome#license).

data/lib/devcenter.rb

@@ -4,5 +4,6 @@ require_relative 'devcenter/logger'
 require_relative 'devcenter/helpers'
 require_relative 'devcenter/client'
 require_relative 'devcenter/coderay_extensions'
+require_relative 'devcenter/article_file'
 require_relative 'devcenter/previewer'
 require_relative 'devcenter/cli'

data/lib/devcenter/article_file.rb

@@ -0,0 +1,32 @@
+require 'devcenter-parser'
+
+module Devcenter
+
+  class ArticleFile
+
+    attr_reader :metadata, :html, :content, :parsing_error, :toc
+
+    def initialize(opts = {})
+      @metadata = opts[:metadata] || OpenStruct.new
+      @content = opts[:content] || ''
+      markdown_flavour = @metadata.markdown_flavour || :maruku
+      begin
+        @html = ::DevcenterParser.to_html(@content, markdown_flavour.to_sym)
+      rescue Exception => e
+        @parsing_error = e.to_s
+        @html = ''
+      end
+      @toc = Nokogiri::HTML(@html).search('h2')
+    end
+
+    def self.read(src_path)
+      src = IO.read(src_path)
+      metadata_yaml, content = src.split(/\r*\n\r*\n/, 2)
+      metadata = OpenStruct.new YAML.load(metadata_yaml)
+      markdown_flavour = metadata.markdown_flavour || :maruku
+      new(metadata: metadata, content: content)
+    end
+
+  end
+
+end

data/lib/devcenter/cli.rb

@@ -36,6 +36,19 @@ command :pull do |c|
   end
 end
 
+command :push do |c|
+  c.syntax = 'devcenter push [options]'
+  c.summary = 'Submit the content of a local article to Dev Center'
+  c.description = c.summary
+  c.example 'devcenter push process-model.md', 'Submits the content of the local "process-model.md" file to the article with the "process-model" slug in Dev Center'
+  c.option '--debug', 'Output internal log to help debugging'
+  c.action do |args, options|
+    options.default :debug => false
+    Devcenter::Logger.active = options.debug
+    Devcenter::Commands::Push.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'

data/lib/devcenter/client.rb

@@ -1,22 +1,97 @@
 require 'singleton'
 require 'excon'
+require 'base64'
 
 module Devcenter
 
   module Client
+
+    class Response
+      def initialize(response)
+        @status, @body, @headers = response.status, response.body, response.headers
+      end
+
+      def ok?
+        [200, 201].include?(@status)
+      end
+
+      def redirect?
+        [301, 302].include?(@status)
+      end
+
+      def not_found?
+        @status == 404
+      end
+
+      def access_denied?
+        @status == 401
+      end
+
+      def body
+        JSON.parse(@body)
+      end
+
+      def location
+        @headers['Location']
+      end
+    end
+
     include Devcenter::Helpers
     extend self
 
+    def validate_article(token, article_id, article_params)
+      form = URI.encode_www_form(article_params)
+      auth_request(:post, token, path: validate_article_path(article_id), body: form, :headers => { "Content-Type" => "application/x-www-form-urlencoded" })
+    end
+
+    def update_article(token, article_id, article_params)
+      form = URI.encode_www_form(article_params)
+      auth_request(:put, token, path: update_article_path(article_id), body: form, :headers => { "Content-Type" => "application/x-www-form-urlencoded" })
+    end
+
+    def response(request_call)
+      Response.new request_call
+    end
+
     def head(args)
-      client.head(args)
+      response client.head(args)
     end
 
     def get(args)
-      client.get(args)
+      response client.get(args)
+    end
+
+    def put(args)
+      response client.put(args)
+    end
+
+    def auth_request(method, token, args)
+      args[:headers] ||= {}
+      args[:headers].merge!(default_headers)
+      args[:headers]["Authorization"] = "Basic #{encode64(token)}"
+      response client.send(method, args)
     end
 
     def client
-      @client ||= Excon.new(devcenter_base_url, :headers => { 'User-agent' => 'DevCenterCLI'})
+      @client ||= Excon.new(devcenter_base_url, :headers => default_headers)
+    end
+
+    def default_headers
+      {'User-agent' => 'DevCenterCLI'}
+    end
+
+    def get_oauth_token(email, password)
+      auth = encode64("#{email}:#{password}")
+      response Excon.post('https://api.heroku.com/oauth/authorizations',
+                  headers: {
+                    "Content-Type" => "application/json",
+                    "Accept" => "application/vnd.heroku+json; version=3",
+                    "Authorization" => "Basic #{auth}"
+                })
+    end
+  
+    def encode64(str)
+      Base64.encode64(str).strip
     end
   end
 

data/lib/devcenter/commands.rb

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

data/lib/devcenter/commands/base.rb

@@ -24,6 +24,7 @@ module Devcenter::Commands
       validate
       if @validation_errors.any?
         @validation_errors.each{ |e| say e }
+        abort
       else
         run
       end
@@ -36,7 +37,8 @@ module Devcenter::Commands
 
     def article_not_found!(slug)
       message = ["No #{slug} article found."]
-      suggestions = JSON.parse(Devcenter::Client.get(:path => search_api_path, :query => { :q => slug, :source => 'devcenter-cli' }).body)['devcenter']
+      response = Devcenter::Client.get(:path => search_api_path, :query => { :q => slug, :source => 'devcenter-cli' })
+      suggestions = response.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?
@@ -46,8 +48,7 @@ module Devcenter::Commands
           message << "  %-#{longest}s # %s" % [suggestion['slug'], suggestion['title']]
         end
       end
-      say message.join("\n")
-      exit
+      abort message.join("\n")
     end
 
   end

data/lib/devcenter/commands/open.rb

@@ -16,15 +16,14 @@ module Devcenter::Commands
     def run
       path = article_path(@slug)
       log "Connecting to #{path}"
-      head = Devcenter::Client.head(:path => path)
-      case head.status
-      when 200
+      response = Devcenter::Client.head(:path => path)
+      if response.ok?
         log "Page found, opening"
         launchy = Launchy.open(devcenter_base_url + path)
         launchy.join if launchy.respond_to?(:join)
-      when 301, 302
-        say "Redirected to #{head.headers['Location']}"
-      when 404
+      elsif response.redirect?
+        abort "Redirected to #{response.location}"
+      elsif response.not_found?
         article_not_found!(@slug)
       end
     end

data/lib/devcenter/commands/pull.rb

@@ -16,10 +16,10 @@ module Devcenter::Commands
 
     def run
       response = Devcenter::Client.get(path: article_api_path(@slug))
-      article_received = response.status == 200 && JSON.parse(response.body)['article'] && JSON.parse(response.body)['article']['id']
+      article_received = response.ok? && response.body['article'] && response.body['article']['id']
       article_not_found!(@slug) unless article_received
 
-      article = JSON.parse(response.body)['article']
+      article = response.body['article']
       metadata = {'title' => article['title'], 'id' => article['id'], 'markdown_flavour' => article['markdown_flavour']}
       file_path = md_file_path(@slug)
 

data/lib/devcenter/commands/push.rb

@@ -0,0 +1,74 @@
+module Devcenter::Commands
+
+  class Push < Base
+
+    def initialize(*args)
+      @slug = args[0].to_s.gsub(/.md\z/, '') # maybe the user provides the filename by mistake
+      @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
+      @article = ::Devcenter::ArticleFile.read(@md_path)
+      if @article.parsing_error
+        abort "The content of #{@md_path} can't be parsed properly, fix it and try again."
+      end
+      say 'Authenticate with your Heroku account:'
+      email = ask('Email:    ')
+      password = ask('Password: ') { |q| q.echo = '*' }
+      response = Devcenter::Client.get_oauth_token(email, password)
+      if response.access_denied?
+        abort "Authentication error: bad credentials. Please try again."
+      elsif response.ok?
+        token = response.body['access_token']['token']
+        push_article(token) if validate_article(token)
+      else
+        abort "Authentication error: #{response.body['message']}"
+      end 
+    end
+
+    def validate_article(token)
+      article_id = @article.metadata.id
+      article_params = {
+        'article[content]' => @article.content,
+        'article[title]' => @article.metadata.title,
+        'article[parser]' => @article.metadata.parser || @article.metadata.markdown_flavour
+      }
+      response = Devcenter::Client.validate_article(token, article_id, article_params)
+      errors = response.body
+      if errors.any?
+        say "The article \"#{@slug}\" is not valid:"
+        abort errors.to_yaml.gsub(/\A(\-+)\n-/, '')
+      else
+        say "The article \"#{@slug}\" is valid."
+      end
+      errors.empty?
+    end
+
+    def push_article(token)
+      article_id = @article.metadata.id
+      article_params = {
+        'article[content]' => @article.content,
+        'article[title]' => @article.metadata.title,
+        'article[parser]' => @article.metadata.parser || @article.metadata.markdown_flavour
+      }
+      response = Devcenter::Client.update_article(token, article_id, article_params)
+      if response.ok?
+        say "\"#{@slug}\" pushed successfully."
+      else
+        error = response.body['error']
+        abort "Error pushing \"#{@slug}\": #{error}"
+      end
+    end
+  end
+end

data/lib/devcenter/helpers.rb

@@ -16,6 +16,14 @@ module Devcenter::Helpers
     "/articles.json"
   end
 
+  def validate_article_path(id)
+    "/api/v1/private/articles/#{id}/validate.json"
+  end
+
+  def update_article_path(id)
+    "/api/v1/private/articles/#{id}.json"
+  end
+
   def article_url?(url)
     escaped_base_url = devcenter_base_url.gsub('/','\\/')
     url.match(/\A#{escaped_base_url}\/articles\/.+/)

data/lib/devcenter/previewer/views/article.erb

@@ -1,6 +1,6 @@
 <section class="main">
 
-  <article class="article autolink <% 'contributed' if @article.external_owner? %>">
+  <article class="article autolink">
 
     <header>
       <h1 class="doc"><%= @article.metadata.title %></h1>
@@ -23,24 +23,14 @@
         </section>
 
         <%= @article.html %>
-      <% elsif @article.error %>
+      <% elsif @article.parsing_error %>
       <div class="cli-preview-error">
         <h4>Parsing error:</h4>
         <p>
-          <%= @article.error %>
+          <%= @article.parsing_error %>
         </p>
       </div>
       <% end %>
-
-      <form class="cli-save" action="<%= devcenter_base_url %>/admin/articles/cli-edit/<%= @article.metadata.id %>" method="POST">
-        <input name="_method" type="hidden" value="put">
-        <input type="hidden" name="article[title]" value="<%= @article.metadata.title %>">
-        <input type="hidden" name="article[markdown_flavour]" value="<%= @article.metadata.markdown_flavour %>">
-        <textarea style="display:none" name="article[content]">
-<%= CGI.escapeHTML(@article.content.to_s.lstrip) %>
-        </textarea>
-        <input type="submit" value="Save in Dev Center">
-      </form>
     </div>
 
   </article>

data/lib/devcenter/previewer/web_app.rb

@@ -1,6 +1,5 @@
 require 'sinatra'
 require 'rack/highlighter'
-require 'devcenter-parser'
 
 module Devcenter::Previewer
 
@@ -51,8 +50,7 @@ module Devcenter::Previewer
       src_path = File.join(Dir.pwd, "#{params[:slug]}.md")
       if File.exists?(src_path)
         log "Parsing"
-        @article = parse_article(src_path)
-        @article.toc = Nokogiri::HTML(@article.html).search('h2')
+        @article = Devcenter::ArticleFile.read(src_path)
         @page_title = @article.metadata.title
         log "Serving"
         erb :article
@@ -63,20 +61,6 @@ module Devcenter::Previewer
       end
     end
 
-    def parse_article(src_path)
-      article = OpenStruct.new
-      src = IO.read(src_path)
-      metadata_yaml, article.content = src.split(/\r*\n\r*\n/, 2)
-      article.metadata = OpenStruct.new YAML.load(metadata_yaml)
-      markdown_flavour = article.metadata.markdown_flavour || :maruku
-      begin
-        article.html = ::DevcenterParser.to_html(article.content, markdown_flavour.to_sym)
-      rescue Exception => e
-        article.error = e.to_s
-      end
-      article
-    end
-
     def self.send_server_event
       Devcenter::Logger.log "Serving server side event to #{settings.connections.size} connections"
       settings.connections.each do |conn|

data/lib/devcenter/version.rb

@@ -1,3 +1,3 @@
 module Devcenter
-  VERSION = "1.0.7"
+  VERSION = "1.1.0rc1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devcenter
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0rc1
 platform: ruby
 authors:
 - Raul Murciano
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -210,6 +210,7 @@ files:
 - bin/devcenter
 - devcenter.gemspec
 - lib/devcenter.rb
+- lib/devcenter/article_file.rb
 - lib/devcenter/cli.rb
 - lib/devcenter/client.rb
 - lib/devcenter/coderay_extensions.rb
@@ -218,6 +219,7 @@ files:
 - lib/devcenter/commands/open.rb
 - lib/devcenter/commands/preview.rb
 - lib/devcenter/commands/pull.rb
+- lib/devcenter/commands/push.rb
 - lib/devcenter/gem_version_checker.rb
 - lib/devcenter/helpers.rb
 - lib/devcenter/logger.rb
@@ -293,9 +295,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3