pina 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12e1b8434afd19e87694e2ddccea223d43718d22
-  data.tar.gz: 54c5df65e806713cc4ca63e05438c1b5aa4e5030
+  metadata.gz: 457ff4607c434ec35f86694fee458ec1cbf7a3a4
+  data.tar.gz: 8fcac7850e11f3b7fbfb17e0cc1ccf4c6d50717d
 SHA512:
-  metadata.gz: 5ab21f7557e14a9e6a09dfc5d85483f2394d815e73c63096998dce35c9fa31b373a5b8038ade5e3cabdf5af7bba8b8028128a3de182960303f9b63383dbbbb6f
-  data.tar.gz: 3be306b670e6f25b815a0ac82d4d717ddb835d0494635f9903d9469c86b89f3904b24b00682916ad23c96a8ab08b84dc210ebd9ae89dfb97d3c15a7c35550117
+  metadata.gz: aa983a4ade13e4ae7292f204652aba67c6e414b517d6fefd30f531f323bedf2f8c0776604fb8fb9aa1e6b868e8c4c805544fe1a886a626ed1c5e0b087b8777cb
+  data.tar.gz: c241904cec297a365e0652714069f6975eb88d44d3ee34cf8aed6d8661aee928d7a6cc274bc784fd41a3356fd6a31d4c9b7f62bd83507a57b01f152c17afd160

data/.gitignore

@@ -26,6 +26,9 @@ build/
 /vendor/bundle
 /lib/bundler/man/
 
+## Docker sync
+.docker-sync/
+
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock

data/.rubocop.yml

@@ -4,3 +4,5 @@ Documentation:
 Metrics/ClassLength:
   Max: 130
 
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
   - 2.3.1
-  - 2.2.3
 env:
   - secure: TENANT=test
 before_install: gem install bundler -v 1.10.6

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM uolcz/ruby:latest
+
+ENV APPDIR /app
+RUN mkdir $APPDIR
+WORKDIR $APPDIR
+
+ENV BUNDLE_JOBS=2 \
+    BUNDLE_PATH=/gems \
+    # do GEM_PATHS se musí přidat cesta z gem_storu
+    GEM_PATH=$GEM_PATH:/gems \
+    PATH=$PATH:/gems/bin
+
+ADD . .

data/README.md

@@ -25,15 +25,50 @@ Or install it yourself as:
 
     $ gem install pina
 
+## Docker dev setup
+To open development environment in docker:
+1) install prerequisites
+`gem install docker-sync`
+2) run
+```sh
+docker volume create --name=gem_store_235
+docker-sync start
+docker-compose run web bash
+```
+
+## Fantozzi API coverage
+| Resource                | All   | Find  | Find_by | Where | Create | Update | Delete |
+| ----------------------- | :---: | :---: | :-----: | :---: | :-----:| :----: | :----: |
+| Contacts                | o     | o     | o       | o     | o      | o      | -      |
+| MyBankAccount           | o     | o     | -       | o     | o      | o      | -      |
+| PettyCashDisburstment   | o     | -     | -       | -     | -      | -      | -      |
+| ProcessedDocument       | o     | o     | -       | o     | -      | -      | o      |
+| Receivable              | o     | o     | -       | o     | -      | -      | -      |
+| SalesInvoice            | o     | o     | -       | o     | o      | o      | -      |
+| SalesOrder              | o     | o     | -       | o     | -      | -      | -      |
+| StatProcessedDocument   | o     | o     | -       | o     | -      | -      | -      |
+| UploadedDocument        | o     | o     | -       | o     | o      | o      | -      |
+| UploadedDocumentPairing | -     | -     | -       | -     | o      | -      | -      |
+
+Resources not mentioned = resources not covered.
+
 ## Usage
 
 Before you start using Pina you have to configure it.
 
 ```ruby
 Pina.configure do |config|
-  config.email = 'your_email@domain.com'
-  config.tenant = 'your tenant database name'
-  config.api_token = 'your secret token'
+  config.email      = 'your_email@domain.com'
+  config.tenant     = 'your tenant database name'
+  config.api_token  = 'your secret token'
+end
+```
+
+Optionally, you can configure Pina to run against other than production instance of Fantozzi:
+```ruby
+Pina.configure do |config|
+  config.api_host = 'localhost:3000'
+  config.use_ssl  =  true | false   # defaults to true
 end
 ```
 
@@ -156,33 +191,11 @@ orders.first_page
 Pina::SalesOrder.find(order_id)
 ```
 
-### Receivables
-
-#### All receivables
-
-```ruby
-Pina::Receivable.all
-```
-
-Gets all receivables from your database. Results are paginated and you can access
-first, next or previous page like this:
-
-```ruby
-receivables = Pina::Receivable.all
-receivables.next_page
-```
-
-```ruby
-invoices = Pina::Receivable.all
-invoices.previous_page
-
-invoices.first_page
-```
-
-#### Fetching specific receivable
+### Petty Cash Disburstments
 
+#### All petty cash disburstments
 ```ruby
-Pina::Receivable.find(invoice_id)
+Pina::PettyCashDisburstment.all
 ```
 
 ### Processed Documents
@@ -220,6 +233,35 @@ Pina::ProcessedDocument.find(gid)
 Pina::ProcessedDocument.delete(gid)
 ```
 
+### Receivables
+
+#### All receivables
+
+```ruby
+Pina::Receivable.all
+```
+
+Gets all receivables from your database. Results are paginated and you can access
+first, next or previous page like this:
+
+```ruby
+receivables = Pina::Receivable.all
+receivables.next_page
+```
+
+```ruby
+invoices = Pina::Receivable.all
+invoices.previous_page
+
+invoices.first_page
+```
+
+#### Fetching specific receivable
+
+```ruby
+Pina::Receivable.find(invoice_id)
+```
+
 ### Stat Processed Documents
 
 #### All stat processed documents
@@ -338,7 +380,13 @@ uploaded_document = Pina::UploadedDocument.find(1)
 uploaded_document.state = 'processed'
 Pina::UploadedDocument.update(1, uploaded_document)
 ```
-
+### UploadedDocumentPairing
+#### Pair uploaded document with a book-keeping document
+```ruby
+Pina::UploadedDocumentPairing.create(uploaded_document_id: 1,
+                                     document_pairable_type: 'purchase_invoice',
+                                     document_pairable_id: 201700001)
+```
 
 ## Development
 

data/docker-compose.yml

@@ -0,0 +1,19 @@
+version: "2"
+
+volumes:
+  pina-sync:
+    external: true
+  gem_store_235:
+    external: true
+
+services:
+  web:
+    build:
+      context: .
+    command: bash
+    tty: true
+    stdin_open: true
+    volumes:
+      - gem_store_235:/gems
+      - .:/app
+      - pina-sync:/app:nocopy

data/docker-sync.yml

@@ -0,0 +1,8 @@
+version: "2"
+options:
+  verbose: true
+  compose-file-path: 'docker-compose.yml'
+syncs:
+  pina-sync:
+    src: './'
+    sync_strategy: 'native_osx'

data/lib/pina.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'base64'
 require 'virtus'
@@ -6,6 +8,8 @@ require 'uri'
 
 require 'pina/utils/pagination'
 
+require 'pina/models/errors'
+require 'pina/models/error'
 require 'pina/collections/base'
 
 require 'pina/contact'
@@ -15,9 +19,11 @@ require 'pina/rest_adapter'
 require 'pina/sales_order'
 require 'pina/receivable'
 require 'pina/processed_document'
+require 'pina/petty_cash_disburstment'
 require 'pina/stat_processed_document'
 require 'pina/my_bank_account'
 require 'pina/uploaded_document'
+require 'pina/uploaded_document_pairing'
 
 module Pina
   class ConfigurationNotSet < StandardError; end
@@ -27,8 +33,7 @@ module Pina
   DEFAULT_EMAIL       = 'dummy@email.com'
   DEFAULT_TENANT      = 'imaginary'
 
-  SCHEME              = 'https://'
-  API_PATH            = '.ucetnictvi.uol.cz/api/'
+  API_HOST            = 'ucetnictvi.uol.cz'
 
   class << self
     attr_accessor :configuration
@@ -41,8 +46,9 @@ module Pina
   end
 
   class Configuration
-    attr_accessor :api_token, :email, :tenant
+    attr_accessor :api_token, :email, :api_host, :use_ssl, :tenant
     attr_reader :api_version
+    attr_writer :base_url
 
     def initialize
       set_defaults
@@ -52,15 +58,21 @@ module Pina
       @api_version = DEFAULT_API_VERSION
       @email       = DEFAULT_EMAIL
       @tenant      = DEFAULT_TENANT
+      @api_host    = API_HOST
+      @use_ssl     = true
       @base_url    = nil
     end
 
-    def base_url=(base_url)
-      @base_url = base_url
+    def schema
+      use_ssl ? 'https://' : 'http://'
+    end
+
+    def tenant_formatted
+      @tenant.blank? ? '' : @tenant + '.'
     end
 
     def base_url
-      @base_url = SCHEME + tenant + API_PATH + "#{api_version}/"
+      @base_url = schema + tenant_formatted + api_host + '/api/' + "#{api_version}/"
     end
   end
 end

data/lib/pina/collections/contact.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Pina
   module Collections
     class Contact < Base
-      attribute :items, Array[::Pina::Models::Contact]
+      attribute :items, Array[Pina::Models::Contact]
     end
   end
 end

data/lib/pina/collections/petty_cash_disburstment.rb

@@ -0,0 +1,9 @@
+module Pina
+  module Collections
+    class PettyCashDisburstment
+      include Virtus.model
+
+      attribute :items, Array[Pina::Models::PettyCashDisburstment]
+    end
+  end
+end

data/lib/pina/models/coercions/nested_value.rb

@@ -0,0 +1,9 @@
+module Pina
+  module Models
+    class NestedValue < Virtus::Attribute
+      def coerce(value)
+        value&.values&.join(', ')&.to_s
+      end
+    end
+  end
+end

data/lib/pina/models/error.rb

@@ -0,0 +1,15 @@
+module Pina
+  module Models
+    class Error
+      include Virtus.model
+
+      attribute :status_code
+      attribute :message
+      attribute :errors, Array[Models::Errors]
+        
+      def ok?
+        status_code == 200 || status_code == 201
+      end
+    end
+  end
+end

data/lib/pina/models/errors.rb

@@ -0,0 +1,11 @@
+module Pina
+  module Models
+    class Errors
+      include Virtus.model
+
+      attribute :resource
+      attribute :field
+      attribute :code
+    end
+  end
+end

data/lib/pina/models/nested_value.rb

@@ -0,0 +1,11 @@
+module Pina
+  module Models
+    module Coercions
+      class NestedValue < Virtus::Attribute
+        def coerce(value)
+          value.values.join(', ')
+        end
+      end
+    end
+  end
+end

data/lib/pina/models/petty_cash_disburstment.rb

@@ -0,0 +1,30 @@
+require 'pina/models/petty_cash_disburstment_item'
+require 'pina/models/coercions/nested_value'
+
+module Pina
+  module Models
+    class PettyCashDisburstment
+      include Virtus.model
+
+      attribute :created_at
+      attribute :updated_at
+      attribute :creator, NestedValue
+      attribute :modifier, NestedValue
+      attribute :items, Array[Pina::Models::PettyCashDisburstmentItem]
+      attribute :number
+      attribute :issue_date
+      attribute :receipt_date
+      attribute :note
+      attribute :coefficient
+      attribute :petty_cash, NestedValue
+      attribute :department, NestedValue
+      attribute :total
+      attribute :contact, NestedValue
+      attribute :contract, NestedValue
+      attribute :vat_document
+      attribute :confirmed
+      attribute :status
+      attribute :gid
+    end
+  end
+end

data/lib/pina/models/petty_cash_disburstment_item.rb

@@ -0,0 +1,22 @@
+require 'pina/models/coercions/nested_value'
+
+module Pina
+  module Models
+    class PettyCashDisburstmentItem
+      include Virtus.model
+
+      attribute :created_at
+      attribute :updated_at
+      attribute :creator, NestedValue
+      attribute :modifier, NestedValue
+      attribute :external_id
+      attribute :rule_id, NestedValue
+      attribute :variable_symbol
+      attribute :price
+      attribute :description
+      attribute :department, NestedValue
+      attribute :contract, NestedValue
+      attribute :linked_doc_number
+    end
+  end
+end

data/lib/pina/models/uploaded_document_pairing.rb

@@ -0,0 +1,9 @@
+module Pina
+  module Models
+    class UploadedDocumentPairing
+      include Virtus.model
+
+      attribute :id
+    end
+  end
+end

data/lib/pina/petty_cash_disburstment.rb

@@ -0,0 +1,32 @@
+require 'pina/models/petty_cash_disburstment'
+require 'pina/collections/petty_cash_disburstment'
+
+module Pina
+  class PettyCashDisburstment
+    class << self
+      def find(gid)
+        response = Pina::RestAdapter.get(:petty_cash_disburstments, gid)
+
+        return Pina::Models::PettyCashDisburstment.new(attributes(response)) if
+          response.ok?
+
+        response
+      end
+
+      def all
+        response = Pina::RestAdapter.get(:petty_cash_disburstments)
+
+        return Pina::Collections::PettyCashDisburstment.new(attributes(response)) if
+          response.ok?
+
+        response
+      end
+
+      private
+
+      def attributes(response)
+        response.to_hash.merge(response: response)
+      end
+    end
+  end
+end

data/lib/pina/rest_adapter.rb

@@ -1,18 +1,23 @@
+require 'net/http/post/multipart'
+
 module Pina
   class RestAdapter
     include ActiveSupport::JSON
 
+    REQUEST_TIMEOUT     = 408
+    SERVICE_UNAVAILABLE = 503
+
     class << self
       def get(resource, id_or_params = nil)
         net_http_for(:get, resource, id_or_params)
       end
 
-      def post(resource, payload)
-        net_http_for(:post, resource, nil, payload)
+      def post(resource, payload, multipart: false)
+        net_http_for(:post, resource, nil, payload, multipart: multipart)
       end
 
       def patch(resource, id, payload)
-        net_http_for(:patch, resource, id, payload)
+        net_http_for(:patch, resource, id, payload, multipart: false)
       end
 
       def delete(resource, id = nil)
@@ -21,19 +26,24 @@ module Pina
 
       private
 
-      def net_http_for(method, resource, id, payload = nil)
-        fail ConfigurationNotSet unless Pina.configuration
+      def net_http_for(method, resource, id, payload = nil, multipart: false)
+        raise ConfigurationNotSet unless Pina.configuration
 
         uri = URI(url(resource, id))
-
-        request = net_http_class_for(method).new(uri)
-        headers.each do |k, v|
-          request[k] = v
-        end
-        request.body = payload.to_json if payload
-
-        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-          http.request(request)
+        request = multipart ? multipart_request(uri, payload) : request(uri, method, payload)
+
+        begin
+          response = Net::HTTP.start(uri.hostname,
+                                     uri.port,
+                                     use_ssl: Pina.configuration.use_ssl) do |http|
+            http.request(request)
+          end
+        rescue SocketError
+          return Pina::Models::Error.new(status_code: SERVICE_UNAVAILABLE,
+                                         message: "služba nedostupná - #{Pina.configuration.api_host}")
+        rescue Net::ReadTimeout
+          return Pina::Models::Error.new(status_code: REQUEST_TIMEOUT,
+                                         message: "služba neodpovídá - #{Pina.configuration.api_host}")
         end
 
         Response.new(response.code.to_i, response.body)
@@ -43,16 +53,49 @@ module Pina
         Kernel.const_get("Net::HTTP::#{method.capitalize}")
       end
 
-      def headers
+      def auth_header
         {
           'Authorization' => 'Basic ' + Base64
-          .strict_encode64("#{Pina.configuration.email}:#{Pina.configuration.api_token}"),
-          'Accept-Encoding' => 'application/json',
-          'Content-Type' =>  'application/json'
+                                        .strict_encode64("#{Pina.configuration.email}:#{Pina.configuration.api_token}")
         }
       end
 
+      def headers
+        auth_header.merge('Accept-Encoding' => 'application/json',
+                          'Content-Type'    => 'application/json')
+      end
+
+      def request(uri, method, payload)
+        request = net_http_class_for(method).new(uri)
+        headers.each do |k, v|
+          request[k] = v
+        end
+        request.body = payload.to_json if payload
+        request
+      end
+
+      def multipart_request(uri, payload)
+        request = Net::HTTP::Post::Multipart.new uri, multipart_payload(payload)
+        auth_header.each do |k, v|
+          request[k] = v
+        end
+        request
+      end
+
+      def multipart_payload(payload)
+        return payload unless payload.is_a? Hash
+
+        payload.map do |key, val|
+          next unless val.respond_to?(:path)
+          payload[key] = UploadIO.new(val, 'application/pdf', val.path.split('/').last)
+        end
+
+        payload
+      end
+
       def url(resource, id_or_params)
+        resource = resource_with_namespace(resource)
+
         if id_or_params.is_a? Hash
           params = prepare_params_for_request(id_or_params)
           Pina.configuration.base_url + "#{resource}?#{params}"
@@ -64,6 +107,10 @@ module Pina
       def prepare_params_for_request(params)
         params.map { |key, value| "#{URI::escape(key.to_s)}=#{URI::escape(value.to_s)}" }.join('&')
       end
+
+      def resource_with_namespace(*resource)
+        resource.join('/')
+      end
     end
 
     class Response

data/lib/pina/uploaded_document.rb

@@ -4,13 +4,24 @@ require 'pina/collections/uploaded_document'
 module Pina
   class UploadedDocument
     class << self
+      def create(uploaded_document)
+        response = Pina::RestAdapter.post(:uploaded_documents, uploaded_document, multipart: true)
+
+        if response.ok?
+          Pina::Models::UploadedDocument.new(attributes(response))
+        else
+          Pina::Models::Error.new(attributes_for_error(response))
+        end
+      end
+
       def find(id)
         response = Pina::RestAdapter.get(:uploaded_documents, id)
 
-        return Pina::Models::UploadedDocument.new(attributes(response)) if
-          response.ok?
-
-        response
+        if response.ok?
+          Pina::Models::UploadedDocument.new(attributes(response))
+        else
+          Pina::Models::Error.new(attributes_for_error(response))
+        end
       end
 
       def where(hash, page = nil)
@@ -34,10 +45,11 @@ module Pina
       def update(id, uploaded_document)
         response = Pina::RestAdapter.patch(:uploaded_documents, id, uploaded_document)
 
-        return Pina::Models::UploadedDocument.new(attributes(response)) if
-          response.ok?
-
-        response
+        if response.ok?
+          Pina::Models::UploadedDocument.new(attributes(response))
+        else
+          Pina::Models::Error.new(attributes_for_error(response))
+        end
       end
 
       private
@@ -45,6 +57,10 @@ module Pina
       def attributes(response)
         response.to_hash.merge(response: response)
       end
+
+      def attributes_for_error(response)
+        response.to_hash.merge(status_code: response.status_code)
+      end
     end
   end
 end

data/lib/pina/uploaded_document_pairing.rb

@@ -0,0 +1,38 @@
+require 'pina/models/uploaded_document_pairing'
+
+module Pina
+  class UploadedDocumentPairing
+    class << self
+      def find(id)
+        response = Pina::RestAdapter.get([:uploaded_documents, id, :pairings])
+
+        return Pina::Models::UploadedDocumentPairing.new(attributes(response)) if
+          response.ok?
+
+        response
+      end
+
+      def create(params)
+        response = Pina::RestAdapter.post([:uploaded_documents, params[:uploaded_document_id], :pairings],
+                                          params.except(:uploaded_document_id))
+
+        if response.ok?
+          # TODO: implement uploaded_documents/:id/pairings response object in Fantozzi api
+          response
+        else
+          Pina::Models::Error.new(attributes_for_error(response))
+        end
+      end
+
+      private
+
+      def attributes(response)
+        response.to_hash.merge(response: response)
+      end
+
+      def attributes_for_error(response)
+        response.to_hash.merge(status_code: response.status_code)
+      end
+    end
+  end
+end

data/lib/pina/version.rb

@@ -1,3 +1,3 @@
 module Pina
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 end

data/pina.gemspec

@@ -33,4 +33,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'virtus'
   spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'multipart-post'
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pina
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Pavel Hronek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-27 00:00:00.000000000 Z
+date: 2018-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  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: Fantozzi REST API client
 email:
 - hronek@uol.cz
@@ -206,15 +220,19 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
+- docker-compose.yml
+- docker-sync.yml
 - lib/pina.rb
 - lib/pina/collections/base.rb
 - lib/pina/collections/contact.rb
 - lib/pina/collections/my_bank_account.rb
+- lib/pina/collections/petty_cash_disburstment.rb
 - lib/pina/collections/processed_document.rb
 - lib/pina/collections/receivable.rb
 - lib/pina/collections/sales_invoice.rb
@@ -223,8 +241,14 @@ files:
 - lib/pina/collections/uploaded_document.rb
 - lib/pina/contact.rb
 - lib/pina/models/address.rb
+- lib/pina/models/coercions/nested_value.rb
 - lib/pina/models/contact.rb
+- lib/pina/models/error.rb
+- lib/pina/models/errors.rb
 - lib/pina/models/my_bank_account.rb
+- lib/pina/models/nested_value.rb
+- lib/pina/models/petty_cash_disburstment.rb
+- lib/pina/models/petty_cash_disburstment_item.rb
 - lib/pina/models/processed_document.rb
 - lib/pina/models/receivable.rb
 - lib/pina/models/sales_invoice.rb
@@ -232,7 +256,9 @@ files:
 - lib/pina/models/sales_order.rb
 - lib/pina/models/stat_processed_document.rb
 - lib/pina/models/uploaded_document.rb
+- lib/pina/models/uploaded_document_pairing.rb
 - lib/pina/my_bank_account.rb
+- lib/pina/petty_cash_disburstment.rb
 - lib/pina/processed_document.rb
 - lib/pina/receivable.rb
 - lib/pina/rest_adapter.rb
@@ -240,6 +266,7 @@ files:
 - lib/pina/sales_order.rb
 - lib/pina/stat_processed_document.rb
 - lib/pina/uploaded_document.rb
+- lib/pina/uploaded_document_pairing.rb
 - lib/pina/utils/pagination.rb
 - lib/pina/version.rb
 - pina.gemspec
@@ -263,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Fantozzi REST API client