blockcypher-client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b261213992eff9f18aff58b6a330da9e83fb261
-  data.tar.gz: 7dbdbe0c9da75177f2769228a8a2991a720f0126
+  metadata.gz: f2a29f73f96f2b248dafb7fc35e2d880bbcf06aa
+  data.tar.gz: 2c1be189f0c326921bc641239d13e4bb277f736d
 SHA512:
-  metadata.gz: 5a091672a0cb2fe2d449de35207f5ecfed8f875e4443e63d822a7a85bb083d7f85a2d2caf62b81368022a20d15f02551697fb2c98593b70d5f11364884b61e44
-  data.tar.gz: 5162dc47d7177219e5993177f4ca48c1f9bf21e63b294eca1fd1bed1c6a8b6523b1a24cbb21a98bebf304145ed2a6f734a80f55ef1c5f22cf13f25f4c2c15b98
+  metadata.gz: f71139fc93454387d7760e6336c6f7be33718226da92abeb9b051dc36e0b5cca2a084262d03d4e7fa0bb3db8fc6e7ab84112a5db757fe6478f7bc0ab51545d21
+  data.tar.gz: 46aa746932879cfaaec25b416f65c679be48abff9f0b8c678093ec76ed422450c6f03078074868df030f10bec717ffe5fca530b9e2fbc5c3b5b8e95ba04fdeb1

data/README.md

@@ -1,29 +1,31 @@
 # Blockcypher::Client
 
-TODO: Write a gem description
+Allow usage of the [Blockcypher API](http://dev.blockcypher.com/reference.html) through Ruby
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'blockcypher-client'
+    $ gem install blockcypher-client
 
-And then execute:
+## Testing
 
-    $ bundle
+At the moment integration tests are hitting the live chains
 
-Or install it yourself as:
-
-    $ gem install blockcypher-client
+    $ rake
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Creates new default client (coin = btc, chain = main)
+client = Blockcypher::Client.new 
+json = client.chain                    # Return JSON info for the current chain
+json['name']                           # => 'BTC.main'
+
+litecoin = Blockcypher::Client.new(coin: :ltc)
+json = litecoin.transactions('4e6b95993b770e7d1084af128f971d6b44c5e32cbf3acc35eee84f69c6b4f9ea')
 
-## Contributing
+# Client for bitcoin on the test3 blockchain
+bitcoin_test = Blockcypher::Client.new(chain: :test3)
 
-1. Fork it ( http://github.com/<my-github-username>/blockcypher-client/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# Client with API token
+client = Blockcypher::Client.new(token: 'my_token')
+```

data/blockcypher-client.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["simcap@fastmail.com"]
   spec.summary       = %q{Basic Ruby wrapper to interact with the Blockcypher API}
   spec.description   = %q{Basic Ruby wrapper to interact with the Blockcypher API}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/simcap/blockcypher-client"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/blockcypher/client.rb

@@ -1,58 +1,26 @@
 require 'blockcypher/client/version'
+require 'blockcypher/client/api'
 
 require 'httpclient'
 require 'json'
 
 module Blockcypher
-  module Api
-
-    def transactions(txs_hash)
-      Call.new(base_uri).get("/txs/#{txs_hash}")
-    end
-    alias_method :txs, :transactions
-
-    def blocks(block_hash)
-      Call.new(base_uri).get("/blocks/#{block_hash}")
-    end
-
-    def address(add)
-      Call.new(base_uri).get("/addrs/#{add}")
-    end
-
-    def current
-      Call.new(base_uri).get
-    end
-    alias_method :status, :current
-
-    class Call
-
-      def initialize(base_uri)
-        @http = HTTPClient.new(base_url: base_uri.to_s) 
-      end
-
-      def get(path = '')
-        parse_response(@http.get_content(path))
-      end
-
-      private
-
-      def parse_response(response)
-        JSON.parse(response) 
-      end
-    end
-  end
-
   class Client
     include Api 
 
-    attr_reader :base_uri
+    attr_reader :config
 
     def initialize(options = {})
-      @chain = options[:chain] || :main
-      @coin = options[:coin] || :btc
-      @base_uri = URI("https://api.blockcypher.com/v1/#{@coin}/#{@chain}")
+      chain = options[:chain] || :main
+      coin = options[:coin] || :btc
+      @config = Config.new(
+        URI("https://api.blockcypher.com/v1/#{coin}/#{chain}"), 
+        options[:token]
+      )
     end
-
   end
 
+  Config = Struct.new(:base_uri, :token) do
+    undef []=, base_uri=, token=
+  end
 end

data/lib/blockcypher/client/api.rb

@@ -0,0 +1,68 @@
+module Blockcypher
+  class Client
+    module Api
+      def transactions(txs_hash)
+        new_call.get("/txs/#{txs_hash}")
+      end
+      alias_method :txs, :transactions
+
+      def blocks(block_hash)
+        new_call.get("/blocks/#{block_hash}")
+      end
+
+      def address(add)
+        new_call.get("/addrs/#{add}")
+      end
+
+      def create_address
+        new_call.post('/addrs')
+      end
+
+      def chain
+        new_call.get
+      end
+
+      private 
+
+      def new_call
+        Call.new(config)
+      end
+
+      class Call
+        def initialize(config)
+          @config = config
+          @http = HTTPClient.new(
+            base_url: @config.base_uri.to_s,
+            default_header: { Accept: 'application/json' }
+          ) 
+        end
+
+        def post(path, options = {})
+          perform(:post, path, options)
+        end
+
+        def get(path = '')
+          perform(:get, path)
+        end
+
+        private
+
+        def perform(verb, path, options = {})
+          options.merge!(query: params)
+          response = @http.public_send("#{verb.to_s}_content", path, options) 
+          parse_json(response)
+        rescue HTTPClient::BadResponseError => e
+          raise "Unexpected http status #{e.res.status} calling '#{e.res.header.request_uri.to_s}'"
+        end
+
+        def params
+          @config.token ? { token: @config.token } : {}
+        end
+
+        def parse_json(response)
+          JSON.parse(response) 
+        end
+      end
+    end
+  end
+end

data/lib/blockcypher/client/version.rb

@@ -1,5 +1,5 @@
 module Blockcypher
   class Client
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/integration/address_api_test.rb

@@ -11,4 +11,12 @@ class AddressApiTest < MiniTest::Test
     assert_equal add, json['address']
   end
 
+  def test_generate_address
+    client = Blockcypher::Client.new
+    json = client.create_address
+    refute_nil json['private']
+    refute_nil json['public']
+    refute_nil json['address']
+  end
+
 end

data/test/integration/current_chain_api_test.rb

@@ -0,0 +1,21 @@
+require 'minitest_helper'
+
+class CurrentChainApiTest < MiniTest::Test
+
+  def test_current_chain_for_different_chains
+    client = Blockcypher::Client.new
+    assert_equal 'BTC.main', client.chain['name']
+
+    client = Blockcypher::Client.new(chain: :test3)
+    assert_equal 'BTC.test3', client.chain['name']
+  end
+
+  def test_current_chain_for_different_coins
+    client = Blockcypher::Client.new(coin: :ltc)
+    assert_equal 'LTC.main', client.chain['name']
+
+    client = Blockcypher::Client.new(coin: :uro)
+    assert_equal 'URO.main', client.chain['name']
+  end
+
+end

data/test/integration/errors_test.rb

@@ -0,0 +1,13 @@
+require 'minitest_helper'
+
+class ErrorsApiTest < MiniTest::Test
+
+  def test_404_not_found
+    client = Blockcypher::Client.new
+    assert_raises RuntimeError do |error|
+      json = client.blocks('')
+      assert_match /404/, error.message
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blockcypher-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - simcap
@@ -89,7 +89,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,14 +96,16 @@ files:
 - bin/blockcypher-client
 - blockcypher-client.gemspec
 - lib/blockcypher/client.rb
+- lib/blockcypher/client/api.rb
 - lib/blockcypher/client/version.rb
 - test/integration/address_api_test.rb
 - test/integration/blocks_api_test.rb
-- test/integration/current_api_test.rb
+- test/integration/current_chain_api_test.rb
+- test/integration/errors_test.rb
 - test/integration/transactions_api_test.rb
 - test/minitest_helper.rb
 - test/test_blockcypher/client.rb
-homepage: ''
+homepage: https://github.com/simcap/blockcypher-client
 licenses:
 - MIT
 metadata: {}
@@ -131,7 +132,8 @@ summary: Basic Ruby wrapper to interact with the Blockcypher API
 test_files:
 - test/integration/address_api_test.rb
 - test/integration/blocks_api_test.rb
-- test/integration/current_api_test.rb
+- test/integration/current_chain_api_test.rb
+- test/integration/errors_test.rb
 - test/integration/transactions_api_test.rb
 - test/minitest_helper.rb
 - test/test_blockcypher/client.rb

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0

data/test/integration/current_api_test.rb

@@ -1,21 +0,0 @@
-require 'minitest_helper'
-
-class CurrentApiTest < MiniTest::Test
-
-  def test_current_status_for_different_chains
-    client = Blockcypher::Client.new
-    assert_equal 'BTC.main', client.current['name']
-
-    client = Blockcypher::Client.new(chain: :test3)
-    assert_equal 'BTC.test3', client.current['name']
-  end
-
-  def test_current_status_for_different_coins
-    client = Blockcypher::Client.new(coin: :ltc)
-    assert_equal 'LTC.main', client.current['name']
-
-    client = Blockcypher::Client.new(coin: :uro)
-    assert_equal 'URO.main', client.current['name']
-  end
-
-end