betfair 0.0.16 → 0.0.17

data/.gitignore

@@ -5,4 +5,5 @@ pkg/*
 .rvmrc
 examples/bar.rb
 examples/doh.rb
+examples/doh_latest.rb
 examples/doh.log

data/README

@@ -44,9 +44,13 @@ as the UK.
 At the heart of the Betfair API is the `session_token`. In order to
 get one of these simply call:
 
-    session_token = bf.login('username', 'password', 82, 0, 0, nil)
+    session_token = bf.login('username', 'password', 
+                             ::Betfair::API;;PRODUCT_ID_FREE, 0, 0, nil)
 
-Username and Password are fairly obvious.
+Username and Password are fairly obvious.  The `session_token` value
+you get back responds to #success? which will tell you whether login
+was successful or not.  If `session_token.success?` returns false,
+`session_token.to_s` will give you the error message.
 
 82 is the standard Product Id, you may have a different one depending
 on the level of Betfair API access that you have.

data/lib/betfair/api.rb

@@ -15,6 +15,19 @@ module Betfair
     BET_TYPE_BACK = 'B'
 
 
+    ## Success and Failure get mixed in to API result values
+    # so that you can tell the difference easily - just call
+    # #success? on the result to find out if it worked
+    module Success
+      def success?; true; end
+    end # module Success
+
+
+    module Failure
+      def success?; false; end
+    end # module Failure
+
+
     ## API METHODS
     #
 
@@ -183,8 +196,8 @@ module Betfair
                                           :vendorSoftwareId => vendor_software_id, 
                                           :locationId       => location_id, 
                                           :ipAddress        => ip_address )
-      
-      session_token(response[:header])
+
+      return response.maybe_result( :header, :session_token )
     end
 
     #
@@ -299,7 +312,11 @@ module Betfair
 
 
       def maybe_result( *path )
-        success? ? path.inject(self){|m,r| m[r]} : format_error()
+        if success?
+          path.inject(self){|m,r| m[r]}.extend( Success )
+        else
+          format_error().extend( Failure )
+        end
       end
 
       
@@ -483,4 +500,4 @@ module Betfair
 
   end
 
-end
+end

data/lib/betfair/version.rb

@@ -1,3 +1,3 @@
 module Betfair
-  VERSION = "0.0.16"
+  VERSION = "0.0.17"
 end

data/spec/betfair/api_spec.rb

@@ -239,22 +239,41 @@ module Betfair
       @bf = Betfair::API.new
     end
 
-    describe "login success"  do
-      it "should return a session token" do
-        savon.expects(:login).returns(:success)
-        session_token = @bf.login('username', 'password', 82, 0, 0, nil).to_s
-        session_token.should be_an_instance_of(String)        
+
+    describe "login" do
+      let( :response ) { @bf.login('username', 'password', 82, 0, 0, nil) }
+      subject { response }
+
+      before do savon.expects( api_call ).returns( api_response ) end
+      
+      let( :api_call ) { :login }
+
+      describe "success"  do
+        let( :api_response ) { :success }
+
+        it { should be_a_kind_of(String) }
+        it { should be_success }
       end
-    end
 
-    describe "login fail"  do
-      it "should return an error" do
-        savon.expects(:login).returns(:fail)
-        error_code = @bf.login('username', 'password', 82, 0, 0, nil) 
-        error_code.should eq('PRODUCT_REQUIRES_FUNDED_ACCOUNT')        
+      describe "failure"  do
+        describe "with a bad product code" do
+          let( :api_response ) { :fail }
+
+          it { should match('PRODUCT_REQUIRES_FUNDED_ACCOUNT') }
+          it { should_not be_success }
+        end
+
+        describe "with a bad password" do
+          let( :api_response ) { :bad_password }
+          
+          it { should match("INVALID_USERNAME_OR_PASSWORD") }
+          it { should_not be_success }
+        end
+
       end
     end
 
+
     describe "proxy success"  do
       it "should return a session token" do
         savon.expects(:login).returns(:success)        
@@ -269,7 +288,7 @@ module Betfair
         savon.expects(:login).returns(:fail)
         proxy = 'http://localhost:8888'
         error_code = Betfair::API.new(proxy).login('username', 'password', 82, 0, 0, nil)
-        error_code.should eq('PRODUCT_REQUIRES_FUNDED_ACCOUNT')         
+        error_code.should match('PRODUCT_REQUIRES_FUNDED_ACCOUNT')         
       end
     end
 

data/spec/fixtures/login/bad_password.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 
+	       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+	       xmlns:n2="http://www.betfair.com/publicapi/types/global/v3/" 
+	       xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soap:Body>
+    <n:loginResponse xmlns:n="http://www.betfair.com/publicapi/v3/BFGlobalService/">
+      <n:Result xsi:type="n2:LoginResp">
+        <header xsi:type="n2:APIResponseHeader">
+          <errorCode xsi:type="n2:APIErrorEnum">OK</errorCode>
+          <minorErrorCode xsi:nil="1"></minorErrorCode>
+          <sessionToken xsi:nil="1"></sessionToken>
+          <timestamp xsi:type="xsd:dateTime">2012-03-13T07:44:21.422Z</timestamp>
+        </header>
+        <currency xsi:nil="1"></currency>
+        <errorCode xsi:type="n2:LoginErrorEnum">INVALID_USERNAME_OR_PASSWORD</errorCode>
+        <minorErrorCode xsi:nil="1"></minorErrorCode>
+        <validUntil xsi:type="xsd:dateTime">0001-01-01T00:00:00.000Z</validUntil>
+      </n:Result>
+    </n:loginResponse>
+  </soap:Body>
+</soap:Envelope>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: betfair
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000Z
+date: 2012-03-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &70157897063020 !ruby/object:Gem::Requirement
+  requirement: &70181452429080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70157897063020
+  version_requirements: *70181452429080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70157897062340 !ruby/object:Gem::Requirement
+  requirement: &70181452427520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157897062340
+  version_requirements: *70181452427520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70157897061740 !ruby/object:Gem::Requirement
+  requirement: &70181452426460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157897061740
+  version_requirements: *70181452426460
 - !ruby/object:Gem::Dependency
   name: savon_spec
-  requirement: &70157897061180 !ruby/object:Gem::Requirement
+  requirement: &70181452425740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157897061180
+  version_requirements: *70181452425740
 description: Gem for accessing the Betfair API.
 email:
 - lukeb@lukebyrne.com
@@ -68,7 +68,6 @@ files:
 - README
 - Rakefile
 - betfair.gemspec
-- examples/doh.log
 - examples/foo.rb
 - lib/betfair.rb
 - lib/betfair/api.rb
@@ -86,6 +85,7 @@ files:
 - spec/fixtures/get_market_prices_compressed/success.xml
 - spec/fixtures/get_mu_bets/fail.xml
 - spec/fixtures/get_mu_bets/success.xml
+- spec/fixtures/login/bad_password.xml
 - spec/fixtures/login/fail.xml
 - spec/fixtures/login/success.xml
 - spec/fixtures/place_bets/fail.xml
@@ -105,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1829796573211684180
+      hash: -4185997546867498005
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1829796573211684180
+      hash: -4185997546867498005
 requirements: []
 rubyforge_project: betfair
 rubygems_version: 1.8.10
@@ -135,6 +135,7 @@ test_files:
 - spec/fixtures/get_market_prices_compressed/success.xml
 - spec/fixtures/get_mu_bets/fail.xml
 - spec/fixtures/get_mu_bets/success.xml
+- spec/fixtures/login/bad_password.xml
 - spec/fixtures/login/fail.xml
 - spec/fixtures/login/success.xml
 - spec/fixtures/place_bets/fail.xml