scenejs_on_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0c018e7eb556d0a1567186274fd7a8dffde1fd4
+  data.tar.gz: a0d0b24791560be6e87cd8109c639cba40536bac
+SHA512:
+  metadata.gz: 95b76943c9bcd0f36af5d8b0c72df8a832d0eff059fdaec207bdef02d268ef3d217e6aed74fcf21c044211901f08150326141e010ff5cf5a6d2629282639ec9c
+  data.tar.gz: c6233899faa7cc3faf692ca274114f6499264e542896efcb286f9e24bc24d8b0a058f74d47d6aff71c22904b22bb940f363dc1dda0ecde9c18b51c6e724611aa

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 scenejs_on_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Louis Alridge
+
+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,177 @@
+# Scenejs On Rails
+## Plugins last updated October 24th, 2013
+
+First off, if you dont know about [Scenejs]:http://scenejs.org/ ,go take a look so you can appreciate what this gem does.
+
+For the informed, this gem allows you to utilize scenejs and all of its plugin glory within rails WITHOUT having to load all
+of its javascript files into your asset pipeline. If you are fine with scenejs.org hosting your files AND not being able to
+easily create and utilize your own scenejs plugins, this gem is not for you. I repeat, if you don't plan on using self-made
+plugins, just pull from scenejs.org directly.
+
+Advantages:
+
+* You will be hosting all the scenejs plugins through this gem and can not worry about scenejs.org being unreachable
+* All plugins will be static
+* You can create plugins in vendor/assets/javascripts/scenejs_plugins and link to them easily
+* Images (gif, png, jpg) included in your plugins will be loaded as well and dont have to be embedded in asset pipeline
+* Your filesystem will NOT be exposed by this gem
+
+Disadvantages:
+* You will be hosting an additional 32MB
+* The scenejs.js file is ~580 kb
+
+## If the above sounds good to you, heres how to install
+
+Add this line to your application's Gemfile:
+
+    gem 'scenejs_on_rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scenejs_on_rails
+
+
+
+Then add this to your routes.rb
+    
+    $ resources :scenejs, only: [:get_scenejs_plugin]
+
+And finally add this to your application.js
+
+    $ //= require scenejs
+
+## Usage Example
+In a script tag:
+
+```javascript
+  // Demo of the "cameras/orbit" and "objects/space/planets/earth" custom node types
+
+  // Create scene
+  var scene = SceneJS.createScene({
+    nodes: [
+
+      {
+        type:"cameras/orbit",
+        id : "camera",
+        yaw:340,
+        pitch:-20,
+        zoom:7,
+        zoomSensitivity:1.0,
+        eye:{ y:0 },
+        look:{ y:0 },
+     
+        nodes:[
+          // Custom lighting to simulate the Sun
+          {
+            type:"lights",
+            lights:[
+              {
+                mode:"dir",
+                color:{ r:1.0, g:1.0, b:1.0 },
+                diffuse:true,
+                specular:true,
+                dir:{ x:-0.5, y:-0.5, z:-0.75 }
+              }
+            ],
+
+            nodes:[
+              // Planet Earth,
+              // implemented by plugin at http://scenejs.org/api/latest/plugins/node/objects/space/planets/earth.js
+              {
+                type:"objects/space/planets/earth"
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  });
+```
+
+This will render the SceneJS team's awesome earth graphic with no additional work on your part. If it doesnt, there is a problem
+and you should create an issue about it.
+
+## Detailed Information
+
+Simply by declaring 
+
+```javascript
+  type: 'myplugin/path'
+```
+for a node, scenejs will send a request to your app for the plugin data it needs. If it is looking for javascripts that define the node,
+it will recieve them as raw inline javascript and then mark that plugin as loaded. It looks in your /vendor/assets/javascripts/scenejs_plugins folder
+THEN in its own directory for the javascripts. If it doesn't find the data, the scenejs controller (within rails) raises a 
+ActionController::RoutingError error.
+
+If you want to link to a image within a plugin you made you should set this in your init function
+```javascript
+  SceneJS.Types.addType("objects/spacee/my_planets/awesome_sun", {
+    
+    init:function (params) {
+
+      var texturePath = "node/objects/space/my_planets/awesome_sun/";
+```
+Then set your texture nodes like so
+```javascript
+  type: "texture",
+  layers: [
+    {
+      src: texturePath + 'mysunimg.png'
+    }
+  ],
+```
+This will tell scenejs to grab the image data from scenejs controller's get_plugin_data url. The image data is served via send_data(location_of_image_file).
+
+### NOTE!
+
+If you plan on using images / whatever as textures within an init file (something that defines the base scene like above), just use your asset pipeline.
+
+```javascript
+  type: "texture",
+  layers: [
+    {
+      src: "<%= asset_path 'mytexture.jpg' %>"
+    }
+  ],
+```
+
+## Vulnerability via looking for the files?
+
+For the security minded, the scenejs controller figures out where to find its files from params[:file] then searching in two possible locations for that data.
+As the location parses uses File.join() it was possible for an attacker to use '..' to dig up files they are not meant to find. This has been prevented through
+statements that scan the params[:file] string. If this occurs, the controller will raise a ActionController::UnpermittedParameters error. This will never occur
+normally.
+
+## So why did you need to modify the original source?
+
+```javascript
+  SceneJS.setConfigs({
+   pluginPath: (((location.protocol.length === 0) ? 'http://' : location.protocol + '//') + location.host + '/scenejs/get_scenejs_data?file=')
+  });
+```
+
+Is the only edit made to scenejs.js source. Everything else happens naturally through the parsing of the files. Kudos to the SceneJS team on this by the way,
+Louis Alridge had originally written some hacks into the source to get things to work just right, but with 3.2 simply adding that is all thats needed.
+
+
+
+## SceneJS Libraries
+
+Certain libraries like stats.min must be included through the asset pipeline in your application.js like this:
+
+    $ //= require scenejs_lib/stats.min
+
+Anything you'd normally find in /examples/libs in the scenejs repo can be found there... Extras can be found with
+
+    $ //= require scenejs_extras/gui
+
+### NOTE!
+
+You may run into some libraries that don't work because they dont call on the SceneJS pluginPath variable and instead try finding their dependencies
+through the filesystem (like the standard physics engine). Theres nothing you can really do about this unless you want to get your hands dirty with some js.
+If you run into these, submit an issue (to both this gem and to the scenejs repo). You can 'fix' this by putting the files causing the problem in YOUR vendor
+directory and fixing them there at the very least. 

data/Rakefile

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

data/lib/scenejs_on_rails/version.rb

@@ -0,0 +1,4 @@
+module ScenejsOnRails
+  VERSION = "1.0.0"
+  SCENEJS_VERSION = "3.2"
+end

data/lib/scenejs_on_rails.rb

@@ -0,0 +1,6 @@
+require "scenejs_on_rails/version"
+
+module ScenejsOnRails
+end
+
+require 'scenejs_on_rails/rails'

data/scenejs_on_rails.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scenejs_on_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scenejs_on_rails"
+  spec.version       = ScenejsOnRails::VERSION
+  spec.authors     = ["Louis Alridge"]
+  spec.email       = ["loualrid@gmail.com"]
+  spec.homepage    = "https://github.com/loualrid/scenejs_on_rails"
+  spec.summary     = %q{Scenejs On Rails Smart Asset Management}
+  spec.description = <<-EOF
+    ### Features ###
+    * Allows you to utilize scenejs without having to clutter up your assets with tons of js files for self hosters.
+    * Seamlessly allows you to create and utilize plugins you've made and placed in your vendor/assets/javascripts/scenejs_plugins directory
+    * Preserves the directory structure of scenejs plugins, you can keep your custom made plugins in a place where scenejs
+      can find them.
+  EOF
+
+  spec.rubyforge_project = "scenejs_on_rails"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rails', '>= 3.1.1'
+
+  spec.license = 'MIT'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: scenejs_on_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Louis Alridge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      ### Features ###
+      * Allows you to utilize scenejs without having to clutter up your assets with tons of js files for self hosters.
+      * Seamlessly allows you to create and utilize plugins you've made and placed in your vendor/assets/javascripts/scenejs_plugins directory
+      * Preserves the directory structure of scenejs plugins, you can keep your custom made plugins in a place where scenejs
+        can find them.
+email:
+- loualrid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scenejs_on_rails.rb
+- lib/scenejs_on_rails/version.rb
+- scenejs_on_rails.gemspec
+homepage: https://github.com/loualrid/scenejs_on_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: scenejs_on_rails
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Scenejs On Rails Smart Asset Management
+test_files: []