impermium 1.0.0

data/spec/impermium/client_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe "client configuration" do
+
+  describe "default configuration" do
+    before(:each) do
+      @keys = Impermium::Configuration::VALID_CONFIG_KEYS
+    end
+
+    it "should support current API version: 3.1" do
+      client = Impermium.new
+      client.api_version.should == '3.1'
+    end
+
+    describe "configuration attributes" do
+      it "should have configuration read attributes" do
+        client = Impermium.new
+        @keys.each { |key| client.respond_to?(key).should be_true }
+      end
+
+      it "should have configuration write attributes" do
+        client = Impermium.new
+        @keys.each { |key| client.respond_to?("#{key}=").should be_true }
+      end
+      
+      it "should correctly set values through attributes" do
+        client = Impermium.new
+        @keys.each do |key|
+          client.send("#{key}=", key)
+        end
+        
+        @keys.each do |key|
+          client.send(key).should == key
+        end
+      end
+    end
+
+    describe "through initialization" do
+      before(:each) do
+        @config = {
+          :adapter => "some_adapter",
+          :api_version => "0.1",
+          :api_key => "impermium_key_001",
+          :client_name => "Impermium Client",
+          :client_id => "Client ID",
+          :endpoint => "http://our.test.endpoint.com"
+        }
+      end
+
+      it "should set values to those passed during initialization" do
+        client = Impermium::Client.new(@config)
+        @config.each do |k, v|
+          client.send("#{k}").should == v
+        end
+      end
+    end
+  end
+
+  describe "URL composing" do
+    it "should contain passed path in the api URL" do
+      path = "some/request/path/"
+      client = Impermium.new(:api_key => "test_api_key")
+      client.api_url(path).should include(path)
+    end
+  end
+  
+end

data/spec/impermium/content/blog_post_spec.rb

@@ -0,0 +1,173 @@
+require "spec_helper"
+require "json"
+
+describe "content API section" do
+  describe "blog_post object" do
+    before(:each) do
+      @user_id = "whi345"
+      @analyst_id = "4n4l1s7"
+      @reporter_user_id = "r3p0rt3r"
+      @ip = "1.1.1.1"
+      @content = "just a simple post"
+      @post_id = "just-a-post#984721"
+      @permalink = "http://example.com/2012/03/05/just_a_post"
+      @url = "http://example.com"
+      @desired_result = {:spam_classifier => { :label => "notspam" }}
+    end
+
+    describe "blog_post method" do
+      describe "missing arguments" do
+        
+        context "missing user_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post(nil, @post_id, @content, @permalink, @url, @ip) }.should raise_error(Impermium::BadRequest, /user_id/)
+          end
+        end
+      
+        context "missing blog_post_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post(@user_id, nil, @content, @permalink, @url, @ip) }.should raise_error(Impermium::BadRequest, /blog_post_id/)
+          end
+        end
+        
+        context "missing content" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post(@user_id, @post_id, nil, @permalink, @url, @ip) }.should raise_error(Impermium::BadRequest, /content/)
+          end
+        end
+      
+        context "missing blog_post_permalink" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post(@user_id, @post_id, @content, nil, @url, @ip) }.should raise_error(Impermium::BadRequest, /blog_post_permalink/)
+          end
+        end
+      
+        context "missing blog_url" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post(@user_id, @post_id, @content, @permalink, nil, @ip) }.should raise_error(Impermium::BadRequest, /blog_url/)
+          end
+        end
+        
+        context "missing enduser_ip" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post(@user_id, @post_id, @content, @permalink, @url, nil) }.should raise_error(Impermium::BadRequest, /enduser_ip/)
+          end
+        end
+      end
+
+      describe "successful blog_post request" do
+        use_vcr_cassette
+        it "should mark blog post with 'notspam' label" do
+          res = Impermium.blog_post(@user_id, @post_id, @content, @permalink, @url, @ip)
+          res.spam_classifier.label.should == "notspam"
+          res.spam_classifier.score.to_f.should < 0.4
+        end
+      end
+    end
+    
+    describe "blog_post_analyst_feedback method" do
+      describe "missing arguments" do
+        context "missing analyst_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post_analyst_feedback(nil, @post_id, @desired_result) }.should raise_error(Impermium::BadRequest, /analyst_id/)
+          end
+        end
+      
+        context "missing blog_post_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post_analyst_feedback(@analyst_id, nil, @desired_result) }.should raise_error(Impermium::BadRequest, /blog_post_id/)
+          end
+        end
+        
+        context "missing desired_result" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post_analyst_feedback(@analyst_id, @post_id, nil) }.should raise_error(Impermium::BadRequest, /desired_result/)
+          end
+        end
+      end
+      
+      describe "successful request" do
+        use_vcr_cassette
+        it "should return an OK response" do
+          res = Impermium.blog_post_analyst_feedback(@analyst_id, @post_id, @desired_result)
+          res.response_id.should be_true
+          res.timestamp.should be_true
+          res.status.should be_nil
+          res.message.should be_nil
+        end
+      end
+    end
+    
+    describe "blog_post_user_feedback method" do
+      describe "missing arguments" do
+        context "missing reporter_user_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post_user_feedback(nil, "MODERATOR", 
+                     @ip, @post_id, @desired_result) 
+                   }.should raise_error(Impermium::BadRequest, /reporter_user_id/)
+          end
+        end
+
+        context "invalid reporter_user_type" do
+          use_vcr_cassette
+          it "should use default value" do
+            res = Impermium.blog_post_user_feedback(@reporter_user_id, "NOT VALID", @ip, @post_id, @desired_result)
+            res.response_id.should be
+            res.timestamp.should be
+            res.status.should be_nil
+            res.message.should be_nil
+          end
+        end
+
+        context "missing reporter_ip" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post_user_feedback(@reporter_user_id, "MODERATOR",
+                     "", @post_id, @desired_result)
+                   }.should raise_error(Impermium::BadRequest, /reporter_ip/)
+          end
+        end
+
+        context "missing blog_post_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post_user_feedback(@reporter_user_id, "MODERATOR",
+                     @ip, nil, @desired_result)
+                   }.should raise_error(Impermium::BadRequest, /blog_post_id/)
+          end
+        end
+      
+        context "missing desired_result" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.blog_post_user_feedback(@reporter_user_id, "MODERATOR",
+                     @ip, @post_id, nil) 
+                   }.should raise_error(Impermium::BadRequest, /desired_result/)
+          end
+        end
+      end
+
+      describe "successful request" do
+        use_vcr_cassette
+        it "should return an OK response" do
+          res = Impermium.blog_post_user_feedback(@reporter_user_id, "ENDUSER", @ip, @post_id, @desired_result)
+          res.response_id.start_with?("CLID").should be_true
+          res.response_id.should be
+          res.timestamp.should be
+          res.status.should be_nil
+        end
+      end
+    end
+    
+  end
+end

data/spec/impermium/content/bookmark_spec.rb

@@ -0,0 +1,205 @@
+require "spec_helper"
+require "json"
+
+describe "content API section" do
+  describe "bookmark object" do
+    before(:each) do
+      @user_id = "whi777"
+      @analyst_id = "4n4l1s7_ID"
+      @reporter_user_id = "r3p0rt3r_ID"
+      @ip = "2.2.2.2"
+      @bookmark_id = "b00km4rk_ID"
+      @bookmark_url = "http://example.com/category/book/marks/33?query=whi"
+      @like_value = "1"
+      @desired_result = {:spam_classifier => { :label => "notspam" }}
+    end
+    
+    describe "bookmark method" do
+      describe "missing arguments" do
+        
+        context "missing user_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark(nil, @bookmark_id, @bookmark_url, @ip) }.should raise_error(Impermium::BadRequest, /user_id/)
+          end
+        end
+      
+        context "missing bookmark_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark(@user_id, nil, @bookmark_url, @ip) }.should raise_error(Impermium::BadRequest, /bookmark_id/)
+          end
+        end
+      
+        context "missing bookmark_url" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark(@user_id, @bookmark_id, nil, @ip) }.should raise_error(Impermium::BadRequest, /bookmark_url/)
+          end
+        end
+        
+        context "missing enduser_ip" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark(@user_id, @bookmark_id, @bookmark_url, nil) }.should raise_error(Impermium::BadRequest, /enduser_ip/)
+          end
+        end
+      end
+
+      describe "successful request" do
+        use_vcr_cassette
+        it "should mark bookmark with 'notspam' label" do
+          res = Impermium.bookmark(@user_id, @bookmark_id, @bookmark_url, @ip)
+          res.spam_classifier.label.should == "notspam"
+        end
+      end
+    end
+    
+    describe "bookmark_like method" do
+      describe "missing arguments" do
+        
+        context "missing user_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_like(nil, @bookmark_id, @bookmark_url, @like_value, @ip) }.should raise_error(Impermium::BadRequest, /user_id/)
+          end
+        end
+      
+        context "missing bookmark_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_like(@user_id, nil, @bookmark_url, @like_value, @ip) }.should raise_error(Impermium::BadRequest, /bookmark_id/)
+          end
+        end
+      
+        context "missing bookmark_url" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_like(@user_id, @bookmark_id, nil, @like_value, @ip) }.should raise_error(Impermium::BadRequest, /bookmark_url/)
+          end
+        end
+        
+        context "missing like_value" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_like(@user_id, @bookmark_id, @bookmark_url, nil, @ip) }.should raise_error(Impermium::BadRequest, /like_value/)
+          end
+        end
+        
+        context "missing enduser_ip" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_like(@user_id, @bookmark_id, @bookmark_url, @like_value, nil) }.should raise_error(Impermium::BadRequest, /enduser_ip/)
+          end
+        end
+      end
+
+      describe "successful request" do
+        use_vcr_cassette
+        it "should mark like with 'notspam' label" do
+          res = Impermium.bookmark_like(@user_id, @bookmark_id, @bookmark_url, @like_value, @ip)
+          res.spam_classifier.label.should == "notspam"
+        end
+      end
+    end
+    
+    describe "bookmark_analyst_feedback method" do
+      describe "missing arguments" do
+        context "missing analyst_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_analyst_feedback(nil, @bookmark_id, @desired_result) }.should raise_error(Impermium::BadRequest, /analyst_id/)
+          end
+        end
+      
+        context "missing bookmark_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_analyst_feedback(@analyst_id, nil, @desired_result) }.should raise_error(Impermium::BadRequest, /bookmark_id/)
+          end
+        end
+        
+        context "missing desired_result" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_analyst_feedback(@analyst_id, @bookmark_id, nil) }.should raise_error(Impermium::BadRequest, /desired_result/)
+          end
+        end
+      end
+      
+      describe "successful request" do
+        use_vcr_cassette
+        it "should return an OK response" do
+          res = Impermium.bookmark_analyst_feedback(@analyst_id, @bookmark_id, @desired_result)
+          res.response_id.should be_true
+          res.timestamp.should be_true
+          res.status.should be_nil
+          res.message.should be_nil
+        end
+      end
+    end
+    
+    describe "bookmark_user_feedback method" do
+      describe "missing arguments" do
+        context "missing reporter_user_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_user_feedback(nil, "MODERATOR", 
+                     @ip, @bookmark_id, @desired_result) 
+                   }.should raise_error(Impermium::BadRequest, /reporter_user_id/)
+          end
+        end
+
+        context "invalid reporter_user_type" do
+          use_vcr_cassette
+          it "should use default value" do
+            res = Impermium.bookmark_user_feedback(@reporter_user_id, "NOT VALID", @ip, @bookmark_id, @desired_result)
+            res.response_id.should be
+            res.timestamp.should be
+            res.status.should be_nil
+            res.message.should be_nil
+          end
+        end
+
+        context "missing reporter_ip" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_user_feedback(@reporter_user_id, "MODERATOR",
+                     "", @bookmark_id, @desired_result)
+                   }.should raise_error(Impermium::BadRequest, /reporter_ip/)
+          end
+        end
+
+        context "missing bookmark_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_user_feedback(@reporter_user_id, "MODERATOR",
+                     @ip, nil, @desired_result)
+                   }.should raise_error(Impermium::BadRequest, /bookmark_id/)
+          end
+        end
+      
+        context "missing desired_result" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.bookmark_user_feedback(@reporter_user_id, "MODERATOR",
+                     @ip, @bookmark_id, nil) 
+                   }.should raise_error(Impermium::BadRequest, /desired_result/)
+          end
+        end
+      end
+
+      describe "successful request" do
+        use_vcr_cassette
+        it "should return an OK response" do
+          res = Impermium.bookmark_user_feedback(@reporter_user_id, "ENDUSER", @ip, @bookmark_id, @desired_result)
+          res.response_id.start_with?("CLID").should be_true
+          res.response_id.should be
+          res.timestamp.should be
+          res.status.should be_nil
+        end
+      end
+    end
+    
+  end
+end

data/spec/impermium/content/comment_spec.rb

@@ -0,0 +1,178 @@
+require "spec_helper"
+require "json"
+
+describe "content API section" do
+  describe "comment object" do
+    before(:each) do
+      @user_id = "whi345"
+      @analyst_id = "4n4l1s7"
+      @reporter_user_id = "r3p0rt3r"
+      @ip = "1.1.1.1"
+      @content = "a simple comment"
+      @comment_id = "simple-comment-347865"
+      @comment_permalink = "http://example.com/2012/03/05/just_a_comment"
+      @article_permalink = "http://example.com/2012/01/05/just_a_post"
+      @desired_result = {:spam_classifier => { :label => "notspam" }}
+    end
+
+    describe "comment method" do
+      describe "missing arguments" do
+        
+        context "missing user_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment(nil, @comment_id, @content, @comment_permalink, @article_permalink, @ip) 
+                   }.should raise_error(Impermium::BadRequest, /user_id/)
+          end
+        end
+      
+        context "missing comment_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment(@user_id, nil, @content, @comment_permalink, @article_permalink, @ip) 
+                   }.should raise_error(Impermium::BadRequest, /comment_id/)
+          end
+        end
+        
+        context "missing content" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment(@user_id, @comment_id, nil, @comment_permalink, @article_permalink, @ip) 
+                   }.should raise_error(Impermium::BadRequest, /content/)
+          end
+        end
+      
+        context "missing comment_permalink" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment(@user_id, @comment_id, @content, nil, @article_permalink, @ip) 
+                   }.should raise_error(Impermium::BadRequest, /comment_permalink/)
+          end
+        end
+      
+        context "missing article_permalink" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment(@user_id, @comment_id, @content, @comment_permalink, nil, @ip) 
+                   }.should raise_error(Impermium::BadRequest, /article_permalink/)
+          end
+        end
+        
+        context "missing enduser_ip" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment(@user_id, @comment_id, @content, @comment_permalink, @article_permalink, nil) 
+                   }.should raise_error(Impermium::BadRequest, /enduser_ip/)
+          end
+        end
+      end
+
+      describe "successful request" do
+        use_vcr_cassette
+        it "should mark comment with 'notspam' label" do
+          res = Impermium.comment(@user_id, @comment_id, @content, @comment_permalink, @article_permalink, @ip)
+          res.spam_classifier.label.should == "notspam"
+        end
+      end
+    end
+    
+    describe "comment_analyst_feedback method" do
+      describe "missing arguments" do
+        context "missing analyst_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment_analyst_feedback(nil, @comment_id, @desired_result) }.should raise_error(Impermium::BadRequest, /analyst_id/)
+          end
+        end
+      
+        context "missing comment_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment_analyst_feedback(@analyst_id, nil, @desired_result) }.should raise_error(Impermium::BadRequest, /comment_id/)
+          end
+        end
+        
+        context "missing desired_result" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment_analyst_feedback(@analyst_id, @comment_id, nil) }.should raise_error(Impermium::BadRequest, /desired_result/)
+          end
+        end
+      end
+      
+      describe "successful request" do
+        use_vcr_cassette
+        it "should return an OK response" do
+          res = Impermium.comment_analyst_feedback(@analyst_id, @comment_id, @desired_result)
+          res.response_id.should be_true
+          res.timestamp.should be_true
+          res.status.should be_nil
+          res.message.should be_nil
+        end
+      end
+    end
+    
+    describe "comment_user_feedback method" do
+      describe "missing arguments" do
+        context "missing reporter_user_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment_user_feedback(nil, "MODERATOR", 
+                     @ip, @comment_id, @desired_result) 
+                   }.should raise_error(Impermium::BadRequest, /reporter_user_id/)
+          end
+        end
+
+        context "invalid reporter_user_type" do
+          use_vcr_cassette
+          it "should use default value" do
+            res = Impermium.comment_user_feedback(@reporter_user_id, "NOT VALID", @ip, @comment_id, @desired_result)
+            res.response_id.should be
+            res.timestamp.should be
+            res.status.should be_nil
+            res.message.should be_nil
+          end
+        end
+
+        context "missing reporter_ip" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment_user_feedback(@reporter_user_id, "MODERATOR",
+                     "", @comment_id, @desired_result)
+                   }.should raise_error(Impermium::BadRequest, /reporter_ip/)
+          end
+        end
+
+        context "missing comment_id" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment_user_feedback(@reporter_user_id, "MODERATOR",
+                     @ip, nil, @desired_result)
+                   }.should raise_error(Impermium::BadRequest, /comment_id/)
+          end
+        end
+      
+        context "missing desired_result" do
+          use_vcr_cassette
+          it "should raise BadRequest error" do
+            lambda { Impermium.comment_user_feedback(@reporter_user_id, "MODERATOR",
+                     @ip, @comment_id, nil) 
+                   }.should raise_error(Impermium::BadRequest, /desired_result/)
+          end
+        end
+      end
+
+      describe "successful request" do
+        use_vcr_cassette
+        it "should return an OK response" do
+          res = Impermium.comment_user_feedback(@reporter_user_id, "ENDUSER", @ip, @comment_id, @desired_result)
+          res.response_id.start_with?("CLID").should be_true
+          res.response_id.should be
+          res.timestamp.should be
+          res.status.should be_nil
+        end
+      end
+    end
+    
+  end
+end