subledger 0.7.7

data/lib/subledger/domain/category.rb

@@ -0,0 +1,157 @@
+module Subledger
+  module Domain
+    class CategoryError < Error; end
+
+    class Category
+
+      include Domain
+
+      include Roles::Attributable
+      include Roles::Describable
+      include Roles::Identifiable
+      include Roles::Storable
+      include Roles::Versionable
+
+      include Roles::Creatable
+      include Roles::Readable
+      include Roles::Updatable
+
+      include Roles::Collectable
+
+      include Roles::Activatable
+      include Roles::Archivable
+
+      include Roles::Restable
+
+      attr_reader   :book
+      attr_accessor :normal_balance
+
+      def self.post_keys
+        [ :description, :reference, :normal_balance ]
+      end
+
+      def self.patch_keys
+        [ :id, :description, :reference, :normal_balance, :version ]
+      end
+
+      def self.root_klass
+        Category
+      end
+
+      def self.sub_klasses
+        [ active_klass, archived_klass ]
+      end
+
+      def self.active_klass
+        ActiveCategory
+      end
+
+      def self.archived_klass
+        ArchivedCategory
+      end
+
+      def initialize args
+        describable args
+        identifiable args
+        storable args
+        versionable args
+
+        @book           = args[:book]
+        @normal_balance = args[:normal_balance]
+      end
+
+      def accounts &block
+        begin
+          store.collect_accounts_for_category self, &block
+        rescue Store::CollectError => e
+          raise CategoryError, e
+        end
+      end
+
+      class Entity < Grape::Entity
+        root 'categories', 'category'
+
+        expose :id,             :documentation => { :type => 'string',  :desc => 'category ID' }
+
+        expose :book,           :format_with   => :id,
+                                :documentation => { :type => 'string',  :desc => 'book ID' }
+
+        expose :description,    :documentation => { :type => 'string',  :desc => 'description' }
+
+        expose :reference,      :documentation => { :type => 'string',  :desc => 'reference URI' }
+
+        expose :normal_balance, :format_with   => :normal_balance,
+                                :documentation => { :type => 'string',  :desc => 'normal balance type' }
+
+        expose :version,        :documentation => { :type => 'integer', :desc => 'version' }
+      end
+
+      private
+
+      ACCEPTABLE_NORMAL_BALANCES = [ Debit, Credit ]
+
+      def self.raise_unless_creatable args
+
+        book = args[:book]
+
+        if book.nil? or not book.kind_of? Book
+          raise CategoryError, ':book is required and must be a Book'
+        elsif UUID.invalid? book.id
+          raise CategoryError, ':book must have a valid :id'
+        end
+
+        normal_balance = args[:normal_balance]
+
+        if normal_balance.nil? or not ACCEPTABLE_NORMAL_BALANCES.include? normal_balance
+          raise CategoryError, ":normal_balance is required and must be one of #{ACCEPTABLE_NORMAL_BALANCES.join(', ')}"
+        end
+      end
+    end
+
+    class ArchivedCategory < Category
+      class Entity < Category::Entity
+        root 'archived_categories', 'archived_category'
+      end
+
+      def self.sub_klasses
+        [ archived_klass ]
+      end
+    end
+
+    class ActiveCategory < Category
+      class Entity < Category::Entity
+        root 'active_categories', 'active_category'
+      end
+
+      def self.sub_klasses
+        [ active_klass ]
+      end
+
+      def attach args
+        account = args[:account]
+
+        begin
+          store.attach_account_to_category :category => self,
+                                           :account  => account
+        rescue Store::AttachError => e
+          raise CategoryError, e
+        end
+
+        account
+      end
+
+      def detach args
+        account = args[:account]
+
+        begin
+          store.detach_account_from_category :category => self,
+                                             :account  => account
+        rescue Store::DetachError => e
+          raise CategoryError, e
+        end
+
+        account
+      end
+    end
+  end
+end

data/lib/subledger/domain/control.rb

@@ -0,0 +1,180 @@
+module Subledger
+  module Domain
+    class ControlError < Error; end
+
+    class Control
+
+      include Domain
+
+      include Roles::Attributable
+      include Roles::Identifiable
+      include Roles::Storable
+      include Roles::Creatable
+      include Roles::Readable
+      include Roles::Collectable
+      include Roles::Activatable
+      include Roles::Archivable
+      include Roles::Restable
+
+      attr_reader :identity, :verbs, :path, :mode
+
+      def self.root_klass
+        Control
+      end
+
+      def self.post_keys
+        [ :id, :identity, :verbs, :path, :mode ]
+      end
+
+      def self.patch_keys
+        [  ]
+      end
+
+      def self.sub_klasses
+        [ active_klass, archived_klass ]
+      end
+
+      def self.active_klass
+        ActiveControl
+      end
+
+      def self.archived_klass
+        ArchivedControl
+      end
+
+      def initialize args
+        identifiable args
+        storable args
+
+        @identity = args[:identity]
+        @verbs    = args[:verbs]
+        @path     = args[:path]
+        @mode     = args[:mode]
+      end
+
+      # def revoke
+      #   @revoked = true
+      #
+      #   self.update
+      #
+      #   self
+      # end
+
+      # def revoked?
+      #   @revoked == true
+      # end
+
+      # def is verb, url
+      #   verb == @verbs and url == @path
+      # end
+
+      def match? verb, url
+        @verbs.split('|').include?(verb) and match_wildcard(url, @path)
+      end
+
+      class Entity < Grape::Entity
+        root 'controls', 'control'
+
+        expose :id,       :documentation => { :type => 'string', :desc => 'control ID' }
+
+        expose :identity, :format_with   => :id,
+                          :documentation => { :type => 'string', :desc => 'identity ID' }
+
+        expose :verbs,    :documentation => { :type => 'string', :desc => 'HTTP verbs' }
+
+        expose :path,     :documentation => { :type => 'string', :desc => 'HTTP path' }
+
+        expose :mode,     :documentation => { :type => 'string', :desc => 'allow or deny' }
+      end
+
+      private
+
+      def match_wildcard actual, authorized
+        actual     = strip_version actual
+        authorized = strip_version authorized
+
+        regx = authorized.gsub(/\*(.)/, '[^\1]*\1').gsub(/\*$/, '.*')
+
+        actual == authorized or ( actual =~ /^#{regx}$/ ) == 0
+      end
+
+      def strip_version path
+        path[3..-1]
+      end
+
+      ACCEPTABLE_VERBS = [ 'POST', 'GET', 'PATCH' ]
+      ACCEPTABLE_MODES = [ :allow, :deny ]
+
+      def self.raise_unless_creatable args
+
+        identity = args[:identity]
+
+        if identity.nil? or not identity.kind_of? Identity
+          raise ControlError, ':identity is required and must be an Identity'
+        elsif UUID.invalid? identity.id
+          raise ControlError, ':identity must have a valid :id'
+        end
+
+        # TODO :verb(s) should be a domain object
+
+        verbs = args[:verbs]
+
+        if verbs.nil?
+          raise ControlError, ':verbs is required'
+        end
+
+        verbs.split('|').each do |verb|
+          unless ACCEPTABLE_VERBS.include? verb
+            raise ControlError, ":verbs must contain one or more of #{ACCEPTABLE_VERBS.join(', ')} separated by |"
+          end
+        end
+
+        # TODO :path should be a domain object
+
+        path = args[:path]
+
+        if path.nil?
+          raise ControlError, ':path is required'
+        end
+
+        api_version = path[1,2]
+
+        unless api_version == API_VERSION
+          raise ControlError, ":path must begin with /#{API_VERSION}/"
+        end
+
+        path[4,].split( '/' ).each do |part|
+          unless part =~ /[*_0-9A-Za-z]+/
+            raise ControlError, 'invalid :path'
+          end
+        end
+
+        mode = args[:mode]
+
+        if mode.nil? or not ACCEPTABLE_MODES.include? mode
+          raise ControlError, ":mode must contain one or more of :allow, :deny}"
+        end
+      end
+    end
+
+    class ArchivedControl < Control
+      class Entity < Control::Entity
+        root 'archived_controls', 'archived_control'
+      end
+
+      def self.sub_klasses
+        [ archived_klass ]
+      end
+    end
+
+    class ActiveControl < Control
+      class Entity < Control::Entity
+        root 'active_controls', 'active_control'
+      end
+
+      def self.sub_klasses
+        [ active_klass ]
+      end
+    end
+  end
+end

data/lib/subledger/domain/formatters.rb

@@ -0,0 +1,31 @@
+Grape::Entity.format_with :id do |entity|
+                                entity.id unless entity.nil?
+                              end
+
+Grape::Entity.format_with :normal_balance do |value_klass|
+                                            value_klass.type unless value_klass.nil?
+                                          end
+
+Grape::Entity.format_with :time do |time|
+                                  time.iso8601(3) unless time.nil?
+                                end
+
+Grape::Entity.format_with :time_full_second do |time|
+                                              time.iso8601 unless time.nil?
+                                            end
+
+Grape::Entity.format_with :value do |value|
+                                   value.rest_hash unless value.nil?
+                                 end
+
+Grape::Entity.format_with :progress do |value|
+                                      { :percentage => value }
+                                    end
+
+Grape::Entity.format_with :integer do |value|
+                                      value.to_i unless value.nil?
+                                   end
+
+Grape::Entity.format_with :balance do |value|
+                                     value.serializable_hash unless value.nil?
+                                   end

data/lib/subledger/domain/identity.rb

@@ -0,0 +1,159 @@
+module Subledger
+  module Domain
+    class IdentityError < Error; end
+
+    class Identity
+
+      include Domain
+
+      include Roles::Attributable
+      include Roles::Describable
+      include Roles::Identifiable
+      include Roles::Storable
+      include Roles::Versionable
+
+      include Roles::Creatable
+      include Roles::Readable
+      include Roles::Updatable
+
+      include Roles::Activatable
+      include Roles::Archivable
+
+      include Roles::Restable
+
+      attr_accessor :email
+
+      def self.post_keys
+        [ :id, :email, :description, :reference ]
+      end
+
+      def self.patch_keys
+        [ :id, :email, :description, :reference, :version ]
+      end
+
+      def self.root_klass
+        Identity
+      end
+
+      def self.sub_klasses
+        [ archived_klass, active_klass ]
+      end
+
+      def self.archived_klass
+        ArchivedIdentity
+      end
+
+      def self.active_klass
+        ActiveIdentity
+      end
+
+      def self.create args
+        validate_creatability args
+
+        identity = args[:client].send active_klass.collection_name, args
+
+        args[:store].create_identity identity
+      end
+
+      def create
+        identity, key = self.class.create self.attributes
+
+        initialize identity.attributes
+
+        return self, key
+      end
+
+      def initialize args
+        describable args
+        identifiable args
+        storable args
+        versionable args
+
+        @email = args[:email]
+      end
+
+      # def by_email email
+      #   # TODO
+      # end
+
+      # def by_org org
+      #   # TODO look in OrgIdentities table
+      # end
+
+      def authorize verb, url
+        raise KeyError if @retired
+
+        controls.each do |control|
+          return true if control.match(verb, url) unless control.revoked?
+        end
+
+        false
+      end
+
+      # def grant args
+      #   args[:client].controls.create args
+      # end
+
+      # def revoke args
+      #   org_id = args[:org_id]
+      #   verb   = args[:verb]
+      #   url    = args[:url]
+      #
+      #   revoked = false
+      #
+      #   controls.each do |control|
+      #     if control.is org_id, verb, url
+      #       control.revoke
+      #       revoked = true
+      #     end
+      #   end
+      #
+      #   raise IdentityError unless revoked
+      #
+      #   self
+      # end
+
+      class Entity < Grape::Entity
+        root 'identities', 'identity'
+
+        expose :id,          :documentation => { :type => 'string',  :desc => 'identity ID' }
+
+        expose :email,       :documentation => { :type => 'string',  :desc => 'identity email' }
+
+        expose :description, :documentation => { :type => 'string',  :desc => 'description' }
+
+        expose :reference,   :documentation => { :type => 'string',  :desc => 'reference URI' }
+
+        expose :version,     :documentation => { :type => 'integer', :desc => 'version' }
+      end
+
+      private
+
+      def self.raise_unless_creatable args
+        unless ValidateEmail.mx_valid? args[:email]
+          raise IdentityError, ':email is required and must have an MX record for the domain'
+        end
+      end
+    end
+
+    class ArchivedIdentity < Identity
+      class Entity < Identity::Entity
+        root 'archived_identities', 'archived_identity'
+      end
+
+      def self.sub_klasses
+        [ archived_klass ]
+      end
+    end
+
+    class ActiveIdentity < Identity
+      class Entity < Identity::Entity
+        root 'active_identities', 'active_identity'
+      end
+
+      def self.sub_klasses
+        [ active_klass ]
+      end
+    end
+  end
+end