fat_zebra 0.0.5 → 1.0.0

data/README.markdown

@@ -1,19 +1,58 @@
 Ruby API Library for Fat Zebra
 ==============================
 
-Further (better) readme content coming soon - I promise!
+Release 1.0.0 for API version 1.0
 
-General Usage:
+A Ruby client for the [Fat Zebra](https://www.fatzebra.com.au) Online Payment Gateway (for Australian Merchants)
 
- 1. Add the gem to your project (i.e. Gemfile or otherwise)
- 2. Create a new FatZebra::Gateway object, and pass it your username, token, and true or false for using test mode.
- 4. Call the purchase() method on the gateway object.
- 5. Examine the result.
+Dependencies
+------------
 
-More details to follow (structure of request/response objects etc).
+ * Ruby (tested on 1.9.2, 1.9.3)
+ * Rest Client
+ * JSON
 
-Documentation for the Fat Zebra API can be found at http://docs.fatzebra.com.au
+Installing
+----------
 
-As always, patches, pull requests, comments, issues etc welcome.
+    gem install fat_zebra
 
-For support please visit https://www.fatzebra.com.au/help or email support@fatzebra.com.au
+Or in a Rails App (or similar, with Bundler), in your Gemfile:
+
+    gem "fat_zebra"
+
+Usage
+-----
+
+```ruby
+require 'fat_zebra'
+
+gateway = FatZebra::Gateway.new("TEST", "TEST", "gateway.sandbox.fatzebra.com.au") # You can ommit the last parameter - by default it will use the Live Gateway
+
+card_data = {
+	card_number: "5123456789012346",
+	card_holder: "Bill Simpson",
+	card_expiry: "05/2013",
+	ccv: "123"
+}
+response = gateway.purchase(10000, card_data, "ORDER-23, "203.99.87.4")
+
+if response.successful? && response.result.successful
+	puts "Transaction ID: #{response.result.id}"
+else
+	abort "Error in transaction: #{response.error_messages}"
+end
+```
+
+Documentation
+-------------
+
+Full API reference can be found at http://docs.fatzebra.com.au
+
+Support
+-------
+If you have any issue with the Fat Zebra Ruby Client please contact us at support@fatzebra.com.au and we will be more then happy to help out. Alternatively you may raise an issue in github.
+
+Pull Requests
+-------------
+If you would like to contribute to the plugin please fork the project, make your changes within a feature branch and then submit a pull request. All pull requests will be reviewed as soon as possible and integrated into the main branch if deemed suitable.

data/lib/fat_zebra/constants.rb

@@ -1 +1,2 @@
-GATEWAY_SERVER = "gateway.fatzebra.com.au"
+GATEWAY_SERVER = "gateway.fatzebra.com.au"
+API_VERSION = "1.0"

data/lib/fat_zebra/gateway.rb

@@ -2,13 +2,14 @@ module FatZebra
 	class Gateway
 		attr_accessor :username, :token, :gateway_server, :options
 		
-		DEFAULT_OPTIONS = {:secure => true}
+		DEFAULT_OPTIONS = {:secure => true, :version => API_VERSION}
 
 		# Public: initializes a new gateway object
 		#
 		# username - merchants username
 		# token - merchants token for authentication
-		# gateway_service - the server for the gateway, defaults to 'gateway.fatzebra.com.au'
+		# gateway_server - the server for the gateway, defaults to 'gateway.fatzebra.com.au'
+		# options - the options for the gateway connection (e.g. secure, version etc)
 		#
 		# Returns a new FatZebra::Gateway instance
 		def initialize(username, token, gateway_server = GATEWAY_SERVER, options = {})
@@ -189,7 +190,8 @@ module FatZebra
 			when false
 				"http://"
 			end
-			url = "#{proto}#{self.gateway_server}/#{resource}"
+			version = options[:version]
+			url = "#{proto}#{self.gateway_server}/v#{version}/#{resource}"
 			unless data.nil?
 				url = url + "?"
 				data.each do |key, value|

data/lib/fat_zebra/version.rb

@@ -1,3 +1,3 @@
 module FatZebra
-  VERSION = "0.0.5"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fat_zebra
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-27 00:00:00.000000000 Z
+date: 2012-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70248297866120 !ruby/object:Gem::Requirement
+  requirement: &70274955595520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248297866120
+  version_requirements: *70274955595520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70248297864400 !ruby/object:Gem::Requirement
+  requirement: &70274955594920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248297864400
+  version_requirements: *70274955594920
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70248297880140 !ruby/object:Gem::Requirement
+  requirement: &70274955593760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248297880140
+  version_requirements: *70274955593760
 - !ruby/object:Gem::Dependency
   name: yard-tomdoc
-  requirement: &70248297879680 !ruby/object:Gem::Requirement
+  requirement: &70274955593300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70248297879680
+  version_requirements: *70274955593300
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70248297879180 !ruby/object:Gem::Requirement
+  requirement: &70274955592760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70248297879180
+  version_requirements: *70274955592760
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70248297878720 !ruby/object:Gem::Requirement
+  requirement: &70274955496320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70248297878720
+  version_requirements: *70274955496320
 description: Provides integration with the Fat Zebra internet payment gateway (www.fatzebra.com.au),
   including purchase, refund, auth, capture and recurring billing functionality.
 email:
@@ -119,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4534837890112680284
+      hash: -164626875595423267
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4534837890112680284
+      hash: -164626875595423267
 requirements: []
 rubyforge_project: fat_zebra
 rubygems_version: 1.8.10