openstax_utilities 0.0.1 → 0.0.2

data/README.md

@@ -1,3 +1,6 @@
-= OpenstaxUtilities
+OpenstaxUtilities
+=================
 
-This project rocks and uses MIT-LICENSE.
+A set of common utilities for the various OpenStax projects.  
+
+Documentation available on [rdoc.info](http://rdoc.info/github/openstax/openstax_utilities/master/frames).

data/lib/openstax/utilities/access.rb

@@ -0,0 +1,45 @@
+
+ActionController::Base.define_singleton_method(:protect_beta) do |options={}|
+  options[:username] ||= SecureRandom.hex
+  options[:password] ||= SecureRandom.hex
+  options[:enable_always] ||= false
+  options[:message] ||= ''
+  
+  return if !(options[:enable_always] || Rails.env.production?)
+
+  prepend_before_filter do 
+    authenticate_or_request_with_http_basic(options[:message]) do |username, password|
+      username == options[:username] && password == options[:password]
+    end
+  end
+end
+
+module OpenStax
+  module Utilities
+    module Access
+
+      # Called in a controller to provide an outer level of basic HTTP 
+      # authentication, typically used when code is deployed during development
+      # and it is not yet ready for public consumption.
+      #
+      # Example:
+      # 
+      #   class ApplicationController < ActionController::Base
+      #     protect_beta :username => 'bob',
+      #                  :password => '123'
+      #
+      # @param :username The authentication username; default value is a random hex string
+      # @param :password The authentication password; default value is a random hex string
+      # @param :enable_always The default is the authentication is only enabled
+      # in production, setting this to true will make it effective in all 
+      # environments
+      # @param :message If given, this message will be displayed in the browser's
+      # authentication dialog box.
+      #
+      def self.protect_beta(options={})
+        # Just here for documentation purposes, see code above
+      end
+
+    end
+  end
+end

data/lib/openstax/utilities/development.rb

@@ -0,0 +1,8 @@
+module OpenStax
+  module Utilities
+    module Development
+
+
+    end
+  end
+end

data/lib/openstax/utilities/engine.rb

@@ -1,4 +1,4 @@
-module Openstax
+module OpenStax
   module Utilities
     class Engine < ::Rails::Engine
     end

data/lib/openstax/utilities/{file.rb → settings.rb}

@@ -1,7 +1,7 @@
 
 module OpenStax
   module Utilities
-    module File
+    module Settings
 
       # Reads and returns a hash of YAML settings from a file
       # @param calling_file This should always be __FILE__
@@ -10,7 +10,7 @@ module OpenStax
       # this method to look up one directory from the directory of calling_file
       # @param filename the plain filename, e.g. 'foobar.yml'
       #
-      def load_settings(calling_file, relative_directory, filename)
+      def self.load_settings(calling_file, relative_directory, filename)
         settings = {}
         
         filename = File.join(File.dirname(calling_file), '..', 'developer_settings.yml')

data/lib/openstax/utilities/version.rb

@@ -1,5 +1,5 @@
 module Openstax
   module Utilities
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/openstax_utilities.rb

@@ -1,3 +1,4 @@
 require "openstax/utilities/engine"
 require "openstax/utilities/version"
-require "openstax/utilities/file"
+require "openstax/utilities/settings"
+require "openstax/utilities/access"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstax_utilities
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -18,8 +18,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/openstax/utilities/access.rb
+- lib/openstax/utilities/development.rb
 - lib/openstax/utilities/engine.rb
-- lib/openstax/utilities/file.rb
+- lib/openstax/utilities/settings.rb
 - lib/openstax/utilities/version.rb
 - lib/openstax_utilities.rb
 - MIT-LICENSE