proxypay 0.2.2 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 24b46cc765e5d6400ad538fbc114ccc9c9eb93cb
-  data.tar.gz: 002c820f1ac4d26a81a30f088af008cec97262ce
+SHA256:
+  metadata.gz: 2c9bdc70835b0dd0bf3662093e8e061400bcadf65857f2b015eb86107e96d6ae
+  data.tar.gz: e67304f184ae90aeb2764a1f8f60a590457ee565ad96a0e2dc5b50ac8ee3e686
 SHA512:
-  metadata.gz: aa063b0c31bb1980c35d2de5647f735041790ebd884f9cd5d6a3e39be36a45159bf6916c1d0ca2d2f0521d7baab7e17bb88df238ca61a85256477bbbdc3902ce
-  data.tar.gz: c09bc6cd2a142725db4817df1979deacb1658a616e0d09306cd9599e7aeb91fe6148363ddb1f4ed122d63a90a8c5e1bf44a1ed5311a24e16b1a7764f60c16942
+  metadata.gz: cb7f2ac55295604899d351ed6058b48d220f2bdd123fc172faecf0732fe4cd71dd2dace9a5513b15798484dbdd81dfe91a8901703f15fcb221962eaa77b9d646
+  data.tar.gz: e003557c74666778d5b1ae9171736dd61549d6f67273644541bba38eccb88cd65685574d60db00948e8b04619c76cbe974d15871d500bc6da2786f91b60499fc

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/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

data/lib/proxypay/version.rb

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

data/lib/proxypay.rb

@@ -1,19 +1,15 @@
-#require "./lib/proxypay/version.rb"
 require "proxypay/version"
 require "httparty"
 
 module Proxypay
   include HTTParty
+  debug_output $stdout
   base_uri "https://api.proxypay.co.ao"
 
   # Fetch all available references
   def self.get_references(options = {})
-    # Proxypay.get_references(query: {limit: 20}, is_test: true, api_key: '0djwano5yth94ihrtw34ot9cehn9emo')
     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 = set_headers(options)
     content[:query] = options.delete(:query) || {}
     get("/references", content).parsed_response
   end
@@ -21,29 +17,22 @@ module Proxypay
   # Fetch a specific reference by his ID string
   def self.get_reference(id, options = {})
     set_base_url(options.delete(:is_test))
-    options = {:basic_auth => authenticate(options.delete(:api_key))}
-    get("/references/#{id}", options).parsed_response
+    content = set_headers(options)
+    get("/references/#{id}", content).parsed_response
   end
 
   # 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)
     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[:headers] = {'Content-Type' => 'application/json'}
+    content = set_headers(options)
+    content[:body] = {:reference => {:amount => amount.to_s, :expiry_date => expiry_date.to_s, custom_fields: (options.delete(:custom_fields) || {})}}.to_json
     post("/references", content).parsed_response
   end
 
   # Fetch all availables payments that have not been acknowledged.
   def self.get_payments(options={})
-    # Proxypay.get_payments(query: {limit: 20}, is_test: true, api_key: '0djwano5yth94ihrtw34ot9cehn9emo')
     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 = set_headers(options)
     content[:query] = options.delete(:query) || {}
     get("/events/payments", content).parsed_response
   end
@@ -51,25 +40,53 @@ module Proxypay
   # Acknowledge a payment by submitting his ID
   def self.new_payment(id, options = {})
     set_base_url(options.delete(:is_test))
-    content = {:basic_auth => authenticate(options.delete(:api_key))}
+    content = set_headers(options)
     delete("/events/payments/#{id}", content).parsed_response
   end
 
   # Acknowledge multiple payments by submitting an array of ids
   def self.new_payments(ids, options = {})
     set_base_url(options.delete(:is_test))
-    content = {}
+    content = set_headers(options)
     content[:body] = { :ids => ids }.to_json
-    content[:basic_auth] = authenticate(options.delete(:api_key))
-    content[:headers] = {'Content-Type' => 'application/json'}
     delete("/events/payments", content).parsed_response
   end
 
+  # Get a list of customers
+  def self.get_customers(options = {})
+    set_base_url(options.delete(:is_test))
+    content = set_headers(options)
+    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))
+    content = set_headers(options)
+    get("/customers/#{id}", content).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 = set_headers(options)
+    content[:body] = {:customer => {:name => nome.to_s, :mobile => telemovel.to_s, :email => email.to_s}}.to_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"
+    self.base_uri is_test == true ? "https://api.sandbox.proxypay.co.ao" : "https://api.proxypay.co.ao"
   end
 
   private
+  def self.set_headers(options)
+    content = {}
+    content[:basic_auth] = authenticate(options.delete(:api_key))
+    content[:headers] = {'Content-Type' => 'application/json', 'Accept' => 'application/vnd.proxypay.v1+json'}
+    return content
+  end
+
   def self.authenticate(api_key = nil)
     auth = {
       username: api_key.nil? ? ENV["PROXYPAY_USER"] : 'api',

data/proxypay.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Sergio Maziano"]
   spec.email         = ["sergio.maziano@gmail.com"]
 
-  spec.summary       = %q{A Ruby gem for ProxyPay API(https://proxypay.co.ao) made by SmartTechys(http://smarttechys.co.ao) }
+  spec.summary       = %q{A Ruby gem for ProxyPay API(https://proxypay.co.ao) made by Sergio Maziano(https://github.com/smaziano) }
   spec.description   = %q{A ruby gem to connect your application with ProxyPay(https://www.proxypay.co.ao) API that allows your application to interact with the Angolan ATM system knows as Multicaixa for online payments by reference.}
 
   spec.homepage      = "https://github.com/smaziano/proxypay"
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "httparty", "~> 0.13.7"
+  spec.add_development_dependency "bundler", "~> 2.3.11"
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_dependency "httparty", "~> 0.20.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxypay
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.6
 platform: ruby
 authors:
 - Sergio Maziano
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2022-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.3.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.3.11
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.7
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.7
+        version: 0.20.0
 description: A ruby gem to connect your application with ProxyPay(https://www.proxypay.co.ao)
   API that allows your application to interact with the Angolan ATM system knows as
   Multicaixa for online payments by reference.
@@ -61,23 +61,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
+- ".proxypay.gemspec.swp"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/setup
+- lib/.proxypay.rb.swp
 - lib/proxypay.rb
 - lib/proxypay/version.rb
-- proxypay-0.2.1.gem
 - proxypay.gemspec
 homepage: https://github.com/smaziano/proxypay
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: A Ruby gem for ProxyPay API(https://proxypay.co.ao) made by SmartTechys(http://smarttechys.co.ao)
+summary: A Ruby gem for ProxyPay API(https://proxypay.co.ao) made by Sergio Maziano(https://github.com/smaziano)
 test_files: []