luno 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daa749234c20ac9ba06398b5c4bd8e5c3e14af593411877ded14fd31d42d0aaf
-  data.tar.gz: 4134f4e339b3f39f0a593b46b94baf665479a5e5681de2a0b57e46dcc0ba38a4
+  metadata.gz: 4e664e47e7a6037bf7e4ff9af7e7e40146cc8d393b0566e77f7f401c51433fb4
+  data.tar.gz: e46c10799631a0fafad6419a176a89c44917d90e4d99b152c7cf91fbd2075778
 SHA512:
-  metadata.gz: b90a4e741c23e3cb14a45ccc7234ca4672a9d192af015d45a3796651ee52cdbf2739980aafa36318d88c5fef7ce711d31de7a69ed2588b35a4fb3e06ed5662f2
-  data.tar.gz: 3c07483225243bdaf7ef880f37802fea9b0bd24233bc5773be7cd9898218054b6b8151bb9228d4df168dab6ea6652484dc2a25f4c3455cc7de6308981a45504f
+  metadata.gz: d33e2d46da2c3827164b7b217cda126b44410ee2c4beefdcf67ddba3bb43ff7ff56f15b943e45729e9b94c047fdefa1cd4abbeae89048516656b98bda1c9fdae
+  data.tar.gz: e7da2ac7785e87dbc147ce645a9dbbecf04ee01aceb003d7b8fc1dde7cfaecbbff7fd40e9552e10ec3f4b83fe47bed14231baa3394f43246050a76d68321fb73

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    luno (0.1.0)
+    luno (0.2.0)
       active_attr (~> 0.15)
       httparty (~> 0.18)
       nokogiri (~> 1.10.9)
@@ -82,7 +82,7 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    rake (10.5.0)
+    rake (13.0.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
     thread_safe (0.3.6)
@@ -106,7 +106,7 @@ DEPENDENCIES
   minitest-reporters (~> 1.4.2)
   mocha (~> 1.11.2)
   pry (~> 0.13)
-  rake (~> 10.0)
+  rake (~> 13.0)
   timecop (~> 0.9.1)
   webmock (~> 3.8.3)
 

data/README.md

@@ -1,6 +1,7 @@
 # Luno
+A client for the Luno API. See: https://www.luno.com/en/developers/api
 
-This is a client for the Luno API. See: https://www.luno.com/en/developers/api
+This is an unofficial project and still a work in progress (WIP) ... more to come soon.
 
 ## Installation
 
@@ -20,7 +21,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+  require 'luno'
+  client  = Luno::Client.new(key: 'your key', secret: 'your secret')
+```
+
+### Endpoints
+  - Accounts
+  - Beneficiaries
+  - Markets
+  - Orders
+  - Quotes
+  - Receiving
+  - Sending
+  - Transactions
+  - Withdrawals
+
+### Beta Endpoints
+  - Lightning
+  - Streaming
+
+### Other Endpoints
+  - ping(limit: 4, paths: ['https://www.luno.com/', 'https://api.mybitx.com/api/1/'])
+  - countries
+  - currencies
+  - permissions
+  - changelog
+
+### Constants
+  Constants
 
 ## Development
 
@@ -28,6 +57,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Tests
+To run tests execute:
+
+    $ rake test
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/trex22/luno. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/luno.rb

@@ -2,6 +2,7 @@ require 'httparty'
 require 'nokogiri'
 
 require 'luno/version'
+require 'luno/constants'
 
 # Endpoints
 require 'luno/accounts'

data/lib/luno/accounts.rb

@@ -1,8 +1,32 @@
 module Luno
   module Accounts
+    # GET paths
     def list_accounts
       path = 'accounts'
       authorise_and_send(http_method: :get, path: path)
     end
+
+    def list_pending_account_transactions(account_id)
+      path = "accounts/#{account_id}/pending"
+      authorise_and_send(http_method: :get, path: path)
+    end
+
+    # Path params: min_row=1&max_row=1000
+    def list_account_transactions(account_id, min_row: -1000, max_row: 0)
+      path = "accounts/#{account_id}/transactions"
+      path_params = { min_row: min_row, max_row: max_row }
+      authorise_and_send(http_method: :get, path: path, params: path_params)
+    end
+
+    # List balances has been moved and retired as an endpoint
+
+    # POST paths
+    # TODO:
+    # Create account: /api/1/accounts body: { name: '', currency: '' }
+    # TODO: Check internally that inputs are valid
+
+    # PUT paths
+    # TODO:
+    # Update Account name:  /api/1/accounts/{id}/name body: { name: '' }
   end
 end

data/lib/luno/beneficiaries.rb

@@ -1,5 +1,8 @@
 module Luno
   module Beneficiaries
-
+    def list_beneficiaries
+      path = 'beneficiaries'
+      authorise_and_send(http_method: :get, path: path)
+    end
   end
 end

data/lib/luno/client.rb

@@ -1,5 +1,7 @@
 module Luno
   class Client
+    include ::Luno::Constants
+
     # Endpoints
     include ::Luno::Accounts
     include ::Luno::Beneficiaries
@@ -38,12 +40,12 @@ module Luno
 
     private
 
-    def unauthorised_and_send(http_method:, path:, payload: {})
+    def unauthorised_and_send(http_method:, path:, payload: {}, params: {})
       start_time = get_micro_second_time
 
       response = HTTParty.send(
         http_method.to_sym,
-        construct_base_path(path),
+        construct_base_path(path, params),
         body: payload,
         headers: { 'Content-Type': 'application/json' },
         port: port,
@@ -51,17 +53,17 @@ module Luno
       )
 
       end_time = get_micro_second_time
-      construct_response_obejct(response, start_time, end_time)
+      construct_response_object(response, path, start_time, end_time)
     end
 
-    def authorise_and_send(http_method:, path:, payload: {})
+    def authorise_and_send(http_method:, path:, payload: {}, params: {})
       auth = {username: key, password: secret}
 
       start_time = get_micro_second_time
 
       response = HTTParty.send(
         http_method.to_sym,
-        construct_base_path(path),
+        construct_base_path(path, params),
         body: payload,
         headers: { 'Content-Type': 'application/json' },
         port: port,
@@ -70,39 +72,63 @@ module Luno
       )
 
       end_time = get_micro_second_time
-      construct_response_obejct(response, start_time, end_time)
+      construct_response_object(response, path, start_time, end_time)
     end
 
-    def construct_response_obejct(response, start_time, end_time)
-      if response.ok?
-        response.to_json.merge({
-          metadata: construct_metadata(start_time, end_time)
-        })
-      else
-        {
-          body: response.body,
-          headers: response.headers,
-          metadata: construct_metadata(start_time, end_time)
-        }
-      end
+    def construct_response_object(response, path, start_time, end_time)
+      {
+        'body' => parse_body(response, path),
+        'headers' => response.headers,
+        'metadata' => construct_metadata(response, start_time, end_time)
+      }
     end
 
-    def construct_metadata(start_time, end_time)
+    def construct_metadata(response, start_time, end_time)
       total_time = end_time - start_time
 
       {
-        start_time: start_time,
-        end_time: end_time,
-        total_time: total_time
+        'start_time' => start_time,
+        'end_time' => end_time,
+        'total_time' => total_time
       }
     end
 
+    def body_is_present?(response)
+      !body_is_missing?(response)
+    end
+
+    def body_is_missing?(response)
+      response.body.nil? || response.body.empty?
+    end
+
+    def parse_body(response, path)
+      parsed_response = JSON.parse(response.body) # Purposely not using HTTParty
+
+      if parsed_response.dig(path.to_s)
+        parsed_response.dig(path.to_s)
+      else
+        parsed_response
+      end
+    rescue JSON::ParserError => _e
+      response.body
+    end
+
     def get_micro_second_time
       (Time.now.to_f * 1000000).to_i
     end
 
-    def construct_base_path(path)
-      "#{base_path}/#{path}"
+    def construct_base_path(path, params)
+      constructed_path = "#{base_path}/#{path}"
+
+      if params != {}
+        constructed_path
+      else
+        "#{constructed_path}?#{process_params(params)}"
+      end
+    end
+
+    def process_params(params)
+      params.keys.map { |key| "#{key}=#{params[key]}" }.join('&')
     end
   end
 end

data/lib/luno/constants.rb

@@ -0,0 +1,70 @@
+module Luno
+  module Constants
+    CURRENCIES = {
+      XBT: 'Bitcoin',
+      BCH: 'Bitcoin Cash',
+      ETH: 'Ethereum',
+      EUR: 'Euro',
+      MYR: 'Malaysian Ringgit',
+      NGN: 'Nigerian Naira',
+      UGX: 'Ugandan Shilling',
+      ZAR: 'South African Rand',
+      ZMW: 'Zambian Kwacha'
+    }
+
+    CURRENCY_PAIRS = [
+      'XBTEUR',
+      'XBTZAR',
+      'XBTUGX',
+      'XBTZMW',
+      'ETHXBT',
+      'BCHXBT'
+    ]
+
+    WITHDRAWL_CURRENCIES = [
+      BTC: 'Bitcoin',
+      BCH: 'Bitcoin Cash',
+      ETH: 'Ethereum',
+      BTC_LN: 'Lightning'
+    ]
+
+    WITHDRAWL_CURRENCY_PAIR_METHODS = {
+      ZAR_EFT: 'EFT',
+      NAD_EFT: 'EFT',
+      KES_EFT: 'EFT',
+      KES_MPESA: 'M-Pesa',
+      MYR_IBG: 'Interbank GIRO / IBFT',
+      IDR_LLG: 'Bank transfer, Lalu Lintas Giro',
+      NGN_EFT: 'Bank transfer',
+      ZMW_EFT: 'Bank transfer',
+      SGD_GIRO: 'GIRO / FAST',
+      SGD_WIRE: 'International Wire',
+      EUR_SEPA: 'SEPA transfer',
+      UGX_EFT: 'Bank transfer',
+    }
+
+    PERMISSIONS = {
+      Perm_R_Balance: { id: 1, description: '(View balance)' },
+      Perm_R_Transactions: { id: 2, description: '(View transactions)' },
+      Perm_W_Send: { id: 4, description: '(Send to any address)' },
+      Perm_R_Addresses: { id: 8, description: '(View addresses)' },
+      Perm_W_Addresses: { id: 16, description: '(Create addresses)' },
+      Perm_R_Orders: { id: 32, description: '(View orders)' },
+      Perm_W_Orders: { id: 64, description: '(Create orders)' },
+      Perm_R_Withdrawals: { id: 128, description: '(View withdrawals)' },
+      Perm_W_Withdrawals: { id: 256, description: '(Create withdrawals)' },
+      Perm_R_Merchant: { id: 512, description: '(View merchant invoices)' },
+      Perm_W_Merchant: { id: 1024, description: '(Create merchant invoices)' },
+      Perm_W_ClientDebit: { id: 8192, description: '(Debit accounts)' },
+      Perm_W_ClientCredit: { id: 16384, description: '(Credit accounts)' },
+      Perm_R_Beneficiaries: { id: 32768, description: '(View beneficiaries)' },
+      Perm_W_Beneficiaries: { id: 65536, description: '(Create and delete beneficiaries)' },
+    }
+
+    MARKET_API_RATE_LIMIT = 1 # per second per ip
+    MARKET_API_BURST_RATE_LIMIT = 5 # per second per ip
+
+    API_RATE_LIMIT = 5 # per second per ip
+    API_BURST_RATE_LIMIT = 25 # per second per ip
+  end
+end

data/lib/luno/lightning.rb

@@ -1,5 +1,11 @@
 module Luno
   module Lightning
+    # GET paths
+
+
+    # POST paths
+
+    # PUT paths
 
   end
 end

data/lib/luno/other_data.rb

@@ -3,6 +3,9 @@
 
 module Luno
   module OtherData
+    COUNTRY_ENDPOINT = 'https://www.luno.com/en/countries'
+    DOCUMENTATION_ENDPOINT = 'https://www.luno.com/en/developers/api'
+
     def ping(limit: 4, paths: ['https://www.luno.com/', 'https://api.mybitx.com/api/1/'])
       endpoint_metrics = paths.map do |path|
         responses = []
@@ -12,45 +15,58 @@ module Luno
         end
 
         avg_time = responses
-          .map { |r| r.dig(:metadata)&.dig(:total_time) }
+          .map { |r| r.dig('metadata')&.dig('total_time') }
           .reduce(&:+) / limit
 
         {
-          path: path,
-          average_time: avg_time
+          'path' => path,
+          'average_time' => avg_time
         }
       end
 
       {
-        metadata: {
-          endpoint_metrics: endpoint_metrics
+        'metadata' => {
+          'endpoint_metrics' => endpoint_metrics
         }
       }
     end
 
+    # TODO
     def countries
-      call_countries
+      response = call_countries
     end
 
     # From API Documentation
+    # [WIP]
     def currencies
       lines = []
 
-      call_api_documentation
+      response = call_api_documentation
+
+      output = parse_html(response['body'])
         .at('div#tag\/Currency')
         .search('li')
         .map(&:text)
         .map { |text| text.split.join(" ") }
+
+      {
+        'body' => output,
+        'headers' => response['headers'],
+        'metadata' => response['metadata']
+      }
     end
 
+    # TODO
     def permissions
-      call_api_documentation
+      response = call_api_documentation
     end
 
     def changelog
       lines = []
 
-      call_api_documentation
+      response = call_api_documentation
+
+      parse_html(response['body'])
         .at('div#tag\/Changelog')
         .search('li')
         .map(&:text)
@@ -73,17 +89,31 @@ module Luno
         output.merge!(key => text)
       end
 
-      output
+      {
+        'body' => output,
+        'headers' => response['headers'],
+        'metadata' => response['metadata']
+      }
     end
 
     private
 
     def call_countries
-      parse_html(HTTParty.get('https://www.luno.com/en/countries').body)
+      start_time = get_micro_second_time
+
+      response = HTTParty.get(COUNTRY_ENDPOINT)
+
+      end_time = get_micro_second_time
+      construct_response_obejct(response, start_time, end_time)
     end
 
     def call_api_documentation
-      parse_html(HTTParty.get('https://www.luno.com/en/developers/api').body)
+      start_time = get_micro_second_time
+
+      response = HTTParty.get(DOCUMENTATION_ENDPOINT)
+
+      end_time = get_micro_second_time
+      construct_response_obejct(response, start_time, end_time)
     end
 
     def parse_html(raw_html)

data/lib/luno/version.rb

@@ -1,3 +1,3 @@
 module Luno
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/luno.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["contact@jasonchalom.com"]
 
   spec.summary       = "A client for using the Luno API in Ruby."
-  spec.description   = "A client for using the Luno API in Ruby. It relies on the swagger spec from their api documentation. https://www.luno.com/en/developers/api"
+  spec.description   = "A client for using the Luno API in Ruby. Built form their api documentation. https://www.luno.com/en/developers/api. This is an unofficial project."
   spec.homepage      = "https://github.com/TRex22/luno"
   spec.license       = "MIT"
 
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   # Development dependancies
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-focus", "~> 1.1.2"
   spec.add_development_dependency "minitest-reporters", "~> 1.4.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luno
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - trex22
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -178,8 +178,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.8.3
-description: A client for using the Luno API in Ruby. It relies on the swagger spec
-  from their api documentation. https://www.luno.com/en/developers/api
+description: A client for using the Luno API in Ruby. Built form their api documentation.
+  https://www.luno.com/en/developers/api. This is an unofficial project.
 email:
 - contact@jasonchalom.com
 executables: []
@@ -201,6 +201,7 @@ files:
 - lib/luno/accounts.rb
 - lib/luno/beneficiaries.rb
 - lib/luno/client.rb
+- lib/luno/constants.rb
 - lib/luno/lightning.rb
 - lib/luno/markets.rb
 - lib/luno/orders.rb