webs 0.1.1 → 0.1.2

data/README.rdoc

@@ -6,7 +6,7 @@ WebsGem is a holder of knowlege with unknown equal. It:
 
 Right now it's composed of 1 modules:
 
-* Controller: Stuff for controllers
+** Controller: Stuff for controllers
 ** params: Stuff for fw params
 
 == Installation
@@ -20,13 +20,21 @@ To use WebsGem with your stuff, in gemfile:
 === Rails 2.3
 
 
-== Params Helpers
+== Usage
 
-* Add helper to a view form controller:
-helper Webs::Controller::Params
+In a controller:
 
-* Include in controller or whatever:
-include Webs::Controller::Params
+ require 'webs'
+ 
+ class Front::Webs::SitesController < ActionController::Base
+   ...
+ 
+   include Webs::Controller::WebsController
+   webs_helpers
+  
+   # NOTE: Uses Webs::SECRET
+   before_filter :require_valid_user, :except=>[:tab, :contactme_login]
+  
 
 * Basic convenience methods for all the fw params
 Instead of "params[:fw_sig_session_key]" now you have fw_sig_session_key
@@ -35,6 +43,16 @@ Instead of "params[:fw_sig_session_key]" now you have fw_sig_session_key
 fw_app_url : full url of the app
 ex: http://mysite.webs.com/apps/videos
 
+* Security
+
+Create a webs.rb file in config/initializers
+
+ module Webs
+   SECRET = "your_secret_key"
+ end
+
+* FWML Tag:
+ <%= fwml :tagname, ... %>
 
 == TODO
 

data/Rakefile

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('webs', '0.1.1') do |p|
+Echoe.new('webs', '0.1.2') do |p|
   p.description    = "Reusable webs stuff."
   p.url            = "https://colczak@github.com/websdev/websgem.git"
   p.author         = "Chuck Olczak"

data/lib/controller/webs_controller.rb

@@ -0,0 +1,38 @@
+module Webs
+  module Controller
+    module WebsController
+      def self.included(base)
+        base.extend ClassMethods
+      end
+  
+      module ClassMethods
+        def webs_helpers
+          helper Webs::Helper::Params
+          helper Webs::Helper::Tags
+          include Webs::Helper::Params
+          include Webs::Helper::Tags
+        end
+      end
+
+      def webs_query_string
+        webs_params.collect{ |k,v| [k,v].join("=") }.join("&").to_s
+      end          
+
+      def webs_auth_string
+        webs_params.collect{ |k,v| [k[7..-1],v].join("=") }.to_s
+      end          
+
+      # http://wiki.developers.webs.com/wiki/Verifying_Requests
+      def webs_auth( secret )
+        s = webs_auth_string
+        Rails.logger.debug "****************** WEBS AUTH STRING=> #{s}"
+        Digest::MD5.hexdigest(webs_auth_string + secret)
+      end
+    
+      def require_valid_user
+        render :text => "Access Denied: Webs::SECRET not defined." and return(false) unless defined?( Webs::SECRET )
+        render :text => "Access Denied" and return(false) unless fw_sig == webs_auth( Webs::SECRET )
+      end
+    end
+  end
+end

data/lib/{controller → helper}/params.rb

@@ -1,5 +1,5 @@
 module Webs
-  module Controller
+  module Helper
     module Params
       def fw_sig
         params[:fw_sig]
@@ -61,45 +61,48 @@ module Webs
       def webs_permission
         case fw_sig_permissions
           when /admin/i
-            ADMIN
+            Permission::ADMIN
           when /owner/i
-            OWNER
+            Permission::OWNER
           when /moderator/i
-            MODERATORS
+            Permission::MODERATORS
           when /contributor/i
-            MEMBERS
+            Permission::MEMBERS
           when /limited/i
-            LIMITED
+            Permission::LIMITED
           else
-            ANYONE
+            Permission::ANYONE
         end
       end
       
       # does fw_sig_permissions contain at least perm
-      def webs_permission?( perm=ANYONE )
+      def webs_permission?( perm=Permission::ANYONE )
         webs_permission >= perm
       end
 
       def webs_admin?
-        fw_sig_permissions && webs_permission == ADMIN
+        fw_sig_permissions && webs_permission == Permission::ADMIN
       end
       
       def webs_owner?
-        fw_sig_permissions && webs_permission == MODERATORS
+        fw_sig_permissions && webs_permission == Permission::MODERATORS
       end
       
       def webs_contributor?
-        fw_sig_permissions && webs_permission == LIMITED
+        fw_sig_permissions && webs_permission == Permission::LIMITED
       end
       
       def webs_moderator?
-        fw_sig_permissions && webs_permission == ANYONE
+        fw_sig_permissions && webs_permission == Permission::ANYONE
       end
       
       def webs_site_owner_or_admin?
         webs_admin? || webs_owner?
       end
       
+      def webs_params
+        params.select{ |k,v| k.starts_with?("fw_sig_") }.sort
+      end
       
       # The full url of the app.  Since in APP_NAME can be different in different environments this is currently
       # defined in a global var, usually in the respective env file, however APP_NAME should be moved to something

data/lib/{controller → helper}/tags.rb

@@ -1,5 +1,5 @@
 module Webs
-  module Controller
+  module Helper
     module Tags
       def fwml tagname, options={}, &block
         s_options = ' ' + options.each_key.collect{|k| "#{k.to_s}=\"#{options[k]}\"" }.join(' ')  if options.size > 0

data/lib/webs.rb

@@ -1,17 +1,19 @@
 dir = Pathname(__FILE__).dirname.expand_path
 
-module Webs
-  VERSION = "0.1.1".freeze
+require dir + 'controller/webs_controller'
+require dir + 'helper/params'
+require dir + 'helper/tags'
 
-  ANYONE = 0
-  LIMITED = 1
-  MEMBERS = 2
-  MODERATORS = 3
-  OWNER = 4
-  ADMIN = 5
+module Webs
+  VERSION = "0.1.2".freeze
 
-  
+  module Permission
+    ANYONE = 0
+    LIMITED = 1
+    MEMBERS = 2
+    MODERATORS = 3
+    OWNER = 4
+    ADMIN = 5
+  end
 end
 
-require dir + 'controller/params'
-require dir + 'controller/tags'

data/webs.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{webs}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chuck Olczak"]
   s.date = %q{2010-07-23}
   s.description = %q{Reusable webs stuff.}
   s.email = %q{chuck@webs.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/controller/controller.rb", "lib/controller/params.rb", "lib/controller/tags.rb", "lib/webs.rb"]
-  s.files = ["README.rdoc", "Rakefile", "lib/controller/controller.rb", "lib/controller/params.rb", "lib/controller/tags.rb", "lib/webs.rb", "webs.gemspec"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/controller/webs_controller.rb", "lib/helper/params.rb", "lib/helper/tags.rb", "lib/webs.rb"]
+  s.files = ["README.rdoc", "Rakefile", "lib/controller/webs_controller.rb", "lib/helper/params.rb", "lib/helper/tags.rb", "lib/webs.rb", "webs.gemspec"]
   s.homepage = %q{http://github.com/websdotcom/websgem}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Webs", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: webs
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Chuck Olczak
@@ -27,16 +27,16 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
-- lib/controller/controller.rb
-- lib/controller/params.rb
-- lib/controller/tags.rb
+- lib/controller/webs_controller.rb
+- lib/helper/params.rb
+- lib/helper/tags.rb
 - lib/webs.rb
 files: 
 - README.rdoc
 - Rakefile
-- lib/controller/controller.rb
-- lib/controller/params.rb
-- lib/controller/tags.rb
+- lib/controller/webs_controller.rb
+- lib/helper/params.rb
+- lib/helper/tags.rb
 - lib/webs.rb
 - webs.gemspec
 has_rdoc: true

data/lib/controller/controller.rb

@@ -1,5 +0,0 @@
-module Webs
-  module Controller
-    
-  end
-end