satz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef06f388d1b3113f7d709320b4ea4606e5fc9c8c
+  data.tar.gz: af63d424f6e74e95418804514075f72886777af5
+SHA512:
+  metadata.gz: 8ef33ff001e893d12588c6fbf6f5825434c7cf8599f14db51ddf12b807e95ccb0e6731f9ff4241a80e6b587e6bec31ec827c3f4ddd919fb853eef807317deccc
+  data.tar.gz: 4a1df71be2425e688e51ed96dafb3d0a8d1d3be929f8f5c2917e8a7788382942d4c1018b5b1e7846f3d933179c98f6eec6df42a58a24a744598b555c8675dd90

data/.gems

@@ -0,0 +1,2 @@
+syro -v 2.0.0
+rack-test -v 0.6.3

data/CHANGELOG

@@ -0,0 +1 @@
+

data/CONTRIBUTING

@@ -0,0 +1,19 @@
+This code tries to solve a particular problem with a very simple
+implementation. We try to keep the code to a minimum while making
+it as clear as possible. The design is very likely finished, and
+if some feature is missing it is possible that it was left out on
+purpose. That said, new usage patterns may arise, and when that
+happens we are ready to adapt if necessary.
+
+A good first step for contributing is to meet us on IRC and discuss
+ideas. We spend a lot of time on #lesscode at freenode, always ready
+to talk about code and simplicity. If connecting to IRC is not an
+option, you can create an issue explaining the proposed change and
+a use case. We pay a lot of attention to use cases, because our
+goal is to keep the code base simple. Usually the result of a
+conversation is the creation of a different tool.
+
+Please don't start the conversation with a pull request. The code
+should come at last, and even though it may help to convey an idea,
+more often than not it draws the attention to a particular
+implementation.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Michel Martens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+Satz
+====
+
+Framework for JSON microservices
+
+Description
+-----------
+
+Satz is a framework for writing microservices that serve and read
+JSON. It uses [Syro][syro] for routing requests. Check the [Syro
+tutorial][tutorial] to learn more about how the routing works.
+
+[syro]: http://soveran.github.io/syro/
+[tutorial]: http://files.soveran.com/syro/
+
+Usage
+-----
+
+An example of a Satz application would look like this:
+
+```ruby
+App = Satz.new do
+  on "players" do
+    on :player_id do
+      get do
+        @player = Player[inbox[:player_id]]
+
+        reply @player
+      end
+    end
+
+    get do
+      reply Player.all.to_a
+    end
+
+    post do
+      @player = Player.new(read)
+
+      on @player.valid? do
+        @player.create
+
+        reply @player
+      end
+
+      default do
+        reply @player.errors
+      end
+    end
+  end
+end
+```
+
+The argument to `reply` is served as JSON by calling `JSON.dump(arg)`.
+In user defined objects, you can define the method `to_json` according
+to your needs. Most ORMs already provide meaningful definitions for
+that method.
+
+API
+---
+
+Apart from [Syro][syro]'s API, the following methods are available:
+
+`read`: Reads the body of the requst and parses it as JSON.
+
+`reply`: Writes to the response its argument encoded as JSON.
+
+```
+$ gem install satz
+```

data/lib/satz.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2015 Michel Martens
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require "syro"
+require "json"
+
+class Satz
+  class Deck < Syro::Deck
+
+    # Respond by default with JSON.
+    def default_headers
+      { "Content-Type" => "application/json" }
+    end
+
+    # Read JSON data from the POST request.
+    def read
+      body = req.body.read
+      body && JSON.parse(body)
+    end
+
+    # Write JSON data to the response.
+    def reply(data)
+      res.write(JSON.dump(data))
+    end
+  end
+
+  def self.define(&code)
+    Syro.new(Deck, &code)
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest -r ./test/helper.rb ./test/*.rb

data/satz.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name              = "satz"
+  s.version           = "0.0.1"
+  s.summary           = "Framework for JSON microservices"
+  s.description       = "Framework for JSON microservices"
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "https://github.com/soveran/satz"
+  s.license           = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "syro", "~> 2.0"
+  s.add_development_dependency "cutest"
+  s.add_development_dependency "rack-test"
+end

data/test/all.rb

@@ -0,0 +1,29 @@
+App = Satz.define do
+  get do
+    reply(true)
+  end
+
+  post do
+    reply(read)
+  end
+end
+
+setup do
+  Driver.new(App)
+end
+
+test "get" do |app|
+  app.get("/")
+
+  assert_equal 200, app.last_response.status
+  assert_equal %Q(true), app.last_response.body
+end
+
+test "post" do |app|
+  data = { "foo" => "bar" }.to_json
+
+  app.post("/", data)
+
+  assert_equal data, app.last_response.body
+  assert_equal 200, app.last_response.status
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+require_relative "../lib/satz"
+require "rack/test"
+
+class Driver
+  include Rack::Test::Methods
+
+  def initialize(app)
+    @app = app
+  end
+
+  def app
+    @app
+  end
+end
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: satz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: syro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  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: rack-test
+  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: Framework for JSON microservices
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- CHANGELOG
+- CONTRIBUTING
+- LICENSE
+- README.md
+- lib/satz.rb
+- makefile
+- satz.gemspec
+- test/all.rb
+- test/helper.rb
+homepage: https://github.com/soveran/satz
+licenses:
+- MIT
+metadata: {}
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Framework for JSON microservices
+test_files: []