proxypay 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5099ebdf08c640857f9d41684d9d61380a13bd55
-  data.tar.gz: 761117dad5d9778bad3ef938ab465bc930c0acdb
+  metadata.gz: 83b2dac7bae8d7ee1ae82c086762f08fef916e61
+  data.tar.gz: faecc885993aaef5a094ca3107ec46e00e3f27ec
 SHA512:
-  metadata.gz: ce78da5889896d97cfbe9a6b3f48cea04b8836608f50536a96cee725ee028b42f728eb293a8009805fc3d45b574a3a1698bf723de3ceddb1cfc6ba56569f6a5b
-  data.tar.gz: f279a35bc77df7df9d96748536337d9dea7e7245069823781e655d09d8467e46ecedcec21ed8e2a140ca79e7e22011776253637ca10293027ffd6ee775d31e09
+  metadata.gz: 942a918b34b2a1f64784d73046181c3afa8dedf74da3986c25c9d54f6b293ef65428a9dd5cf494b435a679db41371836e72d7ddba8b84de2fe0289c61bbffb79
+  data.tar.gz: d9b8c4b3f0fe0ae4c70bae7d9f38f7899fcd1b9e200c909e7ed0e7ed9b6858529edb30fc8bc4ce0ef808fe73d006f38974576571c970a28fbb87962a199432fd

data/README.md

@@ -1,8 +1,6 @@
 # Proxypay
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/proxypay`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A ruby gem to connect your application with [ProxyPay](http://www.proxypay.co.ao) API that allows your application to interact with the Angolan ATM system knows as Multicaixa for online payments by reference.
 
 ## Installation
 
@@ -20,19 +18,45 @@ Or install it yourself as:
 
     $ gem install proxypay
 
+## Setup
+Make sure you setup the environment variables PROXYPAY_USER and PROXYPAY_API_KEY:
+
+```ruby
+PROXYPAY_USER=api
+PROXYPAY_API_KEY=your_api_key_obtained_from_proxypay_folks
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+## Use the class methods to get it going
+# Get References
+Proxypay.get_references
 
-## Development
+# Request a new reference - amount and expiration_date for the reference are mandatory
+Proxypay.new_reference("2000.00", "2015-10-10")
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# You can pass a hash of other custom columns to help you track the references.
+other_data = {invoice:"001-2015", description:"Client #{client_number} - monthly payment"}
+Proxypay.new_reference("2000.00", "2015-10-10", other_data)
+```
+work in progress...
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Help and Docs for Proxypay API and proxypay gem
+- [ProxyPay API](https://developer.proxypay.co.ao)
+- [proxypay gem RDOC](http://www.rubydoc.info/gems/proxypay/0.1.1)
+
+## Development
+- You can fork the project
+- bundle
+- bundle rake exec
+- Make your feature addition or fix a bug
+- Do not mess with rakefile, version or history (do not submit version bump PLEASE or put it in a different commit so we can ignore it when pull)
+- Send us the pull request
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/proxypay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/smaziano/proxypay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/proxypay/version.rb

@@ -1,3 +1,3 @@
 module Proxypay
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/proxypay.rb

@@ -7,30 +7,30 @@ module Proxypay
 
   # Fetch all available references
   def self.get_references(options={})
-    auth = {
-      username:ENV["PROXY_PAY_USER"],
-      password:ENV["PROXY_PAY_PASSWORD"]
-    }
-    options = {basic_auth:auth}
+    options = {:basic_auth => authenticate}
     get('/references', options).parsed_response
   end
 
   # Submit a request to create a new reference
-  def self.new_reference(amount, expiry_date)
-    post('/references', :body =>{:reference => {:amount      => amount,
-                                 :expiry_date => expiry_date}}.to_json,
-                        :basic_auth => {:username => ENV["PROXY_PAY_USER"], :password => ENV["PROXY_PAY_PASSWORD"]},
-                        :headers => { 'Content-Type' => 'application/json'}).parsed_response
+  def self.new_reference(amount, expiry_date, other_data={})
+    post('/references',
+      :body =>{ :reference => {:amount => amount, :expiry_date => expiry_date, :custom_fields => other_data } }.to_json,
+      :basic_auth => authenticate,
+      :headers => { 'Content-Type' => 'application/json'}).parsed_response
   end
 
   # Fetch all availables payments
   def self.get_payments(options={})
+    options = {:basic_auth => authenticate}
+    get('/events/payments', options).parsed_response
+  end
+
+  private
+  def self.authenticate
     auth = {
-      username:ENV["PROXY_PAY_USER"],
-      password:ENV["PROXY_PAY_PASSWORD"]
+      username:ENV["PROXYPAY_USER"],
+      password:ENV["PROXYPAY_API_KEY"]
     }
-    options = {basic_auth:auth}
-    get('/events/payments', options).parsed_response
   end
 end
 

data/proxypay.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |spec|
   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.description   = %q{A ruby library to connect your application connect with the ProxyPay API that allows yours applications interact with tha Angolan ATM system also knows as Multicaixa}
+  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"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxypay
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sergio Maziano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,9 +52,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.7
-description: A ruby library to connect your application connect with the ProxyPay
-  API that allows yours applications interact with tha Angolan ATM system also knows
-  as Multicaixa
+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.
 email:
 - sergio.maziano@gmail.com
 executables: []