sequencescape-client-api 0.4.3 → 0.6.0.pre.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6165cb0ac7fff92a450a030a961c5249f0b647429d1f81af91917117e76081f4
-  data.tar.gz: 9504bdafbdc9def4a588d57e92de0bebe8acdbe3b163dfc9246cd0db455bc09b
+  metadata.gz: 4635af26773e382752071323b624a7f0bd79bad156274c6d211e861220a28f20
+  data.tar.gz: ce8b85bd9a143ac7c5668ecf77eddc167913359f9cae919ed22903338e9cf14d
 SHA512:
-  metadata.gz: 7138f22aeaa97717e093ecfa1f664c2ae9ff5c507bb4527a870af507007fb4f2bb6ee16f0ff9a8376448564e3c31eeca1aa91bad66b45e96aae8935e769b0511
-  data.tar.gz: 55f1f93cf063802dca85aa34c885837ebaf1d86ad39498047a84373f9198c98f9fc3d62d35447f6106e893a93ab5bacef95b789e39fa259d9fb4047b3679755d
+  metadata.gz: d41aaee47f0fc6f5b79d869ef518cee9165aa271bff3f935328819b27aec1c408c0300e955ba7939fa9b5a3a4c78ebfa25067a10ac06a7f6cbc33e7d4c10b5cd
+  data.tar.gz: 47170dbc8bead91f517e88d0dad9f7888245b5f897cac319c569fe74277c298fa60007ba6af7aa36b8e80d8d8db0fbdada4589094111980d9eeae18c000345d4

data/.github/workflows/ruby.yml

@@ -0,0 +1,39 @@
+name: Ruby
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.5", "2.6", "2.7", "3.0"]
+    name: Ruby Test ${{ matrix.ruby }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache:
+            true # Runs bundle install and caches gems. See the ruby_test.yml
+            # example if you need more control over bundler.
+      - name: Run tests
+        run: bundle exec rspec
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache:
+            true # Runs bundle install and caches gems. See the ruby_test.yml
+            # example if you need more control over bundler.
+      - name: Run lint
+        run: bundle exec rubocop

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 tags
 .DS_Store
 lib/.DS_Store
+.talismanrc

data/.rubocop.yml

@@ -22,23 +22,29 @@ Naming/FileName:
     - 'lib/sequencescape-api.rb'
 
 # Pending Cops
-Layout/EmptyLinesAroundAttributeAccessor:
+Lint/DuplicateBranch: # (new in 1.3)
   Enabled: true
-Layout/SpaceAroundMethodCallOperator:
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
   Enabled: true
-Lint/DeprecatedOpenSSLConstant:
+Lint/EmptyBlock: # (new in 1.1)
   Enabled: true
-Lint/RaiseException:
+Lint/EmptyClass: # (new in 1.3)
   Enabled: true
-Lint/StructNewOverride:
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
   Enabled: true
-Style/ExponentialNotation:
+Lint/ToEnumArguments: # (new in 1.1)
   Enabled: true
-Style/HashEachMethods:
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
   Enabled: true
-Style/HashTransformKeys:
+Style/ArgumentsForwarding: # (new in 1.1)
   Enabled: true
-Style/HashTransformValues:
+Style/CollectionCompact: # (new in 1.2)
   Enabled: true
-Style/SlicingWithRange:
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
   Enabled: true

data/.rubocop_todo.yml

@@ -1,11 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 15000`
-# on 2020-05-28 09:58:56 +0100 using RuboCop version 0.84.0.
+# on 2020-11-20 12:14:23 UTC using RuboCop version 1.3.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 4
+Lint/DuplicateBranch:
+  Exclude:
+    - 'lib/sequencescape-api/associations/belongs_to.rb'
+    - 'lib/sequencescape-api/connection_factory/actions.rb'
+
+# Offense count: 3
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/sequencescape-api/associations/belongs_to.rb'
+    - 'lib/sequencescape-api/resource_model_proxy.rb'
+    - 'lib/sequencescape/search.rb'
+
+# Offense count: 1
+Lint/MixedRegexpCaptureTypes:
+  Exclude:
+    - 'spec/support/contract_helper.rb'
+
 # Offense count: 2
 Lint/ShadowingOuterLocalVariable:
   Exclude:
@@ -28,28 +46,34 @@ Lint/Void:
   Exclude:
     - 'spec/sequencescape-api/associations_spec.rb'
 
-# Offense count: 10
+# Offense count: 7
 # Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 25
+  Max: 26
 
 # Offense count: 8
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
   Max: 65
 
 # Offense count: 1
-# Configuration parameters: CountComments.
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
   Max: 120
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 9
+  Max: 10
 
 # Offense count: 1
+# Cop supports --auto-correct.
 Naming/BinaryOperatorParameterName:
   Exclude:
     - 'lib/sequencescape-api/resource/instance_methods.rb'
@@ -71,18 +95,23 @@ Naming/PredicateName:
     - 'lib/sequencescape-api/resource/attributes.rb'
     - 'lib/sequencescape-api/resource_model_proxy.rb'
 
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, AllowModifiersOnSymbols.
-# SupportedStyles: inline, group
-Style/AccessModifierDeclarations:
-  Exclude:
-    - 'lib/sequencescape-api/resource/attributes.rb'
-
 # Offense count: 1
 Style/BeginBlock:
   Exclude:
     - 'lib/sequencescape-api/connection_factory/actions.rb'
 
+# Offense count: 11
+Style/DocumentDynamicEvalDefinition:
+  Exclude:
+    - 'lib/sequencescape-api/actions.rb'
+    - 'lib/sequencescape-api/associations.rb'
+    - 'lib/sequencescape-api/composition.rb'
+    - 'lib/sequencescape-api/finder_methods.rb'
+    - 'lib/sequencescape-api/resource/attributes.rb'
+    - 'lib/sequencescape/batch.rb'
+    - 'lib/sequencescape/behaviour/state_driven.rb'
+    - 'lib/sequencescape/search.rb'
+
 # Offense count: 138
 Style/Documentation:
   Exclude:
@@ -214,6 +243,12 @@ Style/EvalWithLocation:
     - 'lib/sequencescape/behaviour/state_driven.rb'
     - 'lib/sequencescape/search.rb'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExplicitBlockArgument:
+  Exclude:
+    - 'spec/support/contract_helper.rb'
+
 # Offense count: 104
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
@@ -326,13 +361,18 @@ Style/FrozenStringLiteralComment:
     - 'sequencescape-api.gemspec'
 
 # Offense count: 2
-Style/MethodMissingSuper:
+Style/MissingRespondToMissing:
   Exclude:
     - 'lib/sequencescape-api/associations/belongs_to.rb'
-    - 'lib/sequencescape-api/resource_model_proxy.rb'
+    - 'lib/sequencescape-api/core.rb'
 
-# Offense count: 2
-Style/MissingRespondToMissing:
+# Offense count: 6
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
   Exclude:
     - 'lib/sequencescape-api/associations/belongs_to.rb'
     - 'lib/sequencescape-api/core.rb'
+    - 'lib/sequencescape-api/finder_methods.rb'
+    - 'lib/sequencescape-api/resource/instance_methods.rb'
+    - 'lib/sequencescape-api/resource/modifications.rb'

data/README.markdown

@@ -1,23 +1,25 @@
-Sequencescape Client API
-========================
+# Sequencescape Client API
 
 This is the Ruby client library for the Sequencescape API.
 Documentation can be found [on the wiki](https://github.com/sanger/sequencescape-client-api/wiki).
 
-Version Guides
---------------
+## Version Guides
 
 - 0.2.x Supports older versions of Rails.
 - 0.3.x Supports Rails 3.2.x to 5.1.x
 - 0.4.x Supports Rails 5.0 and up
+- 0.5.x Supports Rails 5.0 and up, drops yajl in favour of multi-json
+- 0.6.x Removes usage of WTSISignOn cookie. Replaces with user specific api key,
+  can be provided to Sequencescape::Api.new as user_api_key: or via
+  `api_connection_options` in the controller.
 
-- master currently corresponds to 0.4.x
+- master currently corresponds to 0.6.x
 
 Rails 6 appears to be supported judging by Specs, but haven't used it in anger
 yet.
 
-Making a release
-----------------
+## Making a release
+
 1. Update the version number in `lib/sequencescape-api/version.rb`
 2. For pre-releases the version number should be in the format:
    major.minor.point-rcx
@@ -25,6 +27,8 @@ Making a release
    major.minor.point
 4. Ensure everything is committed, and for non-pre-releases, make sure you are
    merged to master.
+
 ```
   rake release
 ``
+```

data/lib/sequencescape-api.rb

@@ -1,4 +1,5 @@
 require 'active_support'
+require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/class'
 require 'active_support/core_ext/kernel/singleton_class'

data/lib/sequencescape-api/connection_factory.rb

@@ -7,8 +7,8 @@ class Sequencescape::Api::ConnectionFactory
 
   def self.create(options)
     required_options = []
-    required_options.push(:cookie) if options[:authorisation].blank?
-    required_options.push(:url)    if default_url.blank?
+    required_options.push(:user_api_key) if options[:authorisation].blank?
+    required_options.push(:url) if default_url.blank?
 
     required_options.push(allow_blank: false)
     options.required!(*required_options) do |missing|
@@ -19,12 +19,12 @@ class Sequencescape::Api::ConnectionFactory
     new(options)
   end
 
-  attr_reader :url, :cookie, :read_timeout
-  private :url, :cookie, :read_timeout
+  attr_reader :url, :user_api_key, :read_timeout
+  private :url, :user_api_key, :read_timeout
 
   def initialize(options)
     @url = options[:url]
-    @cookie = options[:cookie]
+    @user_api_key = options[:user_api_key]
     @authorisation = options[:authorisation]
     @read_timeout = options[:read_timeout] || 120
   end

data/lib/sequencescape-api/connection_factory/actions.rb

@@ -1,5 +1,5 @@
 require 'net/http'
-require 'yajl'
+require 'multi_json'
 
 # PINCHED FROM https://gist.github.com/736721
 BEGIN {
@@ -48,7 +48,7 @@ module Sequencescape::Api::ConnectionFactory::Actions
   end
 
   # rubocop:todo Metrics/MethodLength
-  def create(url, body, handler) # rubocop:todo Metrics/CyclomaticComplexity
+  def create(url, body, handler)
     perform(:post, url, jsonify(body, action: :create)) do |response|
       case response
       when Net::HTTPCreated             then handler.success(parse_json_from(response))
@@ -64,7 +64,7 @@ module Sequencescape::Api::ConnectionFactory::Actions
   # rubocop:enable Metrics/MethodLength
 
   # rubocop:todo Metrics/MethodLength
-  def create_from_file(url, file, filename, content_type, handler) # rubocop:todo Metrics/CyclomaticComplexity
+  def create_from_file(url, file, filename, content_type, handler)
     perform_for_file(:post, url, file, filename, content_type) do |response|
       case response
       when Net::HTTPCreated             then handler.success(parse_json_from(response))
@@ -113,7 +113,7 @@ module Sequencescape::Api::ConnectionFactory::Actions
       unless body.nil?
         request.content_type = 'application/json'
         # request.body         = body.to_json
-        request.body         = Yajl::Encoder.encode(body)
+        request.body         = MultiJson.dump(body)
       end
       yield(connection.request(request))
     end
@@ -146,12 +146,12 @@ module Sequencescape::Api::ConnectionFactory::Actions
   def parse_json_from(response)
     raise ServerError, 'server returned non-JSON content' unless response.content_type == 'application/json'
 
-    Yajl::Parser.parse(StringIO.new(response.body))
+    MultiJson.load(StringIO.new(response.body))
   end
   private :parse_json_from
 
   def headers
-    { 'Accept' => 'application/json', 'Cookie' => "WTSISignOn=#{cookie}" }.tap do |standard|
+    { 'Accept' => 'application/json', 'Cookie' => "api_key=#{user_api_key}" }.tap do |standard|
       standard.merge!('X-Sequencescape-Client-ID' => @authorisation) unless @authorisation.blank?
     end
   end

data/lib/sequencescape-api/finder_methods.rb

@@ -82,11 +82,9 @@ end
 class Sequencescape::Api::PageOfResults
   include Enumerable
 
-  attr_reader :api, :actions
+  attr_reader :api, :actions, :size
   private :api, :actions
 
-  attr_reader :size
-
   def initialize(api, json, &block)
     @api = api
     @ctor = block

data/lib/sequencescape-api/rails.rb

@@ -1,7 +1,6 @@
 module Sequencescape::Api::Rails
   # Including this module into your Rails ApplicationController adds a before filter that will
-  # provide a user (based on the WTSISignOn cookie) specific Sequencescape::Api instance to
-  # use, accessible through `api`.
+  # provide a Sequencescape::Api instance to use, accessible through `api`.
   module ApplicationController
     def self.included(base) # rubocop:todo Metrics/MethodLength
       base.class_eval do
@@ -20,32 +19,29 @@ module Sequencescape::Api::Rails
       end
     end
 
+    private
+
     def api_class
       ::Sequencescape::Api
     end
-    private :api_class
 
     def configure_api
-      @api = api_class.new({ cookie: cookies['WTSISignOn'] }.merge(api_connection_options))
+      @api = api_class.new(api_connection_options)
     end
-    private :configure_api
 
     def api_connection_options
-      {}
+      raise Sequencescape::Api::Error, "api_connection_options not implemented for #{self.class}"
     end
-    private :api_connection_options
 
     def sequencescape_api_error_handler(exception)
       Rails.logger.error "#{exception}, #{exception.backtrace}"
       raise StandardError, "There is an issue with the API connection to Sequencescape (#{exception.message})"
     end
-    private :sequencescape_api_error_handler
 
     def sequencescape_api_unauthenticated_handler(exception)
       Rails.logger.error "#{exception}, #{exception.backtrace}"
       raise StandardError, 'You are not authenticated; please visit the WTSI login page'
     end
-    private :sequencescape_api_unauthenticated_handler
   end
 
   # Including this module into your Rails model indicates that the model is associated with

data/lib/sequencescape-api/version.rb

@@ -1,5 +1,5 @@
 module Sequencescape
   class Api
-    VERSION = '0.4.3'.freeze
+    VERSION = '0.6.0-rc2'.freeze
   end
 end

data/lib/sequencescape/order.rb

@@ -9,5 +9,6 @@ class Sequencescape::Order < ::Sequencescape::Api::Resource
   # It does, but we don't care for now.
   # has_many :request_types
 
-  attr_accessor :request_options
+  attribute_accessor :request_options
+  attribute_writer :autodetect_studies_projects
 end

data/sequencescape-api.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    = ''
   s.summary     = 'Gem for the client side of the Sequencescape API'
   s.description = 'Provides all of the necessary code for interacting with the Sequencescape API'
+  s.required_ruby_version = '> 2.4'
 
   s.rubyforge_project = 'sequencescape-client-api'
 
@@ -18,16 +19,27 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
+  s.post_install_message = <<~POST_INSTALL
+    sequencescape-client-api has dropped 'yajl-ruby' in favour of 'multi_json',
+    https://rubygems.org/gems/multi_json. This will automatically pick the
+    fastest json encoder in your Gemfile, falling back to the default encoder.
+
+    For best performance you are strongly encouraged to add a custom json
+    encoder to your project. eg. bundle install oj.
+  POST_INSTALL
+
   s.add_dependency('activemodel', '>= 5.0.0')
   s.add_dependency('activesupport', '>= 5.0.0')
   s.add_dependency('i18n')
-  s.add_dependency('yajl-ruby', '>= 1.4.1')
+  s.add_dependency('multi_json')
 
   s.add_development_dependency('pry')
   s.add_development_dependency('rake')
   s.add_development_dependency('redcarpet')
   s.add_development_dependency('rspec', '~> 2.11.0')
-  s.add_development_dependency('rubocop', '~> 0.84.0')
+  s.add_development_dependency('rubocop', '~> 1.3.1')
   s.add_development_dependency('webmock')
   s.add_development_dependency('yard')
+  # Add a json encoder for development
+  s.add_development_dependency('oj')
 end

data/spec/sequencescape-api/contracts/create-invalid-resource.txt

@@ -1,7 +1,7 @@
 POST /model_c/create HTTP/1.1
 Accept: application/json
 Content-Type: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie
 
 {
   "model_c": {

data/spec/sequencescape-api/contracts/create-model-c-has-many-inline-nested.txt

@@ -1,7 +1,7 @@
 POST /model_c/create HTTP/1.1
 Accept: application/json
 Content-Type: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie
 
 {
   "model_c": {

data/spec/sequencescape-api/contracts/create-model-c-has-many-inline.txt

@@ -1,7 +1,7 @@
 POST /model_c/create HTTP/1.1
 Accept: application/json
 Content-Type: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie
 
 {
   "model_c": {

data/spec/sequencescape-api/contracts/create-model-c-has-many.txt

@@ -1,7 +1,7 @@
 POST /model_c/create HTTP/1.1
 Accept: application/json
 Content-Type: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie
 
 {
   "model_c": {

data/spec/sequencescape-api/contracts/create-model-c.txt

@@ -1,7 +1,7 @@
 POST /model_c/create HTTP/1.1
 Accept: application/json
 Content-Type: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie
 
 {
   "model_c": {

data/spec/sequencescape-api/contracts/create-via-has-many.txt

@@ -1,7 +1,7 @@
 POST /UUID/model_bs HTTP/1.1
 Accept: application/json
 Content-Type: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie
 
 {
   "model_b": {

data/spec/sequencescape-api/contracts/retrieve-belongs-to-association.txt

@@ -1,3 +1,3 @@
 GET /BELONGS_TO_UUID HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-model.txt

@@ -1,4 +1,3 @@
 GET /UUID HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
-
+Cookie: api_key=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-results-page-1.txt

@@ -1,3 +1,3 @@
 GET /pages/1 HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-results-page-2.txt

@@ -1,3 +1,3 @@
 GET /pages/2 HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-results-page-3.txt

@@ -1,3 +1,3 @@
 GET /pages/3 HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-root-with-an-authorised-client.txt

@@ -1,5 +1,4 @@
 GET / HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie
 X-Sequencescape-Client-Id: authorised!
-

data/spec/sequencescape-api/contracts/retrieve-root-with-an-unauthorised-client.txt

@@ -1,4 +1,3 @@
 GET / HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
-
+Cookie: api_key=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-unauthorised-model-a-list.txt

@@ -1,4 +1,3 @@
 GET /model_a HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
-
+Cookie: api_key=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-unauthorised-model-b-list.txt

@@ -1,4 +1,3 @@
 GET /model_b HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
-
+Cookie: api_key=single-sign-on-cookie

data/spec/sequencescape-api/contracts/retrieve-unauthorised-model-c-list.txt

@@ -1,4 +1,3 @@
 GET /model_c HTTP/1.1
 Accept: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
-
+Cookie: api_key=single-sign-on-cookie

data/spec/sequencescape-api/contracts/update-invalid-resource.txt

@@ -1,7 +1,7 @@
 PUT /UUID HTTP/1.1
 Accept: application/json
 Content-Type: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie
 
 {
   "model_c": {

data/spec/sequencescape-api/contracts/update-model-c.txt

@@ -1,7 +1,7 @@
 PUT /UUID HTTP/1.1
 Accept: application/json
 Content-Type: application/json
-Cookie: WTSISignOn=single-sign-on-cookie
+Cookie: api_key=single-sign-on-cookie
 
 {
   "model_c": {

data/spec/sequencescape-api/root_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe 'Handling authentication issues' do
   stub_request_from('retrieve-root-with-an-unauthorised-client') { response('client-fails-authentication') }
 
-  subject { Sequencescape::Api.new(url: 'http://localhost:3000/', cookie: 'single-sign-on-cookie') }
+  subject { Sequencescape::Api.new(url: 'http://localhost:3000/', user_api_key: 'single-sign-on-cookie') }
 
   it 'raises an exception' do
     -> { subject }.should raise_error(Sequencescape::Api::UnauthenticatedError)
@@ -17,7 +17,7 @@ describe 'Retrieving the root URL' do
     is_working_as_an_unauthorised_client
 
     context 'with no namespace' do
-      subject { Sequencescape::Api.new(url: 'http://localhost:3000/', cookie: 'single-sign-on-cookie') }
+      subject { Sequencescape::Api.new(url: 'http://localhost:3000/', user_api_key: 'single-sign-on-cookie') }
 
       Unauthorised::MODELS_THROUGH_API.each do |model|
         it "provides the #{model} through the API instance" do
@@ -25,7 +25,7 @@ describe 'Retrieving the root URL' do
         end
 
         it "errors because Sequencescape::#{model.to_s.classify} is not defined" do
-          # Note: Using a regex as > Ruby 2.3 'DidYouMean' changes the error message slightly.
+          # NOTE: Using a regex as > Ruby 2.3 'DidYouMean' changes the error message slightly.
           lambda {
             subject.send(model.to_sym)
           }.should raise_error(NameError,

data/spec/support/contract_helper.rb

@@ -35,7 +35,7 @@ module ContractHelper
         @url = "http://localhost:3000#{match[:path]}"
         @conditions = {}
         @conditions[:headers] = Hash[*match[:headers].split(/\r?\n/).map { |l| l.split(':') }.flatten.map(&:strip)]
-        @conditions[:body] = Yajl::Encoder.encode(Yajl::Parser.parse(match[:body])) unless match[:body].blank?
+        @conditions[:body] = MultiJson.dump(MultiJson.load(match[:body])) unless match[:body].blank?
       end
     end
 
@@ -96,7 +96,7 @@ module ContractHelper
       end
       let(:api) do
         Sequencescape::Api.new(
-          url: 'http://localhost:3000/', cookie: 'single-sign-on-cookie',
+          url: 'http://localhost:3000/', user_api_key: 'single-sign-on-cookie',
           namespace: Unauthorised
         )
       end
@@ -107,7 +107,7 @@ module ContractHelper
 
       let(:api) do
         Sequencescape::Api.new(
-          url: 'http://localhost:3000/', cookie: 'single-sign-on-cookie',
+          url: 'http://localhost:3000/', user_api_key: 'single-sign-on-cookie',
           authorisation: 'authorised!', namespace: Authenticated
         )
       end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sequencescape-client-api
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0.pre.rc2
 platform: ruby
 authors:
 - Matthew Denner
 - James Glover
 - Eduardo Martin Rojo
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -55,19 +55,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -130,14 +130,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.84.0
+        version: 1.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.84.0
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  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'
 description: Provides all of the necessary code for interacting with the Sequencescape
   API
 email:
@@ -176,6 +190,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -493,23 +508,29 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: |
+  sequencescape-client-api has dropped 'yajl-ruby' in favour of 'multi_json',
+  https://rubygems.org/gems/multi_json. This will automatically pick the
+  fastest json encoder in your Gemfile, falling back to the default encoder.
+
+  For best performance you are strongly encouraged to add a custom json
+  encoder to your project. eg. bundle install oj.
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Gem for the client side of the Sequencescape API
 test_files: