xpost 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e754cf1a98d77e678c4d5f58ed676fb791776e9
-  data.tar.gz: 7c91de64c865129a032e3565bbd122185a53044d
+  metadata.gz: 878b45ccbba01168869cdb4bcc95aaba0189d873
+  data.tar.gz: 06b8b6088a40661bbbc6a5e84b1a53be6f81cc86
 SHA512:
-  metadata.gz: 7fe0eed7c9b763ef173a7007caed6d0b8d33aacf8cfe1fc0b1f5d6df2c7033a0f59a3784f136cccce14bffee356d83fd7bf5ed7e789a38d49c941ad64348182f
-  data.tar.gz: 49548ac5f9124529d63e91b936712c64645ceb6a38d5158affcf619a068694c76db5183a913223e5bbc92cc9a8ba1722d92e2b13da8e62021028c71f63af9dfb
+  metadata.gz: 55d707c70faeffeb5bcd0183c15ac387705aa76d2086e4271740deac57014d0d7b37e2961f4627488c2cae77a17c02c394eced9c27a5d580d258c7cd4e280bc7
+  data.tar.gz: beb3d12a8301ec3767d2a48db48b076edaae71eac408cac544afab4a9f0015d29aaa24614175dfa1fd1df2f721f987019c67bcfbc3e64bcfefb117d8ed8faf02

data/.gitignore

@@ -7,4 +7,5 @@ gemfiles/vendor/*
 tmp/
 spec/reports/
 
-.rspec_status
+.rspec_status
+.env

data/TODO.md

@@ -1,5 +1,32 @@
 
-
 # xpost To-Do's
 
+- it should be able to track order statuses on Orders.all (???)
+
+# Bonus To-Do's
+
+- it should find a way to remove the (@auth_token) requirement from all the methods
+  - and error out if an @auth_token is missing from the config
+- OR
+- it should just generate auth_tokens all the time since the api_key + secret_keys should be present
+  - and it should make sure that any method call will error out if a config isnt present
+
+- it should accept shopify order data
+
+# xpost Done
 
+- it returns the shipping labels for a single order
+- it returns all the shipping labels for an array of tracking numbers (no need to check for for-pickup)
+  - link: orders/download/awb/zebra
+  - return S3 link of AWB (airwaybills)
+  - return S3 link of POD (proof of deliveries)
+- it should be able to mark an order for_pickup
+- it should be able to cancel an existing order
+- it should view an existing order
+- it should be able to confirm an existing order
+- it should be able to create an order
+  - figure out line per line why the json file isn't reading the sub array
+  - Xpost::Order.to_json
+    - base details
+    - delivery address
+    - items

data/lib/xpost.rb

@@ -1,13 +1,15 @@
+
 module Xpost
   autoload :Configuration,    'xpost/configuration'
   autoload :Authentication,   'xpost/authentication'
-  autoload :Orders,           'xpost/orders'
+  autoload :Statuses,         'xpost/statuses'
 
-  module Models
-    autoload :Address,  'xpost/models/address'
-    autoload :Item,     'xpost/models/item'
-    autoload :Order,    'xpost/models/order'
-  end
+  autoload :Orders,           'xpost/orders'                  # Generic xpost order methods (find, track, etc.)
+  autoload :Order,            'xpost/order'                   # ActiveModel-type of Order class (Order.create, etc.)
+  # autoload :OrderSerializer,  'serializers/order_serializer'
+  
+  autoload :Address,          'xpost/address'
+  autoload :Item,             'xpost/item'
 
   class << self
     attr_accessor :configuration

data/lib/xpost/address.rb

@@ -0,0 +1,77 @@
+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/authentication.rb

@@ -10,6 +10,11 @@ module Xpost
       token     = "#{header}.#{payload}.#{signature}"
     end
 
+    def self.sample_auth_token
+      config = Xpost::Configuration.sample_configuration
+      Xpost::Authentication.authenticate(config.api_key, config.secret_key)
+    end
+
     private
 
     def self.header

data/lib/xpost/configuration.rb

@@ -8,5 +8,20 @@ module Xpost
       @staging_url
       @production_url
     end
+
+    def self.sample_configuration
+      api_key_line    = File.readlines('.env').first.chomp
+      secret_key_line = File.readlines('.env').last.chomp
+      api_key         = api_key_line.split('=').last
+      secret_key      = secret_key_line.split('=').last
+
+      sample_configuration = Xpost.configure do |config|
+        config.api_key        = api_key
+        config.secret_key     = secret_key
+        config.staging_url    = "https://api.staging.lbcx.ph/v1"
+        config.production_url = "https://api.staging.lbcx.ph/v1"
+      end
+      Xpost.configuration
+    end
   end
 end

data/lib/xpost/item.rb

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,137 @@
+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, :pickup_at]
+
+    attr_accessor :email, :buyer_name, :contact_number, :reference_id
+    attr_accessor :total, :currency, :payment_method, :payment_provider
+    attr_accessor :delivery_address, :pickup_address, :pickup_at
+    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]
+      @pickup_at        = options[:pickup_at]
+    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,
+        pickup_at: self.pickup_at
+      }
+    end
+
+    def to_json
+      self.attributes.to_json
+    end
+  end
+end

data/lib/xpost/orders.rb

@@ -6,17 +6,28 @@ require 'typhoeus'
 #   order = Order.create({...})
 #   order.confirm / order.cancel
 #   order.for_pickup(pickup_address, pickup_date)
-#   order.update({...})
 
 module Xpost
   class Orders
     # cant actually get all orders since its paginated
-    def self.all(auth_token)
-      all_orders_url = "orders"
+    def self.all(auth_token, status = nil)
+      valid_xpost_statuses = ["pending", "confirmed", "for_pickup", "picked_up",
+                              "failed_pickup", "failed_delivery", "claimed",
+                              "return_in_transit", "returned", "failed_return",
+                              "out_for_delivery", "for_consolidation", "consolidated",
+                              "for_dropoff", "dropped_off", "for_transfer", "for_acceptance",
+                              "accepted", "canceled", "in_transit", "delivered"]
+
+      if valid_xpost_statuses.include?(status)
+        all_orders_url = "orders?status=#{status}"
+      else
+        all_orders_url = "orders"
+      end
 
       get_url(all_orders_url, headers: auth_header(auth_token))
     end
 
+    # gets all the details of an order
     def self.find(auth_token, tracking_number)
       find_order_url  = "orders/#{tracking_number}"
 
@@ -24,6 +35,7 @@ module Xpost
       res = res[:message] == "Not Found" ? "Not Found" : res
     end
 
+    # only gets the order tat (turnaround time) info
     def self.track(auth_token, tracking_number)
       track_order_url = "orders/#{tracking_number}"
 
@@ -31,16 +43,27 @@ module Xpost
       res = res[:message] == "Not Found" ? "Not Found" : { timeline: res[:tat], events: res[:events] }
     end
 
-    def self.create(auth_token, options = {})
-      raise "Missing order data" if options[:order_data].empty?
+    def self.exists?(auth_token, tracking_number)
+      find_order_url  = "orders/#{tracking_number}"
+      res = get_url(find_order_url, headers: auth_header(auth_token))
+      res[:status] != 404 && res[:message] != "Not Found"
+    end
+
+    def self.create(auth_token, order = nil, shipment = nil, reference_id = nil)
+      raise "Missing order data" if order.nil?
+      raise "Missing shipment data" if shipment.nil?
+
+      order.shipment = shipment
+      order.reference_id = reference_id
 
-      create_order_url      = "orders"
-      order_data            = options[:order_data]
-      
-      res = post_url(create_order_url, data: order_data, headers: auth_header(auth_token))
+      res = post_url("orders", data: order, headers: auth_header(auth_token))
     end
 
-    def self.confirm(auth_token, tracking_number, payment_reference_id)
+    def self.confirm(auth_token, tracking_number, payment_reference_id = nil)
+      # TODO: these checks are expensive (potentially three back and forth requests)
+      raise "Order not found" unless Xpost::Orders.exists?(auth_token, tracking_number)
+      raise "Order isn't pending" if Xpost::Orders.find(auth_token, tracking_number)[:status] != "pending"
+
       confirm_order_url = "orders/#{tracking_number}/confirm"
 
       res = put_url(confirm_order_url, data: payment_reference_id, headers: auth_header(auth_token))
@@ -49,21 +72,39 @@ module Xpost
 
     def self.cancel(auth_token, tracking_number)
       cancel_order_url = "orders/#{tracking_number}/cancel"
+      raise "Order isn't pending" if Xpost::Orders.find(auth_token, tracking_number)[:status] != "pending"
 
       res = put_url(cancel_order_url, headers: auth_header(auth_token))
       res = res[:message] == "Not Found" ? "Not Found" : res
     end
 
     def self.for_pickup(auth_token, tracking_number, pickup_address)
-      pickup_address = Xpost::Models::Address.new(pickup_address)
+      raise "Order isn't confirmed" if Xpost::Orders.find(auth_token, tracking_number)[:status] != "confirmed"
       for_pickup_url = "orders/#{tracking_number}/for-pickup"
 
-      raise "Invalid address" unless pickup_address.valid?
+      raise "Missing pickup address" if pickup_address.nil?
+      raise "Invalid pickup address" unless pickup_address.valid?
+      pickup_address = { pickup_address: pickup_address.attributes }
 
       res = put_url(for_pickup_url, data: pickup_address, headers: auth_header(auth_token))
       res = res[:message] == "Not Found" ? "Not Found" : res
     end
 
+    def self.get_shipping_labels(auth_token, tracking_number)
+      if tracking_number.kind_of?(Array)
+        shipping_labels_url = "orders/download/awb/zebra"
+
+        res = post_url(shipping_labels_url, data: tracking_number, headers: auth_header(auth_token))
+        res = res[:message] == "Not Found" ? "Not Found" : res
+      else
+        raise "Order isn't for_pickup" if Xpost::Orders.find(auth_token, tracking_number)[:status] != "for_pickup"
+        shipping_label_url = "orders/#{tracking_number}/awb?type=zebra"
+
+        res = get_url(shipping_label_url, headers: auth_header(auth_token))
+        res = res[:message] == "Not Found" ? "Not Found" : res
+      end
+    end
+
     private
 
     def self.base_url