osm 0.1.2 → 0.1.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 0.1.3
+
+  * Add get\_badge\_stock(api) to section
+
 ## Version 0.1.2
 
   * Bug fixes

data/lib/osm/section.rb

@@ -184,6 +184,7 @@ module Osm
       return all_permissions
     end
 
+
     # Get the section's notepads
     # @param [Osm::Api] The api to use to make the request
     # @!macro options_get
@@ -207,6 +208,28 @@ module Osm
       return notepad
     end
 
+    # Get badge stock levels
+    # @param [Osm::Api] The api to use to make the request
+    # @param [Osm::Term, Fixnum, nil] section the term (or its ID) to get the stock levels for, passing nil causes the current term to be used
+    # @!macro options_get
+    # @return Hash
+    def get_badge_stock(api, term=nil, options={})
+      term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, self).id : term.to_i
+      cache_key = ['badge_stock', id, term_id]
+
+      if !options[:no_cache] && self.class.cache_exist?(api, cache_key) && self.class.get_user_permissions(api, self)[:badge].include?(:read)
+        return self.class.cache_read(api, cache_key)
+      end
+
+      data = api.perform_query("challenges.php?action=getInitialBadges&type=core&sectionid=#{id}&section=#{type}&termid=#{term_id}")
+      data = (data['stock'] || {}).select{ |k,v| !k.eql?('sectionid') }.
+                                   inject({}){ |new_hash,(badge, level)| new_hash[badge] = level.to_i; new_hash }
+
+      self.class.cache_write(api, cache_key, data)
+      return data
+    end
+
+
     # Check if this section is one of the youth sections
     # @return [Boolean]
     def youth_section?

data/spec/osm/model_spec.rb

@@ -41,7 +41,7 @@ describe "Model" do
     Osm::Model.configure({})
     config = ModelTester.test_get_config
     config[:cache].should be_nil
-    config[:ttl].should == 1800
+    config[:ttl].should == 600
     config[:prepend_to_key].should == 'OSMAPI'
   end
 
@@ -63,7 +63,7 @@ describe "Model" do
     end
 
     it "Writes" do
-      OsmTest::Cache.should_receive('write').with('OSMAPI-osm-key', 'data', {:expires_in=>1800}) { true }
+      OsmTest::Cache.should_receive('write').with('OSMAPI-osm-key', 'data', {:expires_in=>600}) { true }
       ModelTester.cache('write', @api, 'key', 'data').should be_true
     end
 
@@ -123,7 +123,7 @@ describe "Model" do
 
     it "All Sections" do
       permissions = {1 => {:a => [:read, :write]}, 2 => {:a => [:read]}}
-      OsmTest::Cache.should_receive('write').with('OSMAPI-osm-permissions-user_id', permissions, {:expires_in=>1800}) { true }
+      OsmTest::Cache.should_receive('write').with('OSMAPI-osm-permissions-user_id', permissions, {:expires_in=>600}) { true }
       ModelTester.set_user_permissions(@api, permissions)
     end
 
@@ -131,10 +131,10 @@ describe "Model" do
       permissions = {1 => {:a => [:read, :write]}, 2 => {:a => [:read]}}
       OsmTest::Cache.should_receive('exist?').with('OSMAPI-osm-permissions-user_id') { true }
       OsmTest::Cache.should_receive('read').with('OSMAPI-osm-permissions-user_id') { permissions }
-      OsmTest::Cache.should_receive('write').with('OSMAPI-osm-permissions-user_id', permissions.merge(3 => {:a => [:read]}), {:expires_in=>1800}) { true }
+      OsmTest::Cache.should_receive('write').with('OSMAPI-osm-permissions-user_id', permissions.merge(3 => {:a => [:read]}), {:expires_in=>600}) { true }
       ModelTester.set_user_permissions(@api, 3, {:a => [:read]})
     end
 
   end
 
-end
+end

data/spec/osm/section_spec.rb

@@ -122,6 +122,21 @@ describe "Section" do
       section.get_notepad(@api).should == 'Section 1'
     end
 
+    it "Fetch badge stock levels" do
+      badges_body = {
+        'stock' => {
+          'sectionid' => '1',
+          'badge_1' => '1',
+          'badge_2' => '2'
+        }
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=getInitialBadges&type=core&sectionid=1&section=beavers&termid=2", :body => badges_body.to_json)
+
+      section = Osm::Section.get(@api, 1)
+      section.should_not be_nil
+      section.get_badge_stock(@api, 2).should == {'badge_1' => 1, 'badge_2' => 2}
+    end
+
   end
 
 

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-21 00:00:00.000000000Z
+date: 2012-10-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &83563540 !ruby/object:Gem::Requirement
+  requirement: &78033570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *83563540
+  version_requirements: *78033570
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &83563250 !ruby/object:Gem::Requirement
+  requirement: &78033180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *83563250
+  version_requirements: *78033180
 - !ruby/object:Gem::Dependency
   name: active_attr
-  requirement: &83562880 !ruby/object:Gem::Requirement
+  requirement: &78032730 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *83562880
+  version_requirements: *78032730
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &83561580 !ruby/object:Gem::Requirement
+  requirement: &78032450 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *83561580
+  version_requirements: *78032450
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &83561350 !ruby/object:Gem::Requirement
+  requirement: &78032090 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *83561350
+  version_requirements: *78032090
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &83561080 !ruby/object:Gem::Requirement
+  requirement: &78031770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *83561080
+  version_requirements: *78031770
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &83560720 !ruby/object:Gem::Requirement
+  requirement: &78031150 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *83560720
+  version_requirements: *78031150
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email:
@@ -149,12 +149,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -198994829
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -198994829
 requirements: []
 rubyforge_project: osm
 rubygems_version: 1.8.10
@@ -162,4 +168,3 @@ signing_key:
 specification_version: 3
 summary: Use the Online Scout Manager API
 test_files: []
-has_rdoc: