stbaldricks 1.5.1.pre

data/lib/stbaldricks/entities/person.rb

@@ -0,0 +1,403 @@
+require 'stbaldricks/entities/lib/address'
+require 'stbaldricks/entities/lib/base'
+require 'stbaldricks/entities/lib/top_level'
+require 'stbaldricks/entities/lib/email_address'
+require 'stbaldricks/entities/lib/name'
+require 'stbaldricks/entities/lib/phone'
+require 'stbaldricks/enums/league_status'
+require 'stbaldricks/entities/lib/cacheable'
+require 'stbaldricks/entities/lib/opt_out_settings'
+
+module SBF
+  module Client
+    class Person < SBF::Client::TopLevelEntity
+      include Entities::Cacheable
+      disallow_instantiation
+
+      actions DEFAULT_CRUD_ACTIONS
+      blacklist_action :delete
+
+      cache_id -> { [id, type] }
+      cache_id_from_hash ->(h) { [h[:id], h[:type]] }
+
+      module Status
+        PENDING = 'pending' #1
+        ACTIVE = 'active' #2
+        DECEASED = 'deceased' #7 (may be deprecated: working on this with SBF)
+      end
+
+      module Type
+        INDIVIDUAL = 'individual'
+        BUSINESS = 'business'
+        FOUNDATION = 'foundation'
+
+        IDS = {
+          INDIVIDUAL => 1,
+          BUSINESS => 2,
+          FOUNDATION => 3
+        }
+        IDS.freeze
+
+        def self.to_s(type_id)
+          IDS.key(type_id)
+        end
+
+        def self.value_of(type)
+          IDS[type]
+        end
+      end
+
+      module Gender
+        NOT_SELECTED = 'not_selected'
+        CHOSE_NOT_TO_SPECIFY = 'chose_not_to_specify'
+        MALE = 'male'
+        FEMALE = 'female'
+      end
+
+      module HowCreated
+        WEBSITE = 'website'
+        ADMIN_IMPORT = 'admin_import'
+        ADMIN_CONTROL_PANEL = 'admin_control_panel'
+        SUBMIT_CASH = 'submit_cash'
+        MOBILE = 'mobile'
+        PARTICIPANT_REGISTRATION = 'participant_registration'
+        FUNDRAISER_REGISTRATION = 'fundraiser_registration'
+        FAST_REGISTRATION = 'fast_registration'
+        FAST_DONATION = 'fast_donation'
+        RECURRING_GIFTS = 'recurring'
+        GIVE_ONCE = 'give_once'
+        DONATE = 'donate'
+      end
+
+      class Addresses < SBF::Client::BaseEntity
+        entity_attr_accessor :primary, 'SBF::Client::Address'
+        entity_attr_accessor :secondary, 'SBF::Client::Address'
+      end
+
+      class PhoneNumbers < SBF::Client::BaseEntity
+        entity_attr_accessor :primary, 'SBF::Client::Phone'
+        entity_attr_accessor :secondary, 'SBF::Client::Phone'
+      end
+
+      class EmailAddresses < SBF::Client::BaseEntity
+        entity_attr_accessor :primary, 'SBF::Client::EmailAddress'
+        entity_attr_accessor :secondary, 'SBF::Client::EmailAddress'
+      end
+
+      class Policies < SBF::Client::BaseEntity
+        BACKGROUND_CHECK_YEARS_VALID = 3
+        attr_accessor :is_photo_policy_accepted
+        attr_accessor :background_check_date, :background_check_url
+
+        def background_check_valid_at_date?(check_date)
+          check_date = DateTime.parse(check_date) if check_date.is_a?(String)
+          check_date = DateTime.parse(check_date.to_s) if check_date.is_a?(Date)
+          check_date = DateTime.parse(check_date.strftime('%d/%m/%Y %H:%M:%S')) if check_date.is_a?(Time)
+          background_check_date && check_date.is_a?(DateTime) && background_check_date > check_date.prev_year(SBF::Client::Person::Policies::BACKGROUND_CHECK_YEARS_VALID)
+        end
+      end
+
+      class HowAffected < SBF::Client::BaseEntity
+        attr_accessor :cancer_type, :family_relationship, :cancer_status
+        attr_reader :is_child_survivor, :is_child_family, :is_child_friend, :is_adult_survivor, :is_adult_friend_or_family, :is_none
+
+        module CancerType
+          ACUTE_LYMPHOBLASTIC_LEUKEMIA = 'Acute lymphoblastic leukemia (ALL)'
+          ACUTE_MYELOID_LEUKEMIA = 'Acute myeloid leukemia (AML)'
+          BRAIN_OR_SPINAL_CORD_TUMOR = 'Brain or spinal cord tumor'
+          CLEAR_CELL_SARCOMA_OF_THE_KIDNEY = 'Clear cell sarcoma of the kidney'
+          EWING_SARCOMA = 'Ewing sarcoma'
+          GERM_CELL_TUMOR = 'Germ cell tumor'
+          HEPATOBLASTOMA = 'Hepatoblastoma'
+          HODGKIN_LYMPHOMA = 'Hodgkin lymphoma'
+          LYMPHOMA = 'Lymphoma'
+          NEUROBLASTOMA = 'Neuroblastoma'
+          NON_HODGKIN_LYMPHOMA = 'Non-Hodgkin lymphoma'
+          OSTEOSARCOMA = 'Osteosarcoma'
+          RETINOBLASTOMA = 'Retinoblastoma'
+          RHABDOMYOSARCOMA = 'Rhabdomyosarcoma'
+          WILMS_OR_OTHER_KIDNEY_TUMOR = 'Wilms or other kidney tumor'
+          ADULT_WITH_A_TYPE_OF_CHILDHOOD_CANCER = 'Adult with a type of childhood cancer'
+          OTHER_CHILDHOOD_CANCER = 'Other childhood cancer'
+          @list = {
+            ACUTE_LYMPHOBLASTIC_LEUKEMIA => 'acute_lymphoblastic_leukemia',
+            ACUTE_MYELOID_LEUKEMIA => 'acute_myeloid_leukemia',
+            BRAIN_OR_SPINAL_CORD_TUMOR => 'brain_or_spinal_cord_tumor',
+            CLEAR_CELL_SARCOMA_OF_THE_KIDNEY => 'kidney_sarcoma',
+            EWING_SARCOMA => 'ewing_sarcoma',
+            GERM_CELL_TUMOR => 'germ_cell_tumor',
+            HEPATOBLASTOMA => 'hepatoblastoma',
+            HODGKIN_LYMPHOMA => 'hodgkin_lymphoma',
+            LYMPHOMA => 'lymphoma',
+            NEUROBLASTOMA => 'neuroblastoma',
+            NON_HODGKIN_LYMPHOMA => 'non_hodgkin_lymphoma',
+            OSTEOSARCOMA => 'osteosarcoma',
+            RETINOBLASTOMA => 'retinoblastoma',
+            RHABDOMYOSARCOMA => 'rhabdomyosarcoma',
+            WILMS_OR_OTHER_KIDNEY_TUMOR => 'wilms_or_other_kidney_tumor',
+            ADULT_WITH_A_TYPE_OF_CHILDHOOD_CANCER => 'adult_with_childhood_cancer',
+            OTHER_CHILDHOOD_CANCER => 'other_childhood_cancer'
+          }.freeze
+
+          class << self
+            attr_reader :list
+          end
+        end
+
+        module FamilyRelationship
+          NONE = 'None'
+          MOTHER = 'Mother'
+          FATHER = 'Father'
+          SISTER = 'Sister'
+          BROTHER = 'Brother'
+          AUNT = 'Aunt'
+          UNCLE = 'Uncle'
+          GRANDMOTHER = 'Grandmother'
+          GRANDFATHER = 'Grandfather'
+          STEP_MOTHER = 'Step-Mother'
+          STEP_FATHER = 'Step-Father'
+          LEGAL_GUARDIAN = 'Legal-Guardian'
+          @list = {
+            NONE => 'none',
+            MOTHER => 'mother',
+            FATHER => 'father',
+            SISTER => 'sister',
+            BROTHER => 'brother',
+            AUNT => 'aunt',
+            UNCLE => 'uncle',
+            GRANDMOTHER => 'grandmother',
+            GRANDFATHER => 'grandfather',
+            STEP_MOTHER => 'step_mother',
+            STEP_FATHER => 'step_father',
+            LEGAL_GUARDIAN => 'legal_guardian'
+          }.freeze
+
+          class << self
+            attr_reader :list
+          end
+        end
+
+        module CancerStatus
+          CANCER_FREE = 'Cancer free'
+          IN_REMISSION = 'In remission'
+          IN_TREATMENT = 'In treatment'
+          IN_MAINTENANCE = 'In maintenance'
+          LOST_TO_CANCER = 'Lost to cancer'
+          @list = {
+            CANCER_FREE => 'cancer_free',
+            IN_REMISSION => 'in_remission',
+            IN_TREATMENT => 'in_treatment',
+            IN_MAINTENANCE => 'in_maintenance',
+            LOST_TO_CANCER => 'lost_to_cancer'
+          }.freeze
+
+          class << self
+            attr_reader :list
+          end
+        end
+      end
+
+      class Occupation < SBF::Client::BaseEntity
+        module Type
+          STUDENT = 'Student'
+          EDUCATOR = 'Educator'
+          PHYSICIAN = 'Physician'
+          NURSE = 'Nurse'
+          RESEARCHER = 'Researcher'
+          SOCIAL_WORKER = 'Social Worker'
+          OTHER_CARE_GIVER = 'Other Caregiver'
+          CHILDHOOD_HEALTH_ADVOCATE = 'Childhood Health Advocate'
+          FIREFIGHTER = 'Firefighter'
+          POLICE_OFFICER = 'Police Officer'
+          MILITARY = 'Military'
+          INSURANCE_INDUSTRIES = 'Insurance Industries'
+          BANKING_FINANCE = 'Banking & Finance'
+          SECURITIES_TRADING = 'Securities & Trading'
+          BARBER_COSMETOLOGIST = 'Barber or Cosmetologist'
+          OTHER = 'Other'
+
+          @list = {
+            STUDENT => 'student',
+            EDUCATOR => 'educator',
+            PHYSICIAN => 'physician',
+            NURSE => 'nurse',
+            RESEARCHER => 'researcher',
+            SOCIAL_WORKER => 'social_worker',
+            OTHER_CARE_GIVER => 'other_care_giver',
+            CHILDHOOD_HEALTH_ADVOCATE => 'childhood_health_advocate',
+            FIREFIGHTER => 'firefighter',
+            POLICE_OFFICER => 'police_officer',
+            MILITARY => 'military',
+            INSURANCE_INDUSTRIES => 'insurance_industries',
+            BANKING_FINANCE => 'banking_finance',
+            SECURITIES_TRADING => 'securities_trading',
+            BARBER_COSMETOLOGIST => 'barber_cosmetologist',
+            OTHER => 'other'
+          }.freeze
+
+          class << self
+            attr_reader :list
+          end
+        end
+
+        module EducatorType
+          PRESCHOOL = 'Preschool'
+          ELEMENTARY_SCHOOL = 'Elementary School'
+          MIDDLE_SCHOOL = 'Middle School'
+          HIGH_SCHOOL = 'High School'
+          COLLEGE = 'College'
+
+          @list = {
+            PRESCHOOL => 'preschool',
+            ELEMENTARY_SCHOOL => 'elementary_school',
+            MIDDLE_SCHOOL => 'middle_school',
+            HIGH_SCHOOL => 'high_school',
+            COLLEGE => 'college'
+          }.freeze
+
+          class << self
+            attr_reader :list
+          end
+        end
+
+        module StudentType
+          ELEMENTARY_SCHOOL = 'Elementary School'
+          MIDDLE_SCHOOL = 'Middle School'
+          HIGH_SCHOOL = 'High School'
+          COLLEGE = 'College'
+          @list = {
+            ELEMENTARY_SCHOOL => 'elementary_school',
+            MIDDLE_SCHOOL => 'middle_school',
+            HIGH_SCHOOL => 'high_school',
+            COLLEGE => 'college'
+          }.freeze
+
+          class << self
+            attr_reader :list
+          end
+        end
+
+        module MilitaryBranchType
+          ARMY = 'Army'
+          NAVY = 'Navy'
+          AIR_FORCE = 'Air Force'
+          MARINES = 'Marines'
+          COAST_GUARD = 'Coast Guard'
+          NATIONAL_GUARD = 'National Guard'
+
+          @list = {
+            ARMY => 'army',
+            NAVY => 'navy',
+            AIR_FORCE => 'air_force',
+            MARINES => 'marines',
+            COAST_GUARD => 'coast_guard',
+            NATIONAL_GUARD => 'national_guard'
+          }.freeze
+
+          class << self
+            attr_reader :list
+          end
+        end
+
+        module MilitaryStatusType
+          ACTIVE_DUTY = 'Active Duty'
+          RESERVES = 'Reserves'
+          RETIRED = 'Retired'
+
+          @list = {
+            ACTIVE_DUTY => 'active_duty',
+            RESERVES => 'reserves',
+            RETIRED => 'retired'
+          }.freeze
+
+          class << self
+            attr_reader :list
+          end
+        end
+
+        class EducationDetails < SBF::Client::BaseEntity
+          attr_accessor :level, :school_name, :is_fraternity_sorority, :fraternity_sorority_name
+        end
+
+        class MilitaryDetails < SBF::Client::BaseEntity
+          attr_accessor :branch, :status, :unit
+        end
+
+        class FinanceDetails < SBF::Client::BaseEntity
+          attr_accessor :industry, :business_name, :job_title
+        end
+
+        attr_accessor :type
+        attr_reader :is_student, :is_educator, :is_military, :is_finance, :is_other
+
+        # TODO: Need to rework this. The details hash needs to contain enough information to be
+        # able to determine what type it should be. As it is currently written, it cannot instanitate itself
+        # without the information contained in the SBF::Client::Person::Occupation instance.
+        attr_accessor :details
+        def details=(value)
+          if educator? || student?
+            @details = SBF::Client::Person::Occupation::EducationDetails.new(value)
+          elsif military?
+            @details = SBF::Client::Person::Occupation::MilitaryDetails.new(value)
+          elsif finance? || other?
+            @details = SBF::Client::Person::Occupation::FinanceDetails.new(value)
+          end
+        end
+      end
+
+      def league_status_title
+        case league_status
+        when SBF::Client::LeagueStatus::SQUIRE
+          'Squire of Hope'
+        when SBF::Client::LeagueStatus::KNIGHT
+          'Knight of the Bald Table'
+        when SBF::Client::LeagueStatus::KNIGHT_COMMANDER
+          'Knight Commander'
+        when SBF::Client::LeagueStatus::CRUSADER
+          'Crusader for a Cure'
+        when SBF::Client::LeagueStatus::NOT_APPLICABLE
+        end
+      end
+    end
+
+    class PartialPerson < SBF::Client::Person
+      attr_accessor :id, :type
+    end
+
+    class FullPerson < SBF::Client::Person
+      attr_accessor :id
+      attr_accessor :type
+      attr_accessor :status
+      attr_accessor :gender
+      attr_accessor :is_minor
+      attr_accessor :birthday
+      attr_reader :display_name, :first_and_last_name
+      attr_accessor :display_name_override
+      attr_accessor :years_as_participant, :years_as_organizer
+      attr_reader :league_status
+      attr_reader :name
+      entity_attr_accessor :name_pieces, 'SBF::Client::NamePieces'
+      entity_attr_accessor :addresses, 'SBF::Client::Person::Addresses'
+      entity_attr_accessor :phone_numbers, 'SBF::Client::Person::PhoneNumbers'
+      entity_attr_accessor :email_addresses, 'SBF::Client::Person::EmailAddresses'
+      entity_attr_accessor :occupation, 'SBF::Client::Person::Occupation', nil, true
+      entity_attr_accessor :policies, 'SBF::Client::Person::Policies'
+      entity_attr_accessor :how_affected, 'SBF::Client::Person::HowAffected', nil, true
+      entity_attr_accessor :opt_out_settings, 'SBF::Client::OptOutSettings', nil, true
+      attr_reader :created_at, :modified_at
+      attr_accessor :modified_by
+      attr_accessor :how_created
+
+      def active?
+        status == SBF::Client::Person::Status::ACTIVE
+      end
+
+      # Dynamically build convenience methods for checking the person's league status (i.e. 'squire?', 'knight?', etc.)
+      SBF::Client::LeagueStatus.to_a.delete_if { |x| x == SBF::Client::LeagueStatus::NOT_APPLICABLE }.each do |league_status|
+        define_method "#{league_status}?".to_sym do
+          self.league_status == league_status
+        end
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/photo.rb

@@ -0,0 +1,260 @@
+require 'stbaldricks/endpoints/photo'
+require 'stbaldricks/entities/campaign'
+require 'stbaldricks/entities/event'
+require 'stbaldricks/entities/event_supporter'
+require 'stbaldricks/entities/fund'
+require 'stbaldricks/entities/fundraiser'
+require 'stbaldricks/entities/kid'
+require 'stbaldricks/entities/memorial'
+require 'stbaldricks/entities/participant'
+require 'stbaldricks/entities/team'
+require 'stbaldricks/entities/lib/top_level'
+
+module SBF
+  module Client
+    class Photo < SBF::Client::TopLevelEntity
+      endpoint SBF::Client::PhotoEndpoint
+      actions DEFAULT_CRUD_ACTIONS
+
+      attr_accessor :id
+      attr_accessor :caption
+      attr_accessor :sort_order
+      attr_accessor :category
+      attr_accessor :file
+      attr_accessor :filename
+      multitype_attr_accessor(
+          :model,
+          [
+            [
+              ->(v) { v[:model_type] == SBF::Client::Photo::ModelType::PARTICIPANT },
+              'SBF::Client::Photo::FullParticipant',
+              'SBF::Client::Photo::PartialParticipant'
+            ],
+            [
+              ->(v) { v[:model_type] == SBF::Client::Photo::ModelType::FUNDRAISER },
+              'SBF::Client::Photo::FullFundraiser',
+              'SBF::Client::Photo::PartialFundraiser'
+            ],
+            [
+              ->(v) { v[:model_type] == SBF::Client::Photo::ModelType::FUND },
+              'SBF::Client::Photo::FullFund',
+              'SBF::Client::Photo::PartialFund'
+            ],
+            [
+              ->(v) { v[:model_type] == SBF::Client::Photo::ModelType::CAMPAIGN },
+              'SBF::Client::Photo::FullCampaign',
+              'SBF::Client::Photo::PartialCampaign'
+            ],
+            [
+              ->(v) { v[:model_type] == SBF::Client::Photo::ModelType::TEAM },
+              'SBF::Client::Photo::FullTeam',
+              'SBF::Client::Photo::PartialTeam'
+            ],
+            [
+              ->(v) { v[:model_type] == SBF::Client::Photo::ModelType::EVENT },
+              'SBF::Client::Photo::FullEvent',
+              'SBF::Client::Photo::PartialEvent'
+            ],
+            [
+              ->(v) { v[:model_type] == SBF::Client::Photo::ModelType::KID },
+              'SBF::Client::Photo::FullKid',
+              'SBF::Client::Photo::PartialKid'
+            ],
+            [
+              ->(v) { v[:model_type] == SBF::Client::Photo::ModelType::EVENT_SUPPORTER },
+              'SBF::Client::Photo::FullEventSupporter',
+              'SBF::Client::Photo::PartialEventSupporter'
+            ],
+            [
+              ->(v) { v[:model_type] == SBF::Client::Photo::ModelType::MEMORIAL },
+              'SBF::Client::Photo::FullMemorial',
+              'SBF::Client::Photo::PartialMemorial'
+            ]
+          ],
+          optional: false
+      )
+      attr_accessor :base_photo_url
+      attr_reader :original_file_id
+      attr_reader :original_filename
+
+      def to_json(*a)
+        to_hash.reject { |k, _v| [:file, :filename].include? k }.to_json(*a)
+      end
+
+      module Category
+        SHAVEE_AFTER = 'shavee_after'
+        SHAVEE_BEFORE = 'shavee_before'
+        KID = 'kid'
+        PARTICIPANT = 'participant'
+        TEAM_LOGO = 'team_logo'
+        VENUE_LOGO = 'venue_logo'
+        USER_AVATAR = 'user_avatar'
+        GALLERY = 'gallery'
+        DEFAULT_PHOTO = 'default_photo'
+        CAMPAIGN_LOGO = 'campaign_logo'
+        FUND_LOGO = 'fund_logo'
+        FUNDRAISER_LOGO = 'fundraiser_logo'
+        EVENT_SUPPORTER_LOGO = 'event_supporter_logo'
+        MEMORIAL = 'memorial'
+        COVER_ORIGINAL = 'cover_original'
+        COVER_DEFAULT = 'cover_default'
+      end
+
+      module ModelType
+        EVENT = 'event'
+        TEAM = 'team'
+        PARTICIPANT = 'participant'
+        FUNDRAISER = 'fundraiser'
+        KID = 'kid'
+        FUND = 'fund'
+        CAMPAIGN = 'campaign'
+        EVENT_SUPPORTER = 'event_supporter'
+        MEMORIAL = 'memorial'
+      end
+
+      class FullParticipant < SBF::Client::FullParticipant
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::PARTICIPANT
+        end
+      end
+
+      class PartialParticipant < SBF::Client::PartialParticipant
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::PARTICIPANT
+        end
+      end
+
+      class FullFundraiser < SBF::Client::FullFundraiser
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::FUNDRAISER
+        end
+      end
+
+      class PartialFundraiser < SBF::Client::PartialFundraiser
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::FUNDRAISER
+        end
+      end
+
+      class FullTeam < SBF::Client::FullTeam
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::TEAM
+        end
+      end
+
+      class PartialTeam < SBF::Client::PartialTeam
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::TEAM
+        end
+      end
+
+      class FullEvent < SBF::Client::FullEvent
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::EVENT
+        end
+      end
+
+      class PartialEvent < SBF::Client::PartialEvent
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::EVENT
+        end
+      end
+
+      class FullKid < SBF::Client::FullKid
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::KID
+        end
+      end
+
+      class PartialKid < SBF::Client::PartialKid
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::KID
+        end
+      end
+
+      class FullFund < SBF::Client::FullFund
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::FUND
+        end
+      end
+
+      class PartialFund < SBF::Client::PartialFund
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::FUND
+        end
+      end
+
+      class FullCampaign < SBF::Client::FullCampaign
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::CAMPAIGN
+        end
+      end
+
+      class PartialCampaign < SBF::Client::PartialCampaign
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::CAMPAIGN
+        end
+      end
+
+      class FullEventSupporter < SBF::Client::FullEventSupporter
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::EVENT_SUPPORTER
+        end
+      end
+
+      class PartialEventSupporter < SBF::Client::PartialEventSupporter
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::EVENT_SUPPORTER
+        end
+      end
+
+      class FullMemorial < SBF::Client::FullMemorial
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::MEMORIAL
+        end
+      end
+
+      class PartialMemorial < SBF::Client::PartialMemorial
+        attr_reader :model_type
+
+        def model_type
+          SBF::Client::Photo::ModelType::MEMORIAL
+        end
+      end
+    end
+  end
+end