stbaldricks 1.5.1.pre

data/lib/stbaldricks/entities/event/sub_type.rb

@@ -0,0 +1,16 @@
+require 'stbaldricks/entities/lib/top_level'
+
+module SBF
+  module Client
+    class Event < SBF::Client::TopLevelEntity
+      module SubType
+        NONE = 'none'
+        VIRTUAL = 'virtual'
+        CAMPUS = 'campus'
+        COMMUNITY = 'community'
+        CORPORATE = 'corporate'
+        SCHOOL = 'school'
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/event/type.rb

@@ -0,0 +1,12 @@
+require 'stbaldricks/entities/lib/top_level'
+
+module SBF
+  module Client
+    class Event < SBF::Client::TopLevelEntity
+      module Type
+        HEAD_SHAVING = 'head-shaving'
+        OTHER = 'other'
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/event_application.rb

@@ -0,0 +1,135 @@
+require 'stbaldricks/endpoints/event_application'
+require 'stbaldricks/entities/fund'
+require 'stbaldricks/entities/campaign'
+require 'stbaldricks/entities/event'
+require 'stbaldricks/entities/team'
+require 'stbaldricks/entities/participant'
+require 'stbaldricks/entities/fundraiser'
+require 'stbaldricks/entities/lib/address'
+require 'stbaldricks/entities/lib/base'
+require 'stbaldricks/entities/lib/top_level'
+require 'stbaldricks/entities/lib/name'
+
+module SBF
+  module Client
+    class EventApplication < SBF::Client::TopLevelEntity
+      endpoint SBF::Client::EventApplicationEndpoint
+      actions DEFAULT_CRUD_ACTIONS
+      blacklist_action :delete
+
+      class FullParticipant < SBF::Client::FullParticipant
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::EventApplication::ModelType::PARTICIPANT
+        end
+      end
+
+      class PartialParticipant < SBF::Client::PartialParticipant
+        attr_reader :model_type
+        attr_accessor :year
+
+        def model_type
+          SBF::Client::EventApplication::ModelType::PARTICIPANT
+        end
+      end
+
+      class FullFundraiser < SBF::Client::FullFundraiser
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::EventApplication::ModelType::FUNDRAISER
+        end
+      end
+
+      class PartialFundraiser < SBF::Client::PartialFundraiser
+        attr_reader :model_type
+        attr_accessor :year
+
+        def model_type
+          SBF::Client::EventApplication::ModelType::FUNDRAISER
+        end
+      end
+
+      class FullTeam < SBF::Client::FullTeam
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::EventApplication::ModelType::TEAM
+        end
+      end
+
+      class PartialTeam < SBF::Client::PartialTeam
+        attr_reader :model_type
+        attr_accessor :year
+
+        def model_type
+          SBF::Client::EventApplication::ModelType::TEAM
+        end
+      end
+
+      class FullEvent < SBF::Client::FullEvent
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::EventApplication::ModelType::EVENT
+        end
+      end
+
+      class PartialEvent < SBF::Client::PartialEvent
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::EventApplication::ModelType::EVENT
+        end
+      end
+
+      class Requestor < SBF::Client::BaseEntity
+        attr_accessor :name
+        entity_attr_accessor :name_pieces, 'SBF::Client::NamePieces'
+        entity_attr_accessor :email_address, 'SBF::Client::EmailAddress'
+        entity_attr_accessor :phone, 'SBF::Client::Phone'
+        entity_attr_accessor :address, 'SBF::Client::Address'
+      end
+
+      attr_accessor :id
+      attr_accessor :requested_event_title
+      attr_accessor :status
+      attr_accessor :is_archived
+      attr_accessor :no_conversion_reason
+      attr_accessor :promotional_code
+      attr_accessor :created_at, :modified_at
+      entity_attr_accessor :requestor, 'SBF::Client::EventApplication::Requestor'
+      entity_attr_accessor :qualifier, 'SBF::Client::FullPerson', 'SBF::Client::PartialPerson', true
+      entity_attr_accessor :fund, 'SBF::Client::FullFund', 'SBF::Client::PartialFund', true
+      entity_attr_accessor :campaign, 'SBF::Client::FullCampaign', 'SBF::Client::PartialCampaign', true
+
+      multitype_attr_accessor(
+        :model,
+        [
+          [
+            ->(v) { v[:model_type] == SBF::Client::EventApplication::ModelType::PARTICIPANT },
+            'SBF::Client::EventApplication::FullParticipant',
+            'SBF::Client::EventApplication::PartialParticipant'
+          ],
+          [
+            ->(v) { v[:model_type] == SBF::Client::EventApplication::ModelType::FUNDRAISER },
+            'SBF::Client::EventApplication::FullFundraiser',
+            'SBF::Client::EventApplication::PartialFundraiser'
+          ],
+          [
+            ->(v) { v[:model_type] == SBF::Client::EventApplication::ModelType::TEAM },
+            'SBF::Client::EventApplication::FullTeam',
+            'SBF::Client::EventApplication::PartialTeam'
+          ],
+          [
+            ->(v) { v[:model_type] == SBF::Client::EventApplication::ModelType::EVENT },
+            'SBF::Client::EventApplication::FullEvent',
+            'SBF::Client::EventApplication::PartialEvent'
+          ]
+        ],
+        optional: true
+      )
+    end
+  end
+end

data/lib/stbaldricks/entities/event_application/model_type.rb

@@ -0,0 +1,15 @@
+require 'stbaldricks/entities/lib/top_level'
+
+module SBF
+  module Client
+    class EventApplication < SBF::Client::TopLevelEntity
+      module ModelType
+        EVENT = 'event'
+        TEAM = 'team'
+        PARTICIPANT = 'participant'
+        FUNDRAISER = 'fundraiser'
+        MEMORIAL = 'memorial'
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/event_application/status.rb

@@ -0,0 +1,23 @@
+require 'stbaldricks/entities/lib/top_level'
+
+module SBF
+  module Client
+    class EventApplication < SBF::Client::TopLevelEntity
+      module Status
+        NEW = 'new'
+        REACHED_OUT = 'reached_out'
+        CREATED_EVENT = 'created_event'
+        CREATED_PARTICIPANT = 'created_participant'
+        CREATED_TEAM = 'created_team'
+        CREATED_FUNDRAISER = 'created_fundraiser'
+        NO_CONVERSION = 'no_conversion'
+        CONNECTED = 'connected'
+        DUPLICATE = 'duplicate'
+        CREATED_DONOR = 'created_donor'
+        NEXT_YEAR = 'next_year'
+        FINALIZING = 'finalizing'
+        CREATED_MEMORIAL = 'created_memorial'
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/event_donation_summary.rb

@@ -0,0 +1,18 @@
+require 'stbaldricks/entities/lib/top_level'
+
+module SBF
+  module Client
+    class EventDonationSummary < SBF::Client::TopLevelEntity
+      actions DEFAULT_CRUD_ACTIONS
+      blacklist_action :get
+      blacklist_action :create
+      blacklist_action :update
+      blacklist_action :delete
+
+      attr_accessor :amount_raised
+      attr_accessor :donations
+      attr_accessor :direct_amount_raised
+      attr_accessor :direct_donations
+    end
+  end
+end

data/lib/stbaldricks/entities/event_participant_summary.rb

@@ -0,0 +1,17 @@
+require 'stbaldricks/entities/lib/top_level'
+
+module SBF
+  module Client
+    class EventParticipantSummary < SBF::Client::TopLevelEntity
+      actions DEFAULT_CRUD_ACTIONS
+      blacklist_action :get
+      blacklist_action :create
+      blacklist_action :update
+      blacklist_action :delete
+
+      attr_accessor :shavees
+      attr_accessor :non_shavees
+      attr_accessor :participants
+    end
+  end
+end

data/lib/stbaldricks/entities/event_supporter.rb

@@ -0,0 +1,24 @@
+require 'stbaldricks/entities/lib/top_level'
+require 'stbaldricks/entities/event'
+require 'htmlentities'
+
+module SBF
+  module Client
+    class EventSupporter < SBF::Client::TopLevelEntity
+      actions DEFAULT_CRUD_ACTIONS
+
+      disallow_instantiation
+      attr_accessor :id, :sort_order
+    end
+
+    class PartialEventSupporter < EventSupporter
+    end
+
+    class FullEventSupporter < EventSupporter
+      attr_accessor :photo_url
+      attr_accessor :name, :url
+      entity_attr_accessor :event, 'SBF::Client::FullEvent', 'SBF::Client::PartialEvent', true
+      entity_attr_accessor :photo, 'SBF::Client::Photo'
+    end
+  end
+end

data/lib/stbaldricks/entities/fund.rb

@@ -0,0 +1,98 @@
+require 'stbaldricks/entities/fund'
+require 'stbaldricks/entities/lib/top_level'
+require 'stbaldricks/entities/lib/fundraising_page'
+require 'stbaldricks/endpoints/fund'
+require 'htmlentities'
+
+module SBF
+  module Client
+    class Fund < SBF::Client::TopLevelEntity
+      endpoint SBF::Client::FundEndpoint
+      action :allowed_entities
+      action :get
+      action :find
+      action :find_first
+      action :update
+
+      disallow_instantiation
+
+      class Photos < SBF::Client::BaseEntity
+        attr_reader :avatar, :default
+      end
+
+      class YearlyTotals < SBF::Client::BaseEntity
+        attr_reader :year
+        attr_reader :fundraisers
+        attr_reader :participants
+        attr_reader :shavees
+        attr_reader :non_shavees
+        attr_reader :teams
+        attr_reader :events
+        attr_reader :amount_raised
+
+        def to_hash
+          {}.tap do |hsh|
+            self.class.attributes.each { |name| hsh[name] = send(name.to_sym) unless name.to_sym == :year }
+          end
+        end
+      end
+
+      class Totals < SBF::Client::BaseEntity
+        attr_reader :fundraisers
+        attr_reader :participants
+        attr_reader :shavees
+        attr_reader :non_shavees
+        attr_reader :teams
+        attr_reader :events
+        attr_reader :amount_raised
+      end
+
+      class Photos < SBF::Client::BaseEntity
+        attr_reader :avatar, :default
+      end
+    end
+
+    class PartialFund < Fund
+      attr_accessor :id
+    end
+
+    class FullFund < Fund
+      attr_accessor :id
+      attr_reader :display_name
+      attr_accessor :name
+      attr_accessor :disabled
+      attr_accessor :description
+      entity_attr_accessor :photos, 'SBF::Client::Fund::Photos'
+      entity_attr_reader :totals, 'SBF::Client::Fund::Totals'
+      entity_collection_attr_accessor :totals_by_year, 'SBF::Client::Fund::Total'
+      entity_attr_accessor :fundraising_page, 'SBF::Client::FundraisingPage', nil, true
+      entity_attr_accessor :photos, 'SBF::Client::Fund::Photos'
+      attr_accessor :kid_name
+      attr_accessor :offline_donation_uuid, :offline_donation_form
+
+      def display_name
+        HTMLEntities.new.decode(@display_name)
+      end
+
+      def totals_by_year=(value)
+        return [] if value.nil? || value.empty?
+
+        @totals_by_year = value.map { |k, v|
+          SBF::Client::Fund::YearlyTotals.new(v.merge(year: k.to_s.to_i))
+        }
+      end
+
+      def to_hash
+        hsh = super.to_hash
+        return hsh if @totals_by_year.nil?
+
+        hsh[:totals_by_year] = {}
+        @totals_by_year.each do |year_total|
+          hsh[:totals_by_year][year_total.year.to_s.to_sym] = year_total.to_hash
+        end
+
+        hsh
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/fundraiser.rb

@@ -0,0 +1,124 @@
+require 'stbaldricks/entities/lib/top_level'
+require 'stbaldricks/entities/person'
+require 'stbaldricks/entities/fund'
+require 'stbaldricks/entities/event'
+require 'stbaldricks/entities/team'
+require 'stbaldricks/entities/lib/fundraising_page'
+require 'stbaldricks/entities/lib/venue'
+require 'stbaldricks/entities/lib/permissions'
+require 'htmlentities'
+require 'stbaldricks/entities/lib/default_cacheable'
+
+module SBF
+  module Client
+    class Fundraiser < SBF::Client::TopLevelEntity
+      include Entities::DefaultCacheable
+      actions DEFAULT_CRUD_ACTIONS
+
+      disallow_instantiation
+
+      module Status
+        ACTIVE = 'active'
+        PENDING = 'pending'
+      end
+
+      module HowCreated
+        WEBSITE = 'website'
+        ADMIN_CONTROL_PANEL = 'admin_control_panel'
+        ADMIN_IMPORT = 'admin_import'
+        LEGACY = 'legacy'
+        MOBILE = 'mobile'
+      end
+
+      module FundRelationshipType
+        NO_ASSOCIATION = 'no_association'
+        INDIRECT_ONE = 'indirect_one'
+        INDIRECT_MULTIPLE = 'indirect_multiple'
+        DIRECT = 'direct'
+        DIRECT_BUT_LOCKED = 'direct_but_locked'
+        INHERITED_TEAM = 'inherited_team'
+        INHERITED_EVENT = 'inherited_event'
+        INHERITED_TEAMS_EVENT = 'inherited_teams_event'
+        INHERITED_BOTH_TEAM_AND_EVENT = 'inherited_both_team_and_event'
+      end
+
+      class Photos < SBF::Client::BaseEntity
+        attr_reader :avatar, :default
+      end
+
+      class Policies < SBF::Client::BaseEntity
+        attr_accessor :is_waiver_policy_accepted
+      end
+
+      class Totals < SBF::Client::BaseEntity
+        attr_reader :amount_raised
+        attr_reader :donations
+      end
+
+      class Rankings < SBF::Client::BaseEntity
+        class Ranking < SBF::Client::BaseEntity
+          attr_reader :rank, :total
+        end
+
+        entity_attr_reader :team, 'SBF::Client::Fundraiser::Rankings::Ranking'
+        entity_attr_reader :event, 'SBF::Client::Fundraiser::Rankings::Ranking'
+      end
+
+      class Venue < SBF::Client::BaseEntity
+        entity_attr_accessor :location, 'SBF::Client::Fundraiser::Location'
+      end
+
+      class Location < SBF::Client::BaseEntity
+        attr_accessor :name
+        entity_attr_accessor :address, 'SBF::Client::Address'
+
+        def name
+          HTMLEntities.new.decode(@name)
+        end
+      end
+    end
+
+    class PartialFundraiser < Fundraiser
+      attr_accessor :id
+    end
+
+    class FullFundraiser < Fundraiser
+      attr_accessor :id
+      attr_accessor :status
+      attr_accessor :title
+      attr_accessor :display_name_override
+      attr_reader :display_name
+      entity_attr_accessor :owner, 'SBF::Client::FullPerson'
+      attr_accessor :start_date, :end_date
+      attr_accessor :start_time, :end_time
+      attr_accessor :offline_donation_uuid, :offline_donation_form
+      attr_accessor :fundraising_goal, :fundraising_message
+      entity_attr_accessor :fundraising_page, 'SBF::Client::FundraisingPage', nil, true
+      entity_attr_accessor :event, 'SBF::Client::FullEvent', 'SBF::Client::PartialEvent', true
+      entity_attr_accessor :team, 'SBF::Client::FullTeam', 'SBF::Client::PartialTeam', true
+      entity_attr_accessor :fund, 'SBF::Client::FullFund', 'SBF::Client::PartialFund', true
+      attr_accessor :fund_relationship_type
+      entity_attr_accessor :venue, 'SBF::Client::Fundraiser::Venue'
+      entity_attr_accessor :photos, 'SBF::Client::Fundraiser::Photos'
+      entity_attr_accessor :policies, 'SBF::Client::Fundraiser::Policies'
+      entity_attr_reader :rankings, 'SBF::Client::Fundraiser::Rankings', nil, true
+      entity_attr_reader :totals, 'SBF::Client::Fundraiser::Totals'
+      attr_reader :created_at, :modified_at
+      attr_accessor :modified_by
+      attr_accessor :how_created
+      entity_attr_reader :permissions, 'SBF::Client::Permissions', nil, true
+
+      def active?
+        status == SBF::Client::Fundraiser::Status::ACTIVE
+      end
+
+      def display_name
+        HTMLEntities.new.decode(@display_name)
+      end
+
+      def title
+        HTMLEntities.new.decode(@title)
+      end
+    end
+  end
+end