webfleet_connect 0.1.0

data/lib/webfleet_connect/default_config.rb

@@ -0,0 +1,46 @@
+class WebfleetConnect::DefaultConfig
+  HOST = 'csv.webfleet.com'
+  PATH = 'extern'
+
+  def initialize(args = {})
+    args = default_arguments.merge(args)
+    @lang       = args[:lang]
+    @format     = args[:format]
+    @useUTF8    = args[:useUTF8]
+    @useISO8601 = args[:useISO8601]
+  end
+
+  def to_s
+    "#{base_url}?#{lang}&#{format}&#{useUTF8}&#{useISO8601}"
+  end
+
+  def json?
+    @format == :json
+  end
+
+  private
+
+  def default_arguments
+    { lang: :en, format: :csv, useUTF8: false, useISO8601: false }
+  end
+
+  def base_url
+    "https://#{HOST}/#{PATH}"
+  end
+
+  def lang
+    "lang=#{@lang}"
+  end
+
+  def format
+    "outputformat=#{@format}"
+  end
+
+  def useUTF8
+    "useUTF8=#{@useUTF8}"
+  end
+
+  def useISO8601
+    "useISO8601=#{@useISO8601}"
+  end
+end

data/lib/webfleet_connect/enums/devices.rb

@@ -0,0 +1,10 @@
+module WebfleetConnect::Enums::Devices
+  def link()    :link    end
+  def ecoPLUS() :ecoPLUS end
+  def link100() :link100 end
+  def link510() :link510 end
+  def link610() :link610 end
+  def link710() :link710 end
+  def phone()   :phone   end
+  def tablet()  :tablet  end
+end

data/lib/webfleet_connect/enums/special_vehicle_types.rb

@@ -0,0 +1,7 @@
+module WebfleetConnect::Enums::SpecialVehicleTypes
+  def ambulance() :ambulance end
+  def firetruck() :firetruck end
+  def police()    :police    end
+  def taxi()      :taxi      end
+  def taxi_uk()   :taxi_uk   end
+end

data/lib/webfleet_connect/enums/vehicle_types.rb

@@ -0,0 +1,49 @@
+module WebfleetConnect::Enums::VehicleTypes
+  def ape()                       :ape                       end
+  def barge()                     :barge                     end
+  def bike()                      :bike                      end
+  def boom_lift()                 :boom_lift                 end
+  def boom_lift_truck()           :boom_lift_truck           end
+  def bus()                       :bus                       end
+  def caddy()                     :caddy                     end
+  def car()                       :car                       end
+  def car_station_wagon()         :car_station_wagon         end
+  def concrete_lorry()            :concrete_lorry            end
+  def containership()             :containership             end
+  def crane()                     :crane                     end
+  def deposit_tipper()            :deposit_tipper            end
+  def dump_truck()                :dump_truck                end
+  def dump_truck_open()           :dump_truck_open           end
+  def excavator()                 :excavator                 end
+  def garbage_truck()             :garbage_truck             end
+  def heavy_truck()               :heavy_truck               end
+  def heavytruck_us()             :heavytruck_us             end
+  def heavyweight_truck()         :heavyweight_truck         end
+  def heavyweight_truck_trailer() :heavyweight_truck_trailer end
+  def lighttruck()                :lighttruck                end
+  def light_truck_pallet()        :light_truck_pallet        end
+  def loader()                    :loader                    end
+  def medium_truck()              :medium_truck              end
+  def multicar()                  :multicar                  end
+  def multivan()                  :multivan                  end
+  def pallet_truck()              :pallet_truck              end
+  def pickup()                    :pickup                    end
+  def smart()                     :smart                     end
+  def sprinter()                  :sprinter                  end
+  def street_sweeper()            :street_sweeper            end
+  def suv()                       :suv                       end
+  def tanker_truck()              :tanker_truck              end
+  def telescopic_handler()        :telescopic_handler        end
+  def tractor()                   :tractor                   end
+  def trailer()                   :trailer                   end
+  def train()                     :train                     end
+  def truck()                     :truck                     end
+  def truck_loader_arm()          :truck_loader_arm          end
+  def truck_trailer()             :truck_trailer             end
+  def truck_with_trailer()        :truck_with_trailer        end
+  def truck_wrecker()             :truck_wrecker             end
+  def van()                       :van                       end
+  def vespa()                     :vespa                     end
+  def wrecker()                   :wrecker                   end
+  def yacht()                     :yacht                     end
+end

data/lib/webfleet_connect/error.rb

@@ -0,0 +1,34 @@
+require_relative 'format_handlers/json_response_parser'
+require_relative 'format_handlers/csv_response_error_parser'
+
+module WebfleetConnect
+  class Error < StandardError
+    SITE = 'https://www.webfleet.com'
+    PATH = '/static/help/webfleet-connect/en_gb/index.html'
+
+    attr_reader :code, :url
+
+    def initialize(message, url, is_json)
+      parser = build_parser(is_json)
+      hash = parser.to_hash(message)
+      @code = hash[:errorCode]
+      @message = hash[:errorMsg]
+      @url = url
+    end
+
+    def message
+      "#{code}, #{@message}\n\nCheck #{api_docs_url} for more details.\n\n"
+    end
+
+    private
+
+    def api_docs_url
+      "#{SITE}#{PATH}"
+    end
+
+    def build_parser(is_json)
+      return FormatHandlers::JsonResponseParser.new if is_json
+      FormatHandlers::CsvResponseErrorParser.new
+    end
+  end
+end

data/lib/webfleet_connect/format_handlers/csv_error_parser.rb

@@ -0,0 +1,16 @@
+require_relative 'error_parser'
+
+module WebfleetConnect::FormatHandlers
+  class CsvErrorParser < ErrorParser
+    def error?(message)
+      code = message.split(',').first
+      four_digit_number?(code)
+    end
+
+    private
+
+    def four_digit_number?(string)
+      /\A\d+\z/ === string
+    end
+  end
+end

data/lib/webfleet_connect/format_handlers/csv_response_error_parser.rb

@@ -0,0 +1,11 @@
+require 'csv'
+
+module WebfleetConnect::FormatHandlers
+  class CsvResponseErrorParser
+    def to_hash(message)
+      values = message.split(',')
+      coupled_values = [:errorCode, :errorMsg].zip(values)
+      Hash[coupled_values]
+    end
+  end
+end

data/lib/webfleet_connect/format_handlers/csv_response_parser.rb

@@ -0,0 +1,25 @@
+require 'csv'
+
+module WebfleetConnect::FormatHandlers
+  class CsvResponseParser
+    def to_hash(message)
+      csv = parse(message)
+      hash = format(csv)
+      symbolized_hash(hash)
+    end
+
+    private
+
+    def parse(text)
+      CSV.parse(text, headers: true, col_sep: ';')
+    end
+
+    def format(csv)
+      csv.map(&:to_h)
+    end
+
+    def symbolized_hash(hash)
+      hash.map { |h| h.transform_keys(&:to_sym) }
+    end
+  end
+end

data/lib/webfleet_connect/format_handlers/error_parser.rb

@@ -0,0 +1,11 @@
+module WebfleetConnect::FormatHandlers
+  class ErrorParser
+    def initialize(session)
+      @session = session
+    end
+
+    def error?(response)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/webfleet_connect/format_handlers/json_error_parser.rb

@@ -0,0 +1,17 @@
+require_relative 'error_parser'
+
+module WebfleetConnect::FormatHandlers
+  class JsonErrorParser < ErrorParser
+    def error?(message)
+      json = to_json(message)
+      return false if json.is_a?(Array)
+      json.key?(:errorCode)
+    end
+
+    private
+
+    def to_json(message)
+      JSON.parse(message, symbolize_names: true)
+    end
+  end
+end

data/lib/webfleet_connect/format_handlers/json_response_parser.rb

@@ -0,0 +1,9 @@
+require 'json'
+
+module WebfleetConnect::FormatHandlers
+  class JsonResponseParser
+    def to_hash(message)
+      JSON.parse(message, symbolize_names: true)
+    end
+  end
+end

data/lib/webfleet_connect/helpers/case_helper.rb

@@ -0,0 +1,18 @@
+module WebfleetConnect::Helpers::CaseHelper
+  def pascal_to_snake(str)
+    str.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+  end
+
+  def pascal_to_cammel(str)
+    str[0].downcase + str[1..]
+  end
+
+  def snake_to_pascal(str)
+    str.split('_').map(&:capitalize).join('')
+  end
+
+  def snake_to_cammel(str)
+    pascal = snake_to_pascal(str)
+    pascal_to_cammel(pascal)
+  end
+end

data/lib/webfleet_connect/helpers/class_helper.rb

@@ -0,0 +1,5 @@
+module WebfleetConnect::Helpers::ClassHelper
+  def class_name
+    self.class.to_s.split('::').last
+  end
+end

data/lib/webfleet_connect/helpers/date_format_helper.rb

@@ -0,0 +1,13 @@
+module WebfleetConnect::Helpers::DateFormatHelper
+  def to_de(datetime)
+    datetime.strftime('%d.%m.%Y %H:%M:%S')
+  end
+
+  def to_en(datetime)
+    datetime.strftime('%d/%m/%Y %H:%M:%S')
+  end
+
+  def to_nl
+    datetime.strftime('%d-%m-%Y %H:%M:%S')
+  end
+end

data/lib/webfleet_connect/helpers/encoding_helper.rb

@@ -0,0 +1,8 @@
+require 'base64'
+require_relative '../helpers'
+
+module WebfleetConnect::Helpers::EncodingHelper
+  def base64_encode(text)
+    Base64.encode(text)
+  end
+end

data/lib/webfleet_connect/helpers.rb

@@ -0,0 +1,2 @@
+module WebfleetConnect::Helpers
+end

data/lib/webfleet_connect/params/default_param.rb

@@ -0,0 +1,16 @@
+require_relative 'param'
+
+module WebfleetConnect::Params
+  class DefaultParam < Param
+    def initialize(key, value)
+      @key = key
+      @value = value
+    end
+
+    private
+
+    def param
+      @key
+    end
+  end
+end

data/lib/webfleet_connect/params/param.rb

@@ -0,0 +1,23 @@
+require_relative '../helpers/class_helper'
+require_relative '../helpers/case_helper'
+
+module WebfleetConnect
+  class Params::Param
+    include Helpers::ClassHelper
+    include Helpers::CaseHelper
+
+    def initialize(value)
+      @value = value
+    end
+
+    def to_s
+      "&#{param}=#{@value}"
+    end
+
+    private
+
+    def param
+      pascal_to_snake(class_name)
+    end
+  end
+end

data/lib/webfleet_connect/params/params.rb

@@ -0,0 +1,2 @@
+module WebfleetConnect::Params
+end

data/lib/webfleet_connect/params/params_factory.rb

@@ -0,0 +1,22 @@
+require_relative 'params'
+require_relative 'default_param'
+require_relative 'rangefrom_string'
+require_relative 'rangeto_string'
+require_relative 'range_pattern'
+
+module WebfleetConnect::Params
+  module ParamsFactory
+    def build_params(args)
+      args.map { |k, v| build(k, v) }
+    end
+
+    private
+
+    def build(param, value)
+      return RangePattern.new(value)    if param == :range_pattern
+      return RangefromString.new(value) if param == :rangefrom_string
+      return RangetoString.new(value)   if param == :rangeto_string
+      DefaultParam.new(param, value)
+    end
+  end
+end

data/lib/webfleet_connect/params/range_pattern.rb

@@ -0,0 +1,39 @@
+require_relative 'param'
+
+module WebfleetConnect::Params
+  class RangePattern < Param
+    def initialize(value)
+      @value = format(value)
+    end
+
+    private
+
+    VALID_OPTIONS = {
+      today:                    'd0',
+      yesterday:                'd-1',
+      two_days_ago:             'd-2',
+      three_days_ago:           'd-3',
+      four_days_ago:            'd-4',
+      five_days_ago:            'd-5',
+      six_days_ago:             'd-6',
+      current_week:             'w0',
+      last_week:                'w-1',
+      two_weeks_ago:            'w-2',
+      three_weeks_ago:          'w-3',
+      floating_week:            'wf0',
+      last_floating_week:       'wf-1',
+      two_floating_weeks_ago:   'wf-2',
+      three_floating_weeks_ago: 'wf-3',
+      current_month:            'm0',
+      last_month:               'm-1',
+      two_months_ago:           'm-2',
+      three_months_ago:         'm-3',
+      user_defined_range:       'ud',
+      ud:                       'ud'
+    }
+
+    def format(value)
+      VALID_OPTIONS[value.to_sym] || value
+    end
+  end
+end

data/lib/webfleet_connect/params/rangefrom_string.rb

@@ -0,0 +1,23 @@
+require_relative 'param'
+require_relative '../helpers/date_format_helper'
+
+module WebfleetConnect::Params
+  class RangefromString < Param
+    include WebfleetConnect::Helpers::DateFormatHelper
+
+    def initialize(value)
+      @value = format(value)
+    end
+
+    private
+
+    def format(value)
+      return value if string?(value)
+      to_en(value)
+    end
+
+    def string?(value)
+      value.class == String
+    end
+  end
+end

data/lib/webfleet_connect/params/rangeto_string.rb

@@ -0,0 +1,9 @@
+require_relative 'rangefrom_string'
+
+module WebfleetConnect::Params
+  class RangetoString < RangefromString
+    def initialize(value)
+      @value = format(value)
+    end
+  end
+end

data/lib/webfleet_connect/response.rb

@@ -0,0 +1,33 @@
+require_relative 'format_handlers/json_response_parser'
+require_relative 'format_handlers/csv_response_parser'
+
+module WebfleetConnect
+  class Response
+    attr_reader :url
+
+    def initialize(response, url, is_json)
+      @response = response
+      @url = url
+      @parser = build_parser(is_json)
+    end
+
+    def status_code
+      @response.code
+    end
+
+    def to_hash
+      @parser.to_hash(@response.body)
+    end
+
+    def to_s
+      @response.body
+    end
+
+    private
+
+    def build_parser(is_json)
+      return FormatHandlers::JsonResponseParser.new if is_json
+      FormatHandlers::CsvResponseParser.new
+    end
+  end
+end

data/lib/webfleet_connect/session.rb

@@ -0,0 +1,44 @@
+require_relative 'actions/addresses'
+require_relative 'actions/drivers'
+require_relative 'actions/events'
+require_relative 'actions/geocoding'
+require_relative 'actions/messages'
+require_relative 'actions/miscellaneous'
+require_relative 'actions/objects'
+require_relative 'actions/orders'
+require_relative 'actions/trips'
+require_relative 'connection'
+
+module WebfleetConnect
+  class WebfleetConnect::Session
+    include Actions::Addresses
+    include Actions::Drivers
+    include Actions::Events
+    include Actions::Geocoding
+    include Actions::Messages
+    include Actions::Miscellaneous
+    include Actions::Objects
+    include Actions::Orders
+    include Actions::Trips
+
+    def initialize(credentials, config)
+      @credentials = credentials
+      @config = config
+      @connection = Connection.new(self)
+    end
+
+    def json?
+      @config.json?
+    end
+
+    private
+
+    def exec(action)
+      @connection.exec(url(action))
+    end
+
+    def url(action)
+      "#{@config}&#{@credentials}&#{action}"
+    end
+  end
+end

data/lib/webfleet_connect/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module WebfleetConnect
+  VERSION = "0.1.0"
+end

data/lib/webfleet_connect.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'webfleet_connect/version'
+require_relative 'webfleet_connect/builder'
+
+module WebfleetConnect
+  def self.create(args = {})
+    Builder.create(args)
+  end
+end

data/sig/webfleet_connect.rbs

@@ -0,0 +1,4 @@
+module WebfleetConnect
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/webfleet_connect.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/webfleet_connect/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "webfleet_connect"
+  spec.version = WebfleetConnect::VERSION
+  spec.authors = ["alex"]
+  spec.email = ["alex.guajardo@movomx.com"]
+
+  spec.summary = "Gem to consume Webfleet connect api."
+  spec.description = "The WEBFLEET.connect API connects software appli­ca­tions with the Webfleet fleet management solution. Via WEBFLEET.connect you can enhance the value of all types of business solutions, including routing and scheduling optimization, ERP, Transport Management System (TMS), supply chain planning, asset management, and much more."
+  spec.homepage = "https://movomx.com"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = "https://github.com/movomx/webfleet_connect"
+  spec.metadata["source_code_uri"] = "https://github.com/movomx/webfleet_connect"
+  spec.metadata["changelog_uri"] = "https://github.com/movomx/webfleet_connect"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty', "~> 0.21.0"
+  spec.add_dependency 'json', '2.6.3'
+  spec.add_dependency 'csv', '~> 3.2', '>= 3.2.7'
+  spec.add_development_dependency "rspec", "~> 3.2"
+end