rb-gae-support 0.0.1

data/README.rdoc

@@ -0,0 +1,90 @@
+= rb-gae-support
+
+A gem that wraps GAE functionality.
+
+Currently provides easier access to the User service, Monkey Patches Net::HTTP
+to work on google app engine, and provides a simple wrapper for the Memcache service.
+
+This is very early work, so not very complete, and not production ready.
+
+== Usage
+
+=== Installation
+
+Must be installed into JRuby - this gem is useless under normal ruby.
+
+jruby -S gem install ruby-gae-support
+
+=== Net::HTTP
+
+In your code:
+
+    require 'rb-gae-support'
+
+as early as possible in your application, to make sure that any usage of
+Net::HTTP is caught.
+
+You should then be able to use Net::HTTP and gems that require it like normal.
+
+Note: It currently throws java exceptions rather than ruby exceptions - you
+may need to adjust code to suit. Converting these to the expected ruby
+exceptions is on the TODO list.
+
+=== GAE::User
+
+This wraps the user service, which allows you to authenticate users against
+Google accounts, and check if they have been marked as an Administrator in the
+admin console.
+
+<b>Get a URL for the login form</b>
+
+Call GAE::User.login_url, passing in the URL you wish to return the user to
+once they log in. This will return the URL for the login Form. e.g
+    redirect_to GAE::User.login_url('/home')
+
+<b>Get a URL to log the user out</b>
+
+Call GAE::User.logout_url, passing in the URL to return the user to after
+logging out. This will return the logout URL
+
+<b>Check if a User is logged in.</b>
+
+Call GAE::User.logged_in? . Will return true if a user is logged in, false if
+not.
+
+<b>Check if a User has been set as an Application Admin</>
+
+Call GAE::User.admin?
+
+<b>Get info about the user</b>
+
+Call GAE::User.current. This will return a GAE::User instance, which you can
+call email, nickname and auth_domain on to get those details.
+
+=== GAE::Memcache
+
+Allows you to store & retrieve items in Memcache. Resembles a hash
+
+<b>Storing data</b>
+
+    GAE::Memcache['key'] = 'value'
+
+<b>Storing data, with an expiry time</b>
+
+    # Expires in 1 minute
+    GAE::Memcache.put('key', 'value', 60000)
+
+<b>Retrieving Data</b>
+
+    read_data = GAE::Memcache['key']
+
+Returns nil if item not found.
+
+<b>Deleting data</b>
+
+    GAE::Memcache.delete('key')
+
+== Info
+<b>Author:</b> Lincoln Stoll (lstoll@lstoll.net / http://lstoll.net)
+
+<b>License:</b> MIT

data/TODO

@@ -0,0 +1,4 @@
+- wrapper for mail
+- maybe some datastore stuff. seeing how bumble goes.
+- No-RDOC the net:http stuff? Or leave it, and detail the differences.
+- catch java exceptions, convert to expected ruby ones

data/lib/rb-gae-support/memcache.rb

@@ -0,0 +1,38 @@
+require 'java'
+
+module GAE
+  # Wraps the google app engine memcache service. Can be used like a big hash
+  class Memcache
+
+    # Retrieves an object from the Memcache store by it's key
+    def self.[](key)
+      get_svc.get(key)
+    end
+
+    # Sets an object into memcache.
+    def self.[]=(key,value)
+      put(key, value)
+    end
+
+    # Adds an object to the store, otionally setting it's expiry X milliseconds in the future.
+    def self.put(key, value, expire_millis=nil)
+      if expire_millis
+        exp = com.google.appengine.api.memcache.Expiration.byDeltaMillis(expire_millis)
+        get_svc.put(key, value, exp)
+      else
+        get_svc.put(key, value)
+      end
+    end
+
+    # Deletes the object from the store
+    def self.delete(key)
+      get_svc.delete(key)
+    end
+
+    private
+    def self.get_svc
+      com.google.appengine.api.memcache.MemcacheServiceFactory.getMemcacheService()
+    end
+
+  end
+end

data/lib/rb-gae-support/net_http.rb

@@ -0,0 +1,84 @@
+# We need to monkey patch after these.
+require 'net/http'
+require 'net/https'
+require 'net/protocol'
+require 'java'
+
+module Net
+
+  # Monkey Patching bundled Net::HTTP Library for java.new.URLConnection
+  class HTTP < Protocol
+
+    # Creates an instance. Ignores proxy config, not needed
+    def self.new(address, port = nil, p_addr = nil, p_port = nil, p_user = nil, p_pass = nil)
+      # ignore proxy - google don't need it.
+      return newobj(address, port)
+    end 
+
+    # Contructor - saves address and port
+    def initialize(address, port = nil)
+      #raise 'got initialize'
+      @address = address
+      @port    = (port || HTTP.default_port)
+    end
+
+    # Actual request. Forms a URL, and uses a java.net.URLConnection to retrieve
+    # the body, which it inserts into a Net::HTTPResponse object. Actual
+    # network operation is completed here.
+    def request(req, body = nil, &block)
+      url = @use_ssl ? 'https://' : 'http://' + address + req.path
+      jurl = java.net.URL.new(url)
+      urlconn = jurl.openConnection()
+      inStream = java.io.InputStreamReader.new(urlconn.getInputStream())
+      buff = java.io.BufferedReader.new(inStream)
+      result = ''
+      while line = buff.readLine() do
+        result << line
+      end
+      
+      resp = HTTPResponse.new("1.1", urlconn.getResponseCode(), urlconn.getResponseMessage())
+      resp.body = result
+      resp
+    end
+
+    # We are always started
+    def started?
+      puts 'started called'
+      true #always started.
+    end
+
+    # Avoids OpenSSL calls, sets the use SSL value which is checked when
+    # generating the URL
+    def use_ssl=(flag)
+      flag = (flag ? true : false)
+      @use_ssl = flag
+    end
+
+    # Does nothing at the moment - avoiding OpenSSL
+    def verify_mode=(mode)
+      # TODO - check the verify mode, and make sure
+      # the URL fetcher uses it.
+    end
+    
+  end
+
+  # Monkey Patching bundled Net::HTTPResponse Library for java.new.URLConnection
+  class HTTPResponse
+    # This is where the body is put by Net::HTTP#request
+    attr_writer :body
+    
+    # Reads the response body. In our case the body has already been set in the
+    # request.
+    def read_body(dest = nil, &block)
+      # TODO - handle block situation better, rather than one dump.
+      if block
+        yield @body
+      else
+        @body
+      end
+    end
+    
+  end
+end
+
+

data/lib/rb-gae-support/openssl.rb

@@ -0,0 +1,10 @@
+# This module mocks out OpenSSL functionality to stop net/http erroring.
+module OpenSSL
+  # Providing a dummy SSL module
+  module SSL
+    # Dummy value to prevent errors with Net::HTTP
+    VERIFY_NONE = nil
+    # Dummy value to prevent errors with Net::HTTP
+    VERIFY_PEER = nil
+  end
+end

data/lib/rb-gae-support/user_service.rb

@@ -0,0 +1,49 @@
+module GAE
+  # This class represents the User service. It can be used to detemine if
+  # a user is logged in, if they are an admin, and retrieve their email,
+  # nickname and auth domain. It also provides the login and logout URLs.
+  class User
+    import com.google.appengine.api.users.UserServiceFactory
+  
+    attr_reader :email, :nickname, :auth_domain
+  
+    # Returns the current logged in user object, or false if not logged in
+    def self.current
+      # load from GAE and return, set vars
+      if UserServiceFactory.user_service.user_logged_in?
+        gu = UserServiceFactory.user_service.get_current_user
+        return User.new(gu.getEmail, gu.getNickname, gu.getAuthDomain)
+      else
+        return false
+      end
+    end
+  
+    # Returns the URL for the login form. Pass in the relative URL you
+    # wish to return to when the login is complete
+    def self.login_url(return_to)
+      UserServiceFactory.user_service.create_login_url(return_to)
+    end
+  
+    # Returns the URL to log out the user. Pass in the relative URL you
+    # wish to return to when the logout is complete
+    def self.logout_url(return_to)
+      UserServiceFactory.user_service.create_logout_url(return_to)
+    end
+  
+    # Returns true if the user is logged in, false if not
+    def self.logged_in?
+      UserServiceFactory.user_service.user_logged_in?
+    end
+  
+    # Returns true if the user is marked as an admin, false if not.
+    def self.admin?
+      UserServiceFactory.user_service.user_logged_in? && UserServiceFactory.user_service.user_admin?
+    end
+
+    private
+    def initialize(email,nickname,auth_domain)
+      @email, @nickname, @auth_domain = email, nickname, auth_domain
+    end
+
+  end
+end

data/lib/rb-gae-support.rb

@@ -0,0 +1,16 @@
+# This is a wrapper around the google provided services on appengine.
+# It is intended to make the services more 'ruby' like
+#
+# Author::    Lincoln Stoll  (mailto:lstoll@lstoll.net)
+# Copyright:: Copyright (c) 2009 Lincoln Stoll
+# License::   MIT
+
+require 'java'
+require File.dirname(__FILE__) + '/appengine-api-1.0-sdk-1.2.0.jar'
+directory = File.dirname(__FILE__)
+$:.unshift(directory) unless $:.include?(directory)
+
+require 'rb-gae-support/openssl'
+require 'rb-gae-support/user_service'
+require 'rb-gae-support/net_http'
+require 'rb-gae-support/memcache'

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: rb-gae-support
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lincoln Stoll
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-14 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Support utilities for ruby apps on Google App engine. Wraps GAE specific functionality, and modifies ruby standard libraries where needed (i.e Net:HTTP) to use GAE libraries
+email: lstoll@lstoll.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- TODO
+- lib/rb-gae-support
+- lib/rb-gae-support.rb
+- lib/rb-gae-support/net_http.rb
+- lib/rb-gae-support/memcache.rb
+- lib/rb-gae-support/openssl.rb
+- lib/rb-gae-support/user_service.rb
+- lib/appengine-api-1.0-sdk-1.2.0.jar
+has_rdoc: true
+homepage: http://github.com/lstoll/rb-gae-support
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+- --main
+- README.rdoc
+- --title
+- Ruby Goole AppEngine Support
+- README.rdoc
+- lib
+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: rb-gae-support
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: rb-gae-support is a support library for ruby apps on Google App Engine
+test_files: []
+