janio_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64be649aa911d63a575983fb264d6eccb1110181730087bf4c597c356d380f3d
+  data.tar.gz: d6e5ac35aa954e8e9f2f01dcad588aa0e03ee97e984347377771cba7b0bb89c0
+SHA512:
+  metadata.gz: d1f027f9b7a248d1126cf8a1bb3e0ad8cab9db0b1b51b28eca0bc0c802bc500b0aef1a6e6a64f9de94a8e0efcb2cd4082f4e7d589a42d169fd72ecb7a5de1c74
+  data.tar.gz: 68796a18371a5d99ec452b2d8422dd24bda865d523aac4a0417cde2344341120f8173bfcc33aeb1b19c96f0a7889ce480c220f366cd66803f8d72efa4909c720

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,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in janio_api.gemspec
+gemspec
+
+gem "rake", "~> 12.3"

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    janio_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
+  janio_api!
+  pry
+  pry-byebug
+  rake (~> 12.3)
+  rspec (~> 3.2)
+
+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,47 @@
+# JanioAPI
+
+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/janio_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 'janio_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install janio_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/janio_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/[USERNAME]/janio_api/blob/master/CODE_OF_CONDUCT.md).
+
+### Gem Building Guide
+
+Please read this [guide](https://bundler.io/guides/creating_gem.html), it is very helpful for beginner gem builder.
+
+## 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 JanioAPI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/janio_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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "janio_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (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/janio_api.gemspec

@@ -0,0 +1,35 @@
+require_relative "lib/janio_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "janio_api"
+  spec.version = JanioAPI::VERSION
+  spec.authors = ["Andy Chong"]
+  spec.email = ["andygg1996personal@gmail.com"]
+
+  spec.summary = "Ruby object based Janio API wrapper."
+  spec.homepage = "https://github.com/PostCo/janio_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/janio_api"
+  spec.metadata["changelog_uri"] = "https://github.com/PostCo/janio_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

data/lib/janio_api/configuration.rb

@@ -0,0 +1,5 @@
+module JanioAPI
+  class Configuration
+    attr_accessor :api_host, :api_token
+  end
+end

data/lib/janio_api/connection.rb

@@ -0,0 +1,22 @@
+require "fetcher"
+module JanioAPI
+  class Connection < ActiveResource::Connection
+    def request(method, path, *arguments)
+      result = ActiveSupport::Notifications.instrument("request.active_resource") { |payload|
+        payload[:method] = method
+        payload[:request_uri] = "#{site.scheme}://#{site.host}:#{site.port}#{path}"
+
+        payload[:result] = if method == :get
+          RedirectFetcher.get("#{site}#{path}")
+        else
+          http.send(method, path, *arguments)
+        end
+      }
+      handle_response(result)
+    rescue Timeout::Error => e
+      raise TimeoutError.new(e.message)
+    rescue OpenSSL::SSL::SSLError => e
+      raise SSLError.new(e.message)
+    end
+  end
+end

data/lib/janio_api/redirect_fetcher.rb

@@ -0,0 +1,46 @@
+module JanioAPI
+  class RedirectFetcher
+    def self.get(src)
+      uri = URI.parse(src)
+
+      proxy = OpenStruct.new
+
+      http_proxy = Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password)
+
+      redirect_limit = 6
+      response = nil
+
+      loop do
+        raise ArgumentError, "HTTP redirect too deep" if redirect_limit == 0
+        redirect_limit -= 1
+
+        http = http_proxy.new(uri.host, uri.port)
+
+        request = Net::HTTP::Get.new(uri.request_uri, {})
+        if uri.instance_of? URI::HTTPS
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+
+        response = http.request(request)
+
+        if response.code == "200"
+          break
+        elsif response.code == "304"
+          break
+        elsif response.code == "301" || response.code == "302" || response.code == "303" || response.code == "307"
+
+          newuri = URI.parse(response.header["location"])
+          if newuri.relative?
+            newuri = uri + response.header["location"]
+          end
+          uri = newuri
+        else
+          break
+        end
+      end
+
+      response
+    end
+  end
+end

data/lib/janio_api/resources/base.rb

@@ -0,0 +1,13 @@
+module JanioAPI
+  class Base < ::ActiveResource::Base
+    self.include_root_in_json = false
+    self.include_format_in_path = false
+    self.connection_class = JanioAPI::Connection
+
+    if JanioAPI.config&.api_host
+      self.site = JanioAPI.config.api_host
+    else
+      raise ArgumentError, "Please set the api_host in the initializer file"
+    end
+  end
+end

data/lib/janio_api/resources/order.rb

@@ -0,0 +1,139 @@
+module JanioAPI
+  class Order < Base
+    self.prefix = "/api/order/orders/"
+    self.element_name = ""
+
+    validate :check_api_token
+
+    def check_api_token
+      errors.add(:base, "Please set the api_token in the initializer file") if JanioAPI.config.api_token.blank?
+    end
+
+    class Collection < ActiveResource::Collection
+      attr_accessor :count, :next, :previous
+
+      def initialize(parsed = {})
+        @count = parsed["count"]
+        @next = parsed["next"]
+        @previous = parsed["previous"]
+        @elements = parsed["results"]
+      end
+    end
+
+    self.collection_parser = Collection
+
+    class << self
+      def tracking_path
+        "/api/tracker/query-by-tracking-nos/"
+      end
+
+      # override find to customize url, and only allow find_every
+      # use to find the parcel info, include the label pdf url
+      # check http://apidocs.janio.asia/view for more information
+      # params accept tracking numbers as well: ```tracking_no=[tracking_no1],[tracking_no2],[tracking_no3]```
+      def find(*arguments)
+        scope = arguments.slice!(0)
+        options = arguments.slice!(0) || {}
+        options[:from] = "/api/order/order" unless options[:from]
+        options[:params] = {} unless options[:params]
+        options[:params][:secret_key] = JanioAPI.config.api_token
+        options[:params][:with_items] = true unless options[:params][:with_items]
+
+        case scope
+        when :all
+          find_every(options)
+        when :first
+          collection = find_every(options)
+          collection&.first
+        when :last
+          collection = find_every(options)
+          collection&.last
+        end
+      end
+
+      # Track one or more tracking nos
+      #
+      # Check http://apidocs.janio.asia/track for more information
+      def track(tracking_nos)
+        raise ArgumentError, "tracking_nos not an array" unless tracking_nos.is_a?(Array)
+
+        body = {
+          get_related_updates: true,
+          flatten_data: true,
+          tracking_nos: tracking_nos
+        }
+        response = connection.post(tracking_path, body.to_json, headers)
+
+        self.format.decode(response.body)
+      end
+    end
+
+    # Tracks the current order
+    #
+    # Check http://apidocs.janio.asia/track for more information
+    def track
+      body = {
+        get_related_updates: true,
+        flatten_data: true,
+        tracking_nos: [@attributes["tracking_no"]]
+      }
+      response = connection.post(self.class.tracking_path, body.to_json, self.class.headers)
+      self.class.format.decode(response.body)[0]
+    end
+
+    def save(blocking: true)
+      run_callbacks :save do
+        new? ? create(blocking: blocking) : update(blocking: blocking)
+      end
+    end
+
+    def create(blocking: true)
+      reformat_before_save(blocking)
+      super()
+    rescue => e
+      reset_attributes_format
+      raise e
+    end
+
+    def update(blocking: true)
+      reformat_before_save(blocking)
+      super()
+    rescue => e
+      reset_attributes_format
+      raise e
+    end
+
+    # Reformat the attributes before POST to server
+    def reformat_before_save(blocking)
+      attributes = @attributes.dup
+      @attributes.clear
+      @attributes["secret_key"] = JanioAPI.config.api_token
+      # set blocking until label generated
+      @attributes["blocking"] = blocking
+      # reformat attributes
+      @attributes["orders"] = [attributes]
+    end
+
+    def reset_attributes_format
+      attributes = @attributes.dup
+      @attributes.clear
+      load(attributes.delete("orders")[0])
+    end
+
+    def load_attributes_from_response(response)
+      # reset the attributes structure before assign attributes that came back from server
+      reset_attributes_format
+
+      # 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)
+        attributes.merge!(attributes["orders"][0]).delete("orders")
+        load(attributes, false, true)
+        @persisted = true
+      end
+    end
+  end
+end

data/lib/janio_api/version.rb

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

data/lib/janio_api.rb

@@ -0,0 +1,22 @@
+require "janio_api/version"
+require "active_resource"
+require_relative "zeitwerk_loader"
+require "dotenv/load"
+module JanioAPI
+  class << self
+    attr_accessor :config
+
+    def configure
+      self.config ||= Configuration.new
+      yield(config)
+    end
+  end
+
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+JanioAPI.configure do |config|
+  config.api_host = ENV["API_HOST"]
+  config.api_token = ENV["API_TOKEN"]
+end

data/lib/zeitwerk_loader.rb

@@ -0,0 +1,14 @@
+require "zeitwerk"
+
+$__janio_api_loader__ = Zeitwerk::Loader.for_gem
+$__janio_api_loader__.inflector.inflect(
+  "janio_api" => "JanioAPI"
+)
+$__janio_api_loader__.push_dir("lib")
+$__janio_api_loader__.collapse("lib/janio_api/resources")
+$__janio_api_loader__.enable_reloading
+# loader.log!
+$__janio_api_loader__.setup
+def reload!
+  $__janio_api_loader__.reload
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: janio_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Chong
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-14 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:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- janio_api.gemspec
+- lib/janio_api.rb
+- lib/janio_api/configuration.rb
+- lib/janio_api/connection.rb
+- lib/janio_api/redirect_fetcher.rb
+- lib/janio_api/resources/base.rb
+- lib/janio_api/resources/order.rb
+- lib/janio_api/version.rb
+- lib/zeitwerk_loader.rb
+homepage: https://github.com/PostCo/janio_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/PostCo/janio_api
+  source_code_uri: https://github.com/PostCo/janio_api
+  changelog_uri: https://github.com/PostCo/janio_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 Janio API wrapper.
+test_files: []