check_mot 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1563ec1966cac396ffb090b7260ac635b1a9e29eb3df5570ef5248e13544a51c
-  data.tar.gz: '0078023d2f227021dd9263489c1d90c94e2e600ee7d26db465fe16fe72f6299f'
+  metadata.gz: 5af2047cd12c8506e2c58d0e12e0392bd9d9166184e93c99f5bfdca16dfb04dd
+  data.tar.gz: 595d9183f18ca4f590a7c700977ede40a62ff4b27a35842da17b922b228f53c6
 SHA512:
-  metadata.gz: 95a3cc21a158a6d04c6f2727108de58bd905ec5794e59c4911cd4504d4d4abaea71f69d5e33d8130a7528cc20aea38a053dcdaa2632d9b29bbbf67483139b881
-  data.tar.gz: 0a79b48ef58a2fd507f34d6946d9201c10c601b36c8ff09f6d00628e2e73b9ac51b1a75e3e326152bd0834ad080963638e9c84d8f54549891770a9af12355589
+  metadata.gz: addb1af08ca795a70679f785ed6eb3acd416500086a1f382c683dd45f8dedc43d63f0f2471c0077e7a75b829cd13ac6b88d2210809acb3eacbcdce35c643d1e0
+  data.tar.gz: 9a2e46b02b31783df140696da11f5d7aed8acc9a91a4d24b690f79ab33d905f9cea6ae85a03839d792e424ecae87779df047c8eb3c75e005580928de361e1953

data/.circleci/config.yml

@@ -7,9 +7,9 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:2.5
+      - image: cimg/ruby:3.1.4
         environment:
-          BUNDLER_VERSION: 2.0.1
+          BUNDLER_VERSION: 2.5.7
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -29,8 +29,10 @@ jobs:
             - v1-dependencies-
 
       - run:
-          name: install bundler 2.0
+          name: Configure Bundler
           command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
             gem install bundler
 
       - run:

data/Gemfile.lock

@@ -1,45 +1,58 @@
 PATH
   remote: .
   specs:
-    check_mot (0.1.0)
+    check_mot (0.3.0)
       activesupport (>= 4.0)
       faraday (>= 0.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    concurrent-ruby (1.1.4)
-    diff-lcs (1.3)
-    faraday (0.15.4)
-      multipart-post (>= 1.2, < 3)
-    i18n (1.5.3)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    multipart-post (2.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    minitest (5.22.3)
+    mutex_m (0.2.0)
+    net-http (0.4.1)
+      uri
+    rake (13.0.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (0.13.0)
 
 PLATFORMS
   ruby
@@ -47,9 +60,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   check_mot!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rspec_junit_formatter
 
 BUNDLED WITH
-   2.0.1
+   2.4.22

data/README.md

@@ -62,7 +62,7 @@ config.http_adapter = <your_http_adapter>
 
 To check a vehicle's MOT history using the registration number:
 ```ruby
-check_mot = ChecmMot::Client.new
+check_mot = CheckMot::Client.new
 result = check_mot.by_vehicle_registration('AB01CDF')
 
 result.registration # => "AB01CFD"
@@ -70,6 +70,15 @@ result.mot_tests.first.completed_date # => 2019-02-16 21:40:00
 # etc
 ```
 
+To request MOT tests completed on 15 August 2024 for page 1:
+```ruby
+check_mot = CheckMot::Client.new
+result = check_mot.by_date('20240815', page: 1)
+result.first.mot_tests.first.test_result # => "PASSED"
+# etc
+```
+Note: `page` is between 1 and 1440 inclusive. Dates that are over 5 weeks before the current date will produce a 400 error.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/check_mot.gemspec

@@ -6,8 +6,8 @@ require "check_mot/version"
 Gem::Specification.new do |spec|
   spec.name          = "check_mot"
   spec.version       = CheckMot::VERSION
-  spec.authors       = ["Ben Forrest"]
-  spec.email         = ["ben@clickmechanic.com"]
+  spec.authors       = ["Ben Forrest", "clickmechanic-dev"]
+  spec.email         = "dev@clickmechanic.com"
 
   spec.summary       = 'Ruby interface for the UK MOT History API'
   spec.description   = 'See https://www.check-mot.service.gov.uk/mot-history-api for details of the API spec'
@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency 'activesupport', '>= 4.0'

data/lib/check_mot/attribute.rb

@@ -3,13 +3,13 @@ module CheckMot
   class Attribute
     attr_reader :value
 
-    def initialize(name, value)
-      @name, @value = name, value
+    def initialize(value)
+      @value = value
     end
 
     def self.resolve(name, value)
-      [DateAttribute].lazy.map do |attr|
-        attr.try(name, value)
+      [DateAttribute].map do |attribute|
+        attribute.try(name, value)
       end.first || value
     end
   end

data/lib/check_mot/by_date_request.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CheckMot
+  class ByDateRequest < Request
+    def get(date, page:)
+      raw_response = get_raw(date: date, page: page)
+      ByDateResponse.new(raw_response).resources
+    end
+  end
+end

data/lib/check_mot/by_date_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckMot
+  class ByDateResponse < Response
+    def resources
+      return [] if status == 404
+
+      validate
+
+      sanitized.map { |source_hash| Resource.new(source_hash) }
+    end
+
+    def sanitized
+      parsed_response.map(&method(:transform))
+    end
+  end
+end

data/lib/check_mot/by_vehicle_registration_request.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CheckMot
+  class ByVehicleRegistrationRequest < Request
+    def get(registration)
+      raw_response = get_raw(registration: registration)
+      ByVehicleRegistrationResponse.new(raw_response).resource
+    end
+  end
+end

data/lib/check_mot/by_vehicle_registration_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckMot
+  class ByVehicleRegistrationResponse < Response
+    def resource
+      validate
+      Resource.new(sanitized)
+    end
+
+    def sanitized
+      transform(parsed_response.first)
+    end
+  end
+end

data/lib/check_mot/client.rb

@@ -1,46 +1,11 @@
 module CheckMot
-
   class Client
     def by_vehicle_registration(registration)
-      response = get(registration: registration)
-      Resource.new(response.sanitized.first)
-    end
-
-    private
-
-    def get(params)
-      Response.new(connection.get path, params).tap do |response|
-        fail ResponseError.new(response.status, response.raw) unless response.success?
-      end
-    end
-
-    def url
-      'https://beta.check-mot.service.gov.uk'
-    end
-
-    def path
-      '/trade/vehicles/mot-tests'
-    end
-
-    def connection
-      @connection ||= create_connection
+      ByVehicleRegistrationRequest.new.get(registration)
     end
 
-    def create_connection
-      fail Error.new('api_key not configured') unless CheckMot.configuration.api_key
-
-      Faraday.new(:url => url) do |builder|
-        builder.headers = headers
-        builder.adapter CheckMot.configuration.http_adapter || Faraday.default_adapter
-      end
-    end
-
-    def headers
-      {
-          'Accept': 'application/json+v6',
-          'x-api-key': CheckMot.configuration.api_key
-      }
+    def by_date(date, page:)
+      ByDateRequest.new.get(date, page: page)
     end
   end
-
 end

data/lib/check_mot/date_attribute.rb

@@ -3,13 +3,13 @@ module CheckMot
   class DateAttribute < Attribute
 
     ATTRIBUTE_REGEX = /_date$/
-    DATE_REGEX = /^\d{4}.\d{2}.\d{2}$/
-    TIME_REGEX = /^\d{4}.\d{2}.\d{2} \d{2}:\d{2}:\d{2}$/
+    DATE_REGEX = /^\d{4}[.-\/]\d{2}[.-\/]\d{2}$/
+    TIME_REGEX = /^\d{4}[.-\/]\d{2}[.-\/]\d{2} \d{2}:\d{2}:\d{2}$/
 
     def self.try(name, value)
-      return unless name.to_s.match(/_date$/)
+      return unless name.to_s.match(ATTRIBUTE_REGEX)
 
-      new(name, value)
+      new(value)
     end
 
     def value

data/lib/check_mot/request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module CheckMot
+  class Request
+    URL = 'https://beta.check-mot.service.gov.uk'
+    PATH = '/trade/vehicles/mot-tests'
+
+    def get_raw(params)
+      connection.get PATH, params
+    end
+
+    private
+
+    def connection
+      @connection ||= create_connection
+    end
+
+    def create_connection
+      fail Error.new('api_key not configured') unless CheckMot.configuration.api_key
+
+      Faraday.new(url: URL) do |builder|
+        builder.headers = headers
+        builder.adapter CheckMot.configuration.http_adapter || Faraday.default_adapter
+      end
+    end
+
+    def headers
+      {
+          'Accept': 'application/json+v6',
+          'x-api-key': CheckMot.configuration.api_key
+      }
+    end
+  end
+
+end

data/lib/check_mot/resource.rb

@@ -6,11 +6,10 @@ module CheckMot
     end
 
     def respond_to_missing?(name, include_private = false)
-      super || source_hash.keys.include?(name)
+      true
     end
 
     def method_missing(name, *args)
-      super unless source_hash.keys.include?(name)
       resolved_attribute(name)
     end
 
@@ -24,7 +23,7 @@ module CheckMot
     attr_reader :source_hash
 
     def resolved_attribute(name)
-      resolved_attributes[name] ||= resolve_attribute(name, @source_hash[name])
+      resolved_attributes[name] ||= resolve_attribute(name, source_hash[name])
     end
 
     def resolved_attributes
@@ -32,15 +31,15 @@ module CheckMot
     end
 
     def resolve_attribute(name, value)
-      attr = Attribute.resolve(name, value)
+      attribute = Attribute.resolve(name, value)
 
-      case attr
+      case attribute
       when Array
-        attr.map { |value| resolve_attribute(name, value) }
+        attribute.map { |value| resolve_attribute(name, value) }
       when Hash
-        Resource.new(attr)
+        Resource.new(attribute)
       when Attribute
-        attr.value
+        attribute.value
       else
         value
       end

data/lib/check_mot/response.rb

@@ -7,21 +7,20 @@ module CheckMot
 
     delegate :success?, :status, to: :raw_response
 
-    def sanitized
-      return unless success?
-
-      case parsed_response
-      when Array
-        parsed_response.map(&method(:transform))
-      else
-        transform(parsed_response)
-      end
-    end
-
     def raw
       raw_response.body
     end
 
+    def validate
+      fail ResponseError.new(status, raw) unless success?
+    end
+
+    protected
+
+    def parsed_response
+      @_parsed_response ||= JSON.parse(raw_response.body)
+    end
+
     private
 
     attr_reader :raw_response
@@ -29,10 +28,6 @@ module CheckMot
     def transform(response_hash)
       response_hash.deep_transform_keys { |key| key.underscore.to_sym }
     end
-
-    def parsed_response
-      @_parsed_response ||= JSON.parse(raw_response.body)
-    end
   end
 
 end

data/lib/check_mot/version.rb

@@ -1,3 +1,3 @@
 module CheckMot
-  VERSION = "0.1.0"
+  VERSION = "0.3.1"
 end

data/lib/check_mot.rb

@@ -1,4 +1,5 @@
 require 'date'
+require "active_support"
 require 'active_support/core_ext/time'
 require 'json'
 require 'faraday'
@@ -8,7 +9,12 @@ require 'check_mot/configuration'
 require 'check_mot/attribute'
 require 'check_mot/date_attribute'
 require 'check_mot/resource'
+require 'check_mot/request'
 require 'check_mot/response'
+require 'check_mot/by_vehicle_registration_request'
+require 'check_mot/by_date_request'
+require 'check_mot/by_vehicle_registration_response'
+require 'check_mot/by_date_response'
 require 'check_mot/client'
 
 module CheckMot

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: check_mot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ben Forrest
+- clickmechanic-dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2024-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -82,8 +83,7 @@ dependencies:
         version: '0.9'
 description: See https://www.check-mot.service.gov.uk/mot-history-api for details
   of the API spec
-email:
-- ben@clickmechanic.com
+email: dev@clickmechanic.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -103,9 +103,14 @@ files:
 - check_mot.gemspec
 - lib/check_mot.rb
 - lib/check_mot/attribute.rb
+- lib/check_mot/by_date_request.rb
+- lib/check_mot/by_date_response.rb
+- lib/check_mot/by_vehicle_registration_request.rb
+- lib/check_mot/by_vehicle_registration_response.rb
 - lib/check_mot/client.rb
 - lib/check_mot/configuration.rb
 - lib/check_mot/date_attribute.rb
+- lib/check_mot/request.rb
 - lib/check_mot/resource.rb
 - lib/check_mot/response.rb
 - lib/check_mot/version.rb
@@ -131,8 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby interface for the UK MOT History API