betfair-ng 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8107993206e732bc2b21302b0e60e5ea4d704461
-  data.tar.gz: 608768440ff00294f7a022d240891a5740120d87
+SHA256:
+  metadata.gz: 243906d3090f8e342821089ba7a408f1e36508c296b3fb0c74b41775240134e6
+  data.tar.gz: ea2fcfda179921e4a551a8f62f7923ec2c70aeda194096888ce213e9901d47bf
 SHA512:
-  metadata.gz: e14922a83ea7acc09c60b028b837df3eac6a65514f3b087086521261f844cbc54d89f90e5780df46a30c10b068bfcf88aa3e04ebea7f9bb749cd334f7481b87a
-  data.tar.gz: d6439354aa07699acc613520c7ee43e99e9ccd9cba113aff99fd6c81159964820afc47b1c2bb494be6b3517dc7c3100cbe4f2724be26cf720d4aade68a316e7e
+  metadata.gz: c53554ec09f61ff4a40fdfb8e618e6799f848f4e1dbdc780ffe03dd86e656dd7e57cd65f58a39ae7e54908940d3562719eba6347227bc0e97ba8ce051cd0c8b6
+  data.tar.gz: b4e7b3087e0373410485557fc233e741b79d2beb55b0060bda97c52bd0c02366a8c305e5d838fde25477f3a0c48879578bb5aab2b1f5472371aa83a6bdef7508

data/README.md

@@ -2,7 +2,9 @@
 
 A lightweight ruby wrapper for the Betfair Exchange API (API-NG).
 
-Full API description, including API parameters etc, is available from [Betfair's dedicated API site](https://api.developer.betfair.com/services/webapps/docs/display/1smk3cen4v3lu3yomq5qye0ni/API-NG+Overview).
+Full API description, including API parameters etc, is available from [Betfair's dedicated API site](http://docs.developer.betfair.com/docs/).
+
+Oh, and always [bet responsibly](http://responsiblegambling.betfair.com/). Duh.
 
 ## Installation
 
@@ -91,6 +93,46 @@ client.place_orders({
 client.logout
 ```
 
+## Settings
+
+You can change the endpoint from the default api.betfair.com .. to api-au.betfair.com by using the `endpoint` option when you initialize the Betfair client.
+
+```ruby
+client = Betfair::Client.new({ "X-Application" => "your_app_code" }, { endpoint: :aus })
+```
+
+The default is :default.
+
+## Best practices
+
+### Persistent HTTP connection
+
+Betfair [recommends](http://docs.developer.betfair.com/docs/x/pAFD) that we pass the `Connection: keep-alive` header with each request in order to take advantage of HTTP 1.1's ability to have [persistent connections](https://en.wikipedia.org/wiki/HTTP_persistent_connection) which reduces latency for subsequent requests.
+
+This library uses the [`httpi`](https://github.com/savonrb/httpi) gem, which supports a number of different ruby http client adapters. [`httpclient`](https://github.com/nahi/httpclient) and [`net-http-persistent`](https://github.com/drbrain/net-http-persistent) are two which utilise persistent connections by default. To use `net-http-persistent` you should ensure that the gem is installed and in your load path, then set the HTTPI adapter:
+
+```ruby
+require 'betfair'
+HTTPI.adapter = :net_http_persistent
+```
+
+The same goes for `httpclient`, but it's not strictly necessary to explicitly set the adapter as it has a higher [load order precedence](https://github.com/savonrb/httpi/blob/master/lib/httpi/adapter.rb#L16) than the other adapters.
+
+### Account security and authentication
+
+Despite the example in this readme, you should definitely use the [non-interactive](http://docs.developer.betfair.com/docs/x/J4Q6) login for your bots; check the Betfair docs about how to set that up. To login this way, use the `non_interactive_login` method:
+
+```ruby
+# Performs the login procedure recommended for applications which run autonomously
+#   username: Betfair account username string
+#   password: Betfair account password string
+#   cert_key_file_path: Path to Betfair client certificate private key file
+#   cert_key_path: Path to Betfair client certificate public key file associated with Betfair account
+client.non_interactive_login(username, password, cert_key_file_path, cert_file_path)
+```
+
+This also allows you to use 2-factor authentication for your online account access, which I'd also strongly recommend that you do. I'm pretty sure you wouldn't be comfortable if your bank accounts had nothing more advanced than credential access, and seeing as a lot of you will have a reasonable amount of money stored in your Betfair accounts, I don't think you should settle for that there, either.
+
 ## Todo
 
 1. Error handling

data/lib/betfair/api/rest.rb

@@ -11,8 +11,8 @@ module Betfair
         })
 
         apis = {
-          betting: "https://api.betfair.com/exchange/betting/rest/v1.0",
-          account: "https://api.betfair.com/exchange/account/rest/v1.0"
+          betting: "https://#{obj.endpoint}.betfair.com/exchange/betting/rest/v1.0",
+          account: "https://#{obj.endpoint}.betfair.com/exchange/account/rest/v1.0",
         }
 
         obj.class::OPERATIONS.each do |api, operations|
@@ -43,7 +43,7 @@ module Betfair
       #   cert_key_path: Path to Betfair client certificate public key file associated with Betfair account
       def non_interactive_login(username, password, cert_key_file_path, cert_file_path)
         json = post({
-          url: "https://identitysso.betfair.com/api/certlogin",
+          url: "https://identitysso-cert.betfair.com/api/certlogin",
           body: { username: username, password: password },
           headers: { "Content-Type"  => "application/x-www-form-urlencoded" },
           cert_key_file_path: cert_key_file_path,
@@ -79,4 +79,4 @@ module Betfair
         end
     end
   end
-end
+end

data/lib/betfair/api/rpc.rb

@@ -2,7 +2,7 @@ module Betfair
   module API
     module RPC
       def self.extended(obj)
-        obj.endpoint = "https://api.betfair.com/exchange/betting/json-rpc/v1"
+        obj.endpoint = "https://#{obj.endpoint}.betfair.com/exchange/betting/json-rpc/v1"
         obj.persistent_headers.merge!({
           "Accept" => "application/json",
           "Content-Type" => "application/json"

data/lib/betfair/client.rb

@@ -2,6 +2,7 @@ require "betfair/api/rest"
 require "betfair/api/rpc"
 require "betfair/utils"
 require "httpi"
+require "active_support/core_ext/hash"
 
 module Betfair
   class Client
@@ -17,21 +18,24 @@ module Betfair
       account: [:get_account_funds]
     }
 
-    attr_accessor :settings, :persistent_headers
+    attr_accessor :settings, :request_opts, :persistent_headers, :endpoint
+
+    def initialize(headers = {}, opts = {}, api_type = :rest)
+      set_endpoint!(opts.delete(:endpoint))
+
+      setting_opts         = opts.extract!(:retries, :adapter)
+      @settings            = DEFAULT_SETTINGS.merge(setting_opts)
+      @persistent_headers  = headers
+      @request_opts        = opts
 
-    def initialize(headers = {}, api_type = :rest, settings = {})
-      @settings = DEFAULT_SETTINGS.merge(settings)
-      @persistent_headers = {}
-      @persistent_headers.merge!(headers)
       extend_api(api_type)
     end
 
     private
-
       [:get, :post].each do |verb|
         define_method(verb) do |*args|
           request = configure_request(*args)
-          response = attempt((settings[:retries] || 1).times) do
+          response = attempt((settings[:retries]).times) do
             HTTPI.request(verb, request, settings[:adapter])
           end
           response.body
@@ -40,14 +44,27 @@ module Betfair
 
       def configure_request(opts = {})
         opts[:headers] = persistent_headers.merge(opts[:headers] || {})
-        request = HTTPI::Request.new(opts)
 
-        # It would be nice to have HTTPI do this itself but HTTPI::Request#mass_assign doesn't merge auth fields
-        unless opts[:cert_file_path].nil? or opts[:cert_key_file_path].nil?
-          request.auth.ssl.cert_key_file = opts[:cert_key_file_path]
-          request.auth.ssl.cert_file = opts[:cert_file_path]
+        HTTPI::Request.new(request_opts.merge(opts)).tap do |r|
+          # It would be nice to have HTTPI do this itself but
+          # HTTPI::Request#mass_assign doesn't merge auth fields
+          if opts[:cert_file_path] && opts[:cert_key_file_path]
+            r.auth.ssl.cert_key_file = opts[:cert_key_file_path]
+            r.auth.ssl.cert_file     = opts[:cert_file_path]
+          end
         end
-        request
+      end
+
+      def set_endpoint!(endpoint)
+        @endpoint =
+          case endpoint
+          when :default, nil
+            "api"
+          when :aus
+            "api-au"
+          else
+            raise RuntimeError, "invalid endpoint, please choose :default or :aus"
+          end
       end
 
       def extend_api(type)

data/lib/betfair/version.rb

@@ -1,3 +1,3 @@
 module Betfair
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betfair-ng
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mike Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2019-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A lightweight wrapper for the Betfair Exchange API-NG