ax-track 0.2.5 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e294f6bd99ab7e87c04391742d8f670ade8cb020c53fac68eb0a5849bc5675
-  data.tar.gz: 960a6e7a575c81141cec86665ed328599cadf98afe5c28260a53e78e2b075bbf
+  metadata.gz: 64ef65462f1efd6dc741c8abfc2b1ef96b3cf4ab852f62ce44af60250690d86e
+  data.tar.gz: d610a397e1f547867a1a5b6429858d73e3f1b3b6cc87b6eaf9ba9537e047733b
 SHA512:
-  metadata.gz: 86d54e1f259fbb4486d9bc5e465ae3ad322055dc29ab0588c04677975e0d73f8e93ce6337ae288cc0e3fbcc45c6efcc89f158485826c3503209c6b8f1e954b59
-  data.tar.gz: ce387bfd144fc624417b4dae73148303dfe87be436643ab4df523c49ef46f3ff8fc0d881338c52ee4027f243eebdcc1861e3ed28631fdd4ea539c35e4025c133
+  metadata.gz: 892cbf5549bcc97265b8f0922ebc45750adb22b618f9838b5c7728688ebe75882213c55028a40e68e301840e7612ce94ba4547b5ac976122dcec6ce47a0d7162
+  data.tar.gz: df2aa12059668f758bd40d484c299f1a66af998dd3c5191bf7efed0ee5cc69686ca4332e146423f9639cdc09490428e517bc9e71ad41b2d1f918804d2d9f5f28

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ax-track (0.2.5)
+    ax-track (0.3)
       faraday (~> 1.7)
       faraday_middleware (~> 1.1)
 
@@ -28,7 +28,7 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    faraday_middleware (1.1.0)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     minitest (5.14.4)
     multipart-post (2.1.1)
@@ -56,6 +56,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
   ax-track!
@@ -64,4 +65,4 @@ DEPENDENCIES
   rubocop (~> 1.7)
 
 BUNDLED WITH
-   2.2.19
+   2.2.29

data/README.md

@@ -24,9 +24,31 @@ Or install it yourself as:
     $ gem install axTrack
 
 ## Usage
+### Configure the client
+The Gem is configured by default to work with the public platform of Adnexo at
+* API: `https://prod.api.ax-track.ch/api/v1`
+* User Interface: `https://app.ax-track.ch/#/map/assets/`
 
+If you want the gem to use a different URL, create a file in the initializer folder
+```ruby
+# folder: `config/initializers/ax-track.rb`
+AxTrack.set_base_url_api = 'NEW API URL'
+AxTrack.set_base_url_user = 'NEW USER URL'
+```
+
+If you want to test which URL is configures, you can
+```ruby
+AxTrack.base_url_api
+=> "https://prod.api.ax-track.ch/api/v1"
+AxTrack.base_url_user
+=> "https://app.ax-track.ch/#/map/assets/"
+```
+
+### Instantiate a client
 ```ruby
 client = AxTrack::Client.new(api_key: your_api_key)
+# Or if you have a ENV['AXTRACK_API_KEY'] set, you don't need to pass in the api key.
+client = AxTrack::Client.new
 ```
 
 ### Trackers
@@ -35,9 +57,30 @@ client = AxTrack::Client.new(api_key: your_api_key)
 client.tracker.list
 
 # Get the specific information of a specific tracker. If :asset_id is invalid, a AxTrack::Resource::NotFoundError is returned
-client.tracker.retrieve(:tracker_id)
+record = client.tracker.retrieve(:tracker_id)
+```
+
+You will receive an object AxTrack::Tracker (or a collection for the list call), where you can comfortably access each value
+```ruby
+record.asset_id
+=> 1361
+# The name on asset_id
+record.name
+=> #Name of asset on AxTrack#
+record.identifier
+=> "70B3D57050006F3B"
+record.model
+=> "dm-oyster"
+
+# To access any asset details directly on the tracker just do
+record.asset_details
+
+# To get an array with all sensors
+record.available_sensor_data
+ => ["gps", "temperature", "battery", "humidity"]
 ```
 
+
 ### Assets
 ```ruby
 # Get a list of all assets
@@ -52,15 +95,19 @@ client.asset.update(:tracker_id, params)
 client.tracker.update(:tracker_id, name: 'New name')
 ```
 
-### Errors
-
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+To test the application in the console
+```ruby
+client = AxTrack::Client.new(api_key: _YOUR_API_KEY_)
+# to get a list of all trackers (just as an example)
+client.trackers
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/axTrack.
@@ -70,4 +117,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Open development
-* Pagination for development
+* Pagination for development
+
+

data/lib/ax-track.rb

@@ -16,4 +16,30 @@ module AxTrack
   autoload :TrackerResource, 'ax_track/resources/tracker_resource'
   autoload :AssetResource, 'ax_track/resources/asset_resource'
 
+  @@base_url_api = 'https://prod.api.ax-track.ch/api/v1'.freeze
+  @@base_url_user = 'https://app.ax-track.ch/#/map/assets/'.freeze
+  InvalidURL = Class.new(StandardError)
+
+  def self.base_url_api
+    @@base_url_api
+  end
+
+  def self.set_base_url_api=(new_base_url_api)
+    raise InvalidURL.new 'This is not a valid URL' unless new_base_url_api =~ URI::regexp
+    @@base_url_api = new_base_url_api
+
+  end
+
+  def self.base_url_user
+    @@base_url_user
+  end
+
+  def self.set_base_url_user=(new_base_url_user = nil)
+    raise InvalidURL.new 'This is not a valid URL' unless new_base_url_user =~ URI::regexp
+    new_base_url_user = new_base_url_user + "/" unless new_base_url_user[-1] == '/'
+    @@base_url_user = new_base_url_user
+  end
+
+
+
 end

data/lib/ax_track/client.rb

@@ -4,18 +4,13 @@ require 'faraday_middleware'
 module AxTrack
 
   class Client
-    # include HttpStatusCodes
-    # include ApiExceptions
-
-    BASE_URL = 'https://prod.api.ax-track.ch/api/v1'.freeze
-
     APIKeyMissing = Class.new(StandardError)
 
     attr_reader :api_key, :adapter
     attr_writer :connection
 
     def initialize(api_key: nil, adapter: nil, stubs: nil)
-      @api_key  = api_key || ENV['AXTRACK_API_KEY']
+      @api_key  = api_key&.strip || ENV['AXTRACK_API_KEY']&.strip
       @adapter  = adapter || Faraday.default_adapter
       @stubs    = stubs
 
@@ -32,12 +27,13 @@ module AxTrack
     end
 
     def connection
-      @connection ||= Faraday.new(BASE_URL) do |conn|
+      @connection ||= Faraday.new(AxTrack.base_url_api) do |conn|
         #conn.request :url_encoded
         conn.request :json
         conn.response :json, content_type: 'application/json'
         conn.adapter adapter, @stubs
         conn.headers['Authorization'] = "Token #{api_key}" unless api_key.empty?
+        conn.options.timeout = 20
       end
     end
   end

data/lib/ax_track/objects/tracker.rb

@@ -11,7 +11,7 @@ module AxTrack
     end
 
     def name
-      @name = @asset_details['name']
+      @name ||= asset_details.name
     end
 
     def last_message_timestamp
@@ -20,7 +20,7 @@ module AxTrack
 
     def last_gps_position
       #GPSPosition.new(@last_gps_measurement || { lat: asset_details.lat, lng: asset_details.lng } )
-      GPSPosition.new(@last_gps_measurement)
+      GPSPosition.new(@last_gps_measurement) unless @last_gps_measurement.nil?
     end
 
     def battery
@@ -32,7 +32,7 @@ module AxTrack
     end
 
     def website_url
-      "https://app.ax-track.ch/#/map/assets/#{@id}"
+      "#{AxTrack.base_url_user}#{@id}"
     end
 
     def available_sensor_data
@@ -40,7 +40,7 @@ module AxTrack
       sensor_data_temp = self.sensor_data.keys
       # if no timestamp is available in the GPSPosition, then there wasn't a last_gps_measurement returned in the json
       # hence the sensor doesn't contain a GPS module.
-      sensor_data_temp = sensor_data_temp.unshift('gps') if self.last_gps_position.respond_to? :timestamp
+      sensor_data_temp = sensor_data_temp.unshift('gps') if self.last_gps_position&.respond_to? :timestamp
       sensor_data_temp
     end
   end

data/lib/ax_track/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AxTrack
-  VERSION = "0.2.5"
+  VERSION = "0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ax-track
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: '0.3'
 platform: ruby
 authors:
 - Philipp Baumann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-17 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: API Wrapper for AX Track (from Adnexo).