ax-track-ruby-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2aafcc13472293e19ebff4ca09a931f47337f139631f89679ef7b4ff4872ba3
+  data.tar.gz: b6f0fe9494ed96c5b88f1e33c09b2aa9ed99a073c18f2897607c5d8bc6375ec8
+SHA512:
+  metadata.gz: c74cc67d1a9ad6a8e5f356ebc460994a4b35767a631468603c4cc64aeb8289bb379a03d7194b5a236370dec40072ecd997a39491a5948065dc3714dc7d04a3e1
+  data.tar.gz: 25534232f081ac3cd8e9b6d0538b0136d2bd73f48e8f73fff292bf2a830faf1eb3229fc94756cb663ad772e1961b4c0a377fdf6403057484cb5fd0ebce4a81d3

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-10-03
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in axTrack.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    ax-track-ruby-client (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    minitest (5.14.4)
+    multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.22.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  ax-track-ruby-client!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Philipp Baumann
+
+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,67 @@
+# AxTrack
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/axTrack`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'axTrack'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install axTrack
+
+## Usage
+
+```ruby
+client == AxTrack::Client.new(api_key: your_api_key)
+```
+
+### Trackers
+```ruby
+# Get a list of all trackers
+client.tracker.list
+
+# Get the specific information of a specific tracker
+client.tracker.retrieve(:tracker_id)
+```
+
+### Assets
+```ruby
+# Get a list of all assets
+client.asset.list
+
+# Get a specific asset
+client.asset.retrieve(:asset_id)
+
+# Update a specif asset
+client.asset.update(:tracker_id, params)
+#t Example: to update the name
+client.tracker.update(:tracker_id, name: 'New name')
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/axTrack.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Open development
+* Pagination for development

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/axTrack.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/axTrack/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ax-track-ruby-client"
+  spec.version       = AxTrack::VERSION
+  spec.authors       = ["Philipp Baumann"]
+  spec.email         = ["philipp@timly.ch"]
+
+  spec.summary       = "API Wrapper for AX Track (from Adnexo)."
+  spec.description   = "Official library for the AX Track application."
+  spec.homepage      = "https://ax-track.ch/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/adnexo-GmbH/ax-track-ruby-client"
+  spec.metadata["changelog_uri"]   = "https://github.com/adnexo-GmbH/ax-track-ruby-client/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "AxTrack"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/axTrack/client.rb

@@ -0,0 +1,38 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module AxTrack
+
+  class Client
+    # include HttpStatusCodes
+    # include ApiExceptions
+
+    BASE_URL = 'https://prod.api.ax-track.ch/api/v1'.freeze
+
+    attr_reader :api_key, :adapter
+    def initialize(api_key: ENV['AXTRACK_API_KEY'], adapter: Faraday.default_adapter)
+      @api_key = api_key
+      @adapter = adapter
+    end
+
+    def trackers
+      TrackerResource.new(self)
+    end
+
+
+    def assets
+      AssetResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        #conn.request :url_encoded
+        conn.request :json
+        conn.response :json, content_type: 'application/json'
+        conn.adapter Faraday.default_adapter
+        conn.headers['Authorization'] = "Token #{api_key}" unless api_key.empty?
+      end
+    end
+
+  end
+end

data/lib/axTrack/collection.rb

@@ -0,0 +1,25 @@
+module AxTrack
+  class Collection
+    attr_reader :data, :total, :next_cursor, :prev_cursor
+
+    # key is the subset of the json_response for which to create an array
+    # 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')
+      )
+    end
+
+    def initialize (data:, total:, next_cursor:, prev_cursor:)
+      @data = data
+      @total = total
+      @next_cursor = next_cursor.nil? || next_cursor.empty? ? nil : next_cursor
+      @prev_cursor = prev_cursor.nil? || prev_cursor.empty? ? nil : prev_cursor
+    end
+
+  end
+end

data/lib/axTrack/error.rb

@@ -0,0 +1,4 @@
+module AxTrack
+  class Error < StandardError; end
+end
+

data/lib/axTrack/object.rb

@@ -0,0 +1,18 @@
+require 'ostruct'
+
+module AxTrack
+  class Object
+
+    # 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
+
+  end
+end

data/lib/axTrack/objects/asset.rb

@@ -0,0 +1,14 @@
+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/axTrack/objects/tracker.rb

@@ -0,0 +1,37 @@
+module AxTrack
+  class Tracker < Object
+
+    def initialize(json_response)
+      @id =               json_response['id']
+      @url =              json_response['url']
+      @active =           json_response['active']
+      @model =            json_response['model']
+      @axtrack_asset_id = json_response['asset']
+      @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']
+      @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.delete('battery')
+      @sensor_data =      sensor_data
+
+      create_getters
+    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
+
+    end
+
+  end
+end

data/lib/axTrack/resource.rb

@@ -0,0 +1,61 @@
+
+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)
+
+    HTTP_OK_CODE = 200
+
+    HTTP_BAD_REQUEST_CODE = 400
+    HTTP_UNAUTHORIZED_CODE = 401
+    HTTP_FORBIDDEN_CODE = 403
+    HTTP_NOT_FOUND_CODE = 404
+    HTTP_UNPROCESSABLE_ENTITY_CODE = 429
+
+    def initialize(client)
+      @client = client
+      @response = nil
+    end
+
+    def request(http_method: :get, endpoint:, headers: {}, params: {}, body: {}, result_subset: nil)
+      raise "Client not defined" unless defined? @client
+      endpoint = endpoint + "/" unless endpoint[-1] == "/"
+      @response = client.connection.public_send(http_method, endpoint, params.merge(body))
+
+      unless response_successful?
+        raise error_class(response.status), "Code: #{response.status}, response: #{response.reason_phrase}"
+      end
+
+      result_subset ? response[result_subset.to_s] : response
+    end
+
+    def error_class(status)
+      case status
+      when HTTP_BAD_REQUEST_CODE
+        BadRequestError
+      when HTTP_UNAUTHORIZED_CODE
+        UnauthorizedError
+      when HTTP_FORBIDDEN_CODE
+        ForbiddenError
+      when HTTP_NOT_FOUND_CODE
+        NotFoundError
+      when HTTP_UNPROCESSABLE_ENTITY_CODE
+        UnprocessableEntityError
+      else
+        ApiError
+      end
+    end
+
+    def response_successful?
+      response.status == HTTP_OK_CODE
+    end
+  end
+end

data/lib/axTrack/resources/asset_resource.rb

@@ -0,0 +1,23 @@
+module AxTrack
+  class AssetResource < Resource
+
+    def list(per_page: nil, cursor: nil)
+      Collection.from_response response = request(endpoint: "assets",
+                                                  params: {per_page: per_page, cursor: cursor}.compact),
+                               key: 'results',
+                               type: Asset
+    end
+
+    def retrieve(asset_id)
+      Asset.new request(http_method: :get,
+                          endpoint: "assets/#{asset_id}").body
+    end
+
+    def update(asset_id, **attributes)
+      Asset.new request(http_method: :patch,
+                        endpoint:  "assets/#{asset_id}",
+                        body: attributes).body
+
+    end
+  end
+end

data/lib/axTrack/resources/tracker_resource.rb

@@ -0,0 +1,17 @@
+module AxTrack
+  class TrackerResource < Resource
+
+    def list(per_page: nil, cursor: nil)
+      Collection.from_response response = request(endpoint: "trackers",
+                                                  params: {per_page: per_page, cursor: cursor}.compact),
+                               key: 'results',
+                               type: Tracker
+    end
+
+    def retrieve(tracker_id)
+      Tracker.new request(http_method: :get,
+                          endpoint: "trackers/#{tracker_id}").body
+    end
+
+  end
+end

data/lib/axTrack/version.rb

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

data/lib/axTrack.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "axTrack/version"
+
+module AxTrack
+  autoload :Client, 'axTrack/client'
+  autoload :Collection, 'axTrack/collection'
+  autoload :Error, 'axTrack/error'
+  autoload :Object, 'axTrack/object'
+  autoload :Resource, 'axTrack/resource'
+
+  autoload :Tracker, 'axTrack/objects/tracker'
+  autoload :Asset, 'axTrack/objects/asset'
+
+  autoload :TrackerResource, 'axTrack/resources/tracker_resource'
+  autoload :AssetResource, 'axTrack/resources/asset_resource'
+
+  class TrackerData < Object; end
+  class TrackersList < Object; end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: ax-track-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philipp Baumann
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Official library for the AX Track application.
+email:
+- philipp@timly.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- axTrack.gemspec
+- bin/console
+- bin/setup
+- lib/axTrack.rb
+- lib/axTrack/client.rb
+- lib/axTrack/collection.rb
+- lib/axTrack/error.rb
+- lib/axTrack/object.rb
+- lib/axTrack/objects/asset.rb
+- lib/axTrack/objects/tracker.rb
+- lib/axTrack/resource.rb
+- lib/axTrack/resources/asset_resource.rb
+- lib/axTrack/resources/tracker_resource.rb
+- lib/axTrack/version.rb
+homepage: https://ax-track.ch/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://ax-track.ch/
+  source_code_uri: https://github.com/adnexo-GmbH/ax-track-ruby-client
+  changelog_uri: https://github.com/adnexo-GmbH/ax-track-ruby-client/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: API Wrapper for AX Track (from Adnexo).
+test_files: []