bill_forward 1.2014.296

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/dictionaries
+.rakeTasks
+onelinechange.bat
+twolinechange.bat
+spec/test_constants.rb

data/.idea/.name

@@ -0,0 +1 @@
+bill_forward_api_client

data/.idea/compiler.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="CompilerConfiguration">
+    <option name="DEFAULT_COMPILER" value="Javac" />
+    <resourceExtensions />
+    <wildcardResourcePatterns>
+      <entry name="!?*.java" />
+      <entry name="!?*.form" />
+      <entry name="!?*.class" />
+      <entry name="!?*.groovy" />
+      <entry name="!?*.scala" />
+      <entry name="!?*.flex" />
+      <entry name="!?*.kt" />
+      <entry name="!?*.clj" />
+    </wildcardResourcePatterns>
+    <annotationProcessing>
+      <profile default="true" name="Default" enabled="false">
+        <processorPath useClasspath="true" />
+      </profile>
+    </annotationProcessing>
+  </component>
+</project>
+

data/.idea/copyright/profiles_settings.xml

@@ -0,0 +1,3 @@
+<component name="CopyrightManager">
+  <settings default="" />
+</component>

data/.idea/encodings.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" useUTFGuessing="true" native2AsciiForPropertiesFiles="false" />
+</project>
+

data/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,11 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0" is_locked="false">
+    <option name="myName" value="Project Default" />
+    <option name="myLocal" value="false" />
+    <inspection_tool class="LoggerInitializedWithForeignClass" enabled="false" level="WARNING" enabled_by_default="false">
+      <option name="loggerClassName" value="org.apache.log4j.Logger,org.slf4j.LoggerFactory,org.apache.commons.logging.LogFactory,java.util.logging.Logger" />
+      <option name="loggerFactoryMethodName" value="getLogger,getLogger,getLog,getLogger" />
+    </inspection_tool>
+    <inspection_tool class="RubyQuotedStringsInspection" enabled="false" level="WEAK WARNING" enabled_by_default="false" />
+  </profile>
+</component>

data/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,7 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="PROJECT_PROFILE" value="Project Default" />
+    <option name="USE_PROJECT_PROFILE" value="true" />
+    <version value="1.0" />
+  </settings>
+</component>

data/.idea/misc.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_6" assert-keyword="true" jdk-15="true" project-jdk-name="ruby-2.0.0-p451" project-jdk-type="RUBY_SDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+  <component name="masterDetails">
+    <states>
+      <state key="ProjectJDKs.UI">
+        <settings>
+          <last-edited>1.7</last-edited>
+          <splitter-proportions>
+            <option name="proportions">
+              <list>
+                <option value="0.2" />
+              </list>
+            </option>
+          </splitter-proportions>
+        </settings>
+      </state>
+    </states>
+  </component>
+</project>
+

data/.idea/modules.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/bill_forward_api_client.iml" filepath="$PROJECT_DIR$/bill_forward_api_client.iml" />
+    </modules>
+  </component>
+</project>
+

data/.idea/scopes/scope_settings.xml

@@ -0,0 +1,5 @@
+<component name="DependencyValidationManager">
+  <state>
+    <option name="SKIP_IMPORT_STATEMENTS" value="false" />
+  </state>
+</component>

data/.idea/vcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bill_forward.gemspec
+gemspec
+
+gem 'rest-client', '~> 1.6.8'
+gem 'json', '~> 1.8.1'
+gem 'require_all'
+gem 'activesupport', '>= 3.1.0', '< 4'

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 BillForward, Inc
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,227 @@
+# BillForwardApiClient
+
+This client library provides (via Ruby) easy access to the BillForward API.
+
+## Installation
+
+Add this line to your application's Gemfile and run `bundle`:
+
+```ruby
+gem 'bill_forward', :git => 'git@github.com:billforward/bf-ruby.git', :branch => 'master'
+```
+
+Or install this source as a local gem using:
+
+```bash
+bundle
+gem build bill_forward.gemspec
+gem install bill_forward
+```
+
+## Usage
+### Including the Gem
+
+Once installed, require the BillForward gem:
+
+```ruby
+require 'bill_forward'
+```
+
+### Getting Credentials
+You will need an API token. First log into your [Sandbox account](https://app-sandbox.billforward.net/login/#/) ([register](https://app-sandbox.billforward.net/register/#/) if necessary).
+
+Then [generate an API token](https://app-sandbox.billforward.net/setup/#/personal/api-keys).
+
+We support also client-id and client-secret authentication. For details, please [contact BillForward support](http://www.billforward.net/contact-us/).
+
+### Connecting
+
+Create a default Client. Requests will be sent using its credentials:
+
+```ruby
+my_client = BillForward::Client.new(
+    :host =>      "API URL goes here",
+    :api_token => "API token goes here"
+)
+BillForward::Client.default_client = my_client
+```
+
+### Invocation
+
+##### Getting single entities:
+
+e.g. Get Subscription by ID:
+
+```ruby
+subscription = BillForward::Subscription.get_by_id '3C39A79F-777E-4BDF-BDDC-221652F74E9D'
+puts subscription
+```
+
+##### Accessing entity variables:
+
+The entity can be accessed as a HashWithIndifferentAccess, or as an array.
+
+```ruby
+# The following are equivalent:
+puts subscription.id
+puts subscription['id']
+puts subscription[:id]
+```
+
+##### Getting a list of entities:
+
+e.g. List Accounts
+
+```ruby
+query_params = {
+	'records'  => 3,
+	'order_by' => 'created',
+	'order'    => 'ASC'
+}
+accounts = BillForward::Account.get_all query_params
+puts accounts
+```
+
+##### Creating an entity:
+
+e.g. Create simple Account
+
+```ruby
+created_account = BillForward::Account.create
+```
+
+e.g. Create complex Account
+
+```ruby
+# Create an account with a profile (where the profile has 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
+puts created_account
+```
+
+##### Updating an entity
+
+```ruby
+gotten_account = BillForward::Account.get_by_id '908AF77A-0E5D-4D80-9B91-31EDE9962BF6'
+gotten_account.profile.email = 'sometimes@testing.is.moe'
+updated_account = gotten_account.save() # or: gotten_account.profile.save()
+puts updated_account
+```
+
+## Development
+### Building
+Clone the source, then run `bundle`.
+```bash
+bundle
+```
+If ever you add a new dependency, you will need to run this again.
+
+To install the gem, run:
+```ruby
+gem build bill_forward.gemspec
+gem install bill_forward
+```
+
+### Running tests
+Development is decidedly test-driven.
+
+We use RSpec for testing.
+
+Run offline tests with:
+```bash
+rake
+```
+
+If you wish to run online tests also, you will need to declare some test constants. Create a file `test_constants.rb` in the directory `spec/`, containing the following declarations:
+
+```ruby
+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"
+end
+```
+
+Run main functional tests + offline tests with:
+```bash
+rake spec_main
+```
+
+There are further tests still that can be run, but these are situational -- for example, they require an invoice to exist already, or require credentials to be declared for a payment gateway.
+
+You can specify constants for use in situational tests in the usual test constants file, as before:
+
+```ruby
+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
+end
+```
+
+Run main functional tests + offline tests + situational tests with:
+```bash
+rake spec_all
+```

data/Rakefile

@@ -0,0 +1,73 @@
+require "bundler/gem_tasks"
+
+begin
+	require 'rspec/core/rake_task'
+
+	# these specs test syntax and language features
+	syntax_specs = FileList['spec/syntax/*_spec.rb']
+	# these specs use mocking to test entities without calling a real API
+	component_specs = FileList['spec/component/*_spec.rb']
+	# these specs call the API, but in a read-only manner
+	functional_good_citizen_specs = FileList['spec/functional/*_spec.rb']
+	# these specs call the API, leaving lasting side-effects
+	functional_bad_citizen_specs = FileList['spec/functional/bad_citizen/*_spec.rb']
+	# these specs call the API, and also require prior setup (for example, ensure an invoice exists beforehand)
+	# we do not consider these part of the main run, as they're particularly bad citizens
+	functional_situational_specs = FileList['spec/functional/bad_citizen/situational/*_spec.rb']
+
+	# offline tests
+	fast_specs = FileList[]
+	fast_specs.concat(syntax_specs)
+	fast_specs.concat(component_specs)
+
+	# offline tests + main functional run
+	main_specs = FileList[]
+	main_specs.concat(fast_specs)
+	puts functional_good_citizen_specs
+	main_specs.concat(functional_good_citizen_specs)
+	main_specs.concat(functional_bad_citizen_specs)
+
+	# offline tests + main functional run + situational functional
+	all_specs = FileList[]
+	all_specs.concat(main_specs)
+	all_specs.concat(functional_situational_specs)
+	
+
+	RSpec::Core::RakeTask.new(:spec_offline) do |t|
+		spec_files = FileList[]
+		spec_files.concat(fast_specs)
+
+		# trick t.pattern into accepting a list of files (otherwise deprecated)
+		# otherwise globbing does not work on Windows (only first file is matched)
+		t.pattern = spec_files
+
+		t.rspec_opts = "--color --format documentation"
+	end
+
+	RSpec::Core::RakeTask.new(:spec_main) do |t|
+		spec_files = FileList[]
+		spec_files.concat(main_specs)
+
+		# trick t.pattern into accepting a list of files (otherwise deprecated)
+		# otherwise globbing does not work on Windows (only first file is matched)
+		t.pattern = spec_files
+
+		t.rspec_opts = "--color --format documentation"
+	end
+
+	RSpec::Core::RakeTask.new(:spec_all) do |t|
+		spec_files = FileList[]
+		spec_files.concat(all_specs)
+
+		# trick t.pattern into accepting a list of files (otherwise deprecated)
+		# otherwise globbing does not work on Windows (only first file is matched)
+		t.pattern = spec_files
+
+		t.rspec_opts = "--color --format documentation"
+	end
+
+	# Make 'Rspec test run' the default task
+	task :default => :spec_offline
+rescue LoadError
+	# no rspec available
+end