uk-hs_code 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9119bf354ad934444ceb102a5b135e57ae29bb932dd04ae79fde3a4a162a12f
+  data.tar.gz: 524441f8f9ac14ee6fdd22e9a5784ec459afe32d552bdc7b9cb9901d91bdf74f
+SHA512:
+  metadata.gz: 1d1d1a00af50905816c584315afa8f2797923dcfd5beff9b8dd99797598622b80c33ff4fc772a70c9093d831ce78092e81524d2fcb54686313c0bea682435030
+  data.tar.gz: 347e36b41777a46a239194cdf85a65404a4585dd6ab72967bf2d73ffc01616c7965530955f59df86f098a7c9c89e83127d8fba4f78fef8d69718c6b6762d2509

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in uk-hs_code.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    uk-hs_code (0.1.0)
+      rake (~> 13.0)
+      rspec (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  pry
+  rubocop
+  uk-hs_code!
+
+BUNDLED WITH
+   2.4.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mateusz Michalski
+
+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,55 @@
+# Uk::HsCode
+
+uk-hs_code enables to dynamically search Harmonized Codes via UK Trade Tariff API, https://api.trade-tariff.service.gov.uk/#gov-uk-trade-tariff-api.
+
+## Installation
+
+The repository is here: https://github.com/enigmatt-pl/uk-hs_code.git
+
+Add to your Gemfile:
+
+    $ gem 'uk-hs_code', git: 'https://github.com/enigmatt-pl/uk-hs_code.git'
+
+And:
+
+    $ bundle install
+
+
+## Usage
+
+```ruby
+# Get all HS codes matching 'table' reference
+
+> refs = Uk::HsCode.search('table')
+
+> refs.inspect
+
+ # => [#<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>>
+
+# Get only HS codes with their titles matching 'carpet' reference
+
+> refs = Uk::HsCode.search_hs_codes('carpet')
+
+ # => [#<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">]
+
+```
+
+## 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.
+
+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]/uk-hs_code.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/uk/hs_code/api_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+# require "record"
+
+module Uk
+  module HsCode
+    class ApiRequest
+      attr_reader :url, :query_params
+
+      def initialize(url, query_params = {})
+        @url = url
+        @query_params = query_params
+      end
+
+      def get
+        request = Net::HTTP::Get.new(parsed_uri)
+
+        add_headers(request)
+
+        http = Net::HTTP.new(parsed_uri.host, parsed_uri.port)
+        http.use_ssl = true if parsed_uri.scheme == "https"
+
+        response = http.request(request)
+
+        raise Uk::HsCode::Error, "Request failed with status: #{response.code} - #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+
+        JSON.parse(response.body, object_class: Record)&.data
+      end
+
+      private
+
+      def add_headers(request)
+        request["User-Agent"] = "UK HS Code gem/#{Uk::HsCode::VERSION}"
+        request["Accept"] = "application/json"
+      end
+
+      def parsed_uri
+        @parsed_uri ||= URI.parse("#{url}?#{query_string}")
+      end
+
+      def query_string
+        query_params.map do |key, value|
+          "#{key}[#{URI.encode_www_form_component(value.keys.first)}]=#{URI.encode_www_form_component(value.values.first)}"
+        end.join("&")
+      end
+    end
+  end
+end

data/lib/uk/hs_code/record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Uk
+  module HsCode
+    class Record < OpenStruct; end
+  end
+end

data/lib/uk/hs_code/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Uk
+  module HsCode
+    VERSION = "0.1.0"
+  end
+end

data/lib/uk/hs_code.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "hs_code/version"
+require_relative "hs_code/api_request"
+require_relative "hs_code/record"
+
+module Uk
+  module HsCode
+    API_ENDPOINT = "https://www.trade-tariff.service.gov.uk/api"
+
+    class Error < StandardError; end
+
+    class << self
+      def search(query)
+        search_references(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) }
+      end
+
+      private
+
+      def search_references(query)
+        ApiRequest.new("#{API_ENDPOINT}/v2/search_references.json", { query: { letter: query } }).get
+      end
+    end
+  end
+end

data/sig/uk/hs_code.rbs

@@ -0,0 +1,6 @@
+module Uk
+  module HsCode
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: uk-hs_code
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Michalski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uk/hs_code.rb
+- lib/uk/hs_code/api_request.rb
+- lib/uk/hs_code/record.rb
+- lib/uk/hs_code/version.rb
+- sig/uk/hs_code.rbs
+homepage: https://github.com/enigmatt-pl/uk-hs_code.git
+licenses:
+- MIT
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Enables communication with Trade Tariff Public API V2.
+test_files: []