wurfl_cloud_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d04e8db9f6b0603971e674521eab47bbf65eac09
+  data.tar.gz: a3ca3e5922319626662c2e11b513c086c0bec125
+SHA512:
+  metadata.gz: 98b2cdd9945df9fc89fb7f3bcaf58f7dade7121c7d2f2fb3e7f32facaf9cf1b1954679b786569fcb5000e62115b32e0f6f5061cebb580bc5995c1d44524f394b
+  data.tar.gz: 6c704bd2cba72ea4f0d0726ac5b1e2f98c3b3183e005acd80d024bae92bd41dd5c76807b54858eff3375507cde7e04405a85db6f51ba20a9e04e7c3bf3a868a1

data/.gitignore

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

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 (1.0.0)
+      json
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.7)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    json (1.8.2)
+    multi_json (1.1.0)
+    rack (1.6.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/Rakefile

@@ -0,0 +1,19 @@
+
+## 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 'bundler'
+
+task 'build' do
+  Bundler::GemHelper.new(Dir.pwd, 'wurfl_cloud_client').build_gem
+end
+
+# Bundler::GemHelper.install_tasks
+

data/lib/wurfl_cloud.rb

@@ -0,0 +1,49 @@
+#
+# 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 'wurfl_cloud/configuration'
+require 'wurfl_cloud/cache/null'
+require 'wurfl_cloud/cache/cookie'
+require 'wurfl_cloud/version'
+require 'wurfl_cloud/client'
+require 'wurfl_cloud/environment'
+require 'wurfl_cloud/device_capabilities'
+require 'wurfl_cloud/errors'
+
+module WurflCloud
+
+  class << self
+
+    # A configuration object. See WurflCloud::Configuration.
+    attr_writer :configuration
+
+    # Call this method to modify defaults in your initializers.
+    #
+    # @example
+    #   WurflCloud.configure do |config|
+    #     config.api_key = '00000000:xxxxxxxxxxxxxxxxxxxxxxxxxxx'
+    #     config.host  = 'staging.wurflcloud.com'
+    #   end
+    def configure(silent = false)
+      yield(configuration)
+    end
+
+    # The configuration object.
+    # @see WurflCloud.configure
+    def configuration
+      @configuration ||= WurflCloud::Configuration.new
+    end
+
+  end
+
+end
+
+require 'wurfl_cloud/rails' if defined?(Rails)

data/lib/wurfl_cloud/cache/cookie.rb

@@ -0,0 +1,43 @@
+#
+# 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.
+#
+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,43 @@
+#
+# 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.
+#
+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/memcached.rb

@@ -0,0 +1,64 @@
+#
+# 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 'digest/md5'
+module WurflCloud
+  module Cache
+    class Memcached
+      
+      def initialize(options, environment)
+        opts = options.clone
+        server = opts.delete(:server)
+        @prefix = opts.delete(:prefix)
+        opts[:expires_in] ||= 86400 
+        @memcached = Dalli::Client.new(server, opts)
+      end
+      
+      def prefix
+        "#{(@prefix.nil? || @prefix=="") ? "": "#{@prefix}:"}"
+      end
+      
+      def key_prefix        
+        "#{prefix}:#{mtime}:"
+      end
+      
+      def mtime
+        @memcached.get("#{prefix}mtime")
+      end
+      
+      def mtime=(new_mtime)
+        @memcached.set("#{prefix}mtime", new_mtime)
+      end
+      
+      # Validates the cache
+      # checks if the cache is still valid with respect to a new mtime received from the server
+      # if the new mtime is different from the one cached then it overwrites the current key
+      # prefix thus actually invalidationg the cache
+      def validate(current_mtime)
+        old_mtime = self.mtime
+        if !old_mtime || old_mtime!=current_mtime
+          self.mtime = current_mtime
+        end
+      end
+      
+      # Should return the value stored for the key, nil if the key is not in cache
+      # The Memcached cache reads from the mamcached server
+      def [](key)
+        @memcached.get("#{key_prefix}#{Digest::MD5.hexdigest(key)}")
+      end
+      
+      # Stores the value for the key in the mamcached server
+      def []=(key, value)
+        @memcached.set("#{key_prefix}#{Digest::MD5.hexdigest(key)}", value)
+      end
+    end
+  end
+end

data/lib/wurfl_cloud/cache/null.rb

@@ -0,0 +1,41 @@
+#
+# 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.
+#
+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/cache/rails.rb

@@ -0,0 +1,56 @@
+#
+# 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 'digest/md5'
+module WurflCloud
+  module Cache
+    class Rails
+      
+      def initialize(options, environment)
+        @prefix = options[:prefix]||''
+      end
+      
+      def prefix
+        "#{(@prefix.nil? || @prefix=="") ? "": "#{@prefix}:"}"
+      end
+      
+      def key_prefix        
+        "#{prefix}:#{mtime}:"
+      end
+      
+      def mtime
+        ::Rails.cache.read("#{prefix}mtime")
+      end
+      
+      def mtime=(new_mtime)
+        ::Rails.cache.write("#{prefix}mtime", new_mtime)
+      end
+
+      # Validates the cache
+      # checks if the cache is still valid with respect to a new mtime received from the server
+      # if the new mtime is different from the one cached then it overwrites the current key
+      # prefix thus actually invalidationg the cache
+      def validate(current_mtime)
+      end
+      
+      # Should return the value stored for the key, nil if the key is not in cache
+      # The Rails cache reads from the Rails.cache object
+      def [](key)
+        ::Rails.cache.read("#{key_prefix}#{Digest::MD5.hexdigest(key)}")
+      end
+      
+      # Stores the value for the key in the Rails.cache
+      def []=(key, value)
+        ::Rails.cache.write("#{key_prefix}#{Digest::MD5.hexdigest(key)}", value)
+      end
+    end
+  end
+end

data/lib/wurfl_cloud/client.rb

@@ -0,0 +1,105 @@
+#
+# 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 '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