stbaldricks 1.5.1.pre

data/lib/stbaldricks/entities/section.rb

@@ -0,0 +1,15 @@
+require 'stbaldricks/entities/lib/top_level'
+
+module SBF
+  module Client
+    class Section < SBF::Client::TopLevelEntity
+      actions DEFAULT_CRUD_ACTIONS
+
+      attr_reader :id
+      attr_accessor :title
+      attr_accessor :pages
+      attr_accessor :parent_section
+      attr_accessor :subsections
+    end
+  end
+end

data/lib/stbaldricks/entities/shave_schedule.rb

@@ -0,0 +1,69 @@
+require 'stbaldricks/endpoints/shave_schedule'
+require 'stbaldricks/entities/lib/top_level'
+require 'stbaldricks/entities/lib/permissions'
+
+module SBF
+  module Client
+    class ShaveSchedule < SBF::Client::TopLevelEntity
+      endpoint SBF::Client::ShaveScheduleEndpoint
+      actions DEFAULT_CRUD_ACTIONS
+      action :notify
+
+      def update(with = {})
+        endpoint.update(id, year, self, with)
+      end
+
+      class TimeSelectionPermissions < SBF::Client::BaseEntity
+        attr_accessor :shavees, :team_captains
+
+        def shavees?
+          shavees
+        end
+
+        def team_captains?
+          team_captains
+        end
+      end
+
+      class ShaveScheduleAssignment < SBF::Client::BaseEntity
+        module Type
+          RESERVED = 'reserved'
+          SHAVEE = 'shavee'
+        end
+
+        attr_accessor :id
+        attr_accessor :type
+        attr_accessor :participant
+        attr_accessor :is_notification_sent
+        attr_accessor :shave_time
+      end
+
+      attr_accessor :id
+      attr_accessor :year
+      attr_accessor :start_time
+      attr_accessor :end_time
+      attr_accessor :shave_duration_in_minutes
+      attr_accessor :number_of_seats
+      attr_accessor :is_published
+      entity_attr_accessor :time_selection_permissions, 'SBF::Client::ShaveSchedule::TimeSelectionPermissions'
+      entity_collection_attr_accessor :assignments, 'SBF::Client::ShaveSchedule::ShaveScheduleAssignment'
+      entity_attr_reader :permissions, 'SBF::Client::Permissions', nil, true
+
+      def published?
+        is_published
+      end
+
+      def shavees_can_schedule_times?
+        time_selection_permissions.shavees?
+      end
+
+      def team_captains_can_schedule_times?
+        time_selection_permissions.team_captains?
+      end
+
+      def owner?
+        @permissions.nil? ? false : @permissions.owner?
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/summary.rb

@@ -0,0 +1,32 @@
+require 'stbaldricks/entities/lib/base'
+require 'stbaldricks/entities/lib/top_level'
+require 'stbaldricks/entities/lib/cacheable'
+
+module SBF
+  module Client
+    class Summary < SBF::Client::TopLevelEntity
+      include Entities::Cacheable
+      action :find
+      action :find_first
+
+      cache_id -> { [year] }
+      cache_id_from_hash ->(h) { [h[:year]] }
+
+      attr_accessor :year
+
+      entity_attr_reader :yearly_totals, 'SBF::Client::Summary::Totals'
+      entity_attr_reader :monthly_totals, 'SBF::Client::Summary::Totals'
+      entity_attr_reader :weekly_totals, 'SBF::Client::Summary::Totals'
+
+      class Totals < SBF::Client::BaseEntity
+        attr_reader :donations
+        attr_reader :events
+        attr_reader :male_shavees
+        attr_reader :female_shavees
+        attr_reader :barbers
+        attr_reader :participants
+        attr_reader :fundraisers
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/team.rb

@@ -0,0 +1,95 @@
+require 'stbaldricks/entities/participant'
+require 'stbaldricks/entities/fund'
+require 'stbaldricks/entities/event'
+require 'stbaldricks/entities/lib/top_level'
+require 'stbaldricks/entities/lib/fundraising_page'
+require 'stbaldricks/entities/lib/permissions'
+require 'htmlentities'
+
+module SBF
+  module Client
+    class Team  < SBF::Client::TopLevelEntity
+      actions DEFAULT_CRUD_ACTIONS
+
+      blacklist_action :create
+
+      disallow_instantiation
+
+      module Status
+        ACTIVE = 'active'
+        PENDING = 'pending'
+      end
+
+      module HowCreated
+        WEBSITE = 'website'
+        ADMIN_IMPORT = 'admin_import'
+        ADMIN_CONTROL_PANEL = 'admin_control_panel'
+        MOBILE = 'mobile'
+        PARTICIPANT_IMPORT = 'participant_import'
+      end
+
+      module FundRelationshipType
+        NO_ASSOCIATION = 'no_association'
+        INDIRECT_ONE = 'indirect_one'
+        INDIRECT_MULTIPLE = 'indirect_multiple'
+        DIRECT = 'direct'
+        DIRECT_BUT_LOCKED = 'direct_but_locked'
+        INHERITED_EVENT = 'inherited_event'
+      end
+
+      class Photos < SBF::Client::BaseEntity
+        attr_reader :avatar, :default
+      end
+
+      class Totals < SBF::Client::BaseEntity
+        attr_reader :fundraisers, :participants, :shavees, :amount_raised
+      end
+
+      class Rankings < SBF::Client::BaseEntity
+        class Ranking < SBF::Client::BaseEntity
+          attr_reader :rank, :total
+        end
+
+        entity_attr_reader :event, 'SBF::Client::Team::Rankings::Ranking'
+      end
+    end
+
+    class PartialTeam < Team
+      attr_accessor :id
+    end
+
+    class FullTeam < Team
+      attr_accessor :id
+      attr_accessor :name
+      attr_accessor :status
+      attr_reader :display_name
+      entity_attr_accessor :event, 'SBF::Client::FullEvent', 'SBF::Client::PartialEvent', true
+      entity_attr_accessor :fund, 'SBF::Client::FullFund', 'SBF::Client::PartialFund', true
+      attr_accessor :fund_relationship_type
+      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_reader :photos, 'SBF::Client::Team::Photos'
+      entity_attr_accessor :captain, 'SBF::Client::FullParticipant'
+      entity_attr_reader :rankings, 'SBF::Client::Team::Rankings', nil, true
+      entity_attr_reader :totals, 'SBF::Client::Team::Totals'
+      attr_reader :created_at, :modified_at
+      attr_accessor :modified_by
+      attr_accessor :how_created
+      entity_attr_reader :permissions, 'SBF::Client::Permissions', nil, true
+      entity_attr_accessor :third_party_media, 'SBF::Client::ThirdPartyMedia', nil, true
+
+      def active?
+        status == SBF::Client::Team::Status::ACTIVE
+      end
+
+      def display_name
+        HTMLEntities.new.decode(@display_name)
+      end
+
+      def name
+        HTMLEntities.new.decode(@name)
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/user.rb

@@ -0,0 +1,76 @@
+require 'stbaldricks/endpoints/user'
+require 'stbaldricks/entities/person'
+require 'stbaldricks/entities/organization'
+require 'stbaldricks/entities/lib/top_level'
+require 'stbaldricks/entities/lib/cacheable'
+
+module SBF
+  module Client
+    class User < SBF::Client::TopLevelEntity
+      include Entities::Cacheable
+
+      endpoint SBF::Client::UserEndpoint
+      actions DEFAULT_CRUD_ACTIONS
+      action :login!
+      action :list_entities_user_has_permission
+      action :change_password
+      action :disconnect_facebook
+
+      cache_id -> { [person.id, type] }
+      cache_id_from_hash ->(h) { [h[:person][:id], h[:type]] }
+
+      module AccessScope
+        ADMIN = 'admin'
+        LIMITED_ADMIN = 'admin_limited'
+        MEMBER = 'member'
+      end
+
+      module ProviderType
+        SBF = 'sbf'
+        FACEBOOK = 'facebook'
+        TWITTER = 'twitter'
+
+        IDS = {
+          SBF => 1,
+          FACEBOOK => 2,
+          TWITTER => 3
+        }
+        IDS.default = 0
+        IDS.freeze
+
+        def self.to_s(type_id)
+          IDS.key(type_id)
+        end
+
+        def self.value_of(type)
+          IDS[type]
+        end
+      end
+
+      attr_accessor :type, :access_scope, :username, :password, :token, :identifier
+
+      multitype_attr_accessor(
+        :person,
+        [
+          [
+            ->(v) { v[:type] == SBF::Client::Organization::Type::ORGANIZATION_FOUNDATION },
+            'SBF::Client::FullOrganization',
+            'SBF::Client::PartialOrganization'
+          ],
+          [
+            ->(v) { v[:type] == SBF::Client::Organization::Type::BUSINESS },
+            'SBF::Client::FullOrganization',
+            'SBF::Client::PartialOrganization'
+          ],
+          [
+            ELSE,
+            'SBF::Client::FullPerson',
+            'SBF::Client::PartialPerson'
+          ]
+        ]
+      )
+
+      attr_reader :created_at, :modified_at, :last_login_at
+    end
+  end
+end

data/lib/stbaldricks/enums/country.rb

@@ -0,0 +1,223 @@
+module SBF
+  module Client
+    module Country
+      AMERICAN_SAMOA = 'American Samoa'
+      ANGUILLA = 'Anguilla'
+      ANTIGUA_AND_BARBUDA = 'Antigua And Barbuda'
+      ARGENTINA = 'Argentina'
+      ARMENIA = 'Armenia'
+      ARUBA = 'Aruba'
+      AUSTRALIA = 'Australia'
+      AUSTRIA = 'Austria'
+      AZERBAIJAN = 'Azerbaijan'
+      BAHAMAS = 'Bahamas'
+      BAHRAIN = 'Bahrain'
+      BARBADOS = 'Barbados'
+      BELARUS = 'Belarus'
+      BELGIUM = 'Belgium'
+      BELIZE = 'Belize'
+      BERMUDA = 'Bermuda'
+      BRAZIL = 'Brazil'
+      BULGARIA = 'Bulgaria'
+      CANADA = 'Canada'
+      CAYMAN_ISLANDS = 'Cayman Islands'
+      CHILE = 'Chile'
+      CHINA = 'China'
+      COLUMBIA = 'Colombia'
+      COSTA_RICA = 'Costa Rica'
+      CUBA = 'Cuba'
+      CURACAO = 'Curacao'
+      CYPRUS = 'Cyprus'
+      CZECH_REPUBLIC = 'Czech Republic'
+      DENMARK = 'Denmark'
+      DOMINICA = 'Dominica'
+      DOMINICAN_REPUBLIC = 'Dominican Republic'
+      ECUADOR = 'Ecuador'
+      EGYPT = 'Egypt'
+      EL_SALVADOR = 'El Salvador'
+      FINLAND = 'Finland'
+      FRANCE = 'France'
+      GERMANY = 'Germany'
+      GREECE = 'Greece'
+      GRENADA = 'Grenada'
+      HAITI = 'Haiti'
+      HONDURAS = 'Honduras'
+      HONG_KONG = 'Hong Kong'
+      HUNGARY = 'Hungary'
+      ICELAND = 'Iceland'
+      INDIA = 'India'
+      INDONESIA = 'Indonesia'
+      IRAN = 'Iran'
+      IRAQ = 'Iraq'
+      IRELAND = 'Ireland'
+      ISRAEL = 'Israel'
+      ITALY = 'Italy'
+      JAMAICA = 'Jamaica'
+      JAPAN = 'Japan'
+      KENYA = 'KE'
+      KUWAIT = 'Kuwait'
+      LEBANON = 'Lebanon'
+      LUXEMBOURG = 'Luxembourg'
+      MACAO = 'Macao'
+      MALAWI = 'Malawi'
+      MALAYSIA = 'Malaysia'
+      MEXICO = 'Mexico'
+      MOLDOVA = 'Moldova'
+      MONTSERRAT = 'Montserrat'
+      NETHERLANDS = 'Netherlands (The)'
+      NEW_ZEALAND = 'New Zealand'
+      NICARAGUA = 'Nicaragua'
+      NORWAY = 'Norway'
+      OMAN = 'Oman'
+      PAKISTAN = 'Pakistan'
+      PERU = 'Peru'
+      PHILIPPINES = 'Philippines'
+      POLAND = 'Poland'
+      PORTUGAL = 'Portugal'
+      QATAR = 'Qatar'
+      ROMANIA = 'Romania'
+      RUSSIA = 'Russia'
+      SAINT_KITTS_AND_NEVIS = 'Saint Kitts And Nevis'
+      SAINT_LUCIA = 'Saint Lucia'
+      SAINT_MARTIN = 'Saint Martin'
+      SAINT_VINCENT_AND_THE_GRENADINES = 'Saint Vincent And The Grenadines'
+      SAUDI_ARABIA = 'Saudi Arabia'
+      SINGAPORE = 'Singapore'
+      SINT_MARTIN = 'Sint Martin'
+      SLOVAKIA = 'Slovakia'
+      SLOVENIA = 'Slovenia'
+      SOUTH_AFRICA = 'South Africa'
+      SOUTH_KOREA = 'South Korea'
+      SPAIN = 'Spain'
+      SRI_LANKA = 'Sri Lanka'
+      SWEDEN = 'Sweden'
+      SWITZERLAND = 'Switzerland'
+      TAIWAN = 'Taiwan'
+      THAILAND = 'Thailand'
+      TRINIDAD_AND_TOBAGO = 'Trinidad And Tobago'
+      TURKEY = 'Turkey'
+      TURKS_AND_CAICOS_ISLANDS = 'Turks And Caicos Islands'
+      UGANDA = 'Uganda'
+      UKRAINE = 'Ukraine'
+      UNITED_ARAB_EMIRATES = 'United Arab Emirates'
+      UNITED_KINGDOM = 'United Kingdom'
+      UNITED_STATES = 'United States'
+      URUGUAY = 'Uruguay'
+      VENEZUELA = 'Venezuela'
+      VIETNAM = 'Vietnam'
+      VIRGIN_ISLANDS_BRITISH = 'Virgin Islands (British)'
+
+      @list = {
+        UNITED_STATES => :US,
+        AMERICAN_SAMOA => :AS,
+        ANGUILLA => :AI,
+        ANTIGUA_AND_BARBUDA => :AG,
+        ARGENTINA => :AR,
+        ARMENIA => :AM,
+        ARUBA => :AW,
+        AUSTRALIA => :AU,
+        AUSTRIA => :AT,
+        AZERBAIJAN => :AZ,
+        BAHAMAS => :BS,
+        BAHRAIN => :BH,
+        BARBADOS => :BB,
+        BELARUS => :BY,
+        BELGIUM => :BE,
+        BELIZE => :BZ,
+        BERMUDA => :BM,
+        BRAZIL => :BR,
+        BULGARIA => :BG,
+        CANADA => :CA,
+        CAYMAN_ISLANDS => :KY,
+        CHILE => :CL,
+        CHINA => :CN,
+        COLUMBIA => :CO,
+        COSTA_RICA => :CR,
+        CUBA => :CU,
+        CURACAO => :CW,
+        CYPRUS => :CY,
+        CZECH_REPUBLIC => :CZ,
+        DENMARK => :DK,
+        DOMINICA => :DM,
+        DOMINICAN_REPUBLIC => :DO,
+        ECUADOR => :EC,
+        EGYPT => :EG,
+        EL_SALVADOR => :SV,
+        FINLAND => :FI,
+        FRANCE => :FR,
+        GERMANY => :DE,
+        GREECE => :GR,
+        GRENADA => :GD,
+        HAITI => :HT,
+        HONDURAS => :HN,
+        HONG_KONG => :HK,
+        HUNGARY => :HU,
+        ICELAND => :IS,
+        INDIA => :IN,
+        INDONESIA => :ID,
+        IRAN => :IR,
+        IRAQ => :IQ,
+        IRELAND => :IE,
+        ISRAEL => :IL,
+        ITALY => :IT,
+        JAMAICA => :JM,
+        JAPAN => :JP,
+        KENYA => :KE,
+        KUWAIT => :KW,
+        LEBANON => :LB,
+        LUXEMBOURG => :LU,
+        MACAO => :MO,
+        MALAWI => :MW,
+        MALAYSIA => :MY,
+        MEXICO => :MX,
+        MOLDOVA => :MD,
+        MONTSERRAT => :MS,
+        NETHERLANDS => :NL,
+        NEW_ZEALAND => :NZ,
+        NICARAGUA => :NI,
+        NORWAY => :NO,
+        OMAN => :OM,
+        PAKISTAN => :PK,
+        PERU => :PE,
+        PHILIPPINES => :PH,
+        POLAND => :PL,
+        PORTUGAL => :PT,
+        QATAR => :QA,
+        ROMANIA => :RO,
+        RUSSIA => :RU,
+        SAINT_KITTS_AND_NEVIS => :KN,
+        SAINT_LUCIA => :LC,
+        SAINT_MARTIN => :MF,
+        SAINT_VINCENT_AND_THE_GRENADINES => :VC,
+        SAUDI_ARABIA => :SA,
+        SINGAPORE => :SG,
+        SINT_MARTIN => :SX,
+        SLOVAKIA => :SK,
+        SLOVENIA => :SI,
+        SOUTH_AFRICA => :ZA,
+        SOUTH_KOREA => :KR,
+        SPAIN => :ES,
+        SRI_LANKA => :LK,
+        SWEDEN => :SE,
+        SWITZERLAND => :CH,
+        TAIWAN => :TW,
+        THAILAND => :TH,
+        TRINIDAD_AND_TOBAGO => :TT,
+        TURKEY => :TR,
+        TURKS_AND_CAICOS_ISLANDS => :TC,
+        UGANDA => :UG,
+        UKRAINE => :UA,
+        UNITED_ARAB_EMIRATES => :AE,
+        UNITED_KINGDOM => :UK,
+        URUGUAY => :UY,
+        VENEZUELA => :VE,
+        VIETNAM => :VN,
+        VIRGIN_ISLANDS_BRITISH => :VG
+      }.freeze
+
+      class << self
+        attr_reader :list
+      end
+    end
+  end
+end