osm 1.2.15 → 1.2.16

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjY5Mjk4ZWNkMTdiOTYwNjEyNjMzZDE5ZDJlNDZkMDRlNDhlNjViZA==
+    ODIwM2UyMGRkZWZiZmMxN2Y5M2VhODlkZDgyZDhjY2Y2YzRhYjYyZQ==
   data.tar.gz: !binary |-
-    YzkwMDhiNTljM2M5MTk0M2Y0MTUyN2MyYmVmNThlN2JlN2IwNjcxOQ==
+    ZmQ1OWJlOWUyMDUzNWFiMzk5MGJjYmYwMzAxOWNjMWU3ZTdiMTRiOQ==
 SHA512:
   metadata.gz: !binary |-
-    YWRmZGI4YzdhOWVjNTk5NTYwNmM5OGQxMmJlYzNmYWQ4ZTcyNWE2ZDZlOTRj
-    NTA0MTJmYmQyZDA5MjVhNGJmYmE2YzZhNjZlZDE4MGRjY2U2YjA5ZTEyMGYw
-    OTc5ZDJjYmJhMjQ0NTRjMjNmMDM3Y2E0MWQyZmFjODY1ODUwM2Y=
+    NGUxNWIzNmE4MjlkMWQ1OTVhOTY2YTU3Y2VkMWZkYzZiMjFmZjk5Yzc1M2Qx
+    ZmRkZjU5YjA3MjNjYTQ3ZTFiMmEzYzkwOWRiYTc3YzhjNmRiOGE1YWQyZDc0
+    NDY3MWZkOTUwZjkwNTgyODk4MDY5Y2U3YzAzNGM5N2UwZDY5NDM=
   data.tar.gz: !binary |-
-    OGYyMzY1OWU5NDMzNzlmNTk0Mjk2Yzg0YjAwZjIyYjY0MWU1MWFkZGE3ZWE2
-    MjhhNGM1MmZmZGFmZWE4NDU4ZTc0MDk1MTBkYzlmNGIyMGU1MTliZTc1ZTBh
-    NTk4NjE3NmVhY2Y1ZjY5Mzg3MGM2OWNhMDQzYzI4YzE4YjA2OGQ=
+    ZjE4OWI0YzNjZTliMTc2NzAwN2Y4N2JmOGQ4ZGNmYjA2OTJhMWJkMGNlZWU5
+    OTYxNjVhYTE5ZThjYjJhYWVmNjlmMWI1ZWQ3Yjg5ZWM5ZmQ0MGFkOTQ4ZTA1
+    YjE0NDlkOTdiYmY2MzhhNTYwZDRjMTZhZjU4MjZmYTJiYmYwOTY=

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## Version 1.2.16
+
+  * Osm::Section gains instance methods:
+    * bronze?
+    * silver?
+    * gold?
+    * gold_plus?
+    * subscription_at_least?(level)
+  * Osm::SUBSCRIPTION_LEVEL_NAMES is now a Hash not an Array
+
 ## Version 1.2.15
 
   * Add support for census and giftaid link generation for members

data/lib/osm.rb

@@ -36,7 +36,18 @@ module Osm
   OSM_TIME_REGEX = /\A(?:[0-1][0-9]|2[0-3]):[0-5][0-9]\Z/
   OSM_DATE_REGEX_UNANCHORED = /(?:[1-9]\d{3}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1]))|(?:(?:0?[1-9]|[1-2][0-9]|3[0-1])\/(?:0?[1-9]|1[0-2])\/(?:\d{2}|[1-9]\d{3}))/
   OSM_DATE_REGEX = /\A#{Osm::OSM_DATE_REGEX_UNANCHORED.to_s}\Z/
-  SUBSCRIPTION_LEVEL_NAMES = ['Unknown', 'Bronze', 'Silver', 'Gold', 'Gold+']
+  subscription_level_names = {
+    1 => 'Bronze',
+    :bronze => 'Bronze',
+    2 => 'Silver',
+    :silver => 'Silver',
+    3 => 'Gold',
+    :gold => 'Gold',
+    4 => 'Gold+',
+    :gold_plus => 'Gold+',
+  }
+  subscription_level_names.default = 'Unknown'
+  SUBSCRIPTION_LEVEL_NAMES = subscription_level_names
   SUBSCRIPTION_LEVELS = [nil, :bronze, :silver, :gold, :gold_plus]
 end
 

data/lib/osm/model.rb

@@ -209,23 +209,8 @@ module Osm
     # @raise [Osm::Forbidden] If the Section does not have the required OSM Subscription (or higher)
     def self.require_subscription(api, level, section, options={})
       section = Osm::Section.get(api, section, options) unless section.is_a?(Osm::Section)
-      if level.is_a?(Symbol) # Convert to Fixnum
-        case level
-        when :bronze
-          level = 1
-        when :silver
-          level = 2
-        when :gold
-          level = 3
-        when :gold_plus
-          level = 4
-        else
-          level = 0
-        end
-      end
-      if section.nil? || section.subscription_level < level
-        level_name = Osm::SUBSCRIPTION_LEVEL_NAMES[level] || level
-        raise Osm::Forbidden, "Insufficent OSM subscription level (#{level_name} required for #{section.name})."
+      if section.nil? || !section.subscription_at_least?(level)
+        raise Osm::Forbidden, "Insufficent OSM subscription level (#{Osm::SUBSCRIPTION_LEVEL_NAMES[level]} required for #{section.name})."
       end
     end
 

data/lib/osm/section.rb

@@ -376,6 +376,47 @@ module Osm
       Osm::SUBSCRIPTION_LEVEL_NAMES[subscription_level]
     end
 
+    # Check if the section has a subscription of a given level (or higher)
+    # @param level [Fixnum, Symbol] the subscription level required
+    # @return [Boolean] Whether the section has a subscription of level (or higher)
+    def subscription_at_least?(level)
+      if level.is_a?(Symbol) # Convert to Fixnum
+        case level
+        when :bronze
+          level = 1
+        when :silver
+          level = 2
+        when :gold
+          level = 3
+        when :gold_plus
+          level = 4
+        else
+          level = 0
+        end
+      end
+
+      return subscription_level >= level
+    end
+
+    # @!method bronze?
+    #   Check if this has a Bronze level subscription
+    #   @return (Boolean)
+    # @!method silver?
+    #   Check if this has a Silver level subscription
+    #   @return (Boolean)
+    # @!method gold?
+    #   Check if this has a Gold level subscription
+    #   @return (Boolean)
+    # @!method gold_plus?
+    #   Check if this has a Gold+ level subscription
+    #   @return (Boolean)
+    Osm::SUBSCRIPTION_LEVELS[1..-1].each_with_index do |attribute, index|
+      define_method "#{attribute}?" do
+        subscription_level == (index + 1)
+      end
+    end
+
+
     # Compare Section based on group_name type (age order), then name
     def <=>(another)
       result = self.group_name <=> another.try(:group_name)

data/spec/osm/section_spec.rb

@@ -295,6 +295,114 @@ describe "Section" do
     end
   end
 
+  describe "Corretly works out the subscription level" do
+
+    it "Bronze" do
+      section = Osm::Section.new(subscription_level: 1)
+      section.bronze?.should == true
+      section.silver?.should == false
+      section.gold?.should == false
+      section.gold_plus?.should == false
+    end
+
+    it "Silver" do
+      section = Osm::Section.new(subscription_level: 2)
+      section.bronze?.should == false
+      section.silver?.should == true
+      section.gold?.should == false
+      section.gold_plus?.should == false
+    end
+
+    it "Gold" do
+      section = Osm::Section.new(subscription_level: 3)
+      section.bronze?.should == false
+      section.silver?.should == false
+      section.gold?.should == true
+      section.gold_plus?.should == false
+    end
+
+    it "Gold+" do
+      section = Osm::Section.new(subscription_level: 4)
+      section.bronze?.should == false
+      section.silver?.should == false
+      section.gold?.should == false
+      section.gold_plus?.should == true
+    end
+
+    it "Unknown" do
+      section = Osm::Section.new(subscription_level: 0)
+      section.bronze?.should == false
+      section.silver?.should == false
+      section.gold?.should == false
+      section.gold_plus?.should == false
+    end
+
+  end # describe
+
+  describe "Correctly works out if a section has a subscription of at least" do
+
+    it "Bronze" do
+      section = Osm::Section.new(subscription_level: 1)
+      section.subscription_at_least?(:bronze).should == true
+      section.subscription_at_least?(:silver).should == false
+      section.subscription_at_least?(:gold).should == false
+      section.subscription_at_least?(:gold_plus).should == false
+      section.subscription_at_least?(1).should == true
+      section.subscription_at_least?(2).should == false
+      section.subscription_at_least?(3).should == false
+      section.subscription_at_least?(4).should == false
+    end
+
+    it "Silver" do
+      section = Osm::Section.new(subscription_level: 2)
+      section.subscription_at_least?(:bronze).should == true
+      section.subscription_at_least?(:silver).should == true
+      section.subscription_at_least?(:gold).should == false
+      section.subscription_at_least?(:gold_plus).should == false
+      section.subscription_at_least?(1).should == true
+      section.subscription_at_least?(2).should == true
+      section.subscription_at_least?(3).should == false 
+      section.subscription_at_least?(4).should == false 
+    end
+
+    it "Gold" do
+      section = Osm::Section.new(subscription_level: 3)
+      section.subscription_at_least?(:bronze).should == true
+      section.subscription_at_least?(:silver).should == true
+      section.subscription_at_least?(:gold).should == true
+      section.subscription_at_least?(:gold_plus).should == false
+      section.subscription_at_least?(1).should == true
+      section.subscription_at_least?(2).should == true
+      section.subscription_at_least?(3).should == true 
+      section.subscription_at_least?(4).should == false 
+    end
+
+    it "Gold+" do
+      section = Osm::Section.new(subscription_level: 4)
+      section.subscription_at_least?(:bronze).should == true
+      section.subscription_at_least?(:silver).should == true
+      section.subscription_at_least?(:gold).should == true
+      section.subscription_at_least?(:gold_plus).should == true
+      section.subscription_at_least?(1).should == true
+      section.subscription_at_least?(2).should == true
+      section.subscription_at_least?(3).should == true 
+      section.subscription_at_least?(4).should == true 
+    end
+
+    it "Unknown" do
+      section = Osm::Section.new(subscription_level: 0)
+      section.subscription_at_least?(:bronze).should == false
+      section.subscription_at_least?(:silver).should == false
+      section.subscription_at_least?(:gold).should == false
+      section.subscription_at_least?(:gold_plus).should == false
+      section.subscription_at_least?(1).should == false
+      section.subscription_at_least?(2).should == false
+      section.subscription_at_least?(3).should == false 
+      section.subscription_at_least?(4).should == false 
+    end
+
+  end # describe
+
 end
 
 

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "1.2.15"
+  VERSION = "1.2.16"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 1.2.15
+  version: 1.2.16
 platform: ruby
 authors:
 - Robert Gauld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport