ax-track 0.1.12 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa4b99e8a29421bcac73b9d8d3191c5071af4b09b5d5310c1e151ed1693ce04
-  data.tar.gz: b2365bc080c408a30d0f2d5a810dbd1bf76884d79de66275a0c2fac954eaeae5
+  metadata.gz: 34c0014b35fd2c5751cd11b90c99730472099f0218fe121f19add0e28b14d9f9
+  data.tar.gz: 9ddee5341711f61bdc51961363b4434dff2cacd11d16ae7791f45327db975ad3
 SHA512:
-  metadata.gz: 149e09e93ba9bd1cd2f51d92517cd3c188ae016960639c9d76878a5a0b7d36a95d579b48f0c149a2f05af6f540f6a550433c1ea34c965a0cf2aa1ebdab155f9f
-  data.tar.gz: 8a4fc87c81f411c861a7f684219bfaad36ac54ed3ae7733557baa3a0a1121e9d40f126feb596fd45dab42dd87e670995040d61d1b196139ab3f1ab400031d0ba
+  metadata.gz: 785311de5a3ce20c3ef733055b001a2af4aae4e035bb2fa3ee07ca816bf32dd45a123cd830237e136cbc741a24bcb3b8e1302a9f15ea7e3e938982f000213da8
+  data.tar.gz: 27b1852ba78ada2a75b7ba2dceca80a264e4f67a37bcf19f7b784cceb7985ea2501517187ce60c6e20950664a0df203104992d5182f41eacf0c05c0bbd763350

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ax-track (0.1.12)
+    ax-track (0.2.1)
       faraday (~> 1.7)
       faraday_middleware (~> 1.1)
 

data/README.md

@@ -34,7 +34,7 @@ client = AxTrack::Client.new(api_key: your_api_key)
 # Get a list of all trackers
 client.tracker.list
 
-# Get the specific information of a specific tracker
+# Get the specific information of a specific tracker. If :asset_id is invalid, a AxTrack::Resource::NotFoundError is returned
 client.tracker.retrieve(:tracker_id)
 ```
 
@@ -43,7 +43,7 @@ client.tracker.retrieve(:tracker_id)
 # Get a list of all assets
 client.asset.list
 
-# Get a specific asset
+# Get a specific asset. If :asset_id is invalid, a AxTrack::Resource::NotFoundError is returned
 client.asset.retrieve(:asset_id)
 
 # Update a specif asset
@@ -52,6 +52,9 @@ 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.

data/lib/ax-track.rb

@@ -11,6 +11,7 @@ module AxTrack
 
   autoload :Tracker, 'ax_track/objects/tracker'
   autoload :Asset, 'ax_track/objects/asset'
+  autoload :GPSPosition, 'ax_track/objects/tracker/gps_position'
 
   autoload :TrackerResource, 'ax_track/resources/tracker_resource'
   autoload :AssetResource, 'ax_track/resources/asset_resource'

data/lib/ax_track/client.rb

@@ -12,9 +12,12 @@ module AxTrack
     APIKeyMissing = Class.new(StandardError)
 
     attr_reader :api_key, :adapter
-    def initialize(api_key: ENV['AXTRACK_API_KEY'], adapter: Faraday.default_adapter)
-      @api_key = api_key
-      @adapter = adapter
+    attr_writer :connection
+
+    def initialize(api_key: nil, adapter: nil, stubs: nil)
+      @api_key  = api_key || ENV['AXTRACK_API_KEY']
+      @adapter  = adapter || Faraday.default_adapter
+      @stubs    = stubs
 
       raise APIKeyMissing, "No API key provided" if !defined?(api_key) || api_key.nil? ||  api_key.empty?
     end
@@ -33,10 +36,9 @@ module AxTrack
         #conn.request :url_encoded
         conn.request :json
         conn.response :json, content_type: 'application/json'
-        conn.adapter Faraday.default_adapter
+        conn.adapter adapter, @stubs
         conn.headers['Authorization'] = "Token #{api_key}" unless api_key.empty?
       end
     end
-
   end
 end

data/lib/ax_track/collection.rb

@@ -6,15 +6,13 @@ module AxTrack
     # type is the class Type to wrap the results from key
     def self.from_response(json_response, key:, type: )
       body = json_response.body
-      new(
-        data: body[key].map { |attrs| type.new(attrs ) },
-        total: body.dig('count'),
-        next_cursor: body.dig('next'),
-        prev_cursor: body.dig('previous')
-      )
+      new(data: body[key].map { |attrs| type.new(attrs ) },
+          total: body.dig('count'),
+          next_cursor: body.dig('next'),
+          prev_cursor: body.dig('previous'))
     end
 
-    def initialize (data:, total:, next_cursor:, prev_cursor:)
+    def initialize(data:, total:, next_cursor:, prev_cursor:)
       @data = data
       @total = total
       @next_cursor = next_cursor.nil? || next_cursor.empty? ? nil : next_cursor

data/lib/ax_track/object.rb

@@ -3,14 +3,20 @@ require 'ostruct'
 module AxTrack
   class Object
 
+    def initialize(json_response)
+      # for each key create an own instance variable with a getter
+      json_response.each do |key, value|
+        instance_variable_set "@#{key}", value
+      end
+
+      create_getters
+    end
+
     # pass in an array for getters which should be generated.
     # if nothing is passed in, it will create an instance variable for all instance variables.
     def create_getters(required_getter_methods = instance_variables.map { |attr_name| attr_name[1..-1 ]})
       required_getter_methods.each do |attr|
         singleton_class.send :attr_reader, attr unless self.respond_to? attr
-        # define_singleton_method(v.to_s.tr('@','')) do
-        #   instance_variable_get(v)
-        # end
       end
     end
 

data/lib/ax_track/objects/asset.rb

@@ -1,14 +1,4 @@
 module AxTrack
   class Asset < Object
-
-    def initialize(json_response)
-      # for each key create an own instance variable with a getter
-      json_response.each do |key, value|
-        instance_variable_set "@#{key}", value
-      end
-
-      create_getters
-    end
   end
-
 end

data/lib/ax_track/objects/tracker/gps_position.rb

@@ -0,0 +1,15 @@
+module AxTrack
+  class Tracker
+    class GPSPosition < Object
+
+      def initialize(json_response)
+        @lat =       json_response['lat']
+        @lng =       json_response['lng']
+        @timestamp = DateTime.parse(json_response['timestamp'], false) if json_response['timestamp']
+
+        create_getters
+      end
+
+    end
+  end
+end

data/lib/ax_track/objects/tracker.old

@@ -0,0 +1,42 @@
+module AxTrack
+  class Tracker < Object
+
+    def initialize(json_response)
+      @tracker_id        = json_response['id']
+      @asset_id          = json_response['asset']
+      @identifier        = json_response['identifier']
+      @url               = json_response['url']
+      @active            = json_response['active']
+      @model             = json_response['model']
+      @asset_details     = Asset.new json_response['asset_details'] if json_response['asset_details']
+      @name              =  json_response.dig('asset_details', 'name')
+      @last_message_timestamp = DateTime.parse(json_response['last_message_timestamp'], false) if json_response['last_message_timestamp']
+      @url               = json_response['url']
+      @user_url          = website_url
+      @last_gps_position = GPSPosition.new(json_response['last_gps_measurement'] || json_response['asset_details'])
+
+      @battery           = json_response.dig('asset_details', 'sensor_data', 'battery', 'value')
+      sensor_data        = json_response.dig('asset_details', 'sensor_data')
+
+      @sensor_data       = sensor_data
+
+      @network           = json_response['network']
+
+      create_getters
+    end
+
+    def available_sensor_data
+      # returns a hash with available senson data
+      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
+    end
+
+    def website_url
+      "https://app.ax-track.ch/#/map/assets/#{@tracker_id}"
+    end
+
+  end
+end

data/lib/ax_track/objects/tracker.rb

@@ -1,53 +1,39 @@
 module AxTrack
   class Tracker < Object
 
-    def initialize(json_response)
-      @tracker_id        = json_response['id']
-      @asset_id          = json_response['asset']
-      @identifier        = json_response['identifier']
-      @url               = json_response['url']
-      @active            = json_response['active']
-      @model             = json_response['model']
-      @asset_details     = Asset.new json_response['asset_details'] if json_response['asset_details']
-      @name              =  json_response.dig('asset_details', 'name')
-      @last_message_timestamp = DateTime.parse(json_response['last_message_timestamp'], false) if json_response['last_message_timestamp']
-      @url               = json_response['url']
-      @user_url          = website_url
-      @last_gps_position = GPSPosition.new(json_response['last_gps_measurement'] || json_response['asset_details'])
-
-      @battery           = json_response.dig('asset_details', 'sensor_data', 'battery', 'value')
-      sensor_data        = json_response.dig('asset_details', 'sensor_data')
+    def asset_details
+      @asset_details = Asset.new @asset_details unless @asset_details.is_a? Asset
+      @asset_details
+    end
 
-      @sensor_data       = sensor_data
+    def name
+      @name = @asset_details['name']
+    end
 
-      @network           = json_response['network']
+    def last_message_timestamp
+      DateTime.parse(@last_message_timestamp, false) if @last_message_timestamp
+    end
 
-      create_getters
+    def last_gps_position
+      #GPSPosition.new(@last_gps_measurement || { lat: asset_details.lat, lng: asset_details.lng } )
+      GPSPosition.new(@last_gps_measurement)
     end
 
-    def available_sensor_data
-      # returns a hash with available senson data
-      sensor_data_temp = self.sensor_data.keys
-      sensor_data_temp = sensor_data_temp.unshift('gps') if self.respond_to? :last_gps_position
-      sensor_data_temp
+    def battery
+      asset_details&.sensor_data.dig('battery', 'value')
     end
 
     def website_url
       "https://app.ax-track.ch/#/map/assets/#{@tracker_id}"
     end
 
-
-    class GPSPosition < Object
-
-      def initialize(json_response)
-        @lat =       json_response['lat']
-        @lng =       json_response['lng']
-        @timestamp = DateTime.parse(json_response['timestamp'], false) if json_response['timestamp']
-
-        create_getters
-      end
-
+    def available_sensor_data
+      # returns a hash with available senson data
+      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
     end
-
   end
 end

data/lib/ax_track/resource.rb

@@ -3,14 +3,13 @@ module AxTrack
   class Resource
     attr_reader :client, :response
 
-    GithubAPIError = Class.new(StandardError)
-    BadRequestError = Class.new(GithubAPIError)
-    UnauthorizedError = Class.new(GithubAPIError)
-    ForbiddenError = Class.new(GithubAPIError)
-    ApiRequestsQuotaReachedError = Class.new(GithubAPIError)
-    NotFoundError = Class.new(GithubAPIError)
-    UnprocessableEntityError = Class.new(GithubAPIError)
-    ApiError = Class.new(GithubAPIError)
+    ApiError = Class.new(StandardError)
+    BadRequestError = Class.new(ApiError)
+    UnauthorizedError = Class.new(ApiError)
+    ForbiddenError = Class.new(ApiError)
+    ApiRequestsQuotaReachedError = Class.new(ApiError)
+    NotFoundError = Class.new(ApiError)
+    UnprocessableEntityError = Class.new(ApiError)
 
     HTTP_OK_CODE = 200
 
@@ -28,6 +27,14 @@ module AxTrack
     def request(http_method: :get, endpoint:, headers: {}, params: {}, body: {}, result_subset: nil)
       raise "Client not defined" unless defined? @client
       endpoint = endpoint + "/" unless endpoint[-1] == "/"
+
+      body['picture'] = Faraday::UploadIO.new(
+                  body['picture'].tempfile.path,
+                  body['picture'].content_type,
+                  body['picture'].filename
+                ) if body.key? :picture
+
+      # client.connection['headers']['Content-Type'] = 'multipart/form-data' if body.key? :picture
       @response = client.connection.public_send(http_method, endpoint, params.merge(body))
 
       unless response_successful?
@@ -43,9 +50,7 @@ module AxTrack
         BadRequestError
       when HTTP_UNAUTHORIZED_CODE
         UnauthorizedError
-      when HTTP_FORBIDDEN_CODE
-        ForbiddenError
-      when HTTP_NOT_FOUND_CODE
+      when HTTP_NOT_FOUND_CODE, HTTP_FORBIDDEN_CODE
         NotFoundError
       when HTTP_UNPROCESSABLE_ENTITY_CODE
         UnprocessableEntityError

data/lib/ax_track/resources/asset_resource.rb

@@ -13,10 +13,11 @@ module AxTrack
                           endpoint: "assets/#{asset_id}").body
     end
 
-    def update(asset_id, **attributes)
+    def update(asset_id, headers: {}, **attributes)
       Asset.new request(http_method: :patch,
                         endpoint:  "assets/#{asset_id}",
-                        body: attributes).body
+                        body: attributes,
+                        headers: {}).body
 
     end
   end

data/lib/ax_track/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ax-track
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.2.1
 platform: ruby
 authors:
 - Philipp Baumann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -63,7 +63,9 @@ files:
 - lib/ax_track/error.rb
 - lib/ax_track/object.rb
 - lib/ax_track/objects/asset.rb
+- lib/ax_track/objects/tracker.old
 - lib/ax_track/objects/tracker.rb
+- lib/ax_track/objects/tracker/gps_position.rb
 - lib/ax_track/resource.rb
 - lib/ax_track/resources/asset_resource.rb
 - lib/ax_track/resources/tracker_resource.rb