share_counts 0.0.2 → 0.0.3

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+check.rb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    share_counts (0.0.1)
+    share_counts (0.0.2)
       json
       nokogiri
       redis

data/lib/share_counts/caching.rb

@@ -1,110 +1,112 @@
-module ShareCountsCaching
-  
-  # 
-  # 
-  # Returns true if the Redis
-  # cache store has been initialised
-  # 
-  # 
-  def cache_enabled?
-    !$share_counts_cache.nil?
-  end
+module ShareCounts
+  module Caching
 
+    # 
+    # 
+    # Returns true if the Redis
+    # cache store has been initialised
+    # 
+    # 
+    def cache_enabled?
+      !$share_counts_cache.nil?
+    end
 
 
-  # 
-  # 
-  # Removes from Redis cache store all the keys 
-  # used by ShareCounts.
-  # 
-  # 
-  def clear_cache
-    ($share_counts_cache || {}).keys.select{|cache_key| cache_key =~ /^ShareCounts/ }.each{|cache_key| 
-      $share_counts_cache.del cache_key}
-  end
-  
-  
-  # 
-  # 
-  # Returns the cached share counts available for each URL, in the format
-  # 
-  # { 
-  #   "URL 1": {
-  #     :reddit      => N, 
-  #     :digg        => N, 
-  #     :twitter     => N, 
-  #     :facebook    => N, 
-  #     :fblike      => N, 
-  #     :linkedin    => N, 
-  #     :googlebuzz  => N, 
-  #     :stumbleupon => N
-  #   },
-  #   
-  #   "URL 2": {
-  #     ...
-  #   }
-  # }
-  # 
-  # 
-  def cached
-    urls = ($share_counts_cache || {}).keys.select{|k| k =~ /^ShareCounts/ }.inject({}) do |result, key|
-      data = key.split("||"); network = data[1]; url = data[2]; 
-      count = from_redis("ShareCounts||#{network}||#{url}")
-      (result[url] ||= {})[network.to_sym] = count unless ["all", "fball"].include? network
-      result
+
+    # 
+    # 
+    # Removes from Redis cache store all the keys 
+    # used by ShareCounts.
+    # 
+    # 
+    def clear_cache
+      ($share_counts_cache || {}).keys.select{|cache_key| cache_key =~ /^ShareCounts/ }.each{|cache_key| 
+        $share_counts_cache.del cache_key}
     end
-    urls
-  end
-  
-  # 
-  # 
-  # Enables caching with Redis. 
-  # 
-  # By default, it connects to 127.0.0.1:6379, but it is also
-  # possible to specify in the arguments :host, :port the
-  # connection details.
-  # 
-  # If the application using this gem is already using Redis too,
-  # with the "redis" gem, it is possible to use the existing 
-  # instance of Redis by either setting the :redist_store argument
-  # or by setting the global variable $share_counts_cache first.
-  # 
-  # 
-  def use_cache *args
-    arguments = args.inject({}) { |r, c| r.merge(c) }
-    $share_counts_cache ||= arguments[:redis_store] || 
-      Redis.new(:host => arguments[:host] || "127.0.0.1", :port => arguments[:port] || "6379")  
-  end
 
 
-  private 
-  
-  # 
-  # 
-  # Caches the given value in Redis under the key specified.
-  # By default the value is cached for two minutes, but it
-  # is also possible to override this expiration time by 
-  # setting the global variable $share_counts_cache_expire 
-  # to a number of seconds.
-  # 
-  # 
-  def to_redis(cache_key, value)
-    $share_counts_cache.set cache_key, Marshal.dump(value)
-    $share_counts_cache.expire cache_key, $share_counts_cache_expire || 120
-    value
-  end
+    # 
+    # 
+    # Returns the cached share counts available for each URL, in the format
+    # 
+    # { 
+    #   "URL 1": {
+    #     :reddit      => N, 
+    #     :digg        => N, 
+    #     :twitter     => N, 
+    #     :facebook    => N, 
+    #     :fblike      => N, 
+    #     :linkedin    => N, 
+    #     :googlebuzz  => N, 
+    #     :stumbleupon => N
+    #   },
+    #   
+    #   "URL 2": {
+    #     ...
+    #   }
+    # }
+    # 
+    # 
+    def cached
+      urls = ($share_counts_cache || {}).keys.select{|k| k =~ /^ShareCounts/ }.inject({}) do |result, key|
+        data = key.split("||"); network = data[1]; url = data[2]; 
+        count = from_redis("ShareCounts||#{network}||#{url}")
+        (result[url] ||= {})[network.to_sym] = count unless ["all", "fball"].include? network
+        result
+      end
+      urls
+    end
+
+    # 
+    # 
+    # Enables caching with Redis. 
+    # 
+    # By default, it connects to 127.0.0.1:6379, but it is also
+    # possible to specify in the arguments :host, :port the
+    # connection details.
+    # 
+    # If the application using this gem is already using Redis too,
+    # with the "redis" gem, it is possible to use the existing 
+    # instance of Redis by either setting the :redist_store argument
+    # or by setting the global variable $share_counts_cache first.
+    # 
+    # 
+    def use_cache *args
+      arguments = args.inject({}) { |r, c| r.merge(c) }
+      $share_counts_cache ||= arguments[:redis_store] || 
+        Redis.new(:host => arguments[:host] || "127.0.0.1", :port => arguments[:port] || "6379")  
+    end
+
+
+    private 
+
+    # 
+    # 
+    # Caches the given value in Redis under the key specified.
+    # By default the value is cached for two minutes, but it
+    # is also possible to override this expiration time by 
+    # setting the global variable $share_counts_cache_expire 
+    # to a number of seconds.
+    # 
+    # 
+    def to_redis(cache_key, value)
+      $share_counts_cache.set cache_key, Marshal.dump(value)
+      $share_counts_cache.expire cache_key, $share_counts_cache_expire || 120
+      value
+    end
+
+
+    # 
+    # 
+    # Retrieves the value stores in Redis under 
+    # the given key.
+    # 
+    # 
+    def from_redis(cache_key)
+      value = $share_counts_cache.get(cache_key)
+      return if value.nil?
+      Marshal.load value
+    end
 
-  
-  # 
-  # 
-  # Retrieves the value stores in Redis under 
-  # the given key.
-  # 
-  # 
-  def from_redis(cache_key)
-    value = $share_counts_cache.get(cache_key)
-    return if value.nil?
-    Marshal.load value
   end
-  
-end
+end

data/lib/share_counts/common.rb

@@ -1,106 +1,108 @@
-module ShareCountsCommon
+module ShareCounts
+  module Common
 
-  private
-  
-  # 
-  # 
-  # Given the name of one of the supported social networks and a URL,
-  # attempts the execution of the given block to fetch the relevant share count.
-  # 
-  # If caching with Redis is enabled, it will first try to 
-  # fetch the share count from cache instead, if there is a valid 
-  # cached value for the combination of network/URL. When a share count is 
-  # instead retrieved with an HTTP request to the network's API and 
-  # the caching with Redis is enabled, the value fetched is also cached.
-  # 
-  # NOTE: caching will be skipped if the block fails.
-  # 
-  # 
-  def try service, url, &block
-    cache_key = "ShareCounts||#{service}||#{url}"
-    if cache_enabled?
-      if result = from_redis(cache_key)
-        puts "Loaded #{service} count from cache"
-        result
+    private
+
+    # 
+    # 
+    # Given the name of one of the supported social networks and a URL,
+    # attempts the execution of the given block to fetch the relevant share count.
+    # 
+    # If caching with Redis is enabled, it will first try to 
+    # fetch the share count from cache instead, if there is a valid 
+    # cached value for the combination of network/URL. When a share count is 
+    # instead retrieved with an HTTP request to the network's API and 
+    # the caching with Redis is enabled, the value fetched is also cached.
+    # 
+    # NOTE: caching will be skipped if the block fails.
+    # 
+    # 
+    def try service, url, &block
+      cache_key = "ShareCounts||#{service}||#{url}"
+      if cache_enabled?
+        if result = from_redis(cache_key)
+          puts "Loaded #{service} count from cache"
+          result
+        else
+          puts "Making request to #{service}..."
+          to_redis(cache_key, yield)
+        end
       else
-        puts "Making request to #{service}..."
-        to_redis(cache_key, yield)
+        puts "Redis caching is disabled - Making request to #{service}..."
+        yield
       end
-    else
-      puts "Redis caching is disabled - Making request to #{service}..."
-      yield
+    rescue Exception => e
+      puts "Something went wrong with #{service}: #{e}"
     end
-  rescue Exception => e
-    puts "Something went wrong with #{service}: #{e}"
-  end
 
 
-  # 
-  # 
-  # Performs an HTTP request to the given API URL with the specified params
-  # and within 2 seconds, and max 3 attempts
-  # 
-  # If a :callback param is also specified, then it is assumed that the API
-  # returns a JSON text wrapped in a call to a method by that callback name,
-  # therefore in this case it manipulates the response to extract only
-  # the JSON data required.
-  # 
-  def make_request *args
-    result   = nil
-    attempts = 1
+    # 
+    # 
+    # Performs an HTTP request to the given API URL with the specified params
+    # and within 2 seconds, and max 3 attempts
+    # 
+    # If a :callback param is also specified, then it is assumed that the API
+    # returns a JSON text wrapped in a call to a method by that callback name,
+    # therefore in this case it manipulates the response to extract only
+    # the JSON data required.
+    # 
+    def make_request *args
+      result   = nil
+      attempts = 1
 
-    begin
-      timeout(2) do
-        url         = args.shift
-        params      = args.inject({}) { |r, c| r.merge! c }
-        response    = RestClient.get url,  { :params => params }
+      begin
+        timeout(2) do
+          url         = args.shift
+          params      = args.inject({}) { |r, c| r.merge! c }
+          response    = RestClient.get url,  { :params => params }
 
 
-        # if a callback is specified, the expected response is in the format "callback_name(JSON data)";
-        # with the response ending with ";" and, in some cases, "\n"
-        result = params.keys.include?(:callback) \
-          ? response.gsub(/^(.*);+\n*$/, "\\1").gsub(/^#{params[:callback]}\((.*)\)$/, "\\1") \
-          : response
+          # if a callback is specified, the expected response is in the format "callback_name(JSON data)";
+          # with the response ending with ";" and, in some cases, "\n"
+          result = params.keys.include?(:callback) \
+            ? response.gsub(/^(.*);+\n*$/, "\\1").gsub(/^#{params[:callback]}\((.*)\)$/, "\\1") \
+            : response
+        end
+
+      rescue Exception => e
+        puts "Failed #{attempts} attempt(s)"
+        attempts += 1
+        retry if attempts <= 3
       end
-      
-    rescue Exception => e
-      puts "Failed #{attempts} attempt(s)"
-      attempts += 1
-      retry if attempts <= 3
+
+      result
     end
-    
-    result
-  end
 
 
-  # 
-  # 
-  # Makes an HTTP request with the given URL and params, and assumes 
-  # that the response is in JSON format, therefore it returns
-  # the parsed JSON.
-  # 
-  # 
-  def from_json *args
-    JSON.parse make_request *args
-  end
+    # 
+    # 
+    # Makes an HTTP request with the given URL and params, and assumes 
+    # that the response is in JSON format, therefore it returns
+    # the parsed JSON.
+    # 
+    # 
+    def from_json *args
+      JSON.parse make_request *args
+    end
 
-  # 
-  # 
-  # Most social networks' APIs returns normal JSON data;
-  # this method simply extracts directly the share count from
-  # the given JSON data, by following a pattern common to the
-  # structure of most JSON responses.
-  # 
-  # It also requires a :selector argument that determines how
-  # to "query" the JSON data in a way that emulates XPATH,
-  # so to extract the share count.
-  # 
-  # 
-  def extract_count *args
-    json = args.shift
-    result = args.first.flatten.last.split("/").inject( json.is_a?(Array) ? json.first : json ) { 
-      |r, c| r[c].is_a?(Array) ? r[c].first : r[c] 
-    }
-  end
+    # 
+    # 
+    # Most social networks' APIs returns normal JSON data;
+    # this method simply extracts directly the share count from
+    # the given JSON data, by following a pattern common to the
+    # structure of most JSON responses.
+    # 
+    # It also requires a :selector argument that determines how
+    # to "query" the JSON data in a way that emulates XPATH,
+    # so to extract the share count.
+    # 
+    # 
+    def extract_count *args
+      json = args.shift
+      result = args.first.flatten.last.split("/").inject( json.is_a?(Array) ? json.first : json ) { 
+        |r, c| r[c].is_a?(Array) ? r[c].first : r[c] 
+      }
+    end
 
-end
+  end
+end

data/lib/share_counts.rb

@@ -5,8 +5,8 @@ require File.expand_path(File.dirname(__FILE__) + "/share_counts/caching")
 
 module ShareCounts
 
-  extend ShareCountsCommon
-  extend ShareCountsCaching
+  extend Common
+  extend Caching
 
   def self.supported_networks
     %w(reddit digg twitter facebook fblike linkedin googlebuzz stumbleupon)

data/share_counts.gemspec

@@ -4,7 +4,7 @@ $:.push File.expand_path("../lib/share_counts", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "share_counts"
-  s.version     = "0.0.2"
+  s.version     = "0.0.3"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Vito Botta"]
   s.email       = ["vito@botta.name"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Vito Botta
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-30 00:00:00 +00:00
+date: 2011-01-31 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency