paasmaker-interface 0.9.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Daniel Foote
+
+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,91 @@
+Paasmaker Ruby Interface Library
+================================
+
+This is a simple Ruby library that is designed to read in the Paasmaker
+configuration, falling back to a custom configuration file in development.
+
+Usage - Rails
+-------------
+
+If you want to use this with your Rails project, do the following steps:
+
+* Add paasmaker-interface to your Gemfile:
+
+```ruby
+gem 'paasmaker-interface'
+```
+
+* Update your database.yml file to look like the following:
+
+```yaml
+<% require 'paasmaker' %>
+<% interface = Paasmaker::Interface.new(['../project-configuration.yml']) %>
+<% database = interface.get_service('postgres') %>
+
+production:
+  adapter: postgresql
+  database: "<%= database['database'] %>"
+  host: "<%= database['hostname'] %>"
+  username: "<%= database['username'] %>"
+  password: "<%= database['password'] %>"
+  port: "<%= database['port'] %>"
+```
+
+  And update your adapter as appropriate for your application.
+
+Usage - Other applications
+--------------------------
+
+To read in the configuration details in other applications, you can instantiate
+the Interface class directly and work with it.
+
+```ruby
+require 'paasmaker'
+
+interface = Paasmaker::Interface.new(['../project-configuration.yml'])
+
+interface.is_on_paasmaker?()
+
+service = interface.get_service('service')
+```
+
+Example Configuration Overrides
+-------------------------------
+
+Example YAML configuration file:
+
+```yaml
+services:
+  parameters:
+    foo: bar
+
+application:
+  name: test
+  version: 1
+  workspace: Test
+  workspace_stub: test
+```
+
+Example JSON configuration file:
+
+```json
+{
+	"services": {
+		"parameters": {
+			"foo": "bar"
+		}
+	},
+	"application": {
+		"name": "test",
+		"version": 1,
+		"workspace": "Test",
+		"workspace_stub": "test"
+	}
+}
+```
+
+Testing
+-------
+
+To run the unit tests for the interface, just execute test.rb
+in the root of the project.

data/lib/paasmaker.rb

@@ -0,0 +1,192 @@
+# Copyright (c) 2013 Daniel Foote.
+#
+# See the file LICENSE for copying permission.
+# The licence is the MIT licence.
+
+# TODO: What Gem is required to make YAML work?
+require 'yaml'
+require 'json'
+
+module Paasmaker
+
+    # Exception raised when something goes wrong
+    # with the interface. The message should indicate
+    # what went wrong.
+    class InterfaceException < Exception
+    end
+
+    # An interface class for Paasmaker. It can parse
+    # the Paasmaker environment variables and supply them
+    # to your application. Alternately, it can load override
+    # configuration files to fill in missing values if it is
+    # not running on Paasmaker.
+    class Interface
+        # Create a new instance of the interface class. Supply
+        # an array of override path names. For example, supply
+        # <tt>['../project-name.json']</tt> to load a configuration file
+        # one level above your project root.
+        def initialize(override_paths)
+            @override_paths = override_paths
+            @is_on_paasmaker = false
+            @variables = {}
+            @services = {}
+            # It's over 9000.
+            @port = 9001
+
+            parse_metadata()
+        end
+
+        # Helper function to parse the Paasmaker metadata. You
+        # should not call this externally.
+        def parse_metadata() # :nodoc:
+            raw_services = ENV['PM_SERVICES']
+            raw_metadata = ENV['PM_METADATA']
+            raw_port = ENV['PM_PORT']
+
+            if raw_services and raw_metadata
+                # We're running on Paasmaker.
+                @is_on_paasmaker = true
+
+                # Load from environment variables.
+                @variables = JSON.parse(raw_metadata)
+                @services = JSON.parse(raw_services)
+
+                if raw_port
+                    @port = raw_port.to_i()
+                end
+            else
+                # Not running on Paasmaker, load from
+                # a configuration file.
+                load_configuration_file()
+            end
+        end
+
+        # Helper function to find and load a configuration file.
+        # You should not need to call this externally.
+        def load_configuration_file() # :nodoc:
+            @override_paths.each do |path|
+                if File.exist?(path)
+
+                    if path.end_with?('.yml')
+                        # It's YAML, parse it as such.
+                        data = YAML.load_file(path)
+                    elsif path.end_with?('.json')
+                        # It's JSON.
+                        data = JSON.parse(IO.read(path))
+                    end
+
+                    store_configuration(path, data)
+                    return
+                end
+
+            end
+
+            # If we got here, we were not able to load any files.
+            raise InterfaceException, "Unable to find any configuration files to load."
+        end
+
+        # Helper function to store a loaded configuration. You should
+        # not call this externally.
+        def store_configuration(path, data) # :nodoc:
+            # Validate the data first, filling in some missing blanks.
+            if not data.has_key?('services')
+                data['services'] = {}
+            end
+
+            if not data.has_key?('workspace')
+                data['workspace'] = {}
+            end
+
+            if not data.has_key?('node')
+                data['node'] = {}
+            end
+
+            if not data.has_key?('application')
+                raise InterfaceException, "You must have application data in your configuration file."
+            end
+
+            if data.has_key?('port')
+                @port = data['port']
+            end
+
+            required_keys = ['name', 'version', 'workspace', 'workspace_stub']
+            required_keys.each do |key|
+                if not data['application'].has_key?(key)
+                    raise InterfaceException, "Missing required key #{key} in application section."
+                end
+            end
+
+            # Store it all away.
+            @services = data['services']
+            @variables = data
+        end
+
+        # Return true if the application is running on Paasmaker.
+        def is_on_paasmaker?()
+            return @is_on_paasmaker
+        end
+
+        # Get a named service from Paasmaker. Raises an InterfaceException
+        # if there is no such service.
+        def get_service(name)
+            if @services.has_key?(name)
+                return @services[name]
+            else
+                raise InterfaceException, "No such service #{name}."
+            end
+        end
+
+        # Return all the services assigned to this application.
+        def get_all_services()
+            return @services
+        end
+
+        # Get the application name.
+        def get_application_name()
+            return @variables['application']['name']
+        end
+
+        # Get the application version.
+        def get_application_version()
+            return @variables['application']['version']
+        end
+
+        # Get the workspace name.
+        def get_workspace_name()
+            return @variables['application']['workspace']
+        end
+
+        # Get the workspace stub.
+        def get_workspace_stub()
+            return @variables['application']['workspace_stub']
+        end
+
+        # Get the node tags. Returns a Hash of the tags.
+        def get_node_tags()
+            return @variables['node']
+        end
+
+        # Get the workspace tags. Returns a Hash of the tags.
+        def get_workspace_tags()
+            return @variables['workspace']
+        end
+
+        # Get the port that you should be listening on.
+        def get_port()
+            return @port
+        end
+
+        # Helper to fetch the rails environment. The way this works is
+        # that it looks for the <tt>RAILS_ENV</tt> key on the workspace
+        # metadata, and uses that if found. If not, it uses the default
+        # supplied.
+        def get_rails_env(default)
+            workspace_tags = get_workspace_tags()
+            if workspace_tags.has_key?('RAILS_ENV')
+                return workspace_tags['RAILS_ENV']
+            else
+                return default
+            end
+        end
+    end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: paasmaker-interface
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Foote
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A helper class that makes it easier to interface with the Paasmaker platform-as-a-service.
+email:
+- freefoote@paasmaker.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/paasmaker.rb
+- README.md
+- LICENSE
+homepage: http://paasmaker.org
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An application interface to Paasmaker.
+test_files: []
+has_rdoc: