blockchain-node 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61e4660d85fd214c44a0cd4265d92880e02b9e6f66dc854f43dd88c5b52487d6
-  data.tar.gz: 72e7791adc00517c1da3441072e60fb32f6b369f4994a92c7448fe4fffa28ab0
+  metadata.gz: b783f22fdaaef4c70e77ed848306df99755097442ac07916bb8bcd7482fbd40b
+  data.tar.gz: 84bc58e6ad3c4e722879aeb5ee9dafea9c2f3eb443451f7434a7acb8d7a3d15b
 SHA512:
-  metadata.gz: bd670cc0168af954ea0c726be2d4cc9df34b5dad9980c7cd4f471e7abe95d1ab21e7e6ffc9fd74475e5cc7b6a76e5deb5a2e894ee6a4d5783fb9dc71bffb9708
-  data.tar.gz: 2ed1ad1f25fd1c58de1207b7ad6e5456b9b7f0caa0748da774bf7fb62a6b0391610cde88f40a0a454d5a66e32c6d491b78baab4f501de44641446bdb9abe48e2
+  metadata.gz: 17599574b46a450e6c65e0a03f92fba493c09e2903ca64b0c14a2bdfdc6e17006414dc7d263f772a8a4070ce7ec2c6629e6cf550008a8d58a42f47d581803882
+  data.tar.gz: 5d70c7b73810567ad137e5db0837d17892bf805c28e563eda338f5856e01ec4b278d0ede804acc6c4db1f85c50a500a13017d6f1b3295c7302ca27348158b602

data/README.md

@@ -1,12 +1,10 @@
 # BlockchainNode (BCN) Ruby Client
 
+[![Gem Version](https://badge.fury.io/rb/blockchain-node.svg)](https://badge.fury.io/rb/blockchain-node)
+
 This gem is a secure RPC wrapper to connect to nodes launched by 
 [https://blockchainnode.io](https://blockchainnode.io). 
 
-Provides a Ruby library to the complete Bitcoin JSON-RPC API. Implements all methods listed
-at {https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list}[https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list].
-Also supports customizing the host and port number to connect to.
-
 ## Installation and Configuration
 
 ```bash
@@ -26,7 +24,7 @@ end
 
 **Security Note:**
 It is recommended that you secure your `CLIENT_ID` and `CLIENT_SECRET` and do not check that into your code repo.
-If your `CLIENT_ID` and `CLIENT_SECRET` are comprimised, your wallet will be secure as long as the it is
+If your `CLIENT_ID` and `CLIENT_SECRET` are compromised, your wallet will be secure as long as it is
 encrypted and not left unlocked.
 
 
@@ -40,14 +38,22 @@ node_id = "123ABC"
 client = BlockchainNode::Client.new(node_id)
 ```
 
+Make RPC method calls directly. Pass in parameters as args to the method call.
+
+Other helper methods: 
+
+```ruby
+# returns a list of nodes you have running on your account
+client.nodes
+```
+
 ### Bitcoin Example
 
 
-[Link to RPC Calls](README-RPC-BTC.md)
+[List of Bitcoin RPC Calls](README-RPC-BTC.md)
 
 ### Ethereum Example
 
-Make any RPC method call directly. Pass in parameters as args to the method call.
 
 Notice, for geth, responses are returned in hex so they have to be converted to an integer.
 
@@ -64,7 +70,7 @@ resp = client.eth_getBalance("0xf4c2a25fcbaad4e568fb74d6644b164e999d3132", "late
 Integer(resp[:response]) / 1000000000000000000.0
 ```
 
-[Link to RPC Calls](README-RPC-ETH.md)
+[List of Ethereum (geth) RPC Calls](README-RPC-ETH.md)
 
 ## Contact
 

data/lib/blockchain-node/client.rb

@@ -4,10 +4,10 @@ module BlockchainNode
     @@_auth_token
     AuthToken = Struct.new(:token, :expires_at)
 
-    attr_reader :node_id
+    attr_accessor :node_id
     attr_accessor :configuration
 
-    def initialize(node_id)
+    def initialize(node_id = nil)
       @node_id = node_id
       # allow a different configuration per client instance
       @configuration = BlockchainNode::Configuration.new
@@ -18,6 +18,10 @@ module BlockchainNode
       request.get(path: node_index_path, auth_token: auth_token)
     end
 
+    def details
+      request.get(path: nodes_path, auth_token: auth_token)
+    end
+
     def auth_token
       @@_auth_token ||= get_new_auth_token
       @@_auth_token = get_new_auth_token if auth_token_expired?
@@ -61,6 +65,7 @@ module BlockchainNode
     end
 
     def nodes_path
+      raise Errors::ClientNotConfigured.new("Client Needs to be initialized with a node id.") unless @node_id
       "/api/nodes/#{@node_id}"
     end
 

data/lib/blockchain-node/errors.rb

@@ -1,6 +1,7 @@
 module BlockchainNode
   module Errors
     class BadRequest < StandardError; end
+    class ClientNotConfigured < StandardError; end
     class UnAuthorized < StandardError; end
     class Unknown < StandardError; end
   end

data/lib/blockchain-node/version.rb

@@ -2,7 +2,7 @@
 module BlockchainNode
   MAJOR = 0
   MINOR = 0
-  PATCH = 3
+  PATCH = 4
 
   VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
 end

data/spec/lib/blockchain-node_spec.rb

@@ -49,6 +49,13 @@ describe BlockchainNode::Configuration do
   end
 
   describe "api calls" do
+    it "should return a list of nodes" do
+      stub_oauth
+      stub_get_nodes
+      client = BlockchainNode::Client.new
+      resp = client.nodes
+      expect(resp["nodes"].first["id"]).to eq(NODE_ID)
+    end
     it "should make a successful API call" do
       stub_oauth
       stub_basic_method
@@ -59,4 +66,19 @@ describe BlockchainNode::Configuration do
     end
   end
 
+  describe "client instantiation" do
+    it "should allow instantiation without a client id" do
+      client = BlockchainNode::Client.new
+      expect(client.node_id).to be_nil
+
+      expect{client.details}.to raise_error(BlockchainNode::Errors::ClientNotConfigured)
+      client.node_id = NODE_ID
+
+      stub_oauth
+      stub_get_node
+      resp = client.details
+      expect(resp["id"]).to eq(NODE_ID)
+    end
+  end
+
 end

data/spec/support/webmock.rb

@@ -17,10 +17,20 @@ def stub_oauth
     to_return(status: 200, body: OAUTH_RESPONSE.to_json)
 end
 
+def stub_get_node
+  stub_request(:get, "#{BlockchainNode::Request::DEFAULT_BASE_URL}/api/nodes/#{NODE_ID}").
+    to_return(status: 200, body: "{\"id\":\"#{NODE_ID}\",\"blockchain\":\"bitcoin\",\"network\":\"testnet\",\"status\":\"RUNNING\",\"height\":1454086}"  )
+end
+
+def stub_get_nodes
+  stub_request(:get, "#{BlockchainNode::Request::DEFAULT_BASE_URL}/api/nodes").
+    to_return(status: 200, body: "{\"nodes\":[{\"id\":\"#{NODE_ID}\",\"blockchain\":\"bitcoin\",\"network\":\"testnet\",\"status\":\"RUNNING\",\"height\":1454086}]}"  )
+end
+
 def stub_basic_method
   stub_request(:post, "#{BlockchainNode::Request::DEFAULT_BASE_URL}/api/nodes/#{NODE_ID}").
     with(body: api_method_body('eth_blockNumber')).
-    to_return(status: 200, body: '0x123A ')
+    to_return(status: 200, body: '0x123A')
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blockchain-node
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Matt Pestritto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-27 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry