myfinance 0.1.0

data/lib/myfinance/configuration.rb

@@ -0,0 +1,12 @@
+require 'base64'
+
+module Myfinance
+  class Configuration
+    attr_accessor :url, :user_agent
+
+    def initialize
+      @url = 'https://app.myfinance.com.br'
+      @user_agent = "Myfinance Ruby Client v#{Myfinance::VERSION}"
+    end
+  end
+end

data/lib/myfinance/entities/base.rb

@@ -0,0 +1,9 @@
+require "virtus"
+
+module Myfinance
+  module Entities
+    class Base
+      include Virtus.model
+    end
+  end
+end

data/lib/myfinance/entities/collection.rb

@@ -0,0 +1,57 @@
+module Myfinance
+  module Entities
+    #
+    # A wrapper to Myfinance collection returns from API. This wrapper represents a collection and it's responsible for processing pagination information as well.
+    #
+    class Collection < Base
+      PAGE_REGEX = /page=(\d+)/
+
+      attr_reader :response, :collection, :headers
+
+      def initialize(response)
+        @response = response
+        @collection = []
+        @headers = response.headers['Link'].split(',') rescue []
+       end
+
+      def self.build(response)
+        self.new(response).build
+      end
+
+      def build
+        build_collection
+        self
+      end
+
+      def next_page
+        page_for(:next)
+      end
+
+      def last_page
+        page_for(:last)
+      end
+
+      def previous_page
+        page_for(:prev)
+      end
+
+      def first_page
+        page_for(:first)
+      end
+
+      private
+
+      def page_for(page_rel)
+        header_link_for(page_rel).match(PAGE_REGEX)[1].to_i rescue nil
+      end
+
+      def header_link_for(rel)
+        headers.select{|n| n =~ /rel=#{rel}/}.first
+      end
+
+      def build_collection
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/myfinance/entities/entity.rb

@@ -0,0 +1,16 @@
+module Myfinance
+  module Entities
+    class Entity < Base
+      attribute :id, Integer
+      attribute :name, String
+      attribute :account_id, Integer
+      attribute :charging_uuid, String
+      attribute :created_at, DateTime
+      attribute :default_in_menu, Boolean
+      attribute :deleted_at, DateTime
+      attribute :federation_subscription_number, String
+      attribute :imported_from_sync_at, DateTime
+      attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/myfinance/entities/entity_collection.rb

@@ -0,0 +1,14 @@
+module Myfinance
+  module Entities
+    #
+    # A wrapper to Myfinance entities collection
+    #
+    class EntityCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(Myfinance::Entities::Entity.new(attributes['entity']))
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/entities/financial_account.rb

@@ -0,0 +1,30 @@
+module Myfinance
+  module Entities
+    class FinancialAccount < Base
+      [:id, :entity_id, :status, :category_id, :person_id, :recurrence_id, :number_of_parcels,
+        :current_parcel, :classification_center_id, :expected_deposit_account_id].each do |k|
+        attribute k, Integer
+      end
+
+      [:status_name, :description, :document, :observation, :recurrence_period,
+        :competency_month].each { |k| attribute k, String }
+
+      [:amount, :interest_amount, :discount_amount, :total_amount, :ticket_amount].each do |k|
+        attribute k, Float
+      end
+
+      [:remind, :income_tax_relevant, :recurrent, :parcelled, :ticket_amount].each do |k|
+        attribute k, Boolean
+      end
+
+      [:due_date, :occurred_at, :document_emission_date, :reminded_at].each do |k|
+        attribute k, Date
+      end
+      [:created_at, :updated_at].each { |k| attribute k, DateTime }
+
+      attribute :financial_account_taxes_attributes, Array[Hash]
+      attribute :reconciliations, Hash[String => Array]
+      attribute :links, Array[Hash[String => String]]
+    end
+  end
+end

data/lib/myfinance/entities/payable_account.rb

@@ -0,0 +1,6 @@
+module Myfinance
+  module Entities
+    class PayableAccount < FinancialAccount
+    end
+  end
+end

data/lib/myfinance/entities/receivable_account.rb

@@ -0,0 +1,6 @@
+module Myfinance
+  module Entities
+    class ReceivableAccount < FinancialAccount
+    end
+  end
+end

data/lib/myfinance/exception.rb

@@ -0,0 +1,11 @@
+module Myfinance
+  class Exception < StandardError
+    attr_accessor :code, :body
+
+    def initialize(args = {})
+      super(args[:message])
+      @code     = args[:code]
+      @body     = args[:body]
+    end
+  end
+end

data/lib/myfinance/http.rb

@@ -0,0 +1,33 @@
+require "myfinance/request"
+require "myfinance/response"
+
+module Myfinance
+  class Http
+    attr_reader :token
+
+    def initialize(token)
+      @token = token
+    end
+
+    %w[get post delete put].each do |m|
+      define_method(m) do |path, options = {}, &block|
+        send_request(m.to_sym, path, options, &block)
+      end
+    end
+
+    private
+
+    def send_request(method, path, options, &block)
+      request  = Request.new(options.merge!({
+        method: method,
+        token: token,
+        url: "#{Myfinance.configuration.url}#{path}",
+        user_agent: Myfinance.configuration.user_agent
+      }))
+
+      response = Response.new(request.run)
+
+      response.resolve!(&block)
+    end
+  end
+end

data/lib/myfinance/request.rb

@@ -0,0 +1,53 @@
+module Myfinance
+  class Request
+
+    def initialize(args)
+      @args = args
+    end
+
+    def run
+      request.run
+      request.response
+    end
+
+    private
+
+    attr_reader :args
+
+    def request
+      @request ||= Typhoeus::Request.new(args[:url], options)
+    end
+
+    def options
+      {
+        method:           args[:method],
+        params:           args[:params],
+        body:             body,
+        headers:          headers,
+        accept_encoding:  "gzip"
+      }.reject {|k,v| v.nil?}
+    end
+
+    def headers
+      headers = args.fetch(:headers) { {} }
+
+      {
+        "Accept"         => "application/json",
+        "Content-Type"   => "application/json",
+        "User-Agent"     => args[:user_agent],
+        "Authorization" => "Basic #{authorization_hash}"
+      }.merge(headers)
+    end
+
+    def body
+      body = args[:body]
+      body = MultiJson.dump(body) if body.is_a?(Hash)
+      body
+    end
+
+    def authorization_hash
+      ::Base64.strict_encode64("#{args[:token]}:X")
+    end
+
+  end
+end

data/lib/myfinance/resources/base.rb

@@ -0,0 +1,28 @@
+module Myfinance
+  module Resources
+    class Base
+
+      attr_accessor :http
+
+      def initialize(http)
+        @http = http
+      end
+
+      private
+
+      def respond_with_collection(response)
+        collection_klass = Myfinance::Entities.const_get("#{entity_klass_name}Collection")
+        collection_klass.build(response)
+      end
+
+      def respond_with_object(response, key)
+        entity_klass = Myfinance::Entities.const_get(entity_klass_name)
+        entity_klass.new(response.parsed_body(key))
+      end
+
+      def entity_klass_name
+        self.class.to_s.gsub('Resources', 'Entities')
+      end
+    end
+  end
+end

data/lib/myfinance/resources/entity.rb

@@ -0,0 +1,39 @@
+module Myfinance
+  module Resources
+    #
+    # A wrapper to Myfinance entities API
+    #
+    # [API]
+    #   Documentation: https://app.myfinance.com.br/docs/api/entities
+    #
+    class Entity < Base
+      #
+      # List all entities of the user
+      #
+      # [API]
+      #   Method: <tt>GET /entities</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/entities#get_index
+      #
+      def find_all
+        http.get('/entities', body: {}) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      #
+      # Find a specific entity
+      #
+      # [API]
+      #   Method: <tt>GET /entities/:id</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/entities#get_show
+      #
+      def find(entity_id)
+        http.get("/entities/#{entity_id}", body: {}) do |response|
+          respond_with_object(response, 'entity')
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/resources/financial_account.rb

@@ -0,0 +1,70 @@
+module Myfinance
+  module Resources
+    class FinancialAccount < Base
+
+      def initialize(http)
+        @http = http
+        set_method_for(pay_or_receive_method)
+        set_method_for(undo_payment_or_receivement)
+      end
+      #
+      # Creates a payable/receivable account
+      #
+      # [API]
+      #   Method: <tt>POST /entities/:entity_id/payable_accounts</tt>
+      #   Method: <tt>POST /entities/:entity_id/receivable_accounts</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/payable_accounts#post_create
+      #   Documentation: https://app.myfinance.com.br/docs/api/receivable_accounts#post_create
+      #
+      def create(entity_id, params = {})
+        request_and_build_response(:post, endpoint_for(nil, entity_id, :create), params)
+      end
+
+      #
+      # Destroys a payable/receivable account
+      #
+      # [API]
+      #   Method: <tt>DELETE /entities/:entity_id/payable_accounts/:id</tt>
+      #   Method: <tt>DELETE /entities/:entity_id/receivable_accounts/:id</tt>
+      #
+      #   Documentation: https://app.myfinance.com.br/docs/api/payable_accounts#delete_destroy
+      #   Documentation: https://app.myfinance.com.br/docs/api/receivable_accounts#delete_destroy
+      #
+      def destroy(id, entity_id)
+        http.delete(endpoint_for(id, entity_id, :destroy)) do |response|
+          true
+        end
+      end
+
+      private
+
+      def request_and_build_response(method, endpoint, params={})
+        http.send(method, endpoint, body: { resource_key => params }) do |response|
+          respond_with_object(response, resource_key)
+        end
+      end
+
+      def endpoint_for(id, entity_id, key)
+        parameterize_endoint(id, entity_id, key)
+      end
+
+      def default_endpoints
+        {
+          create: "/entities/:entity_id/#{resource_key}s",
+          destroy: "/entities/:entity_id/#{resource_key}s/:id"
+        }
+      end
+
+      def parameterize_endoint(id, entity_id, key)
+        endpoints[key.to_sym].gsub(':entity_id', entity_id.to_s).gsub(':id', id.to_s)
+      end
+
+      def set_method_for(action)
+        self.class.send(:define_method, action) do |id, entity_id, params={}|
+          request_and_build_response(:put, endpoint_for(id, entity_id, action), params)
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/resources/payable_account.rb

@@ -0,0 +1,33 @@
+module Myfinance
+  module Resources
+    #
+    # A wrapper to Myfinance payable accounts API
+    #
+    # [API]
+    #   Documentation: https://app.myfinance.com.br/docs/api/payable_accounts
+    #
+    class PayableAccount < FinancialAccount
+
+      private
+
+      def endpoints
+        default_endpoints.merge({
+          pay: '/entities/:entity_id/payable_accounts/:id/pay',
+          undo_payment: '/entities/:entity_id/payable_accounts/:id/undo_payment'
+        })
+      end
+
+      def pay_or_receive_method
+        'pay'
+      end
+
+      def undo_payment_or_receivement
+        'undo_payment'
+      end
+
+      def resource_key
+        'payable_account'
+      end
+    end
+  end
+end

data/lib/myfinance/resources/receivable_account.rb

@@ -0,0 +1,33 @@
+module Myfinance
+  module Resources
+    #
+    # A wrapper to Myfinance receivable accounts API
+    #
+    # [API]
+    #   Documentation: https://app.myfinance.com.br/docs/api/receivable_accounts
+    #
+    class ReceivableAccount < FinancialAccount
+
+      private
+
+      def endpoints
+        default_endpoints.merge({
+          receive: '/entities/:entity_id/receivable_accounts/:id/receive',
+          undo_receivement: '/entities/:entity_id/receivable_accounts/:id/undo_receivement',
+        })
+      end
+
+      def pay_or_receive_method
+        'receive'
+      end
+
+      def undo_payment_or_receivement
+        'undo_receivement'
+      end
+
+      def resource_key
+        'receivable_account'
+      end
+    end
+  end
+end