bitreserve 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22fd7b702c886113b8b2c1c6e382721f4b0c84df
-  data.tar.gz: b24e3a7fb9626dbaab357683a2fb3645bac2d64a
+  metadata.gz: f186b06c781c63fe87bc6e16c2528b51fe2f9c6a
+  data.tar.gz: bd8d53c2aa34b64500f6a2bebe7d616510452d84
 SHA512:
-  metadata.gz: cd8989fe44205b5660954800ffd3b1934066d341e4d495e2fb0555bb28f3f8485d956d10eb224365d7417573b63c37d75c51621f2182fb96a9d7f36acc5b08d6
-  data.tar.gz: 2eb14790b044dce1b71264fc1267dbfde5637bf17042bc119aaecfb6f852190ee2a4b3361ac383f51925669a7f9657094958fb2d896294e63ede9caa202fd557
+  metadata.gz: b6ae05f969c7e315f6c6f1723c9269b7c8962678b93f5971d75bca765110223fe0e978995e026ad445729c342e72388e0d4c7b56e235f8a576247f8979dec98f
+  data.tar.gz: 94e73c2fb2aa3d2c6c17854f4d5277c71eab2fa138ece11256aff22c10482652b153fe7833eb8b15beab284176ae45b5c9f63dc1e16a8d748e66ee5f328d5315

data/README.md

@@ -5,9 +5,9 @@
 [![Code Climate](https://codeclimate.com/github/groupbuddies/bitreserve/badges/gpa.svg)](https://codeclimate.com/github/groupbuddies/bitreserve)
 [![Test Coverage](https://codeclimate.com/github/groupbuddies/bitreserve/badges/coverage.svg)](https://codeclimate.com/github/groupbuddies/bitreserve)
 
-TODO: Write a gem description
+A ruby client for the [Bitreserve](https://bitreserve.org/) API.
 
-## Installation
+# Installation
 
 Add this line to your application's Gemfile:
 
@@ -23,14 +23,245 @@ Or install it yourself as:
 
     $ gem install bitreserve
 
-## Usage
+# Contents
 
-TODO: Write usage instructions here
+* [Usage](#usage)
+* [Creating an authenticated client](#creating-an-authenticated-client)
+  * [Personal Access Token](#personal-access-token)
+    * [Via argument](#via-argument)
+    * [Via environment variable](#via-environment-variable)
+* [Endpoints](#endpoints)
+  * [Authentication](#authentication)
+    * [OAuth2](#oauth2)
+    * [Basic Authentication](#basic-authentication)
+  * [Tickers](#tickers)
+  * [Entities](#entities)
+  * [Cards](#cards)
+  * [Transactions](#transactions)
+    * [Public Transactions](#public-transactions)
+    * [Private Transactions](#private-transactions)
+  * [Contacts](#contacts)
+  * [Users](#users)
+  * [Transparency](#transparency)
+* [Contributing](#contributing)
 
-## Contributing
+# Usage
 
-1. Fork it ( https://github.com/[my-github-username]/bitreserve/fork )
+To use the gem, you have to instantiate a client. All API calls are made from there. Here's a minimal working example:
+
+```ruby
+require 'bitreserve'
+
+client = Bitreserve::Client.new
+puts client.all_tickers
+```
+
+# Creating an authenticated client
+
+In order to make most of the API calls, you will need to authenticate your
+client. Here's how you can do that.
+
+## Personal Access Token
+
+If you already have a token, you can use it by setting an environment variable,
+or by passing it when instantiating the client.
+
+### Via argument
+
+Pass the token to the constructor:
+
+```ruby
+Bitreserve::Client.new(token: 'your-access-token')
+```
+
+### Via environment variable
+
+Set the environment variable using [dotenv](https://github.com/bkeepers/dotenv), or by exporting it in your shell:
+
+```bash
+$ export BITRESERVE_AUTH_TOKEN="your-access-token"
+```
+
+Then instantiate the client:
+
+```ruby
+Bitreserve::Client.new
+```
+
+# Endpoints
+
+This is a comprehensive list of all the mappings between this wrapper and the
+Bitreserve's API.
+
+## Authentication
+
+[*Bitreserve documentation on authentication*](https://developer.bitreserve.org/api/v0/#authentication)
+
+### OAuth2
+
+**NOT SUPPORTED YET**
+
+### Basic Authentication
+
+TODO
+
+## Tickers
+
+[*Bitreserve documentation on tickers*](https://developer.bitreserve.org/api/v0/#tickers)
+
+**Return the current rates on Bitreserve for all currency pairs:**
+
+```ruby
+client.all_tickers
+```
+
+**Return the current rates on Bitreserve for a specific currency:**
+
+```ruby
+client.find_ticker(currency: 'EUR')
+```
+
+## Cards
+
+[*Bitreserve documentation on cards*](https://developer.bitreserve.org/api/v0/#cards)
+
+**Return all the user's cards:**
+
+```ruby
+client.all_cards
+```
+
+**Return the details for a specific card associated with the user:**
+
+```ruby
+client.find_card(id: '37e002a7-8508-4268-a18c-7335a6ddf24b')
+```
+
+**Create a card for the user:**
+
+```ruby
+client.create_card(label: 'My label', currency: 'BTC')
+```
+
+## Transactions
+
+[*Bitreserve documentation on transactions*](https://developer.bitreserve.org/api/v0/#transactions)
+
+You can interact with both the authenticated user's and public transactions.
+
+### Public Transactions
+
+**Return the public view of all transactions in the reserve:**
+
+```ruby
+client.all_public_transactions
+```
+
+**Return the public view of a specific transaction:**
+
+```ruby
+client.find_public_transactions(id: 'a97bb994-6e24-4a89-b653-e0a6d0bcf634')
+```
+
+### Private Transactions
+
+**Create a transaction:**
+
+```ruby
+client.create_transaction(card_id: 'a6d35fcd-xxxx-9c9d1dda6d57', currency:
+'BTC', amount: 0.1, destination: 'foo@bar.com')
+```
+
+**Commit a transaction:**
+
+```ruby
+client.commit_transaction(card_id: 'a6d35fcd-xxxx-9c9d1dda6d57', transaction_id:
+'d51b4e4e-9827-40fb-8763-e0ea2880085b')
+```
+
+**Cancel a transaction:**
+
+```ruby
+client.cancel_transaction(card_id: 'a6d35fcd-xxxx-9c9d1dda6d57', transaction_id:
+'d51b4e4e-9827-40fb-8763-e0ea2880085b')
+```
+
+**Resend a transaction:**
+
+```ruby
+client.resend_transaction(card_id: 'a6d35fcd-xxxx-9c9d1dda6d57', transaction_id:
+'d51b4e4e-9827-40fb-8763-e0ea2880085b')
+```
+
+**Return all transactions associated with the user:**
+
+```ruby
+client.all_user_transactions
+```
+
+**Return all transactions associated with a card:**
+
+```ruby
+client.all_card_transactions
+```
+
+## Contacts
+
+[*Bitreserve documentation on contacts*](https://developer.bitreserve.org/api/v0/#contacts)
+
+**Return all the user's contacts:**
+
+```ruby
+client.all_contacts
+```
+
+**Return the details for a specific contact associated with the user:**
+
+```ruby
+client.find_contact(id: '9fae84eb-712d-4b6a-9b2c-764bdde4c079')
+```
+
+**Create a contact for the user:**
+
+```ruby
+client.create_contact(first_name: 'Luke', last_name: 'Skywalker', company: 'Lars
+Moisture Farm Inc', emails: ['support@larsmoisturefarm.com')
+```
+
+## Users
+
+[*Bitreserve documentation on users*](https://developer.bitreserve.org/api/v0/#users)
+
+**Return the details of the user:**
+
+```ruby
+client.me
+```
+
+**Return the list of phone numbers associated with the user:**
+
+```ruby
+client.phones
+```
+
+## Transparency
+
+[*Bitreserve documentation on transparency*](https://developer.bitreserve.org/api/v0/#reserve-status)
+
+**Return a summary of all obligations and assets:**
+
+```ruby
+client.statistics
+```
+
+# Contributing
+
+1. Fork it ( https://github.com/groupbuddies/bitreserve/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+4. 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
+
+# Copyright
+
+Copyright (c) 2015 Group Buddies. See [LICENSE.txt](LICENSE.txt) for further details.

data/lib/bitreserve/api/auth_token.rb

@@ -1,15 +1,16 @@
+require 'base64'
+
 module Bitreserve
   module API
     module AuthToken
-      def generate_access_token(username: '', password: '')
+      def generate_access_token(username: '', password: '', otp: '')
         request_data = Bitreserve::RequestData.new(
           Endpoints::AUTH,
           Entities::AuthToken,
-          authorization_header,
-          nil,
-          username: username, password: password
+          { 'X-Bitreserve-OTP' => otp, 'Authorization' => 'Basic ' + Base64.encode64("#{username}:#{password}") },
+          description: 'Bitreserve ruby'
         )
-        AuthRequest.perform_with_object(:post, request_data)
+        Request.perform_with_object(:post, request_data)
       end
     end
   end

data/lib/bitreserve/api/endpoints.rb

@@ -1,6 +1,6 @@
 module Bitreserve
   module Endpoints
-    AUTH = '/oauth2/tokens'
+    AUTH = '/me/tokens'
     CARD = '/me/cards'
     CARD_PRIVATE_TRANSACTIONS = CARD + '/:card/transactions'
     COMMIT_TRANSACTION = CARD_PRIVATE_TRANSACTIONS + '/:id/commit'

data/lib/bitreserve/request.rb

@@ -1,6 +1,7 @@
 module Bitreserve
-  class BaseRequest
+  class Request
     include ::HTTParty
+    base_uri "#{Bitreserve.api_base}/v#{Bitreserve.api_version}"
 
     def self.perform_with_objects(http_method, request_data)
       response = new(request_data).public_send(http_method)
@@ -15,7 +16,6 @@ module Bitreserve
     def initialize(request_data)
       @path = request_data.endpoint
       @data = request_data.payload
-      @auth = request_data.auth
       @headers = request_data.headers
     end
 
@@ -36,21 +36,13 @@ module Bitreserve
     attr_reader :path, :data, :auth, :headers
 
     def options
-      { basic_auth: auth, body: data, headers: headers }.
+      { body: data, headers: headers }.
         reject { |_k, v| v.nil? }
     end
 
     def log_request_info(http_method, response)
-      Bitreserve.logger.info "[Bitreserve] #{http_method.to_s.upcase} #{self.class.base_uri}#{path} #{self.class.headers} #{response.code}"
+      Bitreserve.logger.info "[Bitreserve] #{http_method.to_s.upcase} #{self.class.base_uri}#{path} #{options[:headers]} #{response.code}"
       Bitreserve.logger.debug response.parsed_response
     end
   end
-
-  class Request < BaseRequest
-    base_uri "#{Bitreserve.api_base}/v#{Bitreserve.api_version}"
-  end
-
-  class AuthRequest < Request
-    base_uri Bitreserve.api_base
-  end
 end

data/lib/bitreserve/request_data.rb

@@ -1,6 +1,6 @@
 module Bitreserve
-  class RequestData < Struct.new(:endpoint, :entity, :headers, :payload, :auth)
-    def initialize(endpoint, entity, headers = {}, payload = nil, auth = nil)
+  class RequestData < Struct.new(:endpoint, :entity, :headers, :payload)
+    def initialize(endpoint, entity, headers = {}, payload = nil)
       super
     end
   end

data/lib/bitreserve/version.rb

@@ -1,3 +1,3 @@
 module Bitreserve
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/spec/fixtures/vcr_cassettes/pats.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://example:Password123@api.bitreserve.org/v0/me/tokens
+    body:
+      encoding: UTF-8
+      string: description=Bitreserve%20ruby
+    headers:
+      X-Bitreserve-Otp:
+      - '5960110'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Thu, 29 Jan 2015 16:24:12 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '106'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d8a73547e05f107f8c796bfcc238d8f851422548652; expires=Fri, 29-Jan-16
+        16:24:12 GMT; path=/; domain=.bitreserve.org; HttpOnly
+      X-Content-Security-Policy:
+      - default-src "none"
+      Content-Security-Policy:
+      - default-src "none"
+      X-Webkit-Csp:
+      - default-src "none"
+      Strict-Transport-Security:
+      - max-age=31536000
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-Bitreserve-Request-Id:
+      - 9eed6cc1-c6f3-43ac-9acf-9286a83935c7
+      X-Ratelimit-Limit:
+      - '300'
+      X-Ratelimit-Remaining:
+      - '298'
+      X-Ratelimit-Reset:
+      - '1422548935'
+      Cf-Ray:
+      - 1b06c7540a6e0ddb-MAD
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"853d580429364a90a6e02cb1f89e257a58da9064","description":"Bitreserve
+        ruby","expires":null}'
+    http_version: 
+  recorded_at: Thu, 29 Jan 2015 16:24:14 GMT
+recorded_with: VCR 2.9.3

data/spec/integration/api/auth_token_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module Bitreserve
+  module API
+    describe AuthToken do
+      let(:client) { Client.new }
+
+      context '#generate_access_token' do
+        it 'generates a personal access token' do
+          VCR.use_cassette('pats') do
+            token = client.generate_access_token(username: 'example', password: 'Password123', otp: '5960110')
+
+            expect(token).to be_a(Entities::AuthToken)
+            expect(token.access_token).to be_a(String)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/webmock.rb

@@ -8,17 +8,4 @@ module WebMockHelpers
     WebMock::API.stub_request(method, Bitreserve::Request.base_uri + url).
       to_return(body: response.to_json, headers: { 'Content-Type' =>  'application/json' })
   end
-
-  def self.bitreserve_stub_request_with_auth(method, url, response = [], auth = nil)
-    new_url = generate_auth_url(url, auth)
-    WebMock::API.stub_request(method, new_url).
-      to_return(body: response.to_json, headers: { 'Content-Type' =>  'application/json' })
-  end
-
-  private
-
-  def self.generate_auth_url(url, auth)
-    uri = URI.parse(Bitreserve::AuthRequest.base_uri)
-    uri.scheme + '://' + auth[:username] + ':' + auth[:password] + '@' + uri.host + url
-  end
 end

data/spec/unit/api/auth_spec.rb

@@ -7,14 +7,13 @@ module Bitreserve
 
       context '#generate_access_token' do
         it 'generates a personal access token' do
-          auth = { username: 'user', password: 'pass' }
-          request_data = RequestData.new(Endpoints::AUTH, Entities::AuthToken, client.authorization_header, nil, auth)
+          auth = { username: 'user', password: 'pass', otp: 'otp' }
           allow(Request).to receive(:perform_with_object)
 
           client.generate_access_token(auth)
 
           expect(Request).to have_received(:perform_with_object).
-            with(:post, request_data)
+            with(:post, anything)
         end
       end
     end

data/spec/unit/request_spec.rb

@@ -4,7 +4,7 @@ module Bitreserve
   shared_examples 'perform request method' do |method_name|
     let(:object_class) { double('ObjectClass', new: nil, from_collection: nil) }
     let(:request) { spy('request') }
-    let(:client) { Bitreserve::Client.new }
+    let(:client) { Client.new }
 
     context ".#{method_name}" do
       it 'makes the correct call for a GET' do
@@ -43,11 +43,24 @@ module Bitreserve
 
         expect(Request).to have_received(:post).with(url, body: data, headers: client.authorization_header)
       end
+
+      it 'makes a call with basic auth' do
+        url = '/some-url'
+        headers = { header1: 'I am a header' }
+        body = { description: 'whatever' }
+        request_data = RequestData.new(url, object_class, headers, body)
+        WebMockHelpers.bitreserve_stub_request(:get, url)
+        allow(Request).to receive(:get).and_call_original
+
+        Request.public_send(method_name, :get, request_data)
+
+        expect(Request).to have_received(:get).with(url, headers: headers, body: body)
+      end
     end
 
-    def request_data(url = anything, client = nil, payload = nil, auth = nil)
+    def request_data(url = anything, client = nil, payload = nil)
       client ||= double('Client', authorization_header: {})
-      RequestData.new(url, object_class, client.authorization_header, payload, auth)
+      RequestData.new(url, object_class, client.authorization_header, payload)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitreserve
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Group Buddies
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -177,10 +177,12 @@ files:
 - spec/fixtures/vcr_cassettes/me/transactions/create_waiting_cancel.yml
 - spec/fixtures/vcr_cassettes/me/transactions/create_waiting_resend.yml
 - spec/fixtures/vcr_cassettes/me/transactions/resend.yml
+- spec/fixtures/vcr_cassettes/pats.yml
 - spec/fixtures/vcr_cassettes/reserve/transaction.yml
 - spec/fixtures/vcr_cassettes/reserve/transactions.yml
 - spec/fixtures/vcr_cassettes/tickers.yml
 - spec/fixtures/vcr_cassettes/transparency.yml
+- spec/integration/api/auth_token_spec.rb
 - spec/integration/api/card_spec.rb
 - spec/integration/api/contact_spec.rb
 - spec/integration/api/private_transactions_spec.rb
@@ -199,7 +201,6 @@ files:
 - spec/unit/api/ticker_spec.rb
 - spec/unit/api/transparency_spec.rb
 - spec/unit/api/user_spec.rb
-- spec/unit/auth_request_spec.rb
 - spec/unit/client_spec.rb
 - spec/unit/entities/base_entity_spec.rb
 - spec/unit/entities/user_spec.rb
@@ -244,10 +245,12 @@ test_files:
 - spec/fixtures/vcr_cassettes/me/transactions/create_waiting_cancel.yml
 - spec/fixtures/vcr_cassettes/me/transactions/create_waiting_resend.yml
 - spec/fixtures/vcr_cassettes/me/transactions/resend.yml
+- spec/fixtures/vcr_cassettes/pats.yml
 - spec/fixtures/vcr_cassettes/reserve/transaction.yml
 - spec/fixtures/vcr_cassettes/reserve/transactions.yml
 - spec/fixtures/vcr_cassettes/tickers.yml
 - spec/fixtures/vcr_cassettes/transparency.yml
+- spec/integration/api/auth_token_spec.rb
 - spec/integration/api/card_spec.rb
 - spec/integration/api/contact_spec.rb
 - spec/integration/api/private_transactions_spec.rb
@@ -266,7 +269,6 @@ test_files:
 - spec/unit/api/ticker_spec.rb
 - spec/unit/api/transparency_spec.rb
 - spec/unit/api/user_spec.rb
-- spec/unit/auth_request_spec.rb
 - spec/unit/client_spec.rb
 - spec/unit/entities/base_entity_spec.rb
 - spec/unit/entities/user_spec.rb

data/spec/unit/auth_request_spec.rb

@@ -1,32 +0,0 @@
-require 'spec_helper'
-
-module Bitreserve
-  shared_examples 'perform auth request method' do |method_name|
-    let(:object_class) { double('ObjectClass', new: nil, from_collection: nil) }
-    let(:request) { spy('request') }
-    let(:client) { Bitreserve::Client.new }
-
-    context ".#{method_name}" do
-      it 'makes a call with basic auth' do
-        url = '/some-url'
-        auth = { username: 'user', password: 'pass' }
-        WebMockHelpers.bitreserve_stub_request_with_auth(:get, url, [], auth)
-        allow(AuthRequest).to receive(:get).and_call_original
-
-        AuthRequest.public_send(method_name, :get, request_data(url, client, nil, auth))
-
-        expect(AuthRequest).to have_received(:get).with(url, basic_auth: auth, headers: client.authorization_header)
-      end
-    end
-
-    def request_data(url = anything, client = nil, payload = nil, auth = nil)
-      client ||= double('Client', authorization_header: {})
-      RequestData.new(url, object_class, client.authorization_header, payload, auth)
-    end
-  end
-
-  describe AuthRequest do
-    include_examples 'perform auth request method', :perform_with_object
-    include_examples 'perform auth request method', :perform_with_objects
-  end
-end