exvo_helpers 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in exvo_helpers.gemspec
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# Exvo Helpers
+
+Ruby gem providing helper methods for various Exvo apps/services. It takes into account the Rails.env (or Merb.env). Also allows overwriting of the defaults by ENV variables (and directly too, see below).
+
+## Examples
+
+Results are from the 'development' Rails environment:
+
+```ruby
+Exvo.cfs_host     => 'cfs.exvo.local'
+Exvo.desktop_host => 'www.exvo.local'
+Exvo.themes_host  => 'themes.exvo.local'
+
+Exvo.cfs_uri      => 'http://cfs.exvo.local'
+Exvo.desktop_uri  => 'http://www.exvo.local'
+Exvo.themes_uri   => 'http://themes.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 this gem is available when using them):
+
+```ruby
+Exvo.auth_host => 'exvo.auth.local'
+Exvo.auth_uri => 'http://exvo.auth.local'
+```
+
+
+## Overwriting
+
+There are two ways to do it. One is by the means of ENV variables (preferred one):
+
+```ruby
+ENV['CFS_HOST']     = 'test.cfs.exvo.com'
+ENV['DESKTOP_HOST'] = 'test.exvo.com'
+ENV['THEMES_HOST']  = 'test.themes.exvo.com'
+```
+
+The other one is to set it in the application's config file:
+
+```ruby
+Exvo.cfs_host     = 'test.cfs.exvo.com'
+Exvo.desktop_host = 'test.exvo.com'
+Exvo.themes_host  = 'test.themes.exvo.com'
+```
+
+
+
+Copyright © 2011 Exvo.com Development BV

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/exvo_helpers.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "exvo_helpers/version"
+
+Gem::Specification.new do |s|
+  s.name        = "exvo_helpers"
+  s.version     = ExvoHelpers::VERSION
+  s.authors     = ["Paweł Gościcki"]
+  s.email       = ["pawel.goscicki@gmail.com"]
+  s.homepage    = "https://github.com/Exvo/exvo_helpers/"
+  s.summary     = %q{host/uri helper methods for various Exvo services}
+  s.description = %q{Ruby gem providing helper *_uri/*_host methods for Exvo services/apps like DESKTOP/CFS/AUTH/THEMES.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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 "rb-fsevent"
+  s.add_development_dependency "rb-inotify"
+end

data/lib/exvo_helpers/helpers.rb

@@ -0,0 +1,107 @@
+module Exvo
+
+  # CFS
+
+  def self.cfs_uri
+    "http://#{cfs_host}"
+  end
+
+  def self.cfs_host
+    @@cfs_host ||= ENV['CFS_HOST'] || default_opts[env.to_sym][:cfs_host]
+  end
+
+  def self.cfs_host=(host)
+    @@cfs_host = host
+  end
+
+
+  # DESKTOP
+
+  def self.desktop_uri
+    "http://#{desktop_host}"
+  end
+
+  def self.desktop_host
+    @@desktop_host ||= ENV['DESKTOP_HOST'] || default_opts[env.to_sym][:desktop_host]
+  end
+
+  def self.desktop_host=(host)
+    @@desktop_host = host
+  end
+
+
+  # THEMES
+
+  def self.themes_uri
+    "http://#{themes_host}"
+  end
+
+  def self.themes_host
+    @@themes_host ||= ENV['THEMES_HOST'] || default_opts[env.to_sym][:themes_host]
+  end
+
+  def self.themes_host=(host)
+    @@themes_host = host
+  end
+
+
+  # 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
+  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
+  end
+
+
+  # ENV
+
+  def self.env
+    @@env ||= Rails.env if defined?(Rails)
+    @@env ||= Merb.env if defined?(Merb)
+    @@env
+  end
+
+  def self.env=(env)
+    @@env = env
+  end
+
+
+  private
+
+  def self.default_opts
+    {
+      :production => {
+        :cfs_host => 'cfs.exvo.com',
+        :desktop_host => 'www.exvo.com',
+        :themes_host => 'themes.exvo.com'
+      },
+      :staging => {
+        :cfs_host => 'staging.cfs.exvo.com',
+        :desktop_host => 'www.exvo.co',
+        :themes_host => 'staging.themes.exvo.com'
+      },
+      :development => {
+        :cfs_host => 'cfs.exvo.local',
+        :desktop_host => 'www.exvo.local',
+        :themes_host => 'themes.exvo.local'
+      },
+      :test => {
+        :cfs_host => 'cfs.exvo.local',
+        :desktop_host => 'www.exvo.local',
+        :themes_host => 'themes.exvo.local'
+      }
+    }
+  end
+end

data/lib/exvo_helpers/version.rb

@@ -0,0 +1,3 @@
+module ExvoHelpers
+  VERSION = "0.0.1"
+end

data/lib/exvo_helpers.rb

@@ -0,0 +1,2 @@
+require "exvo_helpers/version"
+require "exvo_helpers/helpers"

data/spec/exvo_helpers/helpers_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Exvo do
+
+  describe ".env class method" do
+    it "returns 'production' when Rails.env is set to 'production'" do
+      Kernel.const_set(:Rails, Module)
+      Rails.should_receive(:env).and_return('production')
+      Exvo.env.should eql('production')
+    end
+
+    it "allows setting env" do
+      Exvo.env = 'test'
+      Exvo.env.should eql('test')
+      Exvo.env = nil
+    end
+  end
+
+  describe "host methods in production environment" do
+    before do
+      Exvo.should_receive(:env).and_return('production')
+    end
+
+    specify { Exvo.themes_host.should eql('themes.exvo.com') }
+    specify { Exvo.cfs_host.should eql('cfs.exvo.com') }
+    specify { Exvo.desktop_host.should eql('www.exvo.com') }
+  end
+
+  describe "ENV setting overrides the defaults" do
+    let(:cfs_host) { "test.cfs.exvo.com" }
+    let(:desktop_host) { "test.exvo.com" }
+    let(:themes_host) { "test.themes.exvo.com" }
+
+    before do
+      # clear any previous memoization
+      Exvo.cfs_host = nil
+      Exvo.desktop_host = nil
+      Exvo.themes_host = nil
+
+      # set ENV
+      ENV["CFS_HOST"] = cfs_host
+      ENV["DESKTOP_HOST"] = desktop_host
+      ENV["THEMES_HOST"] = themes_host
+    end
+
+    specify { Exvo.cfs_host.should eql(cfs_host) }
+    specify { Exvo.desktop_host.should eql(desktop_host) }
+    specify { Exvo.themes_host.should eql(themes_host) }
+  end
+
+  describe "setting host directly overrides the defaults" do
+    let(:cfs_host) { "new.cfs.exvo.com" }
+    let(:desktop_host) { "new.exvo.com" }
+    let(:themes_host) { "new.themes.exvo.com" }
+
+    before do
+      Exvo.cfs_host = cfs_host
+      Exvo.desktop_host = desktop_host
+      Exvo.themes_host = themes_host
+    end
+
+    specify { Exvo.cfs_host.should eql(cfs_host) }
+    specify { Exvo.desktop_host.should eql(desktop_host) }
+    specify { Exvo.themes_host.should eql(themes_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.auth_uri }.to raise_error
+      expect { Exvo.auth_host }.to raise_error
+    end
+
+    it "passes to the ExvoAuth when it is available" do
+      Kernel.const_set(:ExvoAuth, Module)
+      ExvoAuth.const_set(:Config, Module)
+
+      ExvoAuth::Config.should_receive(:host).and_return(host)
+      Exvo.auth_host.should eql(host)
+
+      ExvoAuth::Config.should_receive(:uri).and_return(uri)
+      Exvo.auth_uri.should eql(uri)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'exvo_helpers'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: exvo_helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paweł Gościcki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &79383900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *79383900
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &79383640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *79383640
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &79383400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *79383400
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &79383210 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *79383210
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &79382980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *79382980
+description: Ruby gem providing helper *_uri/*_host methods for Exvo services/apps
+  like DESKTOP/CFS/AUTH/THEMES.
+email:
+- pawel.goscicki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- exvo_helpers.gemspec
+- lib/exvo_helpers.rb
+- lib/exvo_helpers/helpers.rb
+- lib/exvo_helpers/version.rb
+- spec/exvo_helpers/helpers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Exvo/exvo_helpers/
+licenses: []
+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.10
+signing_key: 
+specification_version: 3
+summary: host/uri helper methods for various Exvo services
+test_files: []