wurfl_cloud_client 1.0.1

data/spec/wurfl_cloud/environment_spec.rb

@@ -0,0 +1,93 @@
+#
+# Copyright (c) 2015 ScientiaMobile Inc.
+#
+# The WURFL Cloud Client is intended to be used in both open-source and
+# commercial environments. To allow its use in as many situations as possible,
+# the WURFL Cloud Client is dual-licensed. You may choose to use the WURFL
+# Cloud Client under either the GNU GENERAL PUBLIC LICENSE, Version 2.0, or
+# the MIT License.
+#
+# Refer to the COPYING.txt file distributed with this package.
+#
+require 'spec_helper'
+describe WurflCloud::Environment do
+
+  context "the class" do  
+    it "should respond to new with 1 argument" do
+      WurflCloud::Environment.should respond_to(:new).with(1).argument
+    end
+  end
+  
+  context "the object" do
+    [
+      :user_agent,
+      :x_forwarded_for,
+      :x_accept,
+      :x_wap_profile
+    ].each do |header|
+      it { should respond_to(header) }
+      it "should return nil if not set in the constructor" do
+        subject.send(header).should be_nil
+      end
+    end
+    
+    context "the user_agent" do
+      [
+        'HTTP_X_DEVICE_USER_AGENT',
+    		'HTTP_X_ORIGINAL_USER_AGENT',
+    		'HTTP_X_OPERAMINI_PHONE_UA',
+    		'HTTP_X_SKYFIRE_PHONE',
+    		'HTTP_X_BOLT_PHONE_UA',
+    		'HTTP_USER_AGENT'
+  		].each do |user_agent_param|
+        it "should be read from #{user_agent_param} " do
+          env = {user_agent_param=>String.random}
+          WurflCloud::Environment.new(env).user_agent.should ==env[user_agent_param]
+        end
+  		end
+
+    end
+
+    context "the x_accept" do
+      it "should be read from HTTP_ACCEPT " do
+        env = {"HTTP_ACCEPT"=>String.random}
+        WurflCloud::Environment.new(env).x_accept.should ==env["HTTP_ACCEPT"]
+      end
+    end
+
+    context "the x_wap_profile" do
+      it "should be read from HTTP_X_WAP_PROFILE if present and HTTP_PROFILE is null" do
+        env = {"HTTP_X_WAP_PROFILE"=>String.random}
+        WurflCloud::Environment.new(env).x_wap_profile.should ==env["HTTP_X_WAP_PROFILE"]
+      end
+
+      it "should be read from HTTP_X_WAP_PROFILE if present and HTTP_PROFILE is present" do
+        env = {"HTTP_X_WAP_PROFILE"=>String.random, "HTTP_PROFILE"=>String.random}
+        WurflCloud::Environment.new(env).x_wap_profile.should ==env["HTTP_X_WAP_PROFILE"]
+      end
+      
+      it "should be read from HTTP_PROFILE if present and HTTP_X_WAP_PROFILE is nil" do
+        env = {"HTTP_PROFILE"=>String.random}
+        WurflCloud::Environment.new(env).x_wap_profile.should ==env["HTTP_PROFILE"]
+      end
+    end
+
+    context "the x_forwarded_for" do
+      it "should be the REMOTE_ADDR if present and HTTP_X_FORWARDED_FOR is absent" do
+        env = {"REMOTE_ADDR"=>String.random}
+        WurflCloud::Environment.new(env).x_forwarded_for.should ==env["REMOTE_ADDR"]
+      end
+      
+      it "should be the REMOTE_ADDR, HTTP_X_FORWARDED_FOR if both are present" do
+        env = {"REMOTE_ADDR"=>String.random, "HTTP_X_FORWARDED_FOR"=>String.random}
+        WurflCloud::Environment.new(env).x_forwarded_for.should =="#{env["REMOTE_ADDR"]}, #{env["HTTP_X_FORWARDED_FOR"]}"
+      end
+      
+      it "should be nil if REMOTE_ADDR and HTTP_X_FORWARDED_FOR is present" do
+        env = {"HTTP_X_FORWARDED_FOR"=>String.random}
+        WurflCloud::Environment.new(env).x_forwarded_for.should be_nil
+      end
+    end
+    
+  end
+end

data/spec/wurfl_cloud/helper_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+#
+# Copyright (c) 2015 ScientiaMobile Inc.
+#
+# The WURFL Cloud Client is intended to be used in both open-source and
+# commercial environments. To allow its use in as many situations as possible,
+# the WURFL Cloud Client is dual-licensed. You may choose to use the WURFL
+# Cloud Client under either the GNU GENERAL PUBLIC LICENSE, Version 2.0, or
+# the MIT License.
+#
+# Refer to the COPYING.txt file distributed with this package.
+#
+require 'spec_helper'
+require 'wurfl_cloud/helper'
+
+describe WurflCloud::Helper do
+  include WurflCloud::Helper
+  
+  context "the wurfl_detect_device method" do
+
+    it "should return a WurflCloud::Client object" do
+      
+      cookie = {'date_set' => Time.now.to_i, 'capabilities' => {'name'=>'example'}}
+      env = env_with_params("/", {}, {"HTTP_USER_AGENT"=>String.random, "HTTP_COOKIE" => "#{WurflCloud::Rack::CacheManager::COOKIE_NAME}=#{::Rack::Utils.escape(cookie.to_json)}"})
+      
+      @device_data = File.new("#{File.dirname(__FILE__)}/../files/generic.json").read
+      stub_request(:any, authenticated_uri).to_return(:status=>200, :body => @device_data)
+
+      @wurfl_device = wurfl_detect_device(env)     
+      @wurfl_device.should be_instance_of(WurflCloud::Client)
+
+    end
+  end
+
+end

data/spec/wurfl_cloud/memcached_cache_spec.rb

@@ -0,0 +1,122 @@
+#
+# Copyright (c) 2015 ScientiaMobile Inc.
+#
+# The WURFL Cloud Client is intended to be used in both open-source and
+# commercial environments. To allow its use in as many situations as possible,
+# the WURFL Cloud Client is dual-licensed. You may choose to use the WURFL
+# Cloud Client under either the GNU GENERAL PUBLIC LICENSE, Version 2.0, or
+# the MIT License.
+#
+# Refer to the COPYING.txt file distributed with this package.
+#
+require 'spec_helper'
+require 'wurfl_cloud/cache/memcached'
+require 'digest/md5'
+require 'dalli'
+
+describe WurflCloud::Cache::Memcached do
+  subject { WurflCloud::Cache::Memcached.new({:server=>'localhost:11211'}, {}) }
+
+  before(:each) do
+    @memcached = Dalli::Client.new('localhost:11211')
+    @memcached.flush()
+    @key = String.random
+    @value = String.random
+  end
+  
+  context "the object" do
+        
+    it { should respond_to(:[]).with(1).argument }
+    it { should respond_to(:[]=).with(2).arguments }
+    it { should respond_to(:mtime).with(0).arguments }
+    it { should respond_to(:mtime=).with(1).argument }
+    it { should respond_to(:prefix).with(0).arguments }
+    it { should respond_to(:key_prefix).with(0).arguments }
+    
+    it "should not throw errors calling []=" do
+      expect { subject[String.random] = String.random }.to_not raise_error
+    end
+    
+    it "should have an empty prefix" do
+      subject.prefix.should ==""
+    end
+    
+    it "should have the key_prefix contain the mtime" do
+      mtime = Time.now.to_i
+      subject.mtime = mtime
+      subject.key_prefix.should include("#{mtime}:")
+    end
+    
+    it "should store values" do
+      key = String.random
+      subject[key] = String.random
+      subject[key].should_not be_nil
+    end
+    
+    it "should read the value from the memcache" do
+      @memcached.set("#{subject.key_prefix}#{Digest::MD5.hexdigest(@key)}", @value)
+      subject[@key].should ==@value
+    end
+
+    it "should set the value into memcache" do
+      subject[@key] = @value
+      @memcached.get("#{subject.key_prefix}#{Digest::MD5.hexdigest(@key)}").should ==@value
+    end
+
+    it "should read the mtime value from memcache" do
+      mtime = Time.now.to_i
+      @memcached.set("mtime", mtime)
+      subject.mtime.should ==mtime
+    end
+
+    it "should store the mtime value into memcache" do
+      mtime = Time.now.to_i
+      subject.mtime = mtime
+      @memcached.get("mtime").should ==mtime
+    end
+
+    it "should store the mtime value into memcache when validating the cache" do
+      mtime = Time.now.to_i
+      subject.validate(mtime)
+      @memcached.get("mtime").should ==mtime
+    end
+  end
+  
+  context "with a prefix" do
+    before(:each) do
+      @cache = WurflCloud::Cache::Memcached.new({:server=>'localhost:11211', :prefix=>"a_prefix"}, {})
+    end
+
+    it "should not have an empty prefix" do
+      @cache.prefix.should =="a_prefix:"
+    end
+    
+    it "should have the key_prefix start with the prefix" do
+      @cache.key_prefix.should =~/^a_prefix:/
+    end
+
+    it "should have the key_prefix contain the mtime" do
+      mtime = Time.now.to_i
+      @cache.mtime = mtime
+      @cache.key_prefix.should include("#{mtime}:")
+    end
+    
+    it "should read the mtime value from memcache" do
+      mtime = Time.now.to_i
+      @memcached.set("a_prefix:mtime", mtime)
+      @cache.mtime.should ==mtime
+    end
+
+    it "should store the mtime value into memcache" do
+      mtime = Time.now.to_i
+      @cache.mtime = mtime
+      @memcached.get("a_prefix:mtime").should ==mtime
+    end
+
+    it "should store the mtime value into memcache when validating the cache" do
+      mtime = Time.now.to_i
+      @cache.validate(mtime)
+      @memcached.get("a_prefix:mtime").should ==mtime
+    end
+  end
+end

data/spec/wurfl_cloud/null_cache_spec.rb

@@ -0,0 +1,37 @@
+#
+# Copyright (c) 2015 ScientiaMobile Inc.
+#
+# The WURFL Cloud Client is intended to be used in both open-source and
+# commercial environments. To allow its use in as many situations as possible,
+# the WURFL Cloud Client is dual-licensed. You may choose to use the WURFL
+# Cloud Client under either the GNU GENERAL PUBLIC LICENSE, Version 2.0, or
+# the MIT License.
+#
+# Refer to the COPYING.txt file distributed with this package.
+#
+require 'spec_helper'
+describe WurflCloud::Cache::Null do
+  subject { WurflCloud::Cache::Null.new({}, Object.new) }
+  
+  context "the object" do    
+    it { should respond_to(:[]).with(1).argument }
+    it { should respond_to(:[]=).with(2).arguments }
+    it { should respond_to(:mtime).with(0).arguments }
+    it { should respond_to(:mtime=).with(1).argument }
+    
+    it "should not throw errors calling []=" do
+      expect { subject[String.random] = String.random }.to_not raise_error
+    end
+
+    it "should not store values" do
+      key = String.random
+      subject[key] = String.random
+      subject[key].should be_nil
+    end
+    
+    it "should not store the mtime" do
+      subject.mtime = rand
+      subject.mtime.should be_nil
+    end
+  end
+end

data/spec/wurfl_cloud/rack_cache_manager_spec.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+#
+# Copyright (c) 2015 ScientiaMobile Inc.
+#
+# The WURFL Cloud Client is intended to be used in both open-source and
+# commercial environments. To allow its use in as many situations as possible,
+# the WURFL Cloud Client is dual-licensed. You may choose to use the WURFL
+# Cloud Client under either the GNU GENERAL PUBLIC LICENSE, Version 2.0, or
+# the MIT License.
+#
+# Refer to the COPYING.txt file distributed with this package.
+#
+require 'spec_helper'
+
+describe WurflCloud::Rack::CacheManager do
+
+  context "the wurfl.cookie.device_cache env parameter" do
+        
+    it "should be inserted if the cookie exists" do
+      cookie = {'date_set' => Time.now.to_i, 'capabilities' => {'name'=>'example'}}
+      env = env_with_params("/", {}, {"HTTP_COOKIE" => "#{WurflCloud::Rack::CacheManager::COOKIE_NAME}=#{::Rack::Utils.escape(cookie.to_json)}"})
+      setup_rack(success_app).call(env)
+      env["wurfl.cookie.device_cache"].should_not be_nil
+    end
+
+    it "should be decoded from json" do
+      cookie = {'date_set' => Time.now.to_i, 'capabilities' => {'name'=>'example'}}
+      env = env_with_params("/", {}, {"HTTP_COOKIE" => "#{WurflCloud::Rack::CacheManager::COOKIE_NAME}=#{::Rack::Utils.escape(cookie.to_json)}"})
+      setup_rack(success_app).call(env)
+      env["wurfl.cookie.device_cache"].should =={'name'=>'example'}
+    end
+
+    it "should be nil if it doesn't exist" do
+      env = env_with_params("/", {}, {})
+      setup_rack(success_app).call(env)
+      env["wurfl.cookie.device_cache"].should be_nil
+    end
+
+    it "should be nil if not a valid json object" do
+      cookie = {}
+      env = env_with_params("/", {}, {"HTTP_COOKIE" => "#{WurflCloud::Rack::CacheManager::COOKIE_NAME}=#{::Rack::Utils.escape("{}")}"})
+      setup_rack(success_app).call(env)
+      env["wurfl.cookie.device_cache"].should be_nil
+    end
+    
+    it "should be nil if it lacks the date_set field" do
+      cookie = {'capabilities' => {}}
+      env = env_with_params("/", {}, {"HTTP_COOKIE" => "#{WurflCloud::Rack::CacheManager::COOKIE_NAME}=#{::Rack::Utils.escape(cookie.to_json)}"})
+      setup_rack(success_app).call(env)
+      env["wurfl.cookie.device_cache"].should be_nil
+    end
+
+    it "should be nil if it lacks the capabilities field" do
+      cookie = {'date_set' => Time.now.to_i}
+      env = env_with_params("/", {}, {"HTTP_COOKIE" => "#{WurflCloud::Rack::CacheManager::COOKIE_NAME}=#{::Rack::Utils.escape(cookie.to_json)}"})
+      setup_rack(success_app).call(env)
+      env["wurfl.cookie.device_cache"].should be_nil
+    end
+
+    it "should be nil if the capabilities field is empty" do
+      cookie = {'date_set' => (Time.now-WurflCloud::Rack::CacheManager::EXPIRY-1).to_i, 'capabilities' => {}}
+      env = env_with_params("/", {}, {"HTTP_COOKIE" => "#{WurflCloud::Rack::CacheManager::COOKIE_NAME}=#{::Rack::Utils.escape(cookie.to_json)}"})
+      setup_rack(success_app).call(env)
+      env["wurfl.cookie.device_cache"].should be_nil
+    end
+
+    it "should be nil if the cookie was expired" do
+      cookie = {'date_set' => (Time.now-WurflCloud::Rack::CacheManager::EXPIRY-1).to_i, 'capabilities' => {'name'=>'example'}}
+      env = env_with_params("/", {}, {"HTTP_COOKIE" => "#{WurflCloud::Rack::CacheManager::COOKIE_NAME}=#{::Rack::Utils.escape(cookie.to_json)}"})
+      setup_rack(success_app).call(env)
+      env["wurfl.cookie.device_cache"].should be_nil
+    end
+
+  end
+
+end

data/spec/wurfl_cloud/rails_cache_spec.rb

@@ -0,0 +1,126 @@
+#
+# Copyright (c) 2015 ScientiaMobile Inc.
+#
+# The WURFL Cloud Client is intended to be used in both open-source and
+# commercial environments. To allow its use in as many situations as possible,
+# the WURFL Cloud Client is dual-licensed. You may choose to use the WURFL
+# Cloud Client under either the GNU GENERAL PUBLIC LICENSE, Version 2.0, or
+# the MIT License.
+#
+# Refer to the COPYING.txt file distributed with this package.
+#
+require 'spec_helper'
+require 'digest/md5'
+require 'wurfl_cloud/cache/rails'
+
+# fake rails cache
+module Rails
+  class Cache
+    def initialize
+      @store = Hash.new
+    end
+    def write(key, value)
+      @store[key] = value
+    end
+    def read(key)
+      @store[key]
+    end
+  end
+  
+  class << self
+    def cache 
+      @cache ||= Rails::Cache.new
+    end
+  end
+end
+
+describe WurflCloud::Cache::Rails do
+  subject { WurflCloud::Cache::Rails.new({}, {}) }
+  
+  context "the object" do    
+    it { should respond_to(:[]).with(1).argument }
+    it { should respond_to(:[]=).with(2).arguments }
+    it { should respond_to(:mtime).with(0).arguments }
+    it { should respond_to(:mtime=).with(1).argument }
+    it { should respond_to(:prefix).with(0).arguments }
+    it { should respond_to(:key_prefix).with(0).arguments }
+    
+    it "should not throw errors calling []=" do
+      expect { subject[String.random] = String.random }.to_not raise_error
+    end
+
+    it "should store values" do
+      key = String.random
+      subject[key] = String.random
+      subject[key].should_not be_nil
+    end
+    
+    it "should have an empty prefix" do
+      subject.prefix.should ==""
+    end
+    
+    it "should have the key_prefix contain the mtime" do
+      mtime = Time.now.to_i
+      subject.mtime = mtime
+      subject.key_prefix.should include("#{mtime}:")
+    end
+
+  end
+  
+  context "given Rails.cache" do
+    before(:each) do
+      @cache = WurflCloud::Cache::Rails.new({}, {})
+      @key = String.random
+      @value = String.random
+    end
+    
+    it "should read the value from the Rails.cache" do
+      Rails.cache.write("#{@cache.key_prefix}#{Digest::MD5.hexdigest(@key)}", @value)
+      @cache[@key].should ==@value
+    end
+
+    it "should set the value into the Rails.cache" do
+      @cache[@key] = @value
+      Rails.cache.read("#{@cache.key_prefix}#{Digest::MD5.hexdigest(@key)}").should ==@value
+    end
+
+    context "with a prefix" do
+      before(:each) do
+        @cache = WurflCloud::Cache::Rails.new({:prefix=>"a_prefix"}, {})
+      end
+
+      it "should not have an empty prefix" do
+        @cache.prefix.should =="a_prefix:"
+      end
+
+      it "should have the key_prefix start with the prefix" do
+        @cache.key_prefix.should =~/^a_prefix:/
+      end
+
+      it "should have the key_prefix contain the mtime" do
+        mtime = Time.now.to_i
+        @cache.mtime = mtime
+        @cache.key_prefix.should include("#{mtime}:")
+      end
+
+      it "should read the mtime value from Rails.cache" do
+        mtime = Time.now.to_i
+        Rails.cache.write("a_prefix:mtime", mtime)
+        @cache.mtime.should ==mtime
+      end
+
+      it "should store the mtime value into Rails.cache" do
+        mtime = Time.now.to_i
+        @cache.mtime = mtime
+        Rails.cache.read("a_prefix:mtime").should ==mtime
+      end
+
+      it "should store the mtime value into Rails.cache when validating the cache" do
+        mtime = Time.now.to_i
+        @cache.validate(mtime)
+        Rails.cache.read("a_prefix:mtime").should ==mtime
+      end
+    end
+  end
+
+end