bitreserve 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8d1c7b27348dfa25433e60edf1be84f5cc89b49
-  data.tar.gz: f294a82c9d166b9f56df06c668f578fa6410a0c5
+  metadata.gz: 3bbbbdb0761739cd6c5e1d66a3f0ac5dfa71c498
+  data.tar.gz: d12bcb0e633a3a04665b17d7b778838645d584d7
 SHA512:
-  metadata.gz: 1d1ecd9e4f0c707ebff9f0be545b1a9ce58476f9f459b4f3f5abab0daedf58b16714bec53f21ae6f8227e8efe4a1e549d63d84c0f035f0ba51bcfbd38361a3c1
-  data.tar.gz: 40a9eca15c48940afe36e845f73d6f65e8e24e1f8589aa0dcb4797367d991b0e27971c5178e7fe090277d7fbc89218dd2af162b3c4ace265a1f31b76cb214fe7
+  metadata.gz: 3e07529048a9d805f6b22460e26f89defe5f7da1b6fe71d3dc49b7b20c3018bac0df8cf0a0b834e59a0191d2c8ded7a7ea99438d4cdb033d3c992de2a4e43a38
+  data.tar.gz: dbd7039f5765587738de721d3dd48d67b3f942948abfa8fd63bea919baa380682c5eafcf98c997237a61131387a769a1236032a7722674978fb8d6889e303eec

data/README.md

@@ -43,6 +43,7 @@ Or install it yourself as:
   * [Contacts](#contacts)
   * [Users](#users)
   * [Transparency](#transparency)
+  * [Pagination](#pagination)
 * [Contributing](#contributing)
 
 # Usage
@@ -63,6 +64,9 @@ client. Here's how you can do that.
 
 ## Personal Access Token
 
+If you don't have a PAT, learn how to generate one
+[here](#basic-authentication).
+
 If you already have a token, you can use it by setting an environment variable,
 or by passing it when instantiating the client.
 
@@ -99,11 +103,24 @@ Bitreserve's API.
 
 ### OAuth2
 
-**NOT SUPPORTED YET**
+**NOT SUPPORTED BY BITRESERVE YET**
 
 ### Basic Authentication
 
-TODO
+[*Bireserve documentation on basic authentication*](https://developer.bitreserve.org/api/v0/#basic-authentication)
+
+The only thing you need, in order to use basic authentication is a Personal
+Access Token, everything else is transparent to you. If you already have a
+token, see how to use it [here](#personal-access-token).
+
+```ruby
+client.generate_access_token(username: 'your-bitreserve-username', password:
+'your-bitreserve-password', otp: 'a-valid-bitreserve-otp')
+```
+
+To generate a valid OTP you can install [Authy](https://www.authy.com/), follow
+it's set up process and choose bitreserve. You should be prompted with a set of
+numbers, which is your OTP (it only lasts 30 seconds, so you have to be quick).
 
 ## Tickers
 
@@ -151,13 +168,15 @@ You can interact with both the authenticated user's and public transactions.
 
 ### Public Transactions
 
-**Return the public view of all transactions in the reserve:**
+**Return the public view of all transactions in the reserve (supports
+[Pagination](#pagination)):**
 
 ```ruby
 client.all_public_transactions
 ```
 
-**Return the public view of a specific transaction:**
+**Return the public view of a specific transaction (supports
+[Pagination](#pagination)):**
 
 ```ruby
 client.find_public_transactions(id: 'a97bb994-6e24-4a89-b653-e0a6d0bcf634')
@@ -193,7 +212,8 @@ client.resend_transaction(card_id: 'a6d35fcd-xxxx-9c9d1dda6d57', transaction_id:
 'd51b4e4e-9827-40fb-8763-e0ea2880085b')
 ```
 
-**Return all transactions associated with the user:**
+**Return all transactions associated with the user (supports
+[Pagination](#pagination)):**
 
 ```ruby
 client.all_user_transactions
@@ -254,6 +274,24 @@ client.phones
 client.statistics
 ```
 
+## Pagination
+
+[*Bitreserve documentation on pagination*](https://developer.bitreserve.org/api/v0/#pagination)
+
+All endpoints that support pagination take a `range` attribute, in which you can
+specify the first and last indexes for the items you wish to retrieve.
+
+The response will look exactly like an `Array`, but with a method called
+`total_items`, that returns the total number of items of that type that
+Bitreserve knows of.
+
+```ruby
+client = Bitreserve::Client.new token: 'XXX'
+client.all_public_transactions.size # 5
+client.all_public_transactions.total_size # 21110
+client.all_public_transactions(range: (5..20)).size # 16
+```
+
 # Contributing
 
 1. Fork it ( https://github.com/groupbuddies/bitreserve/fork )

data/lib/bitreserve/api/private_transaction.rb

@@ -26,20 +26,20 @@ module Bitreserve
         Request.perform_with_object(:post, request_data)
       end
 
-      def all_user_transactions
+      def all_user_transactions(range: (0..4))
         request_data = RequestData.new(
           Endpoints::USER_PRIVATE_TRANSACTIONS,
           Entities::Transaction,
-          authorization_header
+          authorization_header.merge(pagination_header_for_range(range))
         )
         Request.perform_with_objects(:get, request_data)
       end
 
-      def all_card_transactions(card_id: nil)
+      def all_card_transactions(card_id: nil, range: (0..4))
         request_data = RequestData.new(
           Endpoints.with_placeholders(Endpoints::CARD_PRIVATE_TRANSACTIONS, ':card' => card_id),
           Entities::Transaction,
-          authorization_header
+          authorization_header.merge(pagination_header_for_range(range))
         )
         Request.perform_with_objects(:get, request_data)
       end

data/lib/bitreserve/api/public_transaction.rb

@@ -1,11 +1,11 @@
 module Bitreserve
   module API
     module PublicTransaction
-      def all_public_transactions
+      def all_public_transactions(range: (0..4))
         request_data = RequestData.new(
           Endpoints::PUBLIC_TRANSACTIONS,
           Entities::Transaction,
-          authorization_header
+          authorization_header.merge(pagination_header_for_range(range))
         )
         Request.perform_with_objects(:get, request_data)
       end

data/lib/bitreserve/client.rb

@@ -1,7 +1,9 @@
 require 'bitreserve/api'
+require 'bitreserve/pagination'
 
 module Bitreserve
   class Client
+    include Pagination
     include API
     attr_reader :bearer_token
 

data/lib/bitreserve/entities/base_entity.rb

@@ -3,15 +3,25 @@ module Bitreserve
     class BaseEntity
       include Virtus.model
 
-      def self.from_collection(entities)
-        entities.map do |entity|
-          new(entity)
-        end
+      def self.from_collection(entities, content_range)
+        total_size = (content_range && content_range.split('/')[1]) || entities.size
+        items = entities.map { |entity| new(entity) }
+
+        PaginatedCollection.new(items, total_size)
       end
 
       def initialize(attributes = {})
         super(Bitreserve::Helpers.underscored_hash(attributes))
       end
+
+      class PaginatedCollection < Array
+        attr_reader :total_size
+
+        def initialize(items, total_size)
+          super(items)
+          @total_size = total_size.to_i
+        end
+      end
     end
   end
 end

data/lib/bitreserve/pagination.rb

@@ -0,0 +1,9 @@
+module Bitreserve
+  module Pagination
+    def pagination_header_for_range(range)
+      return {} unless range
+
+      { 'Range' => "items=#{range.min}-#{range.max}" }
+    end
+  end
+end

data/lib/bitreserve/request.rb

@@ -1,22 +1,24 @@
 module Bitreserve
   class Request
+    class APIError < StandardError; end
+
     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)
-      check_error(response) || request_data.entity.from_collection(response)
+
+      with_valid_response(response) do
+        request_data.entity.from_collection(response.parsed_response, response.headers['content-range'])
+      end
     end
 
     def self.perform_with_object(http_method, request_data)
       response = new(request_data).public_send(http_method)
-      check_error(response) || request_data.entity.new(response)
-    end
 
-    def self.check_error(response)
-      return unless response.is_a?(Hash) && response['error']
-
-      Entities::Error.new(response)
+      with_valid_response(response) do
+        request_data.entity.new(response.parsed_response)
+      end
     end
 
     def initialize(request_data)
@@ -28,19 +30,27 @@ module Bitreserve
     def get
       response = self.class.get(path, options)
       log_request_info(:get, response)
-      response.parsed_response
+      response
     end
 
     def post
       response = self.class.post(path, options)
       log_request_info(:post, response)
-      response.parsed_response
+      response
     end
 
     private
 
     attr_reader :path, :data, :auth, :headers
 
+    def self.with_valid_response(response)
+      if response.is_a?(Hash) && response['error']
+        Entities::Error.new(response)
+      else
+        yield
+      end
+    end
+
     def options
       { body: data, headers: headers }.
         reject { |_k, v| v.nil? }

data/lib/bitreserve/version.rb

@@ -1,3 +1,3 @@
 module Bitreserve
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/integration/api/public_transaction_spec.rb

@@ -11,6 +11,7 @@ module Bitreserve
             transactions = client.all_public_transactions
 
             expect(transactions).to be_a(Array)
+            expect(transactions.total_size).to eq 2
             expect(transactions.first).to be_a(Entities::Transaction)
             expect(transactions.first.id).to be_a(String)
           end

data/spec/unit/api/private_transaction_spec.rb

@@ -82,7 +82,7 @@ module Bitreserve
           request_data = RequestData.new(
             Endpoints::USER_PRIVATE_TRANSACTIONS,
             Entities::Transaction,
-            client.authorization_header
+            client.authorization_header.merge(client.pagination_header_for_range(0..4))
           )
           allow(Request).to receive(:perform_with_objects)
 
@@ -99,7 +99,7 @@ module Bitreserve
           request_data = RequestData.new(
             Endpoints.with_placeholders(Endpoints::CARD_PRIVATE_TRANSACTIONS, ':card' => card_id),
             Entities::Transaction,
-            client.authorization_header
+            client.authorization_header.merge(client.pagination_header_for_range(0..4))
           )
           allow(Request).to receive(:perform_with_objects)
 

data/spec/unit/api/public_transaction_spec.rb

@@ -7,7 +7,7 @@ module Bitreserve
 
       context '#all_public_transactions' do
         it 'gets all public transactions' do
-          request_data = RequestData.new(Endpoints::PUBLIC_TRANSACTIONS, Entities::Transaction, client.authorization_header)
+          request_data = RequestData.new(Endpoints::PUBLIC_TRANSACTIONS, Entities::Transaction, client.authorization_header.merge(client.pagination_header_for_range(0..4)))
           allow(Request).to receive(:perform_with_objects)
 
           client.all_public_transactions

data/spec/unit/entities/base_entity_spec.rb

@@ -26,7 +26,7 @@ module Bitreserve
           entity = double('Entity')
           allow(MockEntity).to receive(:new)
 
-          MockEntity.from_collection([entity])
+          MockEntity.from_collection([entity], '0-1/10')
 
           expect(MockEntity).to have_received(:new).with(entity)
         end

data/spec/unit/request_spec.rb

@@ -3,7 +3,8 @@ require 'spec_helper'
 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(:response) { double('Response', code: 200, parsed_response: '', headers: {}) }
+    let(:request) { spy('request', get: response, post: response) }
     let(:client) { Client.new }
 
     context ".#{method_name}" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitreserve
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Group Buddies
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -175,6 +175,7 @@ files:
 - lib/bitreserve/entities/transaction.rb
 - lib/bitreserve/entities/user.rb
 - lib/bitreserve/helpers.rb
+- lib/bitreserve/pagination.rb
 - lib/bitreserve/request.rb
 - lib/bitreserve/request_data.rb
 - lib/bitreserve/version.rb
@@ -240,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A wrapper for the bitreserve API
@@ -287,4 +288,3 @@ test_files:
 - spec/unit/entities/base_entity_spec.rb
 - spec/unit/helper_spec.rb
 - spec/unit/request_spec.rb
-has_rdoc: