nova-api 0.4.0

data/lib/nova/api/base.rb

@@ -0,0 +1,126 @@
+require 'httparty'
+require 'forwardable'
+
+module Nova
+  module API
+    class Base < Nova::API::Utils::BaseStruct
+      extend Forwardable
+      include HTTParty
+
+      format :json
+
+      SCHEME = 'https'
+      HOST = 'nova.money'
+
+      def self.endpoint
+        raise EndpointNotConfiguredError, 'Each class must implement its own endpoint'
+      end
+
+      def self.base_url
+        raise Nova::API::MissingSubdomainError, 'The subdomain must be informed' if configuration.subdomain.nil? || configuration.subdomain.empty?
+
+        "#{SCHEME}://#{configuration.subdomain}.#{HOST}"
+      end
+
+      def endpoint
+        raise EndpointNotConfiguredError, 'Each class must implement its own endpoint'
+      end
+
+      protected
+
+      def allowed_attributes
+        return attributes unless self.class.const_defined?('ALLOWED_ATTRIBUTES')
+
+        data = attributes.dup
+
+        data.keys.each { |key| data.delete(key.to_sym) unless self.class.const_get('ALLOWED_ATTRIBUTES').include?(key.to_sym) }
+
+        data
+      end
+
+      def self.initialize_empty_model_with_id(klass, id, additional_attributes = {})
+        data = klass.attribute_names.map { |key| additional_attributes[key] ? [key, additional_attributes[key]] : [key, nil] }
+
+        klass.new(Hash[*data.flatten].merge(id: id))
+      end
+
+      def self.do_get_search(endpoint, query, object = self)
+        response = perform_get(endpoint, query, headers)
+
+        Nova::API::ListResponse.build(response, object)
+      end
+
+      def self.do_get(endpoint, query, object = self)
+        response = perform_get(endpoint, query, headers)
+
+        Nova::API::Response.build(response, object)
+      end
+      def_delegator self, :do_get
+
+      def do_delete(endpoint)
+        set_base_uri
+
+        response = self.class.delete(endpoint, headers: authorization_header)
+
+        Nova::API::Response.build(response)
+      end
+
+      def do_patch(endpoint, data)
+        set_base_uri
+
+        if data.nil? || data.empty?
+          response = self.class.patch(endpoint, headers: authorization_header)
+
+          Nova::API::Response.build(response)
+        else
+          payload = data.dup
+          payload.delete(:id)
+
+          response = self.class.patch(endpoint, body: payload, headers: authorization_header)
+
+          Nova::API::Response.build(response, self)
+        end
+      end
+
+      def do_post(endpoint, data)
+        set_base_uri
+
+        response = self.class.post(endpoint, body: data, headers: authorization_header)
+
+        Nova::API::Response.build(response, self)
+      end
+
+      def protect_operation_from_missing_value(attribute = :id)
+        raise Nova::API::MissingIdError, 'This operation requires an ID to be set' if send(attribute).nil?
+      end
+
+      private
+
+      def self.perform_get(endpoint, query, headers = {})
+        set_base_uri
+
+        response =
+          if query
+            self.get(endpoint, query: query, headers: headers.merge(authorization_header))
+          else
+            self.get(endpoint, headers: headers.merge(authorization_header))
+          end
+      end
+
+      def self.authorization_header
+        { 'Persistent-Token': configuration.api_key }
+      end
+      def_delegator self, :authorization_header
+
+      def self.configuration
+        Nova::API.configuration
+      end
+      def_delegator self, :configuration
+
+      def self.set_base_uri
+        base_uri base_url
+      end
+      def_delegator self, :set_base_uri
+    end
+  end
+end

data/lib/nova/api/list_response.rb

@@ -0,0 +1,42 @@
+require 'httparty'
+require 'dry-struct'
+require 'dry-types'
+
+module Nova
+  module API
+    class ListResponse < Nova::API::Utils::BaseStruct
+      attribute :records, Dry::Types['strict.array'].of(Dry::Types['nominal.any']).optional
+      attribute :errors, Dry::Types['strict.array'].of(Dry::Types['coercible.string'])
+      attribute :success, Dry::Types['strict.bool']
+
+      def self.build(response, klass)
+        success = response.success?
+
+        parsed_response = response.parsed_response
+
+        records = nil
+
+        if parsed_response.is_a?(Array)
+          records = klass.nil? ? nil : parsed_response.map { |object| klass.new(object) }
+        else
+          parsed_response = parsed_response.to_h
+
+          errors = extract_error_from_response('error', parsed_response)
+          errors ||= extract_error_from_response('errors', parsed_response)
+        end
+
+        errors ||= []
+
+        new(success: success, errors: errors, records: records)
+      end
+
+      private
+
+      def self.extract_error_from_response(field, response)
+        return unless response.has_key?(field)
+
+        response[field].is_a?(Array) ? response[field] : [response[field]]
+      end
+    end
+  end
+end

data/lib/nova/api/resource/apportionment.rb

@@ -0,0 +1,80 @@
+module Nova
+  module API
+    module Resource
+      class Apportionment < Nova::API::Base
+        ALLOWED_ATTRIBUTES = %i[name]
+
+        attribute? :id, Dry::Types['coercible.integer'].optional
+        attribute :name, Dry::Types['coercible.string']
+        attribute? :active, Dry::Types['strict.bool'].optional
+        attribute? :values, Dry::Types['strict.array'].of(Nova::API::Resource::ApportionmentValue).optional
+
+        def self.endpoint
+          '/api/apportionments'
+        end
+
+        def self.list(parameters = {})
+          do_get_search(endpoint, parameters.to_h)
+        end
+
+        def self.create(parameters)
+          model = new parameters
+
+          model.attributes.delete(:id)
+
+          model.save
+        end
+
+        def self.update(id, parameters)
+          model = new parameters.merge(id: id)
+
+          model.update
+        end
+
+        def self.destroy(id)
+          model = initialize_empty_model_with_id(self, id)
+
+          model.destroy
+        end
+
+        def self.reactivate(id)
+          model = initialize_empty_model_with_id(self, id)
+
+          model.reactivate
+        end
+
+        def endpoint
+          protect_operation_from_missing_value
+
+          "/api/apportionments/#{id}"
+        end
+
+        def save
+          if id.nil?
+            do_post(self.class.endpoint, allowed_attributes)
+          else
+            do_patch("#{endpoint}", allowed_attributes)
+          end
+        end
+
+        def update
+          protect_operation_from_missing_value
+
+          do_patch("#{endpoint}", allowed_attributes)
+        end
+
+        def destroy
+          protect_operation_from_missing_value
+
+          do_delete("#{endpoint}")
+        end
+
+        def reactivate
+          protect_operation_from_missing_value
+
+          do_patch("#{endpoint}/reactivate", {})
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/apportionment_value.rb

@@ -0,0 +1,74 @@
+module Nova
+  module API
+    module Resource
+      class ApportionmentValue < Nova::API::Base
+        ALLOWED_ATTRIBUTES = %i[name]
+
+        attribute? :id, Dry::Types['coercible.integer'].optional
+        attribute :name, Dry::Types['coercible.string']
+        attribute? :active, Dry::Types['strict.bool'].optional
+        attribute? :apportionment_id, Dry::Types['coercible.integer']
+
+        def self.endpoint(apportionment_id)
+          "/api/apportionments/#{apportionment_id}/apportionment_values"
+        end
+
+        def self.create(apportionment_id, parameters)
+          model = new parameters.merge(apportionment_id: apportionment_id)
+
+          model.attributes.delete(:id)
+
+          model.save
+        end
+
+        def self.update(apportionment_id, id, parameters)
+          model = new parameters.merge(id: id, apportionment_id: apportionment_id)
+
+          model.update
+        end
+
+        def self.destroy(apportionment_id, id)
+          model = initialize_empty_model_with_id(self, id, apportionment_id: apportionment_id)
+
+          model.destroy
+        end
+
+        def self.reactivate(apportionment_id, id)
+          model = initialize_empty_model_with_id(self, id, apportionment_id: apportionment_id)
+
+          model.reactivate
+        end
+
+        def endpoint
+          "/api/apportionments/#{apportionment_id}/apportionment_values/#{id}"
+        end
+
+        def save
+          if id.nil?
+            do_post(self.class.endpoint(apportionment_id), allowed_attributes)
+          else
+            do_patch("#{endpoint}", allowed_attributes)
+          end
+        end
+
+        def update
+          protect_operation_from_missing_value
+
+          do_patch("#{endpoint}", allowed_attributes)
+        end
+
+        def destroy
+          protect_operation_from_missing_value
+
+          do_delete("#{endpoint}")
+        end
+
+        def reactivate
+          protect_operation_from_missing_value
+
+          do_patch("#{endpoint}/reactivate", {})
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/bank.rb

@@ -0,0 +1,28 @@
+module Nova
+  module API
+    module Resource
+      class Bank < Nova::API::Resource::CurrentAsset
+        ALLOWED_ATTRIBUTES = %i[]
+
+        attribute? :agency, Dry::Types['coercible.string'].optional
+        attribute? :current_account, Dry::Types['coercible.string'].optional
+        attribute? :institution do
+          attribute :code, Dry::Types['coercible.string'].optional
+          attribute :name, Dry::Types['coercible.string'].optional
+        end
+        attribute? :usage do
+          attribute :code, Dry::Types['coercible.integer'].optional
+          attribute :name, Dry::Types['coercible.string'].optional
+        end
+
+        def self.endpoint
+          '/api/banks'
+        end
+
+        def self.list(parameters = {})
+          do_get_search(endpoint, parameters.to_h)
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/card.rb

@@ -0,0 +1,20 @@
+module Nova
+  module API
+    module Resource
+      class Card < Nova::API::Resource::CurrentAsset
+        ALLOWED_ATTRIBUTES = %i[]
+
+        attribute? :description, Dry::Types['coercible.string'].optional
+        attribute? :institution, Dry::Types['coercible.string'].optional
+
+        def self.endpoint
+          '/api/cards'
+        end
+
+        def self.list(parameters = {})
+          do_get_search(endpoint, parameters.to_h)
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/cash.rb

@@ -0,0 +1,19 @@
+module Nova
+  module API
+    module Resource
+      class Cash < Nova::API::Resource::CurrentAsset
+        ALLOWED_ATTRIBUTES = %i[]
+
+        attribute? :description, Dry::Types['coercible.string'].optional
+
+        def self.endpoint
+          '/api/cashes'
+        end
+
+        def self.list(parameters = {})
+          do_get_search(endpoint, parameters.to_h)
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/company.rb

@@ -0,0 +1,21 @@
+module Nova
+  module API
+    module Resource
+      class Company < Nova::API::Base
+        ALLOWED_ATTRIBUTES = %i[]
+
+        attribute? :id, Dry::Types['coercible.integer'].optional
+        attribute? :name, Dry::Types['coercible.string'].optional
+        attribute? :trading_name, Dry::Types['coercible.string'].optional
+
+        def self.endpoint
+          '/api/companies'
+        end
+
+        def self.list
+          do_get_search(endpoint, nil)
+        end
+      end
+    end
+  end
+end

data/lib/nova/api/resource/current_asset.rb

@@ -0,0 +1,33 @@
+module Nova
+  module API
+    module Resource
+      class CurrentAsset < Nova::API::Base
+        ALLOWED_ATTRIBUTES = %i[]
+
+        attribute? :id, Dry::Types['coercible.integer'].optional
+        attribute? :company, Nova::API::Resource::Company.optional
+        attribute? :active, Dry::Types['strict.bool'].optional
+        attribute? :image, Dry::Types['coercible.string'].optional
+        attribute? :balance, Dry::Types['coercible.decimal'].optional
+
+        def self.endpoint
+          '/api/current_assets'
+        end
+
+        def self.statement(parameters = {})
+          do_get("#{endpoint}/statement", parameters.to_h, Nova::API::Resource::Response::CurrentAssetStatement.new)
+        end
+
+        def statement(initial_date, final_date)
+          protect_operation_from_missing_value
+
+          self.class.do_get("#{endpoint}/statement", { company_id: company.id, current_asset_id: id, final_date: final_date, initial_date: initial_date }, Nova::API::Resource::Response::CurrentAssetStatement.new)
+        end
+
+        def endpoint
+          "/api/current_assets"
+        end
+      end
+    end
+  end
+end