vncpost_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bab00738a4e65dfa53e1da95a9f93610686b232da184fb3195afc4aa765f16e
+  data.tar.gz: debdaf9f7580a9b0752c843be16da364f5c3801e2bf33ab0f775bd4bd6ab5de6
+SHA512:
+  metadata.gz: 6c8d8c3928889f31de818758a1c66e308f8cddf68075bb7f572aafb796eaba8bc060ec2b1cda661182ffafd0ad0bb5284b83ad3015eef5724a4402714aff9824
+  data.tar.gz: 24ac04b1fe4e881359fd948a206fb9baf139fc0d6fccfbcfd0007b454110fe49940d546ffd6c286986be64671a9d307291ff45d452ae15f5d88bdb60d0735ac0

data/.byebug_history

@@ -0,0 +1 @@
+c

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

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 andy_gg1996@hotmail.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in vncpost_api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    vncpost_api (0.1.0)
+      activeresource
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activemodel-serializers-xml (1.0.2)
+      activemodel (> 5.x)
+      activesupport (> 5.x)
+      builder (~> 3.1)
+    activeresource (5.1.0)
+      activemodel (>= 5.0, < 7)
+      activemodel-serializers-xml (~> 1.0)
+      activesupport (>= 5.0, < 7)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    builder (3.2.4)
+    byebug (11.1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    dotenv (2.7.5)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  pry
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  vncpost_api!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andy Chong
+
+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,43 @@
+# VNCPostAPI
+
+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/vncpost_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:
+
+```ruby
+gem 'vncpost_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install vncpost_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PostCo/vncpost_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/PostCo/vncpost_api/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 VNCPostAPI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/PostCo/vncpost_api/blob/master/CODE_OF_CONDUCT.md).

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,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotenv/load"
+require "dev/zeitwerk_loader"
+require "dev/config"
+require "vncpost_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.
+set_config
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+require "pry-byebug"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,17 @@
+#!/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
+filename=".env"
+if [ ! -f $filename ]
+then
+    touch $filename
+    echo "VNCPOST_API_HOST=http://tu.api.vncpost.com" >> $filename
+    echo "VNCPOST_USERNAME=postco" >> $filename
+    echo "VNCPOST_PASSWORD=" >> $filename
+    echo "VNCPostAPI_GEM_ENV=development" >> $filename
+fi

data/lib/dev/config.rb

@@ -0,0 +1,7 @@
+def set_config
+  VNCPostAPI.configure do |config|
+    config.api_host = ENV["VNCPOST_API_HOST"]
+    config.username = ENV["VNCPOST_USERNAME"]
+    config.password = ENV["VNCPOST_PASSWORD"]
+  end
+end

data/lib/dev/zeitwerk_loader.rb

@@ -0,0 +1,22 @@
+require "zeitwerk"
+require_relative "config"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "vncpost_api" => "VNCPostAPI"
+)
+loader.push_dir("./lib")
+loader.collapse("./lib/vncpost_api/resources")
+loader.ignore("#{__dir__}/config.rb")
+loader.ignore("./lib/vncpost_api/exceptions.rb")
+loader.enable_reloading
+# loader.log!
+loader.setup
+
+$__vncpost_api_loader__ = loader
+
+def reload!
+  $__vncpost_api_loader__.reload
+  set_config
+  true
+end

data/lib/vncpost_api/configuration.rb

@@ -0,0 +1,19 @@
+module VNCPostAPI
+  class Configuration
+    attr_accessor :api_host, :username, :password
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.config=(config)
+    @config = config
+  end
+
+  def self.configure
+    yield config
+    # set the site once user configure
+    VNCPostAPI::Base.site = VNCPostAPI.config.api_host
+  end
+end

data/lib/vncpost_api/connection.rb

@@ -0,0 +1,29 @@
+module VNCPostAPI
+  class ResourceInvalid < ActiveResource::ClientError
+    def to_s
+      body = JSON.parse(response.body)
+      if body["Message"]
+        message = "Failed.".dup
+        message << " Error message: #{body["Message"]}"
+        message
+      else
+        super
+      end
+    end
+  end
+  class Connection < ActiveResource::Connection
+    private
+
+    def request_failed?(response)
+      body = JSON.parse(response.body)
+      body["Result"] == 2
+    rescue JSON::ParserError
+      false
+    end
+
+    def handle_response(response)
+      raise(ResourceInvalid.new(response)) if request_failed?(response)
+      super
+    end
+  end
+end

data/lib/vncpost_api/resources/base.rb

@@ -0,0 +1,59 @@
+module VNCPostAPI
+  class Base < ::ActiveResource::Base
+    self.include_root_in_json = false
+    self.include_format_in_path = false
+    self.connection_class = VNCPostAPI::Connection
+    self.site = VNCPostAPI.config&.api_host
+
+    def create
+      self.class.retrieve_token
+      format_before_send_request
+      super
+    rescue => e
+      reset_attributes_format
+      raise e
+    end
+
+    def update
+      raise NotImplementedError, "#update is not supported"
+    end
+
+    def build
+      raise NotImplementedError, "#build is not supported"
+    end
+
+    private
+
+    def self.retrieve_token
+      clear_auth_token
+      if VNCPostAPI.config&.username && VNCPostAPI.config&.password
+        response = connection.post("/User/Login", {
+          Username: VNCPostAPI.config.username,
+          Password: VNCPostAPI.config.password
+        }.to_json)
+        connection.auth_type = :bearer
+        connection.bearer_token = JSON.parse(response.body)["token"]
+      else
+        raise ArgumentError, "Please set the username and password in the config file under the initializer dir"
+      end
+    end
+
+    def self.clear_auth_token
+      connection.auth_type = nil
+      connection.bearer_token = nil
+    end
+
+    def format_before_send_request
+      @attributes.transform_keys!(&:camelcase)
+    end
+
+    def reset_attributes_format
+      @attributes.transform_keys!(&:underscore)
+    end
+
+    def load_attributes_from_response(response)
+      super
+      reset_attributes_format
+    end
+  end
+end

data/lib/vncpost_api/resources/order.rb

@@ -0,0 +1,86 @@
+module VNCPostAPI
+  class Order < Base
+    validates :code, :product_name, :collect_amount, :weight, :width, :height, :length,
+      :source_address, :source_city, :source_district, :source_ward, :source_name, :source_phone_number,
+      :dest_city, :dest_district, :dest_ward, :dest_name, :dest_phone_number, :dest_address, presence: true
+
+    validates :journey_type, inclusion: {
+      in: [1, 2, 3],
+      message: "%{value} is not a supported journey type, supported journey types are 1(Delivery), 2(Exchange), 3(Collect)"
+    }
+    validates :service_id, inclusion: {
+      in: [12490, 12491],
+      message: "%{value} is not a supported service id, supported service ids are 12490(Express), 12491(Eco)"
+    }
+
+    DEFAULT_ATTRS = {
+      code: nil,
+      product_name: "Fashion Apparel",
+      collect_amount: 0,
+      journey_type: 1,
+      service_id: 12490,
+      weight: 0,
+      width: 0,
+      height: 0,
+      length: 0,
+      note: nil,
+      source_address: nil,
+      source_city: nil,
+      source_district: nil,
+      source_ward: nil,
+      source_name: nil,
+      source_phone_number: nil,
+      dest_address: nil,
+      dest_city: nil,
+      dest_district: nil,
+      dest_ward: nil,
+      dest_name: nil,
+      dest_phone_number: nil,
+      return_address: nil,
+      return_city: nil,
+      return_district: nil,
+      return_ward: nil,
+      return_name: nil,
+      return_phone_number: nil
+    }
+
+    self.prefix = "/Order/Add"
+    self.element_name = ""
+
+    def self.track(code)
+      new(code: code).track
+    end
+
+    def initialize(attributes = {}, persisted = false)
+      attributes = DEFAULT_ATTRS.merge(attributes)
+      super
+    end
+
+    def track
+      puts "#track only available in production environment"
+      self.class.retrieve_token
+      tracking_number = @attributes[:returned_code] || @attributes[:code]
+      get("Track/#{tracking_number}")
+    end
+
+    private
+
+    def load_attributes_from_response(response)
+      # save the response attributes
+      if response_code_allows_body?(response.code.to_i) &&
+          (response["Content-Length"].nil? || response["Content-Length"] != "0") &&
+          !response.body.nil? && response.body.strip.size > 0
+
+        attributes = self.class.format.decode(response.body)
+        # Code(client provided code) will be overwrited by response's Code from the server
+        # To avoid that, the code returned will be stored as ReturnedCode
+        attributes["ReturnedCode"] = attributes.delete("Code")
+
+        load(attributes, false, true)
+        # reset the attributes structure after assign attributes that came back from server
+        reset_attributes_format
+        @persisted = true
+      end
+    end
+  end
+end

data/lib/vncpost_api/version.rb

@@ -0,0 +1,3 @@
+module VNCPostAPI
+  VERSION = "0.1.0"
+end

data/lib/vncpost_api.rb

@@ -0,0 +1,11 @@
+require "vncpost_api/version"
+require "active_resource"
+
+module VNCPostAPI
+  require "vncpost_api/configuration"
+
+  require "vncpost_api/connection"
+
+  require "vncpost_api/resources/base"
+  require "vncpost_api/resources/order"
+end

data/vncpost_api.gemspec

@@ -0,0 +1,35 @@
+require_relative "lib/vncpost_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "vncpost_api"
+  spec.version = VNCPostAPI::VERSION
+  spec.authors = ["Andy Chong"]
+  spec.email = ["andygg1996personal@gmail.com"]
+
+  spec.summary = "Ruby object based VNCPost API wrapper."
+  spec.homepage = "https://github.com/PostCo/vncpost_api"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/PostCo/vncpost_api"
+  spec.metadata["changelog_uri"] = "https://github.com/PostCo/vncpost_api/releases"
+
+  # 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_dependency "activeresource"
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: vncpost_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Chong
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: pry-byebug
+  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: 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'
+description: 
+email:
+- andygg1996personal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/dev/config.rb
+- lib/dev/zeitwerk_loader.rb
+- lib/vncpost_api.rb
+- lib/vncpost_api/configuration.rb
+- lib/vncpost_api/connection.rb
+- lib/vncpost_api/resources/base.rb
+- lib/vncpost_api/resources/order.rb
+- lib/vncpost_api/version.rb
+- vncpost_api.gemspec
+homepage: https://github.com/PostCo/vncpost_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/PostCo/vncpost_api
+  source_code_uri: https://github.com/PostCo/vncpost_api
+  changelog_uri: https://github.com/PostCo/vncpost_api/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby object based VNCPost API wrapper.
+test_files: []