acuitydata 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc211a7f6fb29e84ed8ed05d737cfdd418e20d3c3894281205712aefe017e59f
-  data.tar.gz: a3f0e6192ef8d500035cf8287446c76a34307d76ada594192985e98fa573c48a
+  metadata.gz: 83fa915b9218cc72fce45e4ed2e9c29bcc8384f2f5e02a5aba283b03dcb8561a
+  data.tar.gz: beeda1ee638c6dd78de6c941c2017e861935708e6459c59dca95177451931f69
 SHA512:
-  metadata.gz: 59043be3a18863175ba13d518cf3ab38a2b7754e4354a4327a86a87272171c78369d8c18d6e1280e37f62086dbfcaf357ec6f7a9d972275ff7a6dce380b2c5e0
-  data.tar.gz: 5c3d7594c51910668fc564f1cf93ebc5343feec70b55bc507ccf9620f2c7f85d794650bcc9ccf8ed425bec0bf37838ec198d5e48536f7de4fff77c8125cc178c
+  metadata.gz: 209c38dedca45a28d4ebae02b343038c59214cb27f4bd93359dc43d2a02bb3ce3a5e6d7053552193e387c5bc6ca8b9eee89a19d74c6fb37b811f12a93c13ecb8
+  data.tar.gz: 97dfe79e1384ea0c2771f5f891745f8632be0dfe3ffe7023816500d31a127919c323735faf61cdfa086a627844ed987d5d72b3d70b4b9d303c627b1605a8a135

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behaviour that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behaviour by participants include:
+
+* The use of sexualised language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviours that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported by contacting the project team at contact@jasonchalom.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/TRex22/acuitydata" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: .
+  specs:
+    acuitydata (0.0.2)
+      active_attr (~> 0.16.0)
+      httparty (~> 0.21.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    active_attr (0.16.0)
+      actionpack (>= 3.0.2, < 7.2)
+      activemodel (>= 3.0.2, < 7.2)
+      activesupport (>= 3.0.2, < 7.2)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ansi (1.5.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    crass (1.0.6)
+    drb (2.2.1)
+    erubi (1.12.0)
+    hashdiff (1.1.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.22.3)
+    minitest-focus (1.4.0)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.6.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (2.1.0)
+      ruby2_keywords (>= 0.0.5)
+    multi_xml (0.6.0)
+    mutex_m (0.2.0)
+    nokogiri (1.16.3-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.3-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.3-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.3-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.3-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rack (3.0.9.1)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rake (13.1.0)
+    rexml (3.2.6)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    timecop (0.9.8)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webmock (3.23.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  acuitydata!
+  minitest (~> 5.22.3)
+  minitest-focus (~> 1.4.0)
+  minitest-reporters (~> 1.6.1)
+  mocha (~> 2.1.0)
+  pry (~> 0.14.2)
+  rake (~> 13.1.0)
+  timecop (~> 0.9.8)
+  webmock (~> 3.23.0)
+
+BUNDLED WITH
+   2.5.5

data/README.md

@@ -0,0 +1,58 @@
+# api.acuitydata.co.za API Client
+An API client for AcuityData
+This is an unofficial project and still a work in progress (WIP)
+
+Based on this website: api.acuitydata.co.za
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acuitydata'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acuitydata
+
+## Usage
+
+```ruby
+  require 'acuitydata'
+  client  = AcuityData::Client.new
+
+
+```
+
+### Endpoints
+-
+
+Other endpoints have not been implemented.
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Tests
+To run tests execute:
+
+    $ rake test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trex22/acuitydata. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AcuityData: project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trex22/acuitydata/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/acuitydata.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "acuitydata/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "acuitydata"
+  spec.version       = AcuityData::VERSION
+  spec.authors       = ["trex22"]
+  spec.email         = ["contact@jasonchalom.com"]
+
+  spec.summary       = "A client for using api.acuitydata.co.za API in Ruby."
+  spec.description   = "A client for using api.acuitydata.co.za API in Ruby. This is an unofficial project."
+  spec.homepage      = "https://github.com/TRex22/acuitydata"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.21.0"
+  spec.add_dependency "active_attr", "~> 0.16.0"
+
+  # Development dependancies
+  spec.add_development_dependency "rake", "~> 13.1.0"
+  spec.add_development_dependency "minitest", "~> 5.22.3"
+  spec.add_development_dependency "minitest-focus", "~> 1.4.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.6.1"
+  spec.add_development_dependency "timecop", "~> 0.9.8"
+  spec.add_development_dependency "mocha", "~> 2.1.0"
+  spec.add_development_dependency "pry", "~> 0.14.2"
+  spec.add_development_dependency "webmock", "~> 3.23.0"
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acuitydata"
+
+# 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

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/acuitydata/client.rb

@@ -0,0 +1,137 @@
+module AcuityData
+  class Client
+    include ::AcuityData::Constants
+
+    attr_reader :auth_token, :base_path, :port
+
+    def initialize(auth_token, base_path: BASE_PATH, port: BASE_PORT)
+      @base_path = base_path
+      @port = port
+      @auth_token = auth_token
+    end
+
+    def self.compatible_api_version
+      'v1'
+    end
+
+    # This is the version of the API docs this client was built off-of
+    def self.api_version
+      'v1 2024-03-19'
+    end
+
+    # Endpoints
+    # /lookup/make
+    # Retrieve make information
+    def make
+      send_request(http_method: :get, path: "lookup/make")
+    end
+
+    # /lookup/model/{make}
+    # Retrieve model information for make
+    def model(make, year = nil)
+      if year
+        send_request(http_method: :get, path: "lookup/model2/#{make}/#{year}")
+      else
+        send_request(http_method: :get, path: "lookup/model/#{make}")
+      end
+    end
+
+    # /lookup/year/{make}/{model}
+    # Retrieve year information for make and model
+    def year(make, model = nil)
+      if model
+        send_request(http_method: :get, path: "lookup/year/#{make}/#{model}")
+      else
+        send_request(http_method: :get, path: "lookup/year2/#{make}")
+      end
+    end
+
+    # /lookup/variant/{make}/{model}/{year}
+    # Retrieve variant information for make, model and year
+    def variant(make, model, year)
+      send_request(http_method: :get, path: "lookup/variant/#{make}/#{model}/#{year}")
+    end
+
+    # /report/{make}/{model}/{variant}/{year}/{mileage}
+    # Retrieve vehicle report using make, model, year, variant and mileage
+    def report(make, model, variant, year, mileage)
+      send_request(http_method: :get, path: "report/#{make}/#{model}/#{variant}/#{year}/#{mileage}")
+    end
+
+    private
+
+    def send_request(http_method:, path:, body: {}, params: {}, headers: {}, port: @port, port_in_path: false)
+      start_time = micro_second_time
+
+      response = HTTParty.send(
+        http_method.to_sym,
+        construct_base_path(path, params, port, port_in_path),
+        body: body,
+        headers: headers.merge({ 'Content-Type': 'application/json', 'Authorization': "Basic #{@auth_token}" }),
+        port: port,
+        format: :json
+      )
+
+      end_time = micro_second_time
+      construct_response_object(response, path, start_time, end_time)
+    end
+
+    # Quick n dirty time parsing
+    def parse_time(str_time)
+      time_components = str_time.to_s.split(' ')
+
+      # Have to leave out the timezone - #{time_components[2]}
+      "#{time_components[0]}T#{time_components[1]}"
+    end
+
+    def construct_response_object(response, path, start_time, end_time)
+      {
+        'body' => parse_body(response, path),
+        'code' => response.code,
+        'cookies' => response.headers.dig('set-cookie'),
+        'headers' => response.headers,
+        'metadata' => construct_metadata(response, start_time, end_time)
+      }
+    end
+
+    def construct_metadata(response, start_time, end_time)
+      total_time = end_time - start_time
+
+      {
+        'start_time' => start_time,
+        'end_time' => end_time,
+        'total_time' => total_time
+      }
+    end
+
+    def micro_second_time
+      (Time.now.to_f * 1_000_000).to_i
+    end
+
+    def construct_base_path(path, params, port, port_in_path)
+      if port_in_path
+        constructed_path = "#{base_path}:#{port}/#{path}"
+      else
+        constructed_path = "#{base_path}/#{path}"
+      end
+
+      if params == {}
+        constructed_path.gsub(" ", "%20")
+      else
+        "#{constructed_path}?#{process_params(params)}".gsub(" ", "%20")
+      end
+    end
+
+    def parse_body(response, path)
+      JSON.parse(response.body) # Purposely not using HTTParty
+    rescue JSON::ParserError => _e
+      response.body
+    rescue TypeError => _e
+      nil
+    end
+
+    def process_params(params)
+      params.keys.map { |key| "#{key}=#{params[key]}" }.join('&')
+    end
+  end
+end

data/lib/acuitydata/constants.rb

@@ -0,0 +1,8 @@
+module AcuityData
+  module Constants
+    BASE_URI = 'api.acuitydata.co.za/api'
+    BASE_PATH = "https://#{BASE_URI}"
+
+    BASE_PORT = 443
+  end
+end

data/lib/acuitydata/version.rb

@@ -0,0 +1,3 @@
+module AcuityData
+  VERSION = "0.0.2"
+end

data/lib/acuitydata.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+
+require 'acuitydata/constants'
+require 'acuitydata/version'
+
+require 'acuitydata/client'
+
+module AcuityData
+  class Error < StandardError; end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acuitydata
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - trex22
@@ -159,7 +159,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
 - LICENSE
+- README.md
+- Rakefile
+- acuitydata.gemspec
+- bin/console
+- bin/setup
+- lib/acuitydata.rb
+- lib/acuitydata/client.rb
+- lib/acuitydata/constants.rb
+- lib/acuitydata/version.rb
 homepage: https://github.com/TRex22/acuitydata
 licenses:
 - MIT