mta_json 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mta_json.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marcus Bauer
+
+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,130 @@
+# mta_json
+
+Wraps MTA:SA's JSON format to support named parameters and different HTTP
+methods with callRemote.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mta_json'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mta_json
+
+---
+
+You'll need to add the following line to your `config/application.rb`:
+
+    config.middleware.insert_before Rack::MethodOverride, MtaJson::Wrapper
+
+## Usage
+
+### Rails
+
+There are no changes required to any specific code, so long as your controller
+actions respond to JSON and returns JSON.
+
+The following would just work fine:
+
+    # route:
+    #   resources :posts, :only => [:show, :index]
+    class PostsController < ApplicationController
+      def index
+        @posts = Post.all
+
+        respond_to do |format|
+          format.html
+          format.json { render :json => @posts }
+        end
+      end
+
+      def show
+        @post = Post.find(params[:id])
+
+        respond_to do |format|
+          format.html
+          format.json { render :json => @post }
+        end
+      end
+    end
+
+### MTA:SA
+
+The basic parameters for callRemote are:
+
+    callRemote(url, your_function, params, options)
+
+where
+
+* **params** will be present as `params` hash in your application.
+  For example,
+
+  <pre>callRemote(url, your_function, { name = 'mabako', password = '****' })</pre>
+
+  will allow you to use `params[:name]` and `params[:password]`
+
+* **options** contained options as hints to the JSON-Wrapper.
+    * **method** overwrites the default POST HTTP verb, only 'GET' is a valid
+       alternative currently.
+
+The format is not `posts.json` for URLs but `posts.mta`. This gem will rewrite
+the URL to be `posts.json` as well as handle MTA-specific code.
+
+The following example code shows just how you'd retrieve the list of posts
+returned by above Rails-specific example.
+
+    callRemote('http://localhost/posts.mta',
+      function(posts, err)
+        if posts ~= 'ERROR' then
+          outputDebugString('Retrieved ' .. #posts .. ' posts: ')
+          for k, post in ipairs(posts) do
+            -- assumes your @post in rails has a 'text' attribute
+            outputDebugString(post.text)
+          end
+        else
+          outputDebugString('Failed to retrieve blog posts, error: ' .. tostring(err), 2)
+        end
+      end,
+      nil, # no parameters to pass
+      {method = 'GET'} # MTA has POST as default, pick GET instead
+    )
+
+Likewise to retrieve a single post:
+
+    callRemote('http://localhost/posts/1.mta',
+      function(post, err)
+        if post ~= 'ERROR' then
+          -- assumes your @post in rails has a 'text' attribute
+          outputDebugString(post.text)
+        else
+          outputDebugString('Failed to retrieve blog post, error: ' .. tostring(err), 2)
+        end
+      end,
+      nil,
+      {method = 'GET'}
+    )
+
+A more complete example can be found in `examples/crud`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODOs
+
+* Special care should be taken with the default POST method, there currently is
+  no way to set a CSRF-Token. This can be worked around by using:
+
+  <pre>skip_before_filter :verify_authenticity_token, :only => :your_method</pre>
+
+* The code doesn't insert itself as middleware automatically, see Installation section.

data/Rakefile

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

data/examples/crud/README.md

@@ -0,0 +1,40 @@
+# CRUD Example
+(Create, Read, Update, Delete)
+
+Tests whether you can create, read, update and delete posts from MTA
+
+## Running the example
+
+Start the rails server:
+
+    $ cd rails
+    $ rails s
+
+Start the MTA Server and type the following commands:
+
+    $ aclrequest crud allow all
+    $ start crud
+
+After that, the following commands are available within MTA (console, in-game)
+
+* **/posts** - lists all posts
+
+## How this was built - in rails
+
+Creating the project:
+
+    $ rails new CrudTest
+
+**Manually** adding "gem 'mta_json'" to the Gemfile.
+
+Running Bundler:
+
+    $ bundle install
+
+Generating a model Post along with a matching Controller:
+
+    $ rails g scaffold post title:string text:text
+
+Migrates the database to include the new posts table:
+
+    $ rake db:migrate

data/examples/crud/crud.lua

@@ -0,0 +1,113 @@
+-- lists the -id- and -title- of all posts. While there is a text attribute, we skip that
+local url = 'http://localhost:3000/'
+
+addCommandHandler('posts',
+  function(player, command)
+    callRemote(url .. 'posts.mta',
+      function(posts, err)
+        if posts ~= 'ERROR' then
+          output(player, #posts .. ' posts:')
+          for _, post in ipairs(posts) do
+            output(player, ' #' .. post.id .. ': ' .. tostring(post.title))
+          end
+        else
+          output(player, 'Failed to fetch posts')
+        end
+      end,
+      nil,
+      { method = 'GET' }
+    )
+  end
+)
+
+addCommandHandler('post',
+  function(player, command, id)
+    if tonumber(id) then
+      callRemote(url .. 'posts/' .. math.floor(tonumber(id)) .. '.mta',
+        function(post, err)
+          if post ~= 'ERROR' then
+            output(player, 'Post #' .. post.id .. ': ' .. tostring(post.title))
+            -- first 60 characters only
+            output(player, tostring(post.text):sub(1, 60))
+          else
+            output(player, 'Failed to fetch post')
+          end
+        end,
+        nil,
+        { method = 'GET'}
+      )
+    else
+      output(player, 'Missing id, /' .. command .. ' id')
+    end
+  end
+)
+
+addCommandHandler('newpost',
+  function(player, command, title, ...)
+    callRemote(url .. 'posts.mta',
+      function(post, err)
+        if post ~= 'ERROR' then
+          output(player, 'Created Post #' .. post.id .. ': ' .. tostring(post.title))
+          -- first 60 characters only
+          output(player, tostring(post.text):sub(1, 60))
+
+          -- rails sets the location like this:
+          -- format.json { render json: @post, status: :created, location: @post }
+          -- err contains our headers if no error was received.
+          output(player, 'URL: ' .. err['Location'])
+        else
+          output(player, 'Failed to create post')
+        end
+      end,
+      { post = { title = title, text = table.concat({...}, ' ') } }
+    )
+  end
+)
+
+addCommandHandler('updatepost',
+  function(player, command, id, title, ...)
+    if tonumber(id) then
+      callRemote(url .. 'posts/' .. math.floor(tonumber(id)) .. '.mta',
+        function(post, err)
+          if post ~= 'ERROR' then
+            -- the controller generated by the default update has
+            -- head :no_content - which means both post and err will be empty.
+            output(player, 'Updated!')
+          else
+            output(player, 'Failed to update post')
+          end
+        end,
+        { post = { title = title, text = table.concat({...}, ' ') } },
+        { method = 'PUT' }
+      )
+    end
+  end
+)
+
+addCommandHandler('delpost',
+  function(player, command, id)
+    if tonumber(id) then
+      callRemote(url .. 'posts/' .. math.floor(tonumber(id)) .. '.mta',
+        function(post, err)
+          if post ~= 'ERROR' then
+            -- the controller generated by the default update has
+            -- head :no_content - which means both post and err will be empty.
+            output(player, 'deleted!')
+          else
+            output(player, 'Failed to delete post')
+          end
+        end,
+        nil,
+        { method = 'DELETE' }
+      )
+    end
+  end
+)
+
+function output(element, text)
+  if getElementType(element) == 'console' then
+    outputServerLog(text)
+  else
+    outputChatBox(text, element)
+  end
+end

data/examples/crud/meta.xml

@@ -0,0 +1,14 @@
+<!--
+mta_json crud example to interact with rails.
+
+See https://github.com/mabako/mta_json
+-->
+<meta>
+  <!-- Script source file -->
+  <script src="crud.lua"/>
+
+  <!-- This wouldn't make sense without callRemote, would it? -->
+  <aclrequest>
+    <right name="function.callRemote" access="true" />
+  </aclrequest>
+</meta>

data/examples/crud/mta/crud/meta.xml

@@ -0,0 +1,3 @@
+<meta>
+  <script src="crud.lua"/>
+</meta>

data/examples/crud/rails/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/examples/crud/rails/Gemfile

@@ -0,0 +1,40 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.12'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', :platforms => :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'debugger'
+
+gem 'mta_json'

data/examples/crud/rails/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+CrudTest::Application.load_tasks

data/examples/crud/rails/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/examples/crud/rails/app/assets/javascripts/posts.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/

data/examples/crud/rails/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/examples/crud/rails/app/assets/stylesheets/posts.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the posts controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/examples/crud/rails/app/assets/stylesheets/scaffolds.css.scss

@@ -0,0 +1,69 @@
+body {
+  background-color: #fff;
+  color: #333;
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+  &:visited {
+    color: #666;
+  }
+  &:hover {
+    color: #fff;
+    background-color: #000;
+  }
+}
+
+div {
+  &.field, &.actions {
+    margin-bottom: 10px;
+  }
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+  h2 {
+    text-align: left;
+    font-weight: bold;
+    padding: 5px 5px 5px 15px;
+    font-size: 12px;
+    margin: -7px;
+    margin-bottom: 0px;
+    background-color: #c00;
+    color: #fff;
+  }
+  ul li {
+    font-size: 12px;
+    list-style: square;
+  }
+}

data/examples/crud/rails/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/examples/crud/rails/app/controllers/posts_controller.rb

@@ -0,0 +1,83 @@
+class PostsController < ApplicationController
+  # GET /posts
+  # GET /posts.json
+  def index
+    @posts = Post.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render json: @posts }
+    end
+  end
+
+  # GET /posts/1
+  # GET /posts/1.json
+  def show
+    @post = Post.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @post }
+    end
+  end
+
+  # GET /posts/new
+  # GET /posts/new.json
+  def new
+    @post = Post.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @post }
+    end
+  end
+
+  # GET /posts/1/edit
+  def edit
+    @post = Post.find(params[:id])
+  end
+
+  # POST /posts
+  # POST /posts.json
+  def create
+    @post = Post.new(params[:post])
+
+    respond_to do |format|
+      if @post.save
+        format.html { redirect_to @post, notice: 'Post was successfully created.' }
+        format.json { render json: @post, status: :created, location: @post }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @post.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /posts/1
+  # PUT /posts/1.json
+  def update
+    @post = Post.find(params[:id])
+
+    respond_to do |format|
+      if @post.update_attributes(params[:post])
+        format.html { redirect_to @post, notice: 'Post was successfully updated.' }
+        format.json { head :no_content }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @post.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /posts/1
+  # DELETE /posts/1.json
+  def destroy
+    @post = Post.find(params[:id])
+    @post.destroy
+
+    respond_to do |format|
+      format.html { redirect_to posts_url }
+      format.json { head :no_content }
+    end
+  end
+end

data/examples/crud/rails/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/examples/crud/rails/app/helpers/posts_helper.rb

@@ -0,0 +1,2 @@
+module PostsHelper
+end

data/examples/crud/rails/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  attr_accessible :text, :title
+end

data/examples/crud/rails/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>CrudTest</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/examples/crud/rails/app/views/posts/_form.html.erb

@@ -0,0 +1,25 @@
+<%= form_for(@post) do |f| %>
+  <% if @post.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@post.errors.count, "error") %> prohibited this post from being saved:</h2>
+
+      <ul>
+      <% @post.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </div>
+  <div class="field">
+    <%= f.label :text %><br />
+    <%= f.text_area :text %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>