bitpagos 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28b6e63d61b1c9c5a7ee4ae0af71787cc04c5233
-  data.tar.gz: 65a45c1268f73237ef29bcc3c87e517aa754a26c
+  metadata.gz: aa49867b69c6e13d1750496c1af02ad65dde63f1
+  data.tar.gz: 3bbd0397d50b3535f91b25ae44f21557310b2932
 SHA512:
-  metadata.gz: adbb05cff2ec909756785fb9c64751c15d8d6b9e830d23ac4504fe75db31fcb465e8cb3bf50045dcdd3d244e4e991af8dcd0af12e59dc2ed2f55a3701d7c7171
-  data.tar.gz: 44e277d6710cef072251ce4836cc94c073967a83b07fa6aa5aa272edfbdb2c3552aaa63f31c458db76570a37d7f7b7542ee2f40f03152a7224bc26d4b19059b3
+  metadata.gz: 088e6664f5d6d967416e4571c630fe171c6e829953fd623e481cf8a753e14487ec1a31cdc27c663b7a55facaff55df72e8e93dd93aa6b6737e1a250c4ea1108a
+  data.tar.gz: 6a4439d7ab343de09b0a90d9215c166410acf87e2b23cae55182df167c29469c5f389fc258f69e85f1b76f3c84a495e99884408149e56ee73908cbf9ac0a8c04

data/lib/bitpagos.rb

@@ -2,4 +2,5 @@ require 'rest-client'
 require 'bitpagos/client'
 require 'bitpagos/errors/generic_error'
 require 'bitpagos/errors/invalid_api_key'
+require 'bitpagos/errors/invalid_transaction_type'
 require 'bitpagos/errors/unauthorized'

data/lib/bitpagos/client.rb

@@ -22,42 +22,67 @@ module Bitpagos
       retrieve_transactions(nil, transaction_id)
     end
 
-    def all_transactions
-      retrieve_transactions
+    # Retrieve all transactions, or specify them with parameters, to retrieve
+    # allow retrieving paginated transactions.
+    #
+    # @param [Hash] Allows to specify transaction type, limit or offset
+    # @option [Symbol] status (:pending, :waiting, :completed, :partially_paid)
+    # @option [Integer] offset
+    # @option [Integer] limit
+    # @return [Hash]
+    def transactions(params = {})
+      if status = params[:status]
+        params[:status] = get_transaction_type_from_symbol(status)
+      end
+      retrieve_transactions(params)
     end
 
     def completed_transactions
-      retrieve_transactions(COMPLETED)
+      retrieve_transactions(status: COMPLETED)
     end
 
     def waiting_transactions
-      retrieve_transactions(WAITING)
+      retrieve_transactions(status: WAITING)
     end
 
     def pending_transactions
-      retrieve_transactions(PENDING)
+      retrieve_transactions(status: PENDING)
     end
 
     def partially_paid_transactions
-      retrieve_transactions(PARTIALLY_PAID)
+      retrieve_transactions(status: PARTIALLY_PAID)
     end
 
     # Returns the total count of transactions in all states.
     #
     # @return [Integer] Total transaction count
     def transaction_count
-      all_transactions["meta"]["total_count"]
+      transactions["meta"]["total_count"]
     end
 
     private
 
+    # Takes a symbol and returns the proper transaction type.
+    #
+    # @param [Symbol] Can be :pending, :waiting, :completed or :partially_paid
+    # @return [String,nil] Returns the corresponding "PE", "WA", "CO" or "PP"
+    def get_transaction_type_from_symbol(transaction_type)
+      begin
+        target_type = transaction_type.to_s.upcase
+        return if target_type.empty?
+        self.class.const_get(target_type)
+      rescue NameError => error
+        raise Bitpagos::Errors::InvalidTransactionType.new(error.message)
+      end
+    end
+
     # Hits the Bitpagos transaction API, returns a hash with results
     #
     # @param [String] State (Pending, Waiting, Completed, Partially Paid)
     # @param [String] Transaction ID
     # @return [Hash]
     def retrieve_transactions(query = nil, transaction_id = nil)
-      headers.merge!(params: { status: query }) if query
+      headers.merge!(params: query) if query
       url = "#{API_BASE}/transaction/#{transaction_id}"
       begin
         response = RestClient.get(url, headers)

data/lib/bitpagos/errors/invalid_transaction_type.rb

@@ -0,0 +1,6 @@
+module Bitpagos
+  module Errors
+    class InvalidTransactionType < GenericError
+    end
+  end
+end

data/lib/bitpagos/version.rb

@@ -1,3 +1,3 @@
 module Bitpagos
-  VERSION = '0.3.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitpagos
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Mauro Otonelli
@@ -105,6 +105,7 @@ files:
 - lib/bitpagos/client.rb
 - lib/bitpagos/errors/generic_error.rb
 - lib/bitpagos/errors/invalid_api_key.rb
+- lib/bitpagos/errors/invalid_transaction_type.rb
 - lib/bitpagos/errors/unauthorized.rb
 - lib/bitpagos/version.rb
 homepage: http://github.com/ombulabs/bitpagos