social_wallet 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efcf1377f95d5c41b20f36ecd8944a19c3429f08
-  data.tar.gz: 897540772baadda63332f1c9ee802c40fdab005f
+  metadata.gz: f4a455067fda9d8fee196062f7702871c045a672
+  data.tar.gz: 331643bfd1ce3a654a66bd79ae4b0f1c5433f017
 SHA512:
-  metadata.gz: c3e7b14d90113b7f0ada0edebf16cb24a78cfb562eae0eed59d0ec391bf7350ece2c70a6d37484a4bec0628d9e345461e8aea61ef1c4d97247f070aae8f974fe
-  data.tar.gz: 6c73550c70671e4b4efb7fa2a33cc72bfe1418e08c92e3b26c6522cbe2b1e2c5a792c2aa4019368d7d71ee0da24c628450ed5fbd2e5d2be5d9dbad2acd8e9693
+  metadata.gz: 5e0546c69bbf6f17b6df361b6e3fd628981466b9ff9e675f9840b22a51ecdcdcbf53a29016c2b7add54acfa69bc6d9ef32b28e0a00fecfe541e9ee9743d288a8
+  data.tar.gz: ae5b13893e916dd280c32a5d690367ed95d674ac5f212629c9cee14c7346db6609f5b861039dda9e1fd89ffb933e3d012fa827061f5ff5b3bf48f9925602fd91

data/README.md

@@ -22,21 +22,27 @@ Or install it yourself as:
 
 ### ⚠️ Version compatibility ⚠️
 
+If you use [Social Wallet API](https://github.com/Commonfare-net/social-wallet-api) version 1.0 you must use [v1.1.0 of this gem](https://github.com/Commonfare-net/social_wallet_ruby/tree/d65c45e0aaca07cdf3a3affc483bb38d3dbef1c0).
+
 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).
 
+### Get the API KEY
+
+See [this guide](https://github.com/Commonfare-net/social-wallet-api/blob/master/APIKEY.md) for obtaining your API key.
+
 ### Create the client
 
 The default client uses the *database* `mongo` as backend.
 
 ```ruby
-client = SocialWallet::Client.new(api_endpoint: 'http://example.com/wallet/v1')
+client = SocialWallet::Client.new(api_endpoint: 'http://example.com/wallet/v1', api_key: 'YOUR_API_KEY')
 ```
 
 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', connection: 'faircoin', type: 'blockchain-and-db')
+client = SocialWallet::Client.new(api_endpoint: 'http://example.com/wallet/v1', api_key: 'YOUR_API_KEY', connection: 'faircoin', type: 'blockchain-and-db')
 ```
 
 ### List of tags

data/lib/social_wallet/client.rb

@@ -1,16 +1,18 @@
 module SocialWallet
   class Client
-    attr_accessor :api_endpoint, :blockchain, :request_data, :connection, :type
+    attr_accessor :api_endpoint, :api_key, :blockchain, :request_data, :connection, :type
 
     SW_ERROR_STATUSES = [404, 503].freeze
 
     def initialize(
       api_endpoint: nil,
+      api_key: '',
       blockchain: 'mongo',
       connection: 'mongo',
       type: 'db-only'
     )
       @api_endpoint = api_endpoint
+      @api_key = api_key
       @blockchain = blockchain # NOTE: here for backward compatibility
       @connection = connection
       @type = type
@@ -232,7 +234,7 @@ module SocialWallet
     def headers
       {
         'Content-Type' => 'application/json',
-        # 'x-api-key'    => ENV['SOCIAL_WALLET_API_KEY']
+        'x-api-key'    => api_key
       }
     end
   end

data/lib/social_wallet/version.rb

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

data/test_env.yml.example

@@ -1,4 +1,4 @@
 # Before running tests, copy this file to `test_env.yml`
 # and fill that file with the appropriate values
 TEST_API_ENDPOINT: http://example.com/wallet/v1
-TEST_API_KEY: your_api_key # not used in this release
+TEST_API_KEY: your_api_key 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: social_wallet
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - pbmolini