comptaline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e200a81d1459c390b6255aeb4464f37d0dc0f2b
+  data.tar.gz: 109fe810b268b9a4c5cb26223b21965653bcb5bd
+SHA512:
+  metadata.gz: 0d6602d037f9c87ac94deb793ac756c242b510d050892d1d08bf5d1221530d30c1516e7e624edde8c0115a588e4f6dfbf9e278d4b361563c3a2eb3a38bf2ba24
+  data.tar.gz: bfe85aeb1ba473a7404efaf9c43ee39e0c85d0ffe86880ec7f16950b5549c79c49fa472cb85326d38004343d17a81f4cc4a5fba5967b449e16bb76495f4f9b84

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Loïc Vigneron
+
+MIT License
+
+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,59 @@
+# Comptaline
+
+A Comptaline ( http://comptaline.be )
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'comptaline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install comptaline
+
+## Usage
+
+Add this in an initializer: 
+
+```ruby
+Comptaline.configure do | configuration |
+  configuration.host_url            = "https://www.comptamanager.be/app/"
+  configuration.username            = "<user>"
+  configuration.password            = "<password>"
+  configuration.invoice_journal     = "<INVJOURNAL>"
+  configuration.credit_note_journal = "<NCJOURNAL>"
+end
+```
+
+Then create accounting entries and append them to the exporter instance:
+
+```ruby
+exporter = Comptaline::Exporter.new
+
+customer               = Comptaline::AccountingEntry::Customer.new
+customer.first_name    = "Bob"
+customer.id            = 1
+exporter.push(customer)
+
+invoice                = Comptaline::AccountingEntry::Invoice.new
+invoice.customer_id    = customer_id
+invoice.invoice_number = 100
+exporter.push(invoice)
+
+exporter.flush!
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/spin42/comptaline/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/comptaline.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "comptaline/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "comptaline"
+  spec.version       = Comptaline::VERSION
+  spec.authors       = ["Spin42"]
+  spec.email         = ["info@spin42.com"]
+  spec.summary       = "Client gem for Comptaline API"
+  spec.description   = "Client gem for Comptaline API"
+  spec.homepage      = "https://github.com/Spin42/comptaline"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency             "rest-client", "~> 1.7"
+end

data/lib/comptaline.rb

@@ -0,0 +1,33 @@
+require "rest-client"
+require "uri"
+require "csv"
+
+require_relative "comptaline/client"
+require_relative "comptaline/exporter"
+require_relative "comptaline/utils"
+require_relative "comptaline/accounting_entry/base"
+require_relative "comptaline/accounting_entry/general_operation"
+require_relative "comptaline/accounting_entry/customer"
+require_relative "comptaline/accounting_entry/invoice"
+require_relative "comptaline/accounting_entry/clearance"
+
+module Comptaline
+  class Configuration
+    attr_accessor :host_url, :username, :password, :invoice_journal, :credit_note_journal, 
+      :invoicer_subject_to_vat, :tmp_dir
+  end
+
+  @configuration = Configuration.new
+
+  def self.configure(&block)
+    yield(@configuration)
+  end
+
+  def self.configuration
+    @configuration
+  end
+
+  def self.client
+    @client ||= Comptaline::Client.new @configuration
+  end
+end

data/lib/comptaline/accounting_entry/base.rb

@@ -0,0 +1,9 @@
+module Comptaline
+  module AccountingEntry
+    class Base
+      def format_date(date)
+        date.strftime("%d/%m/%y")
+      end
+    end
+  end
+end

data/lib/comptaline/accounting_entry/clearance.rb

@@ -0,0 +1,32 @@
+module Comptaline
+  module AccountingEntry
+    class Clearance < GeneralOperation
+      def to_a
+        [
+          action,                                    
+          operation_type,                                      
+          @reference,                                   
+          @amount,                
+          format_date(@date),
+          @communication,                                  
+          @currency_code,                           
+          @accounting_journal,                                      
+          @match_id,                                               
+          @accounting_writing_number,                                           
+          @index                                                 
+        ]
+      end
+
+      private
+
+      def action
+        "2"
+      end
+
+      def operation_type
+        "C"
+      end 
+
+    end
+  end
+end

data/lib/comptaline/accounting_entry/customer.rb

@@ -0,0 +1,62 @@
+module Comptaline
+  module AccountingEntry
+    class Customer < Base
+      attr_accessor :id, :language_code, :first_name, :last_name, :street, :zipcode, :city, :country_code, :phone_number, :vat_number, :iban, :bic, :email,
+        :fax_number, :category, :civility, :company_name, :company_civility
+
+      def to_a
+        [
+          action,                                        
+          @id,                                     
+          client_type,                            
+          @language_code,                          
+          formatted_company_name,                 
+          @company_civility,                       
+          name,                                   
+          @civility,                               
+          @category,                               
+          @street,                                 
+          formatted_zipcode,                      
+          @city,                       
+          @country_code,                           
+          @phone_number,         
+          @fax_number,                             
+          formatted_vat_number,                             
+          @iban,                                   
+          @bic,                                    
+          @email                            
+        ]
+      end
+
+      private
+
+      def name 
+        name = @last_name
+        name = "#{name} #{@first_name}" if @first_name
+        name
+      end
+
+      def action 
+        3
+      end
+
+      def client_type
+        1
+      end
+
+      def formatted_zipcode
+        return nil if @zipcode.nil?
+        "#{@country_code}-#{@zipcode}"
+      end
+
+      def formatted_company_name
+        @company_name || name
+      end
+
+      def formatted_vat_number
+        return nil unless @vat_number
+        @vat_number.gsub(/\D/, "")
+      end
+    end
+  end
+end

data/lib/comptaline/accounting_entry/general_operation.rb

@@ -0,0 +1,24 @@
+module Comptaline
+  module AccountingEntry
+    class GeneralOperation < Base
+      attr_accessor :action, :operation_type, :reference, :amount, :date, :communication, :currency_code, 
+        :accounting_journal, :match_id, :accounting_writing_number, :index
+
+      def to_a
+        [
+          @action,                                    
+          @operation_type,                                      
+          @reference,                                   
+          @amount,                
+          format_date(@date),
+          @communication,                                  
+          @currency_code,                           
+          @accounting_journal,                                      
+          @match_id,                                               
+          @accounting_writing_number,                                           
+          @index                                                 
+        ]
+      end
+    end
+  end
+end

data/lib/comptaline/accounting_entry/invoice.rb

@@ -0,0 +1,133 @@
+module Comptaline
+  module AccountingEntry
+    class Invoice < Base
+      attr_accessor :customer, :is_credit_note, :date, :due_date, :invoice_number, :communication, :structured_communication, :account_assignment,
+        :vat_code, :amount, :amount_with_vat, :vat_amount, :currency_code, :match_id
+
+      def initialize(type = {})
+        @is_credit_note = type[:is_credit_note] == true
+      end
+
+      def to_a
+        [
+          action,                                        
+          @customer.id,                  
+          journal,                               
+          period,        
+          invoice_number,                 
+          format_date(@date),
+          format_date(@due_date),
+          @communication,                               
+          @structured_communication,
+          account_assignment,              
+          vat_code,                           
+          @amount,                         
+          @vat_amount,                                      
+          @amount_with_vat,                       
+          @currency_code,                                
+          @match_id,                             
+          credit_note_flag                       
+        ]
+      end
+
+      def vat_code
+        return @vat_code unless @vat_code.nil?
+        vat_codes[invoice_type]
+      end
+
+      def account_assignment
+        return @account_assignment unless @account_assignment.nil?
+        account_assignments[invoice_type]
+      end
+
+      private
+
+      def action
+        1
+      end
+
+      def journal
+        if @is_credit_note
+          Comptaline.configuration.credit_note_journal
+        else
+          Comptaline.configuration.invoice_journal
+        end
+      end
+
+      def credit_note_flag
+        @is_credit_note ? 1 : 0
+      end
+
+      def period
+        @date.strftime("%m")
+      end
+
+      def invoice_type 
+        if !Comptaline.configuration.invoicer_subject_to_vat
+          :invoicer_not_subject_to_vat
+        elsif @customer.country_code == "BE"
+          :belgian_customer
+        elsif @customer.vat_number
+          :european_business_customer
+        elsif vat_codes_for_european_countries[@customer.country_code]
+          :european_individual_customer
+        else
+          :non_european_customer
+        end
+      end
+
+      def account_assignments
+        {
+          invoicer_not_subject_to_vat:  "702100",
+          belgian_customer:             "702100",
+          european_business_customer:   "700001",
+          european_individual_customer: "700003",
+          non_european_customer:        "700002"
+        }
+      end
+
+      def vat_codes
+        {
+          invoicer_not_subject_to_vat:  "211100",
+          belgian_customer:             "211400",
+          european_business_customer:   "222000",
+          european_individual_customer: vat_codes_for_european_countries[@customer.country_code],
+          non_european_customer:        "232000"
+        }
+      end
+
+      def vat_codes_for_european_countries
+        {
+          "AT" => "224100",
+          "BG" => "225500",
+          "BE" => "211400",
+          "CY" => "224600",
+          "DE" => "232002",
+          "DK" => "223100",
+          "ES" => "223300",
+          "EE" => "224500",
+          "FI" => "224300",
+          "FR" => "223405",
+          "GR" => "223200",
+          "UK" => "223500",
+          "HU" => "224900",
+          "IE" => "223600",
+          "IT" => "223700",
+          "LV" => "224700",
+          "LT" => "224800",
+          "LU" => "223800",
+          "MT" => "225000",
+          "NL" => "223902",
+          "PL" => "225100",
+          "PT" => "224000",
+          "RO" => "225400",
+          "SK" => "225300",
+          "SI" => "225200",
+          "SE" => "224200",
+          "CZ" => "224400",
+          "HR" => "225600"
+        }
+      end
+    end
+  end
+end

data/lib/comptaline/client.rb

@@ -0,0 +1,63 @@
+require "securerandom"
+
+module Comptaline
+  class Client
+    attr_accessor :host_url, :username, :password
+
+    def initialize(configuration)
+      @host_url = configuration.host_url
+      @username = configuration.username
+      @password = configuration.password
+    end
+
+    def send(csv)
+      file = make_file_for_multipart(csv)
+      begin
+        authenticated_request(:post, "OPERATIONS", { choice: "CSV" }, { fileName: file})
+      ensure
+        File.unlink(file.path)
+      end
+    end
+
+    private
+
+    def make_file_for_multipart(csv) 
+      dir  = Comptaline.configuration.tmp_dir
+      path = File.join(dir, "comptaline_#{SecureRandom.hex}.csv")
+      File.open(path, "w:ISO-8859-1") { |file| file.write(csv) }
+      File.new(path, :mode => "rb")
+    end
+
+    def authenticated_request(method, path, params = {}, payload = {})
+      open_session
+      params.merge!(sessionid: @session_id)
+      result = request(method, path, params, payload)
+      close_session
+      result
+    end
+
+    def open_session
+      result      = request(:get, "SESSION", choice: 1, username: @username, password: @password)
+      @session_id = result["sessionid"]
+    end
+
+    def close_session
+      request(:get, "SESSION", choice: 2, sessionid: @session_id)
+    end
+
+    def request(method, path, params = {}, payload = {})
+      uri       = URI.join(@host_url, path)
+      uri.query = URI.encode_www_form(params)
+
+      RestClient.__send__(method, uri.to_s, payload) do |body, request, response|
+        throw "Error while retreiving data #{body.inspect}" unless response.code == "200"
+        result = Hash.from_xml(body)["response"]
+        if result["status"] != "0"
+          throw "Something went wrong: #{path}, #{params}, #{result}"
+        else
+          result
+        end
+      end
+    end
+  end
+end

data/lib/comptaline/exporter.rb

@@ -0,0 +1,51 @@
+module Comptaline
+  class Exporter
+    def initialize
+      @entries_buffer = []
+    end
+
+    def concat(entries)
+      @entries_buffer.concat(entries)
+    end
+
+    def push(entry)
+      @entries_buffer.push(entry)
+    end
+
+    def flush!(options = {})
+      return "" unless @entries_buffer.size > 0
+
+      csv = CSV.generate(col_sep: ";", row_sep: "\n", encoding: "iso-8859-1") do |csv|
+        @entries_buffer.each do |entry|
+          csv << encode(entry.to_a)
+        end
+      end
+      Comptaline.client.send(csv) if options[:send] == true
+      csv
+    end
+
+    def add_customer(customer)
+     add_line(customer)
+    end
+
+    def add_invoice(invoice)
+      add_line(invoice)
+    end
+
+    private
+
+    def add_line(object)
+      buffer.push(object.to_a)
+    end
+
+    def encode(values)
+      values.map do |value|
+        if value.respond_to?(:encode)
+          value.encode("iso-8859-1").gsub(/["']/, " ")
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/comptaline/utils.rb

@@ -0,0 +1,7 @@
+module Comptaline
+  class Utils
+    def self.convert_to_match_id(integer)
+      integer % 1000000000
+    end
+  end
+end

data/lib/comptaline/version.rb

@@ -0,0 +1,3 @@
+module Comptaline
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: comptaline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spin42
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Client gem for Comptaline API
+email:
+- info@spin42.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENCE.txt
+- README.md
+- Rakefile
+- comptaline.gemspec
+- lib/comptaline.rb
+- lib/comptaline/accounting_entry/base.rb
+- lib/comptaline/accounting_entry/clearance.rb
+- lib/comptaline/accounting_entry/customer.rb
+- lib/comptaline/accounting_entry/general_operation.rb
+- lib/comptaline/accounting_entry/invoice.rb
+- lib/comptaline/client.rb
+- lib/comptaline/exporter.rb
+- lib/comptaline/utils.rb
+- lib/comptaline/version.rb
+homepage: https://github.com/Spin42/comptaline
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Client gem for Comptaline API
+test_files: []