the-city-admin 0.7.0 → 0.7.1

data/lib/api/group_checkin_events_list.rb

@@ -0,0 +1,64 @@
+module TheCity
+
+  class GroupCheckinEventsList < ApiList
+
+    include Enumerable
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    #
+    # Options:
+    #   :group_id - The ID of the group to load the checkin events for. (required)
+    #   :page - The page number to get.
+    #   :target_date - Date to pull checkin events for. Defaults to nearest checkin date
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   GroupCheckinEventsList.new({:group_id => 12345})
+    #
+    #   GroupCheckinEventsList.new({:group_id => 12345, :page => 2})
+    #
+    def initialize(options = {})
+      @options = options
+      @options[:reader] = TheCity::GroupCheckinEventsListReader.new(@options) if @options[:reader].nil?
+      @json_data = @options[:reader].load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']
+      @target_date = @json_data['target_date']
+    end
+
+
+    # Get the specified note.
+    #
+    # @param index The index of the checkin event to get.
+    #
+    # @return [GroupCheckinEvent]
+    def [](index)
+      GroupCheckinEvent.new( @json_data['checkin_events'][index] ) if @json_data['checkin_events'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['checkin_events'].each{ |checkin| yield( GroupCheckinEvent.new(checkin) )}
+    end
+
+
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['checkin_events'].empty?
+    end
+
+  end
+
+end

data/lib/api/group_checkin_list.rb

@@ -9,7 +9,7 @@ module TheCity
     # @param options A hash of options for loading the list.
     # 
     # Options:
-    #   :group_id - The ID of the group to load the addresses for. (required)
+    #   :group_id - The ID of the group to load the checkins for. (required)
     #   :page - The page number to get.
     #   :reader - The Reader to use to load the data.
     #
@@ -33,7 +33,7 @@ module TheCity
     
     # Get the specified note.
     #
-    # @param index The index of the note to get.
+    # @param index The index of the checkin to get.
     #
     # @return [GroupCheckin]
     def [](index)

data/lib/readers/api_reader.rb

@@ -16,6 +16,7 @@ module TheCity
       #   data = @cacher.get_data( @class_key )
       # else
         @url_data_params ||= {}
+        @url_data_params = stringify_array_params(@url_data_params)
         response = TheCity::admin_request(:get, @url_data_path, @url_data_params)
         data = JSON.parse(response.body)
         @headers = response.headers
@@ -29,7 +30,7 @@ module TheCity
     # x-city-ratelimit-limit-by-account header, whichever is lower.
     def rate_limit
       if @headers
-        [@headers['x-city-ratelimit-limit-by-ip'].to_i, @headers['x-city-ratelimit-limit-by-account'].to_i].min
+        [@headers['X-City-RateLimit-Limit-By-Ip'].to_i, @headers['X-City-RateLimit-Limit-By-Account'].to_i].min
       end
     end
 
@@ -37,10 +38,16 @@ module TheCity
     # x-city-ratelimit-remaining-by-account header, whichever is lower.
     def rate_limit_remaining
       if @headers
-        [@headers['x-city-ratelimit-remaining-by-ip'].to_i, @headers['x-city-ratelimit-remaining-by-account'].to_i].min
+        [@headers['X-City-RateLimit-Remaining-By-Ip'].to_i, @headers['X-City-RateLimit-Remaining-By-Account'].to_i].min
       end
     end
 
+    private
+
+    def stringify_array_params(options)
+      options.each_key {|k| options[k] = "#{options[k]}" if options[k].is_a? Array}
+    end
+
   end
 
 end

data/lib/readers/checkin_list_by_callboard_number_reader.rb

@@ -0,0 +1,27 @@
+module TheCity
+
+  class CheckinListByCallboardNumberReader < ApiReader
+
+    # Constructor.
+    #
+    # @param callboard_number The callboard number to filter by
+    # @param options A hash of options for requesting data from the server.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(callboard_number, options = {}, cacher = nil)
+      options[:page] ||= 1
+      #@class_key = "checkin_list_#{page}"
+      @url_data_path = "/checkins/by_callboard_number/#{URI.escape(callboard_number)}"
+      @url_data_params = white_list_options(options)
+
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?
+    end
+
+    def white_list_options(options)
+      white_list = [:page, :include_checked_out, :under_checkin_group_id]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
+  end
+
+end

data/lib/readers/checkin_list_by_pager_number_reader.rb

@@ -0,0 +1,27 @@
+module TheCity
+
+  class CheckinListByPagerNumberReader < ApiReader
+
+    # Constructor.
+    #
+    # @param pager_number The pager number to filter by
+    # @param options A hash of options for requesting data from the server.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(pager_number, options = {}, cacher = nil)
+      options[:page] ||= 1
+      #@class_key = "checkin_list_#{page}"
+      @url_data_path = "/checkins/by_pager_number/#{URI.escape(pager_number)}"
+      @url_data_params = white_list_options(options)
+
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?
+    end
+
+    def white_list_options(options)
+      white_list = [:page, :include_checked_out, :under_checkin_group_id]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
+  end
+
+end

data/lib/readers/checkin_list_reader.rb

@@ -6,9 +6,9 @@ module TheCity
     #
     # @param options A hash of options for requesting data from the server.
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
-    def initialize(options = {}, cacher = nil) 
+    def initialize(options = {}, cacher = nil)
       options[:page] ||= 1
-      #@class_key = "checkin_list_#{page}"   
+      #@class_key = "checkin_list_#{page}"
       @url_data_path = "/checkins"
       @url_data_params = white_list_options(options)
       

data/lib/readers/group_checkin_events_list_reader.rb

@@ -0,0 +1,28 @@
+module TheCity
+
+  class GroupCheckinEventsListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: group_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil)
+      options[:page] ||= 1
+      group_id = options.delete(:group_id)
+      #@class_key = "groups_#{group_id}_checkin_events"
+      @url_data_path = "/groups/#{group_id}/checkin_events"
+      @url_data_params = white_list_options(options)
+
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?
+    end
+
+    def white_list_options(options)
+      white_list = [:page, :target_date]
+      options.clone.delete_if { |key, value| !white_list.include?(key) }
+    end
+
+  end
+
+end

data/lib/readers/group_checkin_reader.rb

@@ -0,0 +1,32 @@
+module TheCity
+
+  class GroupCheckinReader < ApiReader
+
+    # Constructor.
+    #
+    # @param group_id The ID of the group to load.
+    # @param checkin_id The ID of the group_checkin to load.
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(group_id, checkin_id, by_id='id', cacher = nil)
+      #@class_key = "groups_#{group_id}_checkins_#{checkin_id}"
+      @url_data_path = case by_id
+         when 'id'
+           "/groups/#{group_id}/checkins/#{checkin_id}"
+         when 'pager_number'
+           "/groups/#{group_id}/checkins/by_pager_number?pager_number=#{URI.escape(checkin_id)}"
+         when 'callboard_number'
+           "/groups/#{group_id}/checkins/by_callboard_number?callboard_number=#{URI.escape(checkin_id)}"
+         else
+           "/groups/#{group_id}/checkins/#{checkin_id}"
+      end
+      #@url_data_params = options
+
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?
+    end
+
+  end
+
+end
+
+

data/lib/readers/group_list_reader.rb

@@ -12,7 +12,6 @@ module TheCity
       #@class_key = "group_list_#{options[:page]}_{some_kind_of_md5_thing_here}"  
       @url_data_path = "/groups"
       @url_data_params = white_list_options(options)
-      
       # The object to store and load the cache.
       @cacher = cacher unless cacher.nil?    
     end

data/spec/api/checkin_list_by_callboard_number_spec.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'CheckinListByCallboardNumber' do
+
+  before do
+    #simulate_connection_to_server
+  end
+
+  after do
+
+  end
+
+  it 'should pass if group checkin list attribute is not specified' do
+    group_id = 123
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => [FactoryGirl.attributes_for(:group_checkin)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByCallboardNumber.new('12345')
+    checkin = checkin_list[0]
+    checkin.parent_group_name.should == "Ballard Childrens ministry"
+  end
+
+
+  it 'should pass if group checkin list is empty' do
+    group_id = 123
+    page = 2
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => []
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByCallboardNumber.new('12345')
+
+    checkin_list.empty?.should be_true
+  end
+
+
+  it 'should return a valid list of group checkins' do
+    group_id = 123
+    page = 2
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => [FactoryGirl.attributes_for(:group_checkin)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByCallboardNumber.new('12345')
+
+    checkin = checkin_list[0]
+    checkin.parent_group_name.should == "Ballard Childrens ministry"
+  end
+
+
+  it 'should iterate using *each* method' do
+    group_id = 123
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => [FactoryGirl.attributes_for(:group_checkin)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByCallboardNumber.new('12345')
+
+    checkins = []
+    checkin_list.each { |checkin| checkins << checkin.parent_group_name }
+    checkins.should == ["Ballard Childrens ministry"]
+  end
+
+
+  it 'should iterate using *collect* method' do
+    group_id = 123
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => [FactoryGirl.attributes_for(:group_checkin)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByCallboardNumber.new('12345')
+
+    checkins = checkin_list.collect { |checkin| checkin.parent_group_name }
+    checkins.should == ["Ballard Childrens ministry"]
+  end
+
+
+end
+
+

data/spec/api/checkin_list_by_pager_number_spec.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'CheckinListByPagerNumber' do
+
+  before do
+    #simulate_connection_to_server
+  end
+
+  after do
+
+  end
+
+  # it 'really gets a group checkin list by pager number' do
+  #   TheCity::AdminApi.connect('af504c86420116f135b886a83667b0246784ce41', '96f6257ac4bd57f4')
+  #   checkin_list = TheCity::CheckinListByPagerNumber.new('111', {:include_checked_out => true, :under_checkin_group_id => 49861013})
+  #   binding.pry
+  #   checkin_list.should_not be_nil
+  # end
+
+  it 'should pass if group checkin list attribute is not specified' do
+    group_id = 123
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => [FactoryGirl.attributes_for(:group_checkin)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByPagerNumber.new('111')
+    checkin = checkin_list[0]
+    checkin.parent_group_name.should == "Ballard Childrens ministry"
+  end
+
+
+  it 'should pass if group checkin list is empty' do
+    group_id = 123
+    page = 2
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => []
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByPagerNumber.new('111')
+
+    checkin_list.empty?.should be_true
+  end
+
+
+  it 'should return a valid list of group checkins' do
+    group_id = 123
+    page = 2
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => [FactoryGirl.attributes_for(:group_checkin)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByPagerNumber.new('111')
+
+    checkin = checkin_list[0]
+    checkin.parent_group_name.should == "Ballard Childrens ministry"
+  end
+
+
+  it 'should iterate using *each* method' do
+    group_id = 123
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => [FactoryGirl.attributes_for(:group_checkin)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByPagerNumber.new('111')
+
+    checkins = []
+    checkin_list.each { |checkin| checkins << checkin.parent_group_name }
+    checkins.should == ["Ballard Childrens ministry"]
+  end
+
+
+  it 'should iterate using *collect* method' do
+    group_id = 123
+    request_data = FactoryGirl.attributes_for(:checkin_list, {
+        :total_entries => 1,
+        :total_pages => 1,
+        :checkins => [FactoryGirl.attributes_for(:group_checkin)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    checkin_list = TheCity::CheckinListByPagerNumber.new('111')
+
+    checkins = checkin_list.collect { |checkin| checkin.parent_group_name }
+    checkins.should == ["Ballard Childrens ministry"]
+  end
+
+
+end
+
+