xpost 0.1.4 → 0.1.21

data/lib/xpost/address.rb

@@ -1,77 +0,0 @@
-require 'active_model'
-require 'set'
-
-module Xpost
-  class Address
-    include ActiveModel::Model
-
-    REQUIRED_ADDRESS_PARAMETERS = Set[:name, :line_1, :city, :state, :postal_code, :country]
-    OPTIONAL_ADDRESS_PARAMETERS = Set[:company, :title, :email, :phone_number, :mobile_number, :fax_number,
-                                      :district, :line_2, :remarks]
-
-    attr_accessor :name, :line_1, :city, :state, :postal_code, :country
-    attr_accessor :company, :title, :email, :phone_number, :mobile_number, :fax_number, :district, :line_2, :remarks
-
-    validates_presence_of :name, :line_1, :city, :state, :postal_code, :country
-
-    def initialize(options = {})
-      # (?) Mr., Mrs., Ms., etc.
-      @title          = options[:title]
-      @name           = options[:name]
-      @email          = options[:email]
-      @phone_number   = options[:phone_number]
-      @mobile_number  = options[:mobile_number]
-      @fax_number     = options[:fax_number]
-      @company        = options[:company]
-
-      # Address Line 1
-      @line_1         = options[:line_1]
-      # Address Line 1
-      @line_2         = options[:line_2]
-      # City
-      @city           = options[:city]
-      # District (NCR's Four Districts) (Optional)
-      @district       = options[:district]
-      # State / Province
-      @state          = options[:state]
-      # Postal Code / ZIP Code
-      @postal_code    = options[:postal_code]
-      # Country
-      @country        = options[:country]
-
-      @remarks        = options[:remarks]
-    end
-
-    def attributes
-      {
-        title: self.title,
-        name: self.name,
-        email: self.email,
-        phone_number: self.phone_number,
-        mobile_number: self.mobile_number,
-        fax_number: self.fax_number,
-        company: self.company,
-        line_1: self.line_1,
-        line_2: self.line_2,
-        city: self.city,
-        district: self.district,
-        state: self.state,
-        postal_code: self.postal_code,
-        country: self.country,
-        remarks: self.remarks
-      }
-    end
-
-    def self.sample_address
-      address = Xpost::Address.new(
-        name: "Bobby Axelrod",
-        line_1: "EDSA Shangri-La",
-        city: "Mandaluyong",
-        state: "Metro Manila",
-        postal_code: "1650",
-        country: "PH"
-      )
-      address
-    end
-  end
-end

data/lib/xpost/item.rb

@@ -1,44 +0,0 @@
-require 'active_model'
-require 'set'
-
-module Xpost
-  class Item
-    include ActiveModel::Model
-
-    ITEM_TYPES = Set[:product, :shipping, :tax, :fee, :insurance, :discount]
-
-    attr_accessor :product_type, :description, :amount, :quantity, :metadata
-
-    validates_presence_of :product_type, :description, :amount
-    validate :check_item_type
-
-    def initialize(options = {})
-      # Product Type
-      @product_type = options.key?(:product_type) ? options[:product_type] : "product"
-      # Product Description
-      @description  = options[:description]
-      # (Single) Product Amount
-      @amount       = options[:amount]
-      # Product Quantity
-      @quantity     = options.key?(:quantity) ? options[:quantity].to_i : 1
-      # Additional Product Data (For third-party purposes)
-      @metadata     = options[:metadata]
-    end
-
-    def check_item_type
-      if self.product_type.present? && !ITEM_TYPES.include?(self.product_type.to_sym)
-        errors.add(:type, "wrong item type")
-      end
-    end
-    
-    def attributes
-      {
-        type: self.product_type,
-        description: self.description,
-        amount: self.amount,
-        quantity: self.quantity,
-        metadata: self.metadata
-      }
-    end
-  end
-end

data/lib/xpost/order.rb

@@ -1,135 +0,0 @@
-require 'active_model'
-require 'json'
-require 'set'
-
-module Xpost
-  class Order
-    include ActiveModel::Model
-
-    CONFIRMABLE_PARAMETERS  = Set[:status, :email, :buyer_name, :contact_number, :delivery_address, :items,
-                                  :shipment, :total, :currency, :payment_method, :payment_provider]
-    FOR_PICKUP_PARAMETERS   = Set[:pickup_address]
-
-    attr_accessor :email, :buyer_name, :contact_number, :reference_id
-    attr_accessor :total, :currency, :payment_method, :payment_provider
-    attr_accessor :delivery_address, :pickup_address
-    attr_accessor :status, :items, :shipment
-
-    validates_presence_of :email, :buyer_name, :contact_number
-    validates_presence_of :delivery_address
-
-    def initialize(options = {})
-      @status           = options[:status]            || "pending"
-      @reference_id     = options[:reference_id]
-      @email            = options[:email]
-      @buyer_name       = options[:buyer_name]
-      @contact_number   = options[:contact_number]
-      @delivery_address = options[:delivery_address]
-      @items            = options[:items]             || []
-      @shipment         = options[:shipment]
-      @total            = options[:total]
-      @currency         = options[:currency]
-      @payment_method   = options[:payment_method]
-      @payment_provider = options[:payment_provider]
-      @pickup_address   = options[:pickup_address]
-    end
-
-    def self.sample_order
-      o = Xpost::Order.new
-      o.email = "john@me.com"
-      o.buyer_name = "John Doe"
-      o.contact_number = "+6391712345678"
-      o.shipment = "small-pouch"
-      o.total = 1000
-      o.currency = "PHP"
-      o.payment_method = "cod"
-      o.payment_provider = "lbcx"
-      o.add_item(Xpost::Item.new(
-        type: "product",
-        description: "red shirt",
-        amount: 1000,
-        quantity: 1,
-        metadata: "Small"
-      ))
-      o.delivery_address = Xpost::Address.new(
-        name: "Bobby Axelrod",
-        line_1: "BGC Corporate Centre",
-        line_2: "5th floor",
-        city: "Taguig",
-        state: "Metro Manila",
-        postal_code: "1634",
-        country: "PH",
-        company: "Axe Capital",
-        title: "CEO",
-        email: "bobby@axe.com",
-        phone_number: "12345678",
-        mobile_number: "091712345678",
-        fax_number: "12345678",
-        district: "BGC",
-        remarks: "Send ASAP"
-      )
-      o
-    end
-
-    def confirmable?
-      self.valid? && self.has_delivery_address? && self.has_payment_method? && self.has_items?
-    end
-
-    # https://docs.quadx.xyz/#5f38afd0-66bb-468f-ab4e-993d4745a257
-    # Sets the order status to canceled. An order can be canceled provided they have not passed the cutoff date and time as specified in the contract.
-    def cancellable?
-      true
-    end
-
-    # https://docs.quadx.xyz/#c831dc25-2de4-36c5-c321-8e9db0fc2105
-    # The following fields can be updated provided they have not passed the cutoff date and time as specified in the contract.
-    def updatable?
-      true
-    end
-
-    def has_delivery_address?
-      self.delivery_address.present?
-    end
-
-    def has_payment_method?
-      self.total.present? && self.currency.present? && self.payment_method.present? && self.payment_provider.present?
-    end
-
-    def has_items?
-      self.items.present? ? self.items.count > 0 : false
-    end
-
-    def add_item(item)
-      self.items << item if item.valid?
-    end
-
-    def order_items
-      items = []
-      self.items.each do |item|
-        items << item.attributes
-      end
-      items
-    end
-
-    def attributes
-      {
-        reference_id: self.reference_id,
-        email: self.email,
-        buyer_name: self.buyer_name,
-        contact_number: self.contact_number,
-        shipment: self.shipment,
-        total: self.total,
-        currency: self.currency,
-        payment_method: self.payment_method,
-        payment_provider: self.payment_provider,
-        items: self.order_items,
-        delivery_address: self.delivery_address.attributes,
-        pickup_address: self.pickup_address.nil? ? nil : self.pickup_address.attributes,
-      }
-    end
-
-    def to_json
-      self.attributes.to_json
-    end
-  end
-end

data/lib/xpost/statuses.rb

@@ -1,29 +0,0 @@
-require 'json'
-require 'set'
-require 'typhoeus'
-
-module Xpost
-  class Statuses
-    def self.all(auth_token)
-      get_url("orders/statuses", headers: auth_header(auth_token))
-    end
-
-    private
-
-    def self.base_url
-      Xpost.configuration.production_url
-    end
-
-    def self.auth_header(auth_token)
-      {"Authorization" => "Bearer #{auth_token}"}
-    end
-
-    def self.get_url(url, options = {})
-      req_url = "#{base_url}/#{url}"
-      req_options = {headers: options[:headers]}
-
-      res = Typhoeus::Request.get(req_url, req_options).body
-      res = JSON.parse(res, symbolize_names: true)
-    end
-  end
-end

data/sample/sample_essential_order_details.json

@@ -1,63 +0,0 @@
-{
- "currency": "PHP",
- "total": "1750.00",
- "payment_method": "cod",
- "status" : "for_pickup",
- "payment_provider": "lbcx",
- "shipment": "box",
- "service": "next_day",
- "buyer_name": "Thea Lizardo",
- "buyer_id": "12345",
- "parcel": {
-   "dimensions": {
-     "uom": "cm",
-     "length": 22,
-     "width": 22,
-     "height": 22
-   },
-   "weight": {
-     "uom": "kg",
-     "value": "22"
-   }
- },
- "metadata": {"key_1":"value_1","key_2":"value_2"},
- "pickup_address": {
-   "name": "Thea Lizardo",
-   "company": "xpanse",
-   "phone_number": "",
-   "mobile_number": "+639171234567",
-   "line_1": "Payless Warehouse",
-   "line_2": "",
-   "city": "Paranaque City",
-   "state": "Metro Manila",
-   "postal_code": "1634",
-   "country": "PH",
-   "remarks": "Optional notes / remarks go here."
- },
- "delivery_address": {
-   "name": "Thea Lizardo",
-   "company": "",
-   "phone_number": "",
-   "mobile_number": "+639171234567",
-   "line_1": "Payless Warehouse",
-   "line_2": "",
-   "city": "Paranaque City",
-   "state": "Metro Manila",
-   "postal_code": "1634",
-   "country": "PH",
-   "remarks": "Optional notes / remarks go here."
- },
- "preferred_pickup_time": "morning",
- "preferred_delivery_time": "3pm - 5pm",
- "email": "thealizardo@gmail.com",
- "contact_number": "+639176788488",
- "items": [
-   {
-     "type": "product",
-     "description": "Women's Abby Pointed Sling",
-     "amount": 1750,
-     "quantity": 1,
-     "metadata": {"size":"7","color":"Floral", "width": "Regular", "sku":"FSRI-174290070"}
-   }
- ]
-}

data/sample/sample_xpost_order-confirmed.json

@@ -1,317 +0,0 @@
-{
-  "id": 789566,
-  "party_id": 6191,
-  "service_id": 6191,
-  "currency": "PHP",
-  "reference_id": "2309174223312",
-  "tracking_number": "0078-9566-ABLV",
-  "payment_method": "cod",
-  "payment_provider": "lbcx",
-  "service": "next_day",
-  "status": "confirmed",
-  "status_updated_at": "2018-08-13 11:55:20.723494+00",
-  "buyer_name": "Thea Lizardo",
-  "email": "thealizardo@gmail.com",
-  "contact_number": "+639176788488",
-  "subtotal": "1750.00",
-  "tax": "0.00",
-  "fee": "0.00",
-  "insurance": "0.00",
-  "discount": "0.00",
-  "shipping": "0.00",
-  "total": "1750.00",
-  "transaction_fee": "61.25",
-  "insurance_fee": "17.50",
-  "shipping_fee": "240.00",
-  "metadata": {
-    "key_1": "value_1",
-    "key_2": "value_2"
-  },
-  "preferred_pickup_time": "morning",
-  "preferred_delivery_time": "3pm - 5pm",
-  "created_at": "2018-08-13 11:52:15+00",
-  "tat": {
-    "confirmed": 1534161320,
-    "for_pickup": 1534161135
-  },
-  "shipment": "box",
-  "remarks": null,
-  "buyer_id": "12345",
-  "parcel": {
-    "weight": {
-      "uom": "kg",
-      "value": "4"
-    },
-    "dimensions": {
-      "uom": "cm",
-      "width": 22,
-      "height": 22,
-      "length": 22
-    }
-  },
-  "updated_at": "2018-08-13 11:55:20.723494+00",
-  "client": "Xpanse",
-  "organization": {
-    "party_id": 6191,
-    "name": "Xpanse",
-    "external_id": null
-  },
-  "pickup_address": {
-    "id": 1600969,
-    "code": null,
-    "name": "Thea Lizardo",
-    "title": null,
-    "email": null,
-    "phone_number": "",
-    "mobile_number": "+639171234567",
-    "fax_number": null,
-    "company": "xpanse",
-    "line_1": "Payless Warehouse",
-    "line_2": "",
-    "district": null,
-    "city": "Paranaque City",
-    "state": "Metro Manila",
-    "postal_code": "1634",
-    "region": "Mmb",
-    "country": {
-      "code": "PH",
-      "name": "Philippines"
-    },
-    "city_approximation": "Paranaque City",
-    "branch_code": null
-  },
-  "delivery_address": {
-    "id": 1600609,
-    "code": null,
-    "name": "Thea Lizardo",
-    "title": null,
-    "email": null,
-    "phone_number": "",
-    "mobile_number": "+639171234567",
-    "fax_number": null,
-    "company": "",
-    "line_1": "Payless Warehouse",
-    "line_2": "",
-    "district": null,
-    "city": "Paranaque City",
-    "state": "Metro Manila",
-    "postal_code": "1634",
-    "region": "Mmb",
-    "country": {
-      "code": "PH",
-      "name": "Philippines"
-    },
-    "city_approximation": "Paranaque City"
-  },
-  "return_address": {
-    "id": null,
-    "code": null,
-    "name": null,
-    "title": null,
-    "email": null,
-    "phone_number": null,
-    "mobile_number": null,
-    "fax_number": null,
-    "company": null,
-    "line_1": null,
-    "line_2": null,
-    "district": null,
-    "city": null,
-    "state": null,
-    "postal_code": null,
-    "region": null,
-    "country": {
-      "code": null,
-      "name": null
-    }
-  },
-  "dropoff_address": {
-    "id": null,
-    "code": null,
-    "name": null,
-    "title": null,
-    "email": null,
-    "phone_number": null,
-    "mobile_number": null,
-    "fax_number": null,
-    "company": null,
-    "line_1": null,
-    "line_2": null,
-    "district": null,
-    "city": null,
-    "state": null,
-    "postal_code": null,
-    "region": null,
-    "country": {
-      "code": null,
-      "name": null
-    }
-  },
-  "charge": {
-    "order_id": 789566,
-    "status": "pending",
-    "reference_id": "71001373530487",
-    "total_amount": "1750.00",
-    "tendered_amount": "0.00",
-    "change_amount": "0.00",
-    "remarks": null,
-    "created_at": "2018-08-13 11:52:15+00",
-    "updated_at": "2018-08-13 11:52:16+00"
-  },
-  "claim": {
-    "status": null,
-    "amount": null,
-    "shipping_fee_flag": null,
-    "insurance_fee_flag": null,
-    "transaction_fee_flag": null,
-    "assets": null,
-    "reason": null,
-    "remarks": null,
-    "created_at": null,
-    "updated_at": null,
-    "tat": null,
-    "reference_id": null
-  },
-  "buyer_name_parsed": {
-    "first_name": "Thea Lizardo",
-    "middle_name": null,
-    "last_name": null
-  },
-  "items": [
-    {
-      "type": "product",
-      "description": "Women's Abby Pointed Sling",
-      "amount": "1750.00",
-      "quantity": 1,
-      "total": "1750.00",
-      "metadata": {
-        "sku": "FSRI-174290070",
-        "size": "7",
-        "color": "Floral",
-        "width": "Regular"
-      },
-      "insured_value": null
-    }
-  ],
-  "segments": [
-    {
-      "courier": "South Hub",
-      "type": "pick_up",
-      "barcode_format": "qr",
-      "tat": {
-        "end_date": null,
-        "start_date": null
-      },
-      "shipping_type": "land",
-      "currency": null,
-      "amount": null,
-      "reference_id": "0078-9566-ABLV",
-      "active": true,
-      "pickup_address": {
-        "name": "Thea Lizardo",
-        "title": null,
-        "email": null,
-        "phone_number": "",
-        "mobile_number": "+639171234567",
-        "fax_number": null,
-        "company": "xpanse",
-        "line_1": "Payless Warehouse",
-        "line_2": "",
-        "district": null,
-        "city": "Paranaque City",
-        "state": "Metro Manila",
-        "postal_code": "1634",
-        "region": "Mmb",
-        "country": {
-          "code": "PH",
-          "name": "Philippines"
-        }
-      },
-      "delivery_address": {
-        "name": "South Hub",
-        "title": null,
-        "email": null,
-        "phone_number": null,
-        "mobile_number": null,
-        "fax_number": null,
-        "company": null,
-        "line_1": "",
-        "line_2": null,
-        "district": "",
-        "city": "Manila City",
-        "state": "Metro Manila",
-        "postal_code": "",
-        "region": "MMB",
-        "country": {
-          "code": "PH",
-          "name": "Philippines"
-        }
-      }
-    },
-    {
-      "courier": "South Hub",
-      "type": "delivery",
-      "barcode_format": "qr",
-      "tat": {
-        "end_date": null,
-        "start_date": null
-      },
-      "shipping_type": "land",
-      "currency": null,
-      "amount": null,
-      "reference_id": "71001373530487",
-      "active": false,
-      "pickup_address": {
-        "name": "South Hub",
-        "title": null,
-        "email": null,
-        "phone_number": null,
-        "mobile_number": null,
-        "fax_number": null,
-        "company": null,
-        "line_1": "",
-        "line_2": null,
-        "district": "",
-        "city": "Manila City",
-        "state": "Metro Manila",
-        "postal_code": "",
-        "region": "MMB",
-        "country": {
-          "code": "PH",
-          "name": "Philippines"
-        }
-      },
-      "delivery_address": {
-        "name": "Thea Lizardo",
-        "title": null,
-        "email": null,
-        "phone_number": "",
-        "mobile_number": "+639171234567",
-        "fax_number": null,
-        "company": "",
-        "line_1": "Payless Warehouse",
-        "line_2": "",
-        "district": null,
-        "city": "Paranaque City",
-        "state": "Metro Manila",
-        "postal_code": "1634",
-        "region": "Mmb",
-        "country": {
-          "code": "PH",
-          "name": "Philippines"
-        }
-      }
-    }
-  ],
-  "events": [
-    {
-      "id": 2197070,
-      "status": "confirmed",
-      "created_at": "2018-08-13 11:55:20.723494+00",
-      "remarks": null,
-      "status_updated_at": "2018-08-13 11:55:20.723494+00",
-      "status_name": "Confirmed"
-    }
-  ],
-  "children": []
-}