openpay 1.0.3 → 1.0.4

data/Gemfile

@@ -1,14 +1,8 @@
 source 'https://rubygems.org'
 
-
 gem 'rspec'
 gem 'rest-client',  '~>1.6.7'
 gem 'factory_girl' ,  '4.2.0'
-gem 'json_spec'
-
-
-
-
 
 # Specify your gem's dependencies in Openpay.gemspec
 gemspec

data/README.md

@@ -1,8 +1,10 @@
-# Openpay-Ruby
+<img src="http://www.openpay.mx/img/logo.png">
+
+# Openpay-Ruby [![Build Status](https://travis-ci.org/open-pay/openpay-ruby.png?branch=master)](https://travis-ci.org/open-pay/openpay-ruby)
 
 ##Description
 
-ruby client for *Openpay api* services (version 1.0.3)
+ruby client for *Openpay api* services (version 1.0.4)
 
 This is a ruby client implementing the payment services for *Openpay* at openpay.mx
 
@@ -275,13 +277,21 @@ open_pay_resource.delete_all(customer_id=nil)
             bank_account['alias']
         end
 
+- list merchant / customer bank accounts
+
+        search_params = OpenpayUtils::SearchParams.new
+        search_params.limit = 1
+
+        merchant_filtered_list = bank_accounts.list(search_params)
+        customer_filtered_list = bank_accounts.list(search_params, customer_id)
+
 - all bank accounts for a given customer
 
-         accounts=bank_accounts.all(customer_id)
+        accounts=bank_accounts.all(customer_id)
 
 - deletes a given customer bank account
 
-          bank_accounts.delete(customer_id,bank_id)
+         bank_accounts.delete(customer_id,bank_id)
 
 - deletes all customer bank accounts (sandbox mode only)
 
@@ -309,6 +319,14 @@ open_pay_resource.delete_all(customer_id=nil)
 
         cards.each {|merchant_card| p card}
 
+- list merchant / customer cards
+
+        search_params = OpenpayUtils::SearchParams.new
+        search_params.limit = 1
+
+        merchant_filtered_list = cards.list(search_params)
+        customer_filtered_list = cards.list(search_params, customer_id)
+
 - each customer card
 
         cards.each(customer_id)   {|customer_card | p customer_card }
@@ -329,13 +347,13 @@ open_pay_resource.delete_all(customer_id=nil)
 
         cards.delete(card_id,customer_id)
 
- - delete all merchant cards
+- delete all merchant cards
 
         cards.delete_all
 
- - delete all customer cards
+- delete all customer cards
 
-         cards.delete_all(customer_id)
+        cards.delete_all(customer_id)
 
 
 #### charges
@@ -355,24 +373,32 @@ open_pay_resource.delete_all(customer_id=nil)
 
 - gets  customer charge
 
-         customer_charge=charges.get(charge_id,customer_id)
+        customer_charge=charges.get(charge_id,customer_id)
 
 - each merchant charge
 
-         charges.each {|charge| p charge}
+        charges.each {|charge| p charge}
+
+- list merchant / customer charges
+
+        search_params = OpenpayUtils::SearchParams.new
+        search_params.limit = 1
+
+        merchant_filtered_list = charges.list(search_params)
+        customer_filtered_list = charges.list(search_params, customer_id)
 
 - each customer charge
 
-         charges.each(customer_id) {|charge| p charge}
+        charges.each(customer_id) {|charge| p charge}
 
 
 - all merchant charge
 
-          charges.all
+        charges.all
 
 - all customer charge
 
-          charges.all(customer_id)
+        charges.all(customer_id)
 
 - capture merchant card
 
@@ -382,14 +408,25 @@ open_pay_resource.delete_all(customer_id=nil)
 
         charges.capture(charge['id'],customer['id'])
 
+- confirm capture merchant
+
+        #pass a hash with the following options, no customer_id needed
+        confirm_capture_options = { transaction_id: transaction['id'], amount: 100  }
+        charges.confirm_capture(confirm_capture_options)
+
+- confirm capture customer
+
+        #pass a hash with the following options, pass the customer_id
+        confirm_capture_options = { customer_id: customer['id'], transaction_id: charge['id'], amount: 100  }
+        charges.confirm_capture(confirm_capture_options)
+
 - refund  merchant charge
 
         charges.refund(charge_id, refund_description_hash)
 
 - refund  merchant charge
 
-         charges.refund(charge_id, refund_description_hash)
-
+        charges.refund(charge_id, refund_description_hash)
 
 
 #### customers
@@ -414,19 +451,24 @@ open_pay_resource.delete_all(customer_id=nil)
 
         customers.each do {|customer|  p customer }
 
-- list all customer
+- list customers
+
+        search_params = OpenpayUtils::SearchParams.new
+        search_params.limit = 1
+
+        customers_filtered_list = customers.list(search_params)
 
-        all_customers=customers.all
 
+- all customer
+
+        all_customers=customers.all
 
 - delete all customers (sand box mode only)
 
          all_customers=customers.all
 
-
 #### fees
 
-
 - creates fee
 
         #In order to create a fee a charge should exists
@@ -436,6 +478,12 @@ open_pay_resource.delete_all(customer_id=nil)
 
         all_fees=fees.all
 
+- list customer fees
+
+        search_params = OpenpayUtils::SearchParams.new
+        search_params.limit = 1
+
+        merchant_filtered_list = fees.list(search_params)
 
 #### payouts
 
@@ -445,7 +493,7 @@ open_pay_resource.delete_all(customer_id=nil)
 
 - creates a customer payout
 
-         payouts.create(payout_hash,customer_id)
+        payouts.create(payout_hash,customer_id)
 
 - gets a merchant payout
 
@@ -470,7 +518,13 @@ open_pay_resource.delete_all(customer_id=nil)
 
         payouts.each(customer_id) { |payout| p payout }
 
+- list merchant/customer payouts
+
+        search_params = OpenpayUtils::SearchParams.new
+        search_params.limit = 1
 
+        merchant_filtered_list = payouts.list(search_params)
+        customer_filtered_list = payouts.list(search_params, customer_id)
 
 #### plans
 
@@ -479,7 +533,7 @@ open_pay_resource.delete_all(customer_id=nil)
         plans.create(plan_hash)
 
 
-- create  customer  plan
+- create  customer plan
 
         plans.create(plan_hash,customer_id)
 
@@ -487,33 +541,42 @@ open_pay_resource.delete_all(customer_id=nil)
 
         merchant_plan=plans.get(plan_id)
 
-- get a customer  plan
+- get a customer plan
 
         customer_plan=plans.get(plan_id,customer_id)
 
 
-- updates a merchant  plan
+- updates a merchant plan
 
          plans.update(plan_hash,customer_id)
 
-- updates a customer  plan
+- updates a customer plan
 
         plans.update(plan_hash,customer_id)
 
-- each merchant  plan
+- each merchant plan
 
         plans.each do {|plan| p plan }
 
-- each customer  plans
+- each customer plans
 
         plans.each(customer_id)  do {|plan| p plan }
 
 
-- all merchant  plans
+- list merchant /customer plan
+
+        search_params = OpenpayUtils::SearchParams.new
+        search_params.limit = 1
+
+        merchant_filtered_list = plans.list(search_params)
+        customer_filtered_list = plans.list(search_params, customer_id)
+
+
+- all merchant plans
 
         plans.all
 
-- all customer  plans
+- all customer plans
 
         plans.all(customer_id)
 
@@ -528,6 +591,11 @@ open_pay_resource.delete_all(customer_id=nil)
 
         subscriptions.get(subscriptions_hash,customer_id)
 
+- update customer subscription
+
+        subscription_update_hash={ trial_end_date: "2016-01-12" }
+        subscriptions.update(subscription_id,customer_id, subscription_update_hash )
+
 - all customer subscription
 
         subscriptions.all(customer_id)
@@ -537,6 +605,14 @@ open_pay_resource.delete_all(customer_id=nil)
 
         subscriptions.each(customer_id)    {|subscription| p subscription }
 
+
+- list customer subscriptions
+
+        search_params = OpenpayUtils::SearchParams.new
+        search_params.limit = 1
+
+        customer_filtered_list = subscriptions.list(search_params, customer_id)
+
 - deletes customer subscription
 
          subscriptions.delete(customer_id)
@@ -566,15 +642,21 @@ open_pay_resource.delete_all(customer_id=nil)
 
         transfers.each(customer_id)    {|transfer| p transfer }
 
+- list customer transfers
+
+        search_params = OpenpayUtils::SearchParams.new
+        search_params.limit = 1
+
+        customer_filtered_list = transfers.list(search_params, customer_id)
 
 
 #### Exceptions
 
 This API generates 3 different Exception classes.
 
--  **OpenpayException**: Generic base api exception class, for generic api exceptions.
+-  **OpenpayException**: Generic base API exception class, Generic API exceptions.
 
-     - Internal server error (500 Internal Server Error)
+     - Internal server error (500 Internal Server Error).
      - OpenpayApi factory method, invalid resource name.
 
     Examples:

data/lib/openpay.rb

@@ -8,10 +8,10 @@ require 'json'
 module Openpay
 
   #api setup / constants
-  require   'openpay/openpay_api'
+  require 'openpay/openpay_api'
 
   #base class
-  require  'openpay/open_pay_resource'
+  require 'openpay/open_pay_resource'
 
   #resource classes
   require 'openpay/bankaccounts'
@@ -25,10 +25,14 @@ module Openpay
   require 'openpay/transfers'
   require 'openpay/charges'
 
+  #misc
+  require 'openpay/utils/search_params'
+
   #exceptions
   require 'errors/openpay_exception_factory'
   require 'errors/openpay_exception'
   require 'errors/openpay_transaction_exception'
   require 'errors/openpay_connection_exception'
 
-end
+  include OpenpayUtils
+end

data/lib/openpay/bankaccounts.rb

@@ -1,15 +1,12 @@
 require 'open_pay_resource'
 
-
 class Bankaccounts < OpenPayResource
 
-
   def create(bank_account,customer_id)
     customers=@api_hook.create(:customers)
     customers.create_bank_account(customer_id,bank_account)
   end
 
-
   def get(customer_id='',bank_account=nil)
     customers=@api_hook.create(:customers)
 
@@ -21,27 +18,31 @@ class Bankaccounts < OpenPayResource
 
   end
 
-
   def delete(customer_id,bank_account)
     customers=@api_hook.create(:customers)
     customers.delete_bank_account(customer_id,bank_account)
   end
 
-
   def each(customer_id)
     customers=@api_hook.create(:customers)
      customers.each_bank_account(customer_id)  do |acc|
        yield acc
      end
-
   end
 
-
   def all(customer_id)
-      customers=@api_hook.create(:customers)
-      customers.all_bank_accounts(customer_id)
+    customers=@api_hook.create(:customers)
+    customers.all_bank_accounts(customer_id)
   end
 
+  def list(search_params,customer_id=nil)
+    if customer_id
+      customers=@api_hook.create(:customers)
+      customers.list_bankaccounts(customer_id,search_params)
+    else
+      super search_params
+    end
+  end
 
   def delete_all(customer_id)
 
@@ -54,6 +55,4 @@ class Bankaccounts < OpenPayResource
 
   end
 
-
-
 end

data/lib/openpay/cards.rb

@@ -2,11 +2,6 @@ require 'open_pay_resource'
 
 class Cards < OpenPayResource
 
-  def list(creation,before,after,offset=0,limit=10)
-
-  end
-
-
   def get(card='',customer_id=nil)
     if customer_id
       customers=@api_hook.create(:customers)
@@ -16,7 +11,6 @@ class Cards < OpenPayResource
     end
   end
 
-
   def create(card,customer_id=nil)
     if customer_id
       customers=@api_hook.create(:customers)
@@ -26,7 +20,6 @@ class Cards < OpenPayResource
     end
   end
 
-
   def delete(card_id,customer_id=nil)
     if customer_id
       customers=@api_hook.create(:customers)
@@ -36,7 +29,6 @@ class Cards < OpenPayResource
     end
   end
 
-
   def delete_all(customer_id=nil)
     if customer_id
       customers=@api_hook.create(:customers)
@@ -48,28 +40,34 @@ class Cards < OpenPayResource
     end
   end
 
-
   def each(customer_id=nil)
     if customer_id
       all(customer_id).each do |card|
         yield card
       end
     else
-        all.each do |card|
-          yield card
-        end
+      all.each do |card|
+        yield card
+      end
     end
   end
 
-
   def all(customer_id=nil)
     if customer_id
       customers=@api_hook.create(:customers)
       customers.all_cards(customer_id)
     else
-      super   ''
+      super ''
     end
   end
 
+  def list(search_params,customer_id=nil)
+    if customer_id
+      customers=@api_hook.create(:customers)
+      customers.list_cards(customer_id,search_params)
+    else
+      super search_params
+    end
+  end
 
 end