coin_rack 0.0.3

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gem "rack"
+gem "coin"
+gem "footing", ">=0.1.5"
+gem "rack-abstract-format", :require => "rack/abstract_format"
+gem "rack-accept-media-types", :require => "rack/accept_media_types"
+gem "builder"
+gem "activesupport", :require => "active_support/all"
+
+group :development do
+  gem "pry"
+  gem "pry-stack_explorer"
+  gem "micro_test"
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    binding_of_caller (0.6.8)
+    builder (3.1.4)
+    coderay (1.0.8)
+    coin (0.1.2)
+    footing (0.1.5)
+    i18n (0.6.1)
+    method_source (0.8.1)
+    micro_test (0.3.1)
+      os
+    multi_json (1.4.0)
+    os (0.9.6)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    pry (0.9.10-java)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+      spoon (~> 0.0)
+    pry-stack_explorer (0.4.7)
+      binding_of_caller (~> 0.6.8)
+    rack (1.4.1)
+    rack-abstract-format (0.9.9)
+    rack-accept-media-types (0.9)
+    slop (3.3.3)
+    spoon (0.0.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activesupport
+  builder
+  coin
+  footing (>= 0.1.5)
+  micro_test
+  pry
+  pry-stack_explorer
+  rack
+  rack-abstract-format
+  rack-accept-media-types

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nathan Hopkins
+
+MIT License
+
+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,126 @@
+# CoinRack
+
+A simple [Rack](http://rack.github.com/) application that provides a
+REST interface to [Coin's API](https://github.com/hopsoft/coin).
+
+## Quick Start
+
+### Run the server
+
+```bash
+$ gem install coin_rack
+$ coin_rack --run
+```
+
+### Make some client requests
+
+```bash
+$ curl --data "value=true" http://localhost:9292/example.json
+# => {"example":true}
+
+$ curl http://localhost:9292/example.json
+# => {"example":true}
+
+$ curl -X DELETE http://localhost:9292/example.json
+# => {"example":null}
+
+$ curl http://localhost:9292/example.json
+# => {"example":null}
+```
+
+#### Prefer XML?
+```bash
+$ curl --data "value=true" http://localhost:9292/example.xml
+# <?xml version="1.0" encoding="UTF-8"?>
+# <hash>
+#   <example type="boolean">true</example>
+# </hash>
+
+$ curl http://localhost:9292/example.xml
+# <?xml version="1.0" encoding="UTF-8"?>
+# <hash>
+#   <example type="boolean">true</example>
+# </hash>
+
+$ curl -X DELETE http://localhost:9292/example.xml
+# <?xml version="1.0" encoding="UTF-8"?>
+# <hash>
+#   <example nil="true"/>
+# </hash>
+
+$ curl http://localhost:9292/example.xml
+# <?xml version="1.0" encoding="UTF-8"?>
+# <hash>
+#   <example nil="true"/>
+# </hash>
+```
+
+## URL Definition
+
+```
+                  cache key
+                       |
+http://localhost:9292/KEY.FORMAT
+                            |
+                    response format
+```
+
+*Note: The XML format is also supported but XML examples have been omitted for brevity.*
+
+## POST/PUT
+
+Create and/or update the key to a new value.
+
+#### Params
+
+* **value** - the value to assign
+
+#### Request URI
+
+```
+http://localhost:9292/example.json
+```
+
+#### Request Body
+
+```
+value=true
+```
+
+#### Response
+
+```
+"{\"example\":\"true\"}"
+```
+
+## GET
+
+Get the current value for the specified key.
+
+#### Request URI
+
+```
+http://localhost:9292/example.json
+```
+
+#### Response
+
+```
+"{\"example\":\"true\"}"
+```
+
+## DELETE
+
+Deletes the key.
+
+#### Request URI
+
+```
+http://localhost:9292/example.json
+```
+
+#### Response
+
+```
+"{\"example\":null}"
+```

data/bin/coin_rack

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby --
+require "optparse"
+
+# setup the options -----------------------------------------------------------
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = "CoinRack Usage: coin_rack [options]"
+
+  desc = "Prints the location of the rackup file."
+  opts.on("-p", "--print", desc) { |value| options[:print] = value }
+
+  desc = "Starts the Rack server."
+  opts.on("-r", "--run", desc) { |value| options[:run] = value }
+
+  opts.on_tail("-h", "--help", "Show this message.") do
+    puts opts
+    exit
+  end
+end
+parser.parse!
+
+if options.values.compact.empty?
+  puts parser.banner
+  puts parser.summarize
+  exit
+end
+
+path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+rackup_file = File.join(path, "config.ru")
+
+if options[:print]
+  puts rackup_file
+  exit
+end
+
+if options[:run]
+  exec "cd #{path} && rackup"
+  exit
+end

data/config.ru

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), "lib", "coin_rack")
+
+use Rack::Static
+use Rack::AbstractFormat
+run CoinRack.new

data/lib/coin_rack.rb

@@ -0,0 +1,92 @@
+require "bundler"
+Bundler.require
+require File.join(File.dirname(__FILE__), "coin_rack", "version")
+
+Footing.patch! String, Footing::String
+Footing.patch! Array, Footing::Array
+Footing.patch! Hash, Footing::Hash
+
+class CoinRack
+
+  def call(env)
+    begin
+      request = Rack::Request.new(env)
+      request.POST.cast_values!
+      return favicon if request.path == "/favicon.ico"
+      return get(request) if request.get?
+      return post(request) if request.post?
+      return put(request) if request.put?
+      return delete(request) if request.delete?
+    rescue Exception => ex
+      [500, {"Content-Type" => "text/html"}, ["ERROR: #{ex}"]]
+    end
+
+    [400, {"Content-Type" => "text/html"}, ["BAD REQUEST"]]
+  end
+
+  protected
+
+  def key(request)
+    request.path.gsub(/\A\//, "")
+  end
+
+  def format(request)
+    case request.accept_media_types.prefered
+    when "application/json" then :json
+    when "application/xml" then :xml
+    else :unknown
+    end
+  end
+
+  # CREATE
+  def post(request)
+    put(request)
+  end
+
+  # READ
+  def get(request)
+    k = key(request)
+    f = format(request)
+    result = {}
+    result[k] = Coin.read(k)
+    send f, result
+  end
+
+  # UPDATE
+  def put(request)
+    k = key(request)
+    f = format(request)
+    value = request.POST["value"]
+    Coin.write k, value
+    result = {}
+    result[k] = value
+    send f, result
+  end
+
+  # DELETE
+  def delete(request)
+    k = key(request)
+    f = format(request)
+    Coin.delete k
+    result = {}
+    result[k] = nil
+    send f, result
+  end
+
+  def json(result)
+    [200, {"Content-Type" => "text/json"}, [result.to_json]]
+  end
+
+  def xml(result)
+    [200, {"Content-Type" => "text/xml"}, [result.to_xml]]
+  end
+
+  def unknown
+    [400, {"Content-Type" => "text/html"}, ["UNKNOWN FORMAT"]]
+  end
+
+  def favicon
+    [200, { "Content-Type" => "test/plain" }, ["about:blank"]]
+  end
+
+end

data/lib/coin_rack/version.rb

@@ -0,0 +1,3 @@
+class CoinRack
+  VERSION = "0.0.3"
+end

data/test/coin_rack_test.rb

@@ -0,0 +1,219 @@
+require "net/http"
+require "net/telnet"
+require "uri"
+require "json"
+require "rexml/document"
+require "bundler"
+Bundler.require :default, :development
+
+class CoinRackTest < MicroTest::Test
+
+  before do
+    @path = File.join(File.dirname(__FILE__), "..", "config.ru")
+    @pid = spawn({}, "rackup #{@path}")
+
+    # wait for the server to come up
+    sleep 0.1
+    t = nil
+    begin
+      t = Net::Telnet.new "Host" => "localhost", "Port" => 9292
+    rescue Exception => ex
+    end
+    while t.nil?
+      begin
+        t = Net::Telnet.new "Host" => "localhost", "Port" => 9292
+      rescue Exception => ex
+        sleep 0.1
+      end
+    end
+
+    @uri = URI.parse("http://localhost:9292")
+  end
+
+  after do
+    Coin.stop_server
+    Process.kill(9, @pid)
+  end
+
+  test "GET JSON data" do
+    Coin.write "example", "value"
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Get.new("/example.json")
+    response = http.request(request)
+    data = JSON.parse(response.body)
+    assert response.header["Content-Type"] == "text/json"
+    assert response.code == "200"
+    assert response.body == "{\"example\":\"value\"}"
+    assert data["example"] == "value"
+  end
+
+  test "GET complex JSON data" do
+    Coin.write "example", {
+      "value1" => true,
+      "value2" => [1, 2, 3],
+      "nested" => {
+        "value1" => false,
+        "value2" => [4, 5, 6]
+      }
+    }
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Get.new("/example.json")
+    response = http.request(request)
+    assert response.header["Content-Type"] == "text/json"
+    assert response.code == "200"
+    assert response.body == "{\"example\":{\"value1\":true,\"value2\":[1,2,3],\"nested\":{\"value1\":false,\"value2\":[4,5,6]}}}"
+    assert JSON.parse(response.body)
+  end
+
+  test "GET XML data" do
+    Coin.write "example", "value"
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Get.new("/example.xml")
+    response = http.request(request)
+    assert response.header["Content-Type"] == "text/xml"
+    assert response.code == "200"
+    assert response.body == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <example>value</example>\n</hash>\n"
+    assert REXML::Document.new(response.body)
+  end
+
+  test "GET complex XML data" do
+    Coin.write "example", {
+      "value1" => true,
+      "value2" => [1, 2, 3],
+      "nested" => {
+        "value1" => false,
+        "value2" => [4, 5, 6]
+      }
+    }
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Get.new("/example.xml")
+    response = http.request(request)
+    assert response.header["Content-Type"] == "text/xml"
+    assert response.code == "200"
+    assert response.body == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <example>\n    <value1 type=\"boolean\">true</value1>\n    <value2 type=\"array\">\n      <value2 type=\"integer\">1</value2>\n      <value2 type=\"integer\">2</value2>\n      <value2 type=\"integer\">3</value2>\n    </value2>\n    <nested>\n      <value1 type=\"boolean\">false</value1>\n      <value2 type=\"array\">\n        <value2 type=\"integer\">4</value2>\n        <value2 type=\"integer\">5</value2>\n        <value2 type=\"integer\">6</value2>\n      </value2>\n    </nested>\n  </example>\n</hash>\n"
+    assert REXML::Document.new(response.body)
+  end
+
+  test "POST returning JSON" do
+    example = {
+      "value" => {
+        "value1" => true,
+        "value2" => [1, 2, 3],
+        "nested" => {
+          "value1" => false,
+          "value2" => [4, 5, 6]
+        }
+      }
+    }
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Post.new("/example.json")
+    request.body = example.to_param
+    response = http.request(request)
+    assert response.header["Content-Type"] == "text/json"
+    assert response.code == "200"
+    assert response.body == "{\"example\":{\"nested\":{\"value1\":false,\"value2\":[4,5,6]},\"value1\":true,\"value2\":[1,2,3]}}"
+    assert JSON.parse(response.body)
+    cached = Coin.read("example")
+    assert (cached.keys - example["value"].keys).empty?
+    assert (cached.values - example["value"].values).empty?
+  end
+
+  test "POST returning XML" do
+    example = {
+      "value" => {
+        "value1" => true,
+        "value2" => [1, 2, 3],
+        "nested" => {
+          "value1" => false,
+          "value2" => [4, 5, 6]
+        }
+      }
+    }
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Post.new("/example.xml")
+    request.body = example.to_param
+    response = http.request(request)
+    assert response.header["Content-Type"] == "text/xml"
+    assert response.code == "200"
+    assert response.body == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <example>\n    <nested>\n      <value1 type=\"boolean\">false</value1>\n      <value2 type=\"array\">\n        <value2 type=\"integer\">4</value2>\n        <value2 type=\"integer\">5</value2>\n        <value2 type=\"integer\">6</value2>\n      </value2>\n    </nested>\n    <value1 type=\"boolean\">true</value1>\n    <value2 type=\"array\">\n      <value2 type=\"integer\">1</value2>\n      <value2 type=\"integer\">2</value2>\n      <value2 type=\"integer\">3</value2>\n    </value2>\n  </example>\n</hash>\n"
+    assert REXML::Document.new(response.body)
+    cached = Coin.read("example")
+    assert (cached.keys - example["value"].keys).empty?
+    assert (cached.values - example["value"].values).empty?
+  end
+
+  test "PUT returning JSON" do
+    example = {
+      "value" => {
+        "value1" => true,
+        "value2" => [1, 2, 3],
+        "nested" => {
+          "value1" => false,
+          "value2" => [4, 5, 6]
+        }
+      }
+    }
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Put.new("/example.json")
+    request.body = example.to_param
+    response = http.request(request)
+    assert response.header["Content-Type"] == "text/json"
+    assert response.code == "200"
+    assert response.body == "{\"example\":{\"nested\":{\"value1\":false,\"value2\":[4,5,6]},\"value1\":true,\"value2\":[1,2,3]}}"
+    assert JSON.parse(response.body)
+    cached = Coin.read("example")
+    assert (cached.keys - example["value"].keys).empty?
+    assert (cached.values - example["value"].values).empty?
+  end
+
+  test "PUT returning XML" do
+    example = {
+      "value" => {
+        "value1" => true,
+        "value2" => [1, 2, 3],
+        "nested" => {
+          "value1" => false,
+          "value2" => [4, 5, 6]
+        }
+      }
+    }
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Put.new("/example.xml")
+    request.body = example.to_param
+    response = http.request(request)
+    assert response.header["Content-Type"] == "text/xml"
+    assert response.code == "200"
+    assert response.body == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <example>\n    <nested>\n      <value1 type=\"boolean\">false</value1>\n      <value2 type=\"array\">\n        <value2 type=\"integer\">4</value2>\n        <value2 type=\"integer\">5</value2>\n        <value2 type=\"integer\">6</value2>\n      </value2>\n    </nested>\n    <value1 type=\"boolean\">true</value1>\n    <value2 type=\"array\">\n      <value2 type=\"integer\">1</value2>\n      <value2 type=\"integer\">2</value2>\n      <value2 type=\"integer\">3</value2>\n    </value2>\n  </example>\n</hash>\n"
+    assert REXML::Document.new(response.body)
+    cached = Coin.read("example")
+    assert (cached.keys - example["value"].keys).empty?
+    assert (cached.values - example["value"].values).empty?
+  end
+
+  test "DELETE returning JSON" do
+    Coin.write "example", "value"
+    assert Coin.read("example") == "value"
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Delete.new("/example.json")
+    response = http.request(request)
+    data = JSON.parse(response.body)
+    assert response.header["Content-Type"] == "text/json"
+    assert response.code == "200"
+    assert response.body == "{\"example\":null}"
+    assert Coin.read("example").nil?
+  end
+
+  test "DELETE returning XML" do
+    Coin.write "example", "value"
+    assert Coin.read("example") == "value"
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    request = Net::HTTP::Delete.new("/example.xml")
+    response = http.request(request)
+    assert response.header["Content-Type"] == "text/xml"
+    assert response.code == "200"
+    assert response.body == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <example nil=\"true\"/>\n</hash>\n"
+    assert REXML::Document.new(response.body)
+    assert Coin.read("example").nil?
+  end
+
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: coin_rack
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Hopkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: footing
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-abstract-format
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-accept-media-types
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- natehop@gmail.com
+executables:
+- coin_rack
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/coin_rack/version.rb
+- lib/coin_rack.rb
+- bin/coin_rack
+- test/coin_rack_test.rb
+- config.ru
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+homepage: https://github.com/hopsoft/coin_rack
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Simple Rack application that provides a REST interface for Coin.
+test_files: []
+has_rdoc: