zendesk_api 0.1.11 → 0.2.1

data/lib/zendesk_api/server/helper.rb

@@ -0,0 +1,104 @@
+module ZendeskAPI::Server
+  module Helper
+    def full_url
+      [params["url"], @path].compact.join("/")
+    end
+
+    def coerce_path(path)
+      if path =~ %r{(https?://)?(\w+)(\.zendesk\.com)?(/api/v2)?/(.*)}
+        if $1 == "http://"
+          @error = "Please enter a valid https URL"
+          path
+        elsif !$2 || $2.empty?
+          @error = "Please enter a valid subdomain"
+          path
+        else
+          params["url"] = "https://#{$2}.zendesk.com/api/v2"
+          $5
+        end
+      else
+        @error = "Please enter a valid URL"
+        path
+      end
+    end
+
+    def execute_request
+      unless @method && client.connection.respond_to?(@method)
+        @error = "The input you entered was invalid"
+        return
+      end
+
+      begin
+        response = client.connection.send(@method, @path) do |request|
+          request.params = @url_params.inject({}) do |accum, h|
+            accum.merge(h["name"] => h["value"])
+          end
+
+          if @method != :get && @json && !@json.empty?
+            request.body = JSON.parse(@json)
+          end
+
+          set_request(request.to_env(client.connection))
+        end
+      rescue Faraday::Error::ConnectionFailed => e
+        @error = "The connection failed"
+      rescue Faraday::Error::ClientError => e
+        set_response(e.response) if e.response
+      rescue JSON::ParserError
+        @error = "The JSON you attempted to send was invalid"
+      rescue URI::InvalidURIError, ArgumentError
+        @error = "Please enter a valid URL"
+      else
+        set_response(:body => response.body,
+          :headers => response.env[:response_headers],
+          :status => response.env[:status])
+      end
+    end
+
+    def map_headers(headers)
+      headers.map do |k,v|
+        name = k.split("-").map(&:capitalize).join("-")
+        "#{name}: #{v}"
+      end.join("\n")
+    end
+
+    def set_request(request)
+      @html_request = <<-END
+HTTP/1.1 #{@method.to_s.upcase} #{request[:url]}
+#{map_headers(request[:request_headers])}
+      END
+
+      request_headers = request[:request_headers].dup
+      request_headers.delete("Authorization")
+
+      @user_request_hash = { :url => request[:url].to_s, :request_headers => request_headers }
+
+      if @method != :get && @json && !@json.empty?
+        parsed_json = CodeRay.scan(@json, :json).span
+        @html_request << "\n\n#{parsed_json}"
+      end
+    end
+
+    def set_response(response)
+      @html_response =<<-END
+HTTP/1.1 #{response[:status]}
+#{map_headers(response[:headers])}
+
+
+#{CodeRay.scan(JSON.pretty_generate(response[:body]), :json).span}
+      END
+
+      @user_response_hash = { :status => response[:status], :headers => response[:headers], :body => response[:body] }
+    end
+
+    def client(params = params)
+      @client ||= ZendeskAPI::Client.new do |c|
+        params.each do |key, value|
+          c.send("#{key}=", value)
+        end
+
+        c.allow_http = App.development?
+      end
+    end
+  end
+end

data/lib/zendesk_api/server/html_renderer.rb

@@ -0,0 +1,98 @@
+# Modified from DoubleDoc
+# https://github.com/staugaard/double_doc/blob/master/lib/double_doc/html_renderer.rb
+module ZendeskAPI::Server
+  class HtmlRenderer
+    def self.markdown
+      @markdown ||= Redcarpet::Markdown.new(RedcarpetRenderer, :fenced_code_blocks => true, :no_intra_emphasis => true, :tables => true)
+    end
+
+    def self.render(text)
+      markdown.render(text)
+    end
+
+    def self.generate_id(text)
+      text.strip.downcase.gsub(/[\s,]+/, '-')
+    end
+
+    class RedcarpetRenderer < Redcarpet::Render::HTML
+      attr_reader :headers
+
+      def icons
+        <<-END
+          <i class=\"header-icon icon-plus\"></i>
+          <i class=\"header-icon icon-minus hide\"></i>
+        END
+      end
+
+      def header(text, level)
+        top_level = [2, 3].include?(level)
+        id = HtmlRenderer.generate_id(text)
+
+        @headers ||= []
+        @headers << id if top_level
+
+        "<h#{level} id=\"#{id}\">
+          #{icons if top_level}
+          #{text}
+        </h#{level}>"
+      end
+
+      def block_code(code, language)
+        # CodeRay doesn't know HTTP
+        language = "json" if language == "http"
+
+        mod = {}
+
+        json = nil
+
+        if language
+          if code.start_with?("curl")
+            if code =~ %r[(https://{subdomain}.zendesk.com/api/v2/.*.json(\?(\w+={.+})+ )?)]
+              example = true
+
+              mod["class"] = "example"
+              mod["data-url"] = $1.strip
+
+              # This grabs the -d parameter
+              # ...
+              if code.include?(" -d ")
+                str_begin = code.index(/['"]/, code.index(" -d "))
+
+                chars = code[str_begin..-1].chars.to_a
+                str_end = nil
+
+                chars[1..-1].each_with_index do |char, i|
+                  if char == chars[0] && chars[i - 1] != "\\"
+                    str_end = i
+                    break
+                  end
+                end
+
+                mod["data-json"] = code.slice(str_begin + 1..(str_begin + str_end)) if str_end
+              end
+
+              if code =~ /-X (PUT|POST|GET|DELETE)/
+                mod["data-method"] = $1
+              end
+            end
+          end
+
+          code = CodeRay.scan(code, language).html(:wrap => nil)
+        end
+
+        mod = mod.inject([]) {|str,(k,v)| str.push("#{k}='#{v}'")}.join(" ")
+
+        if example
+          <<-END
+            <button class="btn example" title="Fill in the form with this example">
+              <i class="icon icon-pencil"></i>
+            </button>
+            <pre #{mod}>#{code}</pre>
+          END
+        else
+          "<pre>#{code}</pre>"
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_api/server/models/user_request.rb

@@ -0,0 +1,16 @@
+require 'zendesk_api/server/models/zlib_json'
+
+module ZendeskAPI::Server
+  class UserRequest
+    include Mongoid::Document
+
+    field :method, :type => Symbol
+    field :url, :type => String
+    field :path, :type => String
+    field :json, :type => String
+    field :url_params, :type => Array
+
+    field :request, :type => ZlibJSON
+    field :response, :type => ZlibJSON
+  end
+end

data/lib/zendesk_api/server/models/zlib_json.rb

@@ -0,0 +1,13 @@
+module ZendeskAPI::Server
+  class ZlibJSON < Hash
+    class << self
+      def demongoize(serialized_object)
+        JSON.parse(Zlib.inflate(serialized_object.to_s)).symbolize_keys
+      end
+
+      def mongoize(input_hash)
+        Moped::BSON::Binary.new(:generic, Zlib.deflate(input_hash.to_json))
+      end
+    end
+  end
+end

data/lib/zendesk_api/server/public/config.rb

@@ -0,0 +1,26 @@
+require 'bootstrap-sass'
+# Require any additional compass plugins here.
+
+
+# Set this to the root of your project when deployed:
+http_path = "/"
+css_dir = "stylesheets"
+sass_dir = "sass"
+images_dir = "images"
+javascripts_dir = "javascripts"
+
+# You can select your preferred output style here (can be overridden via the command line):
+# output_style = :expanded or :nested or :compact or :compressed
+
+# To enable relative paths to assets via compass helper functions. Uncomment:
+# relative_assets = true
+
+# To disable debugging comments that display the original location of your selectors. Uncomment:
+# line_comments = false
+
+
+# If you prefer the indented syntax, you might want to regenerate this
+# project again passing --syntax sass, or you can uncomment this:
+# preferred_syntax = :sass
+# and then run:
+# sass-convert -R --from scss --to sass sass scss && rm -rf sass && mv scss sass

data/lib/zendesk_api/server/public/javascripts/application.js

@@ -0,0 +1,186 @@
+function search(query) {
+  query = query.split("#");
+
+  $.post("/search", { query: query[0] }, function(data) {
+    $("#search-results").html(data);
+
+    $("#search-results h2, h3").nextUntil("h3").addClass("hide");
+    $("#search-results h2, h3").children("i.icon-minus").addClass("hide");
+    $("#search-results h2, h3").children("i.icon-plus").removeClass("hide");
+
+    if(query[1]) {
+      var header = $("#search-results #" + query[1]);
+
+      if(header.children("i.icon-minus").hasClass("hide"))
+        header.click();
+
+      // document.getElementById(query[1]).scrollIntoView(true);
+    }
+  }).error(function() {
+    // TODO
+  });
+}
+
+function toggle_json_editor() {
+  var method = $("#method-select option:selected").val();
+  $("#json").toggle(method == "POST" || method == "PUT");
+}
+
+$(document).ready(function() {
+  var dirty = false;
+
+  $('#search input').keyup(function() {
+    var value = $(this).val();
+    dirty = value != "";
+
+    setTimeout(function() {
+      if(dirty) {
+        dirty = false;
+        search($('#search input').val());
+      }
+    }, 750);
+  });
+
+  $('#clear-search').click(function() {
+    $('#search input').val("");
+    search("help");
+  });
+
+  $("#search-results h2, h3").nextUntil("h3").addClass("hide");
+
+  $("#search-results h2, h3").live("click", function() {
+    $(this).nextUntil("h3").toggleClass("hide");
+    $(this).children().toggleClass("hide");
+
+    query = $('#search input').val();
+    query = query.split("#");
+    $('#search input').val(query[0] + "#" + this.id);
+  });
+
+  $("#search-results a").live("click", function(event) {
+    event.preventDefault();
+
+    query = $(this).attr("href");
+    query = query.replace(/\.(html|md)/, "");
+
+    $('#search input').val(query);
+
+    search(query);
+  });
+
+  if(window.location.hash == "#response" || window.location.hash == "#request") {
+    $('#response .tab').addClass('hide');
+    $('#response ul.nav-pills li').removeClass('active');
+
+    var tab = window.location.hash + "-tab";
+    $(tab).removeClass("hide");
+    $(tab + "-link").parent('li').addClass('active');
+  } else if(window.location.hash == "#documentation") {
+    $('.frame.tab').addClass('hide');
+    $('#navigation ul.nav-pills li').removeClass('active');
+
+    $('#help-tab').removeClass('hide');
+    $('#help-tab-link').parent("li").addClass('active');
+  }
+
+  $('#response .tab-link').click(function() {
+    var elem = $(this);
+
+    $('#response .tab').addClass("hide");
+    $('#response ul.nav-pills li').removeClass('active');
+
+    $('#' + this.id.replace(/-link/, '')).removeClass("hide");
+    elem.parent('li').addClass('active');
+
+    event.preventDefault();
+  });
+
+  $('#possible-params').click(function(event) {
+    $(this).children('i').toggleClass('hide');
+    $('#possible-params-text').toggleClass('hide');
+
+    event.preventDefault();
+  });
+
+  $('#navigation .tab-link').click(function() {
+    var elem = $(this);
+
+    $('.frame.tab').addClass("hide");
+    $('#navigation ul.nav-pills li').removeClass('active');
+
+    $('#' + this.id.replace(/-link/, '')).removeClass("hide");
+    elem.parent('li').addClass('active');
+  });
+
+  $('#json').keydown(function() {
+    $('#input p.error').html('');
+  });
+
+  $('#json').keyup(function() {
+    var value = $('#json').val();
+
+    $('#json').removeClass('invalid');
+
+    if(value == '') {
+      $('#json').removeClass('invalid', 'valid');
+      return;
+    }
+
+    try {
+      JSON.parse(value);
+      $('#json').addClass('valid');
+    } catch(e) {
+      $('#json').addClass('invalid');
+    }
+  });
+
+  $('button.example').live("click", function() {
+    var element = $(this).next();
+
+    var url = element.data("url");
+    url = url.split("?");
+
+    $("#path").val(url[0]);
+
+    if(url[1]) {
+      var params = url[1].split("&");
+      var param, inputs;
+
+      for(var i = 0; i < params.length; i++) {
+        param = params[i].split("=");
+        $("#add-param").click();
+        inputs = $("#params div:last input");
+
+        if(inputs.length == 2) {
+          $(inputs[0]).val(param[0]);
+          $(inputs[1]).val(param[1]);
+        }
+      }
+    }
+
+
+    var method = element.data("method") || "GET";
+
+    $("#method-select").val(method);
+    $("#method-select").trigger("change");
+
+    var json = element.data("json");
+
+    if(json) {
+      $("#json").val(JSON.stringify(json));
+    } else {
+      $("#json").val("");
+    }
+
+    window.location.hash = "";
+    $("#throw-tab-link").click();
+  });
+
+  $("#method-select").change(toggle_json_editor);
+  toggle_json_editor();
+
+  $(".remove-param").live("click", function(event) {
+    event.preventDefault();
+    $(this).parent("div").remove();
+  });
+});