easy-jsonapi 1.0.1 → 1.0.2

data/.rubocop.yml

@@ -1,6 +1,6 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: '2.7.0'
+  TargetRubyVersion: '3.0.0'
   SuggestExtensions: false
 
 Metrics/AbcSize:
@@ -61,4 +61,4 @@ Metrics/ModuleLength:
   Enabled: false
 
 Layout/ArgumentAlignment:
-  Enabled: false
+  Enabled: false

data/CHANGELOG.md

@@ -1,10 +1,11 @@
 # CHANGELOG
 
-## 1.0.1 - 2020-03-25
+## 1.0.2 - 2020-03-25
 
 - Updated README and fix READE broken links
 - Reorganization of README files into docs file.
 - Make easy-jsonapi compatible with ruby versions >= 2.5
+- Added wrapper around Oj usage so all raised errors are found in the JSONAPI::Exceptions module
 
 ## 1.0.0 - 2020-03-24
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy-jsonapi (1.0.0)
+    easy-jsonapi (1.0.2)
       oj (~> 3.10)
 
 GEM
@@ -20,9 +20,9 @@ GEM
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    mini_portile2 (2.5.0)
-    nokogiri (1.11.2)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.11.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.11.2-x86_64-linux)
       racc (~> 1.4)
     oj (3.11.3)
     parallel (1.20.1)
@@ -50,7 +50,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.11.0)
+    rubocop (1.12.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -82,13 +82,14 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    thor (1.0.1)
+    thor (1.1.0)
     tilt (2.0.10)
     unicode-display_width (2.0.0)
     yard (0.9.26)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   codecov (~> 0.4)

data/README.md

@@ -9,7 +9,7 @@
 ![](https://ruby-gem-downloads-badge.herokuapp.com/easy-jsonapi?type=total&color=brightgreen)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
 [![License](https://img.shields.io/github/license/Curatess/easy-jsonapi)](https://img.shields.io)
-<!-- [![Build Status](https://secure.travis-ci.org/ -->
+[![Build Status](https://img.shields.io/codecov/c/github/curatess/easy-jsonapi)](https://img.shields.io/codecov/c/github/curatess/easy-jsonapi)
 
 The gem that makes using [JSON:API](https://jsonapi.org/) ***EASY***!
 
@@ -128,7 +128,7 @@ When the middleware is in development mode it will raise an exception wherever i
 
 The types of exceptions it will raise are:
 
-- `Oj::ParserError` when an included body is not valid JSON
+- `JSONAPI::Exceptions::JSONParseError` when an included body is not valid JSON
 - `JSONAPI::Exceptions::HeaderExceptions::InvalidHeader` when an included header is non-compliant
 - `JSONAPI::Exceptions::QueryParamExceptions::InvalidQueryParam` when an included query parameter is non-compliant
 - `JSONAPI::Exceptions::DocumentExceptions::InvalidDocument` when the body is included and non-compliant

data/easy-jsonapi.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'easy-jsonapi'
-  spec.version       = '1.0.1'
+  spec.version       = '1.0.2'
   spec.authors       = ['Joshua DeMoss, Joe Viscomi']
   spec.email         = ['demoss.joshua@gmail.com']
 

data/lib/easy/jsonapi/exceptions.rb

@@ -4,6 +4,8 @@ require 'easy/jsonapi/exceptions/document_exceptions'
 require 'easy/jsonapi/exceptions/headers_exceptions'
 require 'easy/jsonapi/exceptions/naming_exceptions'
 require 'easy/jsonapi/exceptions/query_params_exceptions'
+require 'easy/jsonapi/exceptions/user_defined_exceptions'
+require 'easy/jsonapi/exceptions/json_parse_error'
 
 module JSONAPI
   # Namespace for the gem's Exceptions
@@ -23,5 +25,9 @@ module JSONAPI
     # Checking for JSONAPI naming rules compliance
     module NamingExceptions
     end
+
+    # Checking for User Defined Exceptions
+    module UserDefinedExceptions
+    end
   end
 end

data/lib/easy/jsonapi/exceptions/document_exceptions.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'easy/jsonapi/parser/json_parser'
 require 'easy/jsonapi/exceptions/naming_exceptions'
 require 'easy/jsonapi/exceptions/user_defined_exceptions'
 
@@ -57,7 +58,7 @@ module JSONAPI
       # @param opts [Hash] Includes path, http_method, sparse_fieldsets
       # @raise InvalidDocument if any part of the spec is not observed
       def self.check_compliance(document, config_manager = nil, opts = {})
-        document = Oj.load(document, symbol_keys: true) if document.is_a? String
+        document = JSONAPI::Parser::JSONParser.parse(document) if document.is_a? String
         ensure!(!document.nil?, 'A document cannot be nil')
         
         check_essentials(document, opts[:http_method])

data/lib/easy/jsonapi/exceptions/json_parse_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module Exceptions
+
+    # Error to raise when error found while parsing json
+    class JSONParseError < StandardError
+    end
+  end
+end

data/lib/easy/jsonapi/middleware.rb

@@ -2,7 +2,7 @@
 
 require 'easy/jsonapi/exceptions'
 require 'easy/jsonapi/config_manager'
-require 'oj'
+require 'easy/jsonapi/parser/json_parser'
 
 module JSONAPI
 
@@ -137,7 +137,7 @@ module JSONAPI
       raise if environment_development?(env)
 
       [e.status_code, {}, []]
-    rescue Oj::ParseError
+    rescue JSONAPI::Exceptions::JSONParseError
       raise if environment_development?(env)
 
       [400, {}, []]

data/lib/easy/jsonapi/parser/document_parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'easy/jsonapi/document'
-require 'oj'
+require 'easy/jsonapi/parser/json_parser'
 
 module JSONAPI
   module Parser
@@ -16,7 +16,7 @@ module JSONAPI
       # @raise [JSONAPI::Parser::InvalidDocument] if document is invalid.
       def self.parse(req_body)
         return if req_body.nil?
-        document_hash = Oj.load(req_body, symbol_keys: true) # parse json string into hash
+        document_hash = JSONAPI::Parser::JSONParser.parse(req_body) # parse json string into hash
         parse_hash(document_hash)
       end
 

data/lib/easy/jsonapi/parser/json_parser.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'oj'
+require 'easy/jsonapi/exceptions/json_parse_error'
+
+module JSONAPI
+  module Parser
+    # A wrapper class for OJ parser
+    module JSONParser
+
+      # Parse JSON string into a ruby hash
+      # @param document [String] The JSON string to parse
+      # @raise [JSONAPI::Exceptions::JSONParseError]
+      def self.parse(document, symbol_keys: true)
+        Oj.load(document, symbol_keys: symbol_keys)
+        
+      rescue Oj::ParseError => e
+        raise JSONAPI::Exceptions::JSONParseError, e.message
+      end
+
+      # Convert ruby hash into JSON
+      # @param ruby_hash [Hash] THe hash to convert into JSON
+      def self.dump(ruby_hash)
+        Oj.dump(ruby_hash)
+      end
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy-jsonapi
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Joshua DeMoss, Joe Viscomi
@@ -132,7 +132,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".dockerignore"
-- ".github/workflows/publish-gem.yml"
+- ".github/workflows/codecov.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rspec_status"
@@ -197,6 +198,7 @@ files:
 - lib/easy/jsonapi/exceptions.rb
 - lib/easy/jsonapi/exceptions/document_exceptions.rb
 - lib/easy/jsonapi/exceptions/headers_exceptions.rb
+- lib/easy/jsonapi/exceptions/json_parse_error.rb
 - lib/easy/jsonapi/exceptions/naming_exceptions.rb
 - lib/easy/jsonapi/exceptions/query_params_exceptions.rb
 - lib/easy/jsonapi/exceptions/user_defined_exceptions.rb
@@ -210,6 +212,7 @@ files:
 - lib/easy/jsonapi/parser.rb
 - lib/easy/jsonapi/parser/document_parser.rb
 - lib/easy/jsonapi/parser/headers_parser.rb
+- lib/easy/jsonapi/parser/json_parser.rb
 - lib/easy/jsonapi/parser/rack_req_params_parser.rb
 - lib/easy/jsonapi/request.rb
 - lib/easy/jsonapi/request/query_param_collection.rb

data/.github/workflows/publish-gem.yml

@@ -1,74 +0,0 @@
-name: Test Build and Publish
-on:
-  push:
-    branches: [ production ]
-  pull_request:
-    branches: [ production ]
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.5', '2.6', '2.7', '3.0']
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake
-  build_and_publish:
-    name: Build + Publish + Release
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 3.0
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 3.0.x
-    - name: Publish to GPR
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-      env:
-        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
-        OWNER: ${{ github.repository_owner }}
-    
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
-  release:
-    name: Create Release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
-          body: |
-            Changes in this Release
-            - First Change
-            - Second Change
-          draft: false
-          prerelease: false