laa-fee-calculator-client 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b49b8d4fa382b63ac223bc73b4fa26df867a8bdde1ccdc8a66095d496c64c1
-  data.tar.gz: 879657507b8a62e44507fe92b718134b839001507effcad82256844ffb108bd9
+  metadata.gz: 5ef6d4916284e517e033ca34430e3159698a99d5839cd8d5da11ad5e6dc78250
+  data.tar.gz: ff85257fcd205872dd8ac5c98791a5705818247b5871051319d10116a68af7aa
 SHA512:
-  metadata.gz: f11e00097f4679e9c843109c3f5a3170bc875f3e3d08248443db4645d139997523530415857e64552290eef575885d7925fa3a5c46d24d727a7139cc953a03b0
-  data.tar.gz: 6a4ddefcf31efee1a15fbd2855a87f0e4a810d4169025a84905199dbddc913545a3997e053b6bba5f24e6bb92e0718293ac7b1f968cb987c289a352688579382
+  metadata.gz: 531ea668cdb58324b8a77c69a4865442473d32bcbb11f88964e5130135eb60a38bc36fed6b339935f7f8f8baad3baa6cc8dfabeb016329e7b9e097a7071621e5
+  data.tar.gz: 602b711f8be0b58ec29b0bd695ad93278f1cf0bce962e04c2b35c653b8e5de6b8fd309f283ba0c65584127a20cb31beabe193a258076b10b2ceb1d873f9bd507

data/CHANGELOG.md

@@ -12,8 +12,30 @@ Add latest change log entries at top using template:
   -
 ### Removed
   -
-
 ```
+
+
+## Version 1.4.0
+
+### Added
+  - New configuration options for caching and logging
+
+## Version 1.3.1
+
+### Removed
+  - `addressable` gem dependency
+
+## Version 1.3.0
+
+### Modified
+  - update Faraday dependency
+
+### Added
+  - support for Ruby 3.0 and 3.1
+
+### Removed
+  - removed support for Ruby 2.6
+
 ## Version 1.2.0
 
 ### Modified

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 

data/README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/ministryofjustice/laa-fee-calculator-client.svg?branch=master)](https://travis-ci.org/ministryofjustice/laa-fee-calculator-client)
+![RSpec](https://github.com/ministryofjustice/laa-fee-calculator-client/actions/workflows/rspec.yml/badge.svg)
+![Rubocop](https://github.com/ministryofjustice/laa-fee-calculator-client/actions/workflows/rubocop.yml/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/laa-fee-calculator-client.svg)](https://badge.fury.io/rb/laa-fee-calculator-client)
 ![](https://ruby-gem-downloads-badge.herokuapp.com/laa-fee-calculator-client?type=total)
 
@@ -162,6 +163,17 @@ end
 
 ```
 
+## Caching
+
+Caching can be configured, with optional logging, by providing a cache store:
+
+```ruby
+LAA::FeeCalculator.configure do |config|
+  config.cache = Rails.cache
+  config.logger = Rails.logger
+end
+```
+
 Note: 
 
 ## Contributing
@@ -172,17 +184,15 @@ Bug reports and pull requests are welcome on GitHub at [ministryofjustice/laa-fe
 
 1. Make required changes, run specs (rerecord vcr cassettes if necessary)
 
-2. Run `bin/ruby_version_test` to test against ruby versions (2.6+ supported at present)
+2. Run `bin/ruby_version_test` to test against ruby versions (2.7+ supported at present)
 
 3. Update the VERSION in `lib/laa/fee_calculator/version` using [semantic versioning](https://guides.rubygems.org/patterns/#semantic-versioning).
 
-4. Update the VERSION_RELEASED in `lib/laa/fee_calculator/version` to the date you intend to publish/release the version.
-
-5. Update the `CHANGELOG.md` - format/documentation standards specified at top of file.
+4. Update the `CHANGELOG.md` - format/documentation standards specified at top of file.
 
-6. PR the change, code-review, merge.
+5. PR the change, code-review, merge.
 
-7. Pull master and run rake task below to publish
+6. Pull master and run rake task below to publish. Note, you will need a [rubygems](https://rubygems.org/) account with gem owner privileges and have configured your `~/.gem/credentials` in order for this task to complete successfully.
 
 ```bash
 $ rake release
@@ -195,7 +205,7 @@ $ git push -u origin <branch>
 $ git tag -a v<VERSION> -m "Version <VERSION>"
 $ git push origin v<VERSION>
 $ gem build laa-fee-calculator-client.gemspec
-$ gem push laa-fee-calculator-client-<VERSION>.gemspec
+$ gem push laa-fee-calculator-client-<VERSION>.gem
 ```
 *`<VERSION>` is the value of `LAA::FeeCalculator::VERSION`
 

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -1,9 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "pry-byebug"
-require "laa/fee_calculator"
+require 'bundler/setup'
+require 'laa/fee_calculator'
 
 # 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.
@@ -17,5 +16,5 @@ LAA::FeeCalculator.configure do |config|
   config.host = 'http://localhost:8000/api/v1'
 end
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/ruby_version_test

@@ -2,17 +2,64 @@
 
 set -e
 
-rubies=("ruby-2.6.0" "ruby-2.6.1" "ruby-2.6.2" "ruby-2.6.3" "ruby-2.6.4" "ruby-2.6.5" "ruby-2.6.6" "ruby-2.7.0" "ruby-2.7.1" "ruby-2.7.2")
-for i in "${rubies[@]}"
+RUBIES="2.7 3.0 3.1"
+
+if [ -e Gemfile.lock ]
+then
+  echo Moving Gemfile.lock to Gemfile.lock.tmp
+  mv Gemfile.lock Gemfile.lock.tmp
+fi
+
+if (which rbenv)
+then
+  echo "Using rbenv"
+  eval "$(rbenv init - bash)"
+  get_version() {
+    rbenv install --list 2> /dev/null | grep -E "^$1"
+  }
+  install_ruby() {
+    rbenv install --skip-existing $1
+  }
+  run_tests_with() {
+    rbenv shell $1
+    bundle install
+    bundle exec rspec spec
+    rbenv shell --unset
+  }
+elif (which rvm)
+then
+  echo "Using rvm"
+  get_version() {
+    echo $1
+  }
+  install_ruby() {
+    rvm install $1
+  }
+  run_tests_with() {
+    rvm $1 exec bundle install
+    rvm $1 exec bundle exec rspec spec
+  }
+else
+  echo "No Ruby version manager found"
+  exit 1
+fi
+
+for r in $RUBIES
 do
   echo "====================================================="
-  echo "$i: Start Test"
+  echo "$r: Start Test"
   echo "====================================================="
-  if [[ $(rvm list | grep $i) ]]; then echo "$i already installed!"; else rvm install $i; fi
-  rvm $i exec gem install bundler
-  rvm $i exec bundle install
-  rvm $i exec bundle exec rspec spec
+  VERSION=`get_version $r`
+  install_ruby $VERSION
+  run_tests_with $VERSION
+  rm Gemfile.lock
   echo "====================================================="
-  echo "$i: End Test"
+  echo "$r: End Test"
   echo "====================================================="
 done
+
+if [ -e Gemfile.lock.tmp ]
+then
+  echo Moving Gemfile.lock.tmp to Gemfile.lock
+  mv Gemfile.lock.tmp Gemfile.lock
+fi

data/laa-fee-calculator-client.gemspec

@@ -9,12 +9,11 @@ Gem::Specification.new do |spec|
   spec.version       = LAA::FeeCalculator::VERSION
   spec.authors       = ['Katharine Ahern', 'Ministry of Justice']
   spec.email         = ['katharine.ahern@digital.justice.gov.uk', 'joel.sugarman@digital.justice.gov.uk', 'tools@digital.justice.gov.uk']
-  spec.date          = LAA::FeeCalculator::VERSION_RELEASED
   spec.summary       = 'Ruby client for the Legal Aid Agency fee calculator API'
-  spec.description   = "Ruby client for the Ministry of Justices LAA fee calculator API. A simple interface for transparent calling of the API endpoints to query data and return calculated fee amounts."
+  spec.description   = 'Ruby client for the Ministry of Justices LAA fee calculator API. A simple interface for transparent calling of the API endpoints to query data and return calculated fee amounts.'
   spec.homepage      = 'https://github.com/ministryofjustice/laa-fee-calculator-client'
   spec.license       = 'MIT'
-  spec.extra_rdoc_files = ["LICENSE", "README.md"]
+  spec.extra_rdoc_files = ['LICENSE', 'README.md']
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test/|spec/|features/|\..*)})
@@ -26,16 +25,17 @@ Gem::Specification.new do |spec|
   # see bin/ruby_version_test
   spec.required_ruby_version = '>= 2.6.0'
 
-  spec.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.7'
-  spec.add_runtime_dependency 'faraday', '>= 0.9.2', '< 1.4.0'
+  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'faraday-http-cache', '~> 2.2'
 
   spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'bundler', '~> 2.2.8'
-  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rb-readline'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.78'
+  spec.add_development_dependency 'rubocop', '~> 1.28'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.13'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
 end

data/lib/laa/fee_calculator/calculator.rb

@@ -6,25 +6,18 @@ module LAA
       extend Forwardable
       def_delegators :connection, :get
 
-      attr_reader :scheme_pk, :options
-
       def initialize(scheme_pk, options)
-        @scheme_pk = scheme_pk
-        @options = options
+        @uri = "fee-schemes/#{scheme_pk}/calculate/"
+        @filtered_params = options.reject { |k, _v| k.eql?(:id) }
       end
 
       def call
-        uri.query_values = options.reject { |k, _v| k.eql?(:id) }
-        json = get(uri).body
+        json = get(@uri, @filtered_params).body
         JSON.parse(json)['amount']
       end
 
       private
 
-      def uri
-        @uri ||= Addressable::URI.parse("fee-schemes/#{scheme_pk}/calculate/")
-      end
-
       def connection
         @connection ||= Connection.instance
       end

data/lib/laa/fee_calculator/client.rb

@@ -1,4 +1,4 @@
-require "addressable/uri"
+# frozen_string_literal: true
 
 module LAA
   module FeeCalculator
@@ -17,13 +17,11 @@ module LAA
       end
 
       def fee_schemes(id = nil, **options)
-        uri = 'fee-schemes/'
-        id ||= options.fetch(:id, nil)
-        uri.concat(id.to_s, "/") if id
-        uri = Addressable::URI.parse(uri)
-        uri.query_values = options.reject { |k, _v| k.eql?(:id) }
+        uri = fee_schemes_uri(id || options[:id])
+        filtered_params = options.reject { |k, _| k.eql?(:id) }
+        # Ruby 3.0+; filtered_params = options.except(:id)
 
-        json = get(uri).body
+        json = get(uri, filtered_params).body
 
         fstruct = JSON.parse(json, object_class: FeeScheme)
         return fstruct unless fstruct.respond_to?(:results)
@@ -31,6 +29,14 @@ module LAA
 
         fstruct.results
       end
+
+      private
+
+      def fee_schemes_uri(id)
+        return "fee-schemes/#{id}/" if id
+
+        'fee-schemes/'
+      end
     end
   end
 end

data/lib/laa/fee_calculator/configuration.rb

@@ -6,7 +6,7 @@ module LAA
       LAA_FEE_CALCULATOR_API_V1 = 'https://laa-fee-calculator.service.justice.gov.uk/api/v1'
       HEADERS = { 'Accept' => 'application/json', 'User-Agent' => USER_AGENT }.freeze
 
-      attr_accessor :host, :headers
+      attr_accessor :host, :headers, :cache, :logger
 
       def initialize
         @host = host || LAA_FEE_CALCULATOR_API_V1

data/lib/laa/fee_calculator/connection.rb

@@ -2,6 +2,7 @@
 
 require 'singleton'
 require 'faraday'
+require 'faraday/http_cache'
 
 module LAA
   module FeeCalculator
@@ -16,6 +17,7 @@ module LAA
       def initialize
         @conn = Faraday.new(url: LAA::FeeCalculator.configuration.host, headers: default_headers) do |conn|
           conn.use LAA::FeeCalculator::RaiseError
+          conn.use(:http_cache, store: cache, logger: logger) if cache
           conn.adapter :net_http
         end
       end
@@ -39,6 +41,14 @@ module LAA
       def default_headers
         LAA::FeeCalculator.configuration.headers
       end
+
+      def cache
+        LAA::FeeCalculator.configuration.cache
+      end
+
+      def logger
+        LAA::FeeCalculator.configuration.logger
+      end
     end
   end
 end

data/lib/laa/fee_calculator/has_manyable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module LAA
@@ -17,18 +19,11 @@ module LAA
         end
 
         def has_many(association)
-          define_method("#{association}_uri".to_sym) do |scheme_pk = nil, id = nil|
-            uri = scheme_pk.nil? ? "#{association.to_s.tr('_', '-')}/" : "fee-schemes/#{scheme_pk}/#{association.to_s.tr('_', '-')}/"
-            uri = uri.concat(id.to_s, '/') unless id.nil?
-            Addressable::URI.parse(uri)
-          end
-
           define_method(association) do |id = nil, **options|
-            id ||= options&.fetch(:id, nil)
-            uri = self.send("#{association}_uri", self.id, id)
-            uri.query_values = options.reject { |k, _v| k.eql?(:id) }
+            uri = uri_for(association, id: id || options[:id])
+            filtered_params = options.reject { |k, _v| k.eql?(:id) }
 
-            json = get(uri).body
+            json = get(uri, filtered_params).body
 
             ostruct = JSON.parse(json, object_class: OpenStruct)
             return ostruct unless ostruct.respond_to?(:results)
@@ -37,6 +32,16 @@ module LAA
           end
         end
       end
+
+      def uri_for(association, id: nil)
+        return "#{base_fee_scheme_uri}#{association.to_s.tr('_', '-')}/" if id.nil?
+
+        "#{base_fee_scheme_uri}#{association.to_s.tr('_', '-')}/#{id}/"
+      end
+
+      def base_fee_scheme_uri
+        id ? "fee-schemes/#{id}/" : ''
+      end
     end
   end
 end

data/lib/laa/fee_calculator/version.rb

@@ -2,8 +2,7 @@
 
 module LAA
   module FeeCalculator
-    VERSION = "1.2.0"
-    VERSION_RELEASED = "2021-02-01"
+    VERSION = '1.4.0'
     USER_AGENT = "laa-fee-calculator-client/#{VERSION}"
   end
 end

data/lib/laa/fee_calculator.rb

@@ -12,7 +12,7 @@ module LAA
   module FeeCalculator
     class << self
       def root
-        spec = Gem::Specification.find_by_name("laa-fee-calculator-client")
+        spec = Gem::Specification.find_by_name('laa-fee-calculator-client')
         spec.gem_dir
       end
 

metadata

@@ -1,56 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: laa-fee-calculator-client
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Katharine Ahern
 - Ministry of Justice
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.7
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.7
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -66,21 +54,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.8
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.8
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rb-readline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,61 +82,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rb-readline
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.78'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.78'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +216,7 @@ homepage: https://github.com/ministryofjustice/laa-fee-calculator-client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -229,8 +231,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Ruby client for the Legal Aid Agency fee calculator API
 test_files: []