redsquare 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e01942bde738c4203eeae03cc1e61c3a8a423c4
-  data.tar.gz: 655f6d5f299cf87753e7045d061a820c93474c9d
+  metadata.gz: dbc88f827c0b6a085537558c2a5ad96084fe1999
+  data.tar.gz: 92409c95a47bd14731bbf08aaaf5f7de4c70289c
 SHA512:
-  metadata.gz: 0bdea34c85ecf6be10c97fee60fb659ff8dba8ec2b6f3734a3ca16e3be30c2d2b674a765b6b03b125ce25a08fc7540df21e5a6c21ed9c2e9602ace0427ccd342
-  data.tar.gz: e166d7f76a00d41c721b15dcb7426daffc364dd5016bf404014fc33e4cab7097ea3f27c0899108b83d15b177b9fe1110592f50c73e3e816523e71fcace252a59
+  metadata.gz: 03465cef0c7afead904f05e843824e1f412905ef3e3f8667a3743506e86b3b041c01b8eed37232833929f7b0182f5687df035c85e81661dcb8f7b832ea8bf870
+  data.tar.gz: 792e2aca3fcb850ddb611dab6eca700a07eb9077c4189d6d19b09a23bb4cde4ce7c1f55868c402e9ba3a2253b7747e6b95731754df67810678038025be161d79

data/README.md

@@ -1,6 +1,7 @@
 # Redsquare
 
-TODO: Write a gem description
+Redsquare provides an HTTP interface for Redis that can be launched as a
+standalone Sinatra app or mounted within a Rails application.
 
 ## Installation
 
@@ -16,9 +17,195 @@ Or install it yourself as:
 
     $ gem install redsquare
 
+## Setup
+
+### Configuration
+
+Redsquare config begins and ends with setting a connection to the Redis
+instance you want to use.  If you specify none, then you'll get a
+connection to localhost on the default Redis port.  If you want to
+specify a connection, use the following:
+
+```ruby
+Redsquare.configure do |config|
+
+  # set it to an existing connection
+  config.redis = Redis.current
+
+  # pass a config hash that will be passed to Redis.new
+  config.redis = { :host => 'localhost', :port => 6379 }
+
+end
+```
+
+### Standalone Server
+
+Simply run Redsquare from the command line.
+
+```
+redsquare
+
+redsquare ~/some/path/to/redsquare_config.rb
+```
+
+### Mounting Within a Rails App
+
+In your `routes.rb` file simplye mount the `Redsquare::App` module.
+
+```ruby
+YourApp::Application.routes.draw do
+  mount Redsquare::App => "/redis"
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+Using Redsquare is very simple.  Commands are divided into two
+categories, those you issue with an HTTP POST call and those you issue
+with an HTTP GET call.  The examples below will be in JavaScript but you
+can easily call Redsquare endpoints form anywhere.
+
+### GET Commands
+
+The following are the Redis commands which Redsquare knows about that
+can be called with a GET request:
+
+```
+dbsize
+exists
+get
+getbit
+getrange
+hexists
+hget
+hgetall
+hkeys
+hlen
+hmget
+hvals
+keys
+lindex
+llen
+lrange
+mget
+pttl
+randomkey
+scard
+sdiff
+sinter
+sismember
+smembers
+srandmember
+sunion
+```
+
+The URL format for GET commands is straightforward:
+
+```
+GET /<command>/<arg1>/<arg2>/<arg...>
+```
+
+Some examples:
+
+```
+GET /get/somekey
+GET /keys
+GET /hget/somekey/somefield
+```
+
+The return value is a simple JSON object:
+
+```javascript
+// GET /get/somekey
+{ result: "foo" }
+
+// GET /keys
+{ result: ["somekey", "someotherkey"]
+
+// GET /hget/somekey/somefield
+{ result: "baz" }
+```
+
+### POST Commands
+
+The following are the Redis commands which Redsquare knows about that
+can be called with a POST request:
+
+```
+sunionstore
+srem
+spop
+smove
+setrange
+setnx
+setbit
+set
+sdiffstore
+sadd
+rpush
+rpoplpush
+rpop
+renamex
+rename
+psetex
+pexpireat
+pexpire
+persist
+msetnx
+mset
+ltrim
+lset
+lrem
+lpushx
+lpush
+lpop
+linsert
+incrbyfloat
+incrby
+incr
+hsetnx
+hset
+hmset
+hincrbyfloat
+hincrby
+hdel
+getset
+expireat
+expire
+del
+decrby
+decr
+append
+```
+
+Because these are POST commands and the arguments may be more complex
+types than simple strings the semantics of the request are slightly
+different.  Each URL follows the same format:
+
+```
+POST /<command>
+```
+
+Arguments are supplied via the POST parameter `args` which is an array
+of arguments in the order that they would be passed to the underlying
+Redis method.  For example:
+
+```javascript
+// Sets the 'somefield' field of the hash at key 'somekey' to 42
+$.post("/hset", { args: ["somekey", "somefield", 42] });
+
+// Increments the key at 'somekey' by 12
+$.post("/incrby", { args: ["somekey", 12] });
+```
+
+The return value for POST commands is the same for GET commands, a
+simple JSON hash with a `results` key containing the serialized return
+value of the Redis call.
+
+## TODO:
+
+* Not all of the Redis commands are currently supported.
+* Add support for Redis pub/sub.
 
 ## Contributing
 

data/bin/redsquare

@@ -1,12 +1,16 @@
 #!/usr/bin/env ruby
 
-begin
+def run
   require "redsquare"
+  require File.expand_path(ARGV[0]) if ARGV[0]
   Redsquare::App.run!
+end
+
+begin
+  run
 rescue LoadError => e
   require "rubygems"
   path = File.expand_path "../../lib", __FILE__
   $:.unshift(path) if File.directory?(path) && !$:.include?(path)
-  require "redsquare"
-  Redsquare::App.run!
+  run
 end

data/lib/redsquare/{application/app.rb → app.rb}

@@ -2,6 +2,10 @@ module Redsquare
   class App < Sinatra::Base
 
     POST_COMMANDS = [
+      :sunionstore,
+      :srem,
+      :spop,
+      :smove,
       :setrange,
       :setnx,
       :setbit,
@@ -45,6 +49,10 @@ module Redsquare
     ]
 
     GET_COMMANDS = [
+      :sunion,
+      :srandmember,
+      :smembers,
+      :sismember,
       :sinter,
       :sdiff,
       :scard,
@@ -66,15 +74,14 @@ module Redsquare
       :getbit,
       :get,
       :exists,
-      :dump,
       :dbsize
     ]
 
     POST_COMMANDS.each do |command|
-      post "/#{command}/?*" do
+      post "/#{command}" do
         content_type :json
-        args = params[:splat].select { |a| a.present? }.compact
-        val = Redis.current.send command, *args
+        args = params[:args].map { |a| try_to_i a }
+        val = Config.redis.send command, *args
         { result: val }.to_json
       end
     end
@@ -82,11 +89,16 @@ module Redsquare
     GET_COMMANDS.each do |command|
       get "/#{command}/?*" do
         content_type :json
-        args = params[:splat][0].split("/")
-        val = Redis.current.send command, *args
+        args = params[:splat][0].split("/").map { |a| try_to_i a }
+        val = Config.redis.send command, *args
         { result: val }.to_json
       end
     end
 
+    def try_to_i(str)
+      is_int = str.to_i.to_s == str
+      is_int ? str.to_i : str
+    end
+
   end
 end

data/lib/redsquare/config.rb

@@ -0,0 +1,18 @@
+module Redsquare
+  module Config
+    extend self
+
+    def redis=(arg)
+      if arg.is_a?(Redis)
+        @redis = arg
+      else
+        @redis = Redis.new(arg)
+      end
+    end
+
+    def redis
+      @redis ||= Redis.current
+    end
+
+  end
+end

data/lib/redsquare/version.rb

@@ -1,3 +1,3 @@
 module Redsquare
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/redsquare.rb

@@ -3,4 +3,13 @@ require "active_support/all"
 require "sinatra"
 require "redis"
 require "json"
-require "redsquare/application/app"
+require "redsquare/config"
+require "redsquare/app"
+
+module Redsquare
+
+  def config
+    Config
+  end
+
+end

data/redsquare.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.name          = "redsquare"
   spec.version       = Redsquare::VERSION
   spec.authors       = ["JC Grubbs"]
-  spec.email         = ["jc.grubbs@devmynd.com"]
-  spec.description   = %q{Redsquare is a server that supplies a restful interface to Redis.}
-  spec.summary       = %q{Redsquare is a server that supplies a restful interface to Redis.}
+  spec.email         = ["jc@devmynd.com"]
+  spec.description   = %q{A mountable/standalone JSON interface to Redis.}
+  spec.summary       = %q{A mountable/standalone JSON interface to Redis.}
   spec.homepage      = "http://github.com/thegrubbsian/redsquare"
   spec.license       = "MIT"
 
@@ -27,4 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "fakeredis"
+
 end

data/spec/app_spec.rb

@@ -0,0 +1,197 @@
+require "spec_helper"
+
+describe Redsquare::App do
+  include Rack::Test::Methods
+
+  def app
+    Redsquare::App
+  end
+
+  def result
+    JSON.parse(last_response.body)["result"]
+  end
+
+  def redis
+    Redis.current
+  end
+
+  describe "GET commands" do
+
+    before do
+
+      # String
+      redis.set "string_a", "bar"
+      redis.set "string_b", "baz"
+
+      # Sets
+      redis.sadd "set_a", "a"
+      redis.sadd "set_a", "b"
+      redis.sadd "set_a", "c"
+
+      redis.sadd "set_b", "b"
+      redis.sadd "set_b", "c"
+      redis.sadd "set_b", "d"
+
+      # Lists
+      redis.rpush "list_a", "a"
+      redis.rpush "list_a", "b"
+      redis.rpush "list_a", "c"
+
+      redis.rpush "list_b", "b"
+      redis.rpush "list_b", "c"
+      redis.rpush "list_b", "d"
+
+      # Expiring key
+      redis.set "expire", "foo"
+      redis.expireat "expireat", 1555555555005
+
+      # Hashes
+      redis.hset "hash_a", "a", 1
+      redis.hset "hash_a", "b", 2.00
+      redis.hset "hash_a", "c", "foobar"
+    end
+
+    describe "returns the correct response for" do
+
+      it "sinter" do
+        get "/sinter/set_a/set_b"
+        expect(result).to eq ["b", "c"]
+      end
+
+      it "sdiff" do
+        get "/sdiff/set_a/set_b"
+        expect(result).to eq ["a"]
+        get "/sdiff/set_b/set_a"
+        expect(result).to eq ["d"]
+      end
+
+      it "scard" do
+        get "/scard/set_a"
+        expect(result).to eq 3
+      end
+
+      it "randomkey" do
+        get "/randomkey"
+        expect(result).to_not be_nil
+      end
+
+      it "mget" do
+        get "/mget/string_a/string_b"
+        expect(result).to eq ["bar", "baz"]
+      end
+
+      it "lrange" do
+        get "/lrange/list_a/0/1"
+        expect(result).to eq ["a", "b"]
+      end
+
+      it "llen" do
+        get "/llen/list_a"
+        expect(result).to eq 3
+      end
+
+      it "lindex" do
+        get "/lindex/list_a/1"
+        expect(result).to eq "b"
+      end
+
+      it "keys" do
+        get "/keys"
+        expect(result).to eq Redis.current.keys
+      end
+
+      it "hvals" do
+        get "/hvals/hash_a"
+        expect(result).to eq ["1", "2.0", "foobar"]
+      end
+
+      it "hmget" do
+        get "/hmget/hash_a/a/c"
+        expect(result).to eq ["1", "foobar"]
+      end
+
+      it "hlen" do
+        get "/hlen/hash_a"
+        expect(result).to eq 3
+      end
+
+      it "hkeys" do
+        get "/hkeys/hash_a"
+        expect(result).to eq ["a", "b", "c"]
+      end
+
+      it "hgetall" do
+        get "/hgetall/hash_a"
+        expect(result).to eq({ "a" => "1", "b" => "2.0", "c" => "foobar" })
+      end
+
+      it "hget" do
+        get "/hget/hash_a/a"
+        expect(result).to eq "1"
+      end
+
+      it "hexists" do
+        get "/hexists/hash_a/c"
+        expect(result).to be_true
+      end
+
+      it "getrange" do
+        get "/getrange/string_a/0/1"
+        expect(result).to eq "ba"
+      end
+
+      it "get" do
+        get "/get/string_a"
+        expect(result).to eq "bar"
+      end
+
+      it "exists" do
+        get "/get/string_a"
+        expect(result).to be_true
+      end
+
+      it "dbsize" do
+        get "/dbsize"
+        expect(result).to eq 8
+      end
+
+    end
+
+  end
+
+  describe "POST commands" do
+
+    describe "returns the correct response for" do
+
+      it "setrange" do
+        redis.set "string_a", "Hello World"
+        post "/setrange", args: ["string_a", 6, "Redis"]
+        expect(redis.get "string_a").to eq "Hello Redis"
+      end
+
+      it "setnx" do
+        post "/setnx", args: ["bar", "baz"]
+        expect(redis.get "bar").to eq "baz"
+      end
+
+      it "set" do
+        post "/set", args: ["string_a", "foo"]
+        expect(redis.get "string_a").to eq "foo"
+      end
+
+      it "sdiffstore" do
+        redis.sadd "list_a", "a"
+        redis.sadd "list_a", "b"
+        redis.sadd "list_a", "c"
+        redis.sadd "list_b", "b"
+        redis.sadd "list_b", "c"
+        redis.sadd "list_b", "d"
+        post "/sdiffstore", args: ["list_c", "list_a", "list_b"]
+        expect(redis.smembers "list_c").to eq ["a"]
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "redsquare"
+require "rack/test"
+require "fakeredis/rspec"
+require "pry"
+
+set :environment, :test
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redsquare
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - JC Grubbs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -108,9 +108,37 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Redsquare is a server that supplies a restful interface to Redis.
+- !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'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  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: A mountable/standalone JSON interface to Redis.
 email:
-- jc.grubbs@devmynd.com
+- jc@devmynd.com
 executables:
 - redsquare
 extensions: []
@@ -123,10 +151,12 @@ files:
 - Rakefile
 - bin/redsquare
 - lib/redsquare.rb
-- lib/redsquare/application/app.rb
-- lib/redsquare/application/commands/keys.rb
+- lib/redsquare/app.rb
+- lib/redsquare/config.rb
 - lib/redsquare/version.rb
 - redsquare.gemspec
+- spec/app_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/thegrubbsian/redsquare
 licenses:
 - MIT
@@ -150,5 +180,7 @@ rubyforge_project:
 rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: Redsquare is a server that supplies a restful interface to Redis.
-test_files: []
+summary: A mountable/standalone JSON interface to Redis.
+test_files:
+- spec/app_spec.rb
+- spec/spec_helper.rb

data/lib/redsquare/application/commands/keys.rb

@@ -1,17 +0,0 @@
-module Commands
-  module Keys
-
-    def self.included(klass)
-      redis = Redis.current
-
-      klass.class_eval do
-
-        get "/keys/(:pattern)" do
-          redis.keys
-        end
-
-      end
-    end
-
-  end
-end