bill_forward 1.2014.296

data/spec/functional/bad_citizen/subscription_with_credit_spec.rb

@@ -0,0 +1,240 @@
+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
+	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
+
+
+			# 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 new payment method, using credit notes
+			payment_method = BillForward::PaymentMethod.new({
+				'accountID' => created_account.id,
+				'name' => 'Credit Notes',
+				'description' => 'Pay using credit',
+				# engines will link this to an invoice once paid, for the sake of refunds
+				'linkID' => '',
+				'gateway' => 'credit_note',
+				'userEditable' => 0,
+				'priority' => 100,
+				'reusable' => 1
+				})
+			created_payment_method = BillForward::PaymentMethod::create(payment_method)
+
+
+			# issue $100 credit to our account
+			credit_note = BillForward::CreditNote.new({
+				"accountID" => created_account.id,
+			    "nominalValue" => 100,
+			    "currency" => "USD"
+				})
+			created_credit_note = BillForward::CreditNote.create(credit_note)
+
+
+			# 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
+
+			# 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_account = created_account
+			@created_prp = created_prp
+			@created_payment_method = created_payment_method
+		end
+		describe '::create' do
+			describe 'the subscription' 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)
+					# - 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' => @created_payment_method.id
+						}))
+
+
+					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',
+						'paymentMethodSubscriptionLinks' => payment_method_subscription_links,
+						'pricingComponentValues' =>         pricing_component_values
+						})
+					created_sub = BillForward::Subscription.create(subscription)
+
+					# create references for tests to use
+					@created_sub = created_sub
+				end
+				subject(:subscription) { @created_sub }
+				it 'is created' do
+					expect(subscription['@type']).to eq(BillForward::Subscription.resource_path.entity_name)
+				end
+				it 'can be gotten' do
+					gotten_subscription = BillForward::Subscription.get_by_id(subscription.id)
+					expect(gotten_subscription['@type']).to eq(BillForward::Subscription.resource_path.entity_name)
+				end
+				it 'can be activated' do
+					expect(subscription['state']).to eq('Provisioned')
+					updated_subscription = subscription.activate
+
+					expect(updated_subscription['state']).to eq('AwaitingPayment')
+				end
+			end
+		end
+	end
+end

data/spec/functional/bad_citizen/unit_of_measure_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "spec_helper")
+
+describe BillForward::UnitOfMeasure do
+	before :all do
+		@client = BillForwardTest::TEST_CLIENT
+		BillForward::Client.default_client = @client
+	end
+	describe '::create' do
+		it 'creates a UnitOfMeasure' do
+			unit_of_measure = BillForward::UnitOfMeasure.new({
+				'name' => 'Devices',
+				'displayedAs' => 'Devices',
+				'roundingScheme' => 'UP',
+				})
+			created_uom = BillForward::UnitOfMeasure.create(unit_of_measure)
+			
+			expect(created_uom['@type']).to eq(BillForward::UnitOfMeasure.resource_path.entity_name)
+		end
+	end
+end

data/spec/functional/billing_entity_spec.rb

@@ -0,0 +1,22 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "spec_helper")
+
+describe BillForward::BillingEntity do
+	before :all do
+		@client = BillForwardTest::TEST_CLIENT
+		BillForward::Client.default_client = @client
+	end
+	describe '::get_all' do
+		context 'with query parameters' do
+			it "should allow number of records to be specified" do
+				# ensure that at least one account exists in addition to our login
+				BillForward::Account.create
+
+				records = BillForward::Account.get_all({
+					'records' => 1
+					})
+
+				expect(records.length).to eq(1)
+			end
+		end
+	end
+end

data/spec/functional/client_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "spec_helper")
+
+describe BillForward::Client do
+	describe '#new' do
+		before :all do
+			@client = BillForwardTest::TEST_CLIENT
+			BillForward::Client.default_client = @client
+		end
+		it "should find empty results upon looking up non-existent ID" do
+			account_id = "nonexist"
+
+			expect{BillForward::Account.get_by_id account_id}.to raise_error(IndexError)
+		end
+		it "should raise upon bad token" do
+			host=@client.host
+			token="badtoken"
+			dudclient = BillForward::Client.new(
+			    :host => host,
+			    :api_token => token
+				)
+			expect{BillForward::Organisation.get_mine(nil,dudclient)}.to raise_error(BillForward::ApiAuthorizationError)
+		end
+	end
+end

data/spec/functional/organisation_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "spec_helper")
+
+describe BillForward::Account do
+	before :all do
+		@client = BillForwardTest::TEST_CLIENT
+		BillForward::Client.default_client = @client
+	end
+	describe '::get_all' do
+		it 'raises permissions error' do
+			# 'admin' privilege is insufficient to see other organisations
+			expect{BillForward::Organisation::get_all}.to raise_error(BillForward::ApiError, /415/)
+			# TODO: consider that API v219 (at least) gives instead:
+			# ====
+	  #      400 API Error.
+	  #      Type: PermissionsError
+	  #      Message: Access is denied
+	  #      ====
+		end
+	end
+	describe '::get_mine' do
+		it "should find organisations" do
+			organisations = BillForward::Organisation.get_mine
+			organisations_first = organisations.first
+
+			expect(organisations_first['@type']).to eq(BillForward::Organisation.resource_path.entity_name)
+		end
+	end
+end

data/spec/setup_test_constants.rb

@@ -0,0 +1,73 @@
+# constants include BillForward credentials, required for running functional tests.
+# this file, ignored from version control, allows users to specify credentials for a test account
+test_constants_file = File.join(File.expand_path(File.dirname(__FILE__)), "test_constants.rb")
+if (File.exist?(test_constants_file))
+	puts "using test constants from #{test_constants_file}"
+	require test_constants_file
+else
+	puts 'using default test constants'
+	# The following is a template for what your 'test_constants.rb' should contain.
+	# If used in this placeholder state, functional tests will not pass.
+	module BillForwardTest
+		BILLFORWARD_API_HOST='insert-API-URL-here'
+		BILLFORWARD_API_TOKEN="insert-access-token-here OR leave-blank-for-OAUTH"
+
+		### alternatively:
+		# (these values are used if you leave API token blank)
+		# authenticate using OAUTH:
+		BILLFORWARD_USERNAME="insert-username"
+		BILLFORWARD_PASSWORD="insert-password"
+		BILLFORWARD_CLIENT_ID="insert-client-id"
+		BILLFORWARD_CLIENT_SECRET="insert-client-secret"
+
+
+		# ---- Enable logging if you want (shows request and response bodies)
+		USE_LOGGING=false
+
+
+		# ---- Enable proxy if you want (for example to see requests in Fiddler)
+		CLIENT_PROXY_ENABLED=false
+		CLIENT_PROXY_URL="http://127.0.0.1:8888"
+
+
+		## These constants are required only for running situational tests (not in the main run):
+		# ---- Required for Authorize.Net gateway tests only
+		AUTHORIZE_NET_LOGIN_ID = 'FILL IN WITH AUTHORIZE NET LOGIN ID'
+		AUTHORIZE_NET_TRANSACTION_KEY = 'FILL IN WITH AUTHORIZE NET TRANSACTION KEY'
+		# ---- Required for Authorize.Net tokenization tests only
+		AUTHORIZE_NET_CUSTOMER_PROFILE_ID = 12345678 # FILL IN WITH AUTHORIZE NET CUSTOMER PROFILE ID
+		AUTHORIZE_NET_CUSTOMER_PAYMENT_PROFILE_ID = 12345678 # FILL IN WITH AUTHORIZE NET CUSTOMER PAYMENT PROFILE ID
+		AUTHORIZE_NET_CARD_LAST_4_DIGITS = 1234
+
+		
+		# ---- Required for Invoice tests only
+		USUAL_INVOICE_ID = 'FILL IN WITH EXISTING INVOICE ID'
+	end
+end
+
+# create BillForward client for use in all tests
+# requires working credentials only when running functional tests
+module BillForwardTest
+	if (BillForwardTest::BILLFORWARD_API_TOKEN == '')
+		# Authenticate using OAuth; username and password
+		TEST_CLIENT = BillForward::Client.new(
+				    :host =>          BillForwardTest::BILLFORWARD_API_HOST,
+				    :use_logging =>   BillForwardTest::USE_LOGGING,
+				    :username =>      BillForwardTest::BILLFORWARD_USERNAME,
+				    :password =>      BillForwardTest::BILLFORWARD_PASSWORD,
+				    :client_id =>     BillForwardTest::BILLFORWARD_CLIENT_ID,
+				    :client_secret => BillForwardTest::BILLFORWARD_CLIENT_SECRET,
+				    :use_proxy     => BillForwardTest::CLIENT_PROXY_ENABLED,
+				    :proxy_url =>    BillForwardTest::CLIENT_PROXY_URL
+					)
+	else
+		# Authenticate instead using access token
+		TEST_CLIENT = BillForward::Client.new(
+				    :host =>          BillForwardTest::BILLFORWARD_API_HOST,
+				    :use_logging =>   BillForwardTest::USE_LOGGING,
+				    :api_token =>     BillForwardTest::BILLFORWARD_API_TOKEN,
+				    :use_proxy     => BillForwardTest::CLIENT_PROXY_ENABLED,
+				    :proxy_url =>    BillForwardTest::CLIENT_PROXY_URL
+					)
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'bill_forward' # and any other gems you need
+
+# this file provides constants for tests to share
+require File.join(File.expand_path(File.dirname(__FILE__)), "setup_test_constants")
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/syntax/account_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "spec_helper")
+
+describe BillForward::Account do
+	describe '#new' do
+		it "provides access to client" do
+			host="http://localhost:8080/RestAPI/"
+			environment="development"
+			token="6f1f7465-fc16-4b9c-9ea0-f8c208a43ca6"
+			dudclient = BillForward::Client.new(
+			    :host => host,
+			    :environment => environment,
+			    :api_token => token
+				)
+			account = BillForward::Account.new(nil, dudclient)
+			expect(account._client.host).to eq(host)
+		end
+	end
+	describe '::resource_path' do
+		it "points to expected endpoint" do
+			resource_path = BillForward::Account.resource_path
+			expect(resource_path.path).to eq("accounts")
+		end
+	end
+end