block_io 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c5193b5a4dd01b4b24b14f64b19dfcf2456804a
+  data.tar.gz: db1abcc37ba23f373029aaaa167dd00a04b96ebc
+SHA512:
+  metadata.gz: f38eb4a78f03aeab0feb85a7f4780643a857766adaf6e1efd7d2b751dda0434419d2bfdcaaf15be1dbc0d08a44412eb42e9e79dfde9b47f2ed8a7bf45d134065
+  data.tar.gz: 05fcea2062eb66e6683959659eccbd41914900874db4e0db706fe239a7b8b7a962ca02f80656ab2d44ef542f5e095e3d0f867b2587043d2eb327315ed30f7aee

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in block_io.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 BlockIo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Atif Nazir
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# BlockIo
+
+This Ruby Gem is the official reference client for the Block.io payments API. To use this, you will need the Dogecoin, Bitcoin, or Litecoin API key(s) from <a href="https://block.io" target="_blank">Block.io</a>. Go ahead, sign up :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'block_io'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install block_io
+
+## Usage
+
+It's super easy to get started. In your Ruby shell ($ irb), for example, do this:
+
+    require 'block_io'
+    BlockIo.set_options :api_key => 'API KEY', :pin => 'SECRET PIN'
+     
+And you're good to go:
+
+    BlockIo.get_new_address
+    BlockIo.get_my_addresses
+
+For more information, see https://block.io/api
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/block_io/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/block_io.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'block_io/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "block_io"
+  spec.version       = BlockIo::VERSION
+  spec.authors       = ["Atif Nazir"]
+  spec.email         = ["a@block.io"]
+  spec.summary       = %q{An easy to use Dogecoin, Bitcoin, Litecoin wallet API by Block.io. Sign up required at Block.io.}
+  spec.description   = %q{This Ruby Gem is the official reference client for the Block.io payments API. To use this, you will need the Dogecoin, Bitcoin, or Litecoin API key(s) from Block.io. Go ahead, sign up :)}
+  spec.homepage      = "https://block.io/api/ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "httpclient", "~> 2.4"
+  spec.add_development_dependency "json", "~> 1.8"
+  spec.add_development_dependency "connection_pool", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 0"
+end

data/lib/block_io/version.rb

@@ -0,0 +1,3 @@
+module BlockIo
+  VERSION = "0.1.0"
+end

data/lib/block_io.rb

@@ -0,0 +1,203 @@
+require "block_io/version"
+require 'httpclient'
+require 'json'
+require 'connection_pool'
+
+module BlockIo
+
+  @api_key = nil
+  @base_url = "https://block.io/api/v1/API_CALL/?api_key="
+  @pin = nil
+  @conn_pool = nil
+
+  def self.set_options(args = {})
+    # initialize BlockIo
+    @api_key = args[:api_key]
+    @pin = args[:pin]
+    @conn_pool = ConnectionPool.new(size: 5, timeout: 300) { HTTPClient.new }
+
+    self.api_call(['get_balance',""])
+  end
+
+  def self.get_offline_vault_balance
+    # returns the offline vault's balance
+    endpoint = ["get_offline_vault_balance",""]
+    self.api_call(endpoint)
+  end
+
+  def self.get_offline_vault_address
+    # returns the offline vault's address and balance info
+    self.get_offline_vault_balance
+  end
+
+  def self.get_balance
+    # returns the balances for your account tied to the API key
+    endpoint = ["get_balance", ""] 
+    self.api_call(endpoint)
+  end
+
+  def self.get_user_balance(args)
+    # returns the specified user's balance
+    
+    user_id = args[:user_id]
+
+    raise Exception.new("Must provide user_id") if user_id.nil?
+
+    endpoint = ['get_user_balance',"&user_id=#{user_id}"]
+
+    self.api_call(endpoint)
+  end
+
+  def self.get_address_balance(args)
+    # returns the specified address or address_label's balance
+    
+    address = args[:address]
+    address_label = args[:address_label]
+
+    raise Exception.new("Must provide ONE of address or address_label") if (!address.nil? and !address_label.nil?) or (address.nil? and address_label.nil?)
+
+    endpoint = ['get_address_balance',"&address=#{address}"] unless address.nil?
+    endpoint = ['get_address_balance',"&address_label=#{address_label}"] unless address_label.nil?
+
+    self.api_call(endpoint)
+  end
+
+  def self.get_current_price(args = {})
+    # returns prices from different exchanges as an array of hashes
+    price_base = args[:price_base]
+
+    endpoint = ['get_current_price', '']
+    endpoint = ['get_current_price',"&price_base=#{price_base}"] unless price_base.nil? or price_base.to_s.length == 0
+
+    self.api_call(endpoint)
+  end
+
+  def self.withdraw_from_user(args = {})
+    # withdraws coins from the given user(s)
+    self.withdraw(args)
+  end
+
+  def self.withdraw(args = {})
+    # validate arguments for withdrawal of funds TODO
+
+    raise Exception.new("PIN not set. Use BlockIo.set_options(:api_key=>'API KEY',:pin=>'SECRET PIN')") if @pin.nil?
+
+    # validate argument sets
+    amount = args[:amount]
+    to_user_id = args[:to_user_id]
+    payment_address = args[:payment_address]
+    from_user_ids = args[:from_user_ids] || args[:from_user_id]
+
+    raise Exception.new("Must provide ONE of payment_address, or to_user_id") if (!to_user_id.nil? and !payment_address.nil?) or (to_user_id.nil? and payment_address.nil?)
+    raise Exception.new("Must provide amount to withdraw") if amount.nil?
+
+    endpoint = ['withdraw',"&amount=#{amount}&payment_address=#{payment_address}&pin=#{@pin}"] unless payment_address.nil?
+    endpoint = ['withdraw',"&amount=#{amount}&to_user_id=#{to_user_id}&pin=#{@pin}"] unless to_user_id.nil?
+    endpoint = ['withdraw',"&amount=#{amount}&from_user_ids=#{from_user_ids}&pin=#{@pin}&payment_address=#{payment_address}"] unless from_user_ids.nil? or payment_address.nil?
+    endpoint = ['withdraw',"&amount=#{amount}&from_user_ids=#{from_user_ids}&to_user_id=#{to_user_id}&pin=#{@pin}"] unless to_user_id.nil? or from_user_ids.nil?
+
+    self.api_call(endpoint)
+  end
+
+  def self.get_new_address(args = {})
+    # validate arguments for getting a new address
+    address_label = args[:address_label]
+
+    endpoint = ['get_new_address','']
+    endpoint = ["get_new_address","&address_label=#{address_label}"] unless address_label.nil?
+
+    self.api_call(endpoint)
+  end
+
+  def self.create_user(args = {})
+    # validate arguments for getting a new address
+    address_label = args[:address_label]
+
+    endpoint = ['create_user','']
+    endpoint = ['create_user',"&address_label=#{address_label}"] unless address_label.nil?
+
+    self.api_call(endpoint)
+  end  
+
+  def self.get_my_addresses(args = {})
+    # returns all the addresses in your account tied to the API key
+    endpoint = ["get_my_addresses",""]
+
+    self.api_call(endpoint)
+  end
+
+  def self.get_users(args = {})
+    # returns all the addresses in your account tied to the API key
+    endpoint = ['get_users',""]
+
+    self.api_call(endpoint)
+  end
+
+  def self.get_address_received(args = {})
+    # get coins received, confirmed and unconfirmed, by the given address, address_label, or user_id
+    address_label = args[:address_label]
+    user_id = args[:user_id]
+    address = args[:address]
+
+    raise Exception.new("Must provide ONE of address_label, user_id, or address") unless args.keys.length == 1 and (!address_label.nil? or !user_id.nil? or !address.nil?)
+
+    endpoint = ['get_address_received','']
+    endpoint = ["get_address_received","&user_id=#{user_id}"] unless user_id.nil?
+    endpoint = ['get_address_received',"&address_label=#{address_label}"] unless address_label.nil?
+    endpoint = ['get_address_received',"&address=#{address}"] unless address.nil?
+
+    self.api_call(endpoint)
+  end
+
+  def self.get_user_received(args = {})
+    # returns the user's received coins, confirmed and unconfirmed
+
+    user_id = args[:user_id]
+
+    raise Exception.new("Must provide user_id") if user_id.nil?
+
+    self.get_address_received(:user_id => user_id)
+  end
+
+  def self.get_address_by_label(args = {})
+    # get address by label
+
+    address_label = args[:address_label]
+
+    raise Exception.new("Must provide address_label") if address_label.nil?
+
+    endpoint = ["get_address_by_label","&address_label=#{address_label}"]
+
+    self.api_call(endpoint)
+  end
+
+  def self.get_user_address(args = {})
+    # gets the user's address
+
+    user_id = args[:user_id]
+
+    raise Exception.new("Must provide user_id") if user_id.nil?
+
+    endpoint = ['get_user_address',"&user_id=#{user_id}"]
+
+    self.api_call(endpoint)
+  end
+
+  private
+
+  def self.api_call(endpoint)
+
+    body = nil
+
+    @conn_pool.with do |hc|
+      # prevent initiation of HTTPClients every time we make this call, use a connection_pool
+
+      response = hc.get("#{@base_url.gsub('API_CALL',endpoint[0]) + @api_key + endpoint[1]}")
+      body = JSON.parse(response.body)
+      
+    end
+    
+    body
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: block_io
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Atif Nazir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This Ruby Gem is the official reference client for the Block.io payments
+  API. To use this, you will need the Dogecoin, Bitcoin, or Litecoin API key(s) from
+  Block.io. Go ahead, sign up :)
+email:
+- a@block.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- block_io.gemspec
+- lib/block_io.rb
+- lib/block_io/version.rb
+homepage: https://block.io/api/ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An easy to use Dogecoin, Bitcoin, Litecoin wallet API by Block.io. Sign up
+  required at Block.io.
+test_files: []