janio_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6563c2fcc213efcc5814f62dc6f7d710a8d4d686519c2bfc2a31879f55df06fd
-  data.tar.gz: e079a825f69e71d7a8bacc2724e01df367836707c3cec657ac23a5e4d6778e81
+  metadata.gz: aa093e0f5ad7e07588aaf0c058fea09ef6ee4fbfa7e44044557e0fa313dc15cd
+  data.tar.gz: da73f1b6206dc12d175a71fbf6c73b43562eb4ec0c99b36dd5579c8bebf35863
 SHA512:
-  metadata.gz: 074abb6b51f02c06a2682b0b0907a76030550871fd0e3461eda9c71cbd46ae1ebbe5fe819edf934bbd85f228e308e9a0374a33c8b35a11f02b44f230f11b8623
-  data.tar.gz: d2e9ad3547f786c0a6353fa6b7353a8d8dd0898d2dcce38df9e69043fa4dbe6e058dc0a3e257873a29d5d7b1f474e14eacc52a51f140d27f5fa0b2fca5997951
+  metadata.gz: 934f2a7a98afd7dec8d84212fb4233484c7f31521812e4b2ca2e91060dff3f87a35f49c35e60b73f103de6257accaaafab0f079978f3809534f19fad2a4b3f3f
+  data.tar.gz: 569852e237c4db83f14c3092604ecfd27f1edd01aef5ac72ec93ed3021c810c816167c19bb2bf3bb25aeb7f4bd867afa7a86e463bcc85ced8696343f94f1fbe1

data/.github/workflows/rspec.yml

@@ -0,0 +1,42 @@
+name: Rspec
+
+on: [push]
+
+env:
+  POSTGRES_USER: postgres
+  POSTGRES_PASSWORD: "postgres"
+  POSTGRES_DB: "postco_test"
+
+jobs:
+  rspec:
+    name: Rspec
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.5", "2.6", "2.7"]
+    steps:
+      - name: Checkout to repo
+        uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Cache ruby gems
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+
+      - name: Build gem
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run rspec tests
+        run: |
+          bundle exec rspec spec

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    janio_api (0.2.0)
+    janio_api (0.2.1)
       activeresource
+      countries
+      phonelib
 
 GEM
   remote: https://rubygems.org/
@@ -27,12 +29,42 @@ GEM
     byebug (11.1.1)
     coderay (1.1.2)
     concurrent-ruby (1.1.6)
+    countries (3.0.0)
+      i18n_data (~> 0.8.0)
+      sixarm_ruby_unaccent (~> 1.1)
+      unicode_utils (~> 1.4)
     diff-lcs (1.3)
     dotenv (2.7.5)
+    ffi (1.12.2)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
+    i18n_data (0.8.0)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.4)
     method_source (1.0.0)
     minitest (5.14.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    phonelib (0.6.43)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -40,6 +72,9 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rake (12.3.3)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -53,9 +88,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    shellany (0.0.1)
+    sixarm_ruby_unaccent (1.2.0)
+    thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    unicode_utils (1.4.0)
     zeitwerk (2.3.0)
 
 PLATFORMS
@@ -63,6 +102,7 @@ PLATFORMS
 
 DEPENDENCIES
   dotenv
+  guard-rspec
   janio_api!
   pry
   pry-byebug

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/bin/console

@@ -1,14 +1,18 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require "dotenv/load"
+require "dev/zeitwerk_loader"
+require "dev/config"
 require "janio_api"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
-require "dev/config"
+set_config
 
 # (If you use this, don't forget to add pry to your Gemfile!)
 require "pry"
+require "pry-byebug"
 Pry.start
 
 # require "irb"

data/bin/setup

@@ -8,10 +8,8 @@ bundle install
 # Do any other automated setup that you need to do here
 
 filename=".env"
-if [ ! -f $filename ]
-then
+if [ ! -f $filename ]; then
     touch $filename
-    echo "API_HOST=https://janio-api-int.herokuapp.com" >> $filename
-    echo "API_TOKEN=" >> $filename
-    echo "JANIO_API_GEM_ENV=development" >> $filename
-fi
+    echo "API_HOST=https://janio-api-int.herokuapp.com" >>$filename
+    echo "API_TOKEN=" >>$filename
+fi

data/janio_api.gemspec

@@ -27,9 +27,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activeresource"
+  spec.add_dependency "countries"
+  spec.add_dependency "phonelib"
 
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "guard-rspec"
 end

data/lib/dev/config.rb

@@ -1,7 +1,8 @@
+require "dotenv/load"
+
 def set_config
   JanioAPI.configure do |config|
     config.api_host = ENV["API_HOST"]
     config.api_token = ENV["API_TOKEN"]
   end
 end
-set_config

data/lib/dev/zeitwerk_loader.rb

@@ -1,11 +1,15 @@
 require "zeitwerk"
+require_relative "config"
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
   "janio_api" => "JanioAPI"
 )
+loader.push_dir("./lib")
 loader.collapse("./lib/janio_api/resources")
 loader.ignore("#{__dir__}/config.rb")
+loader.ignore("./lib/janio_api/exceptions.rb")
+loader.ignore("./lib/janio_api/services_list.rb")
 loader.enable_reloading
 # loader.log!
 loader.setup

data/lib/janio_api/connection.rb

@@ -17,36 +17,5 @@ module JanioAPI
     rescue OpenSSL::SSL::SSLError => e
       raise SSLError.new(e.message)
     end
-
-    private
-
-    def handle_response(response)
-      case response.code.to_i
-      when 200...400
-        response
-      when 400
-        raise(BadRequest.new(response))
-      when 401
-        raise(UnauthorizedAccess.new(response))
-      when 403
-        raise(ForbiddenAccess.new(response))
-      when 404
-        raise(ResourceNotFound.new(response))
-      when 405
-        raise(MethodNotAllowed.new(response))
-      when 409
-        raise(ResourceConflict.new(response))
-      when 410
-        raise(ResourceGone.new(response))
-      when 422
-        raise(ResourceInvalid.new(response))
-      when 401...500
-        raise(ClientError.new(response))
-      when 500...600
-        raise(ServerError.new(response))
-      else
-        raise(ConnectionError.new(response, "Unknown response code: #{response.code}"))
-      end
-    end
   end
 end

data/lib/janio_api/resources/order.rb

@@ -15,69 +15,70 @@ module JanioAPI
 
     self.collection_parser = Collection
 
-    SUPPORTED_PICKUP_COUNTRIES = ["Singapore", "China", "Hong Kong", "Indonesia", "Malaysia", "Philippines", "Thailand"].freeze
-    SUPPORTED_CONSIGNEE_COUNTRIES = ["Indonesia", "Singapore", "Thailand", "Malaysia", "Philippines", "China", "Hong Kong", "Taiwan", "Brunei", "South Korea", "Japan", "Vietnam"].freeze
+    SUPPORTED_PICKUP_COUNTRIES = SERVICES.map { |s| s[:pickup_country] }.uniq.freeze
+    SUPPORTED_CONSIGNEE_COUNTRIES = SERVICES.map { |s| s[:consignee_country] }.uniq.freeze
 
     POSTAL_EXCLUDED_COUNTRIES = ["Hong Kong", "Vietnam", "Brunei"].freeze
     VALID_PAYMENT_TYPES = ["cod", "prepaid"].freeze
 
-    SERVICE_ID_MAP = [
-      {id: 1, from: "Singapore", to: "Indonesia"},
-      {id: 6, from: "China", to: "Indonesia"},
-      {id: 5, from: "China", to: "Singapore"},
-      {id: 7, from: "China", to: "Thailand"},
-      {id: 11, from: "Hong Kong", to: "Indonesia"},
-      {id: 37, from: "Hong Kong", to: "Malaysia"},
-      {id: 33, from: "Hong Kong", to: "Philippines"},
-      {id: 13, from: "Hong Kong", to: "Singapore"},
-      {id: 12, from: "Hong Kong", to: "Thailand"},
-      {id: 41, from: "Indonesia", to: "China"},
-      {id: 41, from: "Indonesia", to: "Hong Kong"},
-      {id: 41, from: "Indonesia", to: "Taiwan"},
-      {id: 41, from: "Indonesia", to: "Brunei"},
-      {id: 41, from: "Indonesia", to: "Philippines"},
-      {id: 41, from: "Indonesia", to: "Malaysia"},
-      {id: 3, from: "Indonesia", to: "Indonesia"},
-      {id: 47, from: "Indonesia", to: "Philippines"},
-      {id: 54, from: "Indonesia", to: "Philippines"},
-      {id: 20, from: "Indonesia", to: "Singapore"},
-      {id: 48, from: "Indonesia", to: "Singapore"},
-      {id: 22, from: "Indonesia", to: "South Korea"},
-      {id: 22, from: "Indonesia", to: "Japan"},
-      {id: 22, from: "Indonesia", to: "Vietnam"},
-      {id: 4, from: "Malaysia", to: "Indonesia"},
-      {id: 40, from: "Malaysia", to: "Malaysia"},
-      {id: 36, from: "Philippines", to: "Philippines"},
-      {id: 2, from: "Singapore", to: "China"},
-      {id: 2, from: "Singapore", to: "Taiwan"},
-      {id: 2, from: "Singapore", to: "South Korea"},
-      {id: 2, from: "Singapore", to: "Brunei"},
-      {id: 2, from: "Singapore", to: "Vietnam"},
-      {id: 2, from: "Singapore", to: "Hong Kong"},
-      {id: 2, from: "Singapore", to: "Japan"},
-      {id: 26, from: "Singapore", to: "Malaysia"},
-      {id: 10, from: "Singapore", to: "Singapore"},
-      {id: 17, from: "Singapore", to: "Thailand"},
-      {id: 34, from: "Thailand", to: "Indonesia"},
-      {id: 35, from: "Thailand", to: "Singapore"}
-    ].freeze
-
+    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
+    }
     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_email, :pickup_contact_name, :pickup_contact_number, :pickup_country, :pickup_address,
-      :pickup_state, :pickup_date, presence: true
-
-    validates :pickup_country, inclusion: {in: SUPPORTED_PICKUP_COUNTRIES, message: "%{value} is not a supported pickup country, supported countries are #{SUPPORTED_PICKUP_COUNTRIES.join(", ")}"}
-    validates :consignee_country, inclusion: {in: SUPPORTED_CONSIGNEE_COUNTRIES, message: "%{value} is not a supported consignee country, supported countries are #{SUPPORTED_CONSIGNEE_COUNTRIES.join(", ")}"}
-    validates :pickup_postal, :consignee_postal, presence: true, unless: -> { POSTAL_EXCLUDED_COUNTRIES.include?(consignee_country) }
+    validates :service_id, :order_length, :order_width, :order_height, :order_weight,
+      :consignee_name, :consignee_country, :consignee_address, :consignee_state, :consignee_email,
+      :pickup_contact_name, :pickup_country, :pickup_address, :pickup_state, :pickup_date, presence: true
+
+    validates :pickup_country, inclusion: {
+      in: SUPPORTED_PICKUP_COUNTRIES,
+      message: "%{value} is not a supported pickup country, supported countries are #{SUPPORTED_PICKUP_COUNTRIES.join(", ")}"
+    }
+    validates :consignee_country, inclusion: {
+      in: SUPPORTED_CONSIGNEE_COUNTRIES,
+      message: "%{value} is not a supported consignee country, supported countries are #{SUPPORTED_CONSIGNEE_COUNTRIES.join(", ")}"
+    }
+    validates :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: {in: VALID_PAYMENT_TYPES, message: "%{value} is not a valid payment type, valid payment types are #{VALID_PAYMENT_TYPES.join(", ")}"}
+    validates :payment_type, inclusion: {
+      in: VALID_PAYMENT_TYPES,
+      message: "%{value} is not a valid payment type, valid payment types are #{VALID_PAYMENT_TYPES.join(", ")}"
+    }
     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 :pickup_contact_number_country_matched?
+    validate :consignee_number_country_matched?
     validate :items_validation
     validate :route_supported?
 
@@ -95,8 +96,8 @@ module JanioAPI
         options = arguments.slice!(0) || {}
         options[:from] = "/api/order/order" unless options[:from]
         options[:params] = {} unless options[:params]
-        options[:params][:secret_key] = JanioAPI.config.api_token
         options[:params][:with_items] = true unless options[:params][:with_items]
+        options[:params][:secret_key] = JanioAPI.config.api_token
 
         case scope
         when :all
@@ -128,48 +129,22 @@ module JanioAPI
     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)
+      attributes = DEFAULT_ATTRS.merge(attributes)
       super
       set_service_id
     end
 
-    def get_service_id
-      SERVICE_ID_MAP.find { |route| route[:from] == pickup_country && route[:to] == consignee_country }&.dig(:id)
+    def get_service_id(service_category = "pickup")
+      # only check with services offering pickup by default
+      SERVICES.find do |s|
+        s[:pickup_country] == pickup_country &&
+          s[:consignee_country] == consignee_country &&
+          s[:service_category] == service_category
+      end&.dig(:id)
     end
 
-    def set_service_id
-      @attributes[:service_id] = get_service_id
+    def set_service_id(service_category = "pickup")
+      @attributes[:service_id] = get_service_id(service_category)
     end
 
     # Tracks the current order
@@ -193,6 +168,26 @@ module JanioAPI
 
     private
 
+    def pickup_contact_number_country_matched?
+      country_code = ISO3166::Country.find_country_by_name(pickup_country)&.alpha2
+      if Phonelib.invalid_for_country? pickup_contact_number, country_code
+        errors.add(
+          :pickup_contact_number,
+          "is invalid, please make sure the phone's country code matches the pickup address's country"
+        )
+      end
+    end
+
+    def consignee_number_country_matched?
+      country_code = ISO3166::Country.find_country_by_name(consignee_country)&.alpha2
+      if Phonelib.invalid_for_country? consignee_number, country_code
+        errors.add(
+          :consignee_number,
+          "is invalid, please make sure the phone's country code matches the consignee address's country"
+        )
+      end
+    end
+
     def route_supported?
       unless set_service_id
         errors.add(:route, "not supported, if new route not available in service_id_map, please contact gem author.")