cheatr 0.0.1

data/lib/cheatr/client/sheet.rb

@@ -0,0 +1,137 @@
+require "rest_client"
+
+module Cheatr::Client
+  class Sheet
+
+    attr_reader :name, :contents
+    attr_reader :errors, :uri, :cache_file
+
+    def self.all(query = nil)
+      RestClient.get "http://#{Cheatr::Client.server}/#{query}"
+    end
+
+    def initialize(name, opts = {})
+      raise "Sheet name '#{name}' is not valid" unless name =~ Cheatr::SHEET_NAME_REGEXP
+      @name = name
+      @cache_file = File.join(Cheatr::Client.cache_dir, "#{name}.md")
+      @uri = "http://#{Cheatr::Client.server}/#{name}"
+      fetch(opts)
+    end
+
+    #
+    # Sets new contents to be saved.
+    #
+    def contents=(new_contents)
+      if new_contents != contents
+        @old_contents = contents
+        @contents = new_contents
+      end
+      new_contents
+    end
+
+    #
+    # Returns true if the contents were last fetched from the remote server,
+    # false if fetched from cache.
+    #
+    def remote?
+      @remote == true
+    end
+
+    #
+    # Returns true if the contents have been modified and need to be saved,
+    # false otherwise.
+    #
+    def changed?
+      @old_contents != @contents
+    end
+
+    #
+    # Saves the contents if changed.
+    #
+    # Cache is updated if saving to remote server was successful.
+    #
+    # Returns true if successful, false otherwise.
+    #
+    def save
+      return false if contents.nil?
+      if changed? && save_remote
+        # Re-fetch because the server may modify contents on saving.
+        # Cached version will be saved during re-fetching below.
+        fetch(ignore_cache: true)
+      end
+      !changed?
+    end
+
+    #
+    # Fetches the contents, either from cache if available, or from the remote
+    # server.
+    #
+    # If ignore_cache is true, the cache is ignored, and contents are updated
+    # from the remote server.
+    #
+    # If contents are fetched from the remote server, the cache is updated.
+    # Returns true if successful, false otherwise.
+    #
+    def fetch(opts = {})
+      fetched = opts[:ignore_cache] ? nil : fetch_cache
+      fetched ||= fetch_remote
+      if fetched
+        @contents = fetched
+        @old_contents = @contents
+        save_cache if remote?
+      end
+      !!fetched
+    end
+
+    private
+
+    #
+    # Saves contents to the cache file.
+    #
+    def save_cache
+      File.open(cache_file, 'w') { |f| f.write(contents) } unless contents.nil?
+    end
+
+    #
+    # Returns the cached contents, or nil.
+    #
+    def fetch_cache
+      @remote = false
+      File.read(cache_file) rescue nil
+    end
+
+    #
+    # Saves the contents to remote server.
+    #
+    # Returns true if successful, false otherwise.
+    #
+    def save_remote
+      RestClient.put uri, contents
+      @errors = nil
+      true
+    rescue RestClient::BadRequest => e
+      @errors = e.response.body.strip.split("\n")
+      false
+    rescue Errno::ECONNREFUSED => e
+      @errors = ["Could not connect to server (#{e.message})"]
+      false
+    end
+
+    #
+    # Fetches contents from remote server.
+    #
+    # Returns the contents, or nil if unsuccessful.
+    #
+    def fetch_remote
+      @remote = true
+      RestClient.get uri
+    rescue RestClient::ResourceNotFound
+      @errors = ["Sheet '#{name}' does not exist."]
+      nil
+    rescue Errno::ECONNREFUSED => e
+      @errors = ["Could not connect to server (#{e.message})"]
+      nil
+    end
+
+  end
+end

data/lib/cheatr/error.rb

@@ -0,0 +1,7 @@
+module Cheatr
+  class Error < StandardError
+    def initialize(message)
+      super(message)
+    end
+  end
+end

data/lib/cheatr/server.rb

@@ -0,0 +1,22 @@
+
+module Cheatr
+  module Server
+    autoload :Sheet, "cheatr/server/sheet"
+    autoload :App, "cheatr/server/app"
+
+    def self.run(repository, opts = {})
+      @@config = @@config.merge(opts.to_hash)
+      Sheet.repository = File.expand_path(repository)
+      puts "Serving cheatr repository at #{Sheet.repository}"
+      App.run!
+    rescue Cheatr::Error => e
+      puts "Error: #{e.message}"
+    end
+
+    @@config = {}
+
+    def self.config
+      @@config
+    end
+  end
+end

data/lib/cheatr/server/app.rb

@@ -0,0 +1,80 @@
+require 'erb'
+require 'redcarpet'
+require 'sinatra/base'
+require 'cheatr/server/sheet'
+require 'cheatr/server/helpers'
+
+module Cheatr::Server
+  class App < Sinatra::Base
+    include Helpers
+
+    # Routes
+
+    get '/' do
+      @title = 'Cheat sheets'
+      @sheets = Sheet.all
+      template :index
+    end
+
+    get '/:name' do |name|
+      if query? name
+        @sheets = Sheet.all(name)
+        @title = "Cheat sheets matching '#{name}'"
+        template :index
+      else
+        @sheet = Sheet.find!(name)
+        @title = @sheet.human_name
+        template :sheet
+      end
+    end
+
+    put '/:name' do |name|
+      @sheet = Sheet.new(name)
+      @sheet.contents = request.body.read
+      if @sheet.save
+        text "Sheet #{name} updated successfully"
+      else
+        text @sheet.errors.full_messages, status: 400
+      end
+    end
+
+    # Configuration
+
+    def self.base_path(append = nil)
+      append ? File.join(path, append) : path
+    end
+
+    configure do
+      set :app_file, __FILE__
+      set :base_path, File.dirname(__FILE__)
+      set :views, File.join(settings.base_path, 'views')
+      set :public_folder, File.join(settings.base_path, 'public')
+      Cheatr::Server.config.each_pair do |option, value|
+        set option.to_sym, value
+      end
+    end
+
+    configure :production, :development do
+      enable :logging
+    end
+
+    configure :development do
+      enable :logging, :dump_errors, :raise_errors
+    end
+
+    configure :production do
+      set :raise_errors, false
+      set :show_exceptions, false
+    end
+
+    error do
+      status 500
+      template :error
+    end
+
+    not_found do
+      send_file File.join(settings.public_folder, '404.html'), status: 404
+    end
+
+  end
+end

data/lib/cheatr/server/helpers.rb

@@ -0,0 +1,47 @@
+module Cheatr::Server
+  module Helpers
+    def query?(name)
+      name.include? '*'
+    end
+
+    def html?
+      request.accept? 'text/html'
+    end
+
+    def default_content_type
+      html? ? 'text/html' : 'text/markdown'
+    end
+
+    #
+    # Processes the given text as markdown, additionally processing cheatr links as well.
+    #
+    def md(text)
+      markdown text.
+        gsub(/{{([a-z]+([\.\-\_][a-z]+)*)}}/, '[\1](/\1)').             # {{name}}           -> [name](/name)
+        gsub(/{{([^\|}]+)\|([a-z]+([\.\-\_][a-z]+)*)}}/, '[\1](/\2)').  # {{link text|name}} -> [link text](/name)
+        to_s
+    end
+
+    def text(output, opts = {})
+      content_type 'text/plain'
+      status opts[:status] if opts[:status]
+      if output.is_a?(Array)
+        output = output.map { |s| "#{s}\n" }
+      end
+      logger.info output
+      output
+    end
+
+    def template(name, opts = {})
+      status opts[:status] if opts[:status]
+      content_type opts[:content_type] || default_content_type
+      logger.info "Rendering template #{name}"
+      output = erb :"#{name}.md", layout: false
+      if html?
+        erb md(output), layout: :"layout.html"
+      else
+        output
+      end
+    end
+  end
+end

data/lib/cheatr/server/public/404.html

@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <title>Page Not Found :( - Cheatr</title>
+        <style>
+            ::-moz-selection {
+                background: #b3d4fc;
+                text-shadow: none;
+            }
+
+            ::selection {
+                background: #b3d4fc;
+                text-shadow: none;
+            }
+
+            html {
+                padding: 30px 10px;
+                font-size: 20px;
+                line-height: 1.4;
+                color: #737373;
+                background: #f0f0f0;
+                -webkit-text-size-adjust: 100%;
+                -ms-text-size-adjust: 100%;
+            }
+
+            html,
+            input {
+                font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+            }
+
+            body {
+                max-width: 500px;
+                _width: 500px;
+                padding: 30px 20px 50px;
+                border: 1px solid #b3b3b3;
+                border-radius: 4px;
+                margin: 0 auto;
+                box-shadow: 0 1px 10px #a7a7a7, inset 0 1px 0 #fff;
+                background: #fcfcfc;
+            }
+
+            h1 {
+                margin: 0 10px;
+                font-size: 50px;
+                text-align: center;
+            }
+
+            h1 span {
+                color: #bbb;
+            }
+
+            h3 {
+                margin: 1.5em 0 0.5em;
+            }
+
+            p {
+                margin: 1em 0;
+            }
+
+            ul {
+                padding: 0 0 0 40px;
+                margin: 1em 0;
+            }
+
+            .container {
+                max-width: 380px;
+                _width: 380px;
+                margin: 0 auto;
+            }
+
+            /* google search */
+
+            #goog-fixurl ul {
+                list-style: none;
+                padding: 0;
+                margin: 0;
+            }
+
+            #goog-fixurl form {
+                margin: 0;
+            }
+
+            #goog-wm-qt,
+            #goog-wm-sb {
+                border: 1px solid #bbb;
+                font-size: 16px;
+                line-height: normal;
+                vertical-align: top;
+                color: #444;
+                border-radius: 2px;
+            }
+
+            #goog-wm-qt {
+                width: 220px;
+                height: 20px;
+                padding: 5px;
+                margin: 5px 10px 0 0;
+                box-shadow: inset 0 1px 1px #ccc;
+            }
+
+            #goog-wm-sb {
+                display: inline-block;
+                height: 32px;
+                padding: 0 10px;
+                margin: 5px 0 0;
+                white-space: nowrap;
+                cursor: pointer;
+                background-color: #f5f5f5;
+                background-image: -webkit-linear-gradient(rgba(255,255,255,0), #f1f1f1);
+                background-image: -moz-linear-gradient(rgba(255,255,255,0), #f1f1f1);
+                background-image: -ms-linear-gradient(rgba(255,255,255,0), #f1f1f1);
+                background-image: -o-linear-gradient(rgba(255,255,255,0), #f1f1f1);
+                -webkit-appearance: none;
+                -moz-appearance: none;
+                appearance: none;
+                *overflow: visible;
+                *display: inline;
+                *zoom: 1;
+            }
+
+            #goog-wm-sb:hover,
+            #goog-wm-sb:focus {
+                border-color: #aaa;
+                box-shadow: 0 1px 1px rgba(0, 0, 0, 0.1);
+                background-color: #f8f8f8;
+            }
+
+            #goog-wm-qt:hover,
+            #goog-wm-qt:focus {
+                border-color: #105cb6;
+                outline: 0;
+                color: #222;
+            }
+
+            input::-moz-focus-inner {
+                padding: 0;
+                border: 0;
+            }
+        </style>
+    </head>
+    <body>
+        <div class="container">
+            <h1>Not found <span>:(</span></h1>
+            <p>Sorry, but the page you were trying to view does not exist.</p>
+            <p>It looks like this was the result of either:</p>
+            <ul>
+                <li>a mistyped address</li>
+                <li>an out-of-date link</li>
+            </ul>
+            <script>
+                var GOOG_FIXURL_LANG = (navigator.language || '').slice(0,2),GOOG_FIXURL_SITE = location.host;
+            </script>
+            <script src="//linkhelp.clients.google.com/tbproxy/lh/wm/fixurl.js"></script>
+        </div>
+    </body>
+</html>