first implementation of a concrete client and its factory

sebs · sebs · commit 754a9a6f2fb7 · 2019-08-11T14:57:48.000+02:00
diff --git a/src/Client.ts b/src/Client.ts
@@ -1,4 +1,6 @@
 import { account } from './actions/account'
+import { ClientAccountBalance } from './client/ClientAccountBalance'
+import { Address } from './entities/Address'
 import { ApiKey } from './entities/Apikey'
 
 export class Client {
@@ -7,10 +9,20 @@ export class Client {
     this.apiKey = new ApiKey(apiKey)
     this.apiKey.validate()
   }
-  account(action: string): void {
+
+  account(action: string): any {
     if (!account.get(action)) {
       throw new Error('unknown action')
     }
-    return
+
+    var me = this;
+    const actions:{ [key: string]: any } =  {
+      'balance': (address: string, tag: string): ClientAccountBalance => {
+        const oAddress = new Address(address)
+        return new ClientAccountBalance(this.apiKey, 'account', action, oAddress, tag)
+      },
+    }
+
+    return actions[action]
   }
 }
diff --git a/src/client/ClientAccountBalance.ts b/src/client/ClientAccountBalance.ts
@@ -0,0 +1,30 @@
+import { Address } from '../entities/Address'
+import { ApiKey } from '../entities/Apikey'
+import { IClientAccountBalanceRequest } from '../interfaces/Account'
+
+import { requestBuilder } from '../requestBuilder'
+
+export class ClientAccountBalance implements IClientAccountBalanceRequest {
+  apiKey: ApiKey
+  address: Address
+  module: string
+  action: string
+  tag: string
+
+  constructor(apiKey: ApiKey, module: string, action: string, address: Address, tag: string) {
+    this.apiKey = apiKey
+    this.module = module
+    this.action = action
+    this.address = address
+    this.tag = tag
+  }
+
+  toUrl(): string {
+    return requestBuilder(this.module, this.action, {
+      address: this.address.toString(),
+      tag: this.tag.toString(), 
+      apiKey: this.apiKey.toString()
+    })
+  }
+
+}
diff --git a/src/entities/Address.ts b/src/entities/Address.ts
@@ -4,16 +4,15 @@ import { EntityBase } from './EntityBase'
 
 // a ethereum address
 export class Address extends EntityBase implements IEntity {
-    private address: string
+
     private regex = /0x[a-fA-F0-9]{40}/
 
     constructor(address: string) {
-        super()
+        super(address)
         this.errorMessage = 'Invalid Address'
-        this.address = address
     }
 
     valid(): boolean {
-        return this.address.match(this.regex) !== null
+        return this.value.match(this.regex) !== null
     }
 }
diff --git a/src/entities/Apikey.ts b/src/entities/Apikey.ts
@@ -5,14 +5,12 @@ import { EntityBase } from './EntityBase'
 // api key for etherscan.io
 export class ApiKey extends EntityBase implements IEntity {
     errorMessage: string =  'invalid'
-    private apiKey: string
     private keyLength: number = 34
     constructor(apiKey: string) {
-        super()
-        this.apiKey = apiKey
+        super(apiKey)
     }
 
     valid(): boolean {
-        return this.apiKey.length === this.keyLength
+        return this.value.length === this.keyLength
     }
 }
diff --git a/src/entities/EntityBase.ts b/src/entities/EntityBase.ts
@@ -1,10 +1,12 @@
 
 // base class for entities
 export abstract class EntityBase {
+    protected value: any
     // basic error message for exceptions on validations
     errorMessage: string
     // checks valid() and throws errorMessage
-    constructor() {
+    constructor(value: any) {
+        this.value = value
         this.errorMessage = 'invalid value'
     }
     validate(): void {
@@ -13,6 +15,10 @@ export abstract class EntityBase {
         }
     }
 
+    toString(): string {
+        return this.value.toString()
+    }
+
     valid(): boolean {
         return true
     }
diff --git a/src/entities/HexQuantity.ts b/src/entities/HexQuantity.ts
@@ -6,15 +6,12 @@ import { EntityBase } from './EntityBase'
  */
 export class HexQuantity extends EntityBase implements IEntity {
     errorMessage: string =  'invalid'
-    private hexString: string
-
     constructor(hexString: string) {
-        super()
-        this.hexString = hexString
+        super(hexString)
     }
 
     valid(): boolean {
-        const a = parseInt(this.hexString, 16)
-        return (a.toString(16) === this.hexString)
+        const a = parseInt(this.value, 16)
+        return (a.toString(16) === this.value)
     }
 }
diff --git a/src/entities/PositiveNumber.ts b/src/entities/PositiveNumber.ts
@@ -5,17 +5,16 @@ import { EntityBase } from './EntityBase'
 // a positive number
 export class PositiveNumber extends EntityBase implements IEntity {
     errorMessage: string
-    private positiveNumber: any
 
     constructor(positiveNumber: any) {
-        super()
+        super(positiveNumber)
         this.errorMessage = 'invalid number'
-        this.positiveNumber = positiveNumber
+        this.value = positiveNumber
     }
 
     valid(): boolean {
 
-        const numerical = parseInt(this.positiveNumber, 3)
+        const numerical = parseInt(this.value, 3)
 
         if (numerical < 0) {
             return false
diff --git a/src/entities/Sort.ts b/src/entities/Sort.ts
@@ -6,14 +6,13 @@ import { EntityBase } from './EntityBase'
 // Sort Parameter asc or desc
 export class Sort extends EntityBase implements IEntity {
     errorMessage: string =  'invalid'
-    private sortParam: string
 
     constructor(sortParam: string) {
-        super()
-        this.sortParam = sortParam
+        super(sortParam)
+
     }
 
     valid(): boolean {
-        return sort.asc === this.sortParam || sort.desc === this.sortParam
+        return sort.asc === this.value || sort.desc === this.value
     }
 }
diff --git a/src/interfaces/Entity.ts b/src/interfaces/Entity.ts
@@ -1,12 +1,12 @@
 import { ApiKey } from '../entities/Apikey'
 
-export interface IEntity {
-  validate(): void
-  valid(): boolean
-}
-
 export interface IClientRequest {
   module: string
   action: string
   apiKey: ApiKey
 }
+
+export interface IEntity {
+  validate(): void
+  valid(): boolean
+}
diff --git a/src/requestBuilder.ts b/src/requestBuilder.ts
@@ -23,7 +23,7 @@ actions.set('stats', stats)
 actions.set('tokens', tokens)
 actions.set('transaction', transaction)
 
-export const requestBuilder =  (module: string, action: string): string => {
+export const requestBuilder =  (module: string, action: string, params?: object): string => {
 
     if (!modules.get(module)) {
         throw Error('unknown module')
@@ -33,10 +33,13 @@ export const requestBuilder =  (module: string, action: string): string => {
         throw Error('unknown action')
     }
 
-    const query: string = encode({
+    const baseParams = {
         action,
         module,
-    })
+    }
 
+    const toEncodeParams = Object.assign(baseParams, params)
+    const query: string = encode(toEncodeParams)
+    
     return `${base}?${query}`
 }
diff --git a/test/clients/ClientAccountBalanceTest.ts b/test/clients/ClientAccountBalanceTest.ts
@@ -0,0 +1,42 @@
+import test from 'ava'
+import { Client } from '../../src/Client'
+import { parse } from 'url'
+import { decode } from 'querystring'
+
+test('account api with valid action', t =>  {
+	const client = new Client('TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W')
+	client.account('balance')
+	t.pass()
+})
+
+test('account api with valid action', t =>  {
+	const client = new Client('TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W')
+	const res = client.account('balance')
+	t.is(typeof res, 'function')
+})
+
+test('executing the function', t =>  {
+	const client = new Client('TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W')
+	const concreteClient = client.account('balance')('address', 'latest')
+	t.truthy(concreteClient)
+})
+
+
+test('no param translates to [object Object]', t =>  {
+	const client = new Client('TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W')
+	const url = client.account('balance')('address', 'latest').toUrl()
+	const parsedQuery = decode(url)
+	t.not(parsedQuery.apiKey, '[object Object]')
+	t.not(parsedQuery.module, '[object Object]')
+	t.not(parsedQuery.account, '[object Object]')
+	t.not(parsedQuery.address, '[object Object]')
+})
+
+
+
+test('the correct url is generated', t =>  {
+	const client = new Client('TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W')
+	const resultingUrl = 'https://api.etherscan.io/api?action=balance&module=account&address=address&tag=latest&apiKey=TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W'
+	const url = client.account('balance')('address', 'latest').toUrl()
+	t.is(url, resultingUrl)
+})
diff --git a/test/entities/ApikeyTest.ts b/test/entities/ApikeyTest.ts
@@ -14,11 +14,14 @@ test('key TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W is valid', (t)=> {
 	t.truthy(a.valid())
 })
 
-test('foo is valid', (t)=> {
+test('foo is invalid', (t)=> {
 	const apiKey = 'foo'
 	const a = new ApiKey(apiKey)
 	t.false(a.valid())
 })
 
-
-
+test('to string works', (t)=> {
+	const apiKey = 'TRU5Z5MNWIEYP4F6DPH2T53IJWZIZ5GT1W'
+	const a = new ApiKey(apiKey)
+	t.truthy(a.toString())
+})
diff --git a/test/requestBuilderTest.ts b/test/requestBuilderTest.ts
@@ -17,6 +17,16 @@ test('containts /api', t => {
 	t.regex(res, /\/api/)
 })
 
+test('contains additional parameters', t => {
+	const res = requestBuilder('account', 'balance', {
+		foo: 'bar'
+	})
+	t.regex(res, /foo/)
+	t.regex(res, /bar/)
+})
+
+
+
 test('throws on unknown module', t => {
 	t.throws(()=> requestBuilder('foomodulenotexist', 'balance'))
 })

Original file line number	Diff line number	Diff line change
`@@ -4,16 +4,15 @@ import { EntityBase } from './EntityBase'`
`4`	`4`
`5`	`5`	`// a ethereum address`
`6`	`6`	`export class Address extends EntityBase implements IEntity {`
`7`		`- private address: string`
	`7`	`+`
`8`	`8`	`private regex = /0x[a-fA-F0-9]{40}/`
`9`	`9`
`10`	`10`	`constructor(address: string) {`
`11`		`- super()`
	`11`	`+ super(address)`
`12`	`12`	`this.errorMessage = 'Invalid Address'`
`13`		`- this.address = address`
`14`	`13`	`}`
`15`	`14`
`16`	`15`	`valid(): boolean {`
`17`		`- return this.address.match(this.regex) !== null`
	`16`	`+ return this.value.match(this.regex) !== null`
`18`	`17`	`}`
`19`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,14 +5,12 @@ import { EntityBase } from './EntityBase'`
`5`	`5`	`// api key for etherscan.io`
`6`	`6`	`export class ApiKey extends EntityBase implements IEntity {`
`7`	`7`	`errorMessage: string = 'invalid'`
`8`		`- private apiKey: string`
`9`	`8`	`private keyLength: number = 34`
`10`	`9`	`constructor(apiKey: string) {`
`11`		`- super()`
`12`		`- this.apiKey = apiKey`
	`10`	`+ super(apiKey)`
`13`	`11`	`}`
`14`	`12`
`15`	`13`	`valid(): boolean {`
`16`		`- return this.apiKey.length === this.keyLength`
	`14`	`+ return this.value.length === this.keyLength`
`17`	`15`	`}`
`18`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,12 @@`
`1`	`1`
`2`	`2`	`// base class for entities`
`3`	`3`	`export abstract class EntityBase {`
	`4`	`+ protected value: any`
`4`	`5`	`// basic error message for exceptions on validations`
`5`	`6`	`errorMessage: string`
`6`	`7`	`// checks valid() and throws errorMessage`
`7`		`- constructor() {`
	`8`	`+ constructor(value: any) {`
	`9`	`+ this.value = value`
`8`	`10`	`this.errorMessage = 'invalid value'`
`9`	`11`	`}`
`10`	`12`	`validate(): void {`
`@@ -13,6 +15,10 @@ export abstract class EntityBase {`
`13`	`15`	`}`
`14`	`16`	`}`
`15`	`17`
	`18`	`+ toString(): string {`
	`19`	`+ return this.value.toString()`
	`20`	`+ }`
	`21`	`+`
`16`	`22`	`valid(): boolean {`
`17`	`23`	`return true`
`18`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,15 +6,12 @@ import { EntityBase } from './EntityBase'`
`6`	`6`	`*/`
`7`	`7`	`export class HexQuantity extends EntityBase implements IEntity {`
`8`	`8`	`errorMessage: string = 'invalid'`
`9`		`- private hexString: string`
`10`		`-`
`11`	`9`	`constructor(hexString: string) {`
`12`		`- super()`
`13`		`- this.hexString = hexString`
	`10`	`+ super(hexString)`
`14`	`11`	`}`
`15`	`12`
`16`	`13`	`valid(): boolean {`
`17`		`- const a = parseInt(this.hexString, 16)`
`18`		`- return (a.toString(16) === this.hexString)`
	`14`	`+ const a = parseInt(this.value, 16)`
	`15`	`+ return (a.toString(16) === this.value)`
`19`	`16`	`}`
`20`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,14 +6,13 @@ import { EntityBase } from './EntityBase'`
`6`	`6`	`// Sort Parameter asc or desc`
`7`	`7`	`export class Sort extends EntityBase implements IEntity {`
`8`	`8`	`errorMessage: string = 'invalid'`
`9`		`- private sortParam: string`
`10`	`9`
`11`	`10`	`constructor(sortParam: string) {`
`12`		`- super()`
`13`		`- this.sortParam = sortParam`
	`11`	`+ super(sortParam)`
	`12`	`+`
`14`	`13`	`}`
`15`	`14`
`16`	`15`	`valid(): boolean {`
`17`		`- return sort.asc === this.sortParam \|\| sort.desc === this.sortParam`
	`16`	`+ return sort.asc === this.value \|\| sort.desc === this.value`
`18`	`17`	`}`
`19`	`18`	`}`