rack-sl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8d7e4d19c1e06a7f94592b8feea46b4d8ce21f1
+  data.tar.gz: 9db9c15713f1ba8289416f6234c2640bd4f45215
+SHA512:
+  metadata.gz: 2defb1bf2c89381c4d2f69476733ff41cce817f6d6c67285af9b5ae4ae6266204e20c2ecb10a3e26c80a4b807b17431b853db2b5d0771151a14e9a3358c937d1
+  data.tar.gz: 55bf8718d3414c64f5a638d5c7092011377a720a57e32ec833b1994208f1da59b2f234a1189ba0c79546a221136e347f5aaf2511abde8892f97edb7acddb1d06

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    rack-sl (0.0.1)
+      rack (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.2.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (2.6.0)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    listen (2.4.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    slop (3.4.7)
+    thor (0.18.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec (~> 2.0)
+  rack-sl!
+  rspec (~> 2.0)

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bennett Goble
+
+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,79 @@
+# Rack::SL
+
+Rack::SL adds basic recognition of [Second Life][sl]® ([LSL][lsl] script) requests. It parses [X-SecondLife][headers] headers into structs for easy reference within [Rack][rack] applications.
+
+## Install
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'rack-sl'
+```
+
+### Accessing Parsed Information
+
+**Rack::SL** adds value to [Rack's][rack] `env` Hash with the key `sl`. This value is an *OpenStruct* with the following data:
+
+| Key      | Value     | Description                                         | Present        |
+|----------|-----------|-----------------------------------------------------|----------------|
+| from_sl  | bool      | Whether the request had all of SL's X headers       | Always         |
+| error    | exception | Exception caught while parsing headers              | If encountered |
+| name     | string    | Originating object's name                           | If from_sl     |
+| key      | string    | UUID of originating object                          | If from_sl     |
+| region   | struct    | Struct with region name and `x` and `y` coordinates | If from_sl     |
+| owner    | struct    | Struct with owner's `name` and `key` (UUID)         | If from_sl     |
+| position | struct    | Struct with `x`, `y` and `z` coordinates            | If from_sl     |
+| rotation | struct    | Struct with `x`, `y`, `z` and `s` coordinates       | If from_sl     |
+| velocity | struct    | Struct with `x`, `y` and `z` coordinates            | If from_sl     |
+
+### Rails
+
+Configure Rails to use *Rack::SL* in the `config/application.rb` file:
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+
+  # ...
+
+  config.middleware.use Rack::SL
+
+  end
+end
+```
+
+### Sinatra
+
+```ruby
+require 'sinatra'
+
+configure do
+  use Rack::SL
+end
+
+# ...
+
+```
+...or in a modular app:
+
+```ruby
+require 'sinatra/base'
+
+class MyApp < Sinatra::Base
+  configure do
+
+    # ...
+    
+    use Rack::SL
+  end
+
+  # ...
+
+  run!
+end
+```
+
+[sl]: http://secondlife.com/ "Official Second Life Homepage"
+[lsl]: http://wiki.secondlife.com/wiki/LSL_Portal "Linden Scripting Language"
+[headers]: http://wiki.secondlife.com/wiki/LlHTTPRequest "X-SecondLife HTTP Header Documentation"
+[rack]: https://github.com/rack/rack "Rack Github Repository"

data/Rakefile

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

data/lib/rack/sl.rb

@@ -0,0 +1,57 @@
+require 'ostruct'
+
+SLVector3 = Struct.new(:x, :y, :z)
+SLQuaternion = Struct.new(:x, :y, :z, :s)
+SLRegion = Struct.new(:name, :x, :y)
+SLOwner = Struct.new(:name, :key)
+
+module Rack
+  class SL
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      sl = env['HTTP_X_SECONDLIFE_REGION'] ? parse_headers(env) : {from_sl: false}
+      env['sl'] = OpenStruct.new(sl)
+      @app.call(env)
+    end
+
+    private
+
+    def parse_headers(env)
+      begin
+        sl              = {from_sl: true}
+        sl[:shard]      = env['HTTP_X_SECONDLIFE_SHARD']
+        sl[:name]       = env['HTTP_X_SECONDLIFE_OBJECT_NAME']
+        sl[:key]        = env['HTTP_X_SECONDLIFE_OBJECT_KEY']
+        sl[:region]     = parse_region(env['HTTP_X_SECONDLIFE_REGION'])
+        sl[:position]   = parse_vector3(env['HTTP_X_SECONDLIFE_LOCAL_POSITION'])
+        sl[:rotation]   = parse_rotation(env['HTTP_X_SECONDLIFE_LOCAL_ROTATION'])
+        sl[:velocity]   = parse_vector3(env['HTTP_X_SECONDLIFE_LOCAL_VELOCITY'])
+        sl[:owner]      = SLOwner.new(env['HTTP_X_SECONDLIFE_OWNER_NAME'], 
+                                      env['HTTP_X_SECONDLIFE_OWNER_KEY'])
+        sl
+      rescue => e
+        {from_sl: false, error: e}
+      end
+    end
+
+    def parse_region(value)
+      name = /^.+(?= \()/.match(value).to_s
+      x, y = value.match(/\((\-?[0-9]+), (\-?[0-9]+)\)/).captures
+      SLRegion.new(name, x.to_i, y.to_i)
+    end
+
+    def parse_vector3(value)
+      x, y, z = value.scan(/\-?\d+.\d+/)
+      SLVector3.new(x.to_f, y.to_f, z.to_f)
+    end
+
+    def parse_rotation(value)
+      x, y, z, s = value.scan(/\-?\d+.\d+/)
+      SLQuaternion.new(x.to_f, y.to_f, z.to_f, s.to_f)
+    end
+  end
+end

data/lib/rack/sl/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class SL
+    VERSION = '0.0.1'
+  end
+end

data/rack-sl.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+require './lib/rack/sl/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'rack-sl'
+  s.version  = Rack::SL::VERSION
+  s.summary  = 'Rack middleware for parsing X-SecondLife headers.'
+  s.homepage = 'https://github.com/nivardus/rack-sl'
+  s.authors  = ['Bennett Goble']
+  s.license  = 'MIT'
+
+  s.files         = `git ls-files`.split($/).reject { |f| f == '.gitignore' }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rack', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'guard-rspec',  '~> 2.0'
+end

data/spec/helpers.rb

@@ -0,0 +1,30 @@
+require 'rack/mock'
+
+module Helpers
+
+  def valid_headers
+    env = default_env
+    env['HTTP_X_SECONDLIFE_SHARD']          = 'Production'
+    env['HTTP_X_SECONDLIFE_OBJECT_NAME']    = 'Object'
+    env['HTTP_X_SECONDLIFE_OBJECT_KEY']     = '01234567-89ab-cdef-0123-456789abcdef'
+    env['HTTP_X_SECONDLIFE_REGION']         = 'Jin Ho (264448, 233984)'
+    env['HTTP_X_SECONDLIFE_LOCAL_POSITION'] = '(173.009827, 75.551231, 60.950001)'
+    env['HTTP_X_SECONDLIFE_LOCAL_ROTATION'] = '-0.17304, 0.14914, 0.22335, 0.94759'
+    env['HTTP_X_SECONDLIFE_LOCAL_VELOCITY'] = '1.000000, 0.500000, -0.250000'
+    env['HTTP_X_SECONDLIFE_OWNER_NAME']     = 'Nivardus String'
+    env['HTTP_X_SECONDLIFE_OWNER_KEY']      = '01234567-89ab-cdef-0123-456789abcdef'
+    env
+  end
+
+  def invalid_headers
+    env = default_env
+    env['HTTP_X_SECONDLIFE_SHARD']          = 'Production'
+    env['HTTP_X_SECONDLIFE_REGION']         = 'Jin Ho (264448, 233984)'
+    env['HTTP_X_SECONDLIFE_LOCAL_POSITION'] = '(173.009827, 75.551231, 60.950001)'
+    env
+  end
+
+  def default_env
+    Rack::MockRequest.env_for
+  end
+end

data/spec/sl_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Rack::SL do
+
+  context '.call' do
+    let(:app) { lambda { |env| env }}
+    let(:middleware) do
+      Rack::SL.new(app)
+    end
+
+    context 'with no SL headers' do
+      let(:request_env) { default_env }
+      let(:env) { middleware.call(request_env) }
+
+      it 'should add SL information to env' do
+        env.should include('sl')
+      end
+
+      it 'should identify that the request is not from SL' do
+        env['sl'].from_sl.should eq(false)
+      end
+    end
+
+    context 'with valid SL headers' do
+      let(:request_env) { valid_headers }
+      let(:env) { middleware.call(request_env) }
+      let(:sl) { env['sl'] }
+
+      it 'should add SL information to env' do
+        env.should include('sl')
+      end
+
+      it 'should identify that the request is from SL' do
+        sl.from_sl.should eq(true)
+      end
+
+      it 'should parse header information' do
+        sl.region.name.should eq('Jin Ho')
+        sl.region.x.should eq(264448)
+        sl.region.y.should eq(233984)
+        sl.name.should eq('Object')
+        sl.key.should eq('01234567-89ab-cdef-0123-456789abcdef')
+        sl.owner.name.should eq('Nivardus String')
+        sl.owner.key.should eq('01234567-89ab-cdef-0123-456789abcdef')
+        sl.position.x.should eq(173.009827)
+        sl.position.y.should eq(75.551231)
+        sl.position.z.should eq(60.950001)
+        sl.rotation.x.should eq(-0.17304)
+        sl.rotation.y.should eq(0.14914)
+        sl.rotation.z.should eq(0.22335)
+        sl.rotation.s.should eq(0.94759)
+        sl.velocity.x.should eq(1.0)
+        sl.velocity.y.should eq(0.5)
+        sl.velocity.z.should eq(-0.25)
+      end
+    end
+
+    context 'with invalid SL headers' do
+      let(:request_env) { invalid_headers }
+      let(:env) { middleware.call(request_env) }
+
+      it 'should add SL information to env' do
+        env.should include('sl')
+      end
+
+      it 'should identify that the request is not from SL' do
+        env['sl'].from_sl.should eq(false)
+      end
+
+      it 'should include the first error' do
+        env['sl'].error.should_not eq(nil)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rack/sl'
+require_relative 'helpers'
+
+RSpec.configure do |config|
+  config.include Helpers
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rack-sl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bennett Goble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack/sl.rb
+- lib/rack/sl/version.rb
+- rack-sl.gemspec
+- spec/helpers.rb
+- spec/sl_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nivardus/rack-sl
+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: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Rack middleware for parsing X-SecondLife headers.
+test_files:
+- spec/helpers.rb
+- spec/sl_spec.rb
+- spec/spec_helper.rb