hobby-json 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d7c3bf7ba50a139dc0c243eb7c4363d024a8a614
-  data.tar.gz: 1f71511667ebdb36ef7175c67253cfff4d655d82
+SHA256:
+  metadata.gz: 6681daa3660fe33bc169a0d8ee9eae5ff2b3724d3b8a4f7a9d66f61864eff0c9
+  data.tar.gz: 1d1c83b0529740a02b896bba002ab4c2f47b5c80ec3fe7353ea53dabe2f68e01
 SHA512:
-  metadata.gz: 93b8392838c910474c3c2dcdd6765ea780753842235cefacb5c3140864ab73717eb9ad2fd984adbaa2360df81c6c1c1e01a7eb82925595b9437ee0a77bf86b01
-  data.tar.gz: 4bc44b77be297b77488db23a91f633124a308521f0505d63464835aa12bb2649b55b0c4642ea45c36880b586d5b30097582aaf9f1b98ed9735af64447160bd94
+  metadata.gz: ac541875f2e93d174b2bc2f6be9068522028c130f10ab401e6d8c1a9ec93a5116a1255385218364481aba968783f83784f266f814eae954d6127c9518ae0d7f8
+  data.tar.gz: 02cee90a78e8fa2c19fa1811d7578c7dd1d30721681c10186d15aa61c27e0749c212bcfa6d26a17a9ec6af1d1003d0c85f2f66e508e38d62f04e607a28164814

data/.travis.yml

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

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'hobby-devtools', '>=0.0.5'
+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,8 +1,8 @@
 Gem::Specification.new do |g|
   g.name    = 'hobby-json'
   g.files   = `git ls-files`.split($/)
-  g.version = '0.0.4'
-  g.summary = 'A way to work with JSON in Hobby without too much verbosity.'
+  g.version = '0.0.5'
+  g.summary = 'A Hobby extension for JSON requests and responses.'
   g.authors = ['Anatoly Chernow']
 
   g.add_dependency 'rack'

data/lib/hobby/json.rb

@@ -16,6 +16,7 @@ module Hobby
 
     def json
       @json ||= begin
+                  fail unless env.fetch('CONTENT_TYPE').start_with? 'application/json'
                   ::JSON.parse request.body.read
                 rescue
                   response.status = 400

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/http/bad_request.yml

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

data/spec/http/bad_request_when_json_key_accessed.yml

@@ -1,6 +1,7 @@
 - get:
     path: /access_key
-    body: not very json
+    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

@@ -1,11 +1,15 @@
 - get:
     path: /
+    format: json
     body:
       string: string
       number: 42
+    headers:
+      Content-Type: application/json
 
   response:
     status: 200
+    format: json
     body:
       string: string
       number: 42

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hobby-json
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Anatoly Chernow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -31,12 +31,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
+- LICENSE
 - hobby-json.gemspec
 - lib/hobby/json.rb
+- readme.adoc
 - spec/helper.rb
 - 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: 
@@ -57,9 +61,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.0.3
 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: []