ghtk 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4df0ff353b7f46feeda5484a8b2d8360a4479f78f23ba1fe99e24fc1573656b8
+  data.tar.gz: 0aac5a1d1bab0a652620fa9aeb01cc35c47713f7c22fc0fc9eb89a09b58d3fe5
+SHA512:
+  metadata.gz: 29f10fdda2c80bd30a7e614ee55cc56f3d89ea1e5d659e5d4173e8cc4cb6c228f38768320002b9dab2e0da824120e8756c44df59dec691ed5acec6c12df31f06
+  data.tar.gz: 963961413fb2a39e10ea794d29717fb839e54cd301182a2f748d36384e8a7ae38349f23f4646aea93a3c6430d62c7e8bdf67055937bf93814daad8c42dfc38d7

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 documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+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 ThanhKhoaIT@gmail.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 [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,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ghtk.gemspec
+
+gem "http", '>= 4.1.1'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    ghtk (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http (4.1.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    public_suffix (3.1.1)
+    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.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  ghtk!
+  http (>= 4.1.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 KhoaRB
+
+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,55 @@
+# GHTK API Caller
+**GHTK Documentation:** https://docs.giaohangtietkiem.vn
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ghtk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ghtk
+
+## Setup for Rails
+Add `config/initializers/ghtk.rb` file
+```ruby
+  Ghtk.setup do |config|
+    config.domain = '' # Add domain for sandbox or production
+    config.access_token = '' # Add your token of sandbox or production
+    config.version = 1.5
+  end
+```
+
+## Usage
+#### How to create Order
+```ruby
+  serializer = ShippingServices::GhtkSerializer.new(Shipment.last)
+  Ghtk::Order.create(serializer)
+```
+- Response data: [detail](https://docs.giaohangtietkiem.vn/?http#ng-n-h-ng)
+
+#### How to get Order detail for check status,.....
+```ruby
+  Ghtk::Order.get_detail(tracking_code)
+```
+- Response data: [detail](https://docs.giaohangtietkiem.vn/?http#tr-ng-th-i-n-h-ng)
+
+#### How to cancel Order
+```ruby
+  Ghtk::Order.cancel(tracking_code)
+```
+- Response data: [detail](https://docs.giaohangtietkiem.vn/?http#h-y-n-h-ng)
+
+#### How to check shipping fee
+```ruby
+  serializer = ShippingServices::GhtkFeeSerializer.new(Shipment.last)
+  Ghtk::ShippingFee.check(serializer)
+```
+- Response data: [detail](https://docs.giaohangtietkiem.vn/?http#t-nh-ph-v-n-chuy-n)

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 "ghtk"
+
+# 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/ghtk.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ghtk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ghtk"
+  spec.version       = Ghtk::VERSION
+  spec.authors       = ["KhoaRB"]
+  spec.email         = ["ThanhKhoaIT@gmail.com"]
+
+  spec.summary       = %q{GHTK API Caller}
+  spec.description   = %q{Ruby gem for call GHTK API}
+  spec.homepage      = "https://github.com/ThanhKhoaIT/ghtk"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # 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 "http", "~> 4.1.1"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ghtk.rb

@@ -0,0 +1,36 @@
+require "http"
+require "ghtk/support/hash"
+require "ghtk/version"
+require "ghtk/error"
+require "ghtk/config"
+require "ghtk/flexible_params"
+require "ghtk/request"
+require "ghtk/validations/order_validation"
+require "ghtk/validations/shipping_fee_validation"
+require "ghtk/order"
+require "ghtk/shipping_fee"
+
+module Ghtk
+
+  def self.setup
+    @config ||= Ghtk::Config.new
+    yield @config if block_given?
+    @config
+  end
+
+  def self.is_blank?(object)
+    case object
+    when NilClass, FalseClass
+      return true
+    when TrueClass, Numeric, Fixnum
+      return false
+    when Array, Hash
+      return object.empty?
+    when String
+      return object.empty? || !object.match(/\A[[:space:]]*\z/).nil?
+    else
+      return object.respond_to?(:empty?) ? !!object.empty? : !object
+    end
+  end
+
+end

data/lib/ghtk/config.rb

@@ -0,0 +1,9 @@
+module Ghtk
+  class Config
+
+    attr_accessor :domain
+    attr_accessor :access_token
+    attr_accessor :version
+
+  end
+end

data/lib/ghtk/error.rb

@@ -0,0 +1,8 @@
+module Ghtk
+  class Error < StandardError; end
+  class ForbiddenError < Error; end
+  class ServerError < Error; end
+  class RequestError < Error; end
+  class CreateOrderError < Error; end
+  class BadParamsError < Error; end
+end

data/lib/ghtk/flexible_params.rb

@@ -0,0 +1,18 @@
+module Ghtk
+  class FlexibleParams
+
+    attr_reader :hash
+
+    def initialize(object)
+      if object.is_a?(Hash)
+        data = object
+      elsif object.respond_to?(:as_json)
+        data = object.as_json
+      else
+        data = object.attributes
+      end
+      @hash = data.to_deep_symbolize_keys
+    end
+
+  end
+end

data/lib/ghtk/order.rb

@@ -0,0 +1,23 @@
+module Ghtk
+  class Order
+
+    def self.create(serializer)
+      create_data = NinjaVan::FlexibleParams.new(serializer).hash
+      Ghtk::Validations::OrderValidation.new(create_data).validate!
+      Ghtk::Request.post('/services/shipment/order', create_data)
+    rescue Ghtk::ForbiddenError
+      raise Ghtk::CreateOrderError.new(create_data)
+    end
+
+    def self.get_detail(tracking_code)
+      raise Ghtk::BadParamsError.new('Tracking code is blank!') if Ghtk.is_blank?(tracking_code)
+      Ghtk::Request.get("/services/shipment/v2/#{tracking_code}")
+    end
+
+    def self.cancel(tracking_code)
+      raise Ghtk::BadParamsError.new('Tracking code is blank!') if Ghtk.is_blank?(tracking_code)
+      Ghtk::Request.post("/services/shipment/cancel/#{tracking_code}")
+    end
+
+  end
+end

data/lib/ghtk/request.rb

@@ -0,0 +1,28 @@
+module Ghtk
+  class Request
+
+    def self.post(endpoint, params={})
+      full_endpoint = "#{Ghtk.setup.domain}#{endpoint}?ver=#{Ghtk.setup.version}"
+      response = Http.headers(
+        content_type: 'application/json',
+        token: Ghtk.setup.access_token,
+      ).post(full_endpoint, json: params)
+      raise Ghtk::ForbiddenError.new(full_endpoint) if response.code == 403
+      raise Ghtk::ServerError.new(full_endpoint) if response.code == 500
+      raise Ghtk::RequestError.new(response.parse) unless response.parse['success']
+      response.parse
+    end
+
+    def self.get(endpoint, params={})
+      full_endpoint = "#{Ghtk.setup.domain}#{endpoint}?ver=#{Ghtk.setup.version}"
+      response = Http.headers(
+        content_type: 'aplication/json',
+        token: Ghtk.setup.access_token,
+      ).get(full_endpoint, params: params)
+      raise Ghtk::ForbiddenError.new(full_endpoint) if response.code == 403
+      raise Ghtk::ServerError.new(full_endpoint) if response.code == 500
+      response.parse
+    end
+
+  end
+end

data/lib/ghtk/shipping_fee.rb

@@ -0,0 +1,11 @@
+module Ghtk
+  class ShippingFee
+
+    def self.check(serializer)
+      hash = Ghtk::FlexibleParams.new(serializer).hash
+      Ghtk::Validations::ShippingFeeValidation.new(hash).validate!
+      Ghtk::Request.get('/services/shipment/fee', hash)
+    end
+
+  end
+end

data/lib/ghtk/support/hash.rb

@@ -0,0 +1,26 @@
+class Hash
+
+  def to_deep_symbolize_keys
+    to_deep_transform_keys { |key| key.to_sym rescue key }
+  end
+
+  def to_deep_transform_keys(&block)
+    _to_deep_transform_keys_in_object(self, &block)
+  end
+
+  private
+
+  def _to_deep_transform_keys_in_object(object, &block)
+    case object
+    when Hash
+      object.each_with_object({}) do |(key, value), result|
+        result[yield(key)] = _to_deep_transform_keys_in_object(value, &block)
+      end
+    when Array
+      object.map { |e| _to_deep_transform_keys_in_object(e, &block) }
+    else
+      object
+    end
+  end
+
+end

data/lib/ghtk/validations/order_validation.rb

@@ -0,0 +1,56 @@
+module Ghtk::Validations
+  class OrderValidation
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def validate!
+      blank_params = []
+      REQUIRED_PARAMS.each do |key, sub_keys|
+        sub_keys.each do |sub_key|
+          blank_params << "#{key}.#{sub_key}" if Ghtk.is_blank?(hash.dig(key, sub_key))
+        end
+      end
+      unless hash.dig(:order, :use_return_address).to_i.zero?
+        REQUIRED_RETURN_PARAMS.each do |key, sub_keys|
+          sub_keys.each do |sub_key|
+            blank_params << "#{key}.#{sub_key}" if Ghtk.is_blank?(hash.dig(key, sub_key))
+          end
+        end
+      end
+      raise Ghtk::BadParamsError.new("Params: #{blank_params.join(', ')} is blank!") unless blank_params.empty?
+      return true
+    end
+
+    private
+
+    attr_reader :hash
+
+    REQUIRED_PARAMS = { order: [
+      :id,
+      :pick_name,
+      :pick_money,
+      :pick_address,
+      :pick_province,
+      :pick_district,
+      :pick_tel,
+      :name,
+      :address,
+      :province,
+      :district,
+      :tel,
+      :email,
+    ] }
+
+    REQUIRED_RETURN_PARAMS = { order: [
+      :return_name,
+      :return_address,
+      :return_province,
+      :return_district,
+      :return_tel,
+      :return_email,
+    ] }
+
+  end
+end

data/lib/ghtk/validations/shipping_fee_validation.rb

@@ -0,0 +1,27 @@
+module Ghtk::Validations
+  class ShippingFeeValidation
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def validate!
+      blank_params = REQUIRED_PARAMS.select { |key| Ghtk.is_blank?(hash[key]) }
+      raise Ghtk::BadParamsError.new("Params: #{blank_params.join(', ')} is blank!") unless blank_params.empty?
+      return true
+    end
+
+    private
+
+    attr_reader :hash
+
+    REQUIRED_PARAMS = [
+      :pick_province,
+      :pick_district,
+      :province,
+      :district,
+      :weight
+    ]
+
+  end
+end

data/lib/ghtk/version.rb

@@ -0,0 +1,3 @@
+module Ghtk
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: ghtk
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- KhoaRB
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !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: '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'
+description: Ruby gem for call GHTK API
+email:
+- ThanhKhoaIT@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ghtk.gemspec
+- lib/ghtk.rb
+- lib/ghtk/config.rb
+- lib/ghtk/error.rb
+- lib/ghtk/flexible_params.rb
+- lib/ghtk/order.rb
+- lib/ghtk/request.rb
+- lib/ghtk/shipping_fee.rb
+- lib/ghtk/support/hash.rb
+- lib/ghtk/validations/order_validation.rb
+- lib/ghtk/validations/shipping_fee_validation.rb
+- lib/ghtk/version.rb
+homepage: https://github.com/ThanhKhoaIT/ghtk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ThanhKhoaIT/ghtk
+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.10
+signing_key: 
+specification_version: 4
+summary: GHTK API Caller
+test_files: []