boffin 0.3.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1390bed0369dd43eb7dbe07d1ecf8742ffdaf134
+  data.tar.gz: 2cdd53fe1d9598b296302340dc4bebe0f016f450
+SHA512:
+  metadata.gz: c9f6ca3b08a95c6ff48915a9d68c94b405769fe0767f7ed4eef42e0cb6cdc2e4d5ccfe61f8cf58c68c1e20380d2c24400bbdb4c7249720bb32498ee7049cc401
+  data.tar.gz: becf97f999b9050ede5bf07f85329440ffa4ce5d244fa595f0f60543142c427da6689fd0af79d83c9124bbfa42d74db9a73f09fcdf5f50d65d5761e4d6f0f90b

data/CHANGELOG.md

@@ -1,15 +1,29 @@
-**0.3.0**
+1.0.0
+
+ * Support for redis-rb 3.0, no backwards compatibility is maintained
+ * Ruby 2.0 is now officially supported, 1.9.3, and 1.8.7 are still supported
+ * Removed `Tracker#uhit_count` in favour of `Tracker#count(..., unique: true)`
+ * Renamed `Utils#object_as_session_identifier` to `Utils#object_as_uid`
+ * Renamed `Tracker#hit_count` to `Tracker#count`
+ * Renamed `Utils#uniquenesses_as_session_identifier` to `Utils#uniquenesses_as_uid`
+ * Changed `Utils#uniquenesses_as_uid` to splat arguments, this allows for uses
+   like `Tracker.hit(:thing, unique: current_user)` instead of
+   `Tracker.hit(:thing, unique: [current_user])`
+ * Removed `Tracker#hit_count_for_session_id` in favour of
+   `Tracker#count(..., unique: unique_object)`
+
+0.3.0
 
  * `Hit` can now accept a custom increment, this allows values such as cents to
-   be tracked. (Justin Giancola)
+   be tracked (Justin Giancola)
  * Unique qualities are now passed in as a member in an options hash for
    `Tracker#hit`, this deprecates the unique qualities argument and allows for
-   other options such as `:increment` to be passed as well. (Justin Giancola)
+   other options such as `:increment` to be passed as well (Justin Giancola)
 
-**0.2.0**
+0.2.0
 
- * Support for Ruby 1.8.7 thanks to Justin Giancola
+ * Support for Ruby 1.8.7 (Justin Giancola)
 
-**0.1.0**
+0.1.0
 
  * Initial public release

data/Gemfile

@@ -1,8 +1,6 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rake'
   gem 'redcarpet'
-  gem 'yard', :git => 'https://github.com/lsegal/yard.git'
 end

data/README.md

@@ -36,14 +36,6 @@ probably that of a Rails or Sinatra application. Just add `boffin` to your
 gem 'boffin'
 ```
 
-For utmost performance on *nix-based systems, require
-[hiredis](https://github.com/pietern/hiredis-rb) before you require Boffin:
-
-```ruby
-gem 'hiredis'
-gem 'boffin'
-```
-
 Configuration
 -------------
 
@@ -118,7 +110,7 @@ Now to track hits on instances of the Listing model, simply:
 get '/listings/:id' do
   @listing = Listing[params[:id]]
   @listing.hit(:views)
-  haml :'listings/show'
+  erb :'listings/show'
 end
 ```
 
@@ -129,13 +121,13 @@ identify hits from particular users or sessions:
 get '/listings/:id' do
   @listing = Listing[params[:id]]
   @listing.hit(:views, unique: [current_user, session[:id]])
-  haml :'listings/show'
+  erb :'listings/show'
 end
 ```
 
 Boffin now adds uniqueness to the hit in the form of `current_user.id` if
 available. If `current_user` is nil, Boffin then uses `session[:id]`. You can
-provide as many uniquenesses as you'd like, the first one that is not blank
+provide as many unique factors as you'd like, the first one that is not blank
 (`nil`, `false`, `[]`, `{}`, or `''`) will be used.
 
 It could get a bit tedious having to add `[current_user, session[:id]]` whenever
@@ -167,7 +159,7 @@ You get the idea, now storing a hit is as easy as:
 get '/listings/:id' do
   @listing = Listing[params[:id]]
   hit @listing, :views
-  haml :'listings/show'
+  erb :'listings/show'
 end
 ```
 
@@ -182,10 +174,16 @@ After some hits have been tracked, you can start to do some queries:
 @listing.hit_count(:views)
 ```
 
-**Get count of unique views for an instance**
+**Get count of all unique views for an instance**
 
 ```ruby
-@listing.uhit_count(:views)
+@listing.hit_count(:views, unique: true)
+```
+
+**Get count of unique views for a specific user**
+
+```ruby
+@listing.hit_count(:views, unique: current_user)
 ```
 
 **Get IDs of the most viewed listings in the past 5 days**
@@ -197,7 +195,7 @@ Listing.top_ids(:views, days: 5)
 **Get IDs of the least viewed listings (that were viewed) in the past 8 hours**
 
 ```ruby
-Listing.top_ids(:views, hours: 8, order: 'asc')
+Listing.top_ids(:views, hours: 8, order: :asc)
 ```
 
 **Get IDs and hit counts of the most liked listings in the past 5 days**
@@ -238,12 +236,12 @@ track your friends' favourite and least favourite colours:
 ```ruby
 @tracker = Boffin::Tracker.new(:colours, [:faves, :unfaves])
 
-@tracker.hit(:faves,   'red',    unique: ['lena'])
-@tracker.hit(:unfaves, 'blue',   unique: ['lena'])
-@tracker.hit(:faves,   'green',  unique: ['soren'])
-@tracker.hit(:unfaves, 'red',    unique: ['soren'])
-@tracker.hit(:faves,   'green',  unique: ['jens'])
-@tracker.hit(:unfaves, 'yellow', unique: ['jens'])
+@tracker.hit(:faves,   'red',    unique: 'lena')
+@tracker.hit(:unfaves, 'blue',   unique: 'lena')
+@tracker.hit(:faves,   'green',  unique: 'soren')
+@tracker.hit(:unfaves, 'red',    unique: 'soren')
+@tracker.hit(:faves,   'green',  unique: 'jens')
+@tracker.hit(:unfaves, 'yellow', unique: 'jens')
 
 @tracker.top(:faves, days: 1)
 ```
@@ -257,7 +255,7 @@ WordsTracker = Boffin::Tracker.new(:words, [:searches, :tweets])
 get '/search' do
   @tweets = Tweet.search(params[:q])
   params[:q].split.each { |word| WordsTracker.hit(:searches, word) }
-  haml :'search/show'
+  erb :'search/show'
 end
 
 post '/tweets' do
@@ -266,13 +264,13 @@ post '/tweets' do
     @tweet.words.each { |word| WordsTracker.hit(:tweets, word) }
     redirect to("/tweets/#{@tweet.id}")
   else
-    haml :'tweets/form'
+    erb :'tweets/form'
   end
 end
 
 get '/trends' do
   @words = WordsTracker.top({ tweets: 3, searches: 1 }, hours: 5)
-  haml :'trends/index'
+  erb :'trends/index'
 end
 ```
 _*This is a joke._
@@ -327,6 +325,12 @@ The Future™
 FAQ
 ---
 
+### OMG haven't you heard of page caching?! How am I supposed to use this if my Ruby app doesn't get hit?
+
+Make an XHR request to an endpoint which is soley responsible for tracking hits
+to stuff whenever a specific thing loads. My above examples are just to
+demonstrate how to use the APIs, you can use them wherever you want.
+
 ### What's with the name?
 
 Well, it means [this](http://en.wikipedia.org/wiki/Boffin). For the purposes of

data/boffin.gemspec

@@ -1,25 +1,16 @@
-require File.expand_path('../lib/boffin/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boffin/version'
 
 Gem::Specification.new do |s|
-  s.name              = 'boffin'
-  s.version           = Boffin::VERSION
-  s.platform          = Gem::Platform::RUBY
-  s.date              = Date.today.strftime('%F')
-  s.homepage          = 'http://github.com/heycarsten/boffin'
-  s.author            = 'Carsten Nielsen'
-  s.email             = 'heycarsten@gmail.com'
-  s.summary           = 'Hit tracking library for Ruby using Redis'
-  s.has_rdoc          = 'yard'
-  s.rubyforge_project = 'boffin'
-  s.files             = `git ls-files`.split(/\n/)
-  s.test_files        = `git ls-files -- spec/*`.split(/\n/)
-  s.require_paths     = ['lib']
-
-  s.add_dependency             'redis',   '>= 2.2'
-  s.add_development_dependency 'rspec',   '~> 2.6'
-  s.add_development_dependency 'timecop'
-  s.add_development_dependency 'bundler', '>= 1.0.14'
-
+  s.name     = 'boffin'
+  s.version  = Boffin::VERSION
+  s.homepage = 'http://github.com/heycarsten/boffin'
+  s.authors  = ['Carsten Nielsen']
+  s.email    = ['heycarsten@gmail.com']
+  s.summary  = 'Hit tracking library for Ruby using Redis'
+  s.has_rdoc = 'yard'
+  s.license  = 'MIT'
   s.description = <<-END
 Boffin is a library for tracking hits to things in your Ruby application. Things
 can be IDs of records in a database, strings representing tags or topics, URLs
@@ -27,4 +18,16 @@ of webpages, names of places, whatever you desire. Boffin is able to provide
 lists of those things based on most hits, least hits, it can even report on
 weighted combinations of different types of hits.
   END
+
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'rspec',   '~> 2.13'
+  s.add_development_dependency 'timecop'
+
+  s.add_dependency 'redis',   '~> 3.0'
 end

data/lib/boffin/hit.rb

@@ -12,27 +12,19 @@ module Boffin
     # @param [Object] instance
     #   The instance that is being hit, any object that responds to
     #   `#to_member`, `#id`, or `#to_s`
-    # @param [Hash] options
-    # @option options [Array] :unique ([]) An array of which the first
+    # @param [Hash] opts
+    # @option opts [Array] :unique ([]) An array of which the first
     #   object is used to generate a session identifier for hit uniqueness
-    # @option options [Fixnum] :increment (1) The hit increment
+    # @option opts [Fixnum] :increment (1) The hit increment
     def initialize(tracker, type, instance, opts = {})
-      if opts.is_a?(Array)
-        warn "This constructor is deprecated and will soon be unavailable\n" \
-             "please create Hits with: \n" \
-             "Hit.new(@tracker, :type, @instance, :unique => [1,2,3,4])\n"
-        uniquenesses = opts
-        @increment   = 1
-      else
-        uniquenesses = opts.delete(:unique) || []
-        @increment   = opts.delete(:increment) || 1
-      end
-      @now      = Time.now
-      @sessid   = Utils.uniquenesses_as_session_identifier(uniquenesses)
-      @type     = type
-      @tracker  = tracker
-      @instance = instance
-      @member   = Utils.object_as_member(@instance)
+      uniquenesses = opts.delete(:unique) || []
+      @increment   = opts.delete(:increment) || 1
+      @now         = Time.now
+      @sessid      = Utils.uniquenesses_as_uid(uniquenesses)
+      @type        = type
+      @tracker     = tracker
+      @instance    = instance
+      @member      = Utils.object_as_member(@instance)
       store
       freeze
     end
@@ -65,11 +57,11 @@ module Boffin
     #   `true` if this hit is unique, `false` if it has been made before by the
     #   same session identifer.
     def track_hit
-      redis.incrby(keyspace.hit_count(@type, @instance), @increment)
-      redis.zincrby(keyspace.hits(@type, @instance), 1, @sessid) == '1'
+      redis.incrbyfloat(keyspace.hit_count(@type, @instance), @increment)
+      redis.zincrby(keyspace.hits(@type, @instance), 1, @sessid) == 1.0
     end
 
-    # Store the hit member across all time interval for the current window
+    # Store the hit member across all time intervals for the current window
     # @param [true, false] uniq
     #   If `true` the hit is also added to the keys scoped for unique hits
     def set_windows(uniq)

data/lib/boffin/trackable.rb

@@ -45,21 +45,9 @@ module Boffin
     end
 
     # @see Tracker#hit_count
-    # @return [Fixnum]
-    def hit_count(type)
-      self.class.boffin.hit_count(type, self)
-    end
-
-    # @see Tracker#uhit_count
-    # @return [Fixnum]
-    def uhit_count(type)
-      self.class.boffin.uhit_count(type, self)
-    end
-
-    # @see Tracker#hit_count_for_session_id
-    # @return [Fixnum]
-    def hit_count_for_session_id(type, sess_obj)
-      self.class.boffin.hit_count_for_session_id(type, self, sess_obj)
+    # @return [Float]
+    def hit_count(type, opts = {})
+      self.class.boffin.count(type, self, opts)
     end
 
   end

data/lib/boffin/tracker.rb

@@ -25,9 +25,9 @@ module Boffin
 
     # @param [Symbol] hit_type
     # @param [#as_member, #id, #to_s] instance
-    # @param [Hash] options
-    # @option options [Array] :unique ([]) uniquenesses
-    # @option options [Fixnum] :increment (1) hit increment
+    # @param [Hash] opts
+    # @option opts [Array] :unique ([]) uniquenesses
+    # @option opts [Fixnum] :increment (1) hit increment
     # @return [Hit]
     # @raise Boffin::UndefinedHitTypeError
     #   Raised if a list of hit types is available and the provided hit type is
@@ -38,45 +38,37 @@ module Boffin
     end
 
     # @param [Symbol] hit_type
+    #   Type of hit.
     # @param [#as_member, #id, #to_s] instance
-    # @return [Fixnum]
-    # @raise Boffin::UndefinedHitTypeError
-    #   Raised if a list of hit types is available and the provided hit type is
-    #   not in the list.
-    def hit_count(hit_type, instance)
-      validate_hit_type(hit_type)
-      redis.get(keyspace.hit_count(hit_type, instance)).to_i
-    end
-
-    # @param [Symbol] hit_type
-    # @param [#as_member, #id, #to_s] instance
-    # @return [Fixnum]
-    # @raise Boffin::UndefinedHitTypeError
-    #   Raised if a list of hit types is available and the provided hit type is
-    #   not in the list.
-    def uhit_count(hit_type, instance)
-      validate_hit_type(hit_type)
-      redis.zcard(keyspace.hits(hit_type, instance)).to_i
-    end
-
-    # @param [Symbol] hit_type
-    # @param [#as_member, #id, #to_s] instance
-    # @param [#as_member, #id, #to_s] sess_obj
-    # @return [Fixnum]
+    #   Object to track.
+    # @param [Hash] opts
+    # @option opts [true, #as_member, #id, #to_s] :unique (false)
+    #   If `true` will return a count of unique hits. If passed an object, will
+    #   use that object as a unique identifier and return the score associated
+    #   with it.
+    # @return [Float]
     # @raise Boffin::UndefinedHitTypeError
     #   Raised if a list of hit types is available and the provided hit type is
     #   not in the list.
-    def hit_count_for_session_id(hit_type, instance, sess_obj)
+    def count(hit_type, instance, opts = {})
       validate_hit_type(hit_type)
-      sessid = Utils.object_as_session_identifier(sess_obj)
-      redis.zscore(keyspace.hits(hit_type, instance), sessid).to_i
+      count = case
+      when opts[:unique] == true
+        redis.zcard(keyspace.hits(hit_type, instance))
+      when opts[:unique]
+        uid = Utils.object_as_uid(opts[:unique])
+        redis.zscore(keyspace.hits(hit_type, instance), uid)
+      else
+        redis.get(keyspace.hit_count(hit_type, instance))
+      end
+      (count && count.to_f) || 0.0
     end
 
     # Performs set union across the specified number of hours, days, or months
     # to calculate the members with the highest hit counts. The operation can
     # be performed on one hit type, or multiple hit types with weights.
     # @param [Symbol, Hash] type_or_weights
-    #   When Hash the set union is calculated 
+    #   When Hash the set union is calculated
     # @param [Hash] opts
     # @option opts [true, false] :unique (false)
     #   If `true` then only unique hits are considered in the calculation
@@ -169,7 +161,6 @@ module Boffin
     # @param [Keyspace] ks
     #   Keyspace to perform the union on
     # @param [Hash] weights
-    # @param [Symbol] hit_type
     # @param [:hours, :days, :months] unit
     # @param [Fixnum] size
     #   Number of intervals to include in the union
@@ -200,7 +191,7 @@ module Boffin
       zrangeopts = {
         :counts => opts.delete(:counts),
         :order  => (opts.delete(:order) || :desc).to_sym }
-      if redis.zcard(storkey) == 0
+      if redis.zcard(storkey) < 1
         redis.zunionstore(storkey, keys, opts)
         redis.expire(storkey, @config.cache_expire_secs)
       end
@@ -217,17 +208,16 @@ module Boffin
     #   option is `true` it returns an array of pairs where the first value is
     #   the member, and the second value is the member's score.
     def zrange(key, opts)
-      args = [key, 0, -1, opts[:counts] ? { :withscores => true } : {}]
-      result = case opts[:order]
-        when :asc  then redis.zrange(*args)
-        when :desc then redis.zrevrange(*args)
-      end
-      if opts[:counts]
-        result.each_slice(2).map { |mbr, score| [mbr, score.to_i] }
+      args = [key, 0, -1]
+      args << { :with_scores => true } if opts[:counts]
+      case opts[:order]
+      when :asc
+        redis.zrange(*args)
+      when :desc
+        redis.zrevrange(*args)
       else
-        result
+        raise ArgumentError, "unknown order type: #{opts[:order].inspect}"
       end
     end
-
   end
 end

data/lib/boffin/utils.rb

@@ -114,16 +114,16 @@ module Boffin
       times
     end
 
-    # Generates a set member based off the first object in the provided array
-    # that is not `nil`. If the array is empty or only contains `nil` elements
-    # then {Boffin::NIL_SESSION_MEMBER} is returned.
+    # Generates a unique set member based off the first object in the provided
+    # array that is not `nil`. If the array is empty or only contains `nil`
+    # element then {Boffin::NIL_SESSION_MEMBER} is returned.
     # @param [Array] aspects
     #   An array of which the first non-nil element is passed to
-    #   {#object_as_session_identifier}
+    #   {#object_as_uid}
     # @return [String]
-    def uniquenesses_as_session_identifier(aspects)
+    def uniquenesses_as_uid(*aspects)
       if (obj = aspects.flatten.reject { |u| blank?(u) }.first)
-        object_as_session_identifier(obj)
+        object_as_uid(obj)
       else
         NIL_SESSION_MEMBER
       end
@@ -172,7 +172,7 @@ module Boffin
     # @param [#as_member, #id, #to_s] obj
     # @return [String] A string that can be used as a member in {Keyspace#hits}.
     # @see #object_as_identifier
-    def object_as_session_identifier(obj)
+    def object_as_uid(obj)
       object_as_identifier(obj, :namespace => true)
     end
 

data/lib/boffin/version.rb

@@ -1,4 +1,4 @@
 module Boffin
   # Version of this Boffin release
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

data/spec/boffin/hit_spec.rb

@@ -21,8 +21,8 @@ describe Boffin::Hit, '::new' do
       @tracker.top(:tests, interval => 1, :counts => true, :unique => true).
         should == [['1', 1]]
     end
-    @tracker.hit_count(:tests, @ditty).should == 1
-    @tracker.uhit_count(:tests, @ditty).should == 1
+    @tracker.count(:tests, @ditty).should == 1
+    @tracker.count(:tests, @ditty, :unique => true).should == 1
   end
 
   it 'does not store data under unique keys if the hit is not unique' do
@@ -34,9 +34,9 @@ describe Boffin::Hit, '::new' do
       @tracker.top(:tests, interval => 1, :counts => true, :unique => true).
         should == [['1', 1]]
     end
-    @tracker.hit_count_for_session_id(:tests, @ditty, @user).should == 2
-    @tracker.hit_count(:tests, @ditty).should == 2
-    @tracker.uhit_count(:tests, @ditty).should == 1
+    @tracker.count(:tests, @ditty, :unique => @user).should == 2
+    @tracker.count(:tests, @ditty).should == 2
+    @tracker.count(:tests, @ditty, :unique => true).should == 1
   end
 
   it 'allows arbitrary hit increments' do

data/spec/boffin/trackable_spec.rb

@@ -4,8 +4,8 @@ describe Boffin::Trackable do
   before :all do
     SpecHelper.flush_keyspace!
     @mock = MockTrackableInjected.new(1)
-    @mock.hit(:views, :unique => ['sess.1'])
-    @mock.hit(:views, :unique => ['sess.1'])
+    @mock.hit(:views, :unique => 'sess.1')
+    @mock.hit(:views, :unique => 'sess.1')
   end
 
   it 'can be included' do
@@ -28,11 +28,11 @@ describe Boffin::Trackable do
     @mock.hit_count(:views).should == 2
   end
 
-  it 'delegates #uhit_count to the Tracker instance' do
-    @mock.uhit_count(:views).should == 1
+  it 'delegates #hit_count { unique: true } to the Tracker instance' do
+    @mock.hit_count(:views, :unique => true).should == 1
   end
 
-  it 'delegates #hit_count_for_session_id to the Tracker instance' do
-    @mock.hit_count_for_session_id(:views, 'sess.1').should == 2
+  it 'delegates #hit_count { unique: obj } to the Tracker instance' do
+    @mock.hit_count(:views, :unique => 'sess.1').should == 2
   end
 end

data/spec/boffin/tracker_spec.rb

@@ -55,64 +55,57 @@ describe Boffin::Tracker do
 
   describe '#hit' do
     it 'throws an error if the hit type is not in the list' do
-      lambda  { @tracker.hit(:view, @instance1) }.
+      lambda { @tracker.hit(:view, @instance1) }.
         should raise_error Boffin::UndefinedHitTypeError
     end
   end
 
   describe '#hit_count' do
     it 'throws an error if the hit type is not in the list' do
-      lambda  { @tracker.hit_count(:view, @instance1) }.
+      lambda { @tracker.count(:view, @instance1) }.
         should raise_error Boffin::UndefinedHitTypeError
     end
 
     it 'returns the raw hit count for the instance' do
-      @tracker.hit_count(:views, @instance1).should == 8
+      @tracker.count(:views, @instance1).should == 8
     end
 
     it 'returns 0 for an instance that was never hit' do
-      @tracker.hit_count(:views, 'neverhit').should == 0
-    end
-  end
-
-  describe '#uhit_count' do
-    it 'throws an error if the hit type is not in the list' do
-      lambda  { @tracker.uhit_count(:view, @instance1) }.
-        should raise_error Boffin::UndefinedHitTypeError
+      @tracker.count(:views, 'neverhit').should == 0
     end
 
     it 'returns the unique hit count for the instance' do
-      @tracker.uhit_count(:views, @instance1).should == 5
+      @tracker.count(:views, @instance1, :unique => true).should == 5
     end
 
     it 'returns 0 for an instance that was never hit' do
-      @tracker.hit_count(:likes, @instance4).should == 0
+      @tracker.count(:likes, @instance4, :unique => true).should == 0
     end
   end
 
   describe '#hit_count_for_session_id' do
     it 'throws an error if the hit type is not in the list' do
-      lambda  { @tracker.hit_count_for_session_id(:view, @instance1, 'sess.1') }.
+      lambda { @tracker.count(:view, @instance1, :unique => 'sess.1') }.
         should raise_error Boffin::UndefinedHitTypeError
     end
 
     it 'returns the number of times the instance was hit by the session id' do
-      @tracker.hit_count_for_session_id(:views, @instance3, 'sess.1').should == 3
+      @tracker.count(:views, @instance3, :unique => 'sess.1').should == 3
     end
 
     it 'returns a count of 0 if the session id never hit the instance' do
-      @tracker.hit_count_for_session_id(:views, @instance1, 'nohit').should == 0
+      @tracker.count(:views, @instance1, :unique => 'nohit').should == 0
     end
   end
 
   describe '#top' do
     it 'throws an error if passed hit type is invalid' do
-      lambda  { @tracker.top(:view, :days => 3) }.
+      lambda { @tracker.top(:view, :days => 3) }.
         should raise_error Boffin::UndefinedHitTypeError
     end
 
     it 'throws an error if passed weights with hit type that is invalid' do
-      lambda  { @tracker.top({ :view => 1 }, :days => 3) }.
+      lambda { @tracker.top({ :view => 1 }, :days => 3) }.
         should raise_error Boffin::UndefinedHitTypeError
     end
 
@@ -131,6 +124,11 @@ describe Boffin::Tracker do
       ids.should == ['200', '100', '300']
     end
 
+    it 'throws an error if the specified order is not valid' do
+      lambda { @tracker.top(:views, :days => 3, :order => 'desk') }.
+        should raise_error ArgumentError
+    end
+
     it 'returns ids and counts when passed { counts: true } as an option' do
       ids = @tracker.top(:views, :days => 3, :counts => true)
       ids.should == [

data/spec/boffin/utils_spec.rb

@@ -99,29 +99,29 @@ describe Boffin::Utils do
     end
   end
 
-  describe '::uniquenesses_as_session_identifier' do
+  describe '::uniquenesses_as_uid' do
     specify do
-      subject.uniquenesses_as_session_identifier([]).
+      subject.uniquenesses_as_uid([]).
         should == Boffin::NIL_SESSION_MEMBER
     end
 
     specify do
-      subject.uniquenesses_as_session_identifier([nil, 'hi']).
+      subject.uniquenesses_as_uid([nil, 'hi']).
         should == 'hi'
     end
 
     specify do
-      subject.uniquenesses_as_session_identifier([MockDitty.new]).
+      subject.uniquenesses_as_uid([MockDitty.new]).
         should == 'mock_ditty:1'
     end
   end
 
-  describe '::object_as_session_identifier' do
-    specify { subject.object_as_session_identifier(nil).should == '' }
-    specify { subject.object_as_session_identifier(3.14).should == '3.14' }
+  describe '::object_as_uid' do
+    specify { subject.object_as_uid(nil).should == '' }
+    specify { subject.object_as_uid(3.14).should == '3.14' }
 
     specify do
-      subject.object_as_session_identifier(MockDitty.new).
+      subject.object_as_uid(MockDitty.new).
         should == 'mock_ditty:1'
     end
   end

metadata

@@ -1,73 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: boffin
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Carsten Nielsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000Z
+date: 2013-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redis
-  requirement: &70276273568860 !ruby/object:Gem::Requirement
-    none: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  version_requirements: *70276273568860
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70276273568280 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.13'
   type: :development
   prerelease: false
-  version_requirements: *70276273568280
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70276273567900 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70276273567900
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70276273567340 !ruby/object:Gem::Requirement
-    none: false
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.14
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
-  version_requirements: *70276273567340
-description: ! 'Boffin is a library for tracking hits to things in your Ruby application.
-  Things
-
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  Boffin is a library for tracking hits to things in your Ruby application. Things
   can be IDs of records in a database, strings representing tags or topics, URLs
-
   of webpages, names of places, whatever you desire. Boffin is able to provide
-
   lists of those things based on most hits, least hits, it can even report on
-
   weighted combinations of different types of hits.
-
-'
-email: heycarsten@gmail.com
+email:
+- heycarsten@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -98,34 +132,28 @@ files:
 - spec/boffin_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/heycarsten/boffin
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2879744131493119363
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2879744131493119363
 requirements: []
-rubyforge_project: boffin
-rubygems_version: 1.8.6
+rubyforge_project: 
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Hit tracking library for Ruby using Redis
 test_files:
 - spec/boffin/config_spec.rb