silver_spoon 0.0.1 → 0.0.2

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format nested
+--order random

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
-## 0.0.1 
+## 0.0.2
+
+* Fixed bug in has_entitlements?. I'm not sure how it was ever correct :(
+
+## 0.0.1
 
 * Initial release

data/lib/silver_spoon/entitlements.rb

@@ -1,17 +1,39 @@
 module SilverSpoon
   module Entitlements
+    # Add an entitlement for a given +id+.
+    #
+    # @param id [String] Identifier.
+    # @param entitlement_key [String] Entitlement key.
+    # @param entitlement_value [String] Entitlement value.
+    # @param scope [String, SilverSpoon.default_scope] Scope.
     def add_entitlement(id, entitlement_key, entitlement_value, scope = SilverSpoon.default_scope)
       add_entitlements(id, [entitlement_key], [entitlement_value], scope)
     end
 
+    # Add multiple entitlements for a given +id+.
+    #
+    # @param id [String] Identifier.
+    # @param entitlement_keys [Array of String] Entitlement keys.
+    # @param entitlement_values [Array of String] Entilement values.
+    # @param scope [String, SilverSpoon.default_scope] Scope.
     def add_entitlements(id, entitlement_keys, entitlement_values, scope = SilverSpoon.default_scope)
       SilverSpoon.redis.hmset(silver_spoon_key(id, SilverSpoon.namespace, scope), *entitlement_keys.zip(entitlement_values).flatten!)
     end
 
+    # Remove an entitlement for a given +id+.
+    #
+    # @param id [String] Identifier.
+    # @param entitlement_key [String] Entitlement key.
+    # @param scope [String, SilverSpoon.default_scope] Scope.
     def remove_entitlement(id, entitlement_key, scope = SilverSpoon.default_scope)
       remove_entitlements(id, [entitlement_key], scope)
     end
 
+    # Remove multiple entitlements for a given +id+.
+    #
+    # @param id [String] Identifier.
+    # @param entitlement_keys [Array of String] Entitlement keys.
+    # @param scope [String, SilverSpoon.default_scope] Scope.
     def remove_entitlements(id, entitlement_keys, scope = SilverSpoon.default_scope)
       SilverSpoon.redis.multi do |transaction|
         entitlement_keys.each do |entitlement_key|
@@ -20,28 +42,63 @@ module SilverSpoon
       end
     end
 
+    # Retrieve an entitlement for a given +id+.
+    #
+    # @param id [String] Identifier.
+    # @param entitlement_key [String] Entitlement key.
+    # @param scope [String, SilverSpoon.default_scope] Scope.
+    #
+    # @return Hash of entitlement key to entitlement value.
     def retrieve_entitlement(id, entitlement_key, scope = SilverSpoon.default_scope)
       retrieve_entitlements(id, [entitlement_key], scope)
     end
 
+    # Retrieve a set of entitlements for a given +id+.
+    #
+    # @param id [String] Identifier.
+    # @param entitlement_keys [Array of String] Entitlement keys.
+    # @param scope [String, SilverSpoon.default_scope] Scope.
+    #
+    # @return Hash of entitlement keys to entitlement values.
     def retrieve_entitlements(id, entitlement_keys, scope = SilverSpoon.default_scope)
       Hash[*entitlement_keys.zip(SilverSpoon.redis.hmget(silver_spoon_key(id, SilverSpoon.namespace, scope), *entitlement_keys)).flatten!]
     end
 
+    # Check to see if a given +id+ has a given entitlement.
+    #
+    # @param id [String] Identifier.
+    # @param entitlement_key [String] Entitlement key.
+    # @param scope [String, SilverSpoon.default_scope] Scope.
+    #
+    # @return +true+ if the +id+ has the requested entitlement, +false+ otherwise.
     def has_entitlement?(id, entitlement_key, scope = SilverSpoon.default_scope)
       SilverSpoon.redis.hexists(silver_spoon_key(id, SilverSpoon.namespace, scope), entitlement_key)
     end
 
+    # Check to see if a given +id+ has a given set of entitlements.
+    #
+    # @param id [String] Identifier.
+    # @param entitlement_keys [Array of String] Entitlement keys.
+    # @param scope [String, SilverSpoon.default_scope] Scope.
+    #
+    # @return Array where +true+ if the +id+ has the requested entitlement, +false+ otherwise for each entitlement.
     def has_entitlements?(id, entitlement_keys, scope = SilverSpoon.default_scope)
       SilverSpoon.redis.multi do |transaction|
         entitlement_keys.each do |entitlement_key|
           transaction.hexists(silver_spoon_key(id, SilverSpoon.namespace, scope), entitlement_key)
         end
-      end.map { |value| value == 0 ? false : true }
+      end
     end
 
-    private 
+    private
 
+    # Helper method for SilverSpoon keys in form of +id:namespace:scope+.
+    #
+    # @param id [String] Identifier.
+    # @param namespace [String] Namespace.
+    # @param scope [String] Scope.
+    #
+    # @return Key in form of +id:namespace:scope+.
     def silver_spoon_key(id, namespace, scope)
       "#{namespace}:#{scope}:#{id}"
     end

data/lib/silver_spoon/version.rb

@@ -1,3 +1,3 @@
 module SilverSpoon
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/silver_spoon/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe 'SilverSpoon::VERSION' do
   it 'should be the correct version' do
-    SilverSpoon::VERSION.should == '0.0.1'
+    SilverSpoon::VERSION.should == '0.0.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: silver_spoon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000 Z
+date: 2012-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3943121066716164985
+      hash: -3056986767722262899
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,10 +106,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3943121066716164985
+      hash: -3056986767722262899
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Entitlements in Redis. A simple wrapper around Redis hashes for adding, removing,