regaliator 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efcf64f576bc7a9431e43534c2f9198c77fbb485
+  data.tar.gz: bc6e231c1cba489c8eeef2dbd7fc3a829a867463
+SHA512:
+  metadata.gz: c3275c4f56fb2a72c00d5d0574c7143cd98a3409d34b264ea6ea2d6b60c1ec8eea002dc4c298f9cce0e9c755fd3b39b754a450b282d02fa654fc3b0a151add50
+  data.tar.gz: b5b4a82649400cc05219c00152d89e5d23d07c20d3318afe1f218318148dfd1bd5bb97fb9081efc4f70652a33e68b6a268c5603325a8bde676922d8b245d83d2

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.1.10

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in regaliator.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,36 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+directories %w(lib test)
+
+## Uncomment to clear the screen before every task
+clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Hesham
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# Regaliator
+
+Ruby wrapper for Regalii's API. The full API docs:
+  * Version 3.1 (recommended): https://www.regalii.com/api/v3/overview ;
+  * Version 3.0 : https://www.regalii.com/api/v3/overview ;
+  * Version 1.5 : https://www.regalii.com/api/v1/overview
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'regaliator', github: 'regalii/regaliator'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+Add the following to config/initializers/regaliator.rb:
+
+```ruby
+Regaliator.configure do |config|
+  # Version target
+  config.version      = '3.1'
+
+  # Authentication settings
+  config.api_key      = 'your-api-key'
+  config.secret_key   = 'your-secret-key'
+
+  # API host settings
+  config.host         = 'api.casiregalii.com'
+  config.open_timeout = 5
+  config.read_timeout = 10
+  config.use_ssl      = true
+
+  # Proxy settings
+  config.proxy_host   = nil
+  config.proxy_port   = nil
+  config.proxy_user   = nil
+  config.proxy_pass   = nil
+end
+```
+
+## Versions
+
+To switch the version API, you have just to set the version in the configuration,
+for instance, the version `1.5`:
+
+```ruby
+Regaliator.configure do |config|
+  # Version target
+  config.version = '1.5'
+
+  # ...
+end
+```
+
+The available versions are: `1.5`, `3.0` and `3.1` (recommended).
+
+## Requests
+
+**Success:**
+
+```ruby
+> response = Regaliator.new.bill.show(1)
+> response.success?
+=> true
+> response.data
+=> {...}
+```
+
+```ruby
+> response = Regaliator.new.bill.pay(1, amount: 13.0, currency: 'MXN')
+> response.success?
+=> true
+> response.data
+=> {...}
+```
+
+**Failure:**
+
+```ruby
+> response = Regaliator.new.bill.pay(biller_id: 1, account_number: '12345', amount: 0.0, currency: 'MXN')
+> response.success?
+=> false
+> response.data
+=> {"code" => "R3", "message" => "Invalid Payment Amount"}
+```
+
+## Examples
+
+The following examples will show how to use the Regaliator gem to connect to the different Regalii API endpoints.
+
+### Billers List
+https://www.regalii.com/billers
+```ruby
+response = Regaliator.new.biller.utilities
+```
+
+## Tests
+
+To run the tests, run:
+```
+$ bundle exec rake test
+```
+
+To test on each file change, run:
+
+```
+$ bundle exec guard
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/regaliator/api_version_error.rb

@@ -0,0 +1,7 @@
+module Regaliator
+  class APIVersionError < StandardError
+    def initialize(api_version)
+      super("API version `#{api_version}' isn't supported!")
+    end
+  end
+end

data/lib/regaliator/client.rb

@@ -0,0 +1,9 @@
+module Regaliator
+  class Client
+    attr_accessor :config
+
+    def initialize(config = Regaliator.configuration)
+      @config = config
+    end
+  end
+end

data/lib/regaliator/configuration.rb

@@ -0,0 +1,25 @@
+module Regaliator
+  class Configuration
+    attr_accessor :api_key, :secret_key, :host, :open_timeout, :read_timeout,
+      :use_ssl, :proxy_host, :proxy_port, :proxy_user, :proxy_pass, :version
+
+    def initialize
+      @api_key      = nil
+      @secret_key   = nil
+      @host         = nil
+      @version      = nil
+      @open_timeout = 10
+      @read_timeout = 60
+      @use_ssl      = true
+
+      @proxy_host   = nil
+      @proxy_port   = nil
+      @proxy_user   = nil
+      @proxy_pass   = nil
+    end
+
+    def secure?
+      use_ssl == true
+    end
+  end
+end

data/lib/regaliator/endpoint.rb

@@ -0,0 +1,17 @@
+require 'regaliator/request'
+
+module Regaliator
+  class Endpoint
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    private
+
+    def request(*args)
+      Request.new(config, *args)
+    end
+  end
+end

data/lib/regaliator/request.rb

@@ -0,0 +1,100 @@
+require 'base64'
+require 'digest'
+require 'net/http'
+require 'openssl'
+require 'uri'
+require 'regaliator/response'
+require 'regaliator/version'
+
+module Regaliator
+  class Request
+    CONTENT_TYPE = 'application/json'.freeze
+
+    attr_reader :config, :http, :http_request, :uri, :endpoint, :params, :timestamp
+
+    def initialize(config, endpoint, params = {})
+      @config    = config
+      @timestamp = Time.now.utc.httpdate.to_s
+      @endpoint  = endpoint
+      @params    = params
+      @uri       = build_uri
+      @http      = build_http
+    end
+
+    def post
+      @http_request = Net::HTTP::Post.new(uri.request_uri)
+      @http_request.body = params.to_json
+
+      send_request
+    end
+
+    def get
+      uri.query = URI.encode_www_form(params) if !params.empty?
+      @http_request = Net::HTTP::Get.new(uri.request_uri)
+
+      send_request
+    end
+
+    def patch
+      @http_request = Net::HTTP::Patch.new(uri.request_uri)
+      @http_request.body = params.to_json
+
+      send_request
+    end
+
+    def send_request
+      apply_headers
+
+      response = http.request(http_request)
+      Regaliator::Response.new(response)
+    end
+
+    private
+
+    def build_uri
+      protocol = config.secure? ? 'https' : 'http'
+      url = ["#{protocol}://#{config.host}", endpoint].join
+      URI.parse(url)
+    end
+
+    def build_http
+      http = Net::HTTP::Proxy(config.proxy_host,
+                              config.proxy_port,
+                              config.proxy_user,
+                              config.proxy_pass).new(uri.host, uri.port)
+
+      http.read_timeout = config.read_timeout
+      http.open_timeout = config.open_timeout
+      http.use_ssl      = config.secure?
+      http.ssl_version  = :TLSv1
+
+      http
+    end
+
+    def apply_headers
+      {
+        'User-Agent'    => "Regaliator gem v#{Regaliator::VERSION}",
+        'Accept'        => "application/vnd.regalii.v#{config.version}+json",
+        'Content-Type'  => CONTENT_TYPE,
+        'Date'          => timestamp,
+        'Content-MD5'   => content_md5,
+        'Authorization' => authorization
+      }.each { |k,v| http_request[k] = v }
+    end
+
+    def authorization
+      digest = OpenSSL::Digest.new('sha1')
+      auth = Base64.strict_encode64(OpenSSL::HMAC.digest(digest, config.secret_key, canonical_string))
+
+      "APIAuth #{config.api_key}:#{auth}"
+    end
+
+    def canonical_string
+      [CONTENT_TYPE, content_md5, http_request.path, timestamp].join(',')
+    end
+
+    def content_md5
+      Digest::MD5.base64digest(http_request.body) if http_request.body
+    end
+  end
+end

data/lib/regaliator/response.rb

@@ -0,0 +1,40 @@
+require 'json'
+require 'net/http'
+
+module Regaliator
+  class Response
+    PAGINATION_HEADER = 'X-Pagination'.freeze
+
+    attr_reader :http_response
+
+    def initialize(http_response)
+      @http_response = http_response
+    end
+
+    def data
+      @data ||= begin
+        JSON::parse(http_response.body).tap do |hsh|
+          hsh.merge!('pagination' => pagination) if paginated?
+        end
+      rescue
+        { message: 'Server returned a non-json error' }
+      end
+    end
+
+    def success?
+      @success ||= http_response.kind_of?(Net::HTTPSuccess)
+    end
+
+    def fail?
+      !success?
+    end
+
+    def paginated?
+      http_response.key?(PAGINATION_HEADER)
+    end
+
+    def pagination
+      @pagination ||= JSON::parse(http_response[PAGINATION_HEADER])
+    end
+  end
+end

data/lib/regaliator/v15/account.rb

@@ -0,0 +1,11 @@
+require 'regaliator/endpoint'
+
+module Regaliator
+  module V15
+    class Account < Endpoint
+      def info
+        request('/account').post
+      end
+    end
+  end
+end

data/lib/regaliator/v15/bill.rb

@@ -0,0 +1,23 @@
+require 'regaliator/endpoint'
+
+module Regaliator
+  module V15
+    class Bill < Endpoint
+      def index(params = {})
+        request('/bills', params).post
+      end
+
+      def consult(params = {})
+        request('/bill/consult', params).post
+      end
+
+      def pay(params = {})
+        request('/bill/pay', params).post
+      end
+
+      def check(params = {})
+        request('/bill/check', params).post
+      end
+    end
+  end
+end

data/lib/regaliator/v15/biller.rb

@@ -0,0 +1,15 @@
+require 'regaliator/endpoint'
+
+module Regaliator
+  module V15
+    class Biller < Endpoint
+      def topups(params = {})
+        request('/billers/topups', params).post
+      end
+
+      def utilities(params = {})
+        request('/billers/utilities', params).post
+      end
+    end
+  end
+end

data/lib/regaliator/v15/client.rb

@@ -0,0 +1,32 @@
+require 'regaliator/client'
+require 'regaliator/v15/account'
+require 'regaliator/v15/bill'
+require 'regaliator/v15/biller'
+require 'regaliator/v15/rate'
+require 'regaliator/v15/transaction'
+
+module Regaliator
+  module V15
+    class Client < Client
+      def account
+        Account.new(config)
+      end
+
+      def bill
+        Bill.new(config)
+      end
+
+      def biller
+        Biller.new(config)
+      end
+
+      def rate
+        Rate.new(config)
+      end
+
+      def transaction
+        Transaction.new(config)
+      end
+    end
+  end
+end

data/lib/regaliator/v15/rate.rb

@@ -0,0 +1,15 @@
+require 'regaliator/endpoint'
+
+module Regaliator
+  module V15
+    class Rate < Endpoint
+      def list
+        request('/rates').post
+      end
+
+      def history
+        request('/rates/history').post
+      end
+    end
+  end
+end

data/lib/regaliator/v15/transaction.rb

@@ -0,0 +1,23 @@
+require 'regaliator/endpoint'
+
+module Regaliator
+  module V15
+    class Transaction < Endpoint
+      def list(params = {})
+        request('/transactions', params).post
+      end
+
+      def pay(params = {})
+        request('/transaction/pay', params).post
+      end
+
+      def reverse(params = {})
+        request('/transaction/reverse', params).post
+      end
+
+      def cancel(params = {})
+        request('/transaction/cancel', params).post
+      end
+    end
+  end
+end

data/lib/regaliator/v15.rb

@@ -0,0 +1,7 @@
+require 'regaliator/v15/client'
+
+module Regaliator
+  module V15
+    API_VERSION = '1.5'.freeze
+  end
+end

data/lib/regaliator/v30/account.rb

@@ -0,0 +1,11 @@
+require 'regaliator/endpoint'
+
+module Regaliator
+  module V30
+    class Account < Endpoint
+      def info
+        request('/account').get
+      end
+    end
+  end
+end

data/lib/regaliator/v30/bill.rb

@@ -0,0 +1,35 @@
+require 'regaliator/endpoint'
+
+module Regaliator
+  module V30
+    class Bill < Endpoint
+      def create(params = {})
+        request('/bills', params).post
+      end
+
+      def show(id)
+        request("/bills/#{id}").get
+      end
+
+      def update(id, params = {})
+        request("/bills/#{id}", params).patch
+      end
+
+      def refresh(id)
+        request("/bills/#{id}/refresh").post
+      end
+
+      def pay(id, params = {})
+        request("/bills/#{id}/pay", params).post
+      end
+
+      def xdata(id)
+        request("/bills/#{id}/xdata").get
+      end
+
+      def list(params = {})
+        request('/bills', params).get
+      end
+    end
+  end
+end

data/lib/regaliator/v30/biller.rb

@@ -0,0 +1,19 @@
+require 'regaliator/endpoint'
+
+module Regaliator
+  module V30
+    class Biller < Endpoint
+      def credentials(params = {})
+        request('/billers/credentials', params).get
+      end
+
+      def topups(params = {})
+        request('/billers/topups', params).get
+      end
+
+      def utilities(params = {})
+        request('/billers/utilities', params).get
+      end
+    end
+  end
+end

data/lib/regaliator/v30/client.rb

@@ -0,0 +1,32 @@
+require 'regaliator/client'
+require 'regaliator/v30/account'
+require 'regaliator/v30/bill'
+require 'regaliator/v30/biller'
+require 'regaliator/v30/rate'
+require 'regaliator/v30/transaction'
+
+module Regaliator
+  module V30
+    class Client < Client
+      def account
+        Account.new(config)
+      end
+
+      def bill
+        Bill.new(config)
+      end
+
+      def biller
+        Biller.new(config)
+      end
+
+      def rate
+        Rate.new(config)
+      end
+
+      def transaction
+        Transaction.new(config)
+      end
+    end
+  end
+end

data/lib/regaliator/v30/rate.rb

@@ -0,0 +1,15 @@
+require 'regaliator/endpoint'
+
+module Regaliator
+  module V30
+    class Rate < Endpoint
+      def list
+        request('/rates').get
+      end
+
+      def history
+        request('/rates/history').get
+      end
+    end
+  end
+end