finapps 0.0.14.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7258bf7333018dffd9148db974ba790c694d9608
+  data.tar.gz: 6ea476c463319fd83bcac0dcbca13d8ba6fe8695
+SHA512:
+  metadata.gz: 5833149eb9fcc599b371415869a4807c300ddebef40a669d9195db7232e8cceb8dc420c6ad806f402d67dd3e66ee9ae23f49dc087401c7e04ec321a2b7a92255
+  data.tar.gz: ef79908cc3aee6c4a561414a782544cb5538ada3b2577ab955a49e60ae8e8680ab8435244a0b9fa1978f26a8adccdbf8e42e613abd12889ed09072eec097e96c

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+finapps

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p481

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 qbantek
+
+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,64 @@
+FinApps Ruby-Client
+===================
+
+Ruby client for [FinApps][financialapps].
+
+A simple library for communicating with the [FinApps][financialapps] REST API.
+
+
+
+## Installation
+
+
+To install using [Bundler][bundler], add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+gem 'finapps'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install finapps
+```
+
+
+
+## Getting started with FinApps REST client
+
+### Setup
+
+You will need to authenticate every API call using your FinApps company credentials. 
+
+Please visit [FinApps][financialapps] if you still haven't setup your account with Financial Apps or have any issues locating your company credentials.
+
+
+``` ruby
+require 'finapps'
+
+# replace with your own credentials here
+company_identifier = 'my-company-identifier'
+company_token = 'my-company-token'
+
+# set up a client to talk to the FinApps REST API
+@client = FinApps::REST::Client.new company_identifier, company_token
+```
+
+## More Information
+
+Please check the [FinApps wiki][wiki] for extended documentation.
+
+
+[FinancialApps.com][financialapps]
+
+
+[bundler]: http://bundler.io
+[financialapps]: https://financialapps.com
+[wiki]: https://github.com/finapps/ruby-client/wiki

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/bin/finapps

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'finapps/cli/common'
+require 'finapps/cli/users'
+require 'finapps/cli/institutions'
+
+FinApps::CLI.start

data/finapps.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'finapps/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'finapps'
+  spec.version = FinApps::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ['Erich Quintero']
+  spec.email = ['erich@financialapps.com']
+
+  spec.summary = %q{FinApps REST API ruby client.}
+  spec.description = %q{A simple library for communicating with the FinApps REST API.}
+  spec.homepage = 'http://github.com/finapps/finapps-ruby'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = Dir['spec/**/*.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thor',  '~> 0.19', '>= 0.19.1'
+  spec.add_runtime_dependency 'faraday',  '~> 0.9', '>= 0.9.0'
+  spec.add_runtime_dependency 'faraday_middleware',  '~> 0.9', '>= 0.9.1'
+  spec.add_runtime_dependency 'typhoeus',  '~> 0.6', '>= 0.6.8'
+  spec.add_runtime_dependency 'rash', '~> 0.4', '>= 0.4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6', '>= 1.6.2'
+  spec.add_development_dependency 'rake', '~> 0.9', '>= 0.9.6'
+  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+
+  spec.extra_rdoc_files = %w(README.md LICENSE.txt)
+  spec.rdoc_options = %w(--line-numbers --inline-source --title finapps-ruby --main README.md)
+end

data/lib/finapps/cli/common.rb

@@ -0,0 +1,40 @@
+require 'thor'
+require 'finapps'
+
+
+module FinApps
+  class CLI < Thor
+
+    desc 'create_client', 'initialize API REST Client'
+
+    def create_client
+      puts client
+    end
+
+    private
+
+    def client
+      company_id = ENV['FA_ID']
+      raise 'Invalid company identifier. Please setup the FA_ID environment variable.' if company_id.blank?
+
+      company_token = ENV['FA_TOKEN']
+      raise 'Invalid company token. Please setup the FA_TOKEN environment variable.' if company_token.blank?
+
+      host = ENV['FA_URL']
+      raise 'Invalid API host url. Please setup the FA_URL environment variable.' if host.blank?
+
+      @client ||= FinApps::REST::Client.new company_id, company_token, {:host => host, :log_level => Logger::DEBUG,
+                                                                        :request_uuid => 'le-request-uuid-z',
+                                                                        :session_id => 'da-session-idz'}
+    end
+
+    def rescue_standard_error(error)
+      puts '=============================='
+      puts 'Error:'
+      p error
+      puts "Backtrace:\n\t#{error.backtrace.join("\n\t")}"
+      puts '=============================='
+    end
+
+  end
+end

data/lib/finapps/cli/institutions.rb

@@ -0,0 +1,34 @@
+require 'thor'
+require 'finapps'
+require 'securerandom'
+require 'pp'
+
+module FinApps
+  class CLI < Thor
+
+    desc 'institutions_search', 'search institutions'
+
+    def institutions_search(user_identifier, user_token, term=nil)
+
+      begin
+        client.user_credentials!(user_identifier, user_token)
+        institutions, error_messages = client.institutions.search term
+        if institutions.present?
+          puts
+          puts 'search results:'
+          pp institutions
+        else
+          puts
+          puts 'unable to search institutions'
+          error_messages.each { |m| puts m } if error_messages.present?
+        end
+        puts
+
+      rescue StandardError => error
+        rescue_standard_error(error)
+      end
+
+    end
+
+  end
+end

data/lib/finapps/cli/users.rb

@@ -0,0 +1,87 @@
+require 'thor'
+require 'finapps'
+require 'securerandom'
+require 'pp'
+
+module FinApps
+  class CLI < Thor
+
+    desc 'user_create', 'creates a new API user'
+
+    def user_create(email=nil, password=nil)
+
+      begin
+        email ||= "test-#{SecureRandom.uuid}@powerwallet.com"
+        password ||= 'Power1'
+        user, error_messages = client.users.create ({:email => email,
+                                                     :password => password,
+                                                     :password_confirm => password,
+                                                     :postal_code => '33021'})
+        if user.present?
+          puts
+          puts 'user created:'
+          pp user
+        else
+          puts
+          puts 'unable to create user'
+          error_messages.each { |m| puts m } if error_messages.present?
+        end
+        puts
+
+      rescue StandardError => error
+        rescue_standard_error(error)
+      end
+
+    end
+
+    desc 'user_login', 'creates a new API user and signs in'
+
+    def user_login(email=nil, password=nil)
+
+      begin
+        email ||= "test-#{SecureRandom.uuid}@powerwallet.com"
+        password ||= 'WrongPassword'
+        user, error_messages = client.users.login ({:email => email, :password => password})
+        if user.present?
+          puts
+          puts 'user logged in:'
+          pp user
+        else
+          puts
+          puts 'unable to login user'
+          error_messages.each { |m| puts m } if error_messages.present?
+        end
+        puts
+
+      rescue StandardError => error
+        rescue_standard_error(error)
+      end
+
+    end
+
+    desc 'user_delete', 'deletes an API user'
+
+    def user_delete(public_id=nil)
+
+      begin
+        public_id ||= SecureRandom.uuid.to_s
+
+        error_messages = client.users.delete (public_id)
+        if error_messages.blank?
+          puts
+          puts 'user deleted!'
+        else
+          puts
+          puts 'unable to delete user'
+          error_messages.each { |m| puts m }
+        end
+        puts
+
+      rescue StandardError => error
+        rescue_standard_error(error)
+      end
+
+    end
+
+  end
+end

data/lib/finapps/middleware/api_token.rb

@@ -0,0 +1,25 @@
+module FinApps
+  module Middleware
+
+    class ApiToken < Faraday::Middleware
+      include FinApps::Logging
+
+      def initialize(app, options={})
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        raise MissingArgumentsError.new 'Missing argument: company_identifier.' if @options[:company_identifier].blank?
+        raise MissingArgumentsError.new 'Missing argument: company_token.' if @options[:company_token].blank?
+
+        header_value = "#{@options[:company_identifier].trim}=#{@options[:company_token].trim}"
+        logger.debug "##{__method__.to_s} => Request Header X-FinApps-Token: #{header_value}"
+        env[:request_headers]['X-FinApps-Token'] = header_value
+
+        @app.call(env)
+      end
+
+    end
+  end
+end

data/lib/finapps/middleware/raise_http_exceptions.rb

@@ -0,0 +1,91 @@
+module FinApps
+  module Middleware
+
+    class RaiseHttpExceptions < Faraday::Response::Middleware
+      include FinApps::Logging
+
+      CLIENT_ERROR_STATUSES = 400...600
+
+      def on_complete(env)
+
+        case env[:status]
+          when 400
+            raise FinApps::REST::BadRequest, response_values(env, 'The request could not be understood by the server due to malformed syntax.')
+          when 401
+            raise FinApps::REST::Unauthorized, response_values(env, 'The request requires user authentication.')
+          when 403
+            raise FinApps::REST::Forbidden, response_values(env, 'Forbidden.')
+          when 404
+            raise FinApps::REST::NotFound, response_values(env, 'Page not found.')
+          when 405
+            raise FinApps::REST::MethodNotAllowed, response_values(env, 'The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.')
+          when 406
+            raise FinApps::REST::NotAcceptable, response_values(env, 'The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request')
+          when 407
+            raise Faraday::Error::ConnectionFailed, response_values(env, 'Proxy Authentication Required.')
+          when 409
+            raise FinApps::REST::Conflict, response_values(env, 'The request could not be completed due to a conflict with the current state of the resource.')
+
+          when 500
+            raise FinApps::REST::InternalServerError, response_values(env, 'Unexpected technical condition was encountered.')
+          when 502
+            raise FinApps::REST::BadGateway, response_values(env, 'The server returned an invalid or incomplete response.')
+          when 503
+            raise FinApps::REST::ServiceUnavailable, response_values(env, 'The server is currently unavailable.')
+          when 504
+            raise FinApps::REST::GatewayTimeout, response_values(env, 'Gateway Time-out')
+          when 505
+            raise FinApps::REST::VersionNotSupported, response_values(env, 'The Web server does not support the specified HTTP protocol version.')
+
+          when CLIENT_ERROR_STATUSES
+            raise FinApps::REST::Error, response_values(env, 'Unexpected error.')
+
+          else
+            # 200..206 Success codes
+            # all good!
+            logger.debug "##{__method__.to_s} => Status code: [#{env[:status]}]."
+        end
+
+      end
+
+      private
+
+      def error_messages(body)
+        error_array = Array.new
+
+        if body.present? && body.kind_of?(String)
+          begin
+            parsed = ::JSON.parse(body)
+            if parsed
+              parsed.each do |key, value|
+                value.each do |message|
+                  logger.debug "#{key} => #{message}"
+                  error_array.push message.to_s
+                end
+              end
+            else
+              logger.info "##{__method__.to_s} => Cannot extract errors: unexpected error while parsing response."
+            end
+          rescue ::JSON::ParserError => e
+            logger.error "##{__method__.to_s} => Unable to parse JSON response."
+            logger.error e
+          end
+        end
+
+        error_array
+      end
+
+      def response_values(env, status_message = nil)
+        {
+            :status => env.status,
+            :status_message => status_message,
+            :headers => env.response_headers,
+            :body => env.body,
+            :error_messages => error_messages(env.body)
+        }
+      end
+
+    end
+
+  end
+end

data/lib/finapps/middleware/response_logger.rb

@@ -0,0 +1,40 @@
+module FinApps
+  module Middleware
+
+    class ResponseLogger < Faraday::Response::Middleware
+      include FinApps::Logging
+
+      def call(env)
+        logger.info "##{env.method} #{env.url.to_s}"
+        logger.debug('Request Headers') { dump_headers env.request_headers }
+        super
+      end
+
+      def on_complete(env)
+        logger.info "Status: #{env.status.to_s}"
+        logger.debug('Response Headers') { dump_headers env.response_headers }
+        logger.debug('Response Body') {dump_body env.body } if env.body
+      end
+
+      private
+      def dump_headers(headers)
+        "\n" << headers.map { |k, v| "  #{k}: #{filter_sensitive_header_values(k,v)}" }.join("\n")
+      end
+
+      def filter_sensitive_header_values(key, value)
+        case key
+          when 'X-FinApps-Token', 'Basic-Authorization'
+            value.inspect
+          else
+            '[REDACTED]'
+        end
+      end
+
+      def dump_body(body)
+        "\n" << body
+      end
+
+    end
+
+  end
+end

data/lib/finapps/rest/accounts.rb

@@ -0,0 +1,13 @@
+module FinApps
+  module REST
+
+    class Accounts < FinApps::REST::Resources
+
+    end
+
+    class Account < FinApps::REST::Resource
+      attr_accessor :public_id
+    end
+
+  end
+end

data/lib/finapps/rest/client.rb

@@ -0,0 +1,154 @@
+module FinApps
+  module REST
+    class Client
+      include FinApps::REST::Defaults
+      include FinApps::Logging
+      include FinApps::REST::Connection
+
+      attr_reader :users, :institutions
+
+      # @param [String] company_identifier
+      # @param [String] company_token
+      # @param [Hash] options
+      # @return [FinApps::REST::Client]
+      def initialize(company_identifier, company_token, options = {})
+        logger.debug "##{__method__.to_s} => Started"
+
+        @config = DEFAULTS.merge! options
+        if @config[:logger_tag].present?
+          Logging.tag= @config[:logger_tag]
+          logger.info "##{__method__.to_s} => Added custom tag for logger."
+        end
+
+        set_up_logger_level @config[:log_level]
+        logger.info "##{__method__.to_s} => Current logger level: #{SEVERITY_LABEL[logger.level]}"
+
+        @company_credentials = {:company_identifier => company_identifier,
+                                :company_token => company_token}
+        @connection = set_up_connection(@company_credentials, @config)
+        logger.debug "##{__method__.to_s} => Connection initialized"
+
+        set_up_resources
+        logger.debug "##{__method__.to_s} => All resources initialized"
+
+        logger.debug "##{__method__.to_s} => Completed"
+      end
+
+      # Performs an HTTP GET request. You shouldn't need to use this method directly,
+      # but it can be useful for debugging. Returns a hash obtained from parsing
+      # the JSON object in the response body.
+      #
+      # @param [String] path
+      # @param [Proc] proc
+      # @return [Hash,Array<String>]
+      def get(path, &proc)
+        logger.debug "##{__method__.to_s} => Started"
+        response, result, error_messages = nil, nil, nil
+
+        begin
+          logger.debug "##{__method__.to_s} => GET path:#{path}"
+          response = @connection.get { |req| req.url path }
+          if response.present? && block_given?
+            result = proc.call(response)
+            logger.debug "##{__method__.to_s} => parsed result: #{result.pretty_inspect}" if result.present?
+
+          end
+        rescue FinApps::REST::Error => error
+          error_messages = error.error_messages
+          logger.debug "##{__method__.to_s} => Failed, error_messages: #{error_messages.pretty_inspect}" if error_messages.present?
+        end
+
+        logger.debug "##{__method__.to_s} => Completed"
+        return result, error_messages
+      end
+
+      # Performs an HTTP POST request. You shouldn't need to use this method directly,
+      # but it can be useful for debugging. Returns a hash obtained from parsing
+      # the JSON object in the response body.
+      #
+      # @param [String] path
+      # @param [Hash] params
+      # @param [Proc] proc
+      # @return [Hash,Array<String>]
+      def post(path, params = {}, &proc)
+        logger.debug "##{__method__.to_s} => Started"
+        response, result, error_messages = nil, nil, nil
+
+        begin
+          logger.debug "##{__method__.to_s} => POST path:#{path} params:#{skip_sensitive_data(params)}"
+          response = @connection.post do |req|
+            req.url path
+            req.body = params
+          end
+          if response.present? && block_given?
+            result = proc.call(response)
+            logger.debug "##{__method__.to_s} => parsed result: #{result.pretty_inspect}" if result.present?
+          end
+
+        rescue FinApps::REST::Error => error
+          error_messages = error.error_messages
+          logger.debug "##{__method__.to_s} => Failed, error_messages: #{error_messages.pretty_inspect}" if error_messages.present?
+        end
+
+        logger.debug "##{__method__.to_s} => Completed"
+        return result, error_messages
+      end
+
+      # Performs an HTTP DELETE request. You shouldn't need to use this method directly,
+      # but it can be useful for debugging. Returns a hash obtained from parsing
+      # the JSON object in the response body.
+      #
+      # @param [String] path
+      # @param [Hash] params
+      # @param [Proc] proc
+      # @return [Hash,Array<String>]
+      def delete(path, params = {}, &proc)
+        logger.debug "##{__method__.to_s} => Started"
+        response, result, error_messages = nil, nil, nil
+
+        begin
+          logger.debug "##{__method__.to_s} => DELETE path:#{path} params:#{skip_sensitive_data(params)}"
+          response = @connection.delete do |req|
+            req.url path
+            req.body = params
+          end
+          if response.present? && block_given?
+            result = proc.call(response)
+            logger.debug "##{__method__.to_s} => parsed result: #{result.pretty_inspect}" if result.present?
+          end
+
+        rescue FinApps::REST::Error => error
+          error_messages = error.error_messages
+          logger.debug "##{__method__.to_s} => Failed, error_messages: #{error_messages.pretty_inspect}" if error_messages.present?
+        end
+
+        logger.debug "##{__method__.to_s} => Completed"
+        return result, error_messages
+      end
+
+      # @param [String] user_identifier
+      # @param [String] user_token
+      def user_credentials!(user_identifier, user_token)
+        logger.debug "##{__method__.to_s} => Started"
+
+        {:user_identifier => user_identifier, :user_token => user_token}.validate_required_strings!
+        logger.debug "##{__method__.to_s} => Credentials passed validation. Attempting to set user credentials on current connection."
+
+
+        @config[:user_identifier] = user_identifier
+        @config[:user_token] = user_token
+        @connection = set_up_connection(@company_credentials, @config)
+
+        logger.debug "##{__method__.to_s} => Completed"
+      end
+
+      private
+
+      def set_up_resources
+        @users ||= FinApps::REST::Users.new self
+        @institutions ||= FinApps::REST::Institutions.new self
+      end
+
+    end
+  end
+end