appengine-rack 0.0.1

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+SUMMARY = <<EOF
+Commom dependencies for configuring an App Engine application via Rack.
+EOF
+
+spec = Gem::Specification.new do |s|
+  s.name = "appengine-rack"
+  s.version = "0.0.1"
+  s.author = "Ryan Brown"
+  s.email = "ribrdb@google.com"
+  s.homepage = "http://code.google.com/p/appengine-jruby"
+  s.description = s.summary = SUMMARY
+  
+  s.platform = Gem::Platform::RUBY
+  
+  s.add_dependency "rack"
+  
+  s.require_path = 'lib'
+  s.files = %w(LICENSE Rakefile) + Dir.glob("lib/**/*")
+end
+
+task :default => :spec
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/appengine-rack.rb

@@ -0,0 +1,203 @@
+#!/usr/bin/ruby1.8 -w
+#
+# Copyright:: Copyright 2009 Google Inc.
+# Original Author:: Ryan Brown (mailto:ribrdb@google.com)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+begin
+  require 'appengine-apis/urlfetch'
+rescue LoadError
+end
+
+module AppEngine
+  module Rack
+    ROOT = File.expand_path(File.dirname(__FILE__))
+    
+    class Resources
+      def initialize
+        @includes = []
+        @excludes = []
+      end
+    
+      def include(glob)
+        @includes << glob
+      end
+    
+      def exclude(glob)
+        @excludes << glob
+      end
+    
+      def append_to(xml, type)
+        resources = xml.add_element(type) 
+        @includes.each do |path|
+          resources.add_element('include').add_attribute('path', path)
+        end
+        @excludes.each do |path|
+          resources.add_element('exclude').add_attribute('path', path)
+        end
+      end
+    end
+  
+    class PropertyMap < Hash
+      def append_to(xml)
+        unless empty?
+          sys = xml.add_element('system-properties') 
+          each do |name, value|
+            sys.add_element('property').
+                add_attributes( { "name" => name, "value" => value } )
+          end
+        end
+      end
+    end
+  
+    class EnvVarMap < Hash
+      def append_to(xml)
+        unless empty?
+          env = xml.add_element('env-variables') 
+          each do |name, value|
+            env.add_element('env-var').
+                add_attributes( { "name" => name, "value" => value } )
+          end
+        end
+      end    
+    end
+  
+    class RackApplication
+      attr_accessor :application, :public_root
+      attr_reader :version, :static_files, :resource_files
+      attr_reader :system_properties, :environment_variables
+      attr_writer :ssl_enabled, :sessions_enabled
+    
+      def initialize
+        @version = '1'
+        @system_properties = PropertyMap[ 'os.arch' => '',
+                         'jruby.management.enabled' => 'false' ]
+        @environment_variables = EnvVarMap.new
+        @static_files = Resources.new
+        @resource_files = Resources.new
+        @public_root = '/public'
+      end
+    
+      alias id application
+    
+      def sessions_enabled?
+        @sessions_enabled
+      end
+    
+      def ssl_enabled?
+        @ssl_enabled
+      end
+      
+      def version=(version)
+        @version = version.to_s
+      end
+    
+      def configure(options={})
+        [:system_properties, :environment_variables].each do |key|
+          self.send(key).merge!(options.delete(key)) if options[key]
+        end
+        options.each { |k,v| self.send("#{k}=", v) }
+      end
+    
+      def to_xml
+        require 'rexml/document'
+
+        xml = REXML::Document.new.add_element('appengine-web-app')
+        xml.add_attribute('xmlns','http://appengine.google.com/ns/1.0')
+        xml.add_element('application').add_text(application)
+        xml.add_element('version').add_text(version)
+        xml.add_element('public-root').add_text(@public_root) if @public_root
+        static_files.append_to(xml, 'static-files')
+        resource_files.append_to(xml, 'resource-files')
+        system_properties.append_to(xml)
+        environment_variables.append_to(xml)
+        if sessions_enabled?
+          xml.add_element('sessions-enabled').add_text('true')
+        end
+        if ssl_enabled?
+          xml.add_element('ssl-enabled').add_text('true')
+        end
+        return xml
+      end
+    end
+    
+    class SecurityMiddleware
+      def self.append_xml(doc, pattern)
+        security = doc.add_element('security-constraint')
+        collection = security.add_element('web-resource-collection')
+        collection.add_element('url-pattern').add_text(
+            AppEngine::Rack.make_wildcard(pattern))
+        yield security
+      end
+
+      def self.new(app, *args, &block)
+        app
+      end      
+      
+    end
+    
+    class AdminRequired < SecurityMiddleware
+      def self.append_xml(doc, pattern)
+        super(doc, pattern) do |security|
+          auth = security.add_element('auth-constraint')
+          auth.add_element('role-name').add_text('admin')
+        end
+      end
+    end
+  
+    class LoginRequired < SecurityMiddleware
+      def self.append_xml(doc, pattern)
+        super(doc, pattern) do |security|
+          auth = security.add_element('auth-constraint')
+          auth.add_element('role-name').add_text('*')
+        end
+      end
+    end
+
+    class SSLRequired < SecurityMiddleware
+      def self.append_xml(doc, pattern)
+        super(doc, pattern) do |security|
+          udc = security.add_element('user-data-constraint')
+          udc.add_element('transport-guarantee').add_text('CONFIDENTIAL')
+        end
+      end
+    end  
+
+    class << self
+      def app
+        @app ||= RackApplication.new
+      end
+
+      def configure_app(options={})
+        @app = RackApplication.new
+        @app.configure(options)
+      end
+
+      def environment
+        if $servlet_context
+          if $servlet_context.server_info =~ %r{^Google App Engine Development/}
+            "development"
+          elsif $servlet_context.server_info =~ %r{^Google App Engine/}
+            "production"
+          end
+        end
+      end
+      
+      
+      def make_wildcard(pattern)
+        "#{pattern}/*".squeeze('/')
+      end
+    end
+  end
+end

data/lib/appengine-rack/java.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/ruby1.8 -w
+#
+# Copyright:: Copyright 2009 Google Inc.
+# Original Author:: Ryan Brown (mailto:ribrdb@google.com)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'appengine-rack'
+
+class JavaServlet
+  def initialize(klass, options={})
+    @klass = klass.to_s
+    @name = (options[:name] || klass).to_s
+    @wildcard = options[:wildcard]
+  end
+  
+  def call(env)
+    raise RuntimeError, "JavaServlet should be dispatched by web.xml"
+  end
+  
+  def append_xml(doc, pattern)
+    servlet = doc.add_element('servlet')
+    servlet.add_element('servlet-name').add_text(@name)
+    servlet.add_element('servlet-class').add_text(@klass)
+    map = doc.add_element('servlet-mapping')
+    map.add_element('servlet-name').add_text(@name)
+    map.add_element('url-pattern').add_text(pattern.to_s)
+    if @wildcard
+      wildcard = doc.add_element('servlet-mapping')
+      wildcard.add_element('servlet-name').add_text(@name)
+      wildcard.add_element('url-pattern').add_text(
+          AppEngine::Rack.make_wildcard(pattern))
+    end
+  end
+end
+
+class JavaServletFilter
+  def self.append_xml(doc, pattern, klass, options={})
+    name = options[:name] || klass
+    filter = doc.add_element('filter')
+    filter.add_element('filter-name').add_text(name.to_s)
+    filter.add_element('filter-class').add_text(klass.to_s)
+    map = doc.add_element('filter-mapping')
+    map.add_element('filter-name').add_text(name.to_s)
+    map.add_element('url-pattern').add_text(pattern.to_s)
+    if options[:wildcard]
+      wildcard = doc.add_element('filter-mapping')
+      wildcard.add_element('filter-name').add_text(name.to_s)
+      wildcard.add_element('url-pattern').add_text(
+          AppEngine::Rack.make_wildcard(pattern))
+    end
+  end
+  
+  def self.new(app, *args, &block)
+    app
+  end
+end
+
+class JavaContextListener
+  def self.append_xml(doc, pattern, klass)
+    listener = doc.add_element('listener')
+    listener.add_element('listener-class').add_text(klass.to_s)
+  end
+  
+  def self.new(app, *args, &block)
+    app
+  end
+end
+
+class JavaContextParams
+  def self.append_xml(doc, pattern, params)
+    params.each do |name, value|
+      e = doc.add_element('context-param')
+      e.add_element('param-name').add_text(name.to_s)
+      e.add_element('param-value').add_text(value.to_s)
+    end
+  end
+  
+  def self.new(app, *args, &block)
+    app
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: appengine-rack
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |
+  Commom dependencies for configuring an App Engine application via Rack.
+
+email: ribrdb@google.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Rakefile
+- lib/appengine-rack/java.rb
+- lib/appengine-rack.rb
+has_rdoc: true
+homepage: http://code.google.com/p/appengine-jruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Commom dependencies for configuring an App Engine application via Rack.
+test_files: []
+