uk-hs_code 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b1b52e93fe6030f5caa8a3b2da29d7eec5e162a35aeebf91666433941c41f58
-  data.tar.gz: fc7c3a5197f249f23150563555f42842389922b8d9141f2131a3195da19aeaeb
+  metadata.gz: 85e09b189b4a286a2766142d0b38f27be4bca6b5441ed8d6b3c274d1e3109036
+  data.tar.gz: 1e76d26889a40ebdd5ebd1b70f3634cce6fb92a6518e7d046d109020e84053ab
 SHA512:
-  metadata.gz: 476b71a60ff70e5945d0cd6ba5b820d58eaedf1de8b31a8788160be549aa6228ee07d0ac3c16d8319d15da5204153df9c6cf022322f1af33eaa5e54fa5536cfc
-  data.tar.gz: 66d3efeff1efa29f000bbedd402fe6e1d67089e8b8093a1e2cb9554bfc8788e4921ec47199647155079f7a609c8daac4f886fb86a60bb5dba053487afe84aec6
+  metadata.gz: ea095185027cfd389a2cbe225db95313de464046f60a97d53d0df943a551667c873afd33d7059804041721cb5832639c2e7c974b82eefd6bf0ffe5e277556d86
+  data.tar.gz: a65cf16cfba32f7dcfb611acf1af51b0e721cd7e24326913a8279ed38c6971f708be76a09c1ebe622ec7c40fc64bb34d58520abe7f83504e8e50008e40e62427

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
 
 Style/StringLiterals:
   Enabled: true
@@ -12,9 +14,6 @@ Style/StringLiteralsInInterpolation:
 Style/Documentation:
   Enabled: false
 
-Layout/LineLength:
-  Max: 120
-
 Layout/LineLength:
   Enabled: false
 
@@ -23,3 +22,21 @@ Metrics/AbcSize:
 
 Metrics/BlockLength:
   Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# UK/Hs_code Contributing Guidelines
+
+Thank you for your interest in contributing to our open source project! We appreciate your effort and to ensure that your contributions align with the goals of this project and are integrated smoothly, we ask that you follow these guidelines.
+
+1. **Commit Small, Commit Regularly:** Regular and smaller commits are preferred over large, infrequent commits. This makes the changes easier to review and troubleshoot.
+
+2. **Use Imperative Commands:** Your commit titles should succinctly describe the changes you've made. Prefix your commit titles with imperative commands such as: fix, refactor, add, and remove. This is because you should be able to suffix a commit message to the phrase: "If applied, this code will...".
+
+A good practice is to structure your commit title like this: "[GitHub issue number] Add fields to hs record".
+
+Keep It Brief - You're not writing a monologue, so keep it brief. As a general rule, a commit message should not exceed 50 characters.
+
+3. **Use Draft PRs for Ongoing Work:** If your pull request is not ready for review, please mark it as a draft. This indicates to the team that the changes are still in progress.
+
+4. **Request Reviews Before Merging:** When your pull request is ready, request a review from your team members. Reviews ensure that your changes are validated by others.
+
+5. **Address Review Feedback:** If a reviewer asks for changes or provides feedback, please respond promptly and incorporate necessary changes.
+
+6. **Merge Cautiously:** Once your pull request is reviewed and approved, ensure that it's merging into the correct branch and that it's up-to-date with the latest changes in that branch before merging.

data/Gemfile.lock

@@ -1,14 +1,22 @@
 PATH
   remote: .
   specs:
-    uk-hs_code (0.1.2)
+    uk-hs_code (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.2)
+    base64 (0.3.0)
+    bigdecimal (4.1.3)
     coderay (1.1.3)
+    crack (1.0.1)
+      bigdecimal
+      rexml
     diff-lcs (1.5.0)
+    hashdiff (1.2.1)
     json (2.6.3)
     method_source (1.0.0)
     parallel (1.22.1)
@@ -17,10 +25,12 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (7.0.5)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.7.0)
-    rexml (3.2.5)
+    rexml (3.4.1)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -48,16 +58,24 @@ GEM
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.4.2)
+    webmock (3.34.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
+  base64
   pry
+  racc (~> 1.8)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop
   uk-hs_code!
+  webmock (~> 3.0)
 
 BUNDLED WITH
    2.4.5

data/README.md

@@ -18,28 +18,26 @@ And:
 ## Usage
 
 ```ruby
-# Get all HS codes matching 'table' reference
+# Search HS codes matching free-text commodity description
+commodities = Uk::HsCode.search('cotton t-shirt')
 
-> refs = Uk::HsCode.search('table')
+commodities.first.code
+# => "6109100010"
 
-> refs.inspect
+commodities.first.title
+# => "T-shirts"
 
- # => [#<Uk::HsCode::Record id="6133", type="search_reference", attributes=#<Uk::HsCode::Record title="table, billiard and bagatelle", referenced_id="9504", referenced_class="Heading", goods_nomenclature_item_id="9504000000", productline_suffix="80", goods_nomenclature_sid=54540>>,
- #<Uk::HsCode::Record id="11204", type="search_reference", attributes=#<Uk::HsCode::Record title="table cloths, knitted or crocheted", referenced_id="6302", referenced_class="Heading", goods_nomenclature_item_id="6302000000", productline_suffix="80", goods_nomenclature_sid=43645>>,
- #<Uk::HsCode::Record id="11205", type="search_reference", attributes=#<Uk::HsCode::Record title="tablecloths, knitted or crocheted", referenced_id="6302", referenced_class="Heading", goods_nomenclature_item_id="6302000000", productline_suffix="80", goods_nomenclature_sid=43645>>,
- #<Uk::HsCode::Record id="7289", type="search_reference", attributes=#<Uk::HsCode::Record title="tablecloths, of paper", referenced_id="4818300000-80", referenced_class="Commodity", goods_nomenclature_item_id="4818300000", productline_suffix="80", goods_nomenclature_sid=40686>>,
- #<Uk::HsCode::Record id="11206", type="search_reference", attributes=#<Uk::HsCode::Record title="table cloths, other than knitted or crocheted", referenced_id="6302510000-10", referenced_class="Subheading", goods_nomenclature_item_id="6302510000", productline_suffix="10", goods_nomenclature_sid=43679>>
+commodities.first.declarable
+# => true
 
-# Get only HS codes with their titles matching 'carpet' reference
+# Get only HS codes with their titles
+records = Uk::HsCode.search_hs_codes('carpet')
 
-> refs = Uk::HsCode.search_hs_codes('carpet')
-
-> refs.inspect
-
- # => [#<Uk::HsCode::Record code="8451808000", title="carpet cleaning machines liquid injection">,
- #<Uk::HsCode::Record code="4008000000", title="carpet underlay, rubber">,
- #<Uk::HsCode::Record code="5402000000", title="carpet yarn, of man-made filaments">]
+records.first.code
+# => "8451808000"
 
+records.first.title
+# => "carpet cleaning machines liquid injection"
 ```
 
 ## Development

data/lib/uk/hs_code/api_request.rb

@@ -3,7 +3,6 @@
 require "net/http"
 require "uri"
 require "json"
-# require "record"
 
 module Uk
   module HsCode

data/lib/uk/hs_code/client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+
+module Uk
+  module HsCode
+    class Client
+      BASE_URL = "https://www.trade-tariff.service.gov.uk/api/v2"
+
+      def initialize(base_url: BASE_URL)
+        @base_url = base_url
+      end
+
+      def get(path, params = {})
+        uri = build_uri(path, params)
+        request = Net::HTTP::Get.new(uri)
+        request["User-Agent"] = "UK HS Code gem/#{Uk::HsCode::VERSION}"
+        request["Accept"] = "application/json"
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true if uri.scheme == "https"
+
+        response = http.request(request)
+        handle_response(response)
+      end
+
+      private
+
+      def build_uri(path, params)
+        full_url = "#{@base_url}#{path}"
+        uri = URI.parse(full_url)
+        if params && !params.empty?
+          query_str = URI.encode_www_form(params)
+          uri.query = uri.query ? "#{uri.query}&#{query_str}" : query_str
+        end
+        uri
+      end
+
+      def handle_response(response)
+        raise Uk::HsCode::Error, "Request failed with status: #{response.code} - #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/uk/hs_code/parsers/search_response_parser.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Uk
+  module HsCode
+    module Parsers
+      class SearchResponseParser
+        def self.call(response_hash)
+          new(response_hash).call
+        end
+
+        def initialize(response_hash)
+          @response_hash = response_hash || {}
+        end
+
+        def call
+          data = @response_hash["data"] || @response_hash[:data]
+          return [] unless data
+
+          type = data["type"] || data[:type]
+          attributes = data["attributes"] || data[:attributes] || {}
+
+          case type
+          when "exact_search"
+            parse_exact_search(attributes)
+          when "fuzzy_search"
+            parse_fuzzy_search(attributes)
+          else
+            []
+          end
+        end
+
+        private
+
+        def parse_exact_search(attributes)
+          entry = attributes["entry"] || attributes[:entry] || {}
+          code = entry["id"] || entry[:id]
+          return [] unless code
+
+          [
+            Record.new(
+              code: code,
+              title: "Exact match for #{code}",
+              declarable: true,
+              type: "exact"
+            )
+          ]
+        end
+
+        def parse_fuzzy_search(attributes)
+          records = []
+          seen_codes = {}
+
+          extract_commodities(attributes, records, seen_codes)
+          extract_references(attributes, records, seen_codes)
+
+          records
+        end
+
+        def extract_commodities(attributes, records, seen_codes)
+          gn_commodities = attributes.dig("goods_nomenclature_match", "commodities") || []
+          gn_commodities.each do |hit|
+            source = hit["_source"] || {}
+            code = source["goods_nomenclature_item_id"]
+            next if code.nil? || seen_codes[code]
+
+            seen_codes[code] = true
+            records << Record.new(
+              code: code,
+              title: source["description"],
+              description: source["description"],
+              score: hit["_score"],
+              declarable: source["declarable"],
+              type: "commodity"
+            )
+          end
+        end
+
+        def extract_references(attributes, records, seen_codes)
+          ref_commodities = attributes.dig("reference_match", "commodities") || []
+          ref_commodities.each do |hit|
+            source = hit["_source"] || {}
+            ref_data = source["reference"] || {}
+            code = ref_data["goods_nomenclature_item_id"]
+            next if code.nil? || seen_codes[code]
+
+            seen_codes[code] = true
+            records << Record.new(
+              code: code,
+              title: source["title"],
+              description: ref_data["description"] || source["title"],
+              score: hit["_score"],
+              declarable: ref_data["declarable"],
+              type: "reference"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/uk/hs_code/record.rb

@@ -2,6 +2,79 @@
 
 module Uk
   module HsCode
-    class Record < OpenStruct; end
+    class Record
+      attr_reader :score, :declarable, :type
+
+      def initialize(code: nil, title: nil, description: nil, score: nil, declarable: nil, type: nil, **extra)
+        @extra = extra || {}
+        @code = code || @extra[:goods_nomenclature_item_id] || @extra["goods_nomenclature_item_id"]
+        @title = title || description || @extra[:negated_title] || @extra["negated_title"]
+        @description = description || title
+        @score = score
+        @declarable = declarable
+        @type = type
+      end
+
+      def code
+        @code || self["code"] || self["goods_nomenclature_item_id"]
+      end
+
+      def title
+        @title || self["title"] || self["description"]
+      end
+
+      def description
+        @description || self["description"] || self["title"]
+      end
+
+      def goods_nomenclature_item_id
+        code
+      end
+
+      def attributes
+        self["attributes"] || self
+      end
+
+      def [](key)
+        instance_variable_get("@#{key}") || @extra[key.to_s] || @extra[key.to_sym]
+      end
+
+      def []=(key, val)
+        instance_variable_set("@#{key}", val)
+        @extra[key.to_s] = val
+        @extra[key.to_sym] = val
+      end
+
+      def method_missing(method_name, *args, &block)
+        str_key = method_name.to_s
+        if str_key.end_with?("=")
+          self[str_key.chop] = args.first
+        elsif @extra.key?(str_key) || @extra.key?(method_name)
+          self[method_name]
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        str_key = method_name.to_s.chomp("=")
+        @extra.key?(str_key) || @extra.key?(str_key.to_sym) || super
+      end
+
+      def to_h
+        {
+          code: code,
+          title: title,
+          description: description,
+          score: score,
+          declarable: declarable,
+          type: type
+        }
+      end
+
+      def ==(other)
+        other.is_a?(Record) && code == other.code && title == other.title
+      end
+    end
   end
 end

data/lib/uk/hs_code/services/search_service.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Uk
+  module HsCode
+    module Services
+      class SearchService
+        def self.call(...)
+          new(...).call
+        end
+
+        def initialize(params = {}, client: Client.new, **keyword_params)
+          merged_params = keyword_params.empty? ? params : keyword_params
+          @params = merged_params.is_a?(Hash) ? merged_params : { query: merged_params }
+          @client = client
+        end
+
+        def call
+          validate_prerequisites!
+          execute_workflow
+        end
+
+        private
+
+        def validate_prerequisites!
+          raise ArgumentError, "Missing required query" if query.empty?
+        end
+
+        def execute_workflow
+          raw_response = @client.get("/search", { q: query })
+          Parsers::SearchResponseParser.call(raw_response)
+        end
+
+        def query
+          (@params[:query] || @params["query"] || @params[:q] || @params["q"]).to_s.strip
+        end
+      end
+    end
+  end
+end

data/lib/uk/hs_code/version.rb

@@ -2,6 +2,6 @@
 
 module Uk
   module HsCode
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/lib/uk/hs_code.rb

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
 require_relative "hs_code/version"
-require_relative "hs_code/api_request"
 require_relative "hs_code/record"
+require_relative "hs_code/client"
+require_relative "hs_code/parsers/search_response_parser"
+require_relative "hs_code/services/search_service"
+require_relative "hs_code/api_request"
 
 module Uk
   module HsCode
-    API_ENDPOINT = "https://www.trade-tariff.service.gov.uk/api"
+    API_ENDPOINT = "https://www.trade-tariff.service.gov.uk/api/v2"
 
     class Error < StandardError; end
 
     class << self
       def search(query)
-        search_references(query)
+        Services::SearchService.call(query: query)
       end
 
       def search_hs_codes(query)
-        result = search_references(query)
-        result.map { |a| Record.new(code: a.attributes.goods_nomenclature_item_id, title: a.attributes.title) }
+        search(query)
       end
 
-      private
-
       def search_references(query)
-        ApiRequest.new("#{API_ENDPOINT}/v2/search_references.json", { query: { letter: query } }).get
+        ApiRequest.new("#{API_ENDPOINT}/search_references.json", { query: { letter: query } }).get
       end
     end
   end

data/uk-hs_code.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "Trade Tariff Public API V2 communicator."
   spec.homepage = "https://github.com/enigmatt-pl/uk-hs_code.git"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -29,15 +29,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "base64"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rubocop"
-
+  spec.add_development_dependency "racc", "~> 1.8"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock", "~> 3.0"
 end

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: uk-hs_code
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Mateusz Michalski
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: racc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +79,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Trade Tariff Public API V2 communicator.
 email:
 - enigmatt.priv@gmail.com
@@ -75,6 +116,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -82,7 +124,10 @@ files:
 - Rakefile
 - lib/uk/hs_code.rb
 - lib/uk/hs_code/api_request.rb
+- lib/uk/hs_code/client.rb
+- lib/uk/hs_code/parsers/search_response_parser.rb
 - lib/uk/hs_code/record.rb
+- lib/uk/hs_code/services/search_service.rb
 - lib/uk/hs_code/version.rb
 - sig/uk/hs_code.rbs
 - uk-hs_code.gemspec
@@ -93,7 +138,6 @@ metadata:
   homepage_uri: https://github.com/enigmatt-pl/uk-hs_code.git
   source_code_uri: https://github.com/enigmatt-pl/uk-hs_code.git
   changelog_uri: https://github.com/enigmatt-pl/uk-hs_code.git
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -101,15 +145,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Enables communication with Trade Tariff Public API V2.
 test_files: []