prefabc 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a7de0e0ff6fd6a0527742957a1608d682396bf1
+  data.tar.gz: 8f6ff3e9f31bddf8351772985a9f58699d26ec3b
+SHA512:
+  metadata.gz: 3babe4825ed6f4db21af2d782a7c2558c41727d9ad1ac73275b1e06d061f8e30771054287a4e9567f01738af2aaf12749d45a6dcc27a9bc07be2442746135617
+  data.tar.gz: 9c35c8aa1ca9090920365b8761a885507d32f450ae395c92aff1443d622bfed59ceea681dcad95792541cc15950a72d9603bc5094750dc7008b095a5a120f17b

data/.gitignore

@@ -0,0 +1,12 @@
+# OS generated files #
+######################
+.DS_Store
+
+# Test coverage tool generated files #
+######################################
+coverage
+
+# Gem related files #
+#####################
+Gemfile.lock
+*.gem

data/.rubocop.yml

@@ -0,0 +1,24 @@
+# The default values can be found here:
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+AllCops:
+  DisplayCopNames: true
+
+Documentation:
+  Enabled: false
+
+# This is a useful metric but it gets triggered by heavy meta-programming. Given
+# the design decision of thin clients, it seems like heavy meta-programming is
+# a reasonable choice and therefore this is disabled:
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*.rb
+
+Metrics/MethodLength:
+  Max: 20 # The default is 10.
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: 'comma'

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org' do
+  gem 'iniparse'
+  gem 'plissken'
+  gem 'rest-client'
+
+  group :test do
+    gem 'pry'
+    gem 'rake'
+    gem 'rspec'
+    gem 'rubocop'
+    gem 'simplecov'
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require './lib/prefabc'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: :test
+task test: %i[spec rubocop]
+
+desc 'Run all tests.'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir['test/**/*_test.rb']
+end
+
+desc 'Check style.'
+RuboCop::RakeTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.8

data/bin/console.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require './lib/prefabc'
+require 'pry'
+
+include PrefabC
+
+Pry.start

data/circle.yml

@@ -0,0 +1,7 @@
+database:
+  override:
+    - echo 'No database.'
+
+test:
+  override:
+    - bundle exec rake test

data/lib/prefabc.rb

@@ -0,0 +1,62 @@
+require 'iniparse'
+require 'plissken'
+require 'json'
+require 'rest-client'
+
+require "#{File.dirname(__FILE__)}/prefabc/abstract_resource"
+
+require "#{File.dirname(__FILE__)}/prefabc/mixins/creates_subresources"
+require "#{File.dirname(__FILE__)}/prefabc/mixins/lists_subresources"
+require "#{File.dirname(__FILE__)}/prefabc/mixins/reads_subresources"
+require "#{File.dirname(__FILE__)}/prefabc/mixins/updates"
+
+require "#{File.dirname(__FILE__)}/prefabc/transaction"
+require "#{File.dirname(__FILE__)}/prefabc/account"
+require "#{File.dirname(__FILE__)}/prefabc/book"
+require "#{File.dirname(__FILE__)}/prefabc/entity"
+
+require "#{File.dirname(__FILE__)}/prefabc/client"
+require "#{File.dirname(__FILE__)}/prefabc/version"
+
+module PrefabC
+  DEFAULT_SCHEME_AND_AUTHORITY = 'https://api.prefabc.com'.freeze
+  @scheme_and_authority ||= DEFAULT_SCHEME_AND_AUTHORITY
+
+  class << self
+    attr_accessor :scheme_and_authority
+    attr_writer :api_key
+
+    def api_key
+      @api_key || raise('No API key given.')
+    end
+
+    def load_config_from_dotfile
+      config_filepath = ENV['HOME'] + '/.prefabc'
+      return unless File.exist?(config_filepath)
+
+      config = IniParse.parse(File.read(config_filepath))
+      default_config = config['default']
+      return unless default_config
+
+      @scheme_and_authority = default_config['scheme_and_authority']
+      @api_key = default_config['api_key']
+    end
+
+    def entities
+      client = Client.new(Entity.new.collection_path)
+      client.get.map { |raw_params| Entity.new(raw_params) }
+    end
+
+    def entity(id)
+      client = Client.new("#{Entity.new.collection_path}/#{id}")
+      Entity.new(client.get)
+    end
+
+    def create_entity(params)
+      client = Client.new(Entity.new.collection_path)
+      Entity.new(client.post(params))
+    end
+  end
+
+  load_config_from_dotfile
+end

data/lib/prefabc/abstract_resource.rb

@@ -0,0 +1,75 @@
+module PrefabC
+  class AbstractResource
+    KEYS_TO_PARSE_AS_DATETIME = Set.new(%i[date])
+    IMMUTABLE_PARAMETERS = Set.new(%i[account amount book currency date entity])
+
+    def self.collection_name
+      "#{resource_name}s"
+    end
+
+    def self.resource_name
+      name.split('::').last.downcase
+    end
+
+    def self.hierarchy
+      [Entity, Book, Account, Transaction]
+    end
+
+    def self.subresource
+      raise 'This should be implemented in the subclass.'
+    end
+
+    def self.rubify_raw_params(raw_params)
+      tags = raw_params[:tags]
+      params = raw_params.to_snake_keys
+      params[:tags] = tags if tags
+      params
+    end
+
+    def initialize(raw_params = {})
+      @dirty_params = {}
+      raise 'Argument is expected to be a Hash.' unless raw_params.is_a?(Hash)
+      @params = AbstractResource.rubify_raw_params(raw_params)
+
+      @params.each do |key, value|
+        unless methods.include?(key.to_sym)
+          self.class.class_eval { attr_reader key.to_sym }
+          self.class.send(:define_method, "#{key}=") do |args|
+            resetting_immutable = IMMUTABLE_PARAMETERS.include?(key) &&
+                                  instance_variable_get("@#{key}")
+            raise "`#{key}` is an immutable property." if resetting_immutable
+            @dirty_params[key] = args
+            instance_variable_set("@#{key}", args)
+          end
+        end
+        if KEYS_TO_PARSE_AS_DATETIME.include?(key)
+          instance_variable_set("@#{key}", Time.parse(value))
+        else
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+
+    def subresource_collection_path
+      "#{resource_path}/#{self.class.subresource.collection_name}"
+    end
+
+    def resource_path
+      "#{collection_path}/#{id}"
+    end
+
+    def collection_path
+      "#{parent_path}/#{self.class.collection_name}"
+    end
+
+    def parent_path
+      @parent_path ||= begin
+        hierarchy = self.class.hierarchy
+        parents = hierarchy[0...hierarchy.index(self.class)]
+        parents.inject('') do |partial, klass|
+          "#{partial}/#{klass.collection_name}/#{send(klass.resource_name)}"
+        end
+      end
+    end
+  end
+end

data/lib/prefabc/account.rb

@@ -0,0 +1,12 @@
+module PrefabC
+  class Account < AbstractResource
+    def self.subresource
+      Transaction
+    end
+
+    include ListsSubresources
+    include ReadsSubresources
+    include CreatesSubresources
+    include Updates
+  end
+end

data/lib/prefabc/book.rb

@@ -0,0 +1,17 @@
+module PrefabC
+  class Book < AbstractResource
+    def self.subresource
+      Account
+    end
+
+    include ListsSubresources
+    include ReadsSubresources
+    include CreatesSubresources
+    include Updates
+
+    def post_transaction_set(transaction_set)
+      client = Client.new("/entities/#{entity}/books/#{id}/transactions")
+      client.post(transaction_set)
+    end
+  end
+end

data/lib/prefabc/client.rb

@@ -0,0 +1,23 @@
+module PrefabC
+  class Client
+    def initialize(path)
+      url = "#{PrefabC.scheme_and_authority}#{path}"
+      @resource = RestClient::Resource.new(url, '', PrefabC.api_key)
+    end
+
+    def get
+      response = @resource.get
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    def patch(params = {})
+      response = @resource.patch(params)
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    def post(params = {})
+      response = @resource.post(params)
+      JSON.parse(response.body, symbolize_names: true)
+    end
+  end
+end

data/lib/prefabc/entity.rb

@@ -0,0 +1,16 @@
+module PrefabC
+  class Entity < AbstractResource
+    def self.subresource
+      Book
+    end
+
+    include ListsSubresources
+    include ReadsSubresources
+    include CreatesSubresources
+    include Updates
+
+    def self.collection_name
+      'entities'
+    end
+  end
+end

data/lib/prefabc/mixins/creates_subresources.rb

@@ -0,0 +1,12 @@
+module PrefabC
+  module CreatesSubresources
+    def self.included(base)
+      base.send(
+        :define_method, "create_#{base.subresource.resource_name}"
+      ) do |params|
+        client = Client.new(subresource_collection_path)
+        base.subresource.new(client.post(params))
+      end
+    end
+  end
+end

data/lib/prefabc/mixins/lists_subresources.rb

@@ -0,0 +1,10 @@
+module PrefabC
+  module ListsSubresources
+    def self.included(base)
+      base.send(:define_method, base.subresource.collection_name) do
+        client = Client.new(subresource_collection_path)
+        client.get.map { |raw_params| base.subresource.new(raw_params) }
+      end
+    end
+  end
+end

data/lib/prefabc/mixins/reads_subresources.rb

@@ -0,0 +1,10 @@
+module PrefabC
+  module ReadsSubresources
+    def self.included(base)
+      base.send(:define_method, base.subresource.resource_name) do |id|
+        client = Client.new("#{subresource_collection_path}/#{id}")
+        base.subresource.new(client.get)
+      end
+    end
+  end
+end

data/lib/prefabc/mixins/updates.rb

@@ -0,0 +1,10 @@
+module PrefabC
+  module Updates
+    def update!
+      client = Client.new(resource_path)
+      patch_params = @dirty_params
+      @dirty_params = {}
+      client.patch(patch_params)
+    end
+  end
+end

data/lib/prefabc/transaction.rb

@@ -0,0 +1,5 @@
+module PrefabC
+  class Transaction < AbstractResource
+    include Updates
+  end
+end

data/lib/prefabc/version.rb

@@ -0,0 +1,5 @@
+module PrefabC
+  VERSION = File.read(File.join(File.dirname(__FILE__), '../../VERSION'))
+                .split("\n")
+                .first
+end

data/prefabc.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |gem|
+  gem.name = 'prefabc'
+  gem.version = File.read(File.expand_path('../VERSION', __FILE__))
+  gem.author = 'Prefab C'
+  gem.summary = 'Ruby bindings for Prefab C.'
+  gem.files = `git ls-files`.split("\n")
+
+  gem.add_dependency 'iniparse'
+  gem.add_dependency 'plissken'
+  gem.add_dependency 'rest-client'
+end

data/test/integration/book_test.rb

@@ -0,0 +1,40 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+describe 'Book' do
+  before do
+    PrefabC.scheme_and_authority = 'https://api.prefabc.com'
+    PrefabC.api_key = 'api_key'
+  end
+
+  it 'can post a transaction set' do
+    transaction_set = {
+      date: Time.now,
+      transactions: [
+        { account: 'bank_account', amount: 150 },
+        { account: 'profit_and_loss', amount: -150 },
+      ],
+    }
+    book = Book.new(currency: :USD, entity: 'entity_id', id: 'book_id')
+    api_response_body = {
+      id: 'book_id',
+      entity: 'entity_id',
+      currency: :USD,
+    }.to_json
+    api_response = instance_double(
+      RestClient::Response, body: api_response_body
+    )
+    client = instance_double(RestClient::Resource, post: api_response)
+    expect(RestClient::Resource).to receive(:new)
+      .with(
+        "https://api.prefabc.com/entities/#{book.entity}/books/#{book.id}/" \
+        'transactions', '', 'api_key'
+      )
+      .and_return(client)
+    book.post_transaction_set(transaction_set)
+  end
+
+  it 'errors if an immutable parameter update attempt occurs' do
+    book = Book.new(id: 'entity_id', currency: :CAD)
+    expect { book.currency = :USD }.to raise_error(StandardError)
+  end
+end

data/test/integration/entity_test.rb

@@ -0,0 +1,141 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+describe 'Entity' do
+  before do
+    PrefabC.scheme_and_authority = 'https://api.prefabc.com'
+    PrefabC.api_key = 'api_key'
+  end
+
+  it 'can request and parse a listing of all entities' do
+    successful_api_response_body = [{
+      id: 'id',
+      group: 'group',
+      name: 'name',
+      default: true,
+    }].to_json
+    successful_api_response = instance_double(
+      RestClient::Response, body: successful_api_response_body
+    )
+    client = instance_double(RestClient::Resource, get: successful_api_response)
+    expect(RestClient::Resource).to receive(:new)
+      .with('https://api.prefabc.com/entities', '', 'api_key')
+      .and_return(client)
+    entity_list = PrefabC.entities
+    expect(entity_list.first.id).to eq('id')
+  end
+
+  it 'can request and parse a specific entity' do
+    successful_api_response_body = {
+      id: 'id',
+      group: 'group',
+      name: 'name',
+      default: true,
+    }.to_json
+    successful_api_response = instance_double(
+      RestClient::Response, body: successful_api_response_body
+    )
+    client = instance_double(RestClient::Resource, get: successful_api_response)
+    expect(RestClient::Resource).to receive(:new)
+      .with('https://api.prefabc.com/entities/id', '', 'api_key')
+      .and_return(client)
+    entity = PrefabC.entity('id')
+    expect(entity.name).to eq('name')
+  end
+
+  it 'can create an entity' do
+    successful_api_response_body = {
+      id: 'id',
+      group: 'group',
+      name: 'name',
+      default: true,
+    }.to_json
+    successful_api_response = instance_double(
+      RestClient::Response, body: successful_api_response_body
+    )
+    expect_any_instance_of(RestClient::Resource).to receive(:post)
+      .with({})
+      .and_return(successful_api_response)
+    entity = PrefabC.create_entity({})
+    expect(entity.id).to eq('id')
+  end
+
+  it 'can list books' do
+    entity = Entity.new(id: 'entity_id')
+    successful_api_response_body = [{
+      id: 'book_id',
+      currency: :USD,
+      entity: entity.id,
+      default: true,
+    }].to_json
+    successful_api_response = instance_double(
+      RestClient::Response, body: successful_api_response_body
+    )
+    client = instance_double(RestClient::Resource, get: successful_api_response)
+    expect(RestClient::Resource).to receive(:new)
+      .with('https://api.prefabc.com/entities/entity_id/books', '', 'api_key')
+      .and_return(client)
+    books = entity.books
+    expect(books.first.id).to eq('book_id')
+  end
+
+  it 'can get a specific book' do
+    book_id = 'book_id'
+    entity = Entity.new(id: 'entity_id')
+    successful_api_response_body = {
+      id: book_id,
+      currency: :USD,
+      entity: entity.id,
+      default: true,
+    }.to_json
+    successful_api_response = instance_double(
+      RestClient::Response, body: successful_api_response_body
+    )
+    client = instance_double(RestClient::Resource, get: successful_api_response)
+    expect(RestClient::Resource).to receive(:new)
+      .with(
+        "https://api.prefabc.com/entities/entity_id/books/#{book_id}",
+        '', 'api_key'
+      )
+      .and_return(client)
+    book = entity.book(book_id)
+    expect(book.id).to eq(book_id)
+  end
+
+  it 'can create a book' do
+    book_id = 'book_id'
+    entity = Entity.new(id: 'entity_id')
+    successful_api_response_body = {
+      id: book_id,
+      currency: :USD,
+      entity: entity.id,
+      default: true,
+    }.to_json
+    successful_api_response = instance_double(
+      RestClient::Response, body: successful_api_response_body
+    )
+    expect_any_instance_of(RestClient::Resource).to receive(:post)
+      .with(currency: :USD, entity: entity.id)
+      .and_return(successful_api_response)
+    book = entity.create_book(currency: :USD, entity: entity.id)
+    expect(book.id).to eq(book_id)
+    expect(book.collection_path).to eq("/entities/#{entity.id}/books")
+  end
+
+  it 'can be updated' do
+    entity = Entity.new(id: 'entity_id', name: 'original_name')
+    entity.name = 'updated_name'
+    successful_api_response_body = {
+      id: 'entity_id',
+      group: 'group_id',
+      default: true,
+      name: 'updated_name',
+    }.to_json
+    successful_api_response = instance_double(
+      RestClient::Response, body: successful_api_response_body
+    )
+    expect_any_instance_of(RestClient::Resource).to receive(:patch)
+      .with(name: 'updated_name')
+      .and_return(successful_api_response)
+    entity.update!
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'simplecov'
+
+# Test coverage check.
+SimpleCov.minimum_coverage 90
+SimpleCov.start
+
+require File.join(File.dirname(__FILE__), '../lib/prefabc')
+
+include PrefabC

data/test/unit/abstract_resource_test.rb

@@ -0,0 +1,27 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+describe 'AbstractResource' do
+  before do
+    class DummyResource < AbstractResource
+    end
+  end
+
+  it 'parses a returned JSON object as expected' do
+    datetime = Time.new(2017, 5, 4)
+    balance_sheet_rollup_tag = :'balance-sheet-rollup'
+    hash_to_parse = {
+      className: 'dummy',
+      account: 'profit_and_loss',
+      amount: 314,
+      currency: 'USD',
+      date: datetime.to_s,
+      tags: { balance_sheet_rollup_tag => 'assets' },
+    }
+    dummy = DummyResource.new(hash_to_parse)
+    expect(dummy.class_name).to eq('dummy')
+    expect(dummy.account).to eq('profit_and_loss')
+    expect(dummy.amount).to eq(314)
+    expect(dummy.date).to eq(datetime)
+    expect(dummy.tags[balance_sheet_rollup_tag]).to eq('assets')
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: prefabc
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Prefab C
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: iniparse
+  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: plissken
+  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: rest-client
+  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'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- Rakefile
+- VERSION
+- bin/console.rb
+- circle.yml
+- lib/prefabc.rb
+- lib/prefabc/abstract_resource.rb
+- lib/prefabc/account.rb
+- lib/prefabc/book.rb
+- lib/prefabc/client.rb
+- lib/prefabc/entity.rb
+- lib/prefabc/mixins/creates_subresources.rb
+- lib/prefabc/mixins/lists_subresources.rb
+- lib/prefabc/mixins/reads_subresources.rb
+- lib/prefabc/mixins/updates.rb
+- lib/prefabc/transaction.rb
+- lib/prefabc/version.rb
+- prefabc.gemspec
+- test/integration/book_test.rb
+- test/integration/entity_test.rb
+- test/test_helper.rb
+- test/unit/abstract_resource_test.rb
+homepage: 
+licenses: []
+metadata: {}
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for Prefab C.
+test_files: []