exvo_helpers 0.0.8 → 0.1.0

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
 .bundle
 Gemfile.lock
+coverage/*
 pkg/*

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2011-2012 Exvo.com Development BV
+
+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

@@ -7,6 +7,7 @@ Ruby gem providing helper methods for various Exvo apps/services. It takes into
 Results are from the 'development' Rails environment:
 
 ```ruby
+Exvo::Helpers.auth_host     => 'auth.exvo.local'
 Exvo::Helpers.cdn_host      => 'www.exvo.local'
 Exvo::Helpers.cfs_host      => 'cfs.exvo.local'
 Exvo::Helpers.desktop_host  => 'www.exvo.local'
@@ -18,6 +19,7 @@ Exvo::Helpers.music_host    => 'music.exvo.local'
 Exvo::Helpers.pics_host     => 'pics.exvo.local'
 Exvo::Helpers.preview_host  => 'preview.exvo.local'
 
+Exvo::Helpers.auth_uri     => 'http://auth.exvo.local'
 Exvo::Helpers.cdn_uri      => 'http://www.exvo.local'
 Exvo::Helpers.cfs_uri      => 'http://cfs.exvo.local'
 Exvo::Helpers.desktop_uri  => 'http://www.exvo.local'
@@ -30,44 +32,47 @@ Exvo::Helpers.pics_uri     => 'http://pics.exvo.local'
 Exvo::Helpers.preview_uri  => 'http://preview.exvo.local'
 ```
 
-For consistency, there are also read-only `auth_host/auth_uri` methods, that just pass execution to the [exvo-auth](https://github.com/Exvo/Auth) gem (so it's required that exvo-auth gem is available when using them):
+There is also an `auth_require_ssl` method, which takes true/false values and is used to construct `auth_uri`. It returns `true` in production and `false` in all other environments.
 
 ```ruby
-Exvo::Helpers.auth_host => 'exvo.auth.local'
-Exvo::Helpers.auth_uri  => 'http://exvo.auth.local'
+Exvo::Helpers.auth_require_ssl => false
 ```
 
 
-### Overwriting
+### Overwriting the defaults
 
-There are two ways to do it. One is by the means of ENV variables (preferred one):
+There are two ways to do it. One is by the means of ENV variables (the preferred method):
 
 ```ruby
-ENV['CDN_HOST']      = 'test.cdn.exvo.com'
-ENV['CFS_HOST']      = 'test.cfs.exvo.com'
-ENV['DESKTOP_HOST']  = 'test.exvo.com'
-ENV['THEMES_HOST']   = 'test.themes.exvo.com'
-ENV['BLOG_HOST']     = 'test.blog.exvo.local'
-ENV['CONTACTS_HOST'] = 'test.contacts.exvo.local'
-ENV['INBOX_HOST']    = 'test.inbox.exvo.local'
-ENV['MUSIC_HOST']    = 'test.music.exvo.local'
-ENV['PICS_HOST']     = 'test.pics.exvo.local'
-ENV['PREVIEW_HOST']  = 'test.preview.exvo.local'
+ENV['AUTH_REQUIRE_SSL'] = 'true'
+ENV['AUTH_HOST']        = 'test.auth.exvo.com'
+ENV['CDN_HOST']         = 'test.cdn.exvo.com'
+ENV['CFS_HOST']         = 'test.cfs.exvo.com'
+ENV['DESKTOP_HOST']     = 'test.exvo.com'
+ENV['THEMES_HOST']      = 'test.themes.exvo.com'
+ENV['BLOG_HOST']        = 'test.blog.exvo.local'
+ENV['CONTACTS_HOST']    = 'test.contacts.exvo.local'
+ENV['INBOX_HOST']       = 'test.inbox.exvo.local'
+ENV['MUSIC_HOST']       = 'test.music.exvo.local'
+ENV['PICS_HOST']        = 'test.pics.exvo.local'
+ENV['PREVIEW_HOST']     = 'test.preview.exvo.local'
 ```
 
 The other one is to set it in the application's config file:
 
 ```ruby
-Exvo::Helpers.cdn_host      = 'test.cdn.exvo.com'
-Exvo::Helpers.cfs_host      = 'test.cfs.exvo.com'
-Exvo::Helpers.desktop_host  = 'test.exvo.com'
-Exvo::Helpers.themes_host   = 'test.themes.exvo.com'
-Exvo::Helpers.blog_host     = 'test.blog.exvo.local'
-Exvo::Helpers.contacts_host = 'test.contacts.exvo.local'
-Exvo::Helpers.inbox_host    = 'test.inbox.exvo.local'
-Exvo::Helpers.music_host    = 'test.music.exvo.local'
-Exvo::Helpers.pics_host     = 'test.pics.exvo.local'
-Exvo::Helpers.preview_host  = 'test.preview.exvo.local'
+Exvo::Helpers.auth_require_ssl = true
+Exvo::Helpers.auth_host        = 'test.auth.exvo.com'
+Exvo::Helpers.cdn_host         = 'test.cdn.exvo.com'
+Exvo::Helpers.cfs_host         = 'test.cfs.exvo.com'
+Exvo::Helpers.desktop_host     = 'test.exvo.com'
+Exvo::Helpers.themes_host      = 'test.themes.exvo.com'
+Exvo::Helpers.blog_host        = 'test.blog.exvo.local'
+Exvo::Helpers.contacts_host    = 'test.contacts.exvo.local'
+Exvo::Helpers.inbox_host       = 'test.inbox.exvo.local'
+Exvo::Helpers.music_host       = 'test.music.exvo.local'
+Exvo::Helpers.pics_host        = 'test.pics.exvo.local'
+Exvo::Helpers.preview_host     = 'test.preview.exvo.local'
 ```
 
 
@@ -127,4 +132,4 @@ Note, that this helper does not support full API of Rails' `stylesheet_link_tag`
 ```
 
 
-Copyright © 2011 Exvo.com Development BV
+Copyright © 2011-2012 Exvo.com Development BV, released under the MIT license

data/exvo_helpers.gemspec

@@ -16,9 +16,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency 'rspec', ['>= 2.7']
-  s.add_development_dependency 'guard', ['>= 0.8.0']
-  s.add_development_dependency 'guard-rspec', ['>= 0.4.0']
+  s.add_development_dependency 'rspec', ['>= 2.8']
+  s.add_development_dependency 'guard', ['>= 0.10.0']
+  s.add_development_dependency 'guard-rspec', ['>= 0.6.0']
   s.add_development_dependency "rb-fsevent"
   s.add_development_dependency "rb-inotify"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "simplecov-rcov"
 end

data/lib/exvo_helpers/helpers.rb

@@ -5,16 +5,24 @@ module Exvo
     # Dynamically define class methods
     class << self
 
-      %w(cdn cfs desktop themes blog contacts inbox music pics preview).each do |service|
+      %w(auth cdn cfs desktop themes blog contacts inbox music pics preview).each do |service|
 
         # def self.cdn_uri
-        #   protocol = ["cdn", "cfs", "themes"].include?(service) && env.to_sym == :production ? "//" : "http://"
+        #   protocol = 'http://'
+        #   protocol = 'https://' if service == "auth" && auth_require_ssl
+        #   protocol = '//' if ["cdn", "cfs", "themes"].include?(service) && env.to_sym == :production
         #   protocol + cdn_host
         # end
         define_method "#{service}_uri" do
+          protocol = 'http://'
+
+          # explicit https for auth
+          protocol = 'https://' if service == "auth" && send(:auth_require_ssl)
+
           # special link starting with '//' in production so that the webserver can choose between HTTP and HTTPS
           # but only for those apps/services that have proper SSL support (i.e. valid certificates)
-          protocol = ["cdn", "cfs", "themes"].include?(service) && env.to_sym == :production ? "//" : "http://"
+          protocol = '//' if ["cdn", "cfs", "themes"].include?(service) && env.to_sym == :production
+
           protocol + send("#{service}_host")
         end
 
@@ -45,21 +53,13 @@ module Exvo
 
     # AUTH
 
-    # pass-in to the ExvoAuth gem
-    def self.auth_uri
-      if defined?(ExvoAuth::Config) and ExvoAuth::Config.respond_to?('uri')
-        ExvoAuth::Config.uri
-      else
-        raise "Exvo.auth_uri method is available only when exvo-auth gem is available"
-      end
+    def self.auth_require_ssl
+      return @@auth_require_ssl if defined?(@@auth_require_ssl) && !@@auth_require_ssl.nil?
+      @@auth_require_ssl = (ENV['AUTH_REQUIRE_SSL'] == 'true') || default_opts[env.to_sym][:auth_require_ssl]
     end
 
-    def self.auth_host
-      if defined?(ExvoAuth::Config) and ExvoAuth::Config.respond_to?('host')
-        ExvoAuth::Config.host
-      else
-        raise "Exvo.auth_host method is available only when exvo-auth gem is available"
-      end
+    def self.auth_require_ssl=(require_ssl)
+      @@auth_require_ssl = require_ssl
     end
 
 
@@ -81,6 +81,8 @@ module Exvo
     def self.default_opts
       {
         :production => {
+          :auth_host => 'auth.exvo.com',
+          :auth_require_ssl => true,
           :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',
@@ -93,6 +95,8 @@ module Exvo
           :preview_host => 'preview.exvo.com'
         },
         :staging => {
+          :auth_host => 'staging.auth.exvo.com',
+          :auth_require_ssl => false,
           :cdn_host => 'd1by559a994699.cloudfront.net',
           :cfs_host => 'staging.cfs.exvo.com',
           :desktop_host => 'www.exvo.co',
@@ -105,6 +109,8 @@ module Exvo
           :preview_host => 'staging.preview.exvo.com'
         },
         :development => {
+          :auth_host => 'auth.exvo.local',
+          :auth_require_ssl => false,
           :cdn_host => 'www.exvo.local',
           :cfs_host => 'cfs.exvo.local',
           :desktop_host => 'www.exvo.local',
@@ -117,6 +123,8 @@ module Exvo
           :preview_host => 'preview.exvo.local'
         },
         :test => {
+          :auth_host => 'auth.exvo.local',
+          :auth_require_ssl => false,
           :cdn_host => 'www.exvo.local',
           :cfs_host => 'cfs.exvo.local',
           :desktop_host => 'www.exvo.local',

data/lib/exvo_helpers/version.rb

@@ -1,3 +1,3 @@
 module ExvoHelpers
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/spec/exvo_helpers/helpers_spec.rb

@@ -21,6 +21,7 @@ describe Exvo::Helpers do
       Exvo::Helpers.stub(:env).and_return('production')
     end
 
+    specify { Exvo::Helpers.auth_uri.should match('auth.exvo.com') }
     specify { Exvo::Helpers.cdn_uri.should match('d33gjlr95u9pgf.cloudfront.net') }
     specify { Exvo::Helpers.cfs_uri.should match('cfs.exvo.com') }
     specify { Exvo::Helpers.desktop_uri.should match('www.exvo.com') }
@@ -38,6 +39,7 @@ describe Exvo::Helpers do
       Exvo::Helpers.stub(:env).and_return('production')
     end
 
+    specify { Exvo::Helpers.auth_host.should match('auth.exvo.com') }
     specify { Exvo::Helpers.cdn_host.should eql('d33gjlr95u9pgf.cloudfront.net') }
     specify { Exvo::Helpers.cfs_host.should eql('cfs.exvo.com') }
     specify { Exvo::Helpers.desktop_host.should eql('www.exvo.com') }
@@ -63,6 +65,10 @@ describe Exvo::Helpers do
     end
 
     specify { Exvo::Helpers.cdn_host.should eql(cdn_host) }
+
+    after do
+      ENV["CDN_HOST"] = nil
+    end
   end
 
   describe "setting host directly overrides the defaults" do
@@ -74,26 +80,22 @@ describe Exvo::Helpers do
     end
 
     specify { Exvo::Helpers.cdn_host.should eql(cdn_host) }
-  end
 
-  describe "auth_host/auth_uri methods which pass to the ExvoAuth gem" do
-    let(:host) { 'new.auth.exvo.com' }
-    let(:uri) { "http://#{host}"}
-
-    it "raises an error when ExvoAuth is not available" do
-      expect { Exvo::Helpers.auth_uri }.to raise_error
-      expect { Exvo::Helpers.auth_host }.to raise_error
+    after do
+      Exvo::Helpers.cdn_host = nil
     end
+  end
 
-    it "passes to the ExvoAuth when it is available" do
-      Kernel.const_set(:ExvoAuth, Module)
-      ExvoAuth.const_set(:Config, Module)
+  describe "setting the auth_require_ssl directly overrides the default" do
+    before do
+      Exvo::Helpers.stub(:env).and_return('production')
+      Exvo::Helpers.auth_require_ssl = false
+    end
 
-      ExvoAuth::Config.should_receive(:host).and_return(host)
-      Exvo::Helpers.auth_host.should eql(host)
+    specify { Exvo::Helpers.auth_uri.should match(/http:\/\//) }
 
-      ExvoAuth::Config.should_receive(:uri).and_return(uri)
-      Exvo::Helpers.auth_uri.should eql(uri)
+    after do
+      Exvo::Helpers.auth_require_ssl = nil
     end
   end
 

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+require 'simplecov'
+require 'simplecov-rcov'
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.start
+
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $:.unshift(File.dirname(__FILE__))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exvo_helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,44 +9,44 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-13 00:00:00.000000000Z
+date: 2012-01-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &76965090 !ruby/object:Gem::Requirement
+  requirement: &78011280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *76965090
+  version_requirements: *78011280
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &76962330 !ruby/object:Gem::Requirement
+  requirement: &78011020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *76962330
+  version_requirements: *78011020
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &76961760 !ruby/object:Gem::Requirement
+  requirement: &78010780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *76961760
+  version_requirements: *78010780
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &76961230 !ruby/object:Gem::Requirement
+  requirement: &78010590 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76961230
+  version_requirements: *78010590
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &76954540 !ruby/object:Gem::Requirement
+  requirement: &78010350 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76954540
+  version_requirements: *78010350
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &78010110 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *78010110
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: &78009840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *78009840
 description: Ruby gem providing helper *_uri/*_host methods for Exvo services/apps
   like DESKTOP/CFS/AUTH/THEMES.
 email:
@@ -76,6 +98,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- MIT-LICENSE
 - README.md
 - Rakefile
 - exvo_helpers.gemspec
@@ -112,3 +135,4 @@ signing_key:
 specification_version: 3
 summary: host/uri helper methods for various Exvo services
 test_files: []
+has_rdoc: