bill_forward 1.2014.296 → 1.2015.183

data/lib/bill_forward/insertable_entity.rb

@@ -1,32 +1,22 @@
-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
+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')
+
+				self.request_first('post', '', entity, nil, entity._client)
+			end
+		end
+	end
 end

data/lib/bill_forward/mutable_entity.rb

@@ -1,47 +1,27 @@
-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
+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()
+			self.class.request_first('put', '', self, nil, _client)
+		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()
+			self.class.request_first('delete', '', nil, _client)
+		end
+
+		alias_method :retire, :delete
+	end
 end

data/lib/bill_forward/resource_path.rb

@@ -1,11 +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
+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

@@ -1,21 +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
+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) || (defined?(RSpec) && 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 || (defined?(RSpec) && actualClass<=RSpec::Mocks::Double)
+		end
+	end
+
+	class AbstractInstantiateError < StandardError
+	end
 end

data/lib/bill_forward/version.rb

@@ -1,4 +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
+module BillForward
+  # in an rspec run, the gemspec and bill_forward.rb loader will both visit this
+  VERSION = "1.2015.183" unless const_defined?(:VERSION)
+end

data/lib/bill_forward.rb

@@ -1,18 +1,18 @@
-require 'rest-client'
-require 'json'
-# used for escaping query parameters
-require 'erb'
-
-# Rails extensions
-# 'indifferent hashes' are used to enable string access to entities unserialized with symbol keys
-require 'active_support/core_ext/hash/indifferent_access'
-# we need ordered hashes because API requires '@type' to be first key in object
-require 'active_support/ordered_hash'
-# provides 'blank?' function
-require 'active_support/core_ext/string'
-
-# requirer that negotiates dependency order, relative pathing
-require 'require_all'
-
-# require all ruby files in relative directory 'bill_forward' and all its subdirectories
+require 'rest-client'
+require 'json'
+# used for escaping query parameters
+require 'erb'
+
+# Rails extensions
+# 'indifferent hashes' are used to enable string access to entities unserialized with symbol keys
+require 'active_support/core_ext/hash/indifferent_access'
+# we need ordered hashes because API requires '@type' to be first key in object
+require 'active_support/ordered_hash'
+# provides 'blank?' function
+require 'active_support/core_ext/string'
+
+# requirer that negotiates dependency order, relative pathing
+require 'require_all'
+
+# require all ruby files in relative directory 'bill_forward' and all its subdirectories
 require_rel 'bill_forward'

data/scratch/Gemfile

@@ -0,0 +1,9 @@
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.3')
+  gem 'i18n', '< 0.7'
+  gem 'rest-client', '~> 1.6.8'
+  gem 'activesupport', '~> 3.2'
+else
+  gem 'activesupport'
+end
+
+gem 'bill_forward', :path => '../'

data/scratch/scratch.example.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'bill_forward'
+
+my_client = BillForward::Client.new(
+    :host =>      "API URL goes here",
+    :api_token => "API token goes here"
+)
+BillForward::Client.default_client = my_client

data/spec/component/account_spec.rb

@@ -1,200 +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"
-    }
-  ]
-}'
+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