jsonrpc2 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb244988f3e6da4bd9e07cb696ae0527dc60c5ec
-  data.tar.gz: 8b378af79f04b2603d6ac7ad669918bb9e055962
+SHA256:
+  metadata.gz: 38157bffab895f13838433b4564add0f49d5823a9220eafc0b8d9e402bad7931
+  data.tar.gz: 5ff1f88ca328078754a7fec05f386ab7308ddef82fbb4f8e357b4eceeef0d373
 SHA512:
-  metadata.gz: 8ec025d776da30ad4251511f1907cad21fe1dc76580a907113417fe7e658de63435ec67976b96488c02b41806ab794452e1aad695769cb60059fc9d6dc35ceb7
-  data.tar.gz: 0f7017e7d77711638377d340d7aae1a6355ddca9b40a0ec7e0218c16dd31bc33a364a7e07acdcf10b9a991c1465987bda927fae0c0cb90c245028ebeb38fc8f3
+  metadata.gz: b59d216b880ebeb4988573873090e9bd0807b77a8c7235ee28cfd84a6aeef219d5a7c7c9e16109a93b55d1857a01d3bf7e5ccc10f6bde4e62972199e05f2bccc
+  data.tar.gz: 507d80c0b89143a72c092dc994bc31d72977d5289dfb2c446d879af4b8790f0456457bc8d649a21cdcae9d632f2e8d3acb121c9f24999dcf276d39c18122a05f

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Run automated tests
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby: [2.7, 3.0]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run automated tests
+      run: bundle exec rspec

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+## [0.3.0] - 2023-02-09
+### Added
+- Possibility to define callback for request calls prior to validation `JSONRPC2::Interface#before_validation`
+
+## [0.2.0] - 2022-04-07
+### Added
+- Possibility to define callback for server errors with `JSONRPC2::Interface#on_server_error`
+
+### Fixed
+- Fixed regression introduced in 0.1.1 which makes the valid requests crash
+- Stopped exposing application internals publicly on errors
+
+## [0.1.1] - 2014-01-04
+### Changed
+- Improve logging of exceptions / failure
+
+## [0.1.0] - 2014-01-04
+### Changed
+- Turn on timing & logging of all requests
+
+## [0.0.9] - 2012-09-03
+### Changed
+- Improve client validation
+- Make params optional in request call
+
+## [0.0.8] - 2012-09-03
+### Changed
+- Add #request to access Rack::Request object
+- Make URLs in HTML interface clickable
+
+## [0.0.7] - 2012-08-27
+### Changed
+- Add bundled Bootstrap assets for HTML test interface
+
+## [0.0.6] - 2012-08-24
+### Changed
+- Add Date/Time/DateTime as special string types with regex checks for validation
+
+## [0.0.5] - 2012-07-19
+### Changed
+- Add commandline client jsonrpc2
+- Add #auth to access currently authenticated username

data/Dockerfile

@@ -0,0 +1,8 @@
+FROM ruby:3
+
+RUN mkdir /srv/www
+WORKDIR /srv/www
+COPY jsonrpc2.gemspec .
+COPY Gemfile .
+COPY lib/jsonrpc2/version.rb lib/jsonrpc2/
+RUN bundle install

data/README.markdown

@@ -2,32 +2,6 @@
 
 A Rack compatible, documenting JSON-RPC 2 DSL/server implementation for ruby.
 
-## Changes
-
-* 0.1.1 - 4-Jan-2013
-  Improve logging of exceptions / failure
-
-* 0.1.0 - 4-Jan-2013
-  Turn on timing & logging of all requests
-
-* 0.0.9 - 3-Sep-2012
-  Improve client validation
-  Make params optional in request call
-
-* 0.0.8 - 3-Sep-2012
-  Add #request to access Rack::Request object
-  Make URLs in HTML interface clickable
-
-* 0.0.7 - 27-Aug-2012
-  Add bundled Bootstrap assets for HTML test interface
-
-* 0.0.6 - 24-Aug-2012
-  Add Date/Time/DateTime as special string types with regex checks for validation
-
-* 0.0.5 - 19-Jul-2012
-  Add commandline client jsonrpc2
-  Add #auth to access currently authenticated username
-
 ## Features
 
 * Inline documentation
@@ -38,42 +12,44 @@ A Rack compatible, documenting JSON-RPC 2 DSL/server implementation for ruby.
 
 ## Example
 
-    class Calculator < JSONRPC2::Interface
-      title "JSON-RPC2 Calculator"
-      introduction "This interface allows basic maths calculations via JSON-RPC2"
-      auth_with JSONRPC2::BasicAuth.new({'apiuser' => 'secretword'})
+```ruby
+class Calculator < JSONRPC2::Interface
+  title "JSON-RPC2 Calculator"
+  introduction "This interface allows basic maths calculations via JSON-RPC2"
+  auth_with JSONRPC2::BasicAuth.new({'apiuser' => 'secretword'})
+
+  section 'Simple Ops' do
+      desc 'Multiply two numbers'
+      param 'a', 'Number', 'First number'
+      param 'b', 'Number', 'Second number'
+      result 'Number', 'a * b'
+      def mul args
+        args['a'] * args['b']
+      end
 
-      section 'Simple Ops' do
-         desc 'Multiply two numbers'
-         param 'a', 'Number', 'First number'
-         param 'b', 'Number', 'Second number'
-         result 'Number', 'a * b'
-         def mul args
-           args['a'] * args['b']
-         end
-   
-         desc 'Add numbers'
-         param 'a', 'Number', 'First number'
-         param 'b', 'Number', 'Second number'
-         optional 'c', 'Number', 'Third number'
-         example 'Calculate 1 + 1', :params => { 'a' => 1, 'b' => 1}, :result => 2
-         result 'Number', 'a + b + c'
-         def sum args
-           val = args['a'] + args['b']
-           val += args['c'] if args['c']
-           val
-         end
+      desc 'Add numbers'
+      param 'a', 'Number', 'First number'
+      param 'b', 'Number', 'Second number'
+      optional 'c', 'Number', 'Third number'
+      example 'Calculate 1 + 1', :params => { 'a' => 1, 'b' => 1}, :result => 2
+      result 'Number', 'a + b + c'
+      def sum args
+        val = args['a'] + args['b']
+        val += args['c'] if args['c']
+        val
       end
-    end
+  end
+end
+```
 
 To run example:
-
-    $ gem install shotgun # unless it's already installed
-    $ shotgun example/config.ru
+```bash
+$ gem install shotgun # unless it's already installed
+$ shotgun example/config.ru
+```
 
 Browse API and test it via a web browser at http://localhost:9393/
 
-
 ## Inline documentation
 
 Use built in helper methods to declare complex types and function
@@ -174,7 +150,7 @@ e.g.
     title "Calculator interface"
     introduction "Very simple calculator interface"
 
-    section "Entry points" do 
+    section "Entry points" do
       ...
     end
 
@@ -199,4 +175,8 @@ e.g.
 
 > Specify authentication method that should be used to verify the access credentials before printing.  See {JSONRPC2::BasicAuth} for examples/info.
 
+## Development
 
+- Run `bin/setup` to build a local docker image
+- Run `bin/test` to run the test suite
+- Run `bin/run-example` to run the example JSONRPC API from within docker container

data/bin/run-example

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+docker run --rm \
+           --mount type=bind,source="$(pwd)",target=/srv/www \
+           -p 9292:9292 \
+           jsonrpc2 \
+           rackup example/config.ru --host 0.0.0.0

data/bin/setup

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+docker build . -t jsonrpc2

data/bin/test

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+docker run --rm \
+           --mount type=bind,source="$(pwd)",target=/srv/www \
+           -t \
+           jsonrpc2 \
+           bundle exec rspec $@

data/example/config.ru

@@ -2,39 +2,41 @@ $: << File.join(File.dirname(__FILE__),'../lib')
 require 'jsonrpc2/interface'
 require 'rack/logger'
 
+# Example of JSONRPC2 API
+# Start with `bin/run-example`
+# Open localhost:9292 in your browser and have fun!
 class ::Object::Calculator < JSONRPC2::Interface
   title "JSON-RPC2 Calculator"
   introduction "This interface allows basic maths calculations via JSON-RPC2"
   auth_with JSONRPC2::BasicAuth.new({'user' => 'secretword', 'admin' => 'password'})
 
   section 'Simple Ops' do
-      desc 'Multiply two numbers'
-      param 'a', 'Number', 'a'
-      param 'b', 'Number', 'b'
-      result 'Number', 'a * b'
-      def mul
-        raise JSONRPC2::KnownError, [123, "Don't like negative numbers", params] if params['a'] < 0 or params['b'] < 0
-        params['a'] * params['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
-        val = params['a'] + params['b']
-        val += params['c'] if params['c']
-
-        return 42 if auth == 'admin'
-
-        val
-      end
+    desc 'Multiply two numbers'
+    param 'a', 'Number', 'a'
+    param 'b', 'Number', 'b'
+    result 'Number', 'a * b'
+    def mul
+      raise JSONRPC2::KnownError, [123, "Don't like negative numbers", params] if params['a'] < 0 or params['b'] < 0
+      params['a'] * params['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
+      val = params['a'] + params['b']
+      val += params['c'] if params['c']
+
+      return 42 if auth == 'admin'
+
+      val
+    end
   end
 end
 
 use Rack::Logger
 run Calculator
-

data/jsonrpc2.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.description   = <<-EOD
 == Description
 
-A Rack compatible JSON-RPC2 server domain specific language (DSL) - allows JSONRPC APIs to be 
+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.
@@ -43,16 +43,28 @@ e.g.
 
 EOD
   gem.summary       = %q{JSON-RPC2 server DSL}
-  gem.homepage      = "http://github.com/geoffyoungs/jsonrpc2"
+  gem.homepage      = "http://github.com/livelink/jsonrpc2"
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.bindir        = 'exe'
+  gem.executables   = `git ls-files -- exe/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "jsonrpc2"
   gem.require_paths = ["lib"]
   gem.version       = JSONRPC2::VERSION
+  gem.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",
+  }
+
   gem.add_dependency("httpclient")
   gem.add_dependency("json")
   gem.add_dependency("RedCloth")
   gem.add_dependency('thor')
+
+  gem.add_development_dependency('rack') # Makes it possible to test JSONRPC2::Interface
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('puma') # Required to run rackup example/config.ru
+  gem.add_development_dependency('pry-byebug')
 end

data/lib/jsonrpc2/html.rb

@@ -23,7 +23,7 @@ module JSONRPC2
       }
     </style>
 </head>
-<body> 
+<body>
   <div class="navbar navbar-fixed-top">
     <div class="navbar-inner">
       <div class="container">
@@ -101,7 +101,7 @@ EOM
       end
     else
       body = RedCloth.new(interface.to_textile).to_html.gsub(/\<h3\>(.*?)\<\/h3\>/, '<h3><a href="'+request.script_name+'/\1">\1</a></h3>')
-      [200, {'Content-Type' => 'text/html'}, 
+      [200, {'Content-Type' => 'text/html'},
               html5('Interface: '+interface.name.to_s, body, :request => request)]
     end
   end
@@ -172,7 +172,7 @@ EOS
       url = CGI.unescapeHTML(str)[1...-1]
        %Q["<a href="#{CGI.escapeHTML(url)}">#{CGI.escapeHTML(url)}</a>"]
     end
-  rescue Exception => e
+  rescue Exception
     CGI.escapeHTML(result.to_s)
   end
   end