tttelematics 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bdd512d7d7c164be169515f471c19b29be4d1b5a0b5d7ed2ebb1fe37f0d20f1f
+  data.tar.gz: 921b0b6584e92409a8bcde66b1a75f4e8a28e63e51fae3dff3d72397dd383968
+SHA512:
+  metadata.gz: c7e80edcd9594631f44be89bc0956dd0447970850381fdbba1d5598b980de80601b50ee4870475d638d6155749e4fbd3c0665c9d6dea2d21bb4fe9aa46eb8790
+  data.tar.gz: 87cec370478191bfae88eb9156cd9b8c0630f9010095518745803733dbb054f22f9eeee04bc91461e4f579a8301552efd6b2d81adba85fb1adfbe28619fd66fb

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 S·Fleet
+
+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,56 @@
+# TTTelematics
+A simple ruby API Wrapper for TomTomTelematics
+
+## 1. Quick start
+
+Install via Rubygems
+
+```ruby
+gem install tttelematics
+```
+
+... or add to Gemfile
+
+```ruby
+gem 'tttelematics'
+```
+
+## 2. Initialize Client
+
+```ruby
+client = TTTelematics::API::Client.new('apikey','username','account','password')
+```
+
+
+## 3. Get Objects
+For more options [Resources Objects TomTomTelematics](https://telematics.tomtom.com/static/help/webfleet-connect/en_gb/index.htm#Objects.htm).
+
+### 3.1 showObjectReportExtern
+[More details](https://telematics.tomtom.com/static/help/webfleet-connect/en_gb/index.htm#showObjectReportExtern.htm)
+
+```ruby
+#format = ['json','csv']
+#client.asset.objects(options, format)
+
+client.asset({objectno: 'OBJECTID'}, 'json')
+or 
+asset = client.asset
+objects = asset.objects({}, 'json')
+
+asset = TTTelematics::API::Asset.new(client)
+objects = asset({objectno: 'OBJECTID'}, 'json') #response a json
+
+array_objects = JSON.parse(objects)
+```
+## 4. Errors
+[More details](https://telematics.tomtom.com/static/help/webfleet-connect/en_gb/index.htm#Responsecodes-wfc.htm)
+
+```ruby
+# Common Errors
+
+TTTelematics::Err::InvalidAPIKey -> API key is invalid
+TTTelematics::Err::InvalidUser -> User does not exist
+TTTelematics::Err::InvalidAction -> Action is not valid
+
+
+```

data/lib/TTTelematics/asset.rb

@@ -0,0 +1,28 @@
+module TTTelematics
+  module API
+    class Asset < Base
+      PERMIT_KEYS =  ({ filterstring: 'string', 
+                     objectgroupname: 'string', 
+                     oungroupedonlye: 'string',
+                     objectno: 'string',
+                     objectuid: 'string',
+                     externalid: 'string'}).freeze
+      ACTION_OBJECTS_METHOD = 'showObjectReportExtern'.freeze
+
+      def objects(options = {}, format = 'json')
+        validates(options,format)
+        request = Request.new(@client)
+        response = request.get(ACTION_OBJECTS_METHOD, options, format)
+        response.body
+      end
+
+      private
+      def validates(options, format)
+        raise ArgumentError unless Validator.check_keys?(PERMIT_KEYS, options)
+        raise TypeError unless Validator.check_type_values?(PERMIT_KEYS, options)
+        raise ArgumentError unless Validator.check_format?(format)
+        true
+      end
+    end
+  end
+end

data/lib/TTTelematics/client.rb

@@ -0,0 +1,28 @@
+module TTTelematics
+  module API
+    class Client
+      attr_reader :api_key, :username, :account, :password
+      def initialize(api_key, username, account, password)
+        raise TypeError unless validate_options?(api_key, username, account, password)
+        @api_key = api_key
+        @username = username
+        @account = account 
+        @password = password 
+      end
+
+      def asset
+        Asset.new(self)
+      end
+
+      private
+      def validate_options?(*args)
+        flag = true
+        args.each do |a|
+          flag = (!a.nil? && a.class == String && !a.empty?)
+          break unless flag
+        end
+        return flag
+      end
+    end
+  end
+end

data/lib/TTTelematics/err.rb

@@ -0,0 +1,21 @@
+module TTTelematics
+  module Err
+    class InvalidAPIKey < StandardError 
+      def message
+        'API key is invalid'
+      end
+    end
+
+    class InvalidUser < StandardError
+      def message
+        'User does not exist'
+      end
+    end
+
+    class InvalidAction < StandardError
+      def message
+        'action is not valid'
+      end
+    end
+  end
+end

data/lib/TTTelematics/request.rb

@@ -0,0 +1,49 @@
+module TTTelematics
+  module API
+    class Request < Base
+      require 'faraday'
+      require 'json'
+      require 'byebug'
+      LANG = 'en'.freeze
+      def get(action, params, format = 'json')
+        if (action.is_a?(String)) && 
+           !(action.nil?) &&
+           !(action.empty?)
+           
+          params = generate_params(action, params, format)
+          response = Faraday.get(BASE_URL, params) 
+          handle_response(response)
+          response
+        else
+          raise TypeError
+        end
+      end
+      private
+        def generate_params(action, params, format)
+           params = params
+           params[:action] = action
+           params[:outputformat] = format
+           params[:account] = @client.account
+           params[:apikey] = @client.api_key
+           params[:username] = @client.username
+           params[:password] = @client.password
+           params[:lang] = LANG 
+           params
+        end
+
+        def handle_response(response)
+          body = JSON.parse(response.body)
+          begin
+            errCode = body['errorCode']
+          rescue TypeError
+            errCode = nil
+          end
+          unless errCode.nil?
+            raise TTTelematics::Err::InvalidAPIKey if body['errorCode'] == 1143
+            raise TTTelematics::Err::InvalidUser if body['errorCode'] == 1101
+            raise TTTelematics::Err::InvalidAction if body['errorCode'] == 55
+          end
+        end
+    end
+  end
+end

data/lib/TTTelematics/validator.rb

@@ -0,0 +1,28 @@
+module Validator
+  FORMAT_VALID = ['json', 'csv'].freeze 
+  def self.check_keys?(permitted, options)
+    permitted_keys = permitted.keys.map(&:to_s)
+    option_keys = options.keys.map(&:to_s)
+    (option_keys - permitted_keys).size <= 0
+  end
+
+  def self.check_type_values?(permit_keys, values)
+    err_flag = true
+    values.each do |key, value|
+      type = permit_keys[key.to_sym]
+      if type == 'string'
+        err_flag = (value.is_a?(String)) 
+      elsif type == 'integer'
+        err_flag = (value.is_a?(Integer)) 
+      else
+        err_flag = false
+      end
+      break unless err_flag
+    end
+    err_flag
+  end
+
+  def self.check_format?(format)
+    FORMAT_VALID.include? format.to_s.downcase
+  end
+end

data/lib/TTTelematics/version.rb

@@ -0,0 +1,3 @@
+module TTTelematics
+  VERSION = '0.0.2'
+end

data/lib/tttelematics.rb

@@ -0,0 +1,26 @@
+#Modules
+require_relative './TTTelematics/validator'
+
+#Errors
+require_relative './TTTelematics/err'
+
+require_relative './TTTelematics/version'
+
+module TTTelematics
+  module API
+    class Base
+      BASE_URL = 'https://csv.telematics.tomtom.com/extern'.freeze
+
+      def initialize(client)
+        raise TypeError if !(client.is_a?(Client)) 
+        @client = client
+      end
+    end
+  end
+end
+
+#classes
+require_relative './TTTelematics/asset'
+require_relative './TTTelematics/request' 
+require_relative './TTTelematics/client'
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: tttelematics
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alexei Mamani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: A simple API wrapper for Tom Tom Telematics
+email: alexeim763@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/TTTelematics/asset.rb
+- lib/TTTelematics/client.rb
+- lib/TTTelematics/err.rb
+- lib/TTTelematics/request.rb
+- lib/TTTelematics/validator.rb
+- lib/TTTelematics/version.rb
+- lib/tttelematics.rb
+homepage: https://github.com/s-fleet/tom_tom_telematics
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key: 
+specification_version: 4
+summary: a simple client for Tom Tom Telematics
+test_files: []