ofx-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fbec719c8f878143842e7ce5a3d5b49901458be06deab41adaa832799b13e90
+  data.tar.gz: 790aaddf260e8c6a306f3496fdaeb6d81cca8bc4fbba684235c1543ec653dff5
+SHA512:
+  metadata.gz: 16133b8b23709e0734d46c9a685e9ecb2dfd21dd8feaf1d8373218a411b01cdf5729936a8d7b4cd4d632b8834c0cf96b07df151dcc5f8dd0a12083854e979251
+  data.tar.gz: 821b68bae5262d4b1922b22ff9e7e3ed2927e36092f36ceed876485881385c4d83812b43733c96b48888ba05f5dd5051cc358e834f85c43a31b1803a3e345973

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/.byebug_history/
+/tmp/
+# rspec failure tracking
+.rspec_status

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Milaap Social Ventures
+
+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,60 @@
+# OFX
+
+Welcome to OFX ruby gem! The OFX Ruby gem provides a small SDK for convenient access to the [OFX APIs][ofx/api] from applications written in the Ruby language. It provides a pre-defined set of classes for API resources that initialize themselves dynamically from API responses which allows the bindings to tolerate a number of different versions of the API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ofx-rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ofx-rb
+
+## Usage
+
+The library needs to be configured with environment mode "test" or "live"
+```ruby
+For live mode
+Ofx.mode = "live"
+
+For test mode
+Ofx.mode = "test"
+```
+# Development
+## Authentication
+OFX resource APIs require access token to be sent as Authorization header.
+You can get the access token as following:
+
+```ruby
+Ofx::Authentication.new("your client_id", "your client_secret").get_access_token
+```
+## Quotes API
+https://payments.developer.ofx.com/specs/quotes/create-quote
+Create a quote
+
+```ruby
+quote_params = {
+    "buyCurrency": "USD",
+    "buyAmount": 0,
+    "sellCurrency": "INR",
+    "sellAmount": 50,
+    "beneficiaries": 1
+}
+Ofx::Quote.create(quote_params, {"access_token" => "api access token"})
+```
+Get a already created quote
+https://payments.developer.ofx.com/specs/quotes/get-quote
+
+```ruby
+Ofx::Quote.get("<existing quote id>", {"access_token" => "api access token"})
+```
+
+[ofx/api]: https://payments.developer.ofx.com/

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ofx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/extentions/string.rb

@@ -0,0 +1,10 @@
+class String
+  def to_underscore!
+    gsub!(/(.)([A-Z])/,'\1_\2')
+    downcase!
+  end
+
+  def to_underscore
+    dup.tap { |s| s.to_underscore! }
+  end
+end

data/lib/ofx.rb

@@ -0,0 +1,24 @@
+require "ofx/version"
+
+require "rest-client"
+require "json"
+
+require "extentions/string"
+require "ofx/ofx_object"
+require "ofx/authentication"
+require "ofx/client"
+require "ofx/api_resource"
+require "ofx/beneficiary"
+require "ofx/quote"
+require "ofx/deal"
+require "ofx/ofx_error"
+
+module Ofx
+  class << self
+    attr_accessor :mode
+    attr_accessor :access_token
+    def api_base
+      @api_base ||= mode == 'live' ? 'https://live.api.ofx.com' : 'https://sandbox.api.ofx.com/v1'
+    end
+  end
+end

data/lib/ofx/api_resource.rb

@@ -0,0 +1,35 @@
+module Ofx
+  class APIResource
+    include Ofx::OfxObject
+
+    def self.class_name
+      self.name.split('::')[-1]
+    end
+
+    def self.resource_url(resource_id)
+      "#{collection_url}/#{resource_id}"
+    end
+
+    def self.collection_url(resource_id = nil)
+      if self == APIResource
+        raise NotImplementedError.new('APIResource is an abstract class. You should perform actions on its subclasses (Account, Transfer, etc.)')
+      end
+      "/payments/#{CGI.escape(class_name.downcase)}s"
+    end
+
+    def self.create(params = {}, opts = {})
+      response = Ofx::Client.request(:post, collection_url, params, opts)
+      convert_to_ofx_object(response)
+    end
+
+    def self.list(headers = {}, filters = {}, resource_id: nil)
+      response = Ofx::Client.request(:get, collection_url(resource_id), filters, headers)
+      convert_to_ofx_object(response)
+    end
+
+    def self.get(resource_id, headers = {})
+      response = Ofx::Client.request(:get, resource_url(resource_id), {}, headers)
+      convert_to_ofx_object(response)
+    end
+  end
+end

data/lib/ofx/authentication.rb

@@ -0,0 +1,32 @@
+module Ofx
+  class Authentication
+    attr_accessor :access_token
+
+    def initialize(client_id, client_secret)
+      @client_id, @client_secret = client_id, client_secret
+    end
+
+    def get_access_token
+      @access_token ||= fetch_auth_token["access_token"]
+    end
+
+    private
+
+    def auth_request
+      {
+        url: "#{Ofx.api_base}/oauth/token",
+        method: "post",
+        payload: "grant_type=client_credentials&client_id=#{@client_id}&client_secret=#{@client_secret}&scope=payments",
+        headers:{
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      }
+    end
+
+    def fetch_auth_token
+      response = RestClient::Request.execute(auth_request)
+      JSON.parse(response)
+    end
+
+  end
+end

data/lib/ofx/beneficiary.rb

@@ -0,0 +1,7 @@
+module Ofx
+  class Beneficiary < APIResource
+    def self.collection_url(resource_id = nil)
+      "/payments/beneficiaries"
+    end
+  end
+end

data/lib/ofx/client.rb

@@ -0,0 +1,107 @@
+module Ofx
+  class Client
+    def self.api_url(url = '')
+      Ofx.api_base + url
+    end
+
+    def self.request(method, url, params={}, headers={})
+      url = api_url(url)
+      access_token = headers.delete("access_token") || Ofx.access_token
+      request_opts = {
+        url: url,
+        method: method,
+        payload: params.to_json,
+        headers: request_headers(access_token).update(headers)
+      }
+      response = execute_request(request_opts)
+      parse(response)
+    end
+
+    private
+
+    def self.request_headers(access_token)
+      {
+        'Authorization' => "Bearer #{access_token}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def self.execute_request(request_opts)
+      begin
+        response = RestClient::Request.execute(request_opts)
+      rescue => e
+        if e.is_a?(RestClient::Exception)
+          response = handle_error(e, request_opts)
+        else
+          raise
+        end
+      end
+      response
+    end
+
+
+    def self.handle_error(e, request_opts)
+      if e.is_a?(RestClient::ExceptionWithResponse) && e.response
+        handle_api_error(e.response)
+      else
+        handle_restclient_error(e, request_opts)
+      end
+    end
+
+    def self.handle_api_error(resp)
+      error_obj = parse(resp) rescue {}
+      unless error_obj["errors"].nil?
+        error_message = error_obj["errors"].map{|e| e["message"]}.join(', ')
+      end
+
+      if Ofx::STATUS_CLASS_MAPPING.include?(resp.code)
+        raise "Ofx::#{Ofx::STATUS_CLASS_MAPPING[resp.code]}".constantize.new(error_params(error_message, resp, error_obj))
+      else
+        raise Ofx::OfxError.new(error_params(error_message, resp, error_obj))
+      end
+    end
+
+    def self.parse(response)
+      begin
+        response = JSON.parse(response.body)
+      rescue JSON::ParserError
+        raise handle_parse_error(response.code, response.body)
+      end
+      response
+    end
+
+    def self.handle_parse_error(rcode, rbody)
+      Ofx::ParseError.new({
+        message: "Unable to parse API response: #{rbody.inspect} (HTTP response code was #{rcode})",
+        http_status: rcode,
+        http_body: rbody
+      })
+    end
+
+    def self.handle_restclient_error(e, request_opts)
+      connection_message = "Please check your internet connection and try again. "
+
+      case e
+      when RestClient::RequestTimeout
+        message = "Could not connect to Ofx (#{request_opts[:url]}). #{connection_message}"
+      when RestClient::ServerBrokeConnection
+        message = "The connection to the server (#{request_opts[:url]}) broke before the " \
+          "request completed. #{connection_message}"
+      else
+        message = "Unexpected error communicating with Ofx. "
+      end
+
+      raise Ofx::APIConnectionError.new({message: "#{message} \n\n (Error: #{e.message})"})
+    end
+
+    def self.error_params(error, resp, error_obj)
+      {
+        message: error,
+        http_status: resp.code,
+        http_body: resp.body,
+        json_body: error_obj,
+        http_headers: resp.headers
+      }
+    end
+  end
+end

data/lib/ofx/deal.rb

@@ -0,0 +1,4 @@
+module Ofx
+  class Deal < APIResource
+  end
+end

data/lib/ofx/ofx_error.rb

@@ -0,0 +1,39 @@
+module Ofx
+
+  STATUS_CLASS_MAPPING = {
+    400 => "InvalidRequestError",
+    404 => "InvalidRequestError",
+    401 => "AuthenticationError"
+  }
+
+  class OfxError < StandardError
+    attr_reader :message, :http_status, :http_body, :http_headers, :json_body
+
+    def initialize(params = {})
+      params.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+
+  class APIConnectionError < OfxError
+  end
+
+  class APIError < OfxError
+  end
+
+  class AuthenticationError < OfxError
+  end
+
+  class InvalidRequestError < OfxError
+  end
+
+  class ParseError < OfxError
+  end
+
+end

data/lib/ofx/ofx_object.rb

@@ -0,0 +1,46 @@
+module Ofx
+  module OfxObject
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def initialize()
+      @values = {}
+    end
+
+    def initialize_from(values)
+      add_methods(values.keys)
+      update_attributes(values)
+      self
+    end
+
+    def add_methods(keys)
+      self.instance_eval do
+        keys.each do |k|
+          self.class.send(:define_method, k.to_underscore) { @values[k] }
+        end
+      end
+    end
+
+    def update_attributes(values)
+      values.each do |k, v|
+        @values[k] = v
+      end
+    end
+
+    module ClassMethods
+      def convert_to_ofx_object(resp)
+        case resp
+        when Array
+          resp.map { |i| convert_to_ofx_object(i) }
+        when Hash
+          self.new.initialize_from(resp)
+        else
+          resp
+        end
+      end
+    end
+
+  end
+end

data/lib/ofx/quote.rb

@@ -0,0 +1,4 @@
+module Ofx
+  class Quote < APIResource
+  end
+end

data/lib/ofx/version.rb

@@ -0,0 +1,3 @@
+module Ofx
+  VERSION = "0.1.0"
+end

data/ofx.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ofx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ofx-rb"
+  spec.version       = Ofx::VERSION
+  spec.authors       = ["Imran Ahmad"]
+  spec.email         = ["imran@milaap.org"]
+
+  spec.summary       = %q{Ruby gem for OFX APIs}
+  spec.description   = %q{Ruby gem for OFX APIs}
+  spec.homepage      = "https://github.com/Milaap/ofx-rb"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("rest-client", "~> 2.1")
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: ofx-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Imran Ahmad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby gem for OFX APIs
+email:
+- imran@milaap.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/extentions/string.rb
+- lib/ofx.rb
+- lib/ofx/api_resource.rb
+- lib/ofx/authentication.rb
+- lib/ofx/beneficiary.rb
+- lib/ofx/client.rb
+- lib/ofx/deal.rb
+- lib/ofx/ofx_error.rb
+- lib/ofx/ofx_object.rb
+- lib/ofx/quote.rb
+- lib/ofx/version.rb
+- ofx-0.1.0.gem
+- ofx.gemspec
+homepage: https://github.com/Milaap/ofx-rb
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Milaap/ofx-rb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Ruby gem for OFX APIs
+test_files: []