Add dynamic tokens to docs

Author: mthurman

content/docs/guides/create-a-post.md

@@ -21,7 +21,7 @@ Using [adnpy](/docs/libraries#python)
 import adnpy
 
 # Set the default access token for API calls.
-adnpy.api.add_authorization_token('your access token here')
+adnpy.api.add_authorization_token('<YOUR ACCESS TOKEN>')
 
 # Create a post
 post = adnpy.api.create_post(data={'text':'Hello App.net from Python!'})
@@ -32,7 +32,7 @@ Or with the [adn](/docs/libraries#ruby) Ruby gem:
 ~~~ ruby
 require 'adn'
 
-ADN.token = 'your access token here'
+ADN.token = '<YOUR ACCESS TOKEN>'
 post = ADN::Post.send_post(:text => "Hello App.net from Ruby!")
 ~~~
 

content/docs/guides/send-a-broadcast.md

@@ -31,7 +31,7 @@ Once you've installed the ADNPy library, it's as simple as:
 import adnpy
 
 # Set the default access token for API calls.
-adnpy.api.add_authorization_token('your access token here')
+adnpy.api.add_authorization_token('<YOUR ACCESS TOKEN>')
 
 # Send a broadcast with the BroadcastMessageBuilder recipe.
 builder = adnpy.recipes.BroadcastMessageBuilder(adnpy.api)
@@ -54,7 +54,7 @@ Or with the [adn](https://github.com/adn-rb/adn) Ruby gem:
 ~~~ ruby
 require 'adn'
 
-ADN.token = 'your access token here'
+ADN.token = '<YOUR ACCESS TOKEN>'
 
 builder = ADN::Recipes::BroadcastMessageBuilder.new
 builder.channel_id = 24204

content/reference/authentication/index.md

@@ -91,32 +91,31 @@ All requests to the API—authenticated or not—must be made over HTTPS.
 
 When making a call to one of our API resources, there are three ways to include authentication information.
 
-> In all of these examples, `[access token]` is the user's access token, free of any JSON framing or query string parameters.
+> In all of these examples, `<YOUR ACCESS TOKEN>` is the user's access token, free of any JSON framing or query string parameters.
 
 * Adding an Authorization header (**preferred**)
 
     Add the following header to your request:
-    `Authorization: Bearer [access token]`
-    where `[access token]` is the value of the user's access token.
+    `Authorization: Bearer <YOUR ACCESS TOKEN>`
+    where `<YOUR ACCESS TOKEN>` is the value of the user's access token.
 
     Here's an example:
 
     <%= curl_example(:post, "posts", :none, {
         :data => {"text" => "Test post"},
         :content_type => nil,
-        :token => "[access token]"
     }) %>
 
 * Add `access_token` to query string
 
-    <%= curl_example(:get, "posts/1?access_token=[access token]", :none, {:data => "text=Test post", :content_type => nil, :token => nil}) %>
+    <%= curl_example(:get, "posts/1?access_token=<YOUR ACCESS TOKEN>", :none, {:data => "text=Test post", :content_type => nil, :token => nil}) %>
 
 * Add `access_token` to HTTP body. 
 
     > Note: this method will only work with the `PUT`, `POST`, and `PATCH` methods. `GET` and `DELETE` do not accept an HTTP body.
 
     <%= curl_example(:post, "posts", :none, {
-        :data => {"text" => "Test post", "access_token" => "[access token]"},
+        :data => {"text" => "Test post", "access_token" => "<YOUR ACCESS TOKEN>"},
         :content_type => nil,
         :token => nil
     }) %>

layouts/default.html

@@ -48,7 +48,9 @@
     </div>
 
     <script type="text/javascript" src="/assets/js/jquery-1.8.3.min.js"></script>
+    <script type="text/javascript" src="/assets/js/purl.js"></script>
     <script type="text/javascript" src="/assets/js/bootstrap.js"></script>
+    <script type="text/javascript" src="/assets/js/app.js"></script>
     <script type="text/javascript">
       ADN.write_extra_js();
     </script>

lib/helpers.rb

@@ -72,6 +72,27 @@ def local_hostname()
     ENV['LOCAL_HOSTNAME'] || 'localhost'
 end
 
+def login_url(text)
+    base_domain = "https://account.app.net"
+    scopes = ["basic"]
+    client_id = "gvfM7pVsPBAkVmFWeCDF22uLTyTuMzdd"
+    redirect_uri = "<script>document.write(window.location);</script>"
+    path = "/oauth/authenticate?response_type=token"
+
+    url = "#{base_domain}#{path}&scope=#{scopes.join(' ')}&client_id=#{client_id}&redirect_uri="
+    link = "\"<a href='#{url}\" + window.location + \"'>#{text}</a>\""
+
+    "<script>document.write(#{link})</script>"
+end
+
+def access_token_banner()
+    login_url = login_url("Authorize the App.net docs")
+    "<div class=\"alert alert-success alert-block authorize-prompt hide\">
+    #{login_url} to see more complete examples.
+    </div>
+    "
+end
+
 def curl_example(method, path, response_key, options = {}, &block)
     # things left to figure out
     # - some quoting/escaping stuff
@@ -109,9 +130,7 @@ def curl_example(method, path, response_key, options = {}, &block)
             paginated_response(response_key, &block)
         when :raw
             options[:pretty_json] = false
-            %{<pre><code class="language-#{options[:response_syntax]}">
-#{CGI.escapeHTML(response_key)}
-</code></pre>
+            %{<pre><code class="language-#{options[:response_syntax]}">#{CGI.escapeHTML(response_key)}</code></pre>
 }
         when :none
             ""
@@ -192,10 +211,9 @@ def curl_example(method, path, response_key, options = {}, &block)
     end
     curl_lines << cur_line.strip
 
-    # use pre, code instead of a fenced code block so I can use these insted of markdown lists. Fenced code blocks don't work in md lists
-    %{<pre><code class="language-sh">
-#{curl_lines.join(" \\\n    ")}
-</code></pre>
+    # use pre, code instead of a fenced code block so I can use these inside of markdown lists. Fenced code blocks don't work in md lists
+    %{#{access_token_banner}
+<pre><code class="language-sh">#{curl_lines.join(" \\\n    ")}</code></pre>
 #{response}
 }
 end

lib/sample_objects.rb

@@ -19,7 +19,7 @@ def get_hash(key)
     end
 
     def json_output(hash)
-      "\n<pre><code class='language-js'>\n" + CGI.escapeHTML(JSON.pretty_generate(hash)) + "\n</code></pre>\n"
+      "\n<pre><code class='language-js'>" + CGI.escapeHTML(JSON.pretty_generate(hash)) + "</code></pre>\n"
     end
 
     def process_json(key, &block)
@@ -298,7 +298,7 @@ def paginated_response(key, &block)
       "user" => "...user object...",
       "created_at" => "2012-07-16T17:25:47Z",
       "text" => "@berg FIRST post on this new site #newsocialnetwork",
-      "html" => "<span itemscope=\"https://app.net/schemas/Post\"><span itemprop=\"mention\" data-mention-name=\"berg\" data-mention-id=\"2\">@berg</span> FIRST post on <a href=\"https://join.app.net\" rel=\"nofollow\">this new site</a> <span itemprop=\"hashtag\" data-hashtag-name=\"newsocialnetwork\">#newsocialnetwork</span>.</span",
+      "html" => "<span itemscope=\"https://app.net/schemas/Post\"><span itemprop=\"mention\" data-mention-name=\"berg\" data-mention-id=\"2\">@berg</span> FIRST post on <a href=\"https://join.app.net\" rel=\"nofollow\">this new site</a> <span itemprop=\"hashtag\" data-hashtag-name=\"newsocialnetwork\">#newsocialnetwork</span>.</span>",
       "source" => {
           "name" => "Clientastic for iOS",
           "link" => "http://app.net",

static/js/app.js

@@ -0,0 +1,23 @@
+$(function() {
+
+    var token = null;
+    var new_token = $.url(window.location).fparam('access_token');
+    if (new_token) {
+        token = {
+            user_token: new_token
+        };
+        localStorage.token = JSON.stringify(token);
+    } else if (typeof(localStorage.token) !== 'undefined') {
+        token = JSON.parse(localStorage.token);
+    }
+
+    if (token && token.user_token) {
+        var needle = "<YOUR ACCESS TOKEN>";
+        $('pre code').each(function () {
+            var el = $(this);
+            el.html(el.html().replace(needle, token.user_token));
+        });
+    } else {
+        $('.authorize-prompt').removeClass('hide');
+    }
+});