Class: AdvancedBilling::SubscriptionStateFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/advanced_billing/models/subscription_state_filter.rb

Overview

Allowed values for filtering by the current state of the subscription.

Constant Summary collapse

SUBSCRIPTION_STATE_FILTER = 
[
  # TODO: Write general description for ACTIVE
  ACTIVE = 'active'.freeze,

  # TODO: Write general description for CANCELED
  CANCELED = 'canceled'.freeze,

  # TODO: Write general description for EXPIRED
  EXPIRED = 'expired'.freeze,

  # TODO: Write general description for EXPIRED_CARDS
  EXPIRED_CARDS = 'expired_cards'.freeze,

  # TODO: Write general description for
  # ENUM_EXPIRED_CARDS_LIVE_SUBSCRIPTIONS
  ENUM_EXPIRED_CARDS_LIVE_SUBSCRIPTIONS = 'expired_cards_(live_subscriptions)'.freeze,

  # TODO: Write general description for ENUM_EXPIRED_CARDS_ALL_SUBSCRIPTIONS
  ENUM_EXPIRED_CARDS_ALL_SUBSCRIPTIONS = 'expired_cards_(all_subscriptions)'.freeze,

  # TODO: Write general description for ON_HOLD
  ON_HOLD = 'on_hold'.freeze,

  # TODO: Write general description for AWAITING_SIGNUP
  AWAITING_SIGNUP = 'awaiting_signup'.freeze,

  # TODO: Write general description for AWAITING_SIGNUP_DATE
  AWAITING_SIGNUP_DATE = 'awaiting_signup_date'.freeze,

  # TODO: Write general description for PAST_DUE
  PAST_DUE = 'past_due'.freeze,

  # TODO: Write general description for PENDING_CANCELLATION
  PENDING_CANCELLATION = 'pending_cancellation'.freeze,

  # TODO: Write general description for PENDING_RENEWAL
  PENDING_RENEWAL = 'pending_renewal'.freeze,

  # TODO: Write general description for PREPAID_DUNNING
  PREPAID_DUNNING = 'prepaid_dunning'.freeze,

  # TODO: Write general description for SUSPENDED
  SUSPENDED = 'suspended'.freeze,

  # TODO: Write general description for TRIAL_ENDED
  TRIAL_ENDED = 'trial_ended'.freeze,

  # TODO: Write general description for TRIALING
  TRIALING = 'trialing'.freeze,

  # TODO: Write general description for UNPAID
  UNPAID = 'unpaid'.freeze
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = ACTIVE) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/advanced_billing/models/subscription_state_filter.rb', line 69

def self.from_value(value, default_value = ACTIVE)
  return default_value if value.nil?

  str = value.to_s.strip

  case str.downcase
  when 'active' then ACTIVE
  when 'canceled' then CANCELED
  when 'expired' then EXPIRED
  when 'expired_cards' then EXPIRED_CARDS
  when 'enum_expired_cards_live_subscriptions' then ENUM_EXPIRED_CARDS_LIVE_SUBSCRIPTIONS
  when 'enum_expired_cards_all_subscriptions' then ENUM_EXPIRED_CARDS_ALL_SUBSCRIPTIONS
  when 'on_hold' then ON_HOLD
  when 'awaiting_signup' then AWAITING_SIGNUP
  when 'awaiting_signup_date' then AWAITING_SIGNUP_DATE
  when 'past_due' then PAST_DUE
  when 'pending_cancellation' then PENDING_CANCELLATION
  when 'pending_renewal' then PENDING_RENEWAL
  when 'prepaid_dunning' then PREPAID_DUNNING
  when 'suspended' then SUSPENDED
  when 'trial_ended' then TRIAL_ENDED
  when 'trialing' then TRIALING
  when 'unpaid' then UNPAID
  else
    default_value
  end
end

.validate(value) ⇒ Object 



63
64
65
66
67
 
# File 'lib/advanced_billing/models/subscription_state_filter.rb', line 63

def self.validate(value)
  return false if value.nil?

  SUBSCRIPTION_STATE_FILTER.include?(value)
end