thebigdb 1.2.0 → 1.2.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    thebigdb (1.2.0)
+    thebigdb (1.2.1)
       rack (~> 1.4)
 
 GEM

data/lib/thebigdb/request.rb

@@ -22,6 +22,10 @@ module TheBigDB
     def prepare(method, request_uri, params = {})
       method = method.downcase.to_s
 
+      if TheBigDB.api_key.is_a?(String) and !TheBigDB.api_key.empty?
+        params.merge!("api_key" => TheBigDB.api_key)
+      end
+
       # 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}")
 
@@ -38,10 +42,10 @@ module TheBigDB
       @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})",
+        "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)

data/lib/thebigdb/resources/statement.rb

@@ -43,22 +43,22 @@ module TheBigDB
 
   # Shortcuts to actions
   def self.search(*nodes)
-    StatementRequest.new("search").with(nodes: nodes)
+    StatementRequest.new("search").with("nodes" => nodes)
   end
 
   def self.create(*nodes)
-    StatementRequest.new("create").with(nodes: nodes)
+    StatementRequest.new("create").with("nodes" => nodes)
   end
 
   def self.show(id = "")
-    StatementRequest.new("show").with(id: id)
+    StatementRequest.new("show").with("id" => id)
   end
 
   def self.upvote(id = "")
-    StatementRequest.new("upvote").with(id: id)
+    StatementRequest.new("upvote").with("id" => id)
   end
 
   def self.downvote(id = "")
-    StatementRequest.new("downvote").with(id: id)
+    StatementRequest.new("downvote").with("id" => id)
   end
 end

data/lib/thebigdb/version.rb

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

data/lib/thebigdb.rb

@@ -17,6 +17,7 @@ end
 module TheBigDB
 
   DEFAULT_CONFIGURATION = {
+    "api_key" => nil,
     "api_host" => "api.thebigdb.com",
     "api_port" => 80,
     "api_version" => "1",

data/spec/request_spec.rb

@@ -45,7 +45,6 @@ describe "preparing" do
 end
 
 describe "executing" do
-
   context "requests" do
     before do
       stub_request(:get, /#{TheBigDB.api_host}/).to_return(:body => '{"server_says": "hello world"}')
@@ -120,6 +119,35 @@ describe "executing" do
       end
     end
 
+    context "with basic params and API key" do
+      before do
+        TheBigDB.api_key = "user-api-key"
+        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", "api_key" => "user-api-key"}
+          }
+      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"}')
@@ -206,6 +234,35 @@ describe "executing" do
       end
     end
 
+    context "with basic params and API key" do
+      before do
+        TheBigDB.api_key = "user-api-key"
+        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", "api_key" => "user-api-key"}
+          }
+      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"}')

data/spec/thebigdb_spec.rb

@@ -8,10 +8,22 @@ describe "TheBigDB module" do
     TheBigDB.api_host = "foobar"
     TheBigDB.api_port = 1337
     TheBigDB.api_version = "1337"
+    TheBigDB.api_key = "your-private-api-key"
+    TheBigDB.raise_on_api_status_error = true
+    TheBigDB.before_request_execution = (before_proc = ->(request){ nil })
+    TheBigDB.after_request_execution = (after_proc = ->(request){ nil })
 
     TheBigDB.api_host.should == "foobar"
     TheBigDB.api_port.should == 1337
     TheBigDB.api_version.should == "1337"
+    TheBigDB.api_key.should == "your-private-api-key"
+    TheBigDB.raise_on_api_status_error.should == true
+    TheBigDB.before_request_execution.should == before_proc
+    TheBigDB.after_request_execution.should == after_proc
+
+    # use_ssl modifies the port
+    TheBigDB.use_ssl = true
+    TheBigDB.use_ssl.should == true
   end
 
   it "has resettable default values" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thebigdb
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors: