quelink-mg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65d82d1ee48bd09561636c3a37c45d215f83c859b5b0973d53fab2dab2000e99
+  data.tar.gz: 3b072ed25d29451bed4b73b23d1a97953b0839351cdbeac1de61c71d30d89f13
+SHA512:
+  metadata.gz: a36b701c8db093fa3439ae34fa0ed73d34e8e579342d069eb626824bf32e4bd8c01f3698b5cd2f703aa9c7189e12f3badedeab517b3ea9281112ece9eec642f8
+  data.tar.gz: a8807739c2796ce72d53fc5c22f13238a15459b3e7d5734679d86e7429ef7c906ee33a20e9f796a0b10aed2af2be9e0c0fbf95cf0de81d50d2d3bf320b9de558

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require:
+  - rubocop-rspec
+AllCops:
+  DisplayCopNames: true
+  NewCops: enable
+  TargetRubyVersion: 3.1
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 15
+Metrics/BlockLength:
+  Max: 40
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Max: 20
+Layout/LineLength:
+  Exclude: 
+    - spec/quelink_mg/resp/*_spec.rb

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    quelink-mg (0.1.0)
+      activesupport (~> 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    minitest (5.19.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.21.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  pry (~> 0.13)
+  quelink-mg!
+  rspec (~> 3.9)
+  rubocop (~> 1.0)
+  rubocop-rspec (~> 2.2)
+
+BUNDLED WITH
+   2.4.7

data/README.md

@@ -0,0 +1,26 @@
+# quelink-mg
+Management of commands sent or received from QUELINK-300 device serie. Tested with MG-310 and MG-320
+
+## Instalation
+
+The quelink-mg gem is available at rubygems.org. You can install with:
+
+`gem install quelink-mg`
+
+Alternatively, you can install the gem with bundler:
+
+\# Gemfile
+
+`gem 'quelink-mg'`
+
+After doing bundle install, you should have the gem installed in your bundle.
+
+## Development
+
+Building gem locally (you can change file name, ofc):
+gem build *.gemspec -o pkg/quelink-mg.gem
+
+Installing:
+gem install pkg/quelink-mg.gem
+
+

data/lib/quelink-mg/ack/base.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module QuelinkMg
+  module Ack
+    class Base
+      QUELINK_DATE_FORMAT = '%Y%m%d%H%M%S'
+
+      def initialize(response:)
+        @response = response
+      end
+
+      private
+
+      def float?(value)
+        !Float(value, exception: false).nil?
+      end
+
+      def integer?(value)
+        !Integer(value, exception: false).nil?
+      end
+
+      def date?(value)
+        date = DateTime.strptime(value, QUELINK_DATE_FORMAT)
+
+        !date.nil? && (date - DateTime.now).abs < 3 * 365
+      rescue Date::Error
+        false
+      end
+
+      def transform_with_timezone(value)
+        QuelinkMg.configuration.time_zone.strptime(value, QUELINK_DATE_FORMAT)
+      end
+
+      def unify_keys(hash)
+        hash.transform_values do |v|
+          if date?(v)
+            transform_with_timezone(v)
+          elsif integer?(v)
+            v.to_i
+          elsif float?(v)
+            v.to_f
+          else
+            v
+          end
+        end
+      end
+    end
+  end
+end

data/lib/quelink-mg/ack/gtbsi.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module QuelinkMg
+  module Ack
+    class Gtbsi < Base
+      GTBSI_ACK_KEYS = %w[protocol_version unique_id device_name serial_number send_time count_number].freeze
+
+      def hash
+        unify_keys(GTBSI_ACK_KEYS.zip(@response.split(',')).to_h)
+      end
+    end
+  end
+end

data/lib/quelink-mg/at/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class InvalidATGTBSIException < StandardError; end
+
+module QuelinkMg
+  module At
+    class Base
+      def initialize(params:)
+        @params = params
+      end
+
+      private
+
+      def verify_params(acceptable_values, error)
+        acceptable_values.each do |k, v|
+          next if v.include?(@params.fetch(k, nil))
+
+          raise_error(k, error)
+        end
+      end
+
+      def raise_error(type, error)
+        raise error, "Wrong #{type}: #{@params}"
+      end
+
+      def reserved; end
+    end
+  end
+end

data/lib/quelink-mg/at/gtbsi.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module QuelinkMg
+  module At
+    class Gtbsi < Base
+      def message
+        validate_values
+
+        "AT+GTBSI=#{joined_params}$"
+      end
+
+      private
+
+      GTBSI_VALID_PARAMS = %i[password lte_apn lte_apn_user_name ltn_apn_password gprs_apn gprs_apn_user_name
+                              gprs_apn_password network_mode lte_mode apn_authentication_methods manual_netreg
+                              reserved reserved reserved reserved serial_number].freeze
+
+      def joined_params
+        GTBSI_VALID_PARAMS.map { |method| @params.fetch(method, nil) }.join(',')
+      end
+
+      def validate_values
+        acceptable_values = {
+          network_mode: (0..3),
+          lte_mode: (0..3),
+          apn_authentication_methods: (0..3),
+          manual_netreg: (0..5)
+        }
+
+        verify_params(acceptable_values, InvalidATGTBSIException)
+      end
+    end
+  end
+end

data/lib/quelink-mg/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module QuelinkMg
+  class Configuration
+    attr_accessor :time_zone
+
+    DEFAULT_ZONE = ActiveSupport::TimeZone.new('Europe/Warsaw')
+    def initialize
+      @time_zone = DEFAULT_ZONE
+      Time.zone = @time_zone
+    end
+  end
+end

data/lib/quelink-mg/resp/base.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module QuelinkMg
+  module Resp
+    class Base
+      QUELINK_DATE_FORMAT = '%Y%m%d%H%M%S'
+
+      def initialize(response:)
+        @response = response
+      end
+
+      private
+
+      def float?(value)
+        !Float(value, exception: false).nil?
+      end
+
+      def integer?(value)
+        !Integer(value, exception: false).nil?
+      end
+
+      def date?(value)
+        date = DateTime.strptime(value, QUELINK_DATE_FORMAT)
+
+        !date.nil? && (date - DateTime.now).abs < 3 * 365
+      rescue Date::Error
+        false
+      end
+
+      def transform_with_timezone(value)
+        QuelinkMg.configuration.time_zone.strptime(value, QUELINK_DATE_FORMAT)
+      end
+
+      def unify_keys(hash)
+        hash.transform_values do |v|
+          if date?(v)
+            transform_with_timezone(v)
+          elsif integer?(v)
+            v.to_i
+          elsif float?(v)
+            v.to_f
+          else
+            v
+          end
+        end
+      end
+    end
+  end
+end

data/lib/quelink-mg/resp/gtfri.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module QuelinkMg
+  module Resp
+    class Gtfri < Base
+      GTFRI_RESP_KEYS = %w[protocol_version unique_id device_name report_id report_type number
+                           gps_accuracy speed azimuth elevation longitude latitude gps_utc_time
+                           mcc mnc lac cell_id odo_mileage battery_percentage send_time count_number].freeze
+
+      def hash
+        unify_keys(GTFRI_RESP_KEYS.zip(@response.split(',')).to_h)
+      end
+    end
+  end
+end

data/lib/quelink_mg.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'date'
+require 'active_support'
+require 'active_support/time_with_zone'
+require 'active_support/core_ext/time/zones'
+
+require File.expand_path('quelink-mg/at/base.rb', __dir__)
+require File.expand_path('quelink-mg/at/gtbsi.rb', __dir__)
+require File.expand_path('quelink-mg/resp/base.rb', __dir__)
+require File.expand_path('quelink-mg/resp/gtfri.rb', __dir__)
+require File.expand_path('quelink-mg/ack/base.rb', __dir__)
+require File.expand_path('quelink-mg/ack/gtbsi.rb', __dir__)
+require File.expand_path('quelink-mg/configuration.rb', __dir__)
+
+module QuelinkMg
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/quelink-mg.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'quelink-mg'
+  s.version     = '0.1.0'
+  s.summary     = 'Quelink devices command reader and writer'
+  s.description = 'Quelink devices command reader and writer'
+  s.authors     = ['Stanislaw Zawadzki']
+  s.email       = 'st.zawadzki@gmail.com'
+
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.require_paths = ['lib']
+  s.license       = 'MIT'
+  s.required_ruby_version = '>= 3.1'
+  s.add_dependency 'activesupport', '~> 7.0'
+  s.add_development_dependency 'pry', '~> 0.13'
+  s.add_development_dependency 'rspec', '~> 3.9'
+  s.add_development_dependency 'rubocop', '~> 1.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.2'
+#  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/spec/quelink_mg/ack/gtbsi_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe QuelinkMg::Ack::Gtbsi do
+  it 'parses valid response' do
+    response = 'D40102,868239051011356,,0040,20210816045509,004F'
+    parsed_response = described_class.new(response:).hash
+    expect(parsed_response['protocol_version']).to eq 'D40102'
+    expect(parsed_response['unique_id']).to eq 868_239_051_011_356
+    expect(parsed_response['send_time']).to eq Time.zone.strptime('20210816045509',
+                                                                  QuelinkMg::Resp::Base::QUELINK_DATE_FORMAT)
+  end
+end

data/spec/quelink_mg/at/gtbsi_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe QuelinkMg::At::Gtbsi do
+  it 'creates command when params are valid' do
+    params =
+      {
+        password: 'qwerty',
+        lte_apn: 'https://apn.org/',
+        network_mode: 0,
+        lte_mode: 0,
+        apn_authentication_methods: 0,
+        manual_netreg: 0,
+        serial_number: 'ABFF'
+      }
+
+    expect(described_class.new(params:).message).to eq 'AT+GTBSI=qwerty,https://apn.org/,,,,,,0,0,0,0,,,,,ABFF$'
+  end
+
+  it 'raises error on missing params' do
+    expect { described_class.new(params: {}).message }.to raise_error(InvalidATGTBSIException)
+  end
+
+  it 'raises error on improper params' do
+    params =
+      {
+        password: 'qwerty',
+        lte_apn: 'https://apn.org/',
+        network_mode: 10,
+        lte_mode: 10,
+        apn_authentication_methods: 0,
+        manual_netreg: 0,
+        serial_number: 'ABFF'
+      }
+
+    expect { described_class.new(params:).message }.to raise_error(InvalidATGTBSIException)
+  end
+end

data/spec/quelink_mg/resp/gtfri_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe QuelinkMg::Resp::Gtfri do
+  it 'parses valid response' do
+    response = 'C30204,860201061504521,,0,0,1,1,0.0,0,96.2,21.012847,52.200338,20230813061232,0260,0003,E31F,0447020D,,34,20230813061231,3E94'
+
+    parsed_response = described_class.new(response:).hash
+    expect(parsed_response).not_to eq({})
+    expect(parsed_response['send_time']).to eq Time.zone.strptime('20230813061231',
+                                                                  QuelinkMg::Resp::Base::QUELINK_DATE_FORMAT)
+    expect(parsed_response['gps_utc_time']).to eq Time.zone.strptime('20230813061232',
+                                                                     QuelinkMg::Resp::Base::QUELINK_DATE_FORMAT)
+    expect(parsed_response['longitude']).to eq 21.012847
+    expect(parsed_response['latitude']).to eq 52.200338
+    expect(parsed_response['unique_id']).to eq 860_201_061_504_521
+    expect(parsed_response['battery_percentage']).to eq 34
+    expect(parsed_response['device_name']).to eq ''
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../lib/quelink_mg'
+
+QuelinkMg.configure do |config|
+  config.time_zone = QuelinkMg::Configuration::DEFAULT_ZONE
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: quelink-mg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stanislaw Zawadzki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Quelink devices command reader and writer
+email: st.zawadzki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/quelink-mg/ack/base.rb
+- lib/quelink-mg/ack/gtbsi.rb
+- lib/quelink-mg/at/base.rb
+- lib/quelink-mg/at/gtbsi.rb
+- lib/quelink-mg/configuration.rb
+- lib/quelink-mg/resp/base.rb
+- lib/quelink-mg/resp/gtfri.rb
+- lib/quelink_mg.rb
+- quelink-mg.gemspec
+- spec/quelink_mg/ack/gtbsi_spec.rb
+- spec/quelink_mg/at/gtbsi_spec.rb
+- spec/quelink_mg/resp/gtfri_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Quelink devices command reader and writer
+test_files: []