xpost 0.1.4 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: e06c6e03fdd2dbef18cf861380df0b90a6566030c302d7f938f414e6e9ef6e5b
-  data.tar.gz: f85c2920686b2dadbe01dd025a72639c0bed6031764ff1ca377d1d1c41b88e12
+SHA1:
+  metadata.gz: daeea5bd3cf6a8f61328026b19276b5775e590b3
+  data.tar.gz: 852c2e8c12ef2eceb7d87dc456d5a8f13aeb12c4
 SHA512:
-  metadata.gz: c8f23db4ed6dbcb26752f326da4cb1129f252283aa54e2f879d57e6ad8143d8e366de14c25b3b25ab830c244fc6ae27a1e6d045e4c2a76cc187bb564a8ea4d0c
-  data.tar.gz: 1b4a3b4f3ae573e07ab3402165b785e02c6b7972aa35832bb61141a710c5bf450b7b42f5f56fcc6ffcc17319fd77d29cce7d4a76675ae1ad785ce08c7bb670a8
+  metadata.gz: 84bf7d5da6a979326ddbe82bc78976542d8dba1fe834ad6b22740e3c38acf469f1f961eab491626ca6c1ac1633bcdd0f308aa3d9981049a136bc96c7cfff99d3
+  data.tar.gz: e09a5977510ea684ec0c51d0bf2b0a1a5a76712756305276f91d2d790cca8d93849776cb1a8fabe1bcd1419ff61cc68829b64616e7f597a4b6a602c2a54031cd

data/.gitignore

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

data/TODO.md

@@ -1,32 +1,5 @@
 
-# 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 To-Do's
 
-# 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,15 +1,13 @@
-
 module Xpost
   autoload :Configuration,    'xpost/configuration'
   autoload :Authentication,   'xpost/authentication'
-  autoload :Statuses,         'xpost/statuses'
+  autoload :Orders,           'xpost/orders'
 
-  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'
+  module Models
+    autoload :Address,  'xpost/models/address'
+    autoload :Item,     'xpost/models/item'
+    autoload :Order,    'xpost/models/order'
+  end
 
   class << self
     attr_accessor :configuration

data/lib/xpost/authentication.rb

@@ -10,11 +10,6 @@ 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,20 +8,5 @@ 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.lbcx.ph/v1"
-      end
-      Xpost.configuration
-    end
   end
 end

data/lib/xpost/models.rb

@@ -0,0 +1,5 @@
+module Xpost
+  module Models
+    
+  end
+end

data/lib/xpost/models/address.rb

@@ -0,0 +1,38 @@
+require 'active_model'
+require 'set'
+
+module Xpost
+  module Models
+    class Address
+      include ActiveModel::Model
+
+      REQUIRED_ADDRESS_PARAMETERS = Set[:name, :shipment, :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, :shipment, :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, :shipment, :line_1, :city, :state, :postal_code, :country
+
+      def initialize(options = {})
+        @shipment       = options[:shipment]
+        @name           = options[:name]
+        @email          = options[:email]
+        @phone_number   = options[:phone_number]
+        @mobile_number  = options[:mobile_number]
+        @fax_number     = options[:fax_number]
+        @company        = options[:company]
+        @title          = options[:title]
+        @line_1         = options[:line_1]
+        @line_2         = options[:line_2]
+        @city           = options[:city]
+        @district       = options[:district]
+        @state          = options[:state]
+        @postal_code    = options[:postal_code]
+        @country        = options[:country]
+        @remarks        = options[:remarks]
+      end
+    end
+  end
+end

data/lib/xpost/models/item.rb

@@ -0,0 +1,31 @@
+require 'active_model'
+require 'set'
+
+module Xpost
+  module Models
+    class Item
+      include ActiveModel::Model
+
+      ITEM_TYPES = Set[:product, :shipping, :tax, :fee, :insurance, :discount]
+
+      attr_accessor :type, :description, :amount, :quantity, :metadata
+
+      validates_presence_of :type, :description, :amount
+      validate :check_item_type
+
+      def initialize(options = {})
+        @type         = options[:type]
+        @description  = options[:description]
+        @amount       = options[:amount]
+        @quantity     = options[:quantity]
+        @metadata     = options[:metadata]
+      end
+
+      def check_item_type
+        if self.type.present? && !ITEM_TYPES.include?(self.type.to_sym)
+          errors.add(:type, "wrong item type")
+        end
+      end
+    end
+  end
+end

data/lib/xpost/models/order.rb

@@ -0,0 +1,54 @@
+require 'active_model'
+require 'set'
+
+module Xpost
+  module Models
+    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
+      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]
+        @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 confirmable?
+        self.valid? && self.delivery_address.present?
+      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
+    end
+  end
+end

data/lib/xpost/orders.rb

@@ -6,28 +6,17 @@ 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, 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
+    def self.all(auth_token)
+      all_orders_url = "orders"
 
       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}"
 
@@ -35,7 +24,6 @@ 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}"
 
@@ -43,66 +31,37 @@ module Xpost
       res = res[:message] == "Not Found" ? "Not Found" : { timeline: res[:tat], events: res[:events] }
     end
 
-    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
+    def self.create(auth_token, options = {})
+      raise "Missing order data" if options[:order_data].empty?
 
-      res = post_url("orders", data: order, headers: auth_header(auth_token))
+      create_order_url      = "orders"
+      order_data            = options[:order_data]
+      
+      res = post_url(create_order_url, data: order_data, headers: auth_header(auth_token))
     end
 
-    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"
-
+    def self.confirm(auth_token, tracking_number, payment_reference_id)
       confirm_order_url = "orders/#{tracking_number}/confirm"
 
       res = put_url(confirm_order_url, data: payment_reference_id, headers: auth_header(auth_token))
       res = res[:message] == "Not Found" ? "Not Found" : res
     end
 
-    def self.for_pickup(auth_token, tracking_number, 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 "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.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.get_shipping_labels(auth_token, tracking_number)
-      if tracking_number.kind_of?(Array)
-        shipping_labels_url = "orders/download/awb/zebra"
+    def self.for_pickup(auth_token, tracking_number, pickup_address)
+      pickup_address = Xpost::Models::Address.new(pickup_address)
+      for_pickup_url = "orders/#{tracking_number}/for-pickup"
 
-        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"
+      raise "Invalid address" unless pickup_address.valid?
 
-        res = get_url(shipping_label_url, headers: auth_header(auth_token))
-        res = res[:message] == "Not Found" ? "Not Found" : res
-      end
+      res = put_url(for_pickup_url, data: pickup_address, headers: auth_header(auth_token))
+      res = res[:message] == "Not Found" ? "Not Found" : res
     end
 
     private

data/lib/xpost/version.rb

@@ -1,3 +1,3 @@
 module Xpost
-  VERSION = "0.1.4"
+  VERSION = "0.1.21"
 end

data/spec/factories/addresses.rb

@@ -1,56 +1,38 @@
 FactoryBot.define do
-  factory :address, class: Xpost::Address do
-    name { "Bobby Axelrod" }
-    line_1 { "Axe Capital" }
+  factory :address, class: Xpost::Models::Address do
+    name "Bobby Axelrod"
+    line_1 "Axe Capital"
   end
 
-  factory :required_address, class: Xpost::Address do
-    name { "Bobby Axelrod" }
-    line_1 { "BGC Corporate Centre" }
-    city { "Taguig" }
-    state { "Metro Manila" }
-    postal_code { "1634" }
-    country { "PH" }
+  factory :required_address, class: Xpost::Models::Address do
+    name "Bobby Axelrod"
+    shipment "small-pouch"
+    line_1 "855 Sixth Avenue"
+    city "New York"
+    state "NY"
+    postal_code 10001
+    country "US"
 
     initialize_with { new(attributes) }
   end  
 
-  factory :complete_address, class: Xpost::Address do
-    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" }
-    
-    initialize_with { new(attributes) }
-  end
-
-  factory :complete_address_pickup, class: Xpost::Address do
-    name { "Taylor Mason" }
-    line_1 { "BGC Corporate Centre" }
-    line_2 { "7th floor" }
-    city { "Taguig" }
-    state { "Metro Manila" }
-    postal_code { "1634" }
-    country { "PH" }
-    company { "Taylor Mason Capital" }
-    title { "CEO" }
-    email { "taylor@tmcapital.com" }
-    phone_number { "12345678" }
-    mobile_number { "091712345678" }
-    fax_number { "12345678" }
-    district { "BGC" }
-    remarks { "" }
+  factory :complete_address, class: Xpost::Models::Address do
+    name "Bobby Axelrod"
+    shipment "small-pouch"
+    line_1 "855 Sixth Avenue"
+    city "New York"
+    state "NY"
+    postal_code 10001
+    country "US"
+    company "Axe Capital"
+    title "CEO"
+    email "bobby@axe.com"
+    phone_number "12345678"
+    mobile_number "091712345678"
+    fax_number "12345678"
+    district "Manhattan"
+    line_2 "5th floor"
+    remarks "Send ASAP"
     
     initialize_with { new(attributes) }
   end