marty 0.5.15 → 0.5.16

data/spec/controllers/rpc_controller_spec.rb

@@ -0,0 +1,379 @@
+require 'spec_helper'
+
+sample_script = <<DELOREAN
+A:
+    a =? 123.0
+    b = a * 3
+
+B: A
+    c = a + b
+    d =?
+    e = c / a
+    f = e * d
+
+C:
+    p0 =?
+    a = 456.0 + p0
+
+D:
+    in =? "no input"
+    out = in
+
+DELOREAN
+
+sample_script3 = <<eof
+A:
+    a = 2
+    p =?
+    c = a * 2
+    pc = p + c
+    lc = [pc, pc]
+
+C: A
+    p =? 3
+
+B: A
+    p =? 5
+eof
+
+sample_script4 = <<eof
+import M3
+A: M3::A
+    p =? 10
+    c = a * 2
+    d = pc - 1
+    result = [{"a": 123, "b": 456}, {"a": 789, "b": 101112}]
+eof
+
+describe Marty::RpcController do
+  before(:each) {
+    @routes = Marty::Engine.routes
+
+    # HACKY: 'params' param is special to the Rails controller test helper (at
+    # least as of 4.2). Setting this avoids test framework code that relies on
+    # params being a hash.
+    @request.env['PATH_INFO'] = "/marty/rpc/evaluate.json"
+  }
+
+  before(:each) {
+    @p0 = Marty::Posting.do_create("BASE", Date.today, 'a comment')
+
+    @t1 = Marty::Script.load_script_bodies({
+                         "M1" => sample_script,
+                         "M2" => sample_script.gsub(/a/, "aa").gsub(/b/, "bb"),
+                         "M3" => sample_script3,
+                         "M4" => sample_script4,
+                       }, Date.today + 1.minute)
+
+    @p1 = Marty::Posting.do_create("BASE", Date.today + 2.minute, 'a comment')
+
+    @t2 = Marty::Script.load_script_bodies({
+                         "M1" =>
+                         sample_script.gsub(/A/, "AA")+'    e =? "hello"',
+                       }, Date.today + 3.minute)
+
+    @p2 = Marty::Posting.do_create("BASE", Date.today + 4.minute, 'a comment')
+    @data = [["some data",7,[1,2,3],{foo: "bar", baz: "quz"},5,"string"],
+             ["some more data",[1,2,3],5,{foo: "bar", baz: "quz"},5,"string"]]
+    @data_json = [@data].to_json
+  }
+
+  let(:t1) { @t1 }
+  let(:t2) { @t2 }
+  let(:p0) { @p0 }
+  let(:p1) { @p1 }
+  let(:p2) { @p2 }
+
+  it "should be able to post" do
+    post 'evaluate', {
+           format: :json,
+           script: "M1",
+           node: "B",
+           attrs: ["e","f"].to_json,
+           tag: t1.name,
+           params: { a: 333, d: 5}.to_json
+         }
+    expect(response.body).to eq([4,20].to_json)
+  end
+  it "should be able to post with complex data" do
+    post 'evaluate', {
+           format: :json,
+           script: "M1",
+           node: "D",
+           attrs: ["out"].to_json,
+           tag: t1.name,
+           params: {in: @data}.to_json
+         }
+    expect(response.body).to eq(@data_json)
+  end
+  # content-type: application/json structures the request a little differently
+  # so we also test that
+  it "should be able to post (JSON) with complex data" do
+    @request.env['CONTENT_TYPE'] = 'application/json'
+    @request.env['ACCEPT'] = 'application/json'
+    post 'evaluate', {
+           format: :json,
+           script: "M1",
+           node: "D",
+           attrs: ["out"].to_json,
+           tag: t1.name,
+           params: {in: @data}.to_json
+         }
+    expect(response.body).to eq(@data_json)
+  end
+  it "should be able to run scripts" do
+    get 'evaluate', {
+      format: :json,
+      script: "M1",
+      node: "A",
+      attrs: ["a", "b"].to_json,
+      tag: t1.name,
+    }
+    # puts 'Z'*40, request.inspect
+    expect(response.body).to eq([123.0, 369.0].to_json)
+
+    get 'evaluate', {
+      format: :json,
+      script: "M1",
+      node: "A",
+      attrs: ["a", "b"].to_json,
+      params: {"a" => 4.5}.to_json,
+      tag: t1.name,
+    }
+    expect(response.body).to eq([4.5,13.5].to_json)
+
+    get 'evaluate', {
+      format: :json,
+      script: "M1",
+      node: "B",
+      attrs: ["a", "b", "c"].to_json,
+      params: {"a" => 4.5}.to_json,
+      tag: t1.name,
+    }
+    expect(response.body).to eq([4.5, 13.5, 18.0].to_json)
+
+    get 'evaluate', {
+      format: :json,
+      script: "M1",
+      tag: "DEV",
+      node: "AA",
+      attrs: ["a", "b"].to_json,
+      params: {"a" => 3.3}.to_json,
+    }
+    res = ActiveSupport::JSON.decode(response.body).flatten.map{|x| x.round(8)}
+    expect(res).to eq([3.3, 9.9])
+  end
+
+  it "should be able to use posting name for tags" do
+    get 'evaluate', {
+      format: :json,
+      script: "M1",
+      node: "A",
+      attrs: ["a", "b"].to_json,
+      tag: p0.name,
+    }
+    expect(response.body["error"]).to_not be_nil
+
+    get 'evaluate', {
+      format: :json,
+      script: "M1",
+      node: "A",
+      attrs: ["a", "b"].to_json,
+      params: {"a" => 4.5}.to_json,
+      tag: p1.name,
+    }
+    expect(response.body).to eq([4.5,13.5].to_json)
+
+    get 'evaluate', {
+      format: :json,
+      script: "M1",
+      node: "B",
+      attrs: ["a", "b", "c"].to_json,
+      params: {"a" => 4.5}.to_json,
+      tag: p2.name,
+    }
+    expect(response.body).to eq([4.5, 13.5, 18.0].to_json)
+
+    get 'evaluate', {
+      format: :json,
+      script: "M1",
+      tag: "NOW",
+      node: "AA",
+      attrs: ["a", "b"].to_json,
+      params: {"a" => 3.3}.to_json,
+    }
+    res = ActiveSupport::JSON.decode(response.body).flatten.map{|x| x.round(8)}
+    expect(res).to eq([3.3, 9.9])
+  end
+
+  it "should be able to run scripts 2" do
+    get 'evaluate', {
+      format: :json,
+      script: "M3",
+      node: "C",
+      attrs: ["pc"].to_json,
+    }
+    # puts 'Z'*40, request.inspect
+    expect(response.body).to eq([7].to_json)
+
+    get 'evaluate', {
+      format: :json,
+      script: "M3",
+      node: "B",
+      attrs: ["pc"].to_json,
+    }
+    # puts 'Z'*40, request.inspect
+    expect(response.body).to eq([9].to_json)
+
+    get 'evaluate', {
+      format: :json,
+      script: "M3",
+      node: "A",
+      attrs: ["pc"].to_json,
+    }
+    # puts 'Z'*40, request.inspect
+    expect(response.body).to match(/"error":"undefined parameter p"/)
+  end
+
+  it "should be able to handle imports" do
+    get 'evaluate', {
+      format: :json,
+      script: "M4",
+      node: "A",
+      attrs: ["a", "c", "d", "pc"].to_json,
+    }
+    # puts 'Z'*40, request.inspect
+    expect(response.body).to eq([2,4,13,14].to_json)
+  end
+
+  it "should support CSV" do
+    get 'evaluate', {
+      format: :csv,
+      script: "M4",
+      node: "A",
+      attrs: ["a", "c", "d", "pc", "lc"].to_json,
+    }
+    # puts 'Z'*40, request.inspect
+    expect(response.body).to eq("2\r\n4\r\n13\r\n14\r\n14,14\r\n")
+  end
+
+  it "should support CSV (2)" do
+    get 'evaluate', {
+      format: :csv,
+      script: "M4",
+      node: "A",
+      attrs: ["result"].to_json,
+    }
+    # puts 'Z'*40, request.inspect
+    expect(response.body).to eq("a,b\r\n123,456\r\n789,101112\r\n")
+  end
+
+  it "should support api authorization - api_key not required" do
+    api = Marty::ApiAuth.new
+    api.app_name = 'TestApp'
+    api.script_name = 'M2'
+    api.save!
+
+    get 'evaluate', {
+      format: :json,
+      script: "M3",
+      node: "C",
+      attrs: ["pc"].to_json,
+    }
+    expect(response.body).to eq([7].to_json)
+  end
+
+  it "should support api authorization - api_key required but missing" do
+    api = Marty::ApiAuth.new
+    api.app_name = 'TestApp'
+    api.script_name = 'M3'
+    api.save!
+
+    get 'evaluate', {
+      format: :json,
+      script: "M3",
+      node: "C",
+      attrs: ["pc"].to_json,
+    }
+    expect(response.body).to match(/"error":"Permission denied"/)
+  end
+
+  it "should support api authorization - api_key required and supplied" do
+    api = Marty::ApiAuth.new
+    api.app_name = 'TestApp'
+    api.script_name = 'M3'
+    api.save!
+
+    get 'evaluate', {
+      format: :json,
+      script: "M3",
+      node: "C",
+      attrs: ["pc"].to_json,
+      api_key: api.api_key,
+    }
+    expect(response.body).to eq([7].to_json)
+  end
+
+  it "should support api authorization - api_key required but incorrect" do
+    api = Marty::ApiAuth.new
+    api.app_name = 'TestApp'
+    api.script_name = 'M3'
+    api.save!
+
+    get 'evaluate', {
+      format: :json,
+      script: "M3",
+      node: "C",
+      attrs: ["pc"].to_json,
+      api_key: api.api_key + 'x',
+    }
+    expect(response.body).to match(/"error":"Permission denied"/)
+  end
+
+  context "error handling" do
+    it 'returns bad attrs if attrs is not a string' do
+      get :evaluate, format: :json, attrs: 0
+      expect(response.body).to match(/"error":"Bad attrs"/)
+    end
+
+    it 'returns malformed attrs for improperly formatted json' do
+      get :evaluate, format: :json, attrs: "{"
+      expect(response.body).to match(/"error":"Malformed attrs"/)
+    end
+
+    it 'returns malformed attrs if attrs is not an array of strings' do
+      get :evaluate, format: :json, attrs: "{}"
+      expect(response.body).to match(/"error":"Malformed attrs"/)
+
+      get :evaluate, format: :json, attrs: "[0]"
+      expect(response.body).to match(/"error":"Malformed attrs"/)
+    end
+
+    it 'returns bad params if params is not a string' do
+      get(:evaluate, format: :json, params: 0)
+      expect(response.body).to match(/"error":"Bad params"/)
+    end
+
+    it 'returns malformed params for improperly formatted json' do
+      get :evaluate, format: :json, params: "{"
+      expect(response.body).to match(/"error":"Malformed params"/)
+    end
+
+    it 'returns malformed params if params is not a hash' do
+      get :evaluate, format: :json, params: "[0]"
+      expect(response.body).to match(/"error":"Malformed params"/)
+    end
+
+    it 'returns engine/tag lookup error if script not found' do
+      get :evaluate, format: :json, script: 'M1', tag: 'invalid'
+      expect(response.body).to match(/"error":"Can't get engine:/)
+      get :evaluate, format: :json, script: 'Invalid', tag: t1.name
+      expect(response.body).to match(/"error":"Can't get engine:/)
+    end
+
+    it 'returns the script runtime error (no node specified)' do
+      get :evaluate, format: :json, script: 'M1', tag: t1.name
+      expect(response.body).to match(/"error":"bad node/)
+    end
+  end
+end

data/spec/controllers/rpc_import_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Marty::RpcController do
+  before(:each) { @routes = Marty::Engine.routes }
+
+  before(:each) {
+    @tags = []
+    @tags << Marty::Script.load_script_bodies({
+                         "A" => "A:\n    a = 1\n",
+                         "B" => "B:\n    b = 0\n",
+                       }, Date.today)
+
+    @tags << Marty::Script.load_script_bodies({
+                         "B" => "import A\nB:\n    b = A::A().a\n",
+                       }, Date.today + 1.minute)
+
+    @tags << Marty::Script.load_script_bodies({
+                         "A" => "A:\n    a = 2\n",
+                       }, Date.today + 2.minute)
+
+
+    # create an untagged version for DEV
+    s = Marty::Script.lookup('infinity', "A")
+    s.body = "A:\n    a = 3\n"
+    s.save!
+  }
+
+  let(:tags) { @tags }
+
+  it "should properly import different versions of a script" do
+    # try the test 3 times for fun
+    (0..2).each {
+      tags.each_with_index { |t, i|
+        get 'evaluate', {
+          format: :json,
+          script: "B",
+          node: "B",
+          attrs: ["b"].to_json,
+          tag: t.name,
+        }
+        response.body.should == [i].to_json
+      }
+    }
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.