perfect_audit 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c44bff4137bdd40b067263f0e526acbaba3b1bc
+  data.tar.gz: 7cc8e2d98a5848df06754c50dc7e0528a0126959
+SHA512:
+  metadata.gz: 4c56f255bb80c54f2975c0a4fce2ccc36f4e44dc7b752645eef82567a7dde9a542f20c5a371dbcfc5276fa551a4c85e57cd44484c86c5f4b39ff110d18b68389
+  data.tar.gz: 46fe3306210da40faba5806657ee2f6dc7c7f231ed468a03a60ff66037e895f5bbbda427707331b9ca31023b3e92716c8080c021535da52f7ac9bcd2ed640d40

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.irbrc

@@ -0,0 +1,7 @@
+begin
+  require 'pry'
+  Pry.start
+  exit
+rescue LoadError
+  puts "Pry not found, using 'irb' instead. Try\n  gem install pry"
+end

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Igor Alexandrov
+
+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,82 @@
+# PerfectAudit
+
+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/perfect_audit`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'perfect_audit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install perfect_audit
+
+## Configuration
+
+``` ruby
+  PerfectAudit.configure do |config|
+    config[:api_key] = 'your_api_key'
+    config[:api_secret] = 'your_api_secret'
+  end
+```
+
+## Usage
+
+### Books
+
+Get books list for your account:
+
+``` ruby
+PerfectAudit.books.all
+```
+
+Create a book:
+
+``` ruby
+PerfectAudit.books.create(name: 'Test book', is_public: 'false')
+```
+
+Get book information:
+
+``` ruby
+PerfectAudit.books.find(book_id)
+```
+
+Delete a book:
+
+``` ruby
+PerfectAudit.books.delete(book_or_id)
+```
+
+### Documents
+
+Upload document to a book:
+
+``` ruby
+PerfectAudit.documents.create(book_or_id, file_or_io)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/perfect_audit.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "perfect_audit"
+
+# 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

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/perfect_audit.rb

@@ -0,0 +1,47 @@
+require 'dry-container'
+require 'dry-auto_inject'
+
+require 'perfect_audit/connection'
+require 'perfect_audit/response_parser'
+require 'perfect_audit/version'
+
+module PerfectAudit
+
+  class << self
+    def configure
+      configuration = Hash.new
+      yield configuration
+
+      connection = PerfectAudit::Connection.new(configuration)
+
+      container.register :connection, -> { connection }
+      container.register :response_parser, -> { PerfectAudit::ResponseParser }
+      container.freeze
+    end
+
+    def books
+      PerfectAudit::BooksRepository.new
+    end
+
+    def documents
+      PerfectAudit::DocumentsRepository.new
+    end
+
+    def transactions
+      PerfectAudit::TransactionsRepository.new
+    end
+  end
+
+  private
+
+  @@container = Dry::Container.new
+
+  AutoInject = Dry::AutoInject(@@container)
+
+  def self.container
+    @@container
+  end
+end
+
+require 'perfect_audit/api/repositories'
+# require 'local_configuration'

data/lib/perfect_audit/api/bank_account.rb

@@ -0,0 +1,26 @@
+require 'perfect_audit/api/period'
+
+module PerfectAudit
+  class BankAccount
+    extend Dry::Initializer
+
+    option :pk, as: :id
+    option :book_pk, as: :book_id
+    option :account_type#, optional: true
+    option :account_holder#, optional: true
+    option :account_number#, optional: true
+    option :holder_zip#, optional: true
+    option :holder_state#, optional: true
+    option :holder_city#, optional: true
+    option :holder_address_1#, optional: true
+    option :holder_address_2#, optional: true
+    option :name
+    option :periods, as: :_periods
+
+    def periods
+      _periods.map do |item|
+        PerfectAudit::Period.new(item.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo})
+      end
+    end
+  end
+end

data/lib/perfect_audit/api/book.rb

@@ -0,0 +1,38 @@
+require 'perfect_audit/api/bank_account'
+require 'perfect_audit/api/document'
+
+module PerfectAudit
+  class Book
+    extend Dry::Initializer
+
+    option :pk, as: :id
+    option :created, as: :created_at
+    option :name
+    option :is_public, as: :public
+    option :owner_email, optional: true
+    option :status_tags, optional: true
+    option :bank_accounts, optional: true, as: :_bank_accounts
+    option :docs, optional: true, as: :_documents
+
+    alias_method :public?, :public
+
+    def bank_accounts
+      _bank_accounts.map do |id, params|
+        PerfectAudit::BankAccount.new(params.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo})
+      end
+    end
+
+    def documents
+      _documents.map do |item|
+        PerfectAudit::Document.new(item.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo})
+      end
+    end
+
+    def verification_complete?
+      documents.all?(&:verification_complete?)
+    end
+  end
+end
+
+
+

data/lib/perfect_audit/api/document.rb

@@ -0,0 +1,26 @@
+module PerfectAudit
+  class Document
+    extend Dry::Initializer
+
+    STATUSES = %w(
+      queued
+      failed
+      verifying
+      verification_complete
+      deleting
+      deleted
+      rejected
+    )
+
+    option :pk, as: :id
+    option :pages
+    option :status, proc(&:downcase)
+    option :name
+
+    STATUSES.each do |s|
+      define_method "#{s}?" do
+        status == s
+      end
+    end
+  end
+end

data/lib/perfect_audit/api/period.rb

@@ -0,0 +1,16 @@
+module PerfectAudit
+  class Period
+    extend Dry::Initializer
+
+    option :pk, as: :id
+    option :begin_date, proc { |v| Date.parse(v) }
+    option :end_date, proc { |v| Date.parse(v) }
+    option :begin_balance, proc(&:to_f)
+    option :end_balance, proc(&:to_f)
+    option :primary_recon_error_reason
+    option :secondary_recon_error_reason
+  end
+end
+
+
+

data/lib/perfect_audit/api/repositories.rb

@@ -0,0 +1,90 @@
+require 'perfect_audit/api/book'
+require 'http/form_data'
+
+module PerfectAudit
+  class BooksRepository
+    include PerfectAudit::AutoInject[:connection]
+    include PerfectAudit::AutoInject[:response_parser]
+
+    def create(name, public = false)
+      response = connection.post('book/add',
+        json: {
+          name: name.to_s,
+          is_public: public.to_s
+        }
+      )
+
+      PerfectAudit::Book.new(response_parser.parse(response.body.to_s))
+    end
+
+    def all
+      response = connection.get('books')
+
+      response_parser.parse(response.body.to_s).map{ |item|
+        PerfectAudit::Book.new(item)
+      }
+    end
+
+    def find(id)
+      response = connection.get('book/info',
+        params: {
+          pk: id.to_s
+        }
+      )
+
+      PerfectAudit::Book.new(response_parser.parse(response.body.to_s))
+    end
+
+    def delete(book_or_id)
+      id = book_or_id.is_a?(PerfectAudit::Book) ? book_or_id.id.to_s : book_or_id.to_s
+      response = connection.post('book/remove',
+        json: {
+          book_id: id
+        }
+      )
+
+      response_parser.parse(response.body.to_s)
+
+      true
+    end
+  end
+
+  class DocumentsRepository
+    include PerfectAudit::AutoInject[:connection]
+    include PerfectAudit::AutoInject[:response_parser]
+
+    def create(book_or_id, file)
+      id = book_or_id.is_a?(PerfectAudit::Book) ? book_or_id.id.to_s : book_or_id.to_s
+
+      response = connection.post('book/upload',
+        form: {
+          pk: id,
+          upload: HTTP::FormData::File.new(file)
+        }
+      )
+
+      response_parser.parse(response.body.to_s)
+
+      true
+    end
+  end
+
+  # class TransactionsRepository
+  #   include PerfectAudit::AutoInject[:connection]
+  #   include PerfectAudit::AutoInject[:response_parser]
+
+  #   def find(book_or_id)
+  #     id = book_or_id.is_a?(PerfectAudit::Book) ? book_or_id.id.to_s : book_or_id.to_s
+
+  #     response = connection.get('transaction',
+  #       params: {
+  #         book_pk: id
+  #       }
+  #     )
+
+  #     response_parser.parse(response.body.to_s)[:bank_accounts].map do |id, params|
+  #       PerfectAudit::BankAccount.new(params.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo})
+  #     end
+  #   end
+  # end
+end

data/lib/perfect_audit/connection.rb

@@ -0,0 +1,27 @@
+require 'dry-initializer'
+require 'http'
+
+module PerfectAudit
+  class Connection
+    extend Dry::Initializer
+
+    BASE_PATH = 'https://www.perfectaudit.com/api/v1/'.freeze
+
+    option :api_key
+    option :api_secret
+
+    def post(path, params)
+      HTTP.basic_auth(:user => api_key, :pass => api_secret).post(url(path), params)
+    end
+
+    def get(path, params = {})
+      HTTP.basic_auth(:user => api_key, :pass => api_secret).get(url(path), params)
+    end
+
+    private
+
+    def url(path)
+      URI.join(BASE_PATH, path)
+    end
+  end
+end

data/lib/perfect_audit/response_parser.rb

@@ -0,0 +1,22 @@
+require 'ostruct'
+
+module PerfectAudit
+  class ResponseParser
+    def self.parse(response)
+      struct = OpenStruct.new(JSON.parse(response))
+
+      raise StandardError, struct.message if struct.status != 200
+
+      case struct.response
+      when Hash
+        struct.response.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      when Array
+        struct.response.map do |item|
+          item.inject({}){ |memo,(k,v)| memo[k.to_sym] = v; memo }
+        end
+      else
+        struct.response
+      end
+    end
+  end
+end

data/lib/perfect_audit/version.rb

@@ -0,0 +1,3 @@
+module PerfectAudit
+  VERSION = '0.1.1'.freeze
+end

data/perfect_audit.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'perfect_audit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "perfect_audit"
+  spec.version       = PerfectAudit::VERSION
+  spec.authors       = ["Igor Alexandrov"]
+  spec.email         = ["igor.alexandrov@gmail.com"]
+
+  spec.summary       = %q{Perfect Audit API gem.}
+  spec.description   = %q{Perfect Audit API gem. https://www.perfectaudit.com/api_docs}
+  spec.homepage      = "https://github.com/igor-alexandrov/perfect_audit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.3'
+
+  # a b c d e f g h i j k l m n o p q r s t u v w x y z
+  spec.add_dependency 'dry-auto_inject'
+  spec.add_dependency 'dry-container'
+  spec.add_dependency 'dry-initializer'
+  spec.add_dependency 'http'
+  spec.add_dependency 'http-form_data'
+
+  spec.add_development_dependency 'bundler', "~> 1.11"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.0"
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: perfect_audit
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Igor Alexandrov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-auto_inject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http-form_data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Perfect Audit API gem. https://www.perfectaudit.com/api_docs
+email:
+- igor.alexandrov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".irbrc"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/perfect_audit.rb
+- lib/perfect_audit/api/bank_account.rb
+- lib/perfect_audit/api/book.rb
+- lib/perfect_audit/api/document.rb
+- lib/perfect_audit/api/period.rb
+- lib/perfect_audit/api/repositories.rb
+- lib/perfect_audit/connection.rb
+- lib/perfect_audit/response_parser.rb
+- lib/perfect_audit/version.rb
+- perfect_audit.gemspec
+homepage: https://github.com/igor-alexandrov/perfect_audit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Perfect Audit API gem.
+test_files: []
+has_rdoc: