bill_forward 1.2014.296

data/lib/bill_forward/entities/unit_of_measure.rb

@@ -0,0 +1,5 @@
+module BillForward
+	class UnitOfMeasure < MutableEntity
+  		@resource_path = BillForward::ResourcePath.new('units-of-measure', 'unitOfMeasure')
+	end
+end

data/lib/bill_forward/insertable_entity.rb

@@ -0,0 +1,32 @@
+module BillForward
+	class InsertableEntity < BillingEntity
+		def initialize(*args)
+	      raise AbstractInstantiateError.new('This abstract class cannot be instantiated!') if self.class == InsertableEntity
+	      super
+	    end
+
+		class << self
+			# Asks API to create a real instance of specified entity,
+	 		# based on provided model.
+		    # @param options=nil [self] the Entity to create
+		    # 
+		    # @return [self] The created Entity
+			def create(entity = nil)
+				entity = self.new if entity.nil?
+				TypeCheck.verifyObj(self, entity, 'entity')
+
+				serial = entity.serialize
+				client = entity._client
+
+				route = entity.class.resource_path.path
+				endpoint = ''
+				url_full = "#{route}/#{endpoint}"
+
+				response = client.post_first(url_full, serial)
+
+				created_entity = self.new(response, client)
+				created_entity
+			end
+		end
+	end
+end

data/lib/bill_forward/mutable_entity.rb

@@ -0,0 +1,47 @@
+module BillForward
+	class MutableEntity < InsertableEntity
+		def initialize(*args)
+	      raise AbstractInstantiateError.new('This abstract class cannot be instantiated!') if self.class == MutableEntity
+	      super
+	    end
+
+		# Asks API to update existing instance of this entity,
+ 		# based on current model.
+	    # 
+	    # @return [self] The updated Entity
+		def save()
+			serial = serialize
+			client = _client
+
+			route = self.class.resource_path.path
+			endpoint = ''
+			url_full = "#{route}/#{endpoint}"
+
+			response = client.put_first(url_full, serial)
+
+			updated_entity = self.class.new(response, client)
+			updated_entity
+		end
+
+		# Asks API to retire existing instance of this entity.
+		# @note Many BillForward entities do not support RETIRE
+		# @note As-yet untested
+	    # 
+	    # @return [self] The retired Entity
+		def delete()
+			serial = serialize
+			client = _client
+
+			id = serial.id
+
+			route = self.class.resource_path.path
+			endpoint = ''
+			url_full = "#{route}/#{endpoint}#{id}"
+
+			response = client.retire_first(url_full)
+
+			retired_entity = self.class.new(response, client)
+			retired_entity
+		end
+	end
+end

data/lib/bill_forward/resource_path.rb

@@ -0,0 +1,11 @@
+module BillForward
+  class ResourcePath
+  	attr_reader :path
+  	attr_reader :entity_name
+
+  	def initialize(path, entity_name)
+  		@path = path
+  		@entity_name = entity_name
+  	end
+  end
+end

data/lib/bill_forward/type_check.rb

@@ -0,0 +1,21 @@
+module BillForward
+	class TypeCheck
+		# ensure that the provided object extends the expected class
+		def self.verifyObj(expectedClass, obj, argName)
+			expectedClassName = expectedClass.name
+			actualClassName = obj.class.name
+			raise TypeError.new("Expected instance of '#{expectedClassName}' at argument '#{argName}'. "+
+			"Instead received: '#{actualClassName}'") unless obj.kind_of?(expectedClass) || obj.kind_of?(RSpec::Mocks::Double)
+		end
+		# ensure that the provided class extends the expected class
+		def self.verifyClass(expectedClass, actualClass, argName)
+			expectedClassName = expectedClass.name
+			actualClassName = actualClass.name
+			raise TypeError.new("Expected instance of '#{expectedClassName}' at argument '#{argName}'. "+
+			"Instead received: '#{actualClassName}'") unless actualClass<=expectedClass || actualClass<=RSpec::Mocks::Double
+		end
+	end
+
+	class AbstractInstantiateError < StandardError
+	end
+end

data/lib/bill_forward/version.rb

@@ -0,0 +1,4 @@
+module BillForward
+  # in an rspec run, the gemspec and bill_forward.rb loader will both visit this
+  VERSION = "1.2014.296" unless const_defined?(:VERSION)
+end

data/spec/component/account_spec.rb

@@ -0,0 +1,200 @@
+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
+  before :each do
+    # skip OAuth request
+    allow_any_instance_of(BillForward::Client).to receive(:get_token).and_return('fake token')
+  end
+	describe '::get_by_id' do
+		context 'where account does not exist' do
+			let(:RestClient)      { double :RestClient }
+			it "gets empty list" do
+				response = double
+		    allow(response).to receive(:to_str).and_return(canned_noresults)
+		    allow(RestClient::Request).to receive(:execute).and_return(response)
+
+				expect{BillForward::Account.get_by_id 'anything'}.to raise_error(IndexError)
+			end
+  	end
+		context 'where account exists' do
+			it "gets the account" do
+        account_id = '74DA7D63-EAEB-431B-9745-76F9109FD842'
+
+				response = double
+		    allow(response).to receive(:to_str).and_return(canned_account_get)
+		    allow(RestClient::Request).to receive(:execute).and_return(response)
+
+		    account = BillForward::Account.get_by_id account_id
+
+				expect(account.id).to eq(account_id)
+			end
+		end
+	end
+  describe '::create' do
+    context 'upon creating minimal account' do
+      let(:RestClient)      { double :RestClient }
+      it "can get property" do
+        response = double
+        allow(response).to receive(:to_str).and_return(canned_account_create_minimal)
+        allow(RestClient::Request).to receive(:execute).and_return(response)
+
+        created_account = BillForward::Account.create
+        expect(created_account['@type']).to eq(BillForward::Account.resource_path.entity_name)
+      end
+    end
+    context 'upon creating account with profile' do
+      let(:RestClient)      { double :RestClient }
+      email = 'always@testing.is.moe'
+      before :each do
+        profile = BillForward::Profile.new({
+          'email' => email,
+            'firstName' => 'Test',
+          })
+        account = BillForward::Account.new({
+          'profile' => profile
+          })
+        response = double
+        allow(response).to receive(:to_str).and_return(canned_account_create_with_profile)
+        allow(RestClient::Request).to receive(:execute).and_return(response)
+
+        @created_account = BillForward::Account.create account
+      end
+      subject (:account) { @created_account }
+      it "can get property" do
+        expect(account['@type']).to eq(BillForward::Account.resource_path.entity_name)
+      end
+      it "has profile" do
+        profile = account.profile
+        expect(profile.email).to eq(email)
+      end
+    end
+  end
+end
+
+def canned_noresults
+'{
+  "executionTime": 1070093,
+  "results": []
+}'
+end
+
+def canned_account_create_with_profile
+'{
+  "results": [
+    {
+      "profile": {
+        "accountID": "5037E4EF-9DD1-4BC3-8920-425D9159C41A",
+        "updated": "2014-09-18T22:29:15.079Z",
+        "email": "always@testing.is.moe",
+        "organizationID": "F60667D7-583A-4A01-B4DC-F74CC45ACAE3",
+        "id": "C7A63931-709D-4F1A-B8F9-B5EC0E6C2D29",
+        "created": "2014-09-18T22:29:15.079Z",
+        "addresses": [
+
+        ],
+        "firstName": "Test",
+        "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60"
+      },
+      "updated": "2014-09-18T22:29:14.783Z",
+      "deleted": false,
+      "organizationID": "F60667D7-583A-4A01-B4DC-F74CC45ACAE3",
+      "id": "5037E4EF-9DD1-4BC3-8920-425D9159C41A",
+      "crmID": null,
+      "created": "2014-09-18T22:29:14.783Z",
+      "roles": [
+
+      ],
+      "paymentMethods": [
+
+      ],
+      "successfulSubscriptions": 0,
+      "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60",
+      "@type": "account"
+    }
+  ],
+  "executionTime": 647946
+}'
+end
+
+def canned_account_create_minimal
+'{
+  "results": [
+    {
+      "updated": "2014-09-18T18:27:22.258Z",
+      "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60",
+      "id": "904DAE81-B63C-4F25-86C5-E1A1CDCEEB88",
+      "@type": "account",
+      "deleted": false,
+      "successfulSubscriptions": 0,
+      "organizationID": "F60667D7-583A-4A01-B4DC-F74CC45ACAE3",
+      "crmID": null,
+      "paymentMethods": [
+
+      ],
+      "created": "2014-09-18T18:27:22.258Z",
+      "roles": [
+
+      ]
+    }
+  ],
+  "executionTime": 492653
+}'
+end
+
+def canned_account_get
+'{
+  "executionTime": 1070093,
+  "results": [
+    {
+      "successfulSubscriptions": 0,
+      "@type": "account",
+      "roles": [
+
+      ],
+      "profile": {
+        "firstName": "Test",
+        "addresses": [
+          {
+            "landline": "02000000000",
+            "addressLine3": "address line 3",
+            "addressLine2": "address line 2",
+            "addressLine1": "address line 1",
+            "country": "United Kingdom",
+            "deleted": false,
+            "city": "London",
+            "profileID": "1B07A310-8B0F-4CFA-B2CF-48D206DC79C3",
+            "id": "34B5A980-A133-4B5F-9045-F1A41F20F2D6",
+            "primaryAddress": true,
+            "province": "London",
+            "created": "2014-09-04T17:43:44Z",
+            "postcode": "SW1 1AS",
+            "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60",
+            "organizationID": "F60667D7-583A-4A01-B4DC-F74CC45ACAE3"
+          }
+        ],
+        "id": "1B07A310-8B0F-4CFA-B2CF-48D206DC79C3",
+        "updated": "2014-09-04T17:43:44Z",
+        "email": "always@testing.is.moe",
+        "created": "2014-09-04T17:43:44Z",
+        "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60",
+        "organizationID": "F60667D7-583A-4A01-B4DC-F74CC45ACAE3",
+        "accountID": "74DA7D63-EAEB-431B-9745-76F9109FD842"
+      },
+      "deleted": false,
+      "crmID": null,
+      "id": "74DA7D63-EAEB-431B-9745-76F9109FD842",
+      "updated": "2014-09-04T17:43:43Z",
+      "created": "2014-09-04T17:43:43Z",
+      "paymentMethods": [
+
+      ],
+      "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60",
+      "organizationID": "F60667D7-583A-4A01-B4DC-F74CC45ACAE3"
+    }
+  ]
+}'
+end

data/spec/component/billing_entity_spec.rb

@@ -0,0 +1,153 @@
+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
+	before :each do
+  		# skip OAuth request
+		allow_any_instance_of(BillForward::Client).to receive(:get_token).and_return('fake token')
+	end
+	context 'upon getting entity' do
+		before :each do
+			response = double
+		    allow(response).to receive(:to_str).and_return(canned_entity)
+		    allow(RestClient::Request).to receive(:execute).and_return(response)
+
+		    @entity = BillForward::Account.get_by_id 'anything'
+		end
+		subject (:entity) { @entity }
+		context 'using dot syntax' do
+			it "can get property" do
+				expect(entity.id).to eq('74DA7D63-EAEB-431B-9745-76F9109FD842')
+			end
+			it "can change property" do
+				newid = 'whatever'
+				entity.id = newid
+				expect(entity.id).to eq(newid)
+			end
+			it "can add property" do
+				value = 'whatever'
+				entity.fun = value
+				expect(entity.fun).to eq(value)
+			end
+			describe 'nested array of entities' do
+				context 'once unserialized' do
+					subject :roles do
+						roles = entity.roles
+					end
+					subject :role do
+						roles.first
+					end
+					it 'is an array' do
+						expect(roles.class).to eq(Array)
+					end
+					describe 'some element' do
+						it 'is an entity' do
+							expect(role.class).to eq(BillForward::Role)
+						end
+						it 'has expected properties' do
+							expect(role.role).to eq('user')
+						end
+						it 'has mutable properties' do
+							expect(role.role).to eq('user')
+							new_role = 'abuser'
+							role.role = new_role
+							expect(role.role).to eq(new_role)
+						end
+					end
+				end
+			end
+			describe 'nested entity' do
+				context 'once unserialized' do
+					subject :profile do
+						profile = entity.profile
+					end
+					it 'is an entity' do
+						expect(profile.class).to eq(BillForward::Profile)
+					end
+					it 'has expected properties' do
+						expect(profile.firstName).to eq('Test')
+					end
+					it 'has mutable properties' do
+						expect(profile.firstName).to eq('Test')
+						new_name = 'Best'
+						profile.firstName = new_name
+						expect(profile.firstName).to eq(new_name)
+					end
+				end
+			end
+		end
+		context 'using array access syntax' do
+			it "can get property" do
+				expect(entity['@type']).to eq('account')
+			end
+			it "can change property" do
+				newid = 'notever'
+				entity['id'] = newid
+				expect(entity['id']).to eq(newid)
+			end
+		end
+	end
+end
+
+def canned_entity
+'{
+  "executionTime": 1070093,
+  "results": [
+    {
+      "successfulSubscriptions": 0,
+      "@type": "account",
+      "roles": [
+      	{
+	      "id": "B4E623C2-2CE0-11E3-894A-FA163E717A7F",
+	      "accountID": "74DA7D63-EAEB-431B-9745-76F9109FD842",
+	      "role": "user",
+	      "created": "2014-09-04T17:43:44Z",
+	      "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60"
+	    }
+      ],
+      "profile": {
+        "firstName": "Test",
+        "addresses": [
+          {
+            "landline": "02000000000",
+            "addressLine3": "address line 3",
+            "addressLine2": "address line 2",
+            "addressLine1": "address line 1",
+            "country": "United Kingdom",
+            "deleted": false,
+            "city": "London",
+            "profileID": "1B07A310-8B0F-4CFA-B2CF-48D206DC79C3",
+            "id": "34B5A980-A133-4B5F-9045-F1A41F20F2D6",
+            "primaryAddress": true,
+            "province": "London",
+            "created": "2014-09-04T17:43:44Z",
+            "postcode": "SW1 1AS",
+            "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60",
+            "organizationID": "F60667D7-583A-4A01-B4DC-F74CC45ACAE3"
+          }
+        ],
+        "id": "1B07A310-8B0F-4CFA-B2CF-48D206DC79C3",
+        "updated": "2014-09-04T17:43:44Z",
+        "email": "always@testing.is.moe",
+        "created": "2014-09-04T17:43:44Z",
+        "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60",
+        "organizationID": "F60667D7-583A-4A01-B4DC-F74CC45ACAE3",
+        "accountID": "74DA7D63-EAEB-431B-9745-76F9109FD842"
+      },
+      "deleted": false,
+      "crmID": null,
+      "id": "74DA7D63-EAEB-431B-9745-76F9109FD842",
+      "updated": "2014-09-04T17:43:43Z",
+      "created": "2014-09-04T17:43:43Z",
+      "paymentMethods": [
+
+      ],
+      "changedBy": "7872F2F4-ED96-4038-BC82-39F7DDFECE60",
+      "organizationID": "F60667D7-583A-4A01-B4DC-F74CC45ACAE3"
+    }
+  ]
+}'
+end