osm 0.2.2 → 0.3.0

data/spec/osm/badges_spec.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe "Badges" do
+
+
+  describe "Using the OSM API" do
+
+    it "Get due badges" do
+      data = {
+        'pending' => {
+          'badge_name' => [
+            {
+              'scoutid' => '1',
+              'firstname' => 'John',
+              'lastname' => 'Doe',
+              'level' => '',
+              'extra' => '',
+            }
+          ],
+          'staged_staged_participation' => [{
+              'sid' => '2',
+              'firstname' => 'Jane',
+              'lastname' => 'Doe',
+              'level' => '2',
+              'extra' => 'Lvl 2'
+            }, {
+              'sid' => '1',
+              'firstname' => 'John',
+              'lastname' => 'Doe',
+              'level' => '2',
+              'extra' => 'Lvl 2'
+            }
+          ]
+        },
+
+        'description' => {
+          'badge_name' => {
+            'name' => 'Badge Name',
+            'section' => 'cubs',
+            'type' => 'activity',
+            'badge' => 'badge_name'
+          },
+          'staged_staged_participation' => {
+            'name' => 'Participation',
+            'section' => 'staged',
+            'type' => 'staged',
+            'badge' => 'participation'
+          }
+        }
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=outstandingBadges&section=cubs&sectionid=1&termid=2", :body => data.to_json)
+
+      db = Osm::Badges.get_due_badges(@api, Osm::Section.new(:id => 1, :type => :cubs), 2)
+      db.empty?.should == false
+      db.descriptions.should == {'badge_name_1'=>'Badge Name', 'staged_staged_participation_2'=>'Participation (Level 2)'}
+      db.by_member.should == {'John Doe'=>['badge_name_1', 'staged_staged_participation_2'], 'Jane Doe'=>['staged_staged_participation_2']}
+      db.totals.should == {'staged_staged_participation_2'=>2, 'badge_name_1'=>1}
+      db.valid?.should be_true
+    end
+
+    it "handles an empty array representing no due badges" do
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=outstandingBadges&section=cubs&sectionid=1&termid=2", :body => '[]')
+      db = Osm::Badges.get_due_badges(@api, Osm::Section.new(:id => 1, :type => :cubs), 2)
+      db.should_not == nil
+    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)
+      Osm::Term.stub(:get_current_term_for_section) { Osm::Term.new(:id => 2) }
+
+      section = Osm::Section.new(:id => 1, :type => :beavers)
+      Osm::Badges.get_stock(@api, section).should == {'badge_1' => 1, 'badge_2' => 2}
+    end
+
+    describe "Update badge stock levels" do
+
+      it "Succeds" do
+        url = "https://www.onlinescoutmanager.co.uk/challenges.php?action=updateStock"
+        HTTParty.should_receive(:post).with(url, {:body => {
+          'apiid' => @CONFIGURATION[:api][:osm][:id],
+          'token' => @CONFIGURATION[:api][:osm][:token],
+          'userid' => 'user_id',
+          'secret' => 'secret',
+          'stock' => 10,
+          'table' => 'badge',
+          'sectionid' => 1,
+          'section' => :beavers,
+        }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"sectionid":"1","badge":"10"}'}) }
+
+        section = Osm::Section.new(:id => 1, :type => :beavers)
+        Osm::Badges.update_stock(@api, section, 'badge', 10).should be_true
+      end
+
+      it "Fails" do
+        HTTParty.stub(:post) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"sectionid":"1","badge":"1"}'}) }
+        section = Osm::Section.new(:id => 1, :type => :beavers)
+        Osm::Badges.update_stock(@api, section, 'badge', 10).should be_false
+      end
+
+    end
+
+  end
+
+end

data/spec/osm/flexi_record_spec.rb

@@ -441,8 +441,9 @@ describe "Flexi Record" do
         :flexi_record => fr,
         :member_id => 4,
         :grouping_id => 5,
-        :fields => {'f_1' => 'value'}
+        :fields => {'f_1' => '', 'f_2' => 'value'}
       )
+      fr_data.fields['f_1'] = 'value'
       fr_data.update(@api).should be_true
     end
 
@@ -463,8 +464,9 @@ describe "Flexi Record" do
         :flexi_record => fr,
         :member_id => 4,
         :grouping_id => 5,
-        :fields => {'f_1' => 'value'}
+        :fields => {'f_1' => 'old value'}
       )
+      fr_data.fields['f_1'] = 'new value'
       fr_data.update(@api).should be_false
     end
 

data/spec/osm/section_spec.rb

@@ -190,22 +190,6 @@ describe "Section" do
       section.set_notepad(@api, 'content').should be_false
     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.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000Z
+date: 2013-02-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &86025430 !ruby/object:Gem::Requirement
+  requirement: &86835090 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *86025430
+  version_requirements: *86835090
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &86024870 !ruby/object:Gem::Requirement
+  requirement: &86833800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *86024870
+  version_requirements: *86833800
 - !ruby/object:Gem::Dependency
   name: active_attr
-  requirement: &86006950 !ruby/object:Gem::Requirement
+  requirement: &86832220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *86006950
+  version_requirements: *86832220
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &86006710 !ruby/object:Gem::Requirement
+  requirement: &86819190 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,21 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *86006710
+  version_requirements: *86819190
+- !ruby/object:Gem::Dependency
+  name: dirty_hashy
+  requirement: &86818730 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *86818730
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &86006480 !ruby/object:Gem::Requirement
+  requirement: &86818240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +76,10 @@ dependencies:
         version: '10.0'
   type: :development
   prerelease: false
-  version_requirements: *86006480
+  version_requirements: *86818240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &86006220 !ruby/object:Gem::Requirement
+  requirement: &86817390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +87,10 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *86006220
+  version_requirements: *86817390
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &86005980 !ruby/object:Gem::Requirement
+  requirement: &86816770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +98,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *86005980
+  version_requirements: *86816770
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &86005750 !ruby/object:Gem::Requirement
+  requirement: &86816110 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,18 +109,18 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *86005750
+  version_requirements: *86816110
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &86005510 !ruby/object:Gem::Requirement
+  requirement: &86815330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *86005510
+  version_requirements: *86815330
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email:
@@ -133,7 +144,8 @@ files:
 - lib/osm/activity.rb
 - lib/osm/api.rb
 - lib/osm/api_access.rb
-- lib/osm/due_badges.rb
+- lib/osm/badge.rb
+- lib/osm/badges.rb
 - lib/osm/event.rb
 - lib/osm/flexi_record.rb
 - lib/osm/grouping.rb
@@ -147,7 +159,8 @@ files:
 - spec/osm/activity_spec.rb
 - spec/osm/api_access_spec.rb
 - spec/osm/api_spec.rb
-- spec/osm/due_badges_spec.rb
+- spec/osm/badge_spec.rb
+- spec/osm/badges_spec.rb
 - spec/osm/event_spec.rb
 - spec/osm/flexi_record_spec.rb
 - spec/osm/grouping_spec.rb

data/lib/osm/due_badges.rb

@@ -1,102 +0,0 @@
-module Osm
-
-  class DueBadges < Osm::Model
-
-    # @!attribute [rw] descriptions
-    #   @return [Hash] descriptions for each of the badges
-    # @!attribute [rw] by_member
-    #   @return [Hash] the due badges grouped by member
-
-    attribute :descriptions, :default => {}
-    attribute :by_member, :default => {}
-
-    attr_accessible :descriptions, :by_member
-
-    validates :descriptions, :hash => {:key_type => String, :value_type => String}
-
-    validates_each :by_member do |record, attr, value|
-      desc_keys = record.descriptions.keys
-      record.errors.add(attr, 'must be a Hash') unless value.is_a?(Hash)
-      value.each do |k, v|
-        record.errors.add(attr, 'keys must be String') unless k.is_a?(String)
-        record.errors.add(attr, 'values must be Arrays') unless v.is_a?(Array)
-        v.each do |vv|
-          record.errors.add(attr, 'internal values must be Strings') unless vv.is_a?(String)
-          record.errors.add(attr, 'internal values must exist as a key in :descriptions') unless desc_keys.include?(vv)
-        end
-      end
-    end
-
-
-    # Get due badges
-    # @param [Osm::Api] api The api to use to make the request
-    # @param [Osm::Section, Fixnum, #to_i] section The section (or its ID) to get the due badges for
-    # @param [Osm::Term, Fixnum, #to_i, nil] term The term (or its ID) to get the due badges for, passing nil causes the current term to be used
-    # @!macro options_get
-    # @return [Osm::DueBadges]
-    def self.get(api, section, term=nil, options={})
-      require_ability_to(api, :read, :badge, section, options)
-      section = Osm::Section.get(api, section, options) if section.is_a?(Fixnum)
-      term_id = (term.nil? ? Osm::Term.get_current_term_for_section(api, section, options) : term).to_i
-      cache_key = ['due_badges', section.id, term_id]
-
-      if !options[:no_cache] && cache_exist?(api, cache_key)
-        return cache_read(api, cache_key)
-      end
-
-      data = api.perform_query("challenges.php?action=outstandingBadges&section=#{section.type}&sectionid=#{section.id}&termid=#{term_id}")
-
-
-      data = {} unless data.is_a?(Hash) # OSM/OGM returns an empty array to represent no badges
-      pending_raw = data['pending'] || {}
-      descriptions_raw = data['description'] || {}
-
-      attributes = {
-        :by_member => {},
-        :descriptions => {}
-      }
-
-      pending_raw.each do |key, members|
-        members.each do |member|
-          name = "#{member['firstname']} #{member['lastname']}"
-          description = descriptions_raw[key]['name'] + (descriptions_raw[key]['section'].eql?('staged') ? " (Level #{member['level']})" : '')
-          description_key = key + (descriptions_raw[key]['section'].eql?('staged') ? "_#{member['level']}" : '_1')
-          attributes[:descriptions][description_key] = description
-          attributes[:by_member][name] ||= []
-          attributes[:by_member][name].push(description_key)
-        end
-      end
-
-      due_badges = Osm::DueBadges.new(attributes)
-      cache_write(api, cache_key, due_badges)
-      return due_badges
-    end
-
-
-    # @!method initialize
-    #   Initialize a new Term
-    #   @param [Hash] attributes The hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
-
-
-    # Check if there are no badges due
-    # @return [Boolean]
-    def empty?
-      return by_member.empty?
-    end
-
-    # Calculate the total number of badges needed
-    # @return [Hash] the total number of each badge which is due
-    def totals()
-      totals = {}
-      by_member.keys.each do |member_name|
-        by_member[member_name].each do |badge|
-          totals[badge] ||= 0
-          totals[badge] += 1
-        end
-      end
-      return totals
-    end
-
-  end # Class DueBadges
-
-end # Module

data/spec/osm/due_badges_spec.rb

@@ -1,65 +0,0 @@
-# encoding: utf-8
-require 'spec_helper'
-
-describe "DueBadge" do
-
-  it "Create from API data" do
-    data = {
-      'pending' => {
-        'badge_name' => [
-          {
-            'scoutid' => '1',
-            'firstname' => 'John',
-            'lastname' => 'Doe',
-            'level' => '',
-            'extra' => '',
-          }
-        ],
-        'staged_staged_participation' => [{
-            'sid' => '2',
-            'firstname' => 'Jane',
-            'lastname' => 'Doe',
-            'level' => '2',
-            'extra' => 'Lvl 2'
-          }, {
-            'sid' => '1',
-            'firstname' => 'John',
-            'lastname' => 'Doe',
-            'level' => '2',
-            'extra' => 'Lvl 2'
-          }
-        ]
-      },
-
-      'description' => {
-        'badge_name' => {
-          'name' => 'Badge Name',
-          'section' => 'cubs',
-          'type' => 'activity',
-          'badge' => 'badge_name'
-        },
-        'staged_staged_participation' => {
-          'name' => 'Participation',
-          'section' => 'staged',
-          'type' => 'staged',
-          'badge' => 'participation'
-        }
-      }
-    }
-    FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=outstandingBadges&section=cubs&sectionid=1&termid=2", :body => data.to_json)
-
-    db = Osm::DueBadges.get(@api, Osm::Section.new(:id => 1, :type => :cubs), 2)
-    db.empty?.should == false
-    db.descriptions.should == {'badge_name_1'=>'Badge Name', 'staged_staged_participation_2'=>'Participation (Level 2)'}
-    db.by_member.should == {'John Doe'=>['badge_name_1', 'staged_staged_participation_2'], 'Jane Doe'=>['staged_staged_participation_2']}
-    db.totals.should == {'staged_staged_participation_2'=>2, 'badge_name_1'=>1}
-    db.valid?.should be_true
-  end
-
-  it "handles an empty array representing no due badges" do
-    FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=outstandingBadges&section=cubs&sectionid=1&termid=2", :body => '[]')
-    db = Osm::DueBadges.get(@api, Osm::Section.new(:id => 1, :type => :cubs), 2)
-    db.should_not == nil
-  end
-
-end