wurfl_cloud_client_light 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+coverage
+test_api_key.rb

data/FOSS_THIRD_PARTY_LICENSES.txt

@@ -0,0 +1,23 @@
+License of ./spec/support/rack_helpers.rb:
+
+# Copyright (c) 2009 Daniel Neighman
+# 
+# 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/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    wurfl_cloud_client (0.0.2)
+      json
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.7)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    json (1.6.5)
+    multi_json (1.1.0)
+    rack (1.4.1)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    webmock (1.8.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  simplecov
+  webmock
+  wurfl_cloud_client!

data/LICENSE.txt

@@ -0,0 +1,75 @@
+                                                                     
+                                                                     
+                                                                     
+                                             
+
+License for WURFL Cloud Client
+
+This software is © ScientiaMobile and all rights are reserved. 
+Software is licensed for your personal use, only in compliance 
+with the conditions set out in this license and solely for 
+connecting with certain services rendered by ScientiaMobile 
+under the name of WURFL Cloud, and with the several ones if any that 
+from time to time will be listed at http://www.scientiamobile.com/cloud. 
+
+License is subject the execution of the WURFL Cloud License Agreement and 
+the conditions therein are incorporated herewith. No other use is allowed 
+unless explicitly authorized in writing by ScientiaMobile.
+
+License is personal, conditioned, non-transferable, limited to the version 
+received and does not allow making derivative works even when 
+the source code is provided or the language is an interpreted one and regardless 
+whether the code is not obfuscated. By way of clarification “derivatives” 
+within the working of this license does not extend to linking an unmodified 
+instance of software lawfully obtained from ScientiaMobile with any other 
+software however licensed, no further permission is required for 
+this limited scope (linking exception).
+
+The software could contain, rely upon, depend on, interact with, link to 
+Free and Open Source Software (“FOSS”), Insofar as said FOSS is concerned 
+and where locally specified, the terms of the FOSS license prevail. 
+If You or any third party find any inconsistency, lack of clarity, or any 
+contradiction to the applicable FOSS license, and/or if You or any third party 
+want to exercise your or its rights under it, you or said party is invited to 
+write to FOSS-compliance@scientiamobile.com
+
+License will be terminated at the sole option of ScientiaMobile if You or 
+anybody on your behalf or under your control or solicitation will start or 
+threaten to start litigation against ScientiaMobile or any of its affiliates 
+and distributors for causes of action involving any ScientiaMobile software 
+or services, or if the WURFL Cloud License Agreement is terminated for 
+whichever reason or cause.
+
+SOFTWARE IS PROVIDED "AS IS" AND “AS AVAILABLE.”  ALL EXPRESS OR IMPLIED 
+CONDITIONS, REPRESENTATIONS, AND WARRANTIES INCLUDING, WITHOUT LIMITATION, 
+ANY IMPLIED WARRANTY OR CONDITION OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 
+PURPOSE, NON-INFRINGEMENT, SATISFACTORY QUALITY, NON-INTERFERENCE, ACCURACY 
+OF INFORMATIONAL CONTENT, OR ARISING FROM A COURSE OF DEALING, LAW, USAGE, 
+OR TRADE PRACTICE, ARE HEREBY EXCLUDED.  IN PARTICULAR, WE DO NOT REPRESENT 
+OR WARRANT TO YOU THAT YOUR USE OF THE SERVICES WILL MEET YOUR REQUIREMENTS, 
+YOUR USE OF THE SERVICES WILL BE UNINTERRUPTED, TIMELY, SECURE OR FREE FROM 
+ERROR, OR THAT DEFECTS IN THE OPERATION OR FUNCTIONALITY OF THE SERVICES OR 
+ANY SOFTWARE PROVIDED TO YOU AS PART OF THE SERVICES WILL BE CORRECTED.
+LIMITATION OF LIABILITY. YOU EXPRESSLY UNDERSTAND AND AGREE THAT WE SHALL 
+NOT BE LIABLE TO YOU FOR: (A) ANY INDIRECT, INCIDENTAL, SPECIAL CONSEQUENTIAL 
+OR EXEMPLARY DAMAGES WHICH MAY BE INCURRED BY YOU, HOWEVER CAUSED AND UNDER 
+ANY THEORY OF LIABILITY, INCLUDING, BUT NOT BE LIMITED TO, ANY LOSS OF PROFIT 
+(WHETHER INCURRED DIRECTLY OR INDIRECTLY), ANY LOSS OF GOODWILL OR BUSINESS 
+REPUTATION, ANY LOSS OF DATA SUFFERED, COST OF PROCUREMENT OF SUBSTITUTE 
+GOODS OR SERVICES, OR OTHER INTANGIBLE LOSS; (B) ANY DIRECT LOSS OR DAMAGE 
+WHICH MAY BE INCURRED BY YOU IN EXCESS OF THE AMOUNT YOU PAID FOR THE SERVICE 
+IN THE CONTRACT MONTH IN WHICH THE LOSS OR DAMAGE WAS INCURRED (OR IN THE 
+CASE OF A FREE ACCOUNT TEN DOLLARS).  THE LIMITATIONS ON OUR LIABILITY TO 
+YOU IN THIS AGREEMENT SHALL APPLY WHETHER OR NOT WE HAVE BEEN ADVISED OF 
+OR SHOULD HAVE BEEN AWARE OF THE POSSIBILITY OF ANY SUCH LOSSES ARISING.
+Should you need to verify the working of the software for ensuring that 
+the same is adequate to your use, does not contain dangerous or malicious 
+code or is sufficiently hardened, as well in order to submit patches 
+and/or bug fixes, and in order to perform said activities you need a 
+copy of the corresponding source code that is not already readily available, 
+you are invited to contact ScientiaMobile and ask for a copy under a separate 
+agreement, which will be negotiated in good faith.
+
+The laws of the Commonwealth of Virginia apply to this license.
+
+

data/Rakefile

@@ -0,0 +1,14 @@
+#
+# This software is the Copyright of ScientiaMobile, Inc. 
+# Please refer to the LICENSE.txt file distributed with the software for licensing information
+#
+require 'bundler'
+
+task 'build' do
+  Bundler::GemHelper.new(Dir.pwd, 'wurfl_cloud_client').build_gem
+  Bundler::GemHelper.new(Dir.pwd, 'wurfl_cloud_client_light').build_gem
+  
+end
+
+# Bundler::GemHelper.install_tasks
+

data/lib/wurfl_cloud/cache/cookie.rb

@@ -0,0 +1,36 @@
+#
+# This software is the Copyright of ScientiaMobile, Inc. 
+# Please refer to the LICENSE.txt file distributed with the software for licensing information
+#
+module WurflCloud
+  module Cache
+    class Cookie
+      
+      def initialize(options, environment)
+        @env = environment
+      end
+      
+      attr_accessor :mtime
+      
+      def mtime
+        nil
+      end
+
+      # Validates the cache
+      # it's a no-op in the cookie cache
+      def validate(current_mtime)
+      end
+      
+      # Should return the value stored for the key, nil if the key is not in cache
+      # The Cookie cache always returns the value of the env (no matter what the key)
+      def [](key)
+        @env['wurfl.cookie.device_cache']
+      end
+      
+      # Sets the value in the cache, for the Cookie cache it sets the env
+      def []=(key, value)
+        @env['wurfl.cookie.device_cache'] = value
+      end
+    end
+  end
+end

data/lib/wurfl_cloud/cache/local_memory.rb

@@ -0,0 +1,36 @@
+#
+# This software is the Copyright of ScientiaMobile, Inc. 
+# Please refer to the LICENSE.txt file distributed with the software for licensing information
+#
+module WurflCloud
+  module Cache
+    class LocalMemory
+      
+      def initialize(options=nil, environment=nil)
+        @cache = {}
+      end
+      
+      attr_accessor :mtime
+
+      def mtime
+        nil
+      end
+      
+      # Validates the cache
+      # it's a no-op in the local memory cache
+      def validate(current_mtime)
+      end
+      
+      # Should return the value stored for the key, nil if the key is not in cache
+      # The LocalMemory cache stores the values in the local hash
+      def [](key)
+        @cache[key]
+      end
+      
+      # reads the value from the local hash
+      def []=(key, value)
+        @cache[key] = value
+      end
+    end
+  end
+end

data/lib/wurfl_cloud/cache/null.rb

@@ -0,0 +1,34 @@
+#
+# This software is the Copyright of ScientiaMobile, Inc. 
+# Please refer to the LICENSE.txt file distributed with the software for licensing information
+#
+module WurflCloud
+  module Cache
+    class Null
+      
+      def initialize(options, environment)
+      end
+      
+      attr_accessor :mtime
+      
+      def mtime
+        nil
+      end
+      
+      # Validates the cache
+      # it's a no-op in the null cache
+      def validate(current_mtime)
+      end
+      
+      # Should return the value stored for the key, nil if the key is not in cache
+      # The Null cache always returns nil (nothing is cacheed)
+      def [](key)
+        nil
+      end
+      
+      # It's a no-op for the Null cache
+      def []=(key, value)
+      end
+    end
+  end
+end

data/lib/wurfl_cloud/client.rb

@@ -0,0 +1,98 @@
+#
+# This software is the Copyright of ScientiaMobile, Inc. 
+# Please refer to the LICENSE.txt file distributed with the software for licensing information
+#
+require 'wurfl_cloud/device_capabilities'
+require 'net/http'
+
+module WurflCloud
+  class Client
+    
+    attr_reader :device_capabilities, :read_from_cache
+    
+    def initialize(e, c)
+      @environment = e
+      @cache = c
+      @device_capabilities = WurflCloud::DeviceCapabilities.new(@environment.user_agent)
+      @read_from_cache = false
+    end
+    
+    def [](capability_key)
+      if !@device_capabilities.has_key?(capability_key) && @read_from_cache
+        load_from_server!
+        store_in_cache
+      end
+      @device_capabilities[capability_key]
+    end
+    
+    def detect
+      unless load_from_cache 
+        load_from_server!
+        store_in_cache
+      end
+    end
+    
+    def load_from_server!
+      begin
+        # make the request
+        Net::HTTP.start(WurflCloud.configuration.host,WurflCloud.configuration.port) do |http|
+          req = Net::HTTP::Get.new(WurflCloud.configuration.path, http_headers)
+          req.basic_auth WurflCloud.configuration.api_user, WurflCloud.configuration.api_password
+          res = http.request(req)
+          
+          # emit the result
+          if res.code=="200" 
+            # read the response
+            @device_capabilities = WurflCloud::DeviceCapabilities.parse(res.body)
+            @cache.validate(@device_capabilities.mtime.to_i)
+            @read_from_cache = false
+          else
+            raise WurflCloud::Errors::ConnectionError.new("#{res.code} #{res.message}")
+          end
+        end    
+      rescue WurflCloud::Errors::GenericError => exc
+        raise exc
+      rescue Exception => exc
+        raise WurflCloud::Errors::ConnectionError.new(exc.message)
+      end
+    end
+    
+    class << self
+      
+      def detect_device(environment, cache)
+        new(environment, cache).tap do |client|          
+          client.detect
+        end
+      end
+      
+    end
+
+    private
+    
+    def http_headers
+      {
+        'X-Cloud-Client' => "WurflCloudClient/Ruby_#{WurflCloud::VERSION}",
+        "Content-Type"=>"application/json; charset=UTF-8"
+      }.tap do |h|
+        h['User-Agent'] = @environment.user_agent unless @environment.user_agent.nil?
+        h['X-Forwarded-For'] = @environment.x_forwarded_for unless @environment.x_forwarded_for.nil?
+        h['X-Accept'] = @environment.x_accept unless @environment.x_accept.nil?
+        h['X-Wap-Profile'] = @environment.x_wap_profile unless @environment.x_wap_profile.nil?
+      end
+    end
+    
+    def store_in_cache
+      @cache[@environment.user_agent] = @device_capabilities.to_hash
+    end
+    
+    def load_from_cache 
+      if cached_capabilities = @cache[@environment.user_agent]
+        @device_capabilities = WurflCloud::DeviceCapabilities.new(@environment.user_agent)
+        @device_capabilities.merge(cached_capabilities)
+        @read_from_cache = true
+        return true
+      end      
+    end
+    
+  end
+end

data/lib/wurfl_cloud/configuration.rb

@@ -0,0 +1,81 @@
+#
+# This software is the Copyright of ScientiaMobile, Inc. 
+# Please refer to the LICENSE.txt file distributed with the software for licensing information
+#
+require 'wurfl_cloud/errors'
+
+module WurflCloud
+  class Configuration
+    # The API key to access the WurflCloud api (defaults to "100000:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx").
+    attr_accessor :api_key
+    
+    # The API user id decoded from the api_key
+    attr_reader :api_user
+
+    # The API password decoded from the api_key
+    attr_reader :api_password
+
+    # The schema of the URI for the api server (defaults to http).
+    attr_accessor :schema
+
+    # The host to connect to (defaults to api.wurflcloud.com).
+    attr_accessor :host
+
+    # The port on which your WurflCloud server runs (defaults to 80).
+    attr_accessor :port
+
+    # The path (URL) for the API endpoint at the host (defaults to /v1/json).
+    attr_accessor :path
+
+    # The API Type, defaults to http (*not used*)
+    attr_accessor :api_type
+    
+    # The search parameter format (defaults to "search:(%{capabilities})")
+    attr_accessor :search_parameter 
+    
+    # The search parameter capabilities separator (defaults to ",")
+    attr_accessor :search_parameter_separator
+    
+    # The cache class to be used (defaults to a WurflCloud::Cache::Null )
+    attr_accessor :cache_class
+
+    # The cache_options to be used (defaults to {})
+    attr_accessor :cache_options
+    
+    def initialize
+      @api_key                    = "100000:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      @api_user                   = 100000
+      @api_password               = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      @host                       = 'api.wurflcloud.com'
+      @schema                     = 'http'
+      @port                       = 80
+      @path                       = '/v1/json'
+      @api_type                   = 'http'
+      @search_parameter           = "search:(%{capabilities})"
+      @search_parameter_separator = ','
+      @cache_class                = WurflCloud::Cache::Null
+      @cache_options              = {}
+    end
+    
+    def api_key=(new_key)
+      @api_key = new_key
+      if new_key=~/^(\d{6}):(\w{32})$/
+        @api_user = $1.to_i
+        @api_password = $2
+      else
+        raise WurflCloud::Errors::ConfigurationError.new
+      end
+    end
+    
+    def api_uri
+      "#{@schema}://#{@host}:#{@port}#{@path}"
+    end
+    
+    # creates a cache instance using the class and the options 
+    # given in the confinguration and passing whatever environment
+    # is passed in the parameters
+    def cache(environment)
+      @cache_class.new(@cache_options, environment)
+    end
+  end
+end