bill_forward 1.2014.296

data/spec/functional/bad_citizen/situational/organisation_spec.rb

@@ -0,0 +1,39 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "..", "spec_helper")
+
+describe BillForward::Organisation do
+	before :all do
+		@client = BillForwardTest::TEST_CLIENT
+		BillForward::Client.default_client = @client
+
+		# Authorize.Net credentials used to test adding a payment gateway
+		@authorize_net_login_id = BillForwardTest::AUTHORIZE_NET_LOGIN_ID
+		@authorize_net_transaction_key = BillForwardTest::AUTHORIZE_NET_TRANSACTION_KEY
+	end
+	describe '.api_configurations' do
+		it "can be updated" do
+			organisations = BillForward::Organisation.get_mine
+			first_org = organisations.first
+
+
+			# remove all existing AuthorizeNetConfigurations (if any)
+			filtered = first_org.apiConfigurations.reject do |config|
+				config['@type'] == 'AuthorizeNetConfiguration'
+			end
+
+			first_org.apiConfigurations = filtered
+
+
+			#add a new AuthorizeNetConfiguration
+			first_org.apiConfigurations.push BillForward::APIConfiguration.new({
+				 "@type" =>          "AuthorizeNetConfiguration",
+			     "APILoginID" =>     @authorize_net_login_id,
+			     "transactionKey" => @authorize_net_transaction_key,
+			     "environment" =>    "Sandbox"
+				})
+			updated_org = first_org.save
+
+			added_config = updated_org.apiConfigurations.last
+			expect(added_config.APILoginID).to eq(@authorize_net_login_id)
+		end
+	end
+end

data/spec/functional/bad_citizen/situational/payment_method_spec.rb

@@ -0,0 +1,47 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "..", "spec_helper")
+
+describe BillForward::PaymentMethod do
+	before :all do
+		@client = BillForwardTest::TEST_CLIENT
+		BillForward::Client.default_client = @client
+
+		# Authorize.Net credentials used to test tokenizing a card
+		@authorize_net_customer_profile_id = BillForwardTest::AUTHORIZE_NET_CUSTOMER_PROFILE_ID
+		@authorize_net_customer_payment_profile_id = BillForwardTest::AUTHORIZE_NET_CUSTOMER_PAYMENT_PROFILE_ID
+		@authorize_net_card_last_4_digits = BillForwardTest::AUTHORIZE_NET_CARD_LAST_4_DIGITS
+	end
+	describe '::create' do
+		context 'account exists' do
+			context 'using Authorize.Net payment gateway' do
+				before :all do
+					@created_account = BillForward::Account.create
+					authorize_net_token = BillForward::AuthorizeNetToken.new({
+						'accountID' => @created_account.id,
+						'customerProfileID' => @authorize_net_customer_profile_id,
+						'customerPaymentProfileID' => @authorize_net_customer_payment_profile_id,
+						'lastFourDigits' => @authorize_net_card_last_4_digits,
+						})
+
+					@created_token = BillForward::AuthorizeNetToken.create(authorize_net_token)
+				end
+				subject (:token) { @created_token }
+				subject (:account) { @created_account }
+				it 'creates a payment method' do
+					payment_method = BillForward::PaymentMethod.new({
+						'accountID' => account.id,
+						'linkID' => token.id,
+						'name' => 'Authorize.Net',
+						'description' => 'Pay via Authorize.Net',
+						'gateway' => 'authorizeNet',
+						'userEditable' => 0,
+						'priority' => 100,
+						'reusable' => 1,
+						})
+					created_payment_method = BillForward::PaymentMethod::create(payment_method)
+
+					expect(created_payment_method['@type']).to eq(BillForward::PaymentMethod.resource_path.entity_name)
+				end
+			end
+		end
+	end
+end

data/spec/functional/bad_citizen/situational/subscription_chargeable_spec.rb

@@ -0,0 +1,255 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "..", "spec_helper")
+
+describe BillForward::Subscription do
+	before :all do
+		@client = BillForwardTest::TEST_CLIENT
+		BillForward::Client.default_client = @client
+
+		# Authorize.Net credentials used to test adding a payment gateway
+		@authorize_net_login_id = BillForwardTest::AUTHORIZE_NET_LOGIN_ID
+		@authorize_net_transaction_key = BillForwardTest::AUTHORIZE_NET_TRANSACTION_KEY
+
+		# Authorize.Net credentials used to test adding a payment gateway
+		@authorize_net_customer_profile_id = BillForwardTest::AUTHORIZE_NET_CUSTOMER_PROFILE_ID
+		@authorize_net_customer_payment_profile_id = BillForwardTest::AUTHORIZE_NET_CUSTOMER_PAYMENT_PROFILE_ID
+		@authorize_net_card_last_4_digits = BillForwardTest::AUTHORIZE_NET_CARD_LAST_4_DIGITS
+	end
+	context 'upon creating required entities for chargeable Subscription' do
+		before :all do
+			# get our organisation
+			organisations = BillForward::Organisation.get_mine
+			first_org = organisations.first
+
+
+			# remove from our organisation all existing AuthorizeNetConfigurations (if any)
+			filtered = first_org.apiConfigurations.reject do |config|
+				config['@type'] == 'AuthorizeNetConfiguration'
+			end
+			first_org.apiConfigurations = filtered
+
+
+			# add to our organisation: a new AuthorizeNetConfiguration
+			first_org.apiConfigurations.push BillForward::APIConfiguration.new({
+				 "@type" =>          "AuthorizeNetConfiguration",
+			     "APILoginID" =>     @authorize_net_login_id,
+			     "transactionKey" => @authorize_net_transaction_key,
+			     "environment" =>    "Sandbox"
+				})
+			updated_org = first_org.save
+
+
+			# create an account
+			# requires (optionally):
+			# - profile
+			# - - addresses
+			addresses = Array.new()
+			addresses.push(
+				BillForward::Address.new({
+				'addressLine1' => 'address line 1',
+			    'addressLine2' => 'address line 2',
+			    'addressLine3' => 'address line 3',
+			    'city' => 'London',
+			    'province' => 'London',
+			    'country' => 'United Kingdom',
+			    'postcode' => 'SW1 1AS',
+			    'landline' => '02000000000',
+			    'primaryAddress' => true
+				}))
+			profile = BillForward::Profile.new({
+				'email' => 'always@testing.is.moe',
+				'firstName' => 'Test',
+				'addresses' => addresses
+				})
+			account = BillForward::Account.new({
+				'profile' => profile
+				})
+			created_account = BillForward::Account.create account
+
+
+			# create for our account: a tokenized card from Authorize.Net
+			authorize_net_token = BillForward::AuthorizeNetToken.new({
+				'accountID' => created_account.id,
+				'customerProfileID' => @authorize_net_customer_profile_id,
+				'customerPaymentProfileID' => @authorize_net_customer_payment_profile_id,
+				'lastFourDigits' => @authorize_net_card_last_4_digits,
+				})
+			created_token = BillForward::AuthorizeNetToken.create(authorize_net_token)
+
+
+			# create for our account: a new payment method, using Authorize.Net token
+			payment_method = BillForward::PaymentMethod.new({
+				'accountID' => created_account.id,
+				'linkID' => created_token.id,
+				'name' => 'Authorize.Net',
+				'description' => 'Pay via Authorize.Net',
+				'gateway' => 'authorizeNet',
+				'userEditable' => 0,
+				'priority' => 100,
+				'reusable' => 1,
+				})
+			created_payment_method = BillForward::PaymentMethod::create(payment_method)
+
+
+			# create a unit of measure
+			unit_of_measure = BillForward::UnitOfMeasure.new({
+				'name' => 'Devices',
+				'displayedAs' => 'Devices',
+				'roundingScheme' => 'UP',
+				})
+			created_uom = BillForward::UnitOfMeasure.create(unit_of_measure)
+
+
+			# create a product
+			product = BillForward::Product.new({
+				'productType' => 'non-recurring',
+				'state' => 'prod',
+				'name' => 'Month of Paracetamoxyfrusebendroneomycin',
+				'description' => 'It can cure the common cold and being struck by lightning',
+				'durationPeriod' => 'days',
+				'duration' => 28,
+				})
+			created_product = BillForward::Product::create(product)
+
+
+			# make product rate plan..
+			# requires:
+			# - product,
+			# - pricing components..
+			# .. - which require pricing component tiers
+
+			# create tiers..
+			# for a flat pricing component:
+			tiers_for_flat_component_1 = Array.new()
+			tiers_for_flat_component_1.push(
+				BillForward::PricingComponentTier.new({
+					'lowerThreshold' => 1,
+					'upperThreshold' => 1,
+					'pricingType' => 'fixed',
+					'price' => 1,
+				}))
+
+			# for a tiered pricing component:
+			tiers_for_tiered_component_1 = Array.new()
+			tiers_for_tiered_component_1.push(
+				BillForward::PricingComponentTier.new({
+					'lowerThreshold' => 1,
+					'upperThreshold' => 1,
+					'pricingType' => 'fixed',
+					'price' => 10,
+				}),
+				BillForward::PricingComponentTier.new({
+					'lowerThreshold' => 2,
+					'upperThreshold' => 10,
+					'pricingType' => 'unit',
+					'price' => 5
+				}),
+				BillForward::PricingComponentTier.new({
+					'lowerThreshold' => 11,
+					'upperThreshold' => 100,
+					'pricingType' => 'unit',
+					'price' => 2
+				}))
+
+
+			# create pricing components, based on these tiers
+			pricing_components = Array.new()
+			pricing_components.push(
+				BillForward::PricingComponent.new({
+					'@type' => 'flatPricingComponent',
+					'chargeModel' => 'flat',
+					'name' => 'Devices used, fixed',
+					'description' => 'How many devices you use, I guess',
+					'unitOfMeasureID' => created_uom.id,
+					'chargeType' => 'subscription',
+					'upgradeMode' => 'immediate',
+					'downgradeMode' => 'immediate',
+					'defaultQuantity' => 1,
+					'tiers' => tiers_for_flat_component_1
+				}),
+				BillForward::PricingComponent.new({
+					'@type' => 'tieredPricingComponent',
+					'chargeModel' => 'tiered',
+					'name' => 'Devices used, tiered',
+					'description' => 'How many devices you use, but with a tiering system',
+					'unitOfMeasureID' => created_uom.id,
+					'chargeType' => 'subscription',
+					'upgradeMode' => 'immediate',
+					'downgradeMode' => 'immediate',
+					'defaultQuantity' => 10,
+					'tiers' => tiers_for_tiered_component_1
+				}))
+
+
+			# create product rate plan, using pricing components and product
+			prp = BillForward::ProductRatePlan.new({
+				'currency' => 'USD',
+				'name' => 'A sound plan',
+				'pricingComponents' => pricing_components,
+				'productID' => created_product.id,
+				})
+			created_prp = BillForward::ProductRatePlan.create(prp)
+
+
+			# create references for tests to use
+			@created_account = created_account
+			@created_prp = created_prp
+			@created_payment_method = created_payment_method
+			@updated_org = updated_org
+		end
+		subject(:account) { @created_account }
+		subject(:prp) { @created_prp }
+		subject(:payment_method) { @created_payment_method }
+		subject(:organisation) { @updated_org }
+		describe '::create' do
+			it 'creates Subscription' do
+				# make subscription..
+				# requires:
+				# - account [we have this already]
+				# - product rate plan [we have this already]
+				# - pricing component value instances (for every pricing component on the PRP)
+				# - payment method subscription links (for every payment method on the account)
+
+				# create PaymentMethodSubscriptionLink from payment method and organisation
+				payment_method_subscription_links = Array.new
+				payment_method_subscription_links.push(
+					BillForward::PaymentMethodSubscriptionLink.new({
+						'paymentMethodID' => payment_method.id,
+						'organizationID' => organisation.id,
+					}))
+
+
+				pricing_components = prp.pricingComponents
+				# get references to each pricing component we made
+				flat_pricing_component_1 = pricing_components[0]
+				tiered_pricing_component_1 = pricing_components[1]
+
+				# create PricingComponentValue instances for every PricingComponent on the PRP
+				pricing_component_values = Array.new
+				pricing_component_values.push(
+					BillForward::PricingComponentValue.new({
+						'pricingComponentID' => flat_pricing_component_1.id,
+						'value' => 1,
+					}),
+					BillForward::PricingComponentValue.new({
+						'pricingComponentID' => tiered_pricing_component_1.id,
+						'value' => 5,
+					}))
+
+
+				# create subscription
+				subscription = BillForward::Subscription.new({
+					'type' =>                           'Subscription',
+					'productRatePlanID' =>              prp.id,
+					'accountID' =>                      account.id,
+					'name' =>                           'Memorable Subscription',
+					'description' =>                    'Memorable Subscription Description',
+					'paymentMethodSubscriptionLinks' => payment_method_subscription_links,
+					'pricingComponentValues' =>         pricing_component_values
+					})
+				created_sub = BillForward::Subscription.create(subscription)
+
+				expect(created_sub['@type']).to eq(BillForward::Subscription.resource_path.entity_name)
+			end
+		end
+	end
+end

data/spec/functional/bad_citizen/subscription_spec.rb

@@ -0,0 +1,179 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "spec_helper")
+# we want unique numbers to test updates with
+require 'SecureRandom'
+
+describe BillForward::Subscription do
+	before :all do
+		@client = BillForwardTest::TEST_CLIENT
+		BillForward::Client.default_client = @client
+	end
+	describe '::get_by_account_id' do
+		context 'an account exists' do
+			before :all do
+				created_account = BillForward::Account.create
+
+
+				# create references for tests to use
+				@created_account = created_account
+			end
+			context 'all entities required for a subscription exist' do
+				before :all do
+					# create a unit of measure
+					unit_of_measure = BillForward::UnitOfMeasure.new({
+						'name' => 'Devices',
+						'displayedAs' => 'Devices',
+						'roundingScheme' => 'UP',
+						})
+					created_uom = BillForward::UnitOfMeasure.create(unit_of_measure)
+
+
+					# create a product
+					product = BillForward::Product.new({
+						'productType' => 'non-recurring',
+						'state' => 'prod',
+						'name' => 'Month of Paracetamoxyfrusebendroneomycin',
+						'description' => 'It can cure the common cold and being struck by lightning',
+						'durationPeriod' => 'minutes',
+						'duration' => 1,
+						})
+					created_product = BillForward::Product::create(product)
+
+
+					# make product rate plan..
+					# requires:
+					# - product,
+					# - pricing components, which require..
+					# .. - pricing component tiers
+					# .. - and unit of measure
+
+					# create tiers..
+					# for a flat pricing component:
+					tiers_for_flat_component_1 = Array.new()
+					tiers_for_flat_component_1.push(
+						BillForward::PricingComponentTier.new({
+							'lowerThreshold' => 1,
+							'upperThreshold' => 1,
+							'pricingType' => 'fixed',
+							'price' => 1,
+						}))
+
+					# for a tiered pricing component:
+					tiers_for_tiered_component_1 = Array.new()
+					tiers_for_tiered_component_1.push(
+						BillForward::PricingComponentTier.new({
+							'lowerThreshold' => 1,
+							'upperThreshold' => 1,
+							'pricingType' => 'fixed',
+							'price' => 10,
+						}),
+						BillForward::PricingComponentTier.new({
+							'lowerThreshold' => 2,
+							'upperThreshold' => 10,
+							'pricingType' => 'unit',
+							'price' => 5
+						}),
+						BillForward::PricingComponentTier.new({
+							'lowerThreshold' => 11,
+							'upperThreshold' => 100,
+							'pricingType' => 'unit',
+							'price' => 2
+						}))
+
+
+					# create pricing components, based on these tiers
+					pricing_components = Array.new()
+					pricing_components.push(
+						BillForward::PricingComponent.new({
+							'@type' => 'flatPricingComponent',
+							'chargeModel' => 'flat',
+							'name' => 'Devices used, fixed',
+							'description' => 'How many devices you use, I guess',
+							'unitOfMeasureID' => created_uom.id,
+							'chargeType' => 'subscription',
+							'upgradeMode' => 'immediate',
+							'downgradeMode' => 'immediate',
+							'defaultQuantity' => 1,
+							'tiers' => tiers_for_flat_component_1
+						}),
+						BillForward::PricingComponent.new({
+							'@type' => 'tieredPricingComponent',
+							'chargeModel' => 'tiered',
+							'name' => 'Devices used, tiered',
+							'description' => 'How many devices you use, but with a tiering system',
+							'unitOfMeasureID' => created_uom.id,
+							'chargeType' => 'usage',
+							'upgradeMode' => 'immediate',
+							'downgradeMode' => 'immediate',
+							'defaultQuantity' => 10,
+							'tiers' => tiers_for_tiered_component_1
+						}))
+
+
+					# create product rate plan, using pricing components and product
+					prp = BillForward::ProductRatePlan.new({
+						'currency' => 'USD',
+						'name' => 'A sound plan',
+						'pricingComponents' => pricing_components,
+						'productID' => created_product.id,
+						})
+					created_prp = BillForward::ProductRatePlan.create(prp)
+
+
+					# create references for tests to use
+					@created_prp = created_prp
+				end
+				context 'a subscription exists for the account' do
+					before :all do
+						# make subscription..
+						# requires:
+						# - account [we have this already]
+						# - product rate plan [we have this already]
+						# - pricing component value instances (for every pricing component on the PRP)
+
+
+						pricing_components = @created_prp.pricingComponents
+						# get references to each pricing component we made
+						flat_pricing_component_1 = pricing_components[0]
+						tiered_pricing_component_1 = pricing_components[1]
+
+						# create PricingComponentValue instances for every PricingComponent on the PRP
+						pricing_component_values = Array.new
+						pricing_component_values.push(
+							BillForward::PricingComponentValue.new({
+								'pricingComponentID' => flat_pricing_component_1.id,
+								'value' => 1,
+							}),
+							BillForward::PricingComponentValue.new({
+								'pricingComponentID' => tiered_pricing_component_1.id,
+								'value' => 5,
+							}))
+
+
+						# create subscription
+						subscription = BillForward::Subscription.new({
+							'type' =>                           'Subscription',
+							'productRatePlanID' =>              @created_prp.id,
+							'accountID' =>                      @created_account.id,
+							'name' =>                           'Memorable Subscription',
+							'description' =>                    'Memorable Subscription Description',
+							'pricingComponentValues' =>         pricing_component_values
+							})
+						created_sub = BillForward::Subscription.create(subscription)
+
+
+						# create references for tests to use
+						@created_sub = created_sub
+					end
+					subject (:account) { @created_account }
+					subject (:subscription) { @created_sub }
+					describe 'the subscription' do
+						it 'can be gotten' do
+							subscriptions = BillForward::Subscription.get_by_account_id(account.id)
+							expect(subscriptions.first.id).to eq(subscription.id)
+						end
+					end
+				end
+			end
+		end
+	end
+end