thebigdb 1.0.0

data/.gitignore

@@ -0,0 +1,20 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+*;*
+.backups
+.DS_Store
+log/*
+._*
+.__*
+*~
+*.swp
+.rvmrc
+*.gem
+tmp/*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    thebigdb (1.0.0)
+      rack (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    coderay (1.0.8)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    ffi (1.2.0)
+    guard (1.5.4)
+      listen (>= 0.4.2)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.3.1)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    listen (0.6.0)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rack (1.4.1)
+    rb-fchange (0.0.6)
+      ffi
+    rb-fsevent (0.9.2)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    slop (3.3.3)
+    thor (0.16.0)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec (~> 2.3)
+  rb-fchange
+  rb-fsevent
+  rb-inotify
+  rspec (~> 2.12)
+  thebigdb!
+  webmock (~> 1.9)

data/Guardfile

@@ -0,0 +1,8 @@
+guard 'rspec' do
+  watch("spec/spec_helper.rb") { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/thebigdb\.rb$}) { "spec" }
+  watch(%r{^lib/thebigdb/(.+)\.rb$}) {|m| "spec/#{m[1]}_spec.rb" }
+end

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2013, Christophe Maximin <christophe@thebigdb.com>
+
+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,91 @@
+# TheBigDB Ruby Wrapper
+
+A simple ruby wrapper for making requests to the API of [TheBigDB.com][0].
+
+## Install
+
+    gem install thebigdb
+
+## Usage
+
+Make your requests using this structure:
+    
+
+    TheBigDB::Statement(action, parameters)
+
+
+**[action]** => String of the action as described in the API (e.g. "search", "show", ...)  
+**[parameters]** => Hash. Request parameters as described in the API. Tip: Arrays like ``["abc", "def"]`` will automatically be converted to ``{"0" => "abc", "1" => "def"}``
+
+
+Examples:
+    
+    request = TheBigDB::Statement(:search,
+      {
+        nodes: [{search: ""}, "job", "President of the United States"],
+        period: {from: "2000-01-01 00:00:00", to: "2002-01-01 00:00:00"}
+      }
+    )
+
+    puts request.response
+
+Will print something like:
+
+    {
+      "status" => "success",
+      "statements" => [
+        {"nodes" => ["Bill Clinton", "job", "President of the United States"], "id" => "8e6aec890c942b6f7854d2d7a9f0d002f5ddd0c0", "period"=>{"from" => "1993-01-20 00:00:00", "to" => "2001-01-20 00:00:00"}},
+        {"nodes" => ["George W. Bush", "job", "President of the United States"], "id" => "3f27673816455054032bd46e65bbe4db8ccf9076", "period"=>{"from" => "2001-01-20 00:00:00", "to" => "2009-01-20 00:00:00"}}
+      ]
+    }
+
+That's it!
+
+## The TheBigDB::Request object
+
+Every request you make will return a ``TheBigDB::Request`` object.
+It has several readable attributes:
+    
+    request = TheBigDB::Statement(:search, {nodes: ["iPhone", "weight"]})
+    request.http              # Net::HTTP
+    request.http_request      # subclass of Net::HTTPGenericRequest (Net::HTTP::Get or Net::HTTP::Post)
+    request.http_response     # subclass of Net::HTTPResponse (e.g. Net::HTTPOK)
+    request.data_sent         # Hash of the data sent, keys: "headers", "host", "port", "path", "method", "params"
+    request.data_received     # Hash of the data received, keys: "headers", "content"
+    request.response          # Hash, body of the http response converted from json
+
+## Other Features
+
+You can access other parts of the API in the same way as statements:
+    
+    TheBigDB::User(action, parameters)
+    TheBigDB::Toolbox::Unit(action, parameters)
+
+    # Examples
+    TheBigDB::User(:show, {login: "christophe"}).response["user"]["karma"]
+    TheBigDB::Toolbox::Unit(:compare, {values: ["100 g", "1.2 kg"]}).response["result"]
+
+You can modify the TheBigDB module with several configuration options:
+
+    TheBigDB.api_key = "your-private-api-key"           # default: nil
+    TheBigDB.use_ssl = true                             # default: false
+
+    # Both of them take a Proc or a Lambda, the TheBigDB::Request instance is passed as argument
+    TheBigDB.before_request_execution = ->(request){ Logger.foo(request) }   # default: Proc.new{}
+    TheBigDB.after_request_execution = ->(request){ Logger.foo(request) }    # default: Proc.new{}
+
+
+## Contributing
+
+Don't hesitate to send a pull request !
+
+## Testing
+  
+    rspec spec/
+
+## License
+
+This software is distributed under the MIT License. Copyright (c) 2013, Christophe Maximin <christophe@thebigdb.com>
+
+
+[0]: http://thebigdb.com

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+desc "Run tests"
+task :default => [:spec]

data/lib/thebigdb/aliases.rb

@@ -0,0 +1,4 @@
+# Because a lot of people are bound to make those mistakes
+Thebigdb = TheBigDB
+TheBigDb = TheBigDB
+TheBigdb = TheBigDB

data/lib/thebigdb/module_attribute_accessors.rb

@@ -0,0 +1,43 @@
+# Heavily inspired by "core_ext/module/attribute_accessors" from activesupport (4.0.0.beta)
+module TheBigDB
+  def self.mattr_reader(*syms)
+    syms.each do |sym|
+      raise NameError.new('invalid attribute name') unless sym =~ /^[_A-Za-z]\w*$/
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        @@#{sym} = nil unless defined? @@#{sym}
+
+        def self.#{sym}
+          @@#{sym}
+        end
+      EOS
+
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+    end
+  end
+
+  def self.mattr_writer(*syms)
+    syms.each do |sym|
+      raise NameError.new('invalid attribute name') unless sym =~ /^[_A-Za-z]\w*$/
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+    end
+  end
+
+  def self.mattr_accessor(*syms)
+    mattr_reader(*syms)
+    mattr_writer(*syms)
+  end
+end

data/lib/thebigdb/request.rb

@@ -0,0 +1,145 @@
+module TheBigDB
+  class Request
+    attr_reader :http, :http_request, :http_response, :data_sent, :data_received, :response
+
+    # Prepares the basic @http object with the current values of the module (host, port, ...)
+    def initialize
+      @http = Net::HTTP.new(TheBigDB.api_host, TheBigDB.api_port)
+
+      if TheBigDB.use_ssl
+        @http.use_ssl = true
+        if TheBigDB.verify_ssl_certificates
+          raise NotImplementedError
+        else
+          @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+      end
+    end
+
+    # Prepares the @http_request object with the actual content of the request
+    def prepare(method, request_uri, params = {})
+      method = method.downcase.to_s
+
+      # we add the API version to the URL, with a trailing slash and the rest of the request
+      request_uri = "/v#{TheBigDB.api_version}" + (request_uri.start_with?("/") ? request_uri : "/#{request_uri}")
+
+      if method == "get"
+        encoded_params = TheBigDB::Request::serialize_query_params(params)
+        @http_request = Net::HTTP::Get.new(request_uri + "?" + encoded_params)
+      elsif method == "post"
+        @http_request = Net::HTTP::Post.new(request_uri)
+        @http_request.set_form_data(TheBigDB::Request::flatten_params_keys(params))
+      else
+        raise ArgumentError, "The request method must be 'get' or 'post'"
+      end
+
+      @http_request["user-agent"] = "TheBigDB RubyWrapper/#{TheBigDB::VERSION::STRING}"
+
+      client_user_agent = {
+        :publisher => "thebigdb",
+        :version => TheBigDB::VERSION::STRING,
+        :language => "ruby",
+        :language_version => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+      }
+
+      @http_request["X-TheBigDB-Client-User-Agent"] = JSON(client_user_agent)
+
+      self
+    end
+
+    # Actually makes the request prepared in @http_request, and sets @http_response
+    def execute
+      # Here is the order of operations:
+      # -> executing before_request_execution callback
+      # -> executing the HTTP request
+      # -> setting @response
+      # -> setting @data_sent
+      # -> setting @data_received
+      # -> executing after_request_execution callback
+
+      # Executing callback
+      TheBigDB.before_request_execution.call(self)
+
+      # Here is where the request is actually executed
+      @http_response = @http.request(@http_request)
+
+      # Setting @response
+      begin
+        # We parse the JSON answer and return it.
+        @response = JSON(@http_response.body)
+      rescue JSON::ParserError => e
+        @response = {"error" => {"code" => "0000", "description" => "The server gave an invalid JSON body:\n#{@http_response.body}"}}
+      end
+
+      # Setting @data_sent and @data_received
+      params = Rack::Utils.parse_nested_query(URI.parse(@http_request.path).query)
+      # Since that's how it will be interpreted anyway on the server, we merge the POST params to the GET params,
+      # but it's not supposed to happen: either every params is prepared for GET/query params, or as POST body
+      params.merge!(Rack::Utils.parse_nested_query(@http_request.body.to_s))
+
+      # About: Hash[{}.map{|k,v| [k, v.join] }]
+      # it transforms the following hash:
+      # {"accept"=>["*/*"], "user-agent"=>["TheBigDB RubyWrapper/X.Y.Z"], "host"=>["computer.host"]}
+      # into the following hash:
+      # {"accept"=>"*/*", "user-agent"=>"TheBigDB RubyWrapper/X.Y.Z", "host"=>"computer.host"}
+      # which is way more useful and cleaner.
+      @data_sent = {
+        "headers" => Hash[@http_request.to_hash.map{|k,v| [k, v.join] }],
+        "host" => @http.address,
+        "port" => @http.port,
+        "path" => URI.parse(@http_request.path).path,
+        "method" => @http_request.method,
+        "params" => params
+      }
+
+      @data_received = {
+        "headers" => Hash[@http_response.to_hash.map{|k,v| [k, v.join] }],
+        "content" => @response
+      }
+
+      TheBigDB.after_request_execution.call(self)
+
+      self
+    end
+
+    ##############
+    ## Engine Helpers
+    ##############
+
+    # serialize_query_params({house: "bricks", animals: ["cat", "dog"], computers: {cool: true, drives: ["hard", "flash"]}})
+    # => house=bricks&animals%5B%5D=cat&animals%5B%5D=dog&computers%5Bcool%5D=true&computers%5Bdrives%5D%5B%5D=hard&computers%5Bdrives%5D%5B%5D=flash
+    # which will be read by the server as:
+    # => house=bricks&animals[]=cat&animals[]=dog&computers[cool]=true&computers[drives][]=hard&computers[drives][]=flash
+    def self.serialize_query_params(params, prefix = nil)
+      ret = []
+      params.each_pair do |key, value|
+        param_key = prefix ? "#{prefix}[#{key}]" : key
+
+        if value.is_a?(Hash)
+          ret << self.serialize_query_params(value, param_key.to_s)
+        elsif value.is_a?(Array)
+          sub_hash = {}
+          value.each_with_index do |value_item, i|
+            sub_hash[i.to_s] = value_item
+          end
+          ret << self.serialize_query_params(sub_hash, param_key.to_s)
+        else
+          ret << URI.encode_www_form_component(param_key.to_s) + "=" + URI.encode_www_form_component(value.to_s)
+        end
+      end
+      ret.join("&")
+    end
+
+    # flatten_params_keys({house: "bricks", animals: ["cat", "dog"], computers: {cool: true, drives: ["hard", "flash"]}})
+    # => {"house" => "bricks", "animals[0]" => "cat", "animals[1]" => "dog", "computers[cool]" => "true", "computers[drives][0]" => "hard", "computers[drives][1]" => "flash"}
+    def self.flatten_params_keys(params)
+      serialized_params = self.serialize_query_params(params)
+      new_params = {}
+      serialized_params.split("&").each do |assign|
+        key, value = assign.split("=")
+        new_params[URI.decode(key)] = URI.decode(value)
+      end
+      new_params
+    end
+  end
+end

data/lib/thebigdb/resources/statement.rb

@@ -0,0 +1,10 @@
+module TheBigDB
+  def self.Statement(action, params)
+    method = ["get", "show", "search"].include?(action.to_s) ? "GET" : "POST"
+    path = "/statements/#{action}"
+
+    request = TheBigDB::Request.new
+    request.prepare(method, path, params)
+    request.execute
+  end
+end

data/lib/thebigdb/resources/toolbox.rb

@@ -0,0 +1,12 @@
+module TheBigDB
+  module Toolbox
+    def self.Unit(action, params)
+      method = "GET"
+      path = "/toolbox/units/#{action}"
+
+      request = TheBigDB::Request.new
+      request.prepare(method, path, params)
+      request.execute
+    end
+  end
+end

data/lib/thebigdb/resources/user.rb

@@ -0,0 +1,10 @@
+module TheBigDB
+  def self.User(action, params)
+    method = "GET"
+    path = "/users/#{action}"
+
+    request = TheBigDB::Request.new
+    request.prepare(method, path, params)
+    request.execute
+  end
+end

data/lib/thebigdb/version.rb

@@ -0,0 +1,9 @@
+module TheBigDB
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
+end

data/lib/thebigdb.rb

@@ -0,0 +1,75 @@
+require "net/https"
+require "json"
+require "rack"
+
+%w(
+  module_attribute_accessors
+  aliases
+  request
+  version
+  resources/statement
+  resources/user
+  resources/toolbox
+).each do |file_name|
+  require File.join(File.dirname(__FILE__), 'thebigdb', file_name)
+end
+
+module TheBigDB
+
+  DEFAULT_VALUES = {
+    "api_host" => "api.thebigdb.com",
+    "api_port" => 80,
+    "api_version" => "1",
+    "use_ssl" => false,
+    "verify_ssl_certificates" => false,
+    "before_request_execution" => Proc.new{},
+    "after_request_execution" => Proc.new{}
+  }
+
+  mattr_accessor :api_host, :api_port, :api_version, :api_key
+  mattr_accessor :use_ssl, :verify_ssl_certificates
+  mattr_accessor :before_request_execution, :after_request_execution
+
+  def self.reset_default_values
+    DEFAULT_VALUES.each_pair do |key, value|
+      send(key + "=", value)
+    end
+  end
+  reset_default_values
+
+  def self.use_ssl=(bool)
+    @@api_port = bool ? 443 : 80
+    @@use_ssl = bool
+  end
+
+  def self.verify_ssl_certificates=(bool)
+    if bool
+      raise NotImplementedError, "The certificates are never checked"
+    end
+    @@verify_ssl_certificates = bool
+  end
+
+  def self.before_request_execution=(object)
+    unless object.is_a?(Proc)
+      raise ArgumentError, "You must pass a proc or lambda"
+    end
+    @@before_request_execution = object
+  end
+
+  def self.after_request_execution=(object)
+    unless object.is_a?(Proc)
+      raise ArgumentError, "You must pass a proc or lambda"
+    end
+    @@after_request_execution = object
+  end
+
+
+  # Shortcut: prepares, executes and returns Hash containing the server's response
+  def self.send_request(*args)
+    request = Request.new
+    request.prepare(*args)
+    request.execute
+    request.response
+  end
+
+end

data/spec/request_spec.rb

@@ -0,0 +1,315 @@
+require "spec_helper"
+
+# Here we're testing standard requests behaviour,
+# what they send, what they receive,
+# and how they incorporate them into this wrapper's objects.
+
+describe "initializing requests" do
+  before do
+    @request = TheBigDB::Request.new
+  end
+
+  it "sets a http instance variable with correct attributes" do
+    @request.http.address.should == TheBigDB.api_host
+    @request.http.port.should == TheBigDB.api_port
+  end
+end
+
+describe "preparing" do
+  context "GET requests" do
+    before do
+      @request = TheBigDB::Request.new
+      @request.prepare(:get, "/abc", :foo => "bar")
+    end
+
+    it "sets a http_request instance variable with correct attributes" do
+      http_request = @request.http_request
+      http_request.method == "GET"
+      http_request.path.should == "/v#{TheBigDB.api_version}/abc?foo=bar"
+    end
+  end
+
+  context "POST requests" do
+    before do
+      @request = TheBigDB::Request.new
+      @request.prepare(:post, "/abc", :foo => "bar")
+    end
+
+    it "sets a http_request instance variable with correct attributes" do
+      http_request = @request.http_request
+      http_request.method == "POST"
+      http_request.path.should == "/v#{TheBigDB.api_version}/abc"
+      http_request.body.should == "foo=bar"
+    end
+  end
+end
+
+describe "executing" do
+
+  context "requests" do
+    before do
+      stub_request(:get, /#{TheBigDB.api_host}/).to_return(:body => '{"server_says": "hello world"}')
+
+      @request = TheBigDB::Request.new
+      @request.prepare(:get, "/", :foo => "bar")
+      @request.execute
+    end
+
+    it "sends the correct HTTP request" do
+      a_request(:get, /#{TheBigDB.api_host}/).with(:query => {"foo" => "bar"}).should have_been_made
+    end
+
+    it "sets the correct http_response object" do
+      @request.http_response.body.should == '{"server_says": "hello world"}'
+    end
+
+    it "sets the correct response Hash" do
+      @request.response.should == {"server_says" => "hello world"}
+    end
+  end
+
+  context "requests with before/after callbacks" do
+    it "runs both of them" do
+      stub_request(:get, /#{TheBigDB.api_host}/).to_return(:body => "{}")
+
+      String.should_receive(:new).with("called in before_execution")
+      String.should_receive(:new).with("called in after_execution")
+
+      TheBigDB.before_request_execution = proc { String.new("called in before_execution") }
+      TheBigDB.after_request_execution = proc { String.new("called in after_execution") }
+
+      TheBigDB.send_request(:get, "/")
+    end
+  end
+
+  context "GET requests" do
+    context "with basic params" do
+      before do
+        stub_request(:get, /#{TheBigDB.api_host}/).to_return(:body => '{"server_says": "hello world"}')
+
+        @request = TheBigDB::Request.new
+        @request.prepare(:get, "/", :foo => "bar")
+        @request.execute
+      end
+
+      it "sets the correct data_sent instance variable" do
+        @request.data_sent.should == {
+            "headers" => Hash[@request.http_request.to_hash.map{|k,v| [k, v.join] }],
+            "host" => TheBigDB.api_host,
+            "port" => TheBigDB.api_port,
+            "path" => "/v#{TheBigDB.api_version}/",
+            "method" => "GET",
+            "params" => {"foo" => "bar"}
+          }
+      end
+
+      it "sets the correct data_received instance variable" do
+        @request.data_received.should include({
+            "headers" => Hash[@request.http_response.to_hash.map{|k,v| [k, v.join] }],
+            "content" => {"server_says" => "hello world"}
+          })
+      end
+    end
+
+    context "with arrays in params" do
+      before do
+        stub_request(:get, /#{TheBigDB.api_host}/).to_return(:body => '{"server_says": "hello world"}')
+
+        @request = TheBigDB::Request.new
+        @request.prepare(:get, "/", :nodes => ["foo", "bar"])
+        @request.execute
+      end
+
+      it "sets the correct data_sent instance variable" do
+        @request.data_sent.should == {
+            "headers" => Hash[@request.http_request.to_hash.map{|k,v| [k, v.join] }],
+            "host" => TheBigDB.api_host,
+            "port" => TheBigDB.api_port,
+            "path" => "/v#{TheBigDB.api_version}/",
+            "method" => "GET",
+            "params" => {"nodes" => {"0" => "foo", "1" => "bar"}}
+          }
+      end
+
+      it "sets the correct data_received instance variable" do
+        @request.data_received.should include({
+            "headers" => Hash[@request.http_response.to_hash.map{|k,v| [k, v.join] }],
+            "content" => {"server_says" => "hello world"}
+          })
+      end
+    end
+
+    context "with hashes in params" do
+      before do
+        stub_request(:get, /#{TheBigDB.api_host}/).to_return(:body => '{"server_says": "hello world"}')
+
+        @request = TheBigDB::Request.new
+        @request.prepare(:get, "/", :nodes => {"0" => "foo", "1" => "bar"})
+        @request.execute
+      end
+
+      it "sets the correct data_sent instance variable" do
+        @request.data_sent.should == {
+            "headers" => Hash[@request.http_request.to_hash.map{|k,v| [k, v.join] }],
+            "host" => TheBigDB.api_host,
+            "port" => TheBigDB.api_port,
+            "path" => "/v#{TheBigDB.api_version}/",
+            "method" => "GET",
+            "params" => {"nodes" => {"0" => "foo", "1" => "bar"}}
+          }
+      end
+
+      it "sets the correct data_received instance variable" do
+        @request.data_received.should include({
+            "headers" => Hash[@request.http_response.to_hash.map{|k,v| [k, v.join] }],
+            "content" => {"server_says" => "hello world"}
+          })
+      end
+    end
+  end
+
+  context "POST requests" do
+    context "with basic params" do
+      before do
+        stub_request(:post, /#{TheBigDB.api_host}/).to_return(:body => '{"server_says": "hello world"}')
+
+        @request = TheBigDB::Request.new
+        @request.prepare(:post, "/", :foo => "bar")
+        @request.execute
+      end
+
+      it "sets the correct data_sent instance variable" do
+        @request.data_sent.should == {
+            "headers" => Hash[@request.http_request.to_hash.map{|k,v| [k, v.join] }],
+            "host" => TheBigDB.api_host,
+            "port" => TheBigDB.api_port,
+            "path" => "/v#{TheBigDB.api_version}/",
+            "method" => "POST",
+            "params" => {"foo" => "bar"}
+          }
+      end
+
+      it "sets the correct data_received instance variable" do
+        @request.data_received.should include({
+            "headers" => Hash[@request.http_response.to_hash.map{|k,v| [k, v.join] }],
+            "content" => {"server_says" => "hello world"}
+          })
+      end
+    end
+
+    context "with array arguments" do
+      before do
+        stub_request(:post, /#{TheBigDB.api_host}/).to_return(:body => '{"server_says": "hello world"}')
+
+        @request = TheBigDB::Request.new
+        @request.prepare(:post, "/", :nodes => ["foo", "bar"])
+        @request.execute
+      end
+
+      it "sets the correct data_sent instance variable" do
+        @request.data_sent.should == {
+            "headers" => Hash[@request.http_request.to_hash.map{|k,v| [k, v.join] }],
+            "host" => TheBigDB.api_host,
+            "port" => TheBigDB.api_port,
+            "path" => "/v#{TheBigDB.api_version}/",
+            "method" => "POST",
+            "params" => {"nodes" => {"0" => "foo", "1" => "bar"}}
+          }
+      end
+
+      it "sets the correct data_received instance variable" do
+        @request.data_received.should include({
+            "headers" => Hash[@request.http_response.to_hash.map{|k,v| [k, v.join] }],
+            "content" => {"server_says" => "hello world"}
+          })
+      end
+    end
+
+    context "with hash arguments" do
+      before do
+        stub_request(:post, /#{TheBigDB.api_host}/).to_return(:body => '{"server_says": "hello world"}')
+
+        @request = TheBigDB::Request.new
+        @request.prepare(:post, "/", :nodes => {"0" => "foo", "1" => "bar"})
+        @request.execute
+      end
+
+      it "sets the correct data_sent instance variable" do
+        @request.data_sent.should == {
+            "headers" => Hash[@request.http_request.to_hash.map{|k,v| [k, v.join] }],
+            "host" => TheBigDB.api_host,
+            "port" => TheBigDB.api_port,
+            "path" => "/v#{TheBigDB.api_version}/",
+            "method" => "POST",
+            "params" => {"nodes" => {"0" => "foo", "1" => "bar"}}
+          }
+      end
+
+      it "sets the correct data_received instance variable" do
+        @request.data_received.should include({
+            "headers" => Hash[@request.http_response.to_hash.map{|k,v| [k, v.join] }],
+            "content" => {"server_says" => "hello world"}
+          })
+      end
+    end
+  end
+end
+
+describe "Request helper" do
+  describe "serialize_query_params" do
+    it "works with simple a=b&c=d params" do
+      TheBigDB::Request.serialize_query_params(a: "b", c: "d").should == "a=b&c=d"
+    end
+
+    it "works with more complex imbricated params" do
+      TheBigDB::Request.serialize_query_params({
+        house: "bricks",
+        animals: ["cat", "dog"],
+        computers: {cool: true, drives: ["hard", "flash"]}
+      }).should == "house=bricks&animals%5B0%5D=cat&animals%5B1%5D=dog&computers%5Bcool%5D=true&computers%5Bdrives%5D%5B0%5D=hard&computers%5Bdrives%5D%5B1%5D=flash"
+
+      # and with a hash instead of an array
+      TheBigDB::Request.serialize_query_params({
+        house: "bricks",
+        animals: {"0" => "cat", "1" => "dog"},
+        computers: {cool: true, drives: ["hard", "flash"]}
+      }).should == "house=bricks&animals%5B0%5D=cat&animals%5B1%5D=dog&computers%5Bcool%5D=true&computers%5Bdrives%5D%5B0%5D=hard&computers%5Bdrives%5D%5B1%5D=flash"
+    end
+  end
+
+  describe "flatten_params_keys" do
+    it "works with simple a=b&c=d params" do
+      TheBigDB::Request.flatten_params_keys(a: "b", c: "d").should == {"a" => "b", "c" => "d"}
+    end
+
+    it "works with more complex imbricated params" do
+      TheBigDB::Request.flatten_params_keys({
+        house: "bricks",
+        animals: ["cat", "dog"],
+        computers: {cool: true, drives: ["hard", "flash"]}
+      }).should == {
+        "house" => "bricks",
+        "animals[0]" => "cat",
+        "animals[1]" => "dog",
+        "computers[cool]" => "true",
+        "computers[drives][0]" => "hard",
+        "computers[drives][1]" => "flash"
+      }
+
+      # and with a hash instead of an array
+      TheBigDB::Request.flatten_params_keys({
+        house: "bricks",
+        animals: {"0" => "cat", "1" => "dog"},
+        computers: {cool: true, drives: ["hard", "flash"]}
+      }).should == {
+        "house" => "bricks",
+        "animals[0]" => "cat",
+        "animals[1]" => "dog",
+        "computers[cool]" => "true",
+        "computers[drives][0]" => "hard",
+        "computers[drives][1]" => "flash"
+      }
+    end
+  end
+end
+

data/spec/resources/statement_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe "Statement" do
+  context "basic request executing" do
+    before do
+      stub_request(:get, /#{TheBigDB.api_host}\/v#{TheBigDB.api_version}\/statements\/search/).to_return(:body => '{"server_says": "hello world"}')
+
+      @request = TheBigDB::Statement(:search, nodes: ["a", "b"])
+    end
+
+    it "sets the correct data_sent instance variable" do
+      @request.data_sent.should == {
+          "headers" => Hash[@request.http_request.to_hash.map{|k,v| [k, v.join] }],
+          "host" => TheBigDB.api_host,
+          "port" => TheBigDB.api_port,
+          "path" => "/v#{TheBigDB.api_version}/statements/search",
+          "method" => "GET",
+          "params" => {"nodes" => {"0" => "a", "1" => "b"}}
+        }
+    end
+
+    it "sets the correct data_received instance variable" do
+      @request.data_received.should include({
+          "headers" => Hash[@request.http_response.to_hash.map{|k,v| [k, v.join] }],
+          "content" => {"server_says" => "hello world"}
+        })
+    end
+  end
+end

data/spec/resources/toolbox_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe "Toolbox Units" do
+  context "basic request executing" do
+    before do
+      stub_request(:get, /#{TheBigDB.api_host}\/v#{TheBigDB.api_version}\/toolbox\/units\/convert/).to_return(:body => '{"server_says": "hello world"}')
+
+      @request = TheBigDB::Toolbox::Unit(:convert, :value => "100 ly", :new_unit => "cm")
+    end
+
+    it "sets the correct data_sent instance variable" do
+      @request.data_sent.should == {
+          "headers" => Hash[@request.http_request.to_hash.map{|k,v| [k, v.join] }],
+          "host" => TheBigDB.api_host,
+          "port" => TheBigDB.api_port,
+          "path" => "/v#{TheBigDB.api_version}/toolbox/units/convert",
+          "method" => "GET",
+          "params" => {"value" => "100 ly", "new_unit" => "cm"}
+        }
+    end
+
+    it "sets the correct data_received instance variable" do
+      @request.data_received.should include({
+          "headers" => Hash[@request.http_response.to_hash.map{|k,v| [k, v.join] }],
+          "content" => {"server_says" => "hello world"}
+        })
+    end
+  end
+end

data/spec/resources/user_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe "User" do
+  context "basic request executing" do
+    before do
+      stub_request(:get, /#{TheBigDB.api_host}\/v#{TheBigDB.api_version}\/users\/show/).to_return(:body => '{"server_says": "hello world"}')
+
+      @request = TheBigDB::User(:show, login: "christophe")
+    end
+
+    it "sets the correct data_sent instance variable" do
+      @request.data_sent.should == {
+          "headers" => Hash[@request.http_request.to_hash.map{|k,v| [k, v.join] }],
+          "host" => TheBigDB.api_host,
+          "port" => TheBigDB.api_port,
+          "path" => "/v#{TheBigDB.api_version}/users/show",
+          "method" => "GET",
+          "params" => {"login" => "christophe"}
+        }
+    end
+
+    it "sets the correct data_received instance variable" do
+      @request.data_received.should include({
+          "headers" => Hash[@request.http_response.to_hash.map{|k,v| [k, v.join] }],
+          "content" => {"server_says" => "hello world"}
+        })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require "rspec"
+require "webmock/rspec"
+require "thebigdb"
+
+RSpec.configure do |config|
+  config.order = "random"
+
+  config.before(:each) do
+    TheBigDB::DEFAULT_VALUES["api_host"] = "fake.test.host"
+    TheBigDB.reset_default_values
+  end
+
+  config.after(:each) do
+    TheBigDB.reset_default_values
+  end
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

data/spec/thebigdb_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+# Here's we're testing the basics of the module itself,
+# the variable that you can set, the actions you can take, etc.
+
+describe "TheBigDB module" do
+  it "has accessors for common used global variables" do
+    TheBigDB.api_host = "foobar"
+    TheBigDB.api_port = 1337
+    TheBigDB.api_version = "1337"
+
+    TheBigDB.api_host.should == "foobar"
+    TheBigDB.api_port.should == 1337
+    TheBigDB.api_version.should == "1337"
+  end
+
+  it "has resettable default values" do
+    default_host = TheBigDB.api_host.dup
+    TheBigDB.api_host = "foobar"
+    TheBigDB.reset_default_values
+    TheBigDB.api_host.should == default_host
+  end
+end

data/thebigdb.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "thebigdb/version"
+
+Gem::Specification.new do |s|
+  s.name = "thebigdb"
+  s.version = TheBigDB::VERSION::STRING
+  s.date = "2013-03-12"
+  s.summary = "Ruby bindings for TheBigDB API"
+  s.description = "TheBigDB a simply structured open database of real life facts. See http://thebigdb.com for details."
+  s.authors = ["Christophe Maximin"]
+  s.email = "christophe@thebigdb.com"
+  s.homepage = "http://thebigdb.com"
+
+  s.platform = Gem::Platform::RUBY
+
+  s.add_runtime_dependency "rack", "~> 1.4"
+
+  s.add_development_dependency "rspec", "~> 2.12"
+  s.add_development_dependency "guard-rspec", "~> 2.3"
+  s.add_development_dependency "rb-inotify"
+  s.add_development_dependency "rb-fsevent"
+  s.add_development_dependency "rb-fchange"
+  s.add_development_dependency "webmock", "~> 1.9"
+
+
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: thebigdb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Christophe Maximin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-12 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: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fchange
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: TheBigDB a simply structured open database of real life facts. See http://thebigdb.com
+  for details.
+email: christophe@thebigdb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/thebigdb.rb
+- lib/thebigdb/aliases.rb
+- lib/thebigdb/module_attribute_accessors.rb
+- lib/thebigdb/request.rb
+- lib/thebigdb/resources/statement.rb
+- lib/thebigdb/resources/toolbox.rb
+- lib/thebigdb/resources/user.rb
+- lib/thebigdb/version.rb
+- spec/request_spec.rb
+- spec/resources/statement_spec.rb
+- spec/resources/toolbox_spec.rb
+- spec/resources/user_spec.rb
+- spec/spec_helper.rb
+- spec/thebigdb_spec.rb
+- thebigdb.gemspec
+homepage: http://thebigdb.com
+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.25
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for TheBigDB API
+test_files:
+- spec/request_spec.rb
+- spec/resources/statement_spec.rb
+- spec/resources/toolbox_spec.rb
+- spec/resources/user_spec.rb
+- spec/spec_helper.rb
+- spec/thebigdb_spec.rb