bitcoin-3rd-party-apis 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,17 +1,22 @@
+## v0.2.0
+
+* Added http://blockchain.info call, BlockchainInfo.getreceivedbyaddress.
+* Refactored BlockExplorer slightly.
+
 ## v0.1.0
 
-* Renamed gem to bitcoin-3rd-party-apis
+* Renamed gem to bitcoin-3rd-party-apis.
 
 ## v0.0.3
 
-* Fixed bug (accidental 'puts' left behind)
+* Fixed bug (accidental 'puts' left behind).
 
 ## v0.0.2
 
-* Added BlockExplorer.getreceivedbyaddress
+* Added BlockExplorer.getreceivedbyaddress.
 
 ## v0.0.1 
 
 * Initial release
-* Added BlockExplorer.mytransactions
+* Added BlockExplorer.mytransactions.
 

data/README.md

@@ -1,12 +1,12 @@
-# BlockExplorer
+# Bitcoin 3rd-party APIs
 
-Ruby wrapper for Block Explorer (http://blockexplorer.com), a popular bitcoin blockchain explorer. BlockExplorer exposes some handy bitcoin blockchain query methods. This gem exposes some of those methods for easy consumption in a Ruby project.
+Ruby wrapper for various popular 3rd-party bitcoin related APIs. At the moment only Block Explorer (http://blockexplorer.com) and BlockChain.info (http://blockchain.info) are wrapped. The gem exposes some handy bitcoin blockchain query methods, useful for thin bitcoin clients.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'block_explorer'
+    gem 'bitcoin-3rd-party-apis'
 
 And then execute:
 
@@ -14,7 +14,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install block_explorer
+    $ gem install bitcoin-3rd-party-apis
 
 ## Usage
 
@@ -24,11 +24,14 @@ Or install it yourself as:
     BlockExplorer.mytransactions([address1, address2])
 
 
-`getreceivedbyaddress` returns BigDecimal of the total amount of bitcoins sent to the address. 
+`getreceivedbyaddress` returns BigDecimal of the total amount of bitcoins sent to the address. Note for the `BlockchainInfo` version, `120` is the maximum confirmation number.
 
     BlockExplorer.getreceivedbyaddress(address)
     BlockExplorer.getreceivedbyaddress(address, 3) # return received amount where transactions have minconf=3
 
+    BlockchainInfo.getreceivedbyaddress(address)
+    BlockchainInfo.getreceivedbyaddress(address, 3) # return received amount where transactions have minconf=3
+
 
 ## Contributing
 

data/lib/bitcoin-3rd-party-apis.rb

@@ -3,3 +3,4 @@ require 'json'
 
 require "bitcoin-3rd-party-apis/version"
 require 'block_explorer'
+require 'blockchain_info'

data/lib/bitcoin-3rd-party-apis/version.rb

@@ -1,3 +1,3 @@
 module Bitcoin3rdPartyApis
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/block_explorer.rb

@@ -1,6 +1,10 @@
-require "block_explorer/constants"
 require "block_explorer/block_chain"
 
-module BlockExplorer
+class BlockExplorer
+  private 
+  
+  def self.domain
+    "https://blockexplorer.com"
+  end
 end
 

data/lib/block_explorer/block_chain.rb

@@ -1,22 +1,19 @@
-module BlockExplorer
+class BlockExplorer
   module BlockChain
-    MyTransactions =        "#{BlockExplorer::Domain}/q/mytransactions"
-    RawTx =                 "#{BlockExplorer::Domain}/rawtx"
-    GetReceivedByAddress =  "#{BlockExplorer::Domain}/q/getreceivedbyaddress"
 
     def mytransactions(addresses)
       if addresses.is_a?(String)
         addresses = [addresses]
       end
       
-      get_json "#{MyTransactions}/#{addresses.join('.')}"
+      get_json "#{mytransactions_url}/#{addresses.join('.')}"
     end
 
     def getreceivedbyaddress(address, minconf = 0)
       if minconf > 0 
-        url = "#{GetReceivedByAddress}/#{address}/#{minconf}"
+        url = "#{getreceivedbyaddress_url}/#{address}/#{minconf}"
       else
-        url = "#{GetReceivedByAddress}/#{address}"
+        url = "#{getreceivedbyaddress_url}/#{address}"
       end
       
       BigDecimal(open(url).read)
@@ -27,6 +24,18 @@ module BlockExplorer
     # end
     
     private 
+        
+    def mytransactions_url
+      "#{domain}/q/mytransactions"
+    end
+    
+    def rawtx_url
+      "#{domain}/rawtx"
+    end
+    
+    def getreceivedbyaddress_url
+      "#{domain}/q/getreceivedbyaddress"
+    end
     
     def get_json(url)
       JSON.parse open(url).read

data/lib/blockchain_info.rb

@@ -0,0 +1,11 @@
+require 'blockchain_info/block_chain'
+
+class BlockchainInfo
+  
+  private 
+  
+  def self.domain
+    "https://blockchain.info"
+  end
+end
+

data/lib/blockchain_info/block_chain.rb

@@ -0,0 +1,30 @@
+class BlockchainInfo
+  module BlockChain
+
+    def getreceivedbyaddress(address, minconf = 0)
+      if minconf > 0 
+        url = "#{getreceivedbyaddress_url}/#{address}?confirmations=#{minconf}"
+      else
+        url = "#{getreceivedbyaddress_url}/#{address}"
+      end
+      
+      satoshi_to_bitcoins BigDecimal(open(url).read)
+    end
+
+    private 
+    
+    def satoshi_to_bitcoins(satoshi)
+      satoshi / (10 ** 8)
+    end
+                
+    def getreceivedbyaddress_url
+      "#{domain}/q/getreceivedbyaddress"
+    end
+    
+    def get_json(url)
+      JSON.parse open(url).read
+    end
+  end
+  
+  extend BlockChain
+end

data/spec/blockchain_info/blockchain_info_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe BlockchainInfo do
+  let(:addressA) { '1JDfUiJHZ6pDY6wWYTx86RYjDCW7QxCofs' }
+  let(:addressB) { '1KxepETPK2Xz8e5FaZE62y7Rww4LWuJUhG' }
+      
+  context '#getreceivedbyaddress' do
+    context "without minconf" do
+      use_vcr_cassette
+
+      it "returns the total received" do
+        BlockchainInfo.getreceivedbyaddress(addressA).should == BigDecimal("0.1")
+      end
+    end
+    
+    context "minconf" do
+      use_vcr_cassette
+
+      it "returns same number for old transactions" do
+        BlockchainInfo.getreceivedbyaddress(addressA, 120).should == BigDecimal("0.1")
+      end
+    end
+    
+  end
+end

data/spec/cassettes/BlockchainInfo/_getreceivedbyaddress/minconf.yml

@@ -0,0 +1,123 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://blockchain.info/q/getreceivedbyaddress/1JDfUiJHZ6pDY6wWYTx86RYjDCW7QxCofs?confirmations=99999999
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 500
+      message: Internal Server Error
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Content-Type:
+      - text/plain
+      Content-Length:
+      - '39'
+      Date:
+      - Mon, 18 Jun 2012 01:00:03 GMT
+      Connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: Confirmations must be between 0 and 120
+    http_version: 
+  recorded_at: Mon, 18 Jun 2012 01:00:03 GMT
+- request:
+    method: get
+    uri: https://blockchain.info/q/getreceivedbyaddress/1JDfUiJHZ6pDY6wWYTx86RYjDCW7QxCofs?confirmations=10
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Content-Type:
+      - text/plain
+      Content-Length:
+      - '8'
+      Date:
+      - Mon, 18 Jun 2012 01:04:50 GMT
+    body:
+      encoding: US-ASCII
+      string: '10000000'
+    http_version: 
+  recorded_at: Mon, 18 Jun 2012 01:04:51 GMT
+- request:
+    method: get
+    uri: https://blockchain.info/q/getreceivedbyaddress/1JDfUiJHZ6pDY6wWYTx86RYjDCW7QxCofs?confirmations=999999
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 500
+      message: Internal Server Error
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Content-Type:
+      - text/plain
+      Content-Length:
+      - '39'
+      Date:
+      - Mon, 18 Jun 2012 01:04:50 GMT
+      Connection:
+      - close
+    body:
+      encoding: US-ASCII
+      string: Confirmations must be between 0 and 120
+    http_version: 
+  recorded_at: Mon, 18 Jun 2012 01:04:52 GMT
+- request:
+    method: get
+    uri: https://blockchain.info/q/getreceivedbyaddress/1JDfUiJHZ6pDY6wWYTx86RYjDCW7QxCofs?confirmations=120
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Content-Type:
+      - text/plain
+      Content-Length:
+      - '8'
+      Date:
+      - Mon, 18 Jun 2012 01:06:21 GMT
+    body:
+      encoding: US-ASCII
+      string: '10000000'
+    http_version: 
+  recorded_at: Mon, 18 Jun 2012 01:06:23 GMT
+recorded_with: VCR 2.2.1

data/spec/cassettes/BlockchainInfo/_getreceivedbyaddress/without_minconf.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://blockchain.info/q/getreceivedbyaddress/1JDfUiJHZ6pDY6wWYTx86RYjDCW7QxCofs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Content-Type:
+      - text/plain
+      Content-Length:
+      - '8'
+      Date:
+      - Mon, 18 Jun 2012 01:06:21 GMT
+    body:
+      encoding: US-ASCII
+      string: '10000000'
+    http_version: 
+  recorded_at: Mon, 18 Jun 2012 01:06:22 GMT
+recorded_with: VCR 2.2.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitcoin-3rd-party-apis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-16 00:00:00.000000000 Z
+date: 2012-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70299806946180 !ruby/object:Gem::Requirement
+  requirement: &70255676113420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299806946180
+  version_requirements: *70255676113420
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70299806848620 !ruby/object:Gem::Requirement
+  requirement: &70255675997220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299806848620
+  version_requirements: *70255675997220
 - !ruby/object:Gem::Dependency
   name: ir_b
-  requirement: &70299806776800 !ruby/object:Gem::Requirement
+  requirement: &70255675850020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299806776800
+  version_requirements: *70255675850020
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70299806717860 !ruby/object:Gem::Requirement
+  requirement: &70255675283360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299806717860
+  version_requirements: *70255675283360
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70299806683180 !ruby/object:Gem::Requirement
+  requirement: &70255675361500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299806683180
+  version_requirements: *70255675361500
 description: Ruby wrapper for Block Explorer and Blockchain.info. Plan to add additional
   3rd-party bitcoin APIs
 email:
@@ -86,12 +86,16 @@ files:
 - lib/bitcoin-3rd-party-apis/version.rb
 - lib/block_explorer.rb
 - lib/block_explorer/block_chain.rb
-- lib/block_explorer/constants.rb
+- lib/blockchain_info.rb
+- lib/blockchain_info/block_chain.rb
 - spec/block_explorer/block_explorer_spec.rb
+- spec/blockchain_info/blockchain_info_spec.rb
 - spec/cassettes/BlockExplorer/_getreceivedbyaddress/minconf.yml
 - spec/cassettes/BlockExplorer/_getreceivedbyaddress/without_minconf.yml
 - spec/cassettes/BlockExplorer/_mytransactions/getting_transactions_for_2_addresses.yml
 - spec/cassettes/BlockExplorer/_mytransactions/getting_transactions_for_one_address.yml
+- spec/cassettes/BlockchainInfo/_getreceivedbyaddress/minconf.yml
+- spec/cassettes/BlockchainInfo/_getreceivedbyaddress/without_minconf.yml
 - spec/spec_helper.rb
 homepage: https://github.com/matholroyd/bitcoin-3rd-party-apis
 licenses: []
@@ -119,8 +123,11 @@ specification_version: 3
 summary: Ruby wrapper for various 3rd-party bitcoin APIs
 test_files:
 - spec/block_explorer/block_explorer_spec.rb
+- spec/blockchain_info/blockchain_info_spec.rb
 - spec/cassettes/BlockExplorer/_getreceivedbyaddress/minconf.yml
 - spec/cassettes/BlockExplorer/_getreceivedbyaddress/without_minconf.yml
 - spec/cassettes/BlockExplorer/_mytransactions/getting_transactions_for_2_addresses.yml
 - spec/cassettes/BlockExplorer/_mytransactions/getting_transactions_for_one_address.yml
+- spec/cassettes/BlockchainInfo/_getreceivedbyaddress/minconf.yml
+- spec/cassettes/BlockchainInfo/_getreceivedbyaddress/without_minconf.yml
 - spec/spec_helper.rb

data/lib/block_explorer/constants.rb

@@ -1,3 +0,0 @@
-module BlockExplorer
-  Domain = "https://blockexplorer.com"
-end