proxypay 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24b46cc765e5d6400ad538fbc114ccc9c9eb93cb
-  data.tar.gz: 002c820f1ac4d26a81a30f088af008cec97262ce
+  metadata.gz: c7fd53ce24aa0d2a5cf5e1df3f48ce94a0372f5a
+  data.tar.gz: 3aa1e581ff629ae4eaeddf38be9fb146e6de8bc8
 SHA512:
-  metadata.gz: aa063b0c31bb1980c35d2de5647f735041790ebd884f9cd5d6a3e39be36a45159bf6916c1d0ca2d2f0521d7baab7e17bb88df238ca61a85256477bbbdc3902ce
-  data.tar.gz: c09bc6cd2a142725db4817df1979deacb1658a616e0d09306cd9599e7aeb91fe6148363ddb1f4ed122d63a90a8c5e1bf44a1ed5311a24e16b1a7764f60c16942
+  metadata.gz: 479ee1a986f2faf22accf2547e6f55f262071b6166904e0bc68a93cf9ec271cbc08c4c154582fea4620aeaf64c6aca45731f1023e5a55f105eb0070c63be7351
+  data.tar.gz: c95a6ecb4ba19a6c0eb6d092a3f2b19dbfe7a380ac53c5e64ef19b520a2820a604e5027dbe1e4697dc6d3ff535d9c3fbd69413a7f581767830eba79b9fc35df9

data/README.md

@@ -26,6 +26,21 @@ PROXYPAY_USER=api
 PROXYPAY_API_KEY=your_api_key_obtained_from_proxypay_folks
 ```
 
+to make requests with another api_key use this on every method call.
+
+```ruby
+options = {api_key: your_api_key_obtained_from_proxypay_folks}
+```
+
+
+
+to make the request proxypay's test server use
+
+```ruby
+options = {is_test: true}
+```
+
+
 ## Usage
 
 ### Use the class methods to get it going
@@ -33,31 +48,33 @@ PROXYPAY_API_KEY=your_api_key_obtained_from_proxypay_folks
 ## References
 ### Fetch all available references
 ```ruby
-Proxypay.get_references
+Proxypay.get_references # Fetch all references
+Proxypay.get_references(api_key: some_api_key) # fetch using this key
+Proxypay.get_references(is_test: true) # fetch from the test server
+
 ```
 ### Fetch references by using query's
 or you can pass one or several query's parameters and even use the custom_fields defined at proxypay.
 ```ruby
-options = {status:"paid", offset:15, limit:13, q:{custom_fields:{your_fild:"some_data", some_other_filed:{that_takes:"an_hash"}}}}
-Proxypay.get_reference(options)
+options = {query: {status:"paid", offset:15, limit:13, q:{custom_fields:{your_fild:"some_data", some_other_filed:{that_takes:"an_hash"}}}}}
+Proxypay.get_references(options)
 ```
 
-### Request a new reference - amount and expiration_date for the reference are mandatory
+### Fetch a reference by using id
 ```ruby
-Proxypay.new_reference("2000.00", "2015-10-10")
+options = {}
+Proxypay.get_reference(id, options)
 ```
 
-### Request a reference and add custom fields to your reference for your identification.
+### Request a new reference - amount and expiration_date for the reference are mandatory
 ```ruby
-other_data = {invoice:"001-2015", description:"Client #{client_number} - monthly payment"}
-Proxypay.new_reference("2000.00", "2015-10-10", other_data)
+Proxypay.new_reference("2000.00", "2015-10-10")
 ```
 
-### Request a reference and add custom fields to your reference for your identification on using a specific API_KEY
+### Request a reference and add custom fields to your reference for your identification.
 ```ruby
-other_data = {invoice:"001-2015", description:"Client #{client_number} - monthly payment"}
-api_key = "OcSLBANU4tjRi9gfW5VUcMqkvzLOcSLBANU4tjRi9gfW5VUcMqkvzL"
-Proxypay.other_new_reference("2000.00", "2015-10-10", other_data, api_key)
+options = {custom_fields: {invoice:"001-2015", description:"Client #{client_number} - monthly payment"}}
+Proxypay.new_reference("2000.00", "2015-10-10", options)
 ```
 
 ## Payments
@@ -67,41 +84,32 @@ Proxypay.get_payments
 ```
 ### Fetch all the payments with limitation by the specified number(quantity)
 ```ruby
-options = {n:48}
+options = {query: {n:48}}
 Proxypay.get_payments(options)
 ```
 
-### Fetch all payments that haven't been acknowledged for an specific API KEY
-```ruby
-api_key = "OcSLBANU4tjRi9gfW5VUcMqkvzLOcSLBANU4tjRi9gfW5VUcMqkvzL"
-Proxypay.other_get_payments(api_key)
-```
-
 ### Fetch a specific payment by passing his ID
 ```ruby
-Proxypay.get_payment("OcSLBANU4tjRi9gfW5VUcMqkvzL")
+options = {}
+Proxypay.get_payment("OcSLBANU4tjRi9gfW5VUcMqkvzL", options)
 ```
 
 ### Acknowledge a payment by passing his ID
 ```ruby
-Proxypay.new_payment("OcSLBANU4tjRi9gfW5VUcMqkvzL")
-```
-
-### Acknowledge a payment by passing his ID for an specific API KEY
-```ruby
-api_key = "OcSLBANU4tjRi9gfW5VUcMqkvzLOcSLBANU4tjRi9gfW5VUcMqkvzL"
-Proxypay.other_new_payment("OcSLBANU4tjRi9gfW5VUcMqkvzL", api_key)
+options = {}
+Proxypay.new_payment("OcSLBANU4tjRi9gfW5VUcMqkvzL", options)
 ```
 
 ### Acknowledge multiple payments by passing and array of ID's
 ```ruby
 ids = ["OcSLBANU4tjRi9gfW5VUcMqkvzL", "EcJLBANU4trUi8gfM6MOcMqkvzH","VxELBANU4tjRi9gfW5VUcMqkvzZ"]
-Proxypay.new_payments(ids)
+options = {}
+Proxypay.new_payments(ids, options)
 ```
 
 ## Help and Docs
 - [ProxyPay API](https://developer.proxypay.co.ao)
-- [RDOC](http://www.rubydoc.info/gems/proxypay/0.2.2)
+- [RDOC](http://www.rubydoc.info/gems/proxypay/0.2.3)
 
 ## Development
 - You can fork the project
@@ -119,4 +127,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/smazia
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/proxypay.rb

@@ -27,11 +27,11 @@ module Proxypay
 
   # Submit a request to create a new reference
   def self.new_reference(amount, expiry_date, options={})
-    # new_reference(78654.90, '12-12-2012', custom_fields: {foo: 'F0000-45', bar: 'MMM'}, api_key: 'ctsrxte56v8bgfyv7fuf676t7o89099y85ce6f', is_test: true)
+    # new_reference(78654.90, '12-12-2012', custom_fields: {foo: 'F0000-45', bar: 'MMM'}, api_key: 'ctsrxte56v8my_keyv7fuf676t7o89099y85ce6f', is_test: true)
     set_base_url(options.delete(:is_test))
     content = {}
     content[:basic_auth] = authenticate(options.delete(:api_key))
-    content[:body] = {:reference => {:amount => amount, :expiry_date => expiry_date, custom_fields: (options.delete(:custom_fields) || {})}}.to_json
+    content[:body] = {:reference => {:amount => amount.to_s, :expiry_date => expiry_date.to_s, custom_fields: (options.delete(:custom_fields) || {})}}.to_json
     content[:headers] = {'Content-Type' => 'application/json'}
     post("/references", content).parsed_response
   end
@@ -65,6 +65,34 @@ module Proxypay
     delete("/events/payments", content).parsed_response
   end
 
+  # Get a list of customers
+  def self.get_customers(options = {})
+    set_base_url(options.delete(:is_test))
+    # request body and header
+    content = {}
+    content[:basic_auth] = authenticate(options.delete(:api_key))
+    content[:headers] = {'Content-Type' => 'application/json'}
+    content[:query] = options.delete(:query) || {}
+    get("/customers", content).parsed_response
+  end
+
+  # get a customer by id
+  def self.get_customer(id, options = {})
+    set_base_url(options.delete(:is_test))
+    options = {:basic_auth => authenticate(options.delete(:api_key))}
+    get("/customers/#{id}", options).parsed_response
+  end
+
+  # Store a new customer or update one
+  def self.new_customer(id, nome, telemovel, email, options = {})
+    set_base_url(options.delete(:is_test))
+    content = {}
+    content[:basic_auth] = authenticate(options.delete(:api_key))
+    content[:body] = {:customer => {:name => nome.to_s, :mobile => telemovel.to_s, :email => email.to_s}}.to_json
+    content[:headers] = {'Content-Type' => 'application/json'}
+    put("/customers/#{id}", content).parsed_response
+  end
+
   def self.set_base_url(is_test = false)
     self.base_uri is_test == true ? "https://api.proxypay.co.ao/tests" : "https://api.proxypay.co.ao"
   end

data/lib/proxypay/version.rb

@@ -1,3 +1,3 @@
 module Proxypay
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxypay
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Sergio Maziano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2017-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -72,6 +73,7 @@ files:
 - lib/proxypay.rb
 - lib/proxypay/version.rb
 - proxypay-0.2.1.gem
+- proxypay-0.2.2.gem
 - proxypay.gemspec
 homepage: https://github.com/smaziano/proxypay
 licenses: