social_wallet 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdf12140aa01114e5b4910a8985732936f945e91
-  data.tar.gz: 5133eca30991f157a9459c64452f2fb423dacaa9
+  metadata.gz: efcf1377f95d5c41b20f36ecd8944a19c3429f08
+  data.tar.gz: 897540772baadda63332f1c9ee802c40fdab005f
 SHA512:
-  metadata.gz: 3daad05172f5d38bc0fee1e398cf43178e25954b5654bb66123271da5c03d7c0bc8743b84ff1542dba75958eb3cb5be23f9fb9887d310c26090a8a4e4e9620c8
-  data.tar.gz: 227fa5b9ea0637535d215297ff68eb6d7a8c951d09f1a082fdd4893734ab2e61966bd2179016429eae45a21259e4c342fe18a031183f030e280b24d9929d5cae
+  metadata.gz: c3e7b14d90113b7f0ada0edebf16cb24a78cfb562eae0eed59d0ec391bf7350ece2c70a6d37484a4bec0628d9e345461e8aea61ef1c4d97247f070aae8f974fe
+  data.tar.gz: 6c73550c70671e4b4efb7fa2a33cc72bfe1418e08c92e3b26c6522cbe2b1e2c5a792c2aa4019368d7d71ee0da24c628450ed5fbd2e5d2be5d9dbad2acd8e9693

data/README.md

@@ -20,6 +20,10 @@ Or install it yourself as:
 
 ## Usage
 
+### ⚠️ Version compatibility ⚠️
+
+If you use [Social Wallet API](https://github.com/Commonfare-net/social-wallet-api) version ≤ 0.10.x you must use [v1.0.3 of this gem](https://github.com/Commonfare-net/social_wallet_ruby/tree/5fe6ee36f3055de165540f49eb03e54ea9fc268d).
+
 ### Create the client
 
 The default client uses the *database* `mongo` as backend.
@@ -28,10 +32,11 @@ The default client uses the *database* `mongo` as backend.
 client = SocialWallet::Client.new(api_endpoint: 'http://example.com/wallet/v1')
 ```
 
-If you want to use the API on a *blockchain* just specify it like this:
+This constructor defaults to a client that uses `connection: 'mongo'` and `type: 'db-only'`.
+If you want to use the API on a different backend just specify it like this:
 
 ```ruby
-client = SocialWallet::Client.new(api_endpoint: 'http://example.com/wallet/v1', blockchain: 'faircoin')
+client = SocialWallet::Client.new(api_endpoint: 'http://example.com/wallet/v1', connection: 'faircoin', type: 'blockchain-and-db')
 ```
 
 ### List of tags
@@ -62,7 +67,7 @@ client.transactions.new(from_id: 'paolo', to_id: 'aaron', amount: 10, tags: ['ta
 Retrieve the list of the transactions of a specific account.
 
 ```ruby
-client.transactions(account_id: 'pietro', count: 0, from: 0, page: 0, per_page: 0, currency: 'MONGO').list
+client.transactions(account_id: 'pietro', count: 0, from: 0, page: 0, per_page: 0, currency: 'Commoncoin').list(from_datetime: Time.now - 3600, to_datetime: Time.now)
 ```
 
 To retrieve the list of the transactions of the default account use `account_id: ''`
@@ -73,9 +78,11 @@ To retrieve the list of the transactions of the default account use `account_id:
 
 * **Filter by currency**: another optional parameter for *database* transactions is `:currency`, to filter transactions only by one currency.
 
+* **Filter by dates**: use `from_datetime` and `to_datetime`.
+
 **Response**
 
-The list of transaction is always paginated to avoid overload on the server.
+The list of transactions is always paginated to avoid overload on the server.
 
 ```ruby
 {
@@ -89,7 +96,8 @@ The list of transaction is always paginated to avoid overload on the server.
       'amount'=>10,
       'amount-text'=>'10.0',
       'transaction-id'=>'xqc4cvhr...pCPfju5inCO',
-      'currency'=>'MONGO'
+      'currency'=>'Commoncoin'
+      'description'=>'...'
     },
     {
       ...
@@ -126,7 +134,7 @@ client.transactions.get transaction_id: 'xqc4cvhr...pCPfju5inCO'
   'amount'=>10,
   'amount-text'=>'10.0',
   'transaction-id'=>'xqc4cvhr...pCPfju5inCO',
-  'currency'=>'MONGO'
+  'currency'=>'Commoncoin'
 }
 ```
 
@@ -188,7 +196,7 @@ Retrieve the label of the currency for the client's backend
 
 ```ruby
 client.label
-#=> { 'currency' => 'MONGO' }
+#=> { 'currency' => 'Commoncoin' }
 ```
 
 ### Address

data/lib/social_wallet/client.rb

@@ -1,13 +1,20 @@
 module SocialWallet
   class Client
-    attr_accessor :api_endpoint, :blockchain, :request_data
+    attr_accessor :api_endpoint, :blockchain, :request_data, :connection, :type
 
     SW_ERROR_STATUSES = [404, 503].freeze
 
-    def initialize(api_endpoint: nil, blockchain: 'mongo')
+    def initialize(
+      api_endpoint: nil,
+      blockchain: 'mongo',
+      connection: 'mongo',
+      type: 'db-only'
+    )
       @api_endpoint = api_endpoint
-      @blockchain = blockchain
-      @request_data = { blockchain: blockchain }
+      @blockchain = blockchain # NOTE: here for backward compatibility
+      @connection = connection
+      @type = type
+      @request_data = { connection: connection, type: type }
       @path_parts = []
     end
 
@@ -55,9 +62,9 @@ module SocialWallet
     end
 
     def ___balance(account_id: nil)
-      conn = Faraday.new(url: api_endpoint + '/' + path, ssl: { version: 'TLSv1_2' })
+      conn = Faraday.new(connection_params)
       response = conn.post do |req|
-        req.headers['Content-Type'] = 'application/json'
+        req.headers.merge!(headers)
         request_data['account-id'] = account_id if account_id
         req.body = MultiJson.dump(request_data)
       end
@@ -67,9 +74,9 @@ module SocialWallet
     end
 
     def ___label
-      conn = Faraday.new(url: api_endpoint + '/' + path, ssl: { version: 'TLSv1_2' })
+      conn = Faraday.new(connection_params)
       response = conn.post do |req|
-        req.headers['Content-Type'] = 'application/json'
+        req.headers.merge!(headers)
         req.body = MultiJson.dump(request_data)
       end
       format_response(response)
@@ -78,9 +85,9 @@ module SocialWallet
     end
 
     def ___address(account_id: '')
-      conn = Faraday.new(url: api_endpoint + '/' + path, ssl: { version: 'TLSv1_2' })
+      conn = Faraday.new(connection_params)
       response = conn.post do |req|
-        req.headers['Content-Type'] = 'application/json'
+        req.headers.merge!(headers)
         request_data['account-id'] = account_id
         req.body = MultiJson.dump(request_data)
       end
@@ -89,22 +96,6 @@ module SocialWallet
       reset
     end
 
-    # def move(from_id: nil, to_id: nil, amount: 0, tags: [])
-    #   @path_parts << 'move'
-    #   conn = Faraday.new(url: api_endpoint + '/' + path, ssl: { version: 'TLSv1_2' })
-    #   response = conn.post do |req|
-    #     req.headers['Content-Type'] = 'application/json'
-    #     request_data['from-id'] = (from_id ||= @account_id)
-    #     request_data['to-id'] = to_id
-    #     request_data[:amount] = amount
-    #     request_data[:tags] = tags
-    #     req.body = MultiJson.dump(request_data)
-    #   end
-    #   format_response(response)
-    # ensure
-    #   reset
-    # end
-
     def ___new(
       from_id:             nil,
       to_id:               nil,
@@ -114,11 +105,12 @@ module SocialWallet
       to_address:          '',
       comment:             '',
       comment_to:          '',
+      description:         '',
       tags:                []
     )
-      conn = Faraday.new(url: api_endpoint + '/' + path, ssl: { version: 'TLSv1_2' })
+      conn = Faraday.new(connection_params)
       response = conn.post do |req|
-        req.headers['Content-Type'] = 'application/json'
+        req.headers.merge!(headers)
         # From SWAPI v0.9.3 amount is a String
         request_data[:amount] = BigDecimal.new(amount, 16).to_s('F')
         request_data[:tags] = tags
@@ -135,6 +127,7 @@ module SocialWallet
         elsif @path_parts.include? 'transactions'
           request_data['from-id'] = from_id
           request_data['to-id'] = to_id
+          request_data['description'] = description
         end
         req.body = MultiJson.dump(request_data)
       end
@@ -143,10 +136,15 @@ module SocialWallet
       reset
     end
 
-    def ___list
-      conn = Faraday.new(url: api_endpoint + '/' + path, ssl: { version: 'TLSv1_2' })
+    def ___list(
+      from_datetime: nil,
+      to_datetime:   nil,
+      description:   nil,
+      tags:          nil
+    )
+      conn = Faraday.new(connection_params)
       response = conn.post do |req|
-        req.headers['Content-Type'] = 'application/json'
+        req.headers.merge!(headers)
         if @path_parts.include?('transactions')
           request_data['account-id'] = @account_id
           request_data['count'] = @count unless @count.nil?
@@ -154,6 +152,10 @@ module SocialWallet
           request_data['page'] = @page unless @page.nil?
           request_data['per-page'] = @per_page unless @per_page.nil?
           request_data['currency'] = @currency unless @currency.nil?
+          request_data['from-datetime'] = from_datetime.iso8601 if from_datetime.is_a? Time
+          request_data['to-datetime'] = to_datetime.iso8601 if to_datetime.is_a? Time
+          request_data['description'] = description unless description.nil?
+          request_data['tags'] = tags unless tags.nil?
         end
         req.body = MultiJson.dump(request_data)
       end
@@ -163,9 +165,9 @@ module SocialWallet
     end
 
     def ___get(transaction_id: nil)
-      conn = Faraday.new(url: api_endpoint + '/' + path, ssl: { version: 'TLSv1_2' })
+      conn = Faraday.new(connection_params)
       response = conn.post do |req|
-        req.headers['Content-Type'] = 'application/json'
+        req.headers.merge!(headers)
         request_data[:txid] = transaction_id
         req.body = MultiJson.dump(request_data)
       end
@@ -175,9 +177,9 @@ module SocialWallet
     end
 
     def ___check(address: '')
-      conn = Faraday.new(url: api_endpoint + '/' + path, ssl: { version: 'TLSv1_2' })
+      conn = Faraday.new(connection_params)
       response = conn.post do |req|
-        req.headers['Content-Type'] = 'application/json'
+        req.headers.merge!(headers)
         request_data[:address] = address
         req.body = MultiJson.dump(request_data)
       end
@@ -206,7 +208,7 @@ module SocialWallet
 
     def reset
       @path_parts = []
-      @request_data = { blockchain: blockchain }
+      @request_data = { connection: connection, type: type }
     end
 
     def format_response(response)
@@ -219,5 +221,19 @@ module SocialWallet
         raise SocialWallet::Error.new("API Error: #{response.body}")
       end
     end
+
+    def connection_params
+      {
+        url: api_endpoint + '/' + path,
+        ssl: { version: 'TLSv1_2' }
+      }
+    end
+
+    def headers
+      {
+        'Content-Type' => 'application/json',
+        # 'x-api-key'    => ENV['SOCIAL_WALLET_API_KEY']
+      }
+    end
   end
 end

data/lib/social_wallet/version.rb

@@ -1,3 +1,3 @@
 module SocialWallet
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/lib/social_wallet.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 require 'multi_json'
 require 'bigdecimal'
+require 'time'
 
 require 'social_wallet/version'
 require 'social_wallet/error'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: social_wallet
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - pbmolini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday