gecko-ruby 0.0.4

data/lib/gecko/record/exceptions.rb

@@ -0,0 +1,15 @@
+module Gecko
+  module Record
+    # Generic Gecko::Record exception class.
+    class BaseError < StandardError
+    end
+
+    # Raise when a record can not be found via API
+    class RecordNotFound < BaseError
+    end
+
+    # Raised when a record can not be found in the Identity Map
+    class RecordNotInIdentityMap < BaseError
+    end
+  end
+end

data/lib/gecko/record/fulfillment.rb

@@ -0,0 +1,42 @@
+require 'gecko/record/base'
+require 'gecko/record/fulfillment_line_item'
+
+module Gecko
+  module Record
+    class Fulfillment < Base
+      belongs_to :order
+      belongs_to :shipping_address, class_name: 'Address'
+      belongs_to :billing_address,  class_name: 'Address'
+      has_many :fulfillment_line_items
+
+      attribute :status,           String
+      attribute :exchange_rate,    String
+      attribute :delivery_type,    String
+      attribute :tracking_number,  String
+      attribute :notes,            String
+      attribute :tracking_url,     String
+      attribute :tracking_company, String
+      attribute :destination_url,  String,  readonly: true
+
+      attribute :packed_at,        Date
+      attribute :shipped_at,       DateTime
+      attribute :received_at,      DateTime
+
+      attribute :receipt,          Hash
+    end
+
+    class FulfillmentAdapter < BaseAdapter
+      # Parse sideloaded FulfillmentLineItems into the Identity map
+      # instead of refetching them
+      def parse_records(json)
+        records = super
+        parse_line_items(json) if json['fulfillment_line_items']
+        records
+      end
+
+      def parse_line_items(json)
+        @client.FulfillmentLineItem.parse_records(json)
+      end
+    end
+  end
+end

data/lib/gecko/record/fulfillment_line_item.rb

@@ -0,0 +1,26 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class FulfillmentLineItem < Base
+      belongs_to :fulfillment
+      belongs_to :order_line_item
+
+      attribute :quantity,   BigDecimal
+      attribute :base_price, BigDecimal, readonly: true
+
+      attribute :position,   Integer
+    end
+
+    class FulfillmentLineItemAdapter < BaseAdapter
+      # Returns all cached records for testing
+      #
+      # @return [Array<Gecko::Record::FulfillmentLineItem>]
+      #
+      # @api private
+      def all
+        @identity_map.values
+      end
+    end
+  end
+end

data/lib/gecko/record/image.rb

@@ -0,0 +1,38 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class Image < Base
+      AVAILABLE_SIZES = [:full, :thumbnail]
+
+      belongs_to :variant
+      belongs_to :uploader, class_name: "User"
+      attribute :name,             String
+      attribute :position,         Integer
+      attribute :base_path,        String
+      attribute :file_name,        String
+      attribute :versions,         Array[String]
+      # attribute :image_processing, Boolean
+
+      # URL for image
+      #
+      # @param [Symbol] :size (:full) The image size, currently only :full
+      #   and :thumbnail supported
+      #
+      # @return [String]
+      #
+      # @api public
+      def url(size = :full)
+        if size == :full
+          file_path = file_name
+        else
+          file_path = "#{size}_#{file_name}"
+        end
+        [base_path, file_path].join("/")
+      end
+    end
+
+    class ImageAdapter < BaseAdapter
+    end
+  end
+end

data/lib/gecko/record/invoice.rb

@@ -0,0 +1,29 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class Invoice < Base
+      belongs_to :order
+      belongs_to :shipping_address
+      belongs_to :billing_address
+      belongs_to :payment_term
+
+      has_many :invoice_line_items
+
+      attribute :invoice_number,  String
+      attribute :invoiced_at,     Date
+      attribute :due_at,          Date
+      attribute :notes,           String
+      attribute :exchange_rate,   BigDecimal
+
+      attribute :destination_url, String,   readonly: true
+      attribute :document_url,    String,   readonly: true
+      attribute :created_at,      DateTime, readonly: true
+      attribute :updated_at,      DateTime, readonly: true
+    end
+
+    class InvoiceAdapter < BaseAdapter
+
+    end
+  end
+end

data/lib/gecko/record/invoice_line_item.rb

@@ -0,0 +1,18 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class InvoiceLineItem < Base
+      belongs_to :invoice
+      belongs_to :order_line_item
+      belongs_to :ledger_account
+
+      attribute :quantity, BigDecimal
+      attribute :position, Integer
+    end
+
+    class InvoiceLineItemAdapter < BaseAdapter
+
+    end
+  end
+end

data/lib/gecko/record/location.rb

@@ -0,0 +1,23 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class Location < Base
+
+      attribute :address1,     String
+      attribute :address2,     String
+      attribute :suburb,       String
+      attribute :city,         String
+      attribute :country,      String
+      attribute :label,        String
+      attribute :state,        String
+      attribute :zip_code,     String
+      attribute :holds_stock,  Boolean
+
+      attribute :status,       String,  readonly: true
+    end
+
+    class LocationAdapter < BaseAdapter
+    end
+  end
+end

data/lib/gecko/record/order.rb

@@ -0,0 +1,50 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class Order < Base
+      has_many :fulfillments
+      has_many :invoices
+      has_many :order_line_items
+
+      belongs_to :company
+      belongs_to :shipping_address,     class_name: 'Address'
+      belongs_to :billing_address,      class_name: 'Address'
+      belongs_to :contact,              class_name: 'Contact'
+      belongs_to :user,                 readonly: true
+      belongs_to :assignee,             class_name: 'User'
+      belongs_to :stock_location,       class_name: 'Location'
+      belongs_to :currency
+      # belongs_to :default_price_list,   class_name: 'PriceList'
+
+      attribute :order_number,          String
+      attribute :phone_number,          String
+      attribute :email,                 String
+      attribute :notes,                 String
+      attribute :reference_number,      String
+      attribute :status,                String
+      attribute :packed_status,         String,     readonly: true
+      attribute :fulfillment_status,    String,     readonly: true
+      attribute :invoice_status,        String,     readonly: true
+      attribute :payment_status,        String
+      attribute :tax_type,              String
+      attribute :issued_at,             Date
+      attribute :ship_at,               Date
+      attribute :tax_override,          String,     readonly: true
+      attribute :tax_label,             String,     readonly: true
+      attribute :source_url,            String
+      attribute :document_url,          String,     readonly: true
+      attribute :total,                 BigDecimal, readonly: true
+
+      attribute :source_id,             String,     readonly: true
+
+      ## DEPRECATED
+      attribute :tracking_number,       String,     readonly: true
+      # attribute :source,                String
+      # attribute :invoice_numbers,       Hash[Integer => String], readonly: true
+    end
+
+    class OrderAdapter < BaseAdapter
+    end
+  end
+end

data/lib/gecko/record/order_line_item.rb

@@ -0,0 +1,35 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class OrderLineItem < Base
+      belongs_to :order
+      belongs_to :variant
+      belongs_to :tax_type
+
+      has_many :fulfillment_line_items
+      has_many :invoice_line_items
+
+      attribute :label,     String
+      attribute :line_type, String
+
+      attribute :freeform,  Boolean
+      attribute :shippable, Boolean, readonly: true
+
+      attribute :discount,  BigDecimal
+      attribute :quantity,  BigDecimal
+      attribute :price,     BigDecimal
+      attribute :tax_rate_override,  BigDecimal
+
+      attribute :position,  Integer
+
+      attribute :image_url, String,     readonly: true
+
+      # DEPRECATED
+      attribute :tax_rate,  BigDecimal
+    end
+
+    class OrderLineItemAdapter < BaseAdapter
+    end
+  end
+end

data/lib/gecko/record/product.rb

@@ -0,0 +1,27 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class Product < Base
+      has_many :variants
+      attribute :name,         String
+      attribute :description,  String
+      attribute :product_type, String
+      attribute :supplier,     String
+      attribute :brand,        String
+      attribute :opt1,         String
+      attribute :opt2,         String
+      attribute :opt3,         String
+      attribute :tags,         String
+
+      attribute :status,       String
+
+      # attribute :image_url,    String,  readonly: true
+      # attribute :quantity,     Integer, readonly: true
+      # attribute :search_cache, String,  readonly: true
+    end
+
+    class ProductAdapter < BaseAdapter
+    end
+  end
+end

data/lib/gecko/record/purchase_order.rb

@@ -0,0 +1,43 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class PurchaseOrder < Base
+      has_many :purchase_order_line_items
+      has_many :procurements
+
+      belongs_to :company
+      belongs_to :supplier_address,   class_name: "Address"
+      belongs_to :stock_location,     class_name: "Location"
+      belongs_to :billing_address,    class_name: "Location"
+
+      belongs_to :currency
+      belongs_to :default_price_list, class_name: "PriceList"
+
+      attribute :order_number,          String
+      attribute :reference_number,      String
+      attribute :email,                 String
+      attribute :due_at,                Date
+
+      attribute :status,                String
+      attribute :procurement_status,    String
+      attribute :notes,                 String
+      attribute :tax_treatment,         String
+
+      attribute :destination_url,       String
+      attribute :document_url,          String
+
+      attribute :total,                 BigDecimal
+      attribute :cached_quantity,       BigDecimal
+      attribute :cached_total,          BigDecimal
+
+      # DEPRECATED
+      # attribute :tax_type, String
+      # attribute :default_price_type_id
+    end
+
+    class PurchaseOrderAdapter < BaseAdapter
+
+    end
+  end
+end

data/lib/gecko/record/purchase_order_line_item.rb

@@ -0,0 +1,29 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class PurchaseOrderLineItem < Base
+      belongs_to :purchase_order
+      belongs_to :variant
+      belongs_to :procurement
+      belongs_to :tax_type
+
+      attribute :quantity,          BigDecimal
+      attribute :position,          Integer
+      attribute :tax_rate_override, BigDecimal
+      attribute :price,             BigDecimal
+      attribute :label,             String
+      attribute :freeform,          Boolean
+      attribute :base_price,        BigDecimal
+      attribute :extra_cost_value,  BigDecimal
+      attribute :image_url,         String
+
+      # DEPRECATED
+      # attribute :tax_rate, String
+    end
+
+    class PurchaseOrderLineItemAdapter < BaseAdapter
+
+    end
+  end
+end

data/lib/gecko/record/tax_type.rb

@@ -0,0 +1,21 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class TaxType < Base
+      attribute :name,              String
+      attribute :code,              String
+      attribute :xero_online_id,    String
+      attribute :imported_from,     String
+      attribute :effective_rate,    BigDecimal
+
+      attribute :status,            String
+
+      # has_many :tax_components
+    end
+
+    class TaxTypeAdapter < BaseAdapter
+
+    end
+  end
+end

data/lib/gecko/record/user.rb

@@ -0,0 +1,44 @@
+require 'gecko/record/base'
+
+module Gecko
+  module Record
+    class User < Base
+      attribute :first_name,         String
+      attribute :last_name,          String
+      attribute :email,              String
+      attribute :location,           String
+      attribute :position,           String
+      attribute :phone_number,       String
+      attribute :mobile_phone,       String
+      attribute :last_sign_in_at,    DateTime
+      attribute :avatar_url,         String
+
+      attribute :status,             String
+
+      # attribute :sales_report_email, Boolean
+      # attribute :action_items_email, String
+
+      # attribute :billing_contact,    Boolean
+      # attribute :notification_email, Boolean
+      # attribute :permisssions,       Array[String]
+      # attribute :account_id,         Integer
+    end
+
+    class UserAdapter < BaseAdapter
+      undef :build
+
+      # Return the the logged in user
+      #
+      # @return [Gecko::Record::User]
+      #
+      # @api public
+      def current
+        if self.has_record_for_id?(:current)
+          record_for_id(:current)
+        else
+          @identity_map[:current] = find(:current)
+        end
+      end
+    end
+  end
+end