moonrope 1.4.1 → 2.0.0

data/example/authentication.rb

@@ -0,0 +1,50 @@
+authenticator :default do
+
+  description <<-DESCRIPTION
+    To authenticate to the API, you need to pass an appropriate API token with your
+    request. To find out how to obtain an API token, please refer to the Authentication
+    API documentaton which outlines the available methods available for this.
+  DESCRIPTION
+
+  header "X-Auth-Application", "The API application which is generated by us and provided to you.", :example => "abc123abc123abc123"
+  header "X-Auth-Token", "The API token for the user you wish to authenticate as.", :example => "abc123abc123abc123"
+
+  error "InvalidApplicationToken", "The application token provided in X-Auth-Application is not valid.", :attributes => {:token => "The token used to find the application"}
+  error "InvalidAuthToken", "The auth token provided in X-Auth-Token is not valid.", :attributes => {:token => "The token that was used"}
+  error "ExpiredAuthToken", "The auth token provided in X-Auth-Token has expired.", :attributes => {:expired_at => "The time the token expired"}
+
+  lookup do
+    if app_token = header['X-Auth-Application']
+      api_application = APIApplication.find_by_token(app_token)
+      if api_application.nil?
+        error "InvalidApplicationToken", :token => app_token
+      end
+
+      if auth_token = header['X-Auth-Token']
+        api_token = api_application.api_tokens.find_by_token(auth_token)
+        if api_token.nil? || api_token.inactive?
+          error "InvalidAuthToken", :token => auth_token
+        end
+
+        if api_token.expired?
+          error "ExpiredAuthToken", :expired_at => api_token.expired_at
+        end
+
+        api_token
+      end
+    end
+  end
+
+  rule :default, "NotAuthenticated", "Must be authenticated with a valid user API token." do
+    identity.is_a?(APIToken) && identity.user
+  end
+
+  rule :must_be_admin, "MustBeAdmin", "Must be authenticated as a valid admin user." do
+    identity.is_a?(APIToken) && identity.user && identity.user.admin?
+  end
+
+  rule :anonymous, "MustBeAnonymous", "Must not be authenticated (no auth headers provided)." do
+    identity == :anonymous
+  end
+
+end

data/example/controllers/meta_controller.rb

@@ -0,0 +1,14 @@
+controller :meta do
+
+  friendly_name "Meta API"
+  description <<-DESC
+    The meta API provides you with access to information about the API itself.
+  DESC
+
+  action :version do
+    description "Return the current software version"
+    returns :string, :eg => "v1.2.3"
+    action { LlamaCom::VERSION }
+  end
+
+end

data/example/controllers/users_controller.rb

@@ -0,0 +1,92 @@
+controller :users do
+
+  friendly_name "Users API"
+  description <<-DESC
+    The Users API provides full access to manage the users
+    which exist on your account.
+  DESC
+
+  action :list do
+    title "List all users"
+    description "This action will return a list of all users which the authenticated user has access to."
+    param :page, "The page number", :default => 1, :type => Integer
+    param :per_page, "The number of items to return per page", :default => 30, :type => Integer
+    sortable :username, :id, :created_at, :updated_at
+    paginated
+    filterable do
+      attribute :username, :type => String
+      attribute :age, :type => Integer
+      attribute :admin, :type => :boolean
+    end
+    returns :array, :structure => :user
+    action do
+      paginate(User.all) do |user|
+        structure user, :return => true
+      end
+    end
+  end
+
+  action :show do
+    title "Get unit information"
+    param :username, "The user's username", :type => String, :required => true
+    returns :hash, :structure => :user, :structure_opts => {:paramable => true}
+    error "UserNotFound", "No user was found matching the given username", :attributes => {:username => "The username which was looked up"}
+    action do
+      if user = User.find_by_username(params.username)
+        structure user, :return => true
+      else
+        error 'UserNotFound', :username => params.username
+      end
+    end
+  end
+
+  shared_action :properties do
+    param :username, "The user's username", :type => String
+    param :first_name, "The user's first name", :type => String
+    param :last_name, "The user's last name", :type => String
+    param :email_address, "The user's e-mail address", :type => String
+    param :password, "The user's password", :type => String
+    param :admin, "Should this user be an admin?", :type => :boolean do |object, value|
+      if identity.admin?
+        object.admin = value
+      end
+    end
+  end
+
+  action :create do
+    title "Create a new user"
+    description <<-DESCRIPTION
+      This action will create a new user with the properties which have been provided.
+    DESCRIPTION
+    use :properties
+    returns :hash, :structure => :user, :structure_opts => {:full => true}
+    error "ValidationError", "The details provided were not sufficient to save the user", :attributes => {:errors => "An array of errors for each field"}
+    action do
+      user = User.new
+      if user.save
+        structure user, :return => true
+      else
+        error 'ValidationError', :errors => user.errors
+      end
+    end
+  end
+
+  action :update do
+    title "Update an existing user"
+    description "This action will update an existing user with the properties provided."
+    param :id, "The ID of the user to update", :type => Integer, :required => true
+    use :properties
+    returns :hash, :structure => :user, :structure_opts => {:full => true}
+    error 'UserNotFound', "The user specified could not be found", :attributes => {:id => "The ID that was looked up"}
+    error "ValidationError", "The details provided were not sufficient to save the user", :attributes => {:errors => "An array of errors for each field"}
+    action do
+      user = User.find_by_id(params.id) || error('UserNotFound', :id => params.id)
+      if user.save
+        structure user, :return => true
+      else
+        error 'ValidationError', :errors => user.errors
+      end
+    end
+  end
+
+end

data/example/structures/pet_structure.rb

@@ -0,0 +1,12 @@
+structure :pet do
+
+  # Uncomment the below line to stop this structure being documented.
+  # no_doc!
+
+  basic :id, "The ID of the pet", :type => Integer, :eg => 148
+  basic :name, "The name of the pet", :type => String, :eg => "Fido"
+  basic :color, "What color is the pet?", :type => String, :eg => "Green"
+
+  expansion :user, "The user who owns this pet", :type => Hash, :structure => :user
+
+end

data/example/structures/user_structure.rb

@@ -0,0 +1,35 @@
+structure :user do
+
+  basic :id, "The user's internal system ID", :type => Integer, :eg => 123
+  basic :username, "The user's unique username", :type => String, :eg => "adamcooke"
+  group :name do
+    basic :first, "The user's first name", :type => String, :eg => "Adam", :source_attribute => :first_name
+    basic :last, "The user's last name", :type => String, :eg => "Cooke", :source_attribute => :last_name
+  end
+
+  full :admin, "Is this user an administrator?", :type => :boolean
+  full :age, "The user's age", :type => Integer, :doc => false
+  full :created_at, "The timestamp the user was created", :type => :timestamp
+  full :updated_at, "The timestamp the user was updated", :type => :timestamp
+
+  expansion :pets, "All pets that belong to this user", :structure => :pet, :type => Array
+
+  expansion :balance, "The user's balance", :type => Float, :eg => 12.50 do
+    o.user.balance
+  end
+
+  expansion :hidden, "This is a hidden expansion", :doc => false do
+    o.user.hidden
+  end
+
+  condition Proc.new { identity.admin? }, "Can only be accessed by API users with admin access" do
+    # This value will only be provided to users who are accesing the API with
+    # the permission to view
+    full :support_pin, "The PIN this user needs to use to access support", :type => String, :eg => "4953"
+  end
+
+  condition :default => :anonymous do
+    full :mask, "The unique mask that represents this user", :type => String, :eg => 'abc123abc123'
+  end
+
+end

data/html/assets/lock.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
+  <path fill="#ed4300" d="M3 0c-1.1 0-2 .9-2 2v1h-1v4h6v-4h-1v-1c0-1.1-.9-2-2-2zm0 1c.56 0 1 .44 1 1v1h-2v-1c0-.56.44-1 1-1z" transform="translate(1)" />
+</svg>

data/html/assets/reset.css

@@ -0,0 +1,101 @@
+html, body, body div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, abbr, address, cite, code, del, dfn, em, img, ins, kbd, q, samp, small, strong, sub, sup, var, b, i, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, figure, footer, header, hgroup, menu, nav, section, time, mark, audio, video {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	outline: 0;
+	font-size: 100%;
+	letter-spacing:0;
+	vertical-align: baseline;
+	background: transparent;
+	font-weight:inherit;
+}
+
+* {
+	-webkit-box-sizing: border-box;
+	-moz-box-sizing: border-box;
+	box-sizing: border-box;
+}
+u { text-decoration: none;}
+b { font-weight:normal;}
+article, aside, figure, footer, header, hgroup, nav, section {display: block;}
+
+object,embed {max-width: 100%;}
+ul {list-style: none;}
+blockquote, q {quotes: none;}
+b,strong { font-weight:bold;}
+blockquote:before, blockquote:after, q:before, q:after {content: ''; content: none;}
+
+a {margin: 0; padding: 0; font-size: 100%; vertical-align: baseline; background: transparent;}
+
+del {text-decoration: line-through;}
+
+abbr[title], dfn[title] {border-bottom: 1px dotted #000; cursor: help;}
+
+/* tables still need cellspacing="0" in the markup */
+table {border-collapse: collapse; border-spacing: 0;}
+mark { color:inherit;}
+
+hr {display: block; height: 1px; border: 0; border-top: 1px solid #ccc; margin: 1em 0; padding: 0;}
+
+input, select {vertical-align: middle;}
+
+pre {
+	white-space: pre; /* CSS2 */
+	white-space: pre-wrap; /* CSS 2.1 */
+	white-space: pre-line; /* CSS 3 (and 2.1 as well, actually) */
+	word-wrap: break-word; /* IE */
+}
+
+input[type="radio"] {vertical-align: text-bottom;}
+input[type="checkbox"] {vertical-align: bottom; *vertical-align: baseline;}
+.ie6 input {vertical-align: text-bottom;}
+
+select, input, textarea {font: 99% sans-serif;}
+
+table {font-size: inherit; font: 100%;}
+
+/* Accessible focus treatment
+	people.opera.com/patrickl/experiments/keyboard/test */
+a:hover, a:active {outline: none;}
+
+small {font-size: 85%;}
+
+strong, th {font-weight: bold;}
+
+td, td img {vertical-align: top;}
+
+/* Make sure sup and sub don't screw with your line-heights
+	gist.github.com/413930 */
+sub, sup {font-size: 75%; line-height: 0; position: relative;}
+sup {top: -0.5em;}
+sub {bottom: -0.25em;}
+
+/* standardize any monospaced elements */
+pre, code, kbd, samp {font-family: monospace, sans-serif;}
+
+/* hand cursor on clickable elements */
+.clickable,
+label,
+input[type=button],
+input[type=submit],
+button {cursor: pointer;}
+
+/* Webkit browsers add a 2px margin outside the chrome of form elements */
+button, input, select, textarea {margin: 0;}
+
+/* make buttons play nice in IE */
+button {width: auto; overflow: visible;}
+
+/* scale images in IE7 more attractively */
+.ie7 img {-ms-interpolation-mode: bicubic;}
+
+/* prevent BG image flicker upon hover */
+.ie6 html {filter: expression(document.execCommand("BackgroundImageCache", false, true));}
+
+/* let's clear some floats */
+.clearfix:before, .clearfix:after { content: "\0020"; display: block; height: 0; overflow: hidden; }
+.clearfix:after { clear: both; }
+.clearfix { zoom: 1; }
+
+select, input, textarea, a { outline: none;}
+a { color:inherit;}

data/html/assets/style.css

@@ -0,0 +1,348 @@
+html {
+  font-family: Lato, Arial, sans-serif;
+  font-size:16px;
+}
+
+a {
+  text-decoration: none;
+}
+
+.sidebarBackground {
+  background:#2f3e4d;
+  width:200px;
+  position:fixed;
+  top:0;
+  bottom:0;
+  z-index:1;
+}
+
+.sidebar {
+  width:200px;
+  float:left;
+  z-index:10;
+  position:absolute;
+}
+.sidebar a {
+  display:block;
+  padding:7px 15px;
+  border-bottom:1px solid #394959;
+  color:#889db1;
+  font-size:85%;
+}
+
+.sidebar a:hover {
+  background-color:#26323f;
+}
+
+.sidebar a.active {
+  background-color:#1d2630;
+  color:#fff;
+}
+
+.footer {
+  margin-left:200px;
+  border-top:3px solid #efefef;
+  padding:20px 40px 100px 40px;
+  font-size:90%;
+  color:#999;
+}
+
+.content {
+  margin-left:200px;
+  padding:40px;
+  padding-right:15%;
+}
+
+
+.content h1 {
+  font-size:32px;
+  font-weight:900;
+  margin-bottom:15px;
+}
+
+.content h2 {
+  font-size:24px;
+  font-weight:700;
+  color:#f65552;
+  margin-bottom:10px;
+  margin-top:30px;
+}
+
+.content h3 {
+  font-size:18px;
+  font-weight:700;
+  color:#888;
+  margin-bottom:10px;
+  margin-top:30px;
+}
+
+.content p.text {
+  line-height:1.5;
+  margin-bottom:15px;
+}
+
+
+.content .standardList {
+  margin-bottom:15px;
+  line-height:1.5;
+}
+
+.content .standardList li {
+  list-style:square;
+  margin-bottom:15px;
+  margin-left:35px;
+}
+
+.content code {
+  font-family:'Droid Sans Mono', fixed;
+  color:#f65552;
+  padding:1px 2px;
+  font-size:90%;
+}
+
+.content pre.code {
+  font-family:'Droid Sans Mono', fixed;
+  white-space: pre;
+  background:#efefef;
+  padding:10px 10px 10px;
+  font-size:90%;
+  margin-bottom:15px;
+  border-radius:7px 7px 7px 7px;
+}
+
+.content pre.code span.jsonKey {
+  color:#7f55ad;
+  font-weight:bold;
+}
+
+.content pre.code span.jsonString {
+  color:#9eb503;
+}
+
+.content pre.code span.jsonComment {
+  color:#bbb;
+  font-style:italic;
+}
+
+.content a.link {
+  color:#2d80c8;
+  font-weight:700;
+  border-bottom:1px solid #2d80c8;
+}
+
+.content p.apiURL span {
+  color:#aaa;
+}
+
+.table {
+  width:100%;
+}
+
+.table th, .table td {
+  border-bottom:1px solid #ccc;
+  text-align: left;
+  padding:7px 0;
+}
+
+.table th {
+  border-bottom:2px solid #666;
+  font-size:90%;
+}
+
+.paramTable__req {
+  background:#ea4c89;
+  color:#fff;
+  font-weight:bold;
+  font-size:10px;
+  text-transform: uppercase;
+  padding:1px 3px;
+  border-radius: 2px;
+  vertical-align: 1px;
+  margin-left:5px;
+}
+
+.paramTable__field {
+  width:100%;
+  border:0;
+  padding:0;
+  font:inherit;
+  color:#7f55ad;
+}
+
+.paramTable__description {
+  font-size:90%;
+  color:#999;
+  margin-top:3px;
+}
+
+.paramTable__name {
+  font-family:'Droid Sans Mono', fixed;
+  font-size:90%;
+}
+
+.paramTable__restrictedList {
+  font-size:80%;
+  margin-top:7px;
+  background:url(lock.svg) no-repeat 0 1px;
+  background-size:14px;
+  color:#ed4300;
+  padding-left:20px;
+}
+
+.paramTable__nil {
+  color:#ccc;
+  font-size:90%;
+}
+
+.apiURLFull {
+  font-size:110%;
+  font-weight:bold;
+}
+
+.apiURLFull span {
+  color:#aaaaaa;
+  font-weight:normal;
+}
+
+.errorAttributeList {
+  font-size:80%;
+}
+
+.errorAttributeList li {
+  margin-bottom:8px;
+  list-style:square;
+  margin-left:16px;
+}
+.errorAttributeList li:last-child {
+  margin-bottom:0;
+}
+
+.errorAttributeList__name {
+  font-family:'Droid Sans Mono', fixed;
+}
+
+.errorAttributeList__desc {
+  color:#999;
+}
+
+/* Try Action Form */
+
+.tryForm {
+  display:none;
+  border:2px solid #ccc;
+  background:#f7f7f7;
+  border-radius:7px;
+  overflow: hidden;
+}
+
+.tryForm__header {
+  background:#ddd;
+  padding:15px 25px;
+  font-weight:700;
+  color:#999;
+
+}
+
+.tryForm__header input {
+  background:none;
+  border:0;
+  padding:0;
+  vertical-align:0px;
+  font:inherit;
+  font-weight:700;
+  color:#000;
+  width:auto;
+}
+
+.tryForm__output {
+  display:none;
+  background:#111;
+  color:#fff;
+  padding:15px;
+  font-family:'Droid Sans Mono', fixed;
+  white-space: pre;
+  word-wrap:normal;
+  font-size:90%;
+  overflow-x:auto;
+}
+
+.tryForm__output--success {
+  border-top:7px solid #68be28;
+}
+
+.tryForm__output--error {
+  border-top:7px solid #d4172e;
+}
+
+.tryForm__heading {
+  border-bottom:1px solid #ddd;
+  border-top:4px solid #aaa;
+  margin-bottom:15px;
+  padding:8px 25px;
+  background:#efefef;
+  font-weight:700;
+  font-size:80%;
+  text-transform: uppercase;
+  color:#888;
+}
+
+.tryForm__table {
+  font-size:90%;
+  width:calc(100% - 50px);
+  margin:0 25px;
+  margin-bottom:15px;
+}
+
+.tryForm__table td {
+  padding:5px 0;
+  background:#f8f8f8;
+}
+
+.tryForm__tableField {
+  border:0;
+  background:none;
+  border-bottom:1px solid #ccc;
+  padding:0;
+  padding-bottom:4px;
+  width:100%;
+  font:inherit;
+  color:#7f55ad;
+  font-weight:700;
+}
+
+.tryForm__tableField:focus {
+  border-color:#7f55ad;
+}
+
+.tryForm__button {
+  margin:15px 25px;
+  text-align: right;
+}
+
+.tryFormActivate {
+  margin:20px 0;
+}
+.tryFormActivate__button {
+  background:url(tool.svg) #fffce0 no-repeat 12px 7px;
+  background-size:12px;
+  border:1px solid #dad7bb;
+  color:#6c6a55;
+  border-radius:4px;
+  padding:6px 12px 6px 30px;
+  font-size:12px;
+  font-weight:700;
+}
+
+.tryForm__checkbox {
+  margin-bottom:4px;
+}
+
+.tryForm__checkbox:last-child {
+  margin-bottom:0;
+}
+
+.tryForm__checkbox input {
+  float:left;
+  margin-right:4px;
+  margin-top:4px;
+}

data/html/assets/tool.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
+  <path fill="#6c6a55" d="M5.5 0c-1.38 0-2.5 1.12-2.5 2.5 0 .32.08.62.19.91l-2.91 2.88c-.39.39-.39 1.05 0 1.44.2.2.46.28.72.28.26 0 .52-.09.72-.28l2.88-2.91c.28.11.58.19.91.19 1.38 0 2.5-1.12 2.5-2.5 0-.16 0-.32-.03-.47l-.97.97h-2v-2l.97-.97c-.15-.03-.31-.03-.47-.03zm-4.5 6.5c.28 0 .5.22.5.5s-.22.5-.5.5-.5-.22-.5-.5.22-.5.5-.5z"
+  />
+</svg>