tierion 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a6c61dbd6130591ba0ae23a7fa8845a8b2a4c8f
-  data.tar.gz: d7023dcf234d38ae0b383eb51ab5480d69427c41
+  metadata.gz: b96becbb97f59db9528c8ab605507dbd4c7d45fe
+  data.tar.gz: 2ac8b5c71e817e92fae8654f54823d250dc4ebe8
 SHA512:
-  metadata.gz: 39443a1eca9208226af6a56587ba863df0428a94f647c6d82dac1cdd122109c8a192fc7fa1034e6fb11f3c72780b8d0e9bc5a0e58774ffd8447516fa3b7d3b29
-  data.tar.gz: 1060b935d65af04add356b0679f327cf6ce1175fc6d61cf18f93d4b3c073d4c63fbbd5e97811a81f8e366e97e6c63df8fe418fcc380dfb2bfae5bc28c02a2e30
+  metadata.gz: cc52a5336bcc9092391c0a544ad432400de3baa9486ca1613f3d91b0ad65cf76389da4e55a90b42707876c2609d8dd3c28eab1fe57da2a9a56ef9feb0c396d85
+  data.tar.gz: 3f23fa5db012de8031cc8c34acdae3d3b2d282f5ce936fabefd3b5713f3eb58a0a8fd726081a1819260924d28864c482b96b9a3421be6a9e2bf83d7accc3763a

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v1.1.0 (8/6/2016)
+
+- Added `Receipt#valid?` method to verify Merkle tree proof.
+- Validates `Receipt` merkle tree and target hash match on import.
+- Added support for blockchain subscription API's
+
 ## v1.0.0 (8/5/2016)
 
 - Refactor Ruby API to better match the Client, HashItem, Receipt, Confirmation hierarchy.

data/README.md

@@ -22,6 +22,8 @@ Or install it yourself as:
 
 Shell commands start with a `$`, Ruby console commands start with `>`.
 
+### Client Authorization and Authentication
+
 Instantiate a new API client
 
 ```
@@ -42,6 +44,8 @@ $ export TIERION_PASSWORD=my_pass
 > t = Tierion::HashApi::Client.new
 ```
 
+### Send Hash
+
 Create the hash you want to record on the blockchain
 and send it.
 
@@ -53,6 +57,8 @@ and send it.
 => Tierion::HashApi::HashItem ...
 ```
 
+### Hash Items
+
 Now you can take a look at the Array of `HashItem`s.
 
 ```
@@ -81,6 +87,8 @@ the seconds since the UNIX epoch. For convenience you can use `HashItem#time` to
 => 2016-08-06 01:53:55 UTC
 ```
 
+### Receipts
+
 You can retrieve an individual `Tierion::HashApi::Receipt`
 for this `HashItem` by passing the `Hashitem` instance as
 an arg to `Client#receipt`
@@ -134,6 +142,16 @@ which are populated from the API. Here is an example:
 }
 ```
 
+You can check the validity of the Merkle Tree proof with `Receipt#valid?`
+which will do the math and hash the target hash with each of the proof hashes and verify that they hash properly and match the `merkleRoot` hash.
+
+This requires no external API access and is done locally.
+
+```
+> r.valid?
+=> true
+```
+
 The `Receipt` returns `anchors` which represent one or more trust
 anchors where your hash has been stored. Currently, the only `anchor`
 returned is `BTCOpReturn` which also gives you a `sourceId`
@@ -198,10 +216,34 @@ You can validate this JSON representation of the receipt by
 submitting it to the [Tierion validation](https://tierion.com/validate)
 web page.
 
-## TODO
+### Block Subscriptions
+
+You can also create, retrieve, update, and delete 'block subscriptions'.
 
-- Add blockchain receipt subscription functionality.
 
+```
+> t = Tierion::HashApi::Client.new
+=> #<Tierion::HashApi::Client ... >
+
+# takes a callback URL to receive payload, returns an ID
+> t.create_block_subscription('https://www.rempe.us/foo')
+=> {:id=>"57a67d59fb16c5bc06f8d4e5"}
+
+# takes an ID of an existing subscription and a new callback URL
+# returns the new `callbackUrl`
+> t.update_block_subscription("57a67d59fb16c5bc06f8d4e5", 'https://www.rempe.us/bar')
+=> {:callbackUrl=>"https://www.rempe.us/bar"}
+
+# takes an ID of an existing subscription, returns
+# the `callbackUrl`
+> t.get_block_subscription("57a67d59fb16c5bc06f8d4e5")
+=> {:callbackUrl=>"https://www.rempe.us/bar"}
+
+# takes an ID of an existing subscription, deletes it,
+# and returns the `callbackUrl` of the subscription deleted.
+> t.delete_block_subscription("57a67d59fb16c5bc06f8d4e5")
+=> {:callbackUrl=>"https://www.rempe.us/bar"}
+```
 
 ## Development
 

data/lib/tierion.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext/object/blank.rb'
 require 'active_support/core_ext/numeric'
 require 'active_support/core_ext/integer/time'
 require 'json'
+require 'digest'
 require 'httparty'
 require 'hashie'
 

data/lib/tierion/hash_api/client.rb

@@ -95,7 +95,12 @@ module Tierion
           Hashie.symbolize_keys!(receipt)
 
           if receipt.key?(:type) || receipt.key?('@type')
-            Tierion::HashApi::Receipt.new(receipt)
+            r = Tierion::HashApi::Receipt.new(receipt)
+            if h.hash == r.targetHash && r.valid?
+              return r
+            else
+              raise 'Invalid Receipt returned'
+            end
           else
             raise 'Invalid Receipt found'
           end
@@ -110,6 +115,72 @@ module Tierion
           @expires_at >= Time.now.utc
       end
 
+      def create_block_subscription(callback_url)
+        auth_refresh unless logged_in?
+        options = {
+          body: { 'callbackUrl' => callback_url },
+          headers: { 'Authorization' => "Bearer #{@access_token}" }
+        }
+        response = self.class.post('/blocksubscriptions', options)
+
+        if response.success?
+          parsed = response.parsed_response
+          Hashie.symbolize_keys!(parsed)
+          return parsed
+        else
+          raise_error(response)
+        end
+      end
+
+      def get_block_subscription(id)
+        auth_refresh unless logged_in?
+        options = {
+          headers: { 'Authorization' => "Bearer #{@access_token}" }
+        }
+        response = self.class.get("/blocksubscriptions/#{id}", options)
+
+        if response.success?
+          parsed = response.parsed_response
+          Hashie.symbolize_keys!(parsed)
+          return parsed
+        else
+          raise_error(response)
+        end
+      end
+
+      def update_block_subscription(id, callback_url)
+        auth_refresh unless logged_in?
+        options = {
+          body: { 'callbackUrl' => callback_url },
+          headers: { 'Authorization' => "Bearer #{@access_token}" }
+        }
+        response = self.class.put("/blocksubscriptions/#{id}", options)
+
+        if response.success?
+          parsed = response.parsed_response
+          Hashie.symbolize_keys!(parsed)
+          return parsed
+        else
+          raise_error(response)
+        end
+      end
+
+      def delete_block_subscription(id)
+        auth_refresh unless logged_in?
+        options = {
+          headers: { 'Authorization' => "Bearer #{@access_token}" }
+        }
+        response = self.class.delete("/blocksubscriptions/#{id}", options)
+
+        if response.success?
+          parsed = response.parsed_response
+          Hashie.symbolize_keys!(parsed)
+          return parsed
+        else
+          raise_error(response)
+        end
+      end
+
       private
 
       def raise_error(response)

data/lib/tierion/hash_api/receipt.rb

@@ -14,8 +14,44 @@ module Tierion
         @confs
       end
 
+      # Checks the validity of the Merkle tree proof and
+      # return true or false
+      def valid?
+        return false if targetHash.blank? || merkleRoot.blank?
+
+        # No siblings, single item tree, so the hash
+        # should also be the root
+        return targetHash == merkleRoot if proof.empty?
+
+        # The target hash (the hash the user submitted)
+        # is always hashed in the first cycle through the
+        # proofs. After that, the proof_hash value will
+        # contain intermediate hashes.
+        proof_hash = targetHash
+
+        proof.each do |p|
+          h = Digest::SHA256.new
+          if p.key?('left')
+            h.update hex2bin(p['left'])
+            h.update hex2bin(proof_hash)
+          elsif p.key?('right')
+            h.update hex2bin(proof_hash)
+            h.update hex2bin(p['right'])
+          else
+            return false
+          end
+          proof_hash = h.hexdigest
+        end
+
+        proof_hash == merkleRoot
+      end
+
       private
 
+      def hex2bin(hex)
+        [hex.to_s].pack('H*')
+      end
+
       def get_confirmations
         @confs = {} if @confs.blank?
 

data/lib/tierion/version.rb

@@ -1,3 +1,3 @@
 module Tierion
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tierion
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Glenn Rempe
@@ -30,7 +30,7 @@ cert_chain:
   zieXiXZSAojfFx9g91fKdIrlPbInHU/BaCxXSLBwvOM0drE+c2ue9X8gB55XAhzX
   37oBiw==
   -----END CERTIFICATE-----
-date: 2016-08-06 00:00:00.000000000 Z
+date: 2016-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty