fbox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4184e7461676c58b9407104858c03b406e1f4119
+  data.tar.gz: 84ffa0cdc8511c09bac127a47f9f5ddb37b4211d
+SHA512:
+  metadata.gz: 14243ed18e6b3c75a373f91e2af39348829f20cc12a3cba6f48e373deb2705c98a09772b35dbab66d17ebe80e1ab3b44eb8a73f4428d23acbb8a93e983bad3eb
+  data.tar.gz: 5336158d4ecd3c9707d73b6ced228f34d9373bd48788310ad9fd2ed2b1fb9a2f186a2ad731d0dcc5a394a6cc62fb190dd2b0d7614dc32c82d3970fbdb6cb8b7a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015, Hothza
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,90 @@
+# Fbox
+
+This gem is a [FaucetBox](https://faucetbox.com) REST API helper. It allows you
+to integrate FaucetBox API in an easy way in your RubyOnRails application.
+
+Build status: [![Build Status](https://travis-ci.org/Hothza/fbox.svg)](https://travis-ci.org/Hothza/fbox)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fbox'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fbox
+
+## Usage
+
+Fbox has four FaucetBox API releated methods:
+
+- currencies - returns a list of currently supported coin types by FaucetBox
+```ruby
+    require 'pp'
+    require 'fbox'
+    
+    api_key = '4VdBEIAQKPpZ4SWOhQLUMn7mMNVql' # FBox example API key
+    fbox = Fbox::Client.new({:api_key => api_key})
+    currencies = fbox.currencies()
+
+    pp "Supported currencies: #{currencies}\n"
+```
+
+- balance(currency) - returns current balance fo given currency, if not set then BTC is used as a default one
+```ruby
+    require 'pp'
+    require 'fbox'
+    
+    # Unfortunately at this moment API key used in examples on FaucetBox site
+    # gives 403 status, so you have tou use your own
+    
+    api_key = '4VdBEIAQKPpZ4SWOhQLUMn7mMNVql' # Put your API key here
+    currency = 'BTC'
+    
+    fbox = Fbox::Client.new({:api_key => api_key})
+    balance = fbox.balance()
+    pp "balance: #{balance}\n"
+```
+
+- payment(to, amount, referral = false, currency = '') - sends a given amount of coins
+(in given currency, if not set than BTC is used as a default) from your faucet into destination address 
+
+```ruby
+    require 'pp'
+    require 'fbox'
+
+    api_key = ''      # Put here your API key
+    address = ''      # Put here destination address (BTC, LTC, or other supported by FaucetBox)
+    amount = 10       # Amount of satoshis to send
+    referral = false  # Is this a referral payment?
+    
+    fbox = Fbox::Client.new({:api_key => api_key})
+    payment = fbox.payment(address, amount, referral)
+    pp "payment: #{payment}\n"
+```
+
+- payouts(count = 1, currency = '') - returns list of payouts (no more than 10)
+from last 30 days for given currency (if not set than BTC is used as a default one)
+*WARNING:* This API call gives timeouts - use with care (it is probably disabled on FaucetBox)
+
+
+There are also two helper methods:
+
+- is_response_ok?(body) - returns true if FaucetBox respone has status: 200
+- is_address_valid?(address) - checks if given coin address is valid (proper length, correct checksum, etc.)
+
+
+## Contributing
+
+1. Fork it ( https://github.com/Hothza/fbox/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,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fbox"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fbox.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fbox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fbox"
+  spec.version       = Fbox::VERSION
+  spec.authors       = ["Hothza"]
+  spec.email         = ["hothza@users.noreply.github.com"]
+
+#  if spec.respond_to?(:metadata)
+#    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+#  end
+
+  spec.summary       = %q{Fbox - FaucetBox REST API helper. It allows you to integrate FaucetBox API in an easy way in your RubyOnRails application. }
+  spec.homepage      = "https://github.com/Hothza/fbox"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "minitest"
+  spec.add_dependency "coins_address_validator"
+end

data/lib/fbox.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2015, Hothza
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require "fbox/version"
+require "fbox/client"
+require "fbox/http_client"
+

data/lib/fbox/client.rb

@@ -0,0 +1,147 @@
+# Copyright (c) 2015, Hothza
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'json'
+require 'openssl'
+require 'coins_address_validator'
+
+module Fbox
+  class Client
+    attr_reader :options
+
+    DEFAULT_OPTIONS = {
+      :site               => 'https://faucetbox.com',
+      :context_path       => '',
+      :rest_base_path     => "/api/v1/",
+      :ssl_verify_mode    => OpenSSL::SSL::VERIFY_PEER,
+      :use_ssl            => true,
+      :api_key            => '',
+    }
+
+    FBOX_API = {
+      :balance            => 'balance',
+      :currencies         => 'currencies',
+      :payment            => 'send',
+      :payouts            => 'payouts',
+    }
+
+    @@addres_validator = nil
+    
+    def initialize(options={})
+      @@addres_validator = CoinsAddressValidator::Validator.new
+      options = DEFAULT_OPTIONS.merge(options)
+      @options = options
+      @options[:rest_base_path] = @options[:context_path] + @options[:rest_base_path]
+
+      @request_client = HttpClient.new(@options)
+
+      @options.freeze
+    end
+    
+    def balance(currency = '')
+      path = prepare_api_request(FBOX_API[:balance])
+      form_params = {
+        'api_key' => @options[:api_key],
+        'currency' => !currency.empty? ? currency : 'BTC'
+      }
+      response = request(path, form_params)
+      process_response(response)
+    end
+    
+    ##
+    ## Use with care it gives timeouts, probably this API call is disabled on FaucetBox
+    ##
+    def payouts(count = 1, currency = '')
+      if count.to_i > 0 && count <= 10
+        path = prepare_api_request(FBOX_API[:payouts])
+        form_params = {
+          'api_key' => @options[:api_key],
+          'count' => count,
+          'currency' => !currency.empty? ? currency : 'BTC'
+        }
+        response = request(path, form_params)
+        process_response(response)
+      else
+        invalid_parameter("'count' parameter has to be in 1..10 range")
+      end
+    end
+    
+    def currencies()
+      path = prepare_api_request(FBOX_API[:currencies])
+      response = request(path)
+      process_response(response)
+    end
+    
+    def payment(to, amount, referral = false, currency = '')
+      if !to.empty? && self.is_address_valid?(to) && amount > 0
+        path = prepare_api_request(FBOX_API[:payment])
+        form_params = {
+          'api_key' => @options[:api_key],
+          'to' => to,
+          'amount' => amount,
+          'currency' => !currency.empty? ? currency : 'BTC',
+          'referral' => referral.to_s
+        }
+        response = request(path, form_params)
+        process_response(response)
+      else
+        nil
+      end
+    end
+    
+    def is_response_ok?(body)
+      body['status'].present? && body['status'] == 200
+    end
+    
+    def is_address_valid?(address)
+      @@addres_validator.is_address_valid?(address)
+    end
+    
+    private
+      def invalid_parameter(message)
+        { :error => message }.to_json
+      end
+      
+      def process_response(response)
+        if response.code == '200'
+          JSON.parse(response.body)
+        else
+          { :status => response.code.to_i, :message => response.msg.to_s }.to_json
+        end
+      end
+      
+      def prepare_api_request(api)
+        @options[:site] + @options[:rest_base_path] + api
+      end
+
+      def request(path, form_params = {})
+        puts "\nREQ: #{path}"
+        @request_client.request(:post, path, '', default_headers(), form_params)
+      end
+
+      def default_headers()
+        { 'Content-type' => 'application/x-www-form-urlencoded' }
+      end
+  end
+end

data/lib/fbox/http_client.rb

@@ -0,0 +1,89 @@
+# Copyright (c) 2015, Hothza
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'net/https'
+require 'cgi/cookie'
+
+module Fbox
+  class HttpClient
+    attr_reader :options
+    
+    def initialize(options)
+      @options = options
+      @options.freeze
+      @cookies = {}
+    end
+
+    def make_request(http_method, path, body='', headers={}, form_params = {})
+      request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
+      request.body = body unless body.nil?
+      add_cookies(request) if options[:use_cookies]
+      request.set_form_data(form_params) if !form_params.empty? && http_method.to_s.capitalize == 'Post'
+      
+      response = http_conn(uri).request(request)
+      store_cookies(response) if options[:use_cookies]
+      response
+    end
+
+    def http_conn(uri)
+      if @options[:proxy_address]
+          http_class = Net::HTTP::Proxy(@options[:proxy_address], @options[:proxy_port] ? @options[:proxy_port] : 80)
+      else
+          http_class = Net::HTTP
+      end
+      http_conn = http_class.new(uri.host, uri.port)
+      http_conn.use_ssl = @options[:use_ssl]
+      http_conn.verify_mode = @options[:ssl_verify_mode]
+      http_conn
+    end
+
+    def uri
+      URI.parse(@options[:site])
+    end
+
+    def request(*args)
+      response = make_request(*args)
+      raise HTTPError.new(response) unless response.kind_of?(Net::HTTPSuccess)
+      response
+    end
+    
+    private
+      def store_cookies(response)
+        cookies = response.get_fields('set-cookie')
+        if cookies
+          cookies.each do |cookie|
+            data = CGI::Cookie.parse(cookie)
+            data.delete('Path')
+            @cookies.merge!(data)
+          end
+        end
+      end
+
+      def add_cookies(request)
+        cookie_array = @cookies.values.map { |cookie| cookie.to_s }
+        request.add_field('Cookie', cookie_array.join('; ')) if cookie_array.any?
+        request
+      end
+  end
+end

data/lib/fbox/version.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2015, Hothza
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Fbox
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: fbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hothza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coins_address_validator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hothza@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fbox.gemspec
+- lib/fbox.rb
+- lib/fbox/client.rb
+- lib/fbox/http_client.rb
+- lib/fbox/version.rb
+homepage: https://github.com/Hothza/fbox
+licenses:
+- BSD
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Fbox - FaucetBox REST API helper. It allows you to integrate FaucetBox API
+  in an easy way in your RubyOnRails application.
+test_files: []