shipping_connector 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98c92bddd04b8f92e6630534b66d4e169583db1264fd56ae0ae664aed41e2ebf
+  data.tar.gz: 48e528d536d25680d36127600bb785ac267ce11b9a082b0b4c2df94ff8ad5b60
+SHA512:
+  metadata.gz: be449f20f233c15e90b0a2679d878eac4dfefaddf95645f62eaf474888db9a79369a2ebc2fb2c2c76e81a4a6e95064c2a4de35459749d317bddcb6cf7e5a0e9c
+  data.tar.gz: b48be38a98eb8cc2f341d0177b491b2eb23859a098d782f8b358b117828dd6268fbcc4f3b04fe33360cca592ac5a643b0270cc38f935d793bbc9e1660df27dc2

data/lib/shipping_connector/carrier/dao.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module ShippingConnector
+  class Dao < Carrier
+    self.url = 'https://api.dao.as'
+
+    # Initializes a new carrier object for DAO
+    # @overload initialize(customer_id, password)
+    #   @param customer_id [Integer] login details for the API user
+    #   @param password [String] login details for the API user
+    #
+    def initialize(options = {})
+      require! options, :customer_id, :password
+      super
+    end
+
+    # Returns a list of service points or a single service point
+    # @overload service_points(scope, zip_code, address, limit = 10)
+    #   @param scope [Symbol] the scope: `:list` for listing nearest service points
+    #   @param zip_code [Integer, String] zip code for address to search from
+    #   @param address [String] street address to search from
+    #   @param limit [Integer] amount of service points to be returned
+    #   @return [Array<ServicePoint>] the nearest service points ordered by distance
+    # @overload service_points(id)
+    #   @param id [Integer] the `id` of the service_point to be returned
+    #   @return [ServicePoint] the service point for the given `id`
+    def service_points(*arguments)
+      scope   = arguments.slice!(0)
+      options = arguments.slice!(0) || {}
+
+      case scope
+      when :list
+        list_service_points(options)
+      else
+        find_service_point(scope)
+      end
+    end
+
+    private
+
+    def auth_params
+      { kundeid: @options[:customer_id], kode: @options[:password] }
+    end
+
+    def find_service_point(id)
+
+      service_point = get('/DAOPakkeshop/FindPakkeshop.php', { id: id })['pakkeshops'].first
+
+      ServicePoint.new(id: service_point['shopId'], name: service_point['navn'],
+                       address: service_point['adresse'], zip_code: service_point['postnr'],
+                       city: service_point['bynavn'], opening_hours: opening_hours(service_point['aabningstider']))
+    end
+
+    def list_service_points(options)
+      require! options, :zip_code, :address
+
+      array = get('/DAOPakkeshop/FindPakkeshop.php',
+                  {
+                    postnr: options[:zip_code],
+                    adresse: options[:address],
+                    antal: options[:limit] || 10
+                  })['pakkeshops']
+
+      generate_service_points array
+    end
+
+    def get(path, params)
+      response = super(path, params.merge(auth_params))
+      body = JSON.parse response.body
+
+      return body['resultat'] if body['status'] == 'OK'
+
+      raise StandardError, "DAO errror ##{body['fejlkode']}: #{body['fejltekst']}"
+    end
+
+    def generate_service_points(array)
+      result = []
+      array.each do |service_point|
+        result << ServicePoint.new(id: service_point['shopId'], name: service_point['navn'],
+                                   address: service_point['adresse'], zip_code: service_point['postnr'],
+                                   city: service_point['bynavn'], distance: service_point['afstand'],
+                                   opening_hours: opening_hours(service_point['aabningstider']))
+      end
+      result
+    end
+
+    def opening_hours(args)
+      hash = {}
+
+      args.each do |weekday, hours|
+        hash[weekdays[weekday]] = hours
+      end
+
+      ServicePoint::OpeningHours.new(hash)
+    end
+
+    def weekdays
+      { 'man' => :monday, 'tir' => :tuesday, 'ons' => :wednesday, 'tor' => :thursday,
+        'fre' => :friday, 'lor' => :saturday, 'son' => :sunday }
+    end
+  end
+end

data/lib/shipping_connector/carrier.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/class/attribute'
+require 'faraday'
+require 'json'
+
+module ShippingConnector
+  class Carrier
+    class_attribute :url
+
+    def initialize(options = {})
+      @options = options
+      self.url = options[:mock_url] if options[:mock_url]
+    end
+
+    def require!(hash, *options)
+      options.each do |option|
+        raise ArgumentError, "Missing required parameter: #{option}" unless hash.key? option
+      end
+    end
+
+    private
+
+    # TODO: rescue HTTP error codes (or not?)
+    def get(path, params)
+      connection.get(path, params)
+    end
+
+    def connection
+      Faraday.new url
+    end
+  end
+end

data/lib/shipping_connector/carriers.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'carrier/dao'

data/lib/shipping_connector/service_point.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ShippingConnector
+  class ServicePoint
+    attr_accessor :id, :name, :address, :zip_code, :city, :distance, :opening_hours
+
+    def initialize(params = {})
+      params.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+    class OpeningHours
+      attr_accessor :monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday
+
+      def initialize(params)
+        params.each { |key, value| instance_variable_set("@#{key}", value) }
+      end
+    end
+  end
+end

data/lib/shipping_connector.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'json'
+require 'active_support/core_ext/class/attribute'
+
+require 'shipping_connector/carrier'
+require 'shipping_connector/carriers'
+require 'shipping_connector/service_point'

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: shipping_connector
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Simon Thyregod Kristensen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-24 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      ShippingConnector is an abstraction library that makes connecting to various shipping
+      carriers' APIs easier. As with everything Ruby, the goal is to make writing code that
+      handles shipping logic fast and comfortable
+email: git@simon.thyregod.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/shipping_connector.rb
+- lib/shipping_connector/carrier.rb
+- lib/shipping_connector/carrier/dao.rb
+- lib/shipping_connector/carriers.rb
+- lib/shipping_connector/service_point.rb
+homepage: https://github.com/sthyregod/shipping_connector
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A simple shipping_connector abstraction library
+test_files: []