jsonrpc2 0.1.1 → 0.3.0

data/lib/jsonrpc2/textile.rb

@@ -8,11 +8,11 @@ module JSONRPC2
 			return nil if @about.nil? or @about.empty?
 			str = ""
 
-			if @title
+      if @title
 				str << "h1. #{@title}\n"
       else
         str << "h1. #{name}\n"
-			end
+      end
 
 			if @introduction
 				str << "\nh2. Introduction\n\n#{@introduction}\n"
@@ -41,7 +41,7 @@ module JSONRPC2
 				if section[:summary]
 					str << "\n#{section[:summary]}\n"
 				end
-				
+
 				str += to_textile_group(section).to_s
 			end
 
@@ -70,7 +70,7 @@ module JSONRPC2
 
       if res = info[:returns]
         str << "\n\nh5. Result\n"
-        str << "\n* @#{res[:type]}@"		
+        str << "\n* @#{res[:type]}@"
         str << " - #{res[:desc]}" if res[:desc]
         str << "\n"
       else
@@ -128,7 +128,7 @@ module JSONRPC2
 			return nil if list.empty?
 
 			str = ''
-			
+
 			list.sort_by { |info| info[:index] }.each do |info|
         str << method_to_textile(info)
 			end

data/lib/jsonrpc2/types.rb

@@ -16,6 +16,9 @@ module JSONRPC2
   # * Value (or Any or void) - Any value of any type
   # * CustomType - A defined custom object type
   module Types
+    class InvalidParamsError < ArgumentError; end
+    class InvalidResultError < RuntimeError; end
+
     module_function
     DateTimeRegex = %r"([0-9]{4})(-([0-9]{2})(-([0-9]{2})(T([0-9]{2}):([0-9]{2})(:([0-9]{2})(\.([0-9]+))?)?(Z|(([-+])([0-9]{2}):([0-9]{2})))?)?)?)?"
     DateRegex     = %r'\A\d{4}-\d{2}-\d{2}\z'
@@ -76,7 +79,7 @@ module JSONRPC2
     end
 
     # Checks that param hash is valid for API call
-    # 
+    #
     # @param [Interface] interface API class
     # @param [String] method Method name
     # @param [Hash] data params hash to check
@@ -92,23 +95,23 @@ module JSONRPC2
         return true
       end
 
-      raise "Params should not be nil" if data.nil?
+      raise InvalidParamsError, "Params should not be nil" if data.nil?
 
       extra_keys = data.keys - param_names
       unless extra_keys.empty?
-        raise "Extra parameters #{extra_keys.inspect} for #{method}."
+        raise InvalidParamsError, "Extra parameters #{extra_keys.inspect} for #{method}."
       end
 
       params.each do |param|
         if data.has_key?(param[:name])
           value = data[param[:name].to_s]
           unless valid?(interface, param[:type], value)
-            raise "'#{param[:name]}' should be of type #{param[:type]}, was #{value.class.name}"
+            raise InvalidParamsError, "'#{param[:name]}' should be of type #{param[:type]}, was #{value.class.name}"
           end
         elsif ! param[:required]
           next true
         else
-          raise "Missing parameter: '#{param[:name]}' of type #{param[:type]} for #{method}"
+          raise InvalidParamsError, "Missing parameter: '#{param[:name]}' of type #{param[:type]} for #{method}"
         end
       end
     end
@@ -122,11 +125,12 @@ module JSONRPC2
     def valid_result?(interface, method, value)
       about = interface.about[method.to_s]
       return true if about.nil? # Undefined
-      if about[:returns].nil?
-        return value.nil?
-      end
-      valid?(interface, about[:returns][:type], value) or
-        raise "Invalid return type: should have been #{about[:returns][:type]}, was #{value.class.name}"
+      return value.nil? if about[:returns].nil?
+      return true if valid?(interface, about[:returns][:type], value)
+
+      raise InvalidResultError, <<~MSG.chomp
+        Invalid return type: should have been #{about[:returns][:type]}, was #{value.class.name}
+      MSG
     end
   end
 

data/lib/jsonrpc2/version.rb

@@ -1,5 +1,5 @@
 # JSONRPC2 namespace module
 module JSONRPC2
   # Version
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
 end

data/spec/lib/interface_spec.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'base64'
+require 'logger'
+require 'jsonrpc2/interface'
+require 'jsonrpc2/auth'
+
+RSpec.describe JSONRPC2::Interface do
+  let(:instance) { rpc_api_class.new(initialization_params) }
+  let(:basic_auth_credentials) { 'user:valid_password' }
+  let(:initialization_params) { { 'HTTP_AUTHORIZATION' => "Basic #{Base64.encode64(basic_auth_credentials)}" } }
+  let(:rpc_api_class) do
+    Class.new(described_class) do
+      auth_with JSONRPC2::BasicAuth.new('user' => 'valid_password')
+
+      param 'name', 'String', 'name'
+      result 'String', 'A tailored greeting'
+      def hello
+        raise 'He-Must-Not-Be-Named' if params['name'] == 'Voldemort'
+        return 42 if params['name'] == 'Marvin'
+
+        "Hello, #{params['name']}!"
+      end
+    end
+  end
+
+  describe '#rack_dispatch' do
+    subject(:dispatch_result) { instance.rack_dispatch(rpc_request_data) }
+
+    let(:rpc_request_data) { { 'id' => 123, 'method' => 'hello', 'jsonrpc' => '2.0' } }
+    let(:response_status) { dispatch_result[0] }
+    let(:response_body) { dispatch_result[2][0] }
+    let(:parsed_response_body) { JSON.parse(response_body, symbolize_names: true) }
+
+    context 'with empty input' do
+      let(:rpc_request_data) { {} }
+
+      it 'returns the "Invalid request" error' do
+        expect(parsed_response_body[:error]).to eq(
+          code: -32600,
+          message: 'Invalid request',
+          data: nil
+        )
+      end
+    end
+
+    context 'with invalid credentials' do
+      let(:basic_auth_credentials) { 'user:invalid_password' }
+      it 'returns the authorization error' do
+        expect(response_status).to eq(401)
+        expect(response_body).to include('Authentication Required')
+      end
+    end
+
+    context 'with no params' do
+      it 'returns the "Params should not be nil" error' do
+        expect(parsed_response_body[:error]).to eq(
+          code: -32602,
+          message: 'Invalid params - Params should not be nil',
+          data: {}
+        )
+      end
+    end
+
+    context 'with a missing param' do
+      let(:rpc_request_data) { super().merge('params' => {}) }
+
+      it 'returns a helpful param error' do
+        expect(parsed_response_body[:error]).to eq(
+          code: -32602,
+          message: 'Invalid params - Missing parameter: \'name\' of type String for hello',
+          data: {}
+        )
+      end
+    end
+
+    context 'with a mismatched type of param' do
+      let(:rpc_request_data) { super().merge('params' => { 'name' => true }) }
+
+      it 'returns the helpful param error' do
+        expect(parsed_response_body[:error]).to eq(
+          code: -32602,
+          message: 'Invalid params - \'name\' should be of type String, was TrueClass',
+          data: {}
+        )
+      end
+    end
+
+    context 'with a valid param' do
+      let(:rpc_request_data) { super().merge('params' => params) }
+      let(:params) { { 'name' => 'Geoff' } }
+
+      it 'returns the valid response' do
+        expect(parsed_response_body[:result]).to eq('Hello, Geoff!')
+      end
+
+      context 'with an extra param' do
+        let(:params) { super().merge('extra' => 'I should not be here') }
+
+        it 'returns the helpful param error' do
+          expect(parsed_response_body[:error]).to eq(
+            code: -32602,
+            message: 'Invalid params - Extra parameters ["extra"] for hello.',
+            data: {}
+          )
+        end
+      end
+
+      context 'with an invalid result type' do
+        let(:params) { { 'name' => 'Marvin' } }
+
+        it 'informs about the server error' do
+          expect(parsed_response_body[:error]).to match(
+            code: -32000,
+            message: 'An error occurred. Check logs for details',
+            data: {}
+          )
+        end
+      end
+
+      context 'with a correctly configured before_validation hook' do
+        before do
+          rpc_api_class.class_eval do
+            attr_reader :test_before_validation_data
+
+            def before_validation(method:, id:, params:)
+              @test_before_validation_data = {
+                method: method,
+                id: id,
+                params: params
+              }
+            end
+          end
+        end
+
+        it 'invokes the hook' do
+          dispatch_result
+
+          expect(instance.test_before_validation_data[:method]).to eq('hello')
+          expect(instance.test_before_validation_data[:id]).to eq(123)
+          expect(instance.test_before_validation_data[:params]).to eq({ 'name' => 'Geoff' })
+        end
+      end
+    end
+
+    context 'with an unhandled server error' do
+      let(:rpc_request_data) { super().merge('params' => { 'name' => 'Voldemort' }) }
+
+      it 'informs about the server error' do
+        expect(parsed_response_body[:error]).to match(
+          code: -32000,
+          message: 'An error occurred. Check logs for details',
+          data: {}
+        )
+      end
+
+      context 'with a correctly configured error hook' do
+        before do
+          rpc_api_class.class_eval do
+            attr_reader :test_error_data
+
+            def on_server_error(request_id:, error:)
+              @test_error_data = {
+                request_id: request_id,
+                error: error
+              }
+            end
+          end
+        end
+
+        it 'invokes the hook' do
+          dispatch_result
+
+          expect(instance.test_error_data[:error].message).to eq('He-Must-Not-Be-Named')
+          expect(instance.test_error_data[:request_id]).to eq(nil) # Request_id is generated higher in the stack
+        end
+      end
+
+      context 'with error hook raising an error' do
+        let(:initialization_params) { super().merge('rack.logger' => rack_logger) }
+        let(:rack_logger) { instance_double(::Logger, :rack_logger, info: nil, error: nil) }
+
+        before do
+          rpc_api_class.class_eval do
+            def on_server_error(request_id:, error:)
+              raise "Whoops, my bad!"
+            end
+          end
+        end
+
+        it 'informs about the server error' do
+          expect(parsed_response_body[:error]).to match(
+            code: -32000,
+            message: 'An error occurred. Check logs for details',
+            data: {}
+          )
+        end
+
+        it 'logs the error' do
+          expect(rack_logger).to receive(:error).with(/Whoops, my bad!/)
+
+          dispatch_result
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://relishapp.com/rspec/rspec-core/docs/configuration/zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -1,85 +1,164 @@
 --- !ruby/object:Gem::Specification
 name: jsonrpc2
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Geoff Youngs
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2014-01-04 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: RedCloth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: "== Description\n\nA Rack compatible JSON-RPC2 server domain specific
-  language (DSL) - allows JSONRPC APIs to be \ndefined as mountable Rack applications
-  with inline documentation, authentication and type checking.\n\ne.g.\n\n  class
-  Calculator < JSONRPC2::Interface\n    title \"JSON-RPC2 Calculator\"\n    introduction
-  \"This interface allows basic maths calculations via JSON-RPC2\"\n    auth_with
-  JSONRPC2::BasicAuth.new({'user' => 'secretword'})\n\n    section 'Simple Ops' do\n
-  \       desc 'Multiply two numbers'\n        param 'a', 'Number', 'a'\n        param
-  'b', 'Number', 'b'\n        result 'Number', 'a * b'\n        def mul args\n          args['a']
-  * args['b']\n        end\n\n        desc 'Add numbers'\n        example \"Calculate
-  1 + 1 = 2\", :params => { 'a' => 1, 'b' => 1}, :result => 2\n\n        param 'a',
-  'Number', 'First number'\n        param 'b', 'Number', 'Second number'\n        optional
-  'c', 'Number', 'Third number'\n        result 'Number', 'a + b + c'\n        def
-  sum args\n          val = args['a'] + args['b']\n          val += args['c'] if args['c']\n
-  \         val\n        end\n    end\n  end\n\n"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: rspec
+  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: puma
+  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: pry-byebug
+  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: |+
+  == Description
+
+  A Rack compatible JSON-RPC2 server domain specific language (DSL) - allows JSONRPC APIs to be
+  defined as mountable Rack applications with inline documentation, authentication and type checking.
+
+  e.g.
+
+    class Calculator < JSONRPC2::Interface
+      title "JSON-RPC2 Calculator"
+      introduction "This interface allows basic maths calculations via JSON-RPC2"
+      auth_with JSONRPC2::BasicAuth.new({'user' => 'secretword'})
+
+      section 'Simple Ops' do
+          desc 'Multiply two numbers'
+          param 'a', 'Number', 'a'
+          param 'b', 'Number', 'b'
+          result 'Number', 'a * b'
+          def mul args
+            args['a'] * args['b']
+          end
+
+          desc 'Add numbers'
+          example "Calculate 1 + 1 = 2", :params => { 'a' => 1, 'b' => 1}, :result => 2
+
+          param 'a', 'Number', 'First number'
+          param 'b', 'Number', 'Second number'
+          optional 'c', 'Number', 'Third number'
+          result 'Number', 'a + b + c'
+          def sum args
+            val = args['a'] + args['b']
+            val += args['c'] if args['c']
+            val
+          end
+      end
+    end
+
 email:
 - git@intersect-uk.co.uk
 executables:
@@ -87,12 +166,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Dockerfile
 - Gemfile
 - README.markdown
 - Rakefile
-- bin/jsonrpc2
+- bin/run-example
+- bin/setup
+- bin/test
 - example/config.ru
+- exe/jsonrpc2
 - jsonrpc2.gemspec
 - lib/assets/css/bootstrap.css
 - lib/assets/css/bootstrap.min.css
@@ -110,28 +196,36 @@ files:
 - lib/jsonrpc2/textile.rb
 - lib/jsonrpc2/types.rb
 - lib/jsonrpc2/version.rb
+- spec/lib/interface_spec.rb
+- spec/spec_helper.rb
 - test/test_types.rb
-homepage: http://github.com/geoffyoungs/jsonrpc2
+homepage: http://github.com/livelink/jsonrpc2
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/livelink/jsonrpc2/issues
+  changelog_uri: https://github.com/livelink/jsonrpc2/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/livelink/jsonrpc2#inline-documentation
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: JSON-RPC2 server DSL
-test_files: []
+test_files:
+- spec/lib/interface_spec.rb
+- spec/spec_helper.rb
+- test/test_types.rb
+...