xpanse_2go 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2bb3ad624fd1ac78537bd27941ffbc833f548c6cc866886bbe0af779557bbb1
+  data.tar.gz: b6fad2e2148e7e4f6b841ccc25ded1fc6396d9c8564e291c61ad0716b71a688d
+SHA512:
+  metadata.gz: 837a6c97a2d16104c3dd81a8d5abda98d25bad4d942e4a08669c6cae2d49ab566ce8b0610d5619792dcb5f716d8ec20cac20b101f03f49a70708a3c95950c692
+  data.tar.gz: 0cf3e33b930a1b30298e0e3205c84eb79704de055b6d9ffa6f9bf0e9455fce4a0fa6a709365ac20ce4f20f081e1ea716e7898a4e51e21c37e18c0bc20283721e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+require: rubocop-rspec
+
+Metrics/BlockLength:
+  Max: 100
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false

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.1

data/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Rails server",
+      "type": "Ruby",
+      "request": "launch",
+      "program": "${workspaceRoot}/bin/rails",
+      "args": [
+        "server"
+      ]
+    }
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "editor.fontFamily": "'Roboto Mono for Powerline', Menlo, Monaco, 'Courier New', monospace",
+    "editor.fontLigatures": true,
+    "workbench.fontAliasing": "auto",
+    "editor.fontSize": 9,
+    "editor.tabSize": 2
+}

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    xpanse_2go (0.1.0)
+      activemodel (~> 5.1)
+      fast_jsonapi (~> 1.3)
+      typhoeus (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    dotenv (2.7.1)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
+    faker (1.9.3)
+      i18n (>= 0.7)
+    fast_jsonapi (1.5)
+      activesupport (>= 4.2)
+    ffi (1.10.0)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    shoulda-matchers (4.0.1)
+      activesupport (>= 4.2.0)
+    thread_safe (0.3.6)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  dotenv (~> 2.5)
+  factory_bot (~> 4.8)
+  faker (~> 1.9)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop-rspec (~> 1.32)
+  shoulda-matchers (~> 4.0)
+  xpanse_2go!
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,55 @@
+# Xpanse2go
+
+A Ruby wrapper for the 2GO Courier API written by xpanse (David Marquez).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xpanse_2go'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xpanse_2go
+
+## Xpanse2go::Order
+
+    $ pickup_address = Xpanse2go::Address.new(...)
+    $ delivery_address = Xpanse2go::Address.new(...)
+    $ package = Xpanse2go::Package.new(...)
+    $ order = Xpanse2go::Order.new(pickup_address, delivery_address, package,
+                                   reference_number, awb, cod_amt, instruction)
+
+## Xpanse2go::Address
+
+    $ address = Xpanse2go::Address.new(customer_name, line1, barangay, city,
+                                       country, zip_code, mobile_number, email_address)
+
+## Xpanse2go::Package
+
+    $ item = Xpanse2go::PackageItem(...)
+    $ package = Xpanse2go::Package.new
+    $ package.add_item(item)
+
+## Xpanse2go::PackageItem
+
+    $ item = Xpanse2go::PackageItem.new(quantity, package_code, weight, length,
+                                        width, height, declared_value, description)
+
+## TODO
+
+[x] Xpanse2go::Package
+[x] Xpanse2go::PackageItem
+[x] Add Typhoeus sample
+[] Add Typhoeus and connect to the Sandbox
+[] xport.it
+    [] Receive webhook updates
+[] Create xport.it microservice
+    [] Generating AWB indexes
+    [] Fetching an available AWB

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'xpanse_2go'
+
+# 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/lib/xpanse_2go.rb

@@ -0,0 +1,24 @@
+module Xpanse2go
+  autoload :Configuration, 'xpanse_2go/configuration'
+
+  autoload :Order,        'xpanse_2go/order'
+  autoload :Address,      'xpanse_2go/address'
+  autoload :Package,      'xpanse_2go/package'
+  autoload :PackageItem,  'xpanse_2go/package_item'
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.url
+    if Xpanse2go.configuration.production
+      'https://expressapps.2go.com.ph/2goweb'
+    else
+      'https://expressapps.2go.com.ph/2gowebdev'
+    end
+  end
+end

data/lib/xpanse_2go/address.rb

@@ -0,0 +1,36 @@
+require 'active_model'
+require 'json'
+
+module Xpanse2go
+  class Address
+    include ActiveModel::Model
+
+    attr_accessor :customer_name, :line1, :barangay, :city, :country, :zip_code
+    attr_accessor :mobile_number, :email_address
+
+    validates_presence_of :customer_name, :line1, :barangay, :city, :country, :zip_code
+
+    def initialize(options = {})
+      @customer_name  = options[:customer_name]
+      @line1          = options[:line1]
+      @barangay       = options[:barangay]
+      @city           = options[:city]
+      @country        = options[:customer_name] || 'Philippines'
+      @zip_code       = options[:zip_code]
+      @mobile_number  = options[:mobile_number]
+      @email_address  = options[:email_address]
+    end
+
+    def attributes
+      {
+        "name": @customer_name,
+        "street": @line1,
+        "barangay": @barangay,
+        'city': @city,
+        'area_code': @zip_code,
+        'mobile_number': @mobile_number,
+        'email_address': @email_address
+      }
+    end
+  end
+end

data/lib/xpanse_2go/configuration.rb

@@ -0,0 +1,12 @@
+module Xpanse2go
+  class Configuration
+    attr_accessor :account_id, :account_number, :token, :production
+
+    def initialize
+      @account_id     = 'XPANSE'
+      @token          = 'bVHQGxZLML'
+      @account_number = '1'
+      @production     = false
+    end
+  end
+end

data/lib/xpanse_2go/order.rb

@@ -0,0 +1,59 @@
+require 'active_model'
+require 'json'
+
+module Xpanse2go
+  class Order
+    include ActiveModel::Model
+
+    attr_accessor :reference_number, :awb, :cod_amt, :instruction
+    attr_accessor :pickup_address, :delivery_address, :package
+
+    validates_presence_of :pickup_address, :delivery_address, :package
+    validates_presence_of :reference_number, :awb
+    validate :pickup_address_is_valid, :delivery_address_is_valid
+    validate :package_has_items
+
+    def initialize(pickup_address, delivery_address, package, options = {})
+      @pickup_address   = pickup_address
+      @delivery_address = delivery_address
+      @package          = package
+      @reference_number = options[:reference_number]
+      @awb              = options[:awb]
+      @cod_amt          = options[:cod_amt] || 0
+      @instruction      = options[:instruction]
+    end
+
+    def attributes
+      {
+        'ID_': Xpanse2go.configuration.account_id,
+        'token_': Xpanse2go.configuration.token,
+        'account_no': Xpanse2go.configuration.account_number,
+        'attachment': @reference_number,
+        'awb_code': @awb,
+        'cod_amt': @cod_amt,
+        'instruction': @instruction,
+        'pickup_dtls': @pickup_address.attributes,
+        'cnee_dtls': @delivery_address.attributes,
+        'px_dtls': @package.attributes
+      }
+    end
+
+    def to_json
+      { d: attributes }.to_json
+    end
+
+    private
+
+    def pickup_address_is_valid
+      errors.add(:pickup_address, 'is invalid') unless pickup_address.valid?
+    end
+
+    def delivery_address_is_valid
+      errors.add(:delivery_address, 'is invalid') unless delivery_address.valid?
+    end
+
+    def package_has_items
+      errors.add(:package, 'has no items') if package.empty?
+    end
+  end
+end

data/lib/xpanse_2go/package.rb

@@ -0,0 +1,36 @@
+require 'active_model'
+require 'json'
+
+module Xpanse2go
+  class Package
+    include ActiveModel::Model
+
+    attr_accessor :items
+
+    validates_presence_of :items
+
+    def initialize
+      @items = []
+    end
+
+    def attributes
+      @items
+    end
+
+    def empty?
+      items.count.zero?
+    end
+
+    def add_item(item)
+      items << item.attributes if item.is_a?(Xpanse2go::PackageItem)
+      self
+    end
+
+    def add_item_with_quantity(item, quantity)
+      (0..quantity).each do
+        items << item.attributes if item.is_a?(Xpanse2go::PackageItem)
+      end
+      self
+    end
+  end
+end

data/lib/xpanse_2go/package_item.rb

@@ -0,0 +1,39 @@
+require 'active_model'
+require 'json'
+
+module Xpanse2go
+  class PackageItem
+    include ActiveModel::Model
+
+    attr_accessor :quantity, :package_code
+    attr_accessor :description, :declared_value
+    attr_accessor :weight, :length, :width, :height
+
+    validates_presence_of :quantity, :package_code, :description
+    validates_presence_of :weight, :length, :width, :height
+
+    def initialize(options = {})
+      @quantity         = options[:quantity]
+      @package_code     = options[:package_code]
+      @weight           = options[:weight]
+      @length           = options[:length]
+      @width            = options[:width]
+      @height           = options[:height]
+      @declared_value   = options[:declared_value]
+      @description      = options[:description]
+    end
+
+    def attributes
+      {
+        'item_qty': @quantity,
+        'pkg_code': @package_code,
+        'actual_wt': @weight,
+        'length': @length,
+        'width': @width,
+        'height': @height,
+        'declared_value': @declared_value,
+        'item_description': @description
+      }
+    end
+  end
+end

data/lib/xpanse_2go/version.rb

@@ -0,0 +1,3 @@
+module Xpanse2go
+  VERSION = '0.1.0'.freeze
+end

data/xpanse_2go.gemspec

@@ -0,0 +1,36 @@
+# lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xpanse_2go/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'xpanse_2go'
+  spec.version       = Xpanse2go::VERSION
+  spec.authors       = ['David Marquez']
+  spec.email         = ['david@xpanse.ph']
+
+  spec.summary       = '2GO Ruby API'
+  spec.description   = '2GO Courier API written by xpanse'
+  spec.homepage      = 'https://rubygems.org/gems/xpanse_2go'
+
+  # 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(__dir__)) 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_dependency 'activemodel',  '~> 5.1'
+  spec.add_dependency 'fast_jsonapi', '~> 1.3'
+  spec.add_dependency 'typhoeus',     '~> 1.3'
+
+  spec.add_development_dependency 'bundler',          '~> 2.0'
+  spec.add_development_dependency 'dotenv',           '~> 2.5'
+  spec.add_development_dependency 'factory_bot',      '~> 4.8'
+  spec.add_development_dependency 'faker',            '~> 1.9'
+  spec.add_development_dependency 'rake',             '~> 10.0'
+  spec.add_development_dependency 'rspec',            '~> 3.0'
+  spec.add_development_dependency 'rubocop-rspec',    '~> 1.32'
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: xpanse_2go
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Marquez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: fast_jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+description: 2GO Courier API written by xpanse
+email:
+- david@xpanse.ph
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".vscode/launch.json"
+- ".vscode/settings.json"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xpanse_2go.rb
+- lib/xpanse_2go/address.rb
+- lib/xpanse_2go/configuration.rb
+- lib/xpanse_2go/order.rb
+- lib/xpanse_2go/package.rb
+- lib/xpanse_2go/package_item.rb
+- lib/xpanse_2go/version.rb
+- xpanse_2go.gemspec
+homepage: https://rubygems.org/gems/xpanse_2go
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: 2GO Ruby API
+test_files: []