hobby-json 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8c9105de691a61333c00bafcd8e091629efeacd
-  data.tar.gz: f96cc5d2b3a9ff2e4e7d042d25058ea73baf045d
+SHA256:
+  metadata.gz: 04bef8239f05fe122b05e258dbc95febb39e9ce6b2e73df1e721d035af989f95
+  data.tar.gz: 4defa4ae325347cdd8e98a7ee200276df901034b600bcec40bf577646fe6f5f1
 SHA512:
-  metadata.gz: 0c200130a301b2f49b92f418ac046ddd04509ebafc4663bf20ef9a2e4ce3e902e5c83bee7cd9b48955a092d738a226e8b50e32f701e14477929b69baf0e4107b
-  data.tar.gz: c53adad858bee2d592aa1d84e1112b53ab7a3181ed77c8a948bd38206521df5db498e711e28496f5feadb06a21f19910fd4e7b996292d131b216129ca12ddea3
+  metadata.gz: e05c326717b42f847c14146b8de6be799d998b657a9a346d354fa327bee843437638f2365cc8cc91788b71dea85de81ae599992398861c0ee1bd10795d4daabb
+  data.tar.gz: fee3dfd8b473f628e178be95e903e40f91718a662b3242e258370cf649dc9e133bf1794095fa1905e7cf3df34574ec790c5538a0bf7531cfc0b9ccd67c9695ac

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+rvm:
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'hobby-devtools', '>=0.0.11'

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (C) 2017 by Anatoly Chernow <chertoly@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/hobby-json.gemspec

@@ -1,7 +1,9 @@
 Gem::Specification.new do |g|
   g.name    = 'hobby-json'
   g.files   = `git ls-files`.split($/)
-  g.version = '0.0.1'
-  g.summary = 'A way to work with JSON in Hobby without too much verbosity.'
-  g.authors = ['Anatoly Cherno']
+  g.version = '0.0.6'
+  g.summary = 'A Hobby extension for JSON requests and responses.'
+  g.authors = ['Anatoly Chernov']
+
+  g.add_dependency 'hobby', '~> 0.2.2'
 end

data/lib/hobby/json.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'rack'
 
 module Hobby
   module JSON
@@ -14,7 +15,13 @@ module Hobby
     end
 
     def json
-      @json ||= JSON.parse request.body.read
+      @json ||= begin
+                  fail unless env.fetch('CONTENT_TYPE').start_with? 'application/json'
+                  ::JSON.parse request.body.read
+                rescue
+                  response.status = 400
+                  halt
+                end
     end
   end
 end

data/readme.adoc

@@ -0,0 +1,84 @@
+= Hobby-JSON
+
+This repository provides a https://github.com/ch1c0t/hobby[Hobby] extension
+for JSON requests and responses.
+
+== Installation
+
+[source,bash]
+----
+gem install hobby-json
+----
+
+== Introduction
+
+It tries to parse `request.body` as JSON.
+If succeeded, it will store a parsed Ruby object in `json`.
+If `request.body` happened not to have a valid JSON,
+it will halt the request with https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400[400 status code].
+
+A response will be converted to JSON by calling `.to_json` on the latest action object.
+
+Here is an echo service(it returns the same JSON posted by a request):
+
+[source,ruby]
+----
+require 'hobby'
+require 'hobby/json'
+
+class Echo
+  include Hobby
+  include JSON
+
+  post { json }
+end
+----
+
+Another example could be an adding service.
+It expects to get an array of numbers in the `numbers` field, after which it sums them up,
+and returns the result in the `result` field.
+
+[source,ruby]
+----
+require 'hobby'
+require 'hobby/json'
+
+class Adder
+  include Hobby
+  include JSON
+
+  post do
+    { result: json['numbers'].sum }
+  end
+end
+----
+
+You can put this in `config.ru`:
+
+[source,ruby]
+----
+run Adder.new
+----
+
+and run it with `rackup`. Then, the service can be accessed like so:
+
+[source,bash]
+----
+➜  ~ curl -H "Content-Type: application/json" -X POST -d '{"numbers":[1,2,3]}' http://localhost:9292
+{"result":6}%
+----
+
+== Development
+
+To run the specs:
+
+[source,bash]
+----
+bundle exec rspec
+----
+
+To perform mutation analysis:
+[source,bash]
+----
+bundle exec mutant --use rspec 'Hobby::JSON*' --include lib --require hobby/json
+----

data/spec/helper.rb

@@ -0,0 +1,3 @@
+require 'hobby'
+require 'hobby/json'
+require 'hobby/devtools/rspec_helper'

data/spec/http/access_key.yml

@@ -0,0 +1,14 @@
+- get:
+    path: /access_key
+    format: json
+    body:
+      key: some string
+    headers:
+      Content-Type: application/json
+
+  response:
+    status: 200
+    format: json
+    body: some string
+    headers.>:
+      Content-Type: application/json

data/spec/http/bad_request.yml

@@ -0,0 +1,7 @@
+- get:
+    path: /
+    format: text
+    body: just plain text, not json
+
+  response:
+    status: 400

data/spec/http/bad_request_when_json_key_accessed.yml

@@ -0,0 +1,7 @@
+- get:
+    path: /access_key
+    format: text
+    body: just plain text, not json
+
+  response:
+    status: 400

data/spec/http/bad_request_when_wrong_content_type.yml

@@ -0,0 +1,10 @@
+- get:
+    path: /
+    format: json
+    body:
+      valid: json
+    headers:
+      Content-Type: text/plain
+
+  response:
+    status: 400

data/spec/http/echo.yml

@@ -0,0 +1,17 @@
+- get:
+    path: /
+    format: json
+    body:
+      string: string
+      number: 42
+    headers:
+      Content-Type: application/json
+
+  response:
+    status: 200
+    format: json
+    body:
+      string: string
+      number: 42
+    headers.>:
+      Content-Type: application/json

data/spec/http_spec.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+Hobby::Devtools::RSpec.describe do
+  app do
+    Class.new do
+      include Hobby
+      include Hobby::JSON
+      get { json }
+      get('/access_key') { json['key'] }
+    end.new
+  end
+end

metadata

@@ -1,23 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: hobby-json
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
-- Anatoly Cherno
+- Anatoly Chernov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-11 00:00:00.000000000 Z
-dependencies: []
+date: 2021-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hobby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
 description: 
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
 - hobby-json.gemspec
 - lib/hobby/json.rb
+- readme.adoc
+- spec/helper.rb
+- spec/http/access_key.yml
+- spec/http/bad_request.yml
+- spec/http/bad_request_when_json_key_accessed.yml
+- spec/http/bad_request_when_wrong_content_type.yml
+- spec/http/echo.yml
+- spec/http_spec.rb
 homepage: 
 licenses: []
 metadata: {}
@@ -36,9 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: A way to work with JSON in Hobby without too much verbosity.
+summary: A Hobby extension for JSON requests and responses.
 test_files: []