stbaldricks 1.5.1.pre

data/lib/stbaldricks/entities/lib/cacheable.rb

@@ -0,0 +1,43 @@
+module SBF
+  module Client
+    module Entities
+      module Cacheable
+        class CacheableNotImplementedError < StandardError; end
+        class CacheableInvalidDataError < StandardError; end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        def cache_id
+          raise CacheableNotImplementedError
+        end
+
+        module ClassMethods
+          def cache_id(proc)
+            define_method(:cache_id) do
+              instance_exec(&proc)
+            end
+          end
+
+          def cache_id_from_hash(proc_or_hash)
+            return cache_id_from_hash_func(proc_or_hash) if proc_or_hash.is_a?(Proc)
+            raise CacheableNotImplementedError unless @cache_id_proc || superclass.respond_to?(:cache_id_from_hash)
+
+            id = @cache_id_proc.call(proc_or_hash || {}) if @cache_id_proc
+            id ||= superclass.cache_id_from_hash(proc_or_hash || {}) if superclass.respond_to?(:cache_id_from_hash)
+            raise CacheableInvalidDataError, "Data missing id. Data: #{proc_or_hash.to_json}" unless id
+            id
+          end
+
+          private
+
+          def cache_id_from_hash_func(proc)
+            raise ArgumentError, "Unable to re-set cache_id_from_hash on #{name}" if @cache_id_proc
+            @cache_id_proc = proc
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/default_cacheable.rb

@@ -0,0 +1,17 @@
+require 'stbaldricks/entities/lib/cacheable'
+
+module SBF
+  module Client
+    module Entities
+      module DefaultCacheable
+        def self.included(klass)
+          klass.class_eval do
+            include Cacheable
+            cache_id_from_hash ->(h) { [h[:id]] }
+            cache_id -> { [id] }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/email_address.rb

@@ -0,0 +1,15 @@
+require 'stbaldricks/entities/lib/base'
+
+module SBF
+  module Client
+    class EmailAddress < SBF::Client::BaseEntity
+      module Type
+        PERSONAL = 'personal'
+        BUSINESS = 'business'
+      end
+
+      attr_accessor :type
+      attr_accessor :email_address
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/error.rb

@@ -0,0 +1,38 @@
+require 'stbaldricks/errors'
+
+module SBF
+  module Client
+    class ErrorEntity
+      BAD_INPUT = 5007
+
+      attr_reader :code, :type, :details, :fields
+
+      def initialize(data = {})
+        super()
+
+        # In case null was explicitly passed in
+        data ||= {}
+
+        # Set all attributes
+        @code = data[:code].freeze
+        @type = data[:type].freeze
+        @details = data[:details].freeze
+        @fields = Set.new(data[:errors].empty? ? [] : data[:errors]).freeze
+      end
+
+      def to_hash
+        {code: @code, type: @type, details: @details, fields: @fields.to_a}
+      end
+
+      def to_json(*a)
+        to_hash.to_json(*a)
+      end
+
+      def to_s
+        error_message = "#{@code} - [#{@type}] #{@details}"
+        error_message << " details: #{@fields.to_a.join(', ')}" unless @fields.empty?
+        error_message
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/fundraising_page.rb

@@ -0,0 +1,20 @@
+require 'stbaldricks/entities/lib/base'
+
+module SBF
+  module Client
+    class FundraisingPage < SBF::Client::BaseEntity
+      attr_accessor :is_enabled
+      attr_accessor :custom_url_segment
+      attr_reader :url
+
+      HTTP_REGEX = %r{^https?://}
+
+      def url_with_scheme
+        url.insert(0, 'https:') unless url.empty? || HTTP_REGEX.match(url)
+        url
+      end
+    end
+
+    class WebPage < SBF::Client::FundraisingPage; end
+  end
+end

data/lib/stbaldricks/entities/lib/geo_location.rb

@@ -0,0 +1,9 @@
+require 'stbaldricks/entities/lib/base'
+
+module SBF
+  module Client
+    class GeoLocation < SBF::Client::BaseEntity
+      attr_accessor :lat, :lon
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/location.rb

@@ -0,0 +1,27 @@
+require 'stbaldricks/entities/lib/base'
+require 'stbaldricks/entities/lib/address'
+
+module SBF
+  module Client
+    class Location < SBF::Client::BaseEntity
+      module Type
+        RESTAURANT = 'restaurant'
+        SCHOOL = 'school'
+        BUSINESS = 'business'
+        PRIVATE_RESIDENCE = 'private_residence'
+        HOSPITAL = 'hospital'
+        MUNICIPALITY = 'municipality'
+        OTHER = 'other'
+        LEGACY = 'legacy'
+      end
+
+      attr_accessor :type
+      attr_accessor :name
+      entity_attr_accessor :address, 'SBF::Client::Address'
+
+      def name
+        HTMLEntities.new.decode(@name)
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/name.rb

@@ -0,0 +1,17 @@
+require 'stbaldricks/entities/lib/base'
+
+module SBF
+  module Client
+    class NamePieces < SBF::Client::BaseEntity
+      attr_accessor :prefix, :first_name, :middle_initial, :last_name, :suffix
+
+      def combined_name
+        name = ''
+        name += @first_name + ' ' unless @first_name.nil?
+        name += @middle_initial + '. ' unless @middle_initial.nil?
+        name += @last_name unless @last_name.nil?
+        name.strip
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/not_implemented_object.rb

@@ -0,0 +1,32 @@
+require 'stbaldricks/entities/lib/base'
+
+# - JUST CODED THIS SO IT WILL RESPOND WITH DOT NOTATION ex, thing.id instead of thing['id']
+module SBF
+  module Client
+    class NotImplementedObject < SBF::Client::BaseEntity
+      attr_accessor :props
+
+      def initialize(attributes = {})
+        @props = {}.tap { |hsh|
+          attributes.each { |k, v|
+            hsh[k.to_sym] = v
+          }
+        }
+
+        super
+      end
+
+      def method_missing(name)
+        return @props[name.to_sym] if @props.key?(name.to_sym)
+        super.method_missing(name)
+      end
+
+      def to_hash
+        {}.tap do |hsh|
+          props.each { |k, v| hsh[k] = v }
+          self.class.attributes.each { |name| hsh[name] = send(name.to_sym) unless hsh.key?(name.to_sym) || name.to_sym == :props }
+        end
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/opt_out_settings.rb

@@ -0,0 +1,21 @@
+require 'stbaldricks/entities/lib/base'
+
+module SBF
+  module Client
+    class OptOutSettings < SBF::Client::BaseEntity
+      attr_reader :email_activity, :email_members_communication, :email_mass_online, :email_mass_print, :email_reply, :email_contact_us
+
+      # Setting Types
+      NOTIFICATION_TYPE = 1
+      EMAIL_TYPE = 2
+
+      # Settings
+      WEBSITE_ACTIVITY = 1
+      CONTACT_US = 20
+      ONLINE_MASS_MAIL = 23
+      PRINT_MASS_MAIL = 24
+      REPLY = 26
+      MEMBERS_COMMUNICATION = 28
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/payment.rb

@@ -0,0 +1,86 @@
+require 'stbaldricks/entities/lib/base'
+
+module SBF
+  module Client
+    class Payment
+      module Type
+        UNKNOWN = 'unknown'
+        CREDIT_CARD = 'credit_card'
+        CHECK = 'check'
+        CASH = 'cash'
+        MONEY_ORDER = 'money_order'
+        NONCE = 'nonce'
+        WIRE_TRANSFER = 'wire_transfer'
+        RECURRING_GIFTS = 'recurring'
+      end
+
+      class Details < SBF::Client::BaseEntity
+        attr_reader :type
+
+        def type
+          SBF::Client::Payment::Type::UNKNOWN
+        end
+      end
+
+      class CreditCardDetails < SBF::Client::Payment::Details
+        attr_accessor :authorization_id, :cardholder_name, :card_type, :expiration_date, :card_number
+
+        def type
+          SBF::Client::Payment::Type::CREDIT_CARD
+        end
+      end
+
+      class BraintreeSubscriptionDetails < SBF::Client::Payment::Details
+        attr_accessor :subscription_id, :customer_id, :cardholder_name, :card_type, :expiration_date, :card_number
+
+        def type
+          SBF::Client::Payment::Type::RECURRING_GIFTS
+        end
+      end
+
+      class CheckDetails < SBF::Client::Payment::Details
+        attr_accessor :number
+
+        def type
+          SBF::Client::Payment::Type::CHECK
+        end
+      end
+
+      class MoneyOrderDetails < SBF::Client::Payment::Details
+        attr_accessor :number
+
+        def type
+          SBF::Client::Payment::Type::MONEY_ORDER
+        end
+      end
+
+      class WireTransferDetails < SBF::Client::Payment::Details
+        attr_accessor :number
+
+        def type
+          SBF::Client::Payment::Type::WIRE_TRANSFER
+        end
+      end
+
+      class CashDetails < SBF::Client::Payment::Details
+        def type
+          SBF::Client::Payment::Type::CASH
+        end
+      end
+
+      class UnknownDetails < SBF::Client::Payment::Details
+        def type
+          SBF::Client::Payment::Type::UNKNOWN
+        end
+      end
+
+      class NonceDetails < SBF::Client::Payment::Details
+        attr_accessor :nonce, :device_data
+
+        def type
+          SBF::Client::Payment::Type::NONCE
+        end
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/permissions.rb

@@ -0,0 +1,33 @@
+require 'stbaldricks/entities/lib/base'
+require 'stbaldricks/enums/permission'
+require 'set'
+
+module SBF
+  module Client
+    class Permissions < SBF::Client::BaseEntity
+      attr_accessor :is_owner
+      attr_accessor :permission_ids
+
+      def method_missing(method, *arguments, &block)
+        # If the method starts with 'can', assume they are trying to determine if the user has the permission
+        # in their list of permission ids and return the result
+        if method.to_s.start_with?('can_')
+          const_name = method.to_s.split('can_').last.upcase.to_sym
+
+          if SBF::Client::Permission.constants(false).include?(const_name)
+            permission_id = SBF::Client::Permission.const_get(const_name, false)
+            return permission_ids.include?(permission_id)
+
+          end
+        end
+
+        super
+      end
+    end
+
+    class PermissionsAtEvent < SBF::Client::BaseEntity
+      attr_accessor :granted
+      attr_accessor :inherited_from_roles
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/phone.rb

@@ -0,0 +1,29 @@
+require 'stbaldricks/entities/lib/base'
+
+module SBF
+  module Client
+    class Phone < SBF::Client::BaseEntity
+      module Type
+        HOME = 'home'
+        BUSINESS = 'business'
+        MOBILE = 'mobile'
+      end
+
+      attr_accessor :type
+      attr_accessor :number, :extension
+
+      # (402)555-5555 --> tel:4025555555
+      def format_href
+        return 'tel:' + number.gsub(/\D/, '') unless number.nil?
+        number
+      end
+
+      # This kinda handles extensions, at least? We never actually populate :extension, do we?
+      # (402)555-5555 ext. 5555 --> 402.555.555 x5555
+      def format_number
+        return number.gsub(/\D/, '').gsub(/(\d{3})(\d{3})(\d{4})(\d*)/, '\1.\2.\3 x\4').gsub(/x$/, '').rstrip unless number.nil?
+        number
+      end
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/third_party_media.rb

@@ -0,0 +1,20 @@
+require 'stbaldricks/entities/lib/base'
+require 'stbaldricks/entities/lib/cacheable'
+require 'stbaldricks/entities/lib/default_cacheable'
+
+module SBF
+  module Client
+    class ThirdPartyMedia < SBF::Client::BaseEntity
+      include Entities::DefaultCacheable
+
+      module Type
+        YOUTUBE = 'youtube'
+        VIMEO = 'vimeo'
+      end
+
+      attr_accessor :id
+      attr_accessor :type
+      attr_accessor :identifier
+    end
+  end
+end

data/lib/stbaldricks/entities/lib/top_level.rb

@@ -0,0 +1,99 @@
+require 'stbaldricks/entities/lib/base'
+require 'stbaldricks/endpoints/lib/entity'
+require 'stbaldricks/entities/lib/cacheable'
+
+module SBF
+  module Client
+    class TopLevelEntity < SBF::Client::BaseEntity
+      include Entities::Cacheable
+
+      DEFAULT_ENDPOINT = SBF::Client::EntityEndpoint
+      DEFAULT_INSTANCE_ACTIONS = [:save, :create, :update, :delete]
+      DEFAULT_CLASS_ACTIONS = [:get, :find, :find_first, :aggregate, :update, :delete]
+      DEFAULT_CRUD_ACTIONS = DEFAULT_INSTANCE_ACTIONS + DEFAULT_CLASS_ACTIONS
+
+      class << self
+        DEFAULT_CLASS_ACTIONS.each do |action|
+          define_method(action) do |*_|
+            raise NoMethodError.new("#{action} is not implemented", action)
+          end
+        end
+
+        def endpoint(mod = nil, options = {})
+          return define_endpoint(mod, options) if mod
+          _endpoint
+        end
+
+        def _endpoint
+          DEFAULT_ENDPOINT.new(self)
+        end
+
+        def define_endpoint(mod, options)
+          singleton_class.class_eval do
+            define_method(:_endpoint) do
+              @_endpoint ||= mod.new(options.fetch(:target_class, self))
+            end
+          end
+        end
+
+        def actions(actions)
+          actions.each { |m| action(m) }
+        end
+
+        def instance_action(name)
+          define_method(name) do |*args|
+            endpoint.send(name, self, *args)
+          end
+        end
+
+        def class_action(name)
+          singleton_class.class_eval do
+            define_method(name) do |*args|
+              endpoint.send(name, *args)
+            end
+          end
+        end
+
+        def action(name)
+          instance_action(name) if [:save, :create].include?(name)
+
+          if name == :update
+            define_method(name) do |*args|
+              endpoint.update(id, self, *args)
+            end
+          end
+
+          if name == :delete
+            define_method(:delete) do |*_args|
+              endpoint.delete(id)
+            end
+          end
+
+          class_action(name)
+        end
+
+        def blacklist_action(name)
+          define_method(name) do |*_|
+            raise NoMethodError.new("#{name} is blacklisted", name)
+          end
+
+          singleton_class.class_eval do
+            define_method(name) do |*_|
+              raise NoMethodError.new("#{name} is blacklisted", name)
+            end
+          end
+        end
+      end
+
+      DEFAULT_INSTANCE_ACTIONS.each do |action|
+        define_method(action) do |*_|
+          raise NoMethodError.new("#{action} is not implemented", action)
+        end
+      end
+
+      def endpoint
+        self.class.endpoint
+      end
+    end
+  end
+end