mr_speedy_ruby 1.0.0.pre.alpha.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2156a454d95152c80a1ad9e229193bde625d4f8f75af06f074cbf7425aa60983
+  data.tar.gz: 8c5915a58da4cbb598a99fda9d04b32e3d1900343b540bc6e90b40eafbc2482d
+SHA512:
+  metadata.gz: c72899df3891543bb8c36c025f67674b64a52bcdaeb1e65e4ceef354fb43702fc5918348746a626e6dfd98612693a092317f3c458f376729de5d7c5c2c2479e7
+  data.tar.gz: '0912f29cdacf1375a72bb48562d651b98adeaa1efd891ab535a2be8cfa0b69be055faf335f039d7b70891e637cfb78c52b056d2099673c485b3bc73bdff44ace'

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peterjohn@gorated.ph. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mr_speedy_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    mr_speedy_ruby (1.0.0.pre.alpha.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    awesome_print (1.8.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    minitest (5.14.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    safe_yaml (1.0.5)
+    vcr (5.1.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  mr_speedy_ruby!
+  pry
+  rake (~> 13.0)
+  vcr (~> 5.1.0)
+  webmock (~> 3.8.3)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Peter John Alvarado
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,164 @@
+# MrSpeedyRuby
+[Mr.Speedy](https://mrspeedy.ph/) Api Integration For Ruby and Ruby On Rails
+===
+
+![Travis (.org)](https://img.shields.io/travis/redjoker011/mr_speedy_ruby)
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/redjoker011/mr_speedy_ruby?include_prereleases)
+![Gem](https://img.shields.io/gem/v/mr_speedy_ruby)
+
+[![GitHub license](https://img.shields.io/github/license/redjoker011/mr_speedy_ruby)](https://github.com/redjoker011/mr_speedy_ruby/blob/development/LICENSE.txt)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mr_speedy_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mr_speedy_ruby
+
+## Usage
+This gem will provide service for integrating mr.speedy in your ruby app with
+ease.
+
+### Initialize Client
+We can initialize mr.speedy api client by providing authentication token
+located in our mr.speedy account setting.
+
+```ruby
+MrSpeedyRuby::Client.new(token: "mr-speedy-token")
+```
+
+### Calculate Delivey Fee
+Send request to mr.speedy api for delivery fee calculation by providing delivery
+and pickup details
+
+```ruby
+client = MrSpeedyRuby::Client.new(token: "mr-speedy-token")
+
+# Pickup Location Details Including Contact Person and Package
+pickup = {
+  address: "Capitol Park Homes, 71 Berlin Avenue, Matandang Balara, Quezon City, Metro Manila",
+  contact_person: { name: "Admin One", phone: "639123456789" },
+  packages: []
+}
+
+# Delivery Location Details Including Contact Person and Package
+delivery = {
+  address: "Unit 802, EcoTower, 32nd Street corner 9th Avenue, BGC, Taguig, 1634 Metro Manila",
+  contact_person: { name: "Admin One", phone: "639123456789" },
+  packages: []
+}
+
+# Additional Parameters
+options = { matter: "Food" }
+
+client.calculate_fees(delivery: delivery, pickup: pickup, opts: options, sandbox: true)
+```
+
+Theres so many things happening here first we initialize our client by providing
+token , then we pass delivery details as separate entity from options so we can
+easily validate required delivery details parameter. We also pass additional
+required parameter `matter` which indicates parcel type and lastly we call
+`MrSpeedyRuby::Client#calculate_fees` to send request for delivery fee
+calculation to mr.speedy api.
+
+Also note we pass `sandbox` parameter with true value to indicate that we want
+to make a request on mr.speedy sandbox server.
+
+##### Note:
+
+[Order Price Calculation](https://apitest.mrspeedy.ph/business-api/doc#calculate-order) parameters can also be passed as options.
+
+[Delivery Details](https://apitest.mrspeedy.ph/business-api/doc#calculate-order) can also be passed along pickup/delivery params.
+
+By default we set `MOTORBIKE` as default vehicle unless you pass `vehicle_type_id` as option for `opts`.
+
+### Placing an Order
+Send request to mr.speedy api to create order.
+
+```ruby
+client = MrSpeedyRuby::Client.new(token: "mr-speedy-token")
+
+# Pickup Location Details Including Contact Person and Package
+pickup = {
+  address: "Capitol Park Homes, 71 Berlin Avenue, Matandang Balara, Quezon City, Metro Manila",
+  contact_person: { name: "Admin One", phone: "639277876287" },
+  packages: []
+}
+
+# Delivery Location Details Including Contact Person and Package
+delivery = {
+  address: "Unit 802, EcoTower, 32nd Street corner 9th Avenue, BGC, Taguig, 1634 Metro Manila",
+  contact_person: { name: "Admin One", phone: "639277876287" },
+  packages: []
+}
+
+# Additional Parameters
+options = { matter: "Food" }
+
+client.place_order(delivery: delivery, pickup: pickup, opts: options, sandbox: true)
+```
+Like `delivery fee calculation` we also do the same steps and pass the exact
+parameter to ensure that we have the same `delivery fee`, We also set `sandbox`
+parameter to true to test our implementation against sandbox server.
+
+##### Note:
+
+[Order Creation](https://apitest.mrspeedy.ph/business-api/doc#create-order) parameters can also be passed as options.
+
+[Delivery Details](https://apitest.mrspeedy.ph/business-api/doc#create-order) can also be passed along pickup/delivery params.
+
+By default we set `MOTORBIKE` as default vehicle unless you pass `vehicle_type_id` as option for `opts`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+### Features
+
+- [x] Delivery Fee Calculation
+- [x] Create Order
+- [ ] Update Order
+- [ ] Cancel Order
+- [ ] Order List
+- [ ] Courier Info and Location Tracker
+- [ ] Create Draft Deliveries
+- [ ] Update Draft Deliveries
+- [ ] Draft Delivery Deletion
+- [ ] Draft Delivery List
+- [ ] API Setting Update
+- [ ] Request Error Handling
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MrSpeedyRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/redjoker011/mr_speedy_ruby/blob/master/CODE_OF_CONDUCT.md).
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/redjoker011/mr_speedy_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Contributors
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/redjoker011"><img src="https://avatars2.githubusercontent.com/u/22144212?v=4" width="100px;" alt=""/><br /><sub><b>Peter John Alvarado</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/cjbmartinez"><img src="https://avatars2.githubusercontent.com/u/34258568?v=4" width="100px;" alt=""/><br /><sub><b>Charles Martinez</b></sub></a><br /></td>
+  </tr>
+</table>
+
+<!-- ALL-CONTRIBUTORS-LIST:END - Do not remove or modify this section -->

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mr_speedy_ruby"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fixtures/vcr_cassettes/delivery_fee.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://robotapitest.mrspeedy.ph/api/business/1.1/calculate-order
+    body:
+      encoding: UTF-8
+      string: '{"matter":"Food","vehicle_type_id":8,"points":[{"address":"Capitol
+        Park Homes, 71 Berlin Avenue, Matandang Balara, Quezon City, Metro Manila","contact_person":{"name":"Merchant","phone":"639123456789"},"packages":[]},{"address":"Unit
+        802, EcoTower, 32nd Street corner 9th Avenue, BGC, Taguig, 1634 Metro Manila","contact_person":{"name":"Reciever","phone":"639123456789"},"packages":[]}]}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - robotapitest.mrspeedy.ph
+      X-Dv-Auth-Token:
+      - 70B4ABCA8A35AC50E1585E27F217DF160F740D46
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 12 May 2020 13:22:18 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - DENY
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block;
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+    body:
+      encoding: ASCII-8BIT
+      string: '{"is_successful":true,"order":{"order_id":null,"order_name":null,"vehicle_type_id":8,"created_datetime":"2020-05-12T21:22:18+08:00","finish_datetime":null,"status":null,"matter":"Food","total_weight_kg":0,"is_client_notification_enabled":false,"is_contact_person_notification_enabled":false,"loaders_count":0,"backpayment_details":null,"points":[{"point_type":"plain","point_id":null,"client_order_id":null,"address":"Zurich
+        Ave, Matandang Balara, Quezon City, Metro Manila, Philippines","latitude":"14.6710069","longitude":"121.0944076","required_start_datetime":"2020-05-12T21:22:18+08:00","required_finish_datetime":"2020-05-12T22:30:00+08:00","arrival_start_datetime":null,"arrival_finish_datetime":null,"courier_visit_datetime":null,"contact_person":{"name":"Merchant","phone":"639123456789"},"taking_amount":"0.00","buyout_amount":"0.00","note":null,"packages":[],"is_cod_cash_voucher_required":false,"is_order_payment_here":false,"building_number":null,"entrance_number":null,"intercom_code":null,"floor_number":null,"apartment_number":null,"invisible_mile_navigation_instructions":null},{"point_type":"plain","point_id":null,"client_order_id":null,"address":"32nd
+        St. cor. 9th Ave, Taguig, Metro Manila, 32nd St, Taguig, Metro Manila, Philippines","latitude":"14.5528233","longitude":"121.0519364","required_start_datetime":"2020-05-12T21:22:18+08:00","required_finish_datetime":"2020-05-12T23:00:00+08:00","arrival_start_datetime":null,"arrival_finish_datetime":null,"courier_visit_datetime":null,"contact_person":{"name":"Reciever","phone":"639123456789"},"taking_amount":"0.00","buyout_amount":"0.00","note":null,"packages":[],"is_cod_cash_voucher_required":false,"is_order_payment_here":false,"building_number":null,"entrance_number":null,"intercom_code":null,"floor_number":null,"apartment_number":null,"invisible_mile_navigation_instructions":null}],"payment_amount":"170.00","delivery_fee_amount":"170.00","intercity_delivery_fee_amount":"0.00","weight_fee_amount":"0.00","insurance_amount":"0.00","insurance_fee_amount":"0.00","loading_fee_amount":"0.00","money_transfer_fee_amount":"0.00","suburban_delivery_fee_amount":"0.00","overnight_fee_amount":"0.00","discount_amount":"0.00","backpayment_amount":"0.00","cod_fee_amount":"0.00","backpayment_photo_url":null,"itinerary_document_url":null,"waybill_document_url":null,"courier":null,"is_motobox_required":false},"warnings":[],"parameter_warnings":null}'
+    http_version: null
+  recorded_at: Tue, 12 May 2020 13:22:19 GMT
+recorded_with: VCR 5.1.0

data/fixtures/vcr_cassettes/place_order.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://robotapitest.mrspeedy.ph/api/business/1.1/create-order
+    body:
+      encoding: UTF-8
+      string: '{"matter":"Food","vehicle_type_id":8,"points":[{"address":"Capitol
+        Park Homes, 71 Berlin Avenue, Matandang Balara, Quezon City, Metro Manila","contact_person":{"name":"Merchant","phone":"639123456789"},"packages":[]},{"address":"Unit
+        802, EcoTower, 32nd Street corner 9th Avenue, BGC, Taguig, 1634 Metro Manila","contact_person":{"name":"Reciever","phone":"639123456789"},"packages":[]}]}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - robotapitest.mrspeedy.ph
+      X-Dv-Auth-Token:
+      - 70B4ABCA8A35AC50E1585E27F217DF160F740D46
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 12 May 2020 13:22:21 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      X-Frame-Options:
+      - DENY
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block;
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+    body:
+      encoding: ASCII-8BIT
+      string: '{"is_successful":true,"order":{"order_id":77802,"order_name":"77802","vehicle_type_id":8,"created_datetime":"2020-05-12T21:22:21+08:00","finish_datetime":null,"status":"new","matter":"Food","total_weight_kg":0,"is_client_notification_enabled":false,"is_contact_person_notification_enabled":false,"loaders_count":0,"backpayment_details":null,"points":[{"point_type":"plain","point_id":203156,"client_order_id":null,"address":"Zurich
+        Ave, Matandang Balara, Quezon City, Metro Manila, Philippines","latitude":"14.6710069","longitude":"121.0944076","required_start_datetime":"2020-05-12T21:22:21+08:00","required_finish_datetime":"2020-05-12T22:30:00+08:00","arrival_start_datetime":null,"arrival_finish_datetime":null,"courier_visit_datetime":null,"contact_person":{"name":"Merchant","phone":"639123456789"},"taking_amount":"0.00","buyout_amount":"0.00","note":null,"packages":[],"is_cod_cash_voucher_required":false,"is_order_payment_here":false,"building_number":null,"entrance_number":null,"intercom_code":null,"floor_number":null,"apartment_number":null,"invisible_mile_navigation_instructions":null},{"point_type":"plain","point_id":203157,"client_order_id":null,"address":"32nd
+        St. cor. 9th Ave, Taguig, Metro Manila, 32nd St, Taguig, Metro Manila, Philippines","latitude":"14.5528233","longitude":"121.0519364","required_start_datetime":"2020-05-12T21:22:21+08:00","required_finish_datetime":"2020-05-12T23:00:00+08:00","arrival_start_datetime":null,"arrival_finish_datetime":null,"courier_visit_datetime":null,"contact_person":{"name":"Reciever","phone":"639123456789"},"taking_amount":"0.00","buyout_amount":"0.00","note":null,"packages":[],"is_cod_cash_voucher_required":false,"is_order_payment_here":false,"building_number":null,"entrance_number":null,"intercom_code":null,"floor_number":null,"apartment_number":null,"invisible_mile_navigation_instructions":null}],"payment_amount":"170.00","delivery_fee_amount":"170.00","intercity_delivery_fee_amount":"0.00","weight_fee_amount":"0.00","insurance_amount":"0.00","insurance_fee_amount":"0.00","loading_fee_amount":"0.00","money_transfer_fee_amount":"0.00","suburban_delivery_fee_amount":"0.00","overnight_fee_amount":"0.00","discount_amount":"0.00","backpayment_amount":"0.00","cod_fee_amount":"0.00","backpayment_photo_url":null,"itinerary_document_url":null,"waybill_document_url":null,"courier":null,"is_motobox_required":false}}'
+    http_version: null
+  recorded_at: Tue, 12 May 2020 13:22:21 GMT
+recorded_with: VCR 5.1.0

data/lib/mr_speedy_ruby.rb

@@ -0,0 +1,7 @@
+require "mr_speedy_ruby/version"
+require "mr_speedy_ruby/client"
+
+# Mr Speedy Namespace Module
+module MrSpeedyRuby
+  class Error < StandardError; end
+end

data/lib/mr_speedy_ruby/base.rb

@@ -0,0 +1,72 @@
+module MrSpeedyRuby
+  # Mr Speedy Abstract Class
+  # @since 0.1.0
+  class Base
+    require "net/http"
+    require "uri"
+    require "json"
+
+    AUTH_TOKEN_HEADER="X-DV-Auth-Token".freeze
+    PRODUCTION_BASE_URL="http://robot.mrspeedy.ph".freeze
+    STAGING_BASE_URL="https://robotapitest.mrspeedy.ph".freeze
+
+    # Endpoint Generator
+    # @since v0.1.0
+    #
+    # @private
+    #
+    # @param [String] endpoint request endpoint
+    # @param [Boolean] sandbox sandbox environment indicator
+    #
+    # @return [String] request endpoint
+    def build_url(endpoint, sandbox)
+      base_url = sandbox ? STAGING_BASE_URL : PRODUCTION_BASE_URL
+      base_url + endpoint
+    end
+
+    # Send Post Request
+    # @since v0.1.0
+    # @param endpoint [String] request endpoint
+    # @param token [String] app token
+    # @param payload [Hash] message payload
+    #
+    # @return [Json] response
+    def post(endpoint:, token:, payload:)
+      response = send_request("post", endpoint, token, payload)
+
+      response_body = JSON.parse(response.body)
+      response_body
+    end
+
+    private
+
+    # Request sender
+    # @since v0.1.0
+    #
+    # @private
+    #
+    # @param endpoint [String] request endpoint
+    # @param token [String] app token
+    # @param payload [Hash] message payload
+    #
+    # @return [Json] request response
+    def send_request(method, endpoint, token, payload)
+      uri = URI.parse(endpoint)
+
+      request = if method == "post"
+                  Net::HTTP::Post.new(uri)
+                else
+                  Net::HTTP::Get.new(uri)
+                end
+
+      request.add_field(AUTH_TOKEN_HEADER, token)
+
+      request.body = JSON.dump payload
+      options = { use_ssl: uri.scheme == "https" }
+
+      Net::HTTP.start(uri.hostname, uri.port, options) do |http|
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/mr_speedy_ruby/client.rb

@@ -0,0 +1,164 @@
+require "mr_speedy_ruby/base"
+require "mr_speedy_ruby/lib/hash_refinement"
+
+module MrSpeedyRuby
+  # Mr Speedy API Client
+  # @since 0.1.0
+  class Client < Base
+    using MrSpeedyRuby::Lib::HashRefinement
+    # Vehicle Types
+    # @see https://apitest.mrspeedy.ph/business-api/doc#vehicle-types
+    CAR       = 7.freeze
+    MOTORBIKE = 8.freeze
+
+    # @attr_reader [String] token authentication token
+    # @attr_reader [String] version api version
+    attr_reader :token, :version
+
+    def initialize(token:, version: "1.1")
+      @token = token
+      @version = version
+    end
+
+    # Delivery Fee Calculation
+    # @since 0.1.0
+    #
+    # @param [Hash] pickup pickup location
+    # @param pickup [String] :address delivery parcel pickup address
+    # @param pickup [Hash] :contact_person delivery parcel pickup contact person
+    # details
+    # @param contact_person [String] :name delivery parcel pickup contact person
+    #   name
+    # @param contact_person [String] :phone delivery parcel pickup contact person
+    # contact details(required)
+    #
+    # @param [Hash] delivery location
+    # @param delivery [String] :address delivery parcel address
+    # @param delivery [Hash] :contact_person delivery parcel contact person details
+    # @param contact_person [String] :name delivery parcel contact person name
+    # @param contact_person [String] :phone delivery parcel contact person
+    # contact details(required)
+    #
+    # @param [Hash] opts additional details
+    # @param opts [String] :matter delivery parcel type
+    #
+    # @param [Boolean] sandbox sandbox identifier(default false)
+    #
+    # @see https://apitest.mrspeedy.ph/business-api/doc#calculate-order
+    def calculate_fees(pickup:, delivery:, opts: {}, sandbox: false)
+      validate_delivery(details: pickup)
+      validate_delivery(details: delivery)
+
+      opts.deep_symbolize_keys.assert_required_keys(option_keys)
+
+      endpoint = "/api/business/#{version}/calculate-order"
+      url = build_url(endpoint, sandbox)
+      payload = build_payload(opts: opts, pickup: pickup, delivery: delivery)
+
+      post(endpoint: url, token: @token, payload: payload)
+    end
+
+    # Place Order
+    # @since 0.1.0
+    #
+    # @param [Hash] pickup pickup location
+    # @param pickup [String] :address delivery parcel pickup address
+    # @param pickup [Hash] :contact_person delivery parcel pickup contact person
+    # details
+    # @param contact_person [String] :name delivery parcel pickup contact person
+    #   name
+    # @param contact_person [String] :phone delivery parcel pickup contact person
+    # contact details(required)
+    #
+    # @param [Hash] delivery location
+    # @param delivery [String] :address delivery parcel address
+    # @param delivery [Hash] :contact_person delivery parcel contact person details
+    # @param contact_person [String] :name delivery parcel contact person name
+    # @param contact_person [String] :phone delivery parcel contact person
+    # contact details(required)
+    #
+    # @param [Hash] opts additional details
+    # @param opts [String] :matter delivery parcel type
+    #
+    # @param [Boolean] sandbox sandbox identifier(default false)
+    #
+    # @see https://apitest.mrspeedy.ph/business-api/doc#create-order
+    def place_order(pickup:, delivery:, opts: {}, sandbox: false)
+      validate_delivery(details: pickup)
+      validate_delivery(details: delivery)
+
+      opts.deep_symbolize_keys.assert_required_keys(option_keys)
+
+      endpoint = "/api/business/#{version}/create-order"
+      url = build_url(endpoint, sandbox)
+      payload = build_payload(opts: opts, pickup: pickup, delivery: delivery)
+
+      post(endpoint: url, token: @token, payload: payload)
+    end
+
+    private
+
+    # Options Required Keys
+    # @since 0.1.0
+    #
+    # @private
+    #
+    # @return [Array<String>]
+    def option_keys
+      %i[matter]
+    end
+
+    # Points Required Keys
+    #
+    # @private
+    #
+    # @return [Array<String>]
+    def points_keys
+      %i[packages]
+    end
+
+    # Contact Person Required Keys
+    # @since 0.1.0
+    #
+    # @private
+    #
+    # @return [Array<String>]
+    def contact_person_keys
+      %i[phone]
+    end
+
+    # Package Required Keys
+    #
+    # @private
+    #
+    # @return [Array<String>]
+    def package_keys
+      %i[ware_code description items_count item_payment_amount]
+    end
+
+    # Delivery Details Validator
+    # @since 0.1.0
+    #
+    # @private
+    def validate_delivery(details:)
+      delivery_details = details.deep_symbolize_keys
+      delivery_details.assert_required_keys(points_keys)
+      delivery_details[:contact_person].to_h.assert_required_keys(contact_person_keys)
+    end
+
+    # Payload Builder
+    # @since 0.1.0
+    #
+    # @private
+    #
+    # @return [Hash]
+    def build_payload(opts:, pickup:, delivery:)
+      # Set MOTORBIKE as default vehicle
+      vehicle = opts[:vehicle_type_id] || MOTORBIKE
+      opts.merge({
+        vehicle_type_id: vehicle,
+        points: [pickup, delivery]
+      })
+    end
+  end
+end

data/lib/mr_speedy_ruby/lib/hash_refinement.rb

@@ -0,0 +1,39 @@
+module MrSpeedyRuby
+  module Lib
+    # Hash Module Refinement
+    # https://medium.com/rubycademy/refine-and-using-methods-in-ruby-part-i-2aef6d7a4325
+    module HashRefinement
+      extend self
+
+      def symbolize_recursive(hash)
+        {}.tap do |h|
+          hash.each { |key, value| h[key.to_sym] = transform(value) }
+        end
+      end
+
+      private
+
+      def transform(thing)
+        case thing
+        when Hash; symbolize_recursive(thing)
+        when Array; thing.map { |v| transform(v) }
+        else; thing
+        end
+      end
+
+      refine Hash do
+        def deep_symbolize_keys
+          HashRefinement.symbolize_recursive(self)
+        end
+
+        # Ensure Hash parameters are completed
+        # https://coderwall.com/p/ne7owq/validating-hash-params-in-ruby
+        def assert_required_keys(*keys)
+          keys.flatten.each do |key|
+            raise ArgumentError, "Required key: #{key.inspect}" unless key?(key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mr_speedy_ruby/version.rb

@@ -0,0 +1,3 @@
+module MrSpeedyRuby
+  VERSION = "1.0.0-alpha.2"
+end

data/mr_speedy_ruby.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mr_speedy_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mr_speedy_ruby"
+  spec.version       = MrSpeedyRuby::VERSION
+  spec.authors       = ["Peter John Alvarado"]
+  spec.email         = ["peterjohn@gorated.ph"]
+
+  spec.summary       = "Mr.speedy api integration for ruby"
+  spec.description   = "Provides services for integrating mr.speedy in your app"
+  spec.homepage      = "https://github.com/redjoker011/mr_speedy_ruby"
+  spec.license       = "MIT"
+  spec.extra_rdoc_files = Dir["README.md", "CHANGELOG.md", "LICENSE.txt"]
+  spec.rdoc_options += [
+    "--title", "MrSpeedyRuby - mr.speedy api integration for ruby",
+    "--main", "README.md",
+    "--line-numbers",
+    "--inline-source",
+    "--quiet"
+  ]
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/redjoker011/mr_speedy_ruby"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr", "~> 5.1.0"
+  spec.add_development_dependency "webmock", "~> 3.8.3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "awesome_print"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: mr_speedy_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha.2
+platform: ruby
+authors:
+- Peter John Alvarado
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides services for integrating mr.speedy in your app
+email:
+- peterjohn@gorated.ph
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/delivery_fee.yml
+- fixtures/vcr_cassettes/place_order.yml
+- lib/mr_speedy_ruby.rb
+- lib/mr_speedy_ruby/base.rb
+- lib/mr_speedy_ruby/client.rb
+- lib/mr_speedy_ruby/lib/hash_refinement.rb
+- lib/mr_speedy_ruby/version.rb
+- mr_speedy_ruby.gemspec
+homepage: https://github.com/redjoker011/mr_speedy_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/redjoker011/mr_speedy_ruby
+  source_code_uri: https://github.com/redjoker011/mr_speedy_ruby
+post_install_message: 
+rdoc_options:
+- "--title"
+- MrSpeedyRuby - mr.speedy api integration for ruby
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Mr.speedy api integration for ruby
+test_files: []