exvo_helpers 0.4.0 → 0.5.0

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Note, that only significant changes are listed.
 
+## 0.5.0 (2012-06-15)
+
+* all staging apps now use 'exvo.co' domain
+* new `sso_cookie_domain` and `sso_cookie_secret` settings
+
+
 ## 0.4.0 (2012-05-15)
 
 * support for Sinatra apps (use `ENV["RACK_ENV"]` to set environment)

data/README.md

@@ -16,6 +16,9 @@ Exvo::Helpers.auth_require_ssl => false
 Exvo::Helpers.auth_client_id     => nil
 Exvo::Helpers.auth_client_secret => nil
 
+Exvo::Helpers.sso_cookie_domain => 'exvo.local'
+Exvo::Helpers.sso_cookie_secret => 'some secret cookie signing key'
+
 Exvo::Helpers.auth_host     => 'auth.exvo.local'
 Exvo::Helpers.cdn_host      => 'www.exvo.local'
 Exvo::Helpers.cfs_host      => 'cfs.exvo.local'
@@ -53,6 +56,9 @@ ENV['AUTH_REQUIRE_SSL'] = 'true'
 ENV['AUTH_CLIENT_ID']     = '123'
 ENV['AUTH_CLIENT_SECRET'] = 'abc'
 
+ENV['SSO_COOKIE_DOMAIN'] = 'exvo.dev'
+ENV['SSO_COOKIE_SECRET'] = 'exvo.dev'
+
 ENV['AUTH_HOST']     = 'test.auth.exvo.com'
 ENV['CDN_HOST']      = 'test.cdn.exvo.com'
 ENV['CFS_HOST']      = 'test.cfs.exvo.com'
@@ -75,6 +81,9 @@ Exvo::Helpers.auth_require_ssl = true
 Exvo::Helpers.auth_client_id     = '123'
 Exvo::Helpers.auth_client_secret = 'abc'
 
+Exvo::Helpers.sso_cookie_domain = 'exvo.dev'
+Exvo::Helpers.sso_cookie_key = 'some secret key'
+
 Exvo::Helpers.auth_host     = 'test.auth.exvo.com'
 Exvo::Helpers.cdn_host      = 'test.cdn.exvo.com'
 Exvo::Helpers.cfs_host      = 'test.cfs.exvo.com'

data/exvo_helpers.gemspec

@@ -16,8 +16,10 @@ Gem::Specification.new do |gem|
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
+  gem.add_development_dependency "rake"
   gem.add_development_dependency 'rspec', ['>= 2.8']
   gem.add_development_dependency 'guard', ['>= 0.10.0']
+  gem.add_development_dependency 'guard-bundler'
   gem.add_development_dependency 'guard-rspec', ['>= 0.6.0']
   gem.add_development_dependency "rb-fsevent"
   gem.add_development_dependency "rb-inotify"

data/lib/exvo_helpers/helpers.rb

@@ -105,6 +105,61 @@ module Exvo
         define_method "auth_#{option}=" do |value|
           class_variable_set("@@auth_#{option}", value)
         end
+
+      end
+
+    end
+
+
+    # SSO Cookie Domain
+
+    # Dynamically define class methods
+    class << self
+
+      %w(sso_cookie_domain).each do |option|
+
+        # def self.sso_cookie_domain
+        #   @@sso_cookie_domain ||= ENV['SSO_COOKIE_DOMAIN'] || default_opts[env.to_sym][:sso_cookie_domain]
+        # end
+        define_method "#{option}" do
+          if class_variable_defined?("@@#{option}") and class_variable_get("@@#{option}")
+            class_variable_get("@@#{option}")
+          else
+            domain = ENV["#{option.upcase}"] || default_opts[env.to_sym]["#{option}".to_sym]
+            class_variable_set("@@#{option}", domain)
+          end
+        end
+
+        # def self.sso_cookie_domain=(domain)
+        #   @@sso_cookie_domain = domain
+        # end
+        define_method "#{option}=" do |value|
+          class_variable_set("@@#{option}", value)
+        end
+
+      end
+
+      %w(sso_cookie_secret).each do |option|
+
+        # def self.sso_cookie_secret
+        #   @@sso_cookie_secret ||= ENV['SSO_COOKIE_secret']
+        # end
+        define_method "#{option}" do
+          if class_variable_defined?("@@#{option}") and class_variable_get("@@#{option}")
+            class_variable_get("@@#{option}")
+          else
+            secret = ENV["#{option.upcase}"]
+            class_variable_set("@@#{option}", secret)
+          end
+        end
+
+        # def self.sso_cookie_secret=(secret)
+        #   @@sso_cookie_secret = secret
+        # end
+        define_method "#{option}=" do |value|
+          class_variable_set("@@#{option}", value)
+        end
+
       end
 
     end
@@ -113,7 +168,7 @@ module Exvo
     # ENV
 
     # by default fall back to production; this way the omniauth-exvo's gem specs can pass
-    # (they depend on this gem and on env, but nor Rails nor Merb is undefined there)
+    # (they depend on this gem and on env, but nor Rails nor Merb is defined there)
     def self.env
       @@env ||= Rails.env if defined?(Rails)
       @@env ||= Merb.env if defined?(Merb)
@@ -134,6 +189,7 @@ module Exvo
           :auth_debug => false,
           :auth_host => 'auth.exvo.com',
           :auth_require_ssl => true,
+          :sso_cookie_domain => 'exvo.com',
           :cdn_host => 'd33gjlr95u9pgf.cloudfront.net', # cloudfront.net so we can use https (cdn.exvo.com via https does not work properly)
           :cfs_host => 'cfs.exvo.com',
           :desktop_host => 'www.exvo.com',
@@ -147,23 +203,25 @@ module Exvo
         },
         :staging => {
           :auth_debug => false,
-          :auth_host => 'staging.auth.exvo.com',
+          :auth_host => 'auth.exvo.co',
           :auth_require_ssl => false,
+          :sso_cookie_domain => 'exvo.co',
           :cdn_host => 'd1by559a994699.cloudfront.net',
-          :cfs_host => 'staging.cfs.exvo.com',
+          :cfs_host => 'cfs.exvo.co',
           :desktop_host => 'www.exvo.co',
-          :themes_host => 'staging.themes.exvo.com',
-          :blog_host => 'staging.blog.exvo.com',
-          :contacts_host => 'staging.contacts.exvo.com',
-          :inbox_host => 'staging.inbox.exvo.com',
-          :music_host => 'staging.music.exvo.com',
-          :pics_host => 'staging.pics.exvo.com',
-          :preview_host => 'staging.preview.exvo.com'
+          :themes_host => 'themes.exvo.co',
+          :blog_host => 'blog.exvo.co',
+          :contacts_host => 'contacts.exvo.co',
+          :inbox_host => 'inbox.exvo.co',
+          :music_host => 'music.exvo.co',
+          :pics_host => 'pics.exvo.co',
+          :preview_host => 'preview.exvo.co'
         },
         :development => {
           :auth_debug => false,
           :auth_host => 'auth.exvo.local',
           :auth_require_ssl => false,
+          :sso_cookie_domain => 'exvo.local',
           :cdn_host => 'www.exvo.local',
           :cfs_host => 'cfs.exvo.local',
           :desktop_host => 'www.exvo.local',
@@ -179,6 +237,7 @@ module Exvo
           :auth_debug => false,
           :auth_host => 'auth.exvo.local',
           :auth_require_ssl => false,
+          :sso_cookie_domain => 'exvo.local',
           :cdn_host => 'www.exvo.local',
           :cfs_host => 'cfs.exvo.local',
           :desktop_host => 'www.exvo.local',

data/lib/exvo_helpers/version.rb

@@ -1,5 +1,5 @@
 module Exvo
   module Helpers
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/spec/exvo_helpers/helpers_spec.rb

@@ -2,6 +2,11 @@ require 'spec_helper'
 
 describe Exvo::Helpers do
 
+  # clear all memoizations after each spec run
+  after do
+    clear_memoizations
+  end
+
   describe ".env class method" do
     it "should fall back to 'production' if Rails & Merb are undefined" do
       Exvo::Helpers.env.should eql('production')
@@ -17,17 +22,12 @@ describe Exvo::Helpers do
     it "returns 'staging' when RACK_ENV is set to 'staging'" do
       ENV["RACK_ENV"] = 'staging'
       Exvo::Helpers.env.should eql('staging')
-      ENV.delete("RACK_ENV")
     end
 
     it "allows setting env" do
       Exvo::Helpers.env = 'test'
       Exvo::Helpers.env.should eql('test')
     end
-
-    after do
-      Exvo::Helpers.env = nil
-    end
   end
 
   describe "uri methods in production environment" do
@@ -58,95 +58,120 @@ describe Exvo::Helpers do
     specify { Exvo::Helpers.preview_host.should eql('preview.exvo.com') }
   end
 
+  describe "host methods in staging environment" do
+    before do
+      Exvo::Helpers.env = 'staging'
+    end
+
+    specify { Exvo::Helpers.auth_host.should match('auth.exvo.co') }
+    specify { Exvo::Helpers.cdn_host.should eql('d1by559a994699.cloudfront.net') }
+    specify { Exvo::Helpers.cfs_host.should eql('cfs.exvo.co') }
+    specify { Exvo::Helpers.desktop_host.should eql('www.exvo.co') }
+    specify { Exvo::Helpers.themes_host.should eql('themes.exvo.co') }
+    specify { Exvo::Helpers.blog_host.should eql('blog.exvo.co') }
+    specify { Exvo::Helpers.contacts_host.should eql('contacts.exvo.co') }
+    specify { Exvo::Helpers.inbox_host.should eql('inbox.exvo.co') }
+    specify { Exvo::Helpers.music_host.should eql('music.exvo.co') }
+    specify { Exvo::Helpers.pics_host.should eql('pics.exvo.co') }
+    specify { Exvo::Helpers.preview_host.should eql('preview.exvo.co') }
+  end
+
   describe "#auth_debug by default for production env" do
     specify { Exvo::Helpers.auth_debug.should be_false }
-
-    after do
-      # reset cached class instance variable
-      Exvo::Helpers.auth_debug = nil
-    end
   end
 
   describe "#auth_require_ssl by default for production env" do
     specify { Exvo::Helpers.auth_require_ssl.should be_true }
-
-    after do
-      # reset cached class instance variable
-      Exvo::Helpers.auth_require_ssl = nil
-    end
   end
 
-  describe "setting #auth_client_id and #auth_client_secret via ENV variables" do
-    before do
-      ENV["AUTH_CLIENT_ID"] = '123'
-      ENV["AUTH_CLIENT_SECRET"] = 'abc'
-    end
-
-    specify { Exvo::Helpers.auth_client_id.should eq('123') }
-    specify { Exvo::Helpers.auth_client_secret.should eq('abc') }
-
-    after do
-      ENV["AUTH_CLIENT_ID"] = nil
-      ENV["AUTH_CLIENT_SECRET"] = nil
-    end
+  describe "#sso_cookie_domain by default for production env" do
+    specify { Exvo::Helpers.sso_cookie_domain.should eq("exvo.com") }
   end
 
-  describe "ENV setting overrides the defaults" do
-    # as all methods are defined the same using metaprogramming, only testing for 1 is enough
+  describe "ENV settings override the defaults" do
+    # all *host* methods are defined the same using metaprogramming, only testing for 1 is enough
     let(:cdn_host) { "test.cdn.exvo.com" }
+    let(:auth_client_id) { '123' }
+    let(:auth_client_secret) { 'abc' }
+    let(:auth_require_ssl) { 'false' }
+    let(:sso_cookie_domain) { "exvo.dev" }
+    let(:sso_cookie_secret) { "secret" }
 
     before do
-      # clear any previous memoization
-      Exvo::Helpers.cdn_host = nil
-
       # set ENV
       ENV["CDN_HOST"] = cdn_host
+      ENV["AUTH_CLIENT_ID"] = auth_client_id
+      ENV["AUTH_CLIENT_SECRET"] = auth_client_secret
+      ENV["AUTH_REQUIRE_SSL"] = auth_require_ssl
+      ENV["SSO_COOKIE_DOMAIN"] = sso_cookie_domain
+      ENV["SSO_COOKIE_SECRET"] = sso_cookie_secret
     end
 
     specify { Exvo::Helpers.cdn_host.should eql(cdn_host) }
-
-    after do
-      ENV["CDN_HOST"] = nil
-    end
+    specify { Exvo::Helpers.auth_client_id.should eq(auth_client_id) }
+    specify { Exvo::Helpers.auth_client_secret.should eq(auth_client_secret) }
+    specify { Exvo::Helpers.auth_uri.should match(/http:\/\//) }
+    specify { Exvo::Helpers.sso_cookie_domain.should eql(sso_cookie_domain) }
+    specify { Exvo::Helpers.sso_cookie_secret.should eql(sso_cookie_secret) }
   end
 
-  describe "setting host directly overrides the defaults" do
-    # as all methods are defined the same using metaprogramming, only testing for 1 is enough
+  describe "direct settings override the defaults" do
+    # all *host* methods are defined the same using metaprogramming, only testing for 1 is enough
     let(:cdn_host) { "new.cdn.exvo.com" }
+    let(:auth_client_id) { '123' }
+    let(:auth_client_secret) { 'abc' }
+    let(:auth_require_ssl) { false }
+    let(:sso_cookie_domain) { "exvo.new" }
+    let(:sso_cookie_secret) { "abc" }
 
     before do
       Exvo::Helpers.cdn_host = cdn_host
+      Exvo::Helpers.auth_client_id = auth_client_id
+      Exvo::Helpers.auth_client_secret = auth_client_secret
+      Exvo::Helpers.auth_require_ssl = auth_require_ssl
+      Exvo::Helpers.sso_cookie_domain = sso_cookie_domain
+      Exvo::Helpers.sso_cookie_secret = sso_cookie_secret
     end
 
     specify { Exvo::Helpers.cdn_host.should eql(cdn_host) }
-
-    after do
-      Exvo::Helpers.cdn_host = nil
-    end
-  end
-
-  describe "setting the auth_require_ssl to false via ENV variable overrides the default" do
-    before do
-      ENV["AUTH_REQUIRE_SSL"] = 'false'
-    end
-
+    specify { Exvo::Helpers.auth_client_id.should eq(auth_client_id) }
+    specify { Exvo::Helpers.auth_client_secret.should eq(auth_client_secret) }
     specify { Exvo::Helpers.auth_uri.should match(/http:\/\//) }
-
-    after do
-      ENV["AUTH_REQUIRE_SSL"] = nil
-    end
+    specify { Exvo::Helpers.sso_cookie_domain.should eql(sso_cookie_domain) }
+    specify { Exvo::Helpers.sso_cookie_secret.should eql(sso_cookie_secret) }
   end
 
-  describe "setting the auth_require_ssl directly overrides the default" do
-    before do
-      Exvo::Helpers.auth_require_ssl = false
-    end
-
-    specify { Exvo::Helpers.auth_uri.should match(/http:\/\//) }
-
-    after do
-      Exvo::Helpers.auth_require_ssl = nil
-    end
+  # Clear all memoizations and ENV variables
+  def clear_memoizations
+    Exvo::Helpers.env = nil
+
+    Exvo::Helpers.auth_debug = nil
+    Exvo::Helpers.auth_require_ssl = nil
+    Exvo::Helpers.auth_client_id = nil
+    Exvo::Helpers.auth_client_secret = nil
+    Exvo::Helpers.sso_cookie_domain = nil
+    Exvo::Helpers.sso_cookie_secret = nil
+
+    Exvo::Helpers.auth_host = nil
+    Exvo::Helpers.cdn_host = nil
+    Exvo::Helpers.cfs_host = nil
+    Exvo::Helpers.desktop_host = nil
+    Exvo::Helpers.themes_host = nil
+    Exvo::Helpers.blog_host = nil
+    Exvo::Helpers.contacts_host = nil
+    Exvo::Helpers.inbox_host = nil
+    Exvo::Helpers.music_host = nil
+    Exvo::Helpers.pics_host = nil
+    Exvo::Helpers.preview_host = nil
+
+    ENV.delete("RACK_ENV")
+    ENV.delete("CDN_HOST")
+    ENV.delete("AUTH_DEBUG")
+    ENV.delete("AUTH_CLIENT_ID")
+    ENV.delete("AUTH_CLIENT_SECRET")
+    ENV.delete("AUTH_REQUIRE_SSL")
+    ENV.delete("SSO_COOKIE_DOMAIN")
+    ENV.delete("SSO_COOKIE_SECRET")
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exvo_helpers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-15 00:00:00.000000000 Z
+date: 2012-06-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement