fanforce-base 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5e8ce0ddfe5ae255cbaace4d27d1e4bb33a5b00
+  data.tar.gz: 76091e58b1942cab6591528f9a670fb6f02ae4e4
+SHA512:
+  metadata.gz: df91f669fa4bdecfe4d99cdbb7f7c35851a2ab311b5cee0632b39282ca5b088dc89f13dc1d85591fb1c22fd1147044977ae6cc70e5b8fc37e4879e8bf229fe58
+  data.tar.gz: b5e4266cc7753a77780361916bb394c245ae229736044856afd53049a7bc2aefbcebe364258826a75fce23759867a6a8624ad1b21e3c466c91c41606198a45c6

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.DS_Store
+.idea/
+.idea/*
+Gemfile.lock

data/.yardopts

@@ -0,0 +1 @@
+ lib/**/*.rb

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'minitest'
+  gem 'rack-test'
+  gem 'simplecov', :require => false
+  gem 'yard'
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Caleb Clark
+
+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

@@ -0,0 +1,4 @@
+fanforce-base
+========
+
+The base gem used by all other Fanforce gems

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'fileutils'
+include FileUtils
+
+task :run_test do
+  Rake::Task['test'].execute
+  puts '---------------------------------------------------------------------'
+  puts 'TESTS PASSED... READY TO BUILD...'
+  puts '---------------------------------------------------------------------'
+end
+task :build => :run_test
+task :default => :build
+
+########################################################################
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.libs.push 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/fanforce-base.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fanforce/base/version'
+
+Gem::Specification.new do |gem|
+  gem.name     = 'fanforce-base'
+  gem.version  = Fanforce::Base::VERSION
+  gem.date     = Time.now.utc.strftime('%Y-%m-%d')
+  gem.summary  = %q{The base gem used by other fanforce gems}
+
+  gem.authors  = ['Caleb Clark']
+  gem.email    = ['cclark@fanforce.com']
+  gem.homepage = 'http://github.com/fanforce/gem-fanforce-base'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'rack'
+  gem.add_runtime_dependency 'addressable', '~> 2.3.6'
+end

data/lib/fanforce/base.rb

@@ -0,0 +1,11 @@
+require_relative 'base/version'
+
+class Fanforce
+  class Base
+    require_relative 'base/domains'
+    require_relative 'base/internal_utils'
+    require_relative 'base/utils'
+  end
+  include Base::Utils
+  include Base::Domains
+end

data/lib/fanforce/base/domain_environments.rb

@@ -0,0 +1,44 @@
+module Fanforce::Base::DomainEnvironments
+
+  # Base domains for development environment.
+  # @return [hash]
+  def self.development
+    root_domain = (ENV['FANFORCE_GEM_TOP_LEVEL_DOMAIN'] || 'gg')
+    {
+        :base                 => ENV['FANFORCE_GEM_BASE_DOMAIN'] || "fanforce.#{root_domain}",
+        :default_short_domain => ENV['FANFORCE_GEM_DEFAULT_SHORT_DOMAIN'] || "fanforc.#{root_domain}",
+        :apps_base            => ENV['FANFORCE_GEM_APPS_BASE_DOMAIN']     || "ffapp.#{root_domain}",
+    }
+  end
+
+  # Base domains for test environment.
+  # @return [hash]
+  def self.test
+    {
+      :base                 => 'fanforce.gg',
+      :default_short_domain => 'fanforc.gg',
+      :apps_base            => 'ffapp.gg',
+    }
+  end
+
+  # Base domains for staging environment.
+  # @return [hash]
+  def self.staging
+    {
+        :base                 => 'fanforce-staging.com',
+        :default_short_domain => 'fanforc.us',
+        :apps_base            => 'ffapp.us',
+    }
+  end
+
+  # Base domains for production environment.
+  # @return [hash]
+  def self.production
+    {
+        :base                 => 'fanforce.com',
+        :default_short_domain => 'fanforce.io',
+        :apps_base            => 'ffapp.io',
+    }
+  end
+
+end

data/lib/fanforce/base/domains.rb

@@ -0,0 +1,100 @@
+require_relative 'domain_environments'
+
+module Fanforce::Base::Domains
+  extend self
+  def self.included(base) base.extend(self) end
+
+  # Current rack environment (i.e., production)
+  # @return [string] defaults to development
+  def environment
+    ENV['RACK_ENV'] || 'development'
+  end
+
+  # Abbreviation of current rack environment (i.e., dev)
+  # @return [symbol]
+  def environ
+    case environment
+      when 'production'  then :prd
+      when 'staging'     then :stg
+      when 'test'        then :tst
+      when 'development' then :dev
+    end
+  end
+
+  # Base domain (i.e., fanforce.com) for current environment
+  # @return [domain]
+  def base_domain
+    Fanforce::Base::DomainEnvironments.method(environment).call[:base]
+  end
+
+  # Default short domain (i.e., fanforce.io) for current environment
+  # @return [domain]
+  def default_short_domain
+    Fanforce::Base::DomainEnvironments.method(environment).call[:default_short_domain]
+  end
+
+  # Base domain used for apps (i.e., ffapp.com) for current environment
+  # @return [domain]
+  def apps_base_domain
+    Fanforce::Base::DomainEnvironments.method(environment).call[:apps_base]
+  end
+
+  # Domain for accessing supercore-api (i.e., api.fanforce.com) for current environment
+  # @return [domain]
+  def api_domain
+    'api.' + base_domain
+  end
+
+  # Domain for accessing supercore-api with https (i.e., prd-supercore-api.herokuapp.com) for current environment
+  # @return [domain]
+  def api_domain_ssl
+    environ == 'development' ? api_domain : "#{environ.to_s}-supercore-api.herokuapp.com"
+  end
+
+  # Domain for accessing supercore-eye (i.e., i.fanforce.com) for current environment
+  # @return [domain]
+  def eye_domain
+    'i.' + base_domain
+  end
+
+  # Domain for accessing supercore-controller (i.e., controller.fanforce.com) for current environment
+  # @return [domain]
+  def controller_domain
+    'controller.' + base_domain
+  end
+
+  # Domain for accessing uranium (i.e., uranium.fanforce.com) for current environment
+  # @return [domain]
+  def uranium_domain
+    'uranium.' + base_domain
+  end
+
+  # Domain for Fanforce's website (i.e., fanforce.com) for current environment
+  # @return [domain]
+  def website_domain
+    'www.' + base_domain
+  end
+
+  # Domain for accessing developer's website (i.e., developers.fanforce.com) for current environment
+  # @return [domain]
+  def developers_domain
+    'developers.' + base_domain
+  end
+
+  ###########
+  # The following should be moved to edition config
+  ###########
+
+  # Domain for accessing the CommandCenter Webapp (i.e., app.fanforce.com) for current environment
+  # @return [domain]
+  def app_domain
+    'app.' + base_domain
+  end
+
+  # Domain for accessing the CommandCenter Signup (i.e., signup.fanforce.com) for current environment
+  # @return [domain]
+  def signup_domain
+    'signup.' + base_domain
+  end
+
+end

data/lib/fanforce/base/internal_utils.rb

@@ -0,0 +1,36 @@
+module Fanforce::Base::InternalUtils
+
+  def self.modify_keys(object, &modifier) #:nodoc:
+    case object
+      when Array
+        object.map do |value|
+          modify_keys(value, &modifier)
+        end
+      when Hash
+        object.inject({}) do |result, (key, value)|
+          new_key   = modifier.call(key)
+          new_value = modify_keys(value, &modifier)
+          result.merge! new_key => new_value
+        end
+      else
+        object
+    end
+  end
+
+  def self.to_param(obj, namespace=nil)
+    if obj.is_a?(Array)
+      collect { |e| to_param(e) }.join '/'
+    elsif obj.is_a?(Hash)
+      to_query_string(obj, namespace)
+    elsif obj.is_a?(NilClass)
+      obj
+    elsif obj.is_a?(TrueClass)
+      obj
+    elsif obj.is_a?(FalseClass)
+      obj
+    elsif obj.is_a?(Object)
+      obj.to_s
+    end
+  end
+
+end

data/lib/fanforce/base/utils.rb

@@ -0,0 +1,111 @@
+require 'uri'
+require 'cgi'
+require 'rack/utils'
+require 'addressable/uri'
+
+require_relative 'internal_utils'
+
+module Fanforce::Base::Utils
+  extend self
+  def self.included(base) base.extend(self)  end
+
+  # An object is blank if it's nil, false, or empty. For example, '', nil, [], and {} are all blank.
+  # @return [boolean]
+  def is_blank?(obj)
+    obj.respond_to?(:empty?) ? !!obj.empty? : !obj
+  end
+
+  # An object is present if it's not blank.
+  # @return [boolean]
+  def is_present?(obj)
+    !is_blank?(obj)
+  end
+
+  # Return a new hash with all keys converted to symbols, as long as they respond to to_sym.
+  def symbolize_keys(object) #:nodoc:
+    Fanforce::Base::InternalUtils.modify_keys(object) do |key|
+      key.is_a?(String) ? key.to_sym : key
+    end
+  end
+
+  # Convert a URL string to a hash of URI parts:
+  # - scheme
+  # - host
+  # - port
+  # - path
+  # - query_params
+  # - query_string
+  # - fragment
+  # - clean_url
+  # @param url [string]
+  # @return [hash]
+  def extract_uri_hash(url)
+    uri = extract_uri(url) || return
+    if is_present?(uri.query)
+      query_params = Rack::Utils.parse_nested_query(uri.query).inject({}) do |result, (k,v)|
+        result[k] = v if k !~ /^ff_.+/
+        result
+      end
+      query_string = to_query_string(Hash[query_params.sort])
+    end
+    fragment = uri.fragment.gsub(/^ff_[^=]+=[^&]+$/, '').gsub(/&ff_[^=]+=[^&]+/, '') if is_present?(uri.fragment)
+
+    uri_hash = {}
+    uri_hash[:scheme] = uri.scheme || 'http'
+    uri_hash[:host]   = clean_uri_var(uri.host)
+    uri_hash[:port]   = clean_uri_var(uri.port)
+    uri_hash[:path]   = clean_uri_var(uri.path || '/')
+    uri_hash[:query_params] = query_params || {}
+    uri_hash[:query_string] = query_string || ''
+    uri_hash[:fragment]  = fragment || ''
+    uri_hash[:clean_url] = "#{uri_hash[:scheme]}://#{uri_hash[:host]}#{":#{uri_hash[:port]}" if [80,443].include?(uri_hash[:port])}#{uri_hash[:path]}#{"?#{query_string}" if is_present?(uri_hash[:query_string])}"
+    return uri_hash
+  end
+
+  def clean_uri_var(v)
+    (v.is_a?(Hash) or v.is_a?(Array) or v.is_a?(Integer)) ? v : v.to_s
+  end
+
+  def extract_uri(url)
+    url = url.gsub(/^file:\/\/:/, 'file://LOCALFILE') if url =~ /^file:\/\//
+    Addressable::URI.parse(url)
+  rescue
+    return if !url.is_a?(String)
+    if url =~ /^(http(.+))http\2+$/
+      extract_uri($1)
+    elsif url =~ /^(.+)#.*\s+.+$/
+      extract_uri($1)
+    end
+  end
+
+  def to_query_string(obj, namespace=nil)
+    return '' if is_blank?(obj)
+    if obj.is_a?(Array)
+      obj.collect { |value| to_query_string(value, "#{namespace}[]") }.join '&'
+    elsif obj.is_a?(Hash)
+      obj.collect { |key, value| to_query_string(value, namespace ? "#{namespace}[#{key}]" : key) }.sort * '&'
+    elsif obj.is_a?(Object)
+      "#{CGI.escape(Fanforce::Base::InternalUtils.to_param(namespace))}=#{CGI.escape(Fanforce::Base::InternalUtils.to_param(obj).to_s)}"
+    else
+      raise "Argument must be an object, hash, or array; instead it was a #{obj.class}"
+    end
+  end
+
+  def curl_command(method, url, req_params)
+    case method.to_s.downcase.to_sym
+      when :get
+        "curl \"#{url}?#{to_query_string(req_params)}\""
+      when :post
+        "curl -X POST -d \"#{to_query_string(req_params)}\" #{url}"
+      when :put
+        "curl -X PUT -d \"#{to_query_string(req_params)}\" #{url.to_json}"
+      when :delete
+        "curl --request DELETE \"#{url}?#{to_query_string(req_params)}\""
+      when :options
+        "curl -X OPTIONS \"#{url}?#{to_query_string(req_params)}\""
+      else
+        raise 'Unknown request method'
+    end
+  end
+
+end

data/lib/fanforce/base/version.rb

@@ -0,0 +1,5 @@
+class Fanforce
+  class Base
+    VERSION = '1.0.0'
+  end
+end

data/test/base/domains_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+describe Fanforce::Base::Domains do
+
+  [:test,:development,:staging,:production].each do |rack_env| it "should return domains for #{rack_env}" do
+    ENV['RACK_ENV'] = rack_env.to_s
+    assert Fanforce.environ.is_a?(Symbol)
+
+    assert Fanforce.base_domain == Fanforce::Base::DomainEnvironments.method(rack_env.to_s).call[:base]
+    assert Fanforce.default_short_domain == Fanforce::Base::DomainEnvironments.method(rack_env.to_s).call[:default_short_domain]
+    assert Fanforce.apps_base_domain == Fanforce::Base::DomainEnvironments.method(rack_env.to_s).call[:apps_base]
+
+    assert Fanforce.api_domain
+    assert Fanforce.api_domain_ssl
+    assert Fanforce.eye_domain
+    assert Fanforce.controller_domain
+    assert Fanforce.uranium_domain
+    assert Fanforce.website_domain
+    assert Fanforce.developers_domain
+    assert Fanforce.app_domain
+    assert Fanforce.signup_domain
+  end end
+
+end

data/test/base/utils_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+describe Fanforce::Base::Utils do
+
+  it 'should return true if false, nil, or empty' do
+    assert Fanforce.is_blank?(nil) == true
+    assert Fanforce.is_blank?('') == true
+    assert Fanforce.is_blank?([]) == true
+    assert Fanforce.is_blank?({}) == true
+    assert Fanforce.is_blank?(false) == true
+
+    assert Fanforce.is_blank?(true) == false
+    assert Fanforce.is_blank?(0) == false
+    assert Fanforce.is_blank?(1) == false
+    assert Fanforce.is_blank?('SOMETHING') == false
+  end
+
+  it 'should return true if not blank' do
+    assert Fanforce.is_present?(nil) == false
+    assert Fanforce.is_present?('') == false
+    assert Fanforce.is_present?([]) == false
+    assert Fanforce.is_present?({}) == false
+    assert Fanforce.is_present?(false) == false
+
+    assert Fanforce.is_present?(true) == true
+    assert Fanforce.is_present?(0) == true
+    assert Fanforce.is_present?(1) == true
+    assert Fanforce.is_present?('SOMETHING') == true
+  end
+
+  it 'should symbolize all keys' do
+    Fanforce.symbolize_keys({'first' => 'test', 'second' => 2}).each do |k,v|
+      assert k.is_a?(Symbol)
+    end
+    Fanforce.symbolize_keys([{'first' => 'test', 'second' => 2}]).each do |hash|
+      hash.each do |k,v|
+        assert k.is_a?(Symbol)
+      end
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+SimpleCov.start { add_filter '/test/' }
+
+require 'rubygems'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'rack/test'
+
+ENV['RACK_ENV'] = 'test'
+
+require 'fanforce/base'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: fanforce-base
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Caleb Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.6
+description: 
+email:
+- cclark@fanforce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- fanforce-base.gemspec
+- lib/fanforce/base.rb
+- lib/fanforce/base/domain_environments.rb
+- lib/fanforce/base/domains.rb
+- lib/fanforce/base/internal_utils.rb
+- lib/fanforce/base/utils.rb
+- lib/fanforce/base/version.rb
+- test/base/domains_test.rb
+- test/base/utils_test.rb
+- test/test_helper.rb
+homepage: http://github.com/fanforce/gem-fanforce-base
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: The base gem used by other fanforce gems
+test_files:
+- test/base/domains_test.rb
+- test/base/utils_test.rb
+- test/test_helper.rb
+has_rdoc: