tent-apidoc 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'tent-client', :git => 'git://github.com/tent/tent-client-ruby.git', :branch => 'master'
+gem 'tentd', :git => 'git://github.com/tent/tentd.git', :branch => 'master'
+gem 'girl_friday'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Apollic Software, LLC
+
+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,3 @@
+# TentApiDoc
+
+Documentation generator used to generate API examples for http://tent.io

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/tent-apidoc

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+bin_file = Pathname.new(__FILE__).realpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require 'tent-apidoc'
+require 'yaml'
+
+data = { :examples => TentApiDoc.examples, :variables => TentApiDoc.variables }
+
+File.open(ARGV[0] || 'examples.yaml', 'w') { |f| f.write YAML.dump(data) }

data/lib/tent-apidoc.rb

@@ -0,0 +1,93 @@
+require 'bundler/setup'
+require 'tent-client'
+require 'tentd'
+require 'rack/utils'
+
+ENV['TENT_ENTITY'] = 'https://example.org'
+
+class TentApiDoc
+  class FaradayAdapter < Faraday::Adapter::Rack
+    def call(env)
+      env[:request_body] = env[:body].dup if env[:body]
+      super
+    end
+  end
+
+  Faraday.register_middleware :adapter, :tent_rack => FaradayAdapter
+
+  class << self
+    attr_accessor :examples
+
+    def clients
+      @clients ||= begin
+        adapter = [:tent_rack, TentD.new(:database => 'postgres://localhost/tent_doc').tap { DataMapper.auto_migrate! }]
+        TentD.faraday_adapter = adapter # tentception
+        {
+          :base => TentClient.new('https://example.com', :faraday_adapter => adapter)
+        }
+      end
+    end
+
+    def example(name)
+      (@examples ||= {})[name] = response_to_markdown(yield)
+    end
+
+    def variables
+      @variables ||= {}
+    end
+
+    private
+
+    def response_to_markdown(response)
+      return unless response
+      markdown = request_markdown(response.env)
+      markdown += body_markdown(response.env[:request_body])
+      markdown += response_head_markdown(response)
+      markdown += body_markdown(response.body)
+    end
+
+    def request_markdown(env)
+      request = "#{env[:method].to_s.upcase} #{env[:url].request_uri} HTTP/1.1\n"
+      request += header_string(env[:request_headers])
+      fenced_code(request)
+    end
+
+    def response_head_markdown(response)
+      head = "HTTP/1.1 #{response.status} #{Rack::Utils::HTTP_STATUS_CODES[response.status]}\n"
+      response.headers.delete('X-Cascade')
+      head += header_string(response.headers)
+      fenced_code(head)
+    end
+
+    def body_markdown(body)
+      return '' if body.nil? || body.respond_to?(:empty?) && body.empty?
+      body = (body.rewind && body.read) if body.respond_to?(:read)
+      fenced_code(body)
+    end
+
+    def header_string(headers)
+      headers.map { |k,v| "#{k}: #{v}" }.join("\n")
+    end
+
+    def fenced_code(code)
+      language = if code.kind_of?(Hash) || code.kind_of?(Array)
+        code = JSON.pretty_generate(code)
+        'json'
+      elsif code.match(/\A\s*\{/)
+        code = JSON.pretty_generate(JSON.parse(code))
+        'json'
+      else
+        'text'
+      end
+      "\n```#{language}\n#{code}\n```\n"
+    end
+
+    def client_options(authable)
+      authable.auth_details.merge(:faraday_adapter => TentD.faraday_adapter)
+    end
+  end
+end
+
+TentApiDoc.clients
+
+require 'tent-apidoc/examples'

data/lib/tent-apidoc/examples.rb

@@ -0,0 +1,204 @@
+require 'faker'
+require 'fabrication'
+
+class TentApiDoc
+  include TentD::Model
+
+  User.current = User.create
+
+  # hack so tentception works
+  class TentD::Model::User
+    def profile_entity
+      nil
+    end
+  end
+
+  ProfileInfo.create(:type_base => 'https://tent.io/types/info/core',
+                     :type_version => '0.1.0',
+                     :public => true,
+                     :content => {
+                       :licenses => ['http://creativecommons.org/licenses/by/3.0/'],
+                       :entity => 'https://example.org',
+                       :servers => ['https://tent.example.com', 'http://eqt5g4fuenphqinx.onion/']
+                     })
+  ProfileInfo.create(:type_base => 'https://tent.io/types/info/basic',
+                     :type_version => '0.1.0',
+                     :public => true,
+                     :content => {
+                       :name => 'The Tentity',
+                       :avatar_url => 'http://example.org/avatar.jpg',
+                       :birthdate => '2012-08-23',
+                       :location => 'The Internet',
+                       :gender => 'Unknown',
+                       :bio => Faker::Lorem.sentence
+                     })
+
+  example(:get_profile) do
+    clients[:base].profile.get
+  end
+
+  example(:create_app) do
+    clients[:base].app.create(
+      :name => "FooApp",
+      :description => "Does amazing foos with your data",
+      :url => "http://example.com",
+      :icon => "http://example.com/icon.png",
+      :redirect_uris => ["https://app.example.com/tent/callback"],
+      :scopes => {
+        :write_profile => "Uses an app profile section to describe foos",
+        :read_followings => "Calculates foos based on your followings"
+      }).tap {
+        clients[:app] = TentClient.new('https://example.com', client_options(App.last))
+      }
+  end
+
+  example(:app_auth) do
+    app = App.first
+    auth = app.authorizations.create(
+      :scopes => %w(read_posts write_posts import_posts read_profile write_profile read_followers write_followers read_followings write_followings read_groups write_groups read_permissions write_permissions read_apps write_apps follow_ui read_secrets write_secrets),
+      :profile_info_types => ['https://tent.io/types/info/basic/v0.1.0'],
+      :post_types => ['https://tent.io/types/post/status/v0.1.0', 'https://tent.io/types/post/photo/v0.1.0']
+    )
+    variables[:app_code] = auth.token_code
+    variables[:app_id] = app.public_id
+    clients[:app].app.authorization.create(app.public_id, :code => auth.token_code, :token_type => 'mac').tap {
+      clients[:auth] = TentClient.new('https://example.com', client_options(AppAuthorization.last))
+    }
+  end
+
+  example(:create_following) do
+    clients[:auth].following.create('https://example.org')
+  end
+
+  example(:create_follower) do
+    clients[:base].follower.create(
+      :entity => 'https://example.org',
+      :types => ['all'],
+      :notification_path => "notifications/#{Following.last.public_id}",
+      :licenses => ['http://creativecommons.org/licenses/by/3.0/']
+    ).tap { |res|
+      clients[:follower] = TentClient.new('https://example.com', client_options(Follower.last))
+      variables[:follower_id] = res.body['id']
+    }
+  end
+
+  example(:get_follower) do
+    clients[:follower].follower.get(variables[:follower_id])
+  end
+
+  example(:update_follower) do
+    follower = Follower.first(:public_id => variables[:follower_id])
+    clients[:follower].follower.update(follower.public_id, follower.attributes.slice(:entity, :licenses).merge(:types => ['https://tent.io/types/post/essay/v0.1.0#full']))
+  end
+
+  example(:get_app) do
+    clients[:app].app.get(App.last.public_id)
+  end
+
+  example(:update_app) do
+    clients[:app].app.update(
+      App.last.public_id,
+      :name => "FooApp",
+      :description => "Does amazing foos with your data",
+      :url => "http://example.com",
+      :icon => "http://example.com/icon.png",
+      :redirect_uris => ["https://app.example.com/tent/callback"],
+      :scopes => {
+        :write_profile => "Uses an app profile section to describe foos",
+        :read_followings => "Calculates foos based on your followings",
+        :write_following => "Follow new users when you click"
+      }
+    )
+  end
+
+  example(:discovery) do
+    clients[:base].http.head('/')
+  end
+
+  example(:update_profile) do
+    clients[:auth].profile.update(
+      'https://tent.io/types/info/basic/v0.1.0',
+      :name => 'The Tentity',
+      :avatar_url => 'http://example.org/avatar.jpg',
+      :birthdate => '2012-08-23',
+      :location => 'The Internet',
+      :gender => 'Unknown',
+      :bio => Faker::Lorem.sentence
+    )
+  end
+
+  example(:create_post) do
+    clients[:auth].post.create(
+      :type => 'https://tent.io/types/post/status/v0.1.0',
+      :published_at => Time.now.to_i,
+      :permissions => { :public => true },
+      :licenses => ['http://creativecommons.org/licenses/by/3.0/'],
+      :content => {
+        :text => "Just landed.",
+        :location => {
+          :type => 'Point',
+          :coordinates => [50.923878, 4.028605]
+        }
+      }
+    ).tap { |res| variables[:post_id] = res.body['id'] }
+  end
+
+  example(:create_post_with_attachments) do
+    clients[:auth].post.create(
+      {
+        :type => 'https://tent.io/types/post/photo/v0.1.0',
+        :published_at => Time.now.to_i,
+        :permissions => { :public => true },
+        :licenses => ['http://creativecommons.org/licenses/by/3.0/'],
+        :content => {
+          :caption => 'Some fake photos'
+        }
+      },
+      :attachments => [
+        { :category => 'photos', :filename => 'fake_photo1.jpg', :data => 'Photo 1 data would go here', :type => 'image/jpeg' },
+        { :category => 'photos', :filename => 'fake_photo2.jpg', :data => 'Photo 2 data would go here', :type => 'image/jpeg' },
+      ]
+    )
+  end
+
+  example(:get_post_attachment) do
+    attachment = PostAttachment.last
+    clients[:auth].post.attachment.get(attachment.post.public_id, attachment.name, attachment.type)
+  end
+
+  example(:get_followings) do
+    clients[:auth].following.list
+  end
+
+  example(:get_following) do
+    clients[:auth].following.get(Following.last.public_id)
+  end
+
+  example(:delete_following) do
+    clients[:auth].following.delete(Following.last.public_id)
+  end
+
+  example(:get_followers) do
+    clients[:auth].follower.list
+  end
+
+  example(:get_posts) do
+    clients[:auth].post.list
+  end
+
+  example(:get_post) do
+    clients[:auth].post.get(variables[:post_id])
+  end
+
+  example(:follower_get_post) do
+    clients[:follower].post.get(variables[:post_id])
+  end
+
+  example(:follower_get_posts) do
+    clients[:follower].post.list
+  end
+
+  example(:delete_follower) do
+    clients[:follower].follower.delete(variables[:follower_id])
+  end
+end

data/tent-apidoc.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "tent-apidoc"
+  gem.version       = '0.0.1'
+  gem.authors       = ["Jonathan Rudenberg"]
+  gem.email         = ["jonathan@titanous.com"]
+  gem.description   = "API examples for the Tent protocol documentation"
+  gem.summary       = "API examples for the Tent protocol documentation"
+  gem.homepage      = "http://tent.io"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'tent-client'
+  gem.add_runtime_dependency 'tentd'
+  gem.add_runtime_dependency 'rack-test'
+  gem.add_runtime_dependency 'fabrication'
+  gem.add_runtime_dependency 'faker'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: tent-apidoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Rudenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tent-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API examples for the Tent protocol documentation
+email:
+- jonathan@titanous.com
+executables:
+- tent-apidoc
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/tent-apidoc
+- lib/tent-apidoc.rb
+- lib/tent-apidoc/examples.rb
+- tent-apidoc.gemspec
+homepage: http://tent.io
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: API examples for the Tent protocol documentation
+test_files: []