tapbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e15f05fc034d20ae22e1ed3ffd827b314305634
+  data.tar.gz: 45ad5b318a1965aac0b081b43c6ec0832d72e619
+SHA512:
+  metadata.gz: 00875333f29d1006f55e47cbea9ea324b0dd9f9e127bcc6ae6e4969a3ef05f87f36125dbcc1da16efa04531e241c2596183e06880a1319f37e9df7957389da58
+  data.tar.gz: 38df0f610521e77a084f28685704a92250baf2f1e02298d634bf3b949414eb84dff1ef907f577e2910a283fb424ace9e03762a5577fbad01efb11f8d05aacfc5

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'httparty', '~> 0.13.7'
+gem 'hashie', '~> 3.4', '>= 3.4.2'
+
+# Specify your gem's dependencies in tapbot.gemspec
+gemspec

data/README.md

@@ -0,0 +1,152 @@
+# Tapbot
+
+[![Build Status](https://travis-ci.org/Tapbot/tapbot-ruby.svg?branch=master)](https://travis-ci.org/Tapbot/tapbot-ruby)
+[![Code Climate](https://codeclimate.com/github/Tapbot/tapbot-ruby/badges/gpa.svg)](https://codeclimate.com/github/Tapbot/tapbot-ruby)
+
+Official Tapbot API ruby gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tapbot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tapbot
+
+## Usage
+
+###Client
+First of all you should initialize a Tapbot client with your rest-token and secret.
+```ruby
+client = Tapbot.client(rest_token: "your-token-here", rest_secret: "your-secret-here")
+```
+###User profiles
+```ruby
+profile = client.profile("username")
+```
+Profile object
+```ruby
+profile.username => user username
+profile.firstname => user first name
+profile.lastname => user last name
+profile.payment_address => user payment address
+profile.bio => user bio 
+```
+###Me
+```ruby
+me = client.me
+```
+Me object:
+```ruby
+me.username => my username
+me.firstname => user first name
+me.lastname => user last name
+me.payment_address => user payment address
+me.bio => user bio 
+me.email => my email
+me.balance => my balance
+```
+###Prices
+```ruby
+price = client.price
+```
+Price object
+```ruby
+price.taps
+price.btc
+price.usd
+```
+###Transactions list
+```ruby
+transactions = client.transaction_list(paginate: 10, page: 5) # optional paginate and page options 
+```
+Transactions list object
+```ruby
+transactions.page
+transactions.per_page
+transactions.total_pages
+transactions.total_transactions
+transactions.transactions
+```
+###Transaction details
+```ruby
+transaction = client.transaction_details("transaction-id")
+```
+Transaction object
+```ruby
+transaction.transaction_id
+transaction.from
+transaction.to
+transaction.amount
+transaction.date
+transaction.comments
+```
+###Create a Transaction
+```ruby
+transaction = client.create_transaction("username", amount) # transaction destination username
+```
+If everithing is ok it should return a Transaction object
+```ruby
+transaction.transaction_id
+transaction.from
+transaction.to
+transaction.amount
+transaction.date
+transaction.comments
+```
+Otherwise it should raise a Tapbot::Error with a concrete message
+###Exchange details
+```ruby
+exchange = client.exchange_details("exchange-id")
+```
+Exchange object
+```ruby
+exchange.exchange_id
+exchange.btc_address
+exchange.status
+exchange.from
+exchange.to
+exchange.from_amount
+exchange.to_amount
+exchange.date
+```
+###Create an Exchange
+```ruby
+exchange = client.create_exchange(amount, "btc-address") # TAP amount to exchange to BTC and your Wallet address
+```
+If everithing is ok it should return a Exchange object
+```ruby
+exchange.exchange_id
+exchange.btc_address
+exchange.status
+exchange.from
+exchange.to
+exchange.from_amount
+exchange.to_amount
+exchange.date
+```
+Otherwise it should raise a Tapbot::Error with a concrete message
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tapbot/tapbot-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tapbot/api.rb

@@ -0,0 +1,22 @@
+module Tapbot
+  class Api
+    
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options={})
+      options = Tapbot.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+    
+  end
+end

data/lib/tapbot/client/exchanges.rb

@@ -0,0 +1,19 @@
+module Tapbot
+  class Client
+    module Exchanges
+      
+      def exchange_details(id)
+        response = self.class.get("/exchanges/#{id}", headers: auth_headers("/exchanges/#{id}"))
+        raise Tapbot::Error, response["errors"][0] unless response.success?
+        response
+      end
+      
+      def create_exchange(amount, address)
+        response = self.class.post("/exchanges", { :body => {:exchange => { from_amount: amount, btc_address: address }}.to_json, headers: auth_headers("/exchanges", { :exchange => { from_amount: amount, btc_address: address }}.to_json)})
+        raise Tapbot::Error, response["errors"][0] unless response.success?
+        response
+      end
+      
+    end
+  end
+end

data/lib/tapbot/client/prices.rb

@@ -0,0 +1,13 @@
+module Tapbot
+  class Client
+    module Prices  
+        
+      def price
+        response = self.class.get("/price", headers: auth_headers("/price"))
+        raise Tapbot::Error, response["errors"][0] unless response.success?
+        response
+      end  
+      
+    end
+  end
+end

data/lib/tapbot/client/transactions.rb

@@ -0,0 +1,27 @@
+module Tapbot
+  class Client
+    module Transactions        
+      
+      def transaction_list(options={})
+        page = options[:page] || 1
+        paginate = options[:paginate] || 50
+        response = self.class.get("/transactions?paginate=#{paginate}&page=#{page}", headers: auth_headers("/transactions?paginate=#{paginate}&page=#{page}"))
+        raise Tapbot::Error, response["errors"][0] unless response.success?
+        response
+      end  
+      
+      def transaction_details(id)
+        response = self.class.get("/transactions/#{id}", headers: auth_headers("/transactions/#{id}"))
+        raise Tapbot::Error, response["errors"][0] unless response.success?
+        response
+      end
+      
+      def create_transaction(to, amount, comments="")
+        response = self.class.post("/transactions", { :body => {:transaction => { to: to, amount: amount, comments: comments }}.to_json, headers: auth_headers("/transactions", { :transaction => { to: to, amount: amount, comments: comments }}.to_json)})
+        raise Tapbot::Error, response["errors"][0] unless response.success?
+        response
+      end
+      
+    end
+  end
+end

data/lib/tapbot/client/users.rb

@@ -0,0 +1,18 @@
+module Tapbot
+  class Client
+    module Users
+    
+      def profile(username)
+        response = self.class.get("/users/#{username}")
+        raise Tapbot::Error, response["errors"][0] unless response.success?
+        response
+      end
+  
+      def me
+        response = self.class.get("/users/me", headers: auth_headers("/users/me"))
+        raise Tapbot::Error, response["errors"][0] unless response.success?
+        response
+      end
+    end
+  end
+end

data/lib/tapbot/client.rb

@@ -0,0 +1,37 @@
+module Tapbot
+  class Client < Api
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+  
+    include HTTParty
+    
+    parser Tapbot::Parser
+    
+    base_uri Tapbot::Configuration::BASE_URI
+          
+    def auth_headers(url, body="")
+        ts = Time.now.to_i.to_s
+        if rest_secret && rest_token && url
+          signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'),
+                                              rest_secret,
+                                              rest_token + ts + (Tapbot::Configuration::BASE_URI + url) + body.to_s)
+              
+                                            
+          { 
+            "Content-Type" => "application/json", 
+            "Accept" => "application/json",
+            "User-Agent" => Tapbot::Configuration::USER_AGENT,
+            'TP-REST-TOKEN' => rest_token,
+            'TP-ACCESS-SIGNATURE' => signature,
+            'TP-ACCESS-TIMESTAMP' => ts,
+            'TP-API-VERSION' => Tapbot::Configuration::API_VERSION }
+        else
+          raise Tapbot::Error, "Invalid credentials"
+        end
+    end
+   
+    include Tapbot::Client::Users
+    include Tapbot::Client::Prices
+    include Tapbot::Client::Transactions
+    include Tapbot::Client::Exchanges
+  end
+end

data/lib/tapbot/configuration.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../version', __FILE__)
+
+module Tapbot
+  module Configuration    
+    VALID_OPTIONS_KEYS = [:rest_token, :rest_secret].freeze
+    BASE_URI = 'https://api.tapbot.com/v1'.freeze
+    USER_AGENT = "tapbot-ruby #{Tapbot::VERSION}".freeze
+    API_VERSION = "v1"
+    
+    attr_accessor *VALID_OPTIONS_KEYS
+    
+    def configure
+      yield self
+    end
+    
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+    
+  end
+end

data/lib/tapbot/error.rb

@@ -0,0 +1,3 @@
+module Tapbot
+  class Error < StandardError; end  
+end

data/lib/tapbot/parser.rb

@@ -0,0 +1,15 @@
+module Tapbot
+  class Parser < HTTParty::Parser
+    SupportedFormats = {'application/json' => :json}
+    
+    def initialize(body, format)
+      @body = body
+      @format = format
+    end
+
+    def json
+      Hashie::Mash.new(JSON.parse(body))
+    end
+    
+  end
+end

data/lib/tapbot/version.rb

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

data/lib/tapbot.rb

@@ -0,0 +1,17 @@
+require 'httparty'
+require 'hashie'
+require "tapbot/version"
+require "tapbot/error"
+require "tapbot/configuration"
+require "tapbot/api"
+require "tapbot/parser"
+require "tapbot/client"
+
+module Tapbot
+  extend Configuration
+  
+  def self.client(options={})
+    Tapbot::Client.new(options)
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'tapbot'
+require 'rspec'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

data/spec/tapbot_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Tapbot do
+  it 'has a version number' do
+    expect(Tapbot::VERSION).not_to be nil
+  end
+  
+  describe "CLIENT" do
+    it "should be a Tapbot::Client" do
+      expect(Tapbot.client).to be_a Tapbot::Client
+    end
+  end
+  
+  describe "BASE URI" do
+    it "should return the default base uri" do
+      expect(Tapbot::Configuration::BASE_URI).to eq("https://api.tapbot.com/v1")
+    end
+  end
+  
+  describe "API VERSION" do
+    it "should return the default API version" do
+      expect(Tapbot::Configuration::API_VERSION).to eq("v1")
+    end
+  end
+  
+  describe "User Agent" do
+    it "should return the default API version" do
+      expect(Tapbot::Configuration::USER_AGENT).to eq("tapbot-ruby #{Tapbot::VERSION}")
+    end
+  end
+  
+  describe "Configuration" do
+    Tapbot::Configuration::VALID_OPTIONS_KEYS.each do |key|
+      it "should set the #{key}" do
+        Tapbot.configure do |config|
+          config.send("#{key}=", key)
+          expect(Tapbot.send(key)).to eq(key)
+        end
+      end
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: tapbot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Ramirez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: webmock
+  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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+description: Tapbot api gem
+email:
+- david@davidrv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/tapbot.rb
+- lib/tapbot/api.rb
+- lib/tapbot/client.rb
+- lib/tapbot/client/exchanges.rb
+- lib/tapbot/client/prices.rb
+- lib/tapbot/client/transactions.rb
+- lib/tapbot/client/users.rb
+- lib/tapbot/configuration.rb
+- lib/tapbot/error.rb
+- lib/tapbot/parser.rb
+- lib/tapbot/version.rb
+- spec/spec_helper.rb
+- spec/tapbot_spec.rb
+homepage: https://tapbot.readme.io/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Tapbot api gem
+test_files: []