janio_api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d175fb1eb0e1a7e19fa09fcda305c1041a5d1872ec8836574907967032aa7b1
-  data.tar.gz: 593aaf0c717b6ef19739f4d3309bdd9336d4c5fcb7047d21560e12e09dde5e4a
+  metadata.gz: 0721ffe6796b2c0d2b0c20a5bf2b6e54b0310e40135d02c72e3c696ff1c8836f
+  data.tar.gz: '00250458c6169e4d52cc7465bd31d0c8df7914c866476127a7d92b9435223137'
 SHA512:
-  metadata.gz: 4523b95ae78228abaf6da00aa50e092846c611a9426cd28868869db75ac73b0fd60dcb1d70df43ab245de4209acd51e95a48db3b27bc41d6746c657a7c5fb045
-  data.tar.gz: 3e2b7d937d7887957f06935936729874b7b101cd8a19c1edd88b3d19b965219ddc25c497c7b667b2c70e55908a6ba43eba851eebe461e59ec72420f20b66148f
+  metadata.gz: 28edeba9d49aa7707bc43b95ed3a29d761fd4ff25b8996c749f3f2f651dc58e43b22940028a722c61060deae7c68849866b26275606be78a0d516ab83030b50b
+  data.tar.gz: c52488a5053b715f4b57659a38ff85bce4ef5c1357fac31d49dc42532f9a8cb513d1404de8e3c9120f84895bbca6c15d19023d8f38da0a67c1fca2ab2f78fde8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    janio_api (0.1.2)
+    janio_api (0.1.3)
       activeresource
 
 GEM

data/README.md

@@ -1,9 +1,5 @@
 # JanioAPI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/janio_api`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,6 +18,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Setup
+
 1. Create a file under the `initializers` folder.
 2. Set the `api_host` and `api_token` as following sample:
    ```ruby
@@ -30,54 +28,91 @@ Or install it yourself as:
      config.api_token = ENV["API_TOKEN"]
    end
    ```
-3. Then you can start creating Janio orders! Here's an example:
 
-```ruby
-attributes={
-  service_id: 1,
-  tracking_no: "TRACKINGNUMBERHTH333ASDA1",
-  shipper_order_id: nil,
-  order_length: 12,
-  order_width: 12,
-  order_height: 12,
-  order_weight: 12,
-  payment_type: "cod",
-  cod_amount_to_collect: 40.5,
-  consignee_name: "Susan",
-  consignee_number: "+6291234567891",
-  consignee_country: "Indonesia",
-  consignee_address: "Pos 5 security komp perumahan PT INALUM tanjung gading., Jln berangin.",
-  consignee_postal: "12420",
-  consignee_state: "Daerah Khusus Ibukota Jakarta",
-  consignee_city: "Jakarta Selatan",
-  consignee_province: "Cilandak",
-  consignee_email: "susan123@email.com",
-  pickup_contact_name: "Jackson",
-  pickup_contact_number: "+6591234567",
-  pickup_country: "Singapore",
-  pickup_address: "Jurong West Ave 1",
-  pickup_postal: "640534",
-  pickup_state: "Singapore State",
-  pickup_city: nil,
-  pickup_province: nil,
-  pickup_date: nil,
-  pickup_notes: nil,
-  items: [
-    {
-      item_desc: "Blue Male T-Shirt",
-      item_quantity: 2,
-      item_product_id: "PROD123",
-      item_sku: "ITEMSKU123",
-      item_category: "Fashion Apparel",
-      item_price_value: 23.5,
-      item_price_currency: "IDR"
-    }
-  ]
-}
-
-order = JanioAPI::Order.new(attributes)
-order.save
-```
+### Creation
+
+1. Here's an example:
+
+   ```ruby
+   attributes={
+     service_id: 1,
+     tracking_no: "TRACKINGNUMBERHTH333ASDA1",
+     shipper_order_id: nil,
+     order_length: 12,
+     order_width: 12,
+     order_height: 12,
+     order_weight: 12,
+     payment_type: "cod",
+     cod_amount_to_collect: 40.5,
+     consignee_name: "Susan",
+     consignee_number: "+6291234567891",
+     consignee_country: "Indonesia",
+     consignee_address: "Pos 5 security komp perumahan PT INALUM tanjung gading., Jln berangin.",
+     consignee_postal: "12420",
+     consignee_state: "Daerah Khusus Ibukota Jakarta",
+     consignee_city: "Jakarta Selatan",
+     consignee_province: "Cilandak",
+     consignee_email: "susan123@email.com",
+     pickup_contact_name: "Jackson",
+     pickup_contact_number: "+6591234567",
+     pickup_country: "Singapore",
+     pickup_address: "Jurong West Ave 1",
+     pickup_postal: "640534",
+     pickup_state: "Singapore State",
+     pickup_city: nil,
+     pickup_province: nil,
+     pickup_date: nil,
+     pickup_notes: nil,
+     items: [
+       {
+         item_desc: "Blue Male T-Shirt",
+         item_quantity: 2,
+         item_product_id: "PROD123",
+         item_sku: "ITEMSKU123",
+         item_category: "Fashion Apparel",
+         item_price_value: 23.5,
+         item_price_currency: "IDR"
+       }
+     ]
+   }
+
+   order = JanioAPI::Order.new(attributes)
+   order.save
+   ```
+
+2. Make sure you use `#valid?` or `#save_with_validation` to catch errors before POST to the server.
+   ```ruby
+     unless order.valid?
+       # handle invalid order
+     end
+
+     #or
+
+     unless order.save_with_validation
+       # handle invalid order
+     end
+   ```
+
+### Tracking
+
+1. You are recommended to use the webhook provided by Janio to capture the latest parcel's status.
+2. You can also track the parcel using the `#track` or `.track([one or more tracking number])`. Examples:
+
+   ```ruby
+     JanioAPI::Order.track(["tracking_no1", "tracking_no2"]) # one or more tracking number
+
+     # or
+
+     JanioAPI::Order.new({tracking_no: "tracking_no1"}).track
+   ```
+
+### Update
+
+- Update is not supported yet
+
+### Deletion
+
+- Deletion is not supported yet
 
 ## Development
 

data/lib/janio_api/resources/item.rb

@@ -0,0 +1,38 @@
+module JanioAPI
+  class Item < Base
+    validates :item_desc, :item_quantity, :item_price_value, :item_price_currency, presence: true
+    validates :item_category, inclusion: ["Fashion Accessories", "Fashion Footwear", "Fashion Apparels (Men)", "Fashion Apparels (Women)",
+                                          "Fashion Apparels (Babies, Toddlers and Children)", "Fashion Apparel", "Electronics",
+                                          "Electronics (Non-Telecommunications)", "Electronics (Telecommunications)", "Lifestyle Products",
+                                          "Lifestyle (Health Related)", "Lifestyle (Beauty Related)", "Lifestyle (Home & Living)",
+                                          "Lifestyle (Hobbies & Collection)", "Lifestyle (Pantry & Packaged Food & Beverages)", "Others", "Printed Matters"]
+
+    class << self
+      def find(*args)
+        raise "JanioAPI::Item cannot be fetched directly, plesase use JanioAPI::Order to fetch the items under the order."
+      end
+
+      def create
+        raise "JanioAPI::Item cannot be created directly, "\
+        "please include it in an JanioAPI::Order to create it under a new JanioAPI::Order."
+      end
+    end
+
+    def initialize(attributes = {}, persisted = false)
+      default_attrs = {
+        item_desc: nil, item_quantity: nil, item_price_value: nil, item_price_currency: nil, item_category: nil
+      }
+      attributes = default_attrs.merge(attributes)
+      super
+    end
+
+    def create
+      self.class.create
+    end
+
+    def update
+      raise "JanioAPI::Item cannot be updated, only creation is supported and "\
+      "please include it in an JanioAPI::Order to create it under a new JanioAPI::Order."
+    end
+  end
+end

data/lib/janio_api/resources/order.rb

@@ -1,16 +1,7 @@
 module JanioAPI
-##
-# See http://apidocs.janio.asia/faq for parameters information
+  ##
+  # See http://apidocs.janio.asia/faq for parameters information
   class Order < Base
-    self.prefix = "/api/order/orders/"
-    self.element_name = ""
-
-    validate :check_api_token
-
-    def check_api_token
-      errors.add(:base, "Please set the api_token in the initializer file") if JanioAPI.config.api_token.blank?
-    end
-
     class Collection < ActiveResource::Collection
       attr_accessor :count, :next, :previous
 
@@ -24,6 +15,31 @@ module JanioAPI
 
     self.collection_parser = Collection
 
+    SUPPORTED_COUNTRIES = ["Australia", "Brunei", "China", "Hong Kong", "Indonesia", "Italy", "Japan", "Malaysia", "Philippines", "Saudi Arabia",
+                           "Singapore", "South Korea", "Spain", "Taiwan", "Thailand", "UAE", "UK", "US", "Vietnam"].freeze
+
+    POSTAL_EXCLUDED_COUNTRIES = ["Hong Kong", "Vietnam"].freeze
+
+    self.prefix = "/api/order/orders/"
+    self.element_name = ""
+
+    has_many :items, class_name: "JanioAPI::Item"
+
+    validates :service_id, :order_length, :order_width, :order_height, :order_weight,
+      :cod_amount_to_collect, :consignee_name, :consignee_number, :consignee_country, :consignee_address, :consignee_state,
+      :consignee_city, :consignee_province, :consignee_email, :pickup_contact_name, :pickup_contact_number, :pickup_country, :pickup_address,
+      :pickup_state, :pickup_city, :pickup_province, :pickup_date, :pickup_notes, presence: true
+
+    validates :pickup_country, :consignee_country, inclusion: SUPPORTED_COUNTRIES
+    validates :pickup_postal, :consignee_postal, presence: true, unless: -> { POSTAL_EXCLUDED_COUNTRIES.include?(consignee_country) }
+    validates :pickup_postal, presence: true, unless: -> { POSTAL_EXCLUDED_COUNTRIES.include?(pickup_country) }
+    validates :payment_type, inclusion: ["cod", "prepaid"]
+    validates :cod_amount_to_collect, presence: true, if: -> { payment_type == "cod" }
+    validates :items, length: {minimum: 1, message: "are required. Please add at least one."}
+
+    validate :check_api_token
+    validate :items_validation
+
     class << self
       def tracking_path
         "/api/tracker/query-by-tracking-nos/"
@@ -70,6 +86,42 @@ module JanioAPI
       end
     end
 
+    def initialize(attributes = {}, persisted = false)
+      default_attrs = {
+        service_id: 1,
+        tracking_no: nil,
+        shipper_order_id: nil,
+        order_length: 12,
+        order_width: 12,
+        order_height: 12,
+        order_weight: 1,
+        payment_type: nil,
+        cod_amount_to_collect: 0,
+        consignee_name: nil,
+        consignee_number: nil,
+        consignee_country: nil,
+        consignee_address: nil,
+        consignee_postal: nil,
+        consignee_state: nil,
+        consignee_city: nil,
+        consignee_province: nil,
+        consignee_email: nil,
+        pickup_contact_name: nil,
+        pickup_contact_number: nil,
+        pickup_country: nil,
+        pickup_address: nil,
+        pickup_postal: nil,
+        pickup_state: nil,
+        pickup_city: nil,
+        pickup_province: nil,
+        pickup_date: nil,
+        pickup_notes: nil,
+        items: nil
+      }
+      attributes = default_attrs.merge(attributes)
+      super
+    end
+
     # Tracks the current order
     #
     # Check http://apidocs.janio.asia/track for more information
@@ -89,6 +141,18 @@ module JanioAPI
       end
     end
 
+    private
+
+    def check_api_token
+      errors.add(:base, "Please set the api_token in the initializer file") if JanioAPI.config.api_token.blank?
+    end
+
+    def items_validation
+      items&.each_with_index do |item, index|
+        item.errors.full_messages.each { |msg| errors.add("item_#{index}".to_sym, msg) } unless item.valid?
+      end
+    end
+
     def create(blocking: true)
       reformat_before_save(blocking)
       super()

data/lib/janio_api/version.rb

@@ -1,3 +1,3 @@
 module JanioAPI
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: janio_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andy Chong
@@ -104,6 +104,7 @@ files:
 - lib/janio_api/connection.rb
 - lib/janio_api/redirect_fetcher.rb
 - lib/janio_api/resources/base.rb
+- lib/janio_api/resources/item.rb
 - lib/janio_api/resources/order.rb
 - lib/janio_api/version.rb
 - lib/zeitwerk_loader.rb