pina 0.3.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23b08d7071b89683e9435a5a42b8f4f51cb5eccd
-  data.tar.gz: e5648493ce1f0a9505d9dc806bbdbe0d4163e4fb
+  metadata.gz: e50f2ed2015bf16a54f12d20aff18b67ad7e66d6
+  data.tar.gz: d2e5434617fb9156bcddbc1d6cb467b6c2293445
 SHA512:
-  metadata.gz: 607bb57906cee481c9cba39cc107a1c1bff8353150434c2187e1eae44a8c93db43e67d052aeb29814f8d8415f80a874e09512936024d27cdef35b7bb503c3e47
-  data.tar.gz: 0e7b22d010ec4e5bdc19db8f09c505871a31f18da886009bc6ba56564154316b6763e5de6bfeb9aa58eb25d503b4685cfb4b89021fea0252174c8989cf2e5139
+  metadata.gz: 37b7cf897b2b4d62c6071eadba1435bce7b4eae43cb10905ed88aa63b75eba7a2635e045d3d496b7a887cd1d8ebd5d87815067fe16d4df5bf9eb8a51197fab3d
+  data.tar.gz: b1a154831bf26d55da0685d3ea584fe53a21f32225b721eb872908d4d930de3f3454f2516f5d082637d61b38bd159308c29c064ea04c798c1e102dd2ca2c1255

data/.travis.yml

@@ -2,8 +2,6 @@ language: ruby
 rvm:
   - 2.3.0
   - 2.2.3
-  - 2.2
-  - 2.1
 env:
   - secure: TENANT=test
 before_install: gem install bundler -v 1.10.6

data/README.md

@@ -39,7 +39,9 @@ end
 
 Now you can start querying REST API.
 
-### All contacts
+### Contacts
+
+#### All contacts
 
 ```ruby
 Pina::Contact.all
@@ -60,27 +62,30 @@ contacts.previous_page
 contacts.first_page
 ```
 
-### Fetching specific contact
+#### Fetching specific contact
 
 ```ruby
 Pina::Contact.find('contact_name')
 ```
 
-### Create new contact
+#### Create new contact
 
 ```ruby
 contact = Pina::Models::Contact.new
 Pina::Contact.create(contact)
 ```
 
-### Update existing contact
+#### Update existing contact
 
 ```ruby
 contact = Pina::Contact.find('existing')
 contact.email = 'brand_new@email.com'
 Pina::Contact.update('existing', contact)
 ```
-### All sales invoices
+
+### Sales Invoices
+
+#### All sales invoices
 
 ```ruby
 Pina::SalesInvoice.all
@@ -101,26 +106,93 @@ invoices.previous_page
 invoices.first_page
 ```
 
-### Fetching specific sales invoice
+#### Fetching specific sales invoice
 
 ```ruby
 Pina::SalesInvoice.find(invoice_id)
 ```
 
-### Create new sales invoice
+#### Create new sales invoice
 
 ```ruby
 invoice = Pina::Models::SalesInvoice.new
 Pina::SalesInvoice.create(invoice)
 ```
 
-### Update existing sales invoice
+#### Update existing sales invoice
 
 ```ruby
 invoice = Pina::SalesInvoice.find(2016000001)
 invoice.status = :confirmed
 Pina::SalesInvoice.update(2016000001, invoice)
 ```
+
+### Sales Orders
+
+#### All sales orders
+
+```ruby
+Pina::SalesOrder.all
+```
+
+Gets all sales orders from your database. Results are paginated and you can access
+first, next or previous page like this:
+
+```ruby
+orders = Pina::SalesOrder.all
+orders.next_page
+```
+
+```ruby
+orders = Pina::SalesOrder.all
+orders.previous_page
+
+orders.first_page
+```
+
+#### Fetching specific sales order
+
+```ruby
+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
+
+```ruby
+Pina::Receivable.find(invoice_id)
+```
+
+NOTE: receivables are being calculated from your DB, they do not correspond
+with any table in your database, you can access related invoice simply:
+
+```ruby
+receivable = Pina::Receivable.find(invoice_id)
+receivable.invoice
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/console

@@ -3,6 +3,7 @@
 require 'irb'
 require 'irb/completion'
 
+require 'bundler/setup'
 require 'pina'
 require 'dotenv'
 Dotenv.load

data/lib/pina.rb

@@ -5,19 +5,16 @@ require 'typhoeus'
 require 'virtus'
 require 'uri'
 
+require 'pina/utils/pagination'
+
+require 'pina/collections/base'
+
 require 'pina/contact'
 require 'pina/sales_invoice'
 require 'pina/version'
 require 'pina/rest_adapter'
-
-require 'pina/utils/pagination'
-
-require 'pina/models/address'
-require 'pina/models/contact'
-require 'pina/models/contact_list'
-require 'pina/models/sales_item'
-require 'pina/models/sales_invoice'
-require 'pina/models/sales_invoice_list'
+require 'pina/sales_order'
+require 'pina/receivable'
 
 module Pina
   class ConfigurationNotSet < StandardError; end

data/lib/pina/collections/base.rb

@@ -0,0 +1,11 @@
+module Pina
+  module Collections
+    class Base
+      include Virtus.model
+      include Pina::Utils::Pagination
+
+      attribute :_meta
+      attribute :response
+    end
+  end
+end

data/lib/pina/collections/contact.rb

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

data/lib/pina/collections/receivable.rb

@@ -0,0 +1,7 @@
+module Pina
+  module Collections
+    class Receivable < Base
+      attribute :items, Array[::Pina::Models::Receivable]
+    end
+  end
+end

data/lib/pina/collections/sales_invoice.rb

@@ -0,0 +1,7 @@
+module Pina
+  module Collections
+    class SalesInvoice < Base
+      attribute :items, Array[::Pina::Models::SalesInvoice]
+    end
+  end
+end

data/lib/pina/collections/sales_order.rb

@@ -0,0 +1,7 @@
+module Pina
+  module Collections
+    class SalesOrder < Base
+      attribute :items, Array[::Pina::Models::SalesOrder]
+    end
+  end
+end

data/lib/pina/contact.rb

@@ -1,3 +1,7 @@
+require 'pina/models/address'
+require 'pina/models/contact'
+require 'pina/collections/contact'
+
 module Pina
   class Contact
     class << self
@@ -8,7 +12,7 @@ module Pina
       def find_by(hash)
         response = where(hash)
 
-        return response.items.first if response.is_a? Pina::Models::ContactList
+        return response.items.first if response.is_a? Pina::Collections::Contact
 
         response
       end
@@ -16,7 +20,7 @@ module Pina
       def where(hash, page = nil)
         response = Pina::RestAdapter.get(:contacts, hash)
 
-        return Pina::Models::ContactList.new(attributes(response)) if
+        return Pina::Collections::Contact.new(attributes(response)) if
           response.ok?
 
         response
@@ -33,7 +37,7 @@ module Pina
       def all(page = nil)
         response = Pina::RestAdapter.get(:contacts, page)
 
-        return Pina::Models::ContactList.new(attributes(response)) if
+        return Pina::Collections::Contact.new(attributes(response)) if
           response.ok?
 
         response

data/lib/pina/models/receivable.rb

@@ -0,0 +1,24 @@
+module Pina
+  module Models
+    class Receivable
+      include Virtus.model
+
+      attribute :invoice_id
+      attribute :invoice
+      attribute :contact_id
+      attribute :total_amount
+      attribute :total_amount_in_currency
+      attribute :paid_amount
+      attribute :paid_amount_in_currency
+      attribute :paid_amount_currency_ids
+      attribute :last_payment_time
+
+      def invoice_id=(value)
+        return unless value
+
+        self.invoice = Pina::SalesInvoice.find(value)
+        super
+      end
+    end
+  end
+end

data/lib/pina/models/sales_order.rb

@@ -0,0 +1,106 @@
+module Pina
+  module Models
+    class SalesOrder
+      include Virtus.model
+
+      attribute :created_at
+      attribute :updated_at
+      attribute :creator
+      attribute :creator_id
+      attribute :modifier
+      attribute :modifier_id
+      attribute :contact
+      attribute :contact_id
+      attribute :accounting_address
+      attribute :accounting_address_id
+      attribute :buyer_address
+      attribute :buyer_address_id
+      attribute :document_recipient_address
+      attribute :document_recipient_address_id
+      attribute :delivery_address
+      attribute :delivery_address_id
+      attribute :contact
+      attribute :currency
+      attribute :currency_id
+      attribute :date_of_receipt
+      attribute :delivery_method
+      attribute :department
+      attribute :department_id
+      attribute :percent_discount
+      attribute :external_id
+      attribute :fullfilled_on
+      attribute :group_id
+      attribute :invoicing_method
+      attribute :status
+      attribute :order
+      attribute :order_id
+      attribute :contract
+      attribute :shipper_id
+      attribute :shipping_method
+      attribute :specific_symbol
+      attribute :payment_method
+      attribute :complete_upon_execution
+      attribute :items, Array[::Pina::Models::SalesItem]
+
+      def self.to_s
+        'sales_order'
+      end
+
+      def accounting_address=(value)
+        return unless value
+
+        self.accounting_address_id = value.values[0]
+        super
+      end
+
+      def buyer_address=(value)
+        return unless value
+
+        self.buyer_address_id = value.values[0]
+        super
+      end
+
+      def delivery_address=(value)
+        return unless value
+
+        self.delivery_address_id = value.values[0]
+        super
+      end
+
+      def department=(value)
+        return unless value
+
+        self.department_id = value.values[0]
+        super
+      end
+
+      def contact=(value)
+        return unless value
+
+        self.contact_id = value.values[0]
+        super
+      end
+
+      def order=(value)
+        return unless value
+
+        self.order_id = value.values[0]
+        super
+      end
+
+      def creator=(value)
+        return unless value
+
+        self.creator_id = value.values[0]
+        super
+      end
+
+      def modifier=(value)
+        return unless value
+
+        self.modifier_id = value.values[0]
+        super
+      end
+    end
+  end
+end

data/lib/pina/receivable.rb

@@ -0,0 +1,45 @@
+require 'pina/models/receivable'
+require 'pina/collections/receivable'
+
+module Pina
+  class Receivable
+    class << self
+      def new(params = nil)
+        Pina::Models::Receivable.new(params)
+      end
+
+      def find(id)
+        response = Pina::RestAdapter.get(:receivables, id)
+
+        return Pina::Models::Receivable.new(attributes(response)) if
+          response.ok?
+
+        response
+      end
+
+      def where(hash, page = nil)
+        response = Pina::RestAdapter.get(:receivables, hash)
+
+        return Pina::Collections::Receivable.new(attributes(response)) if
+          response.ok?
+
+        response
+      end
+
+      def all(page = nil)
+        response = Pina::RestAdapter.get(:receivables, page)
+
+        return Pina::Collections::Receivable.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/sales_invoice.rb

@@ -1,3 +1,7 @@
+require 'pina/models/sales_item'
+require 'pina/models/sales_invoice'
+require 'pina/collections/sales_invoice'
+
 module Pina
   class SalesInvoice
     class << self
@@ -17,7 +21,7 @@ module Pina
       def all(page = nil)
         response = Pina::RestAdapter.get(:sales_invoices, page)
 
-        return Pina::Models::SalesInvoiceList.new(attributes(response)) if
+        return Pina::Collections::SalesInvoice.new(attributes(response)) if
           response.ok?
 
         response

data/lib/pina/sales_order.rb

@@ -0,0 +1,46 @@
+require 'pina/models/sales_item'
+require 'pina/models/sales_order'
+require 'pina/collections/sales_order'
+
+module Pina
+  class SalesOrder
+    class << self
+      def new(params = nil)
+        Pina::Models::SalesOrder.new(params)
+      end
+
+      def find(id)
+        response = Pina::RestAdapter.get(:sales_orders, id)
+
+        return Pina::Models::SalesOrder.new(attributes(response)) if
+          response.ok?
+
+        response
+      end
+
+      def where(hash, page = nil)
+        response = Pina::RestAdapter.get(:sales_orders, hash)
+
+        return Pina::Collections::SalesOrder.new(attributes(response)) if
+          response.ok?
+
+        response
+      end
+
+      def all(page = nil)
+        response = Pina::RestAdapter.get(:sales_orders, page)
+
+        return Pina::Collections::SalesOrder.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/utils/pagination.rb

@@ -2,19 +2,23 @@ module Pina
   module Utils
     module Pagination
       def next_page
-        RESOURCE.all(extract_next_page)
+        resource.all(extract_next_page)
       end
 
       def first_page
-        RESOURCE.all
+        resource.all
       end
 
       def previous_page
-        RESOURCE.all(extract_prev_page)
+        resource.all(extract_prev_page)
       end
 
       private
 
+      def resource
+        Object.const_get("Pina::#{self.class.to_s.split('::').last}")
+      end
+
       def extract_next_page
         string = _meta['pagination']['next']
         return unless string

data/lib/pina/version.rb

@@ -1,3 +1,3 @@
 module Pina
-  VERSION = '0.3.1'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pina
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Pavel Hronek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-08 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -197,15 +197,22 @@ files:
 - Rakefile
 - bin/console
 - lib/pina.rb
+- lib/pina/collections/base.rb
+- lib/pina/collections/contact.rb
+- lib/pina/collections/receivable.rb
+- lib/pina/collections/sales_invoice.rb
+- lib/pina/collections/sales_order.rb
 - lib/pina/contact.rb
 - lib/pina/models/address.rb
 - lib/pina/models/contact.rb
-- lib/pina/models/contact_list.rb
+- lib/pina/models/receivable.rb
 - lib/pina/models/sales_invoice.rb
-- lib/pina/models/sales_invoice_list.rb
 - lib/pina/models/sales_item.rb
+- lib/pina/models/sales_order.rb
+- lib/pina/receivable.rb
 - lib/pina/rest_adapter.rb
 - lib/pina/sales_invoice.rb
+- lib/pina/sales_order.rb
 - lib/pina/utils/pagination.rb
 - lib/pina/version.rb
 - pina.gemspec

data/lib/pina/models/contact_list.rb

@@ -1,41 +0,0 @@
-module Pina
-  module Models
-    class ContactList
-      include Virtus.model
-
-      attribute :items, Array[Contact]
-      attribute :_meta
-      attribute :response
-
-      def next_page
-        Pina::Contact.all(extract_next_page)
-      end
-
-      def first_page
-        Pina::Contact.all
-      end
-
-      def previous_page
-        Pina::Contact.all(extract_prev_page)
-      end
-
-      private
-
-      def extract_next_page
-        string = _meta['pagination']['next']
-        return unless string
-
-        index = string.index('?')
-        string[index..-1]
-      end
-
-      def extract_prev_page
-        string = _meta['pagination']['prev']
-        return unless string
-
-        index = string.index('?')
-        string[index..-1]
-      end
-    end
-  end
-end

data/lib/pina/models/sales_invoice_list.rb

@@ -1,41 +0,0 @@
-module Pina
-  module Models
-    class SalesInvoiceList
-      include Virtus.model
-
-      attribute :items, Array[SalesInvoice]
-      attribute :_meta
-      attribute :response
-
-      def next_page
-        Pina::SalesInvoice.all(extract_next_page)
-      end
-
-      def first_page
-        Pina::SalesInvoice.all
-      end
-
-      def previous_page
-        Pina::SalesInvoice.all(extract_prev_page)
-      end
-
-      private
-
-      def extract_next_page
-        string = _meta['pagination']['next']
-        return unless string
-
-        index = string.index('?')
-        string[index..-1]
-      end
-
-      def extract_prev_page
-        string = _meta['pagination']['prev']
-        return unless string
-
-        index = string.index('?')
-        string[index..-1]
-      end
-    end
-  end
-end