crp 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89dc79fbad7cc7cb2ea6f00b9231697652783bd8
-  data.tar.gz: ea341ffd304533323bec333d2b0c6b2d0b204921
+  metadata.gz: b55aa354b29035b7ae9f9a156cf3b800e151b3ae
+  data.tar.gz: a9e36f4cef8e3c64936d6f8a311b9c8f6fd0465a
 SHA512:
-  metadata.gz: c05ad6fb9b711b16eaa1789c666296617c5dfc5b97a65afaae599416e2ca5866b648024a6706be7945db522d66796ae06f1923459b1420447f683e0b343db736
-  data.tar.gz: 1fb696152dfdf1a588d57ce067aeb1651e0cd3f9c41b6fc5d9e242e71166540ac9d1b587d0417dd56dbdbe97c144cbc1b92ce0646e1f79b2a0a2ac7df0374725
+  metadata.gz: 6dfd96653d1e3210e9ee33ac82bf46d86aa9b25d4e202b9a8084c03c8d384ebc67f3127f569a42b0572f9390195b83b36444f24c6265fc0a20f609e5cdde428a
+  data.tar.gz: d30290643202e013a37224f687d94eff230c1eb2e9bbaaceb0d0c710d893274d076eb8863a93939d74fe9de6c2fbad5db4ae62f2a539f876df5ef49f11f9c912

data/README.md

@@ -25,7 +25,7 @@ Create a new review:
 ```` ruby
 require "crp"
  => true
-review_poster = CRP::ReviewPoster.new("crp.example.com", "client", "key")
+review_poster = CRP::ReviewPoster.new("crp.example.com", "client", "key", "username", "password")
  => #<CRP::ReviewPoster:0x007fa2c1119110 @host="crp.example.com", @client="client", @key="key">
 review_response = review_poster.new_description_review("I'm looking for that special someone.", "123ABC", :male, "davy22", 55)
  => #<CRP::ReviewResponse:0x007fa87c1fd020 @response=#<Net::HTTPOK 200 OK readbody=true>>
@@ -37,7 +37,9 @@ review_response.external_id
  => "ABCD1234"
 ````
 
-You can skip the host, client and key parameters and specify the `ENV['CRP_HOST']`, `ENV['CRP_CLIENT']` and `ENV['CRP_KEY']` environment variable for convenience.
+The `client` and `key` variables are used to authenticate against the API, the `username` and `password` variables are the credentials for the basic auth used on the CRP server.
+
+You can skip the host, client and key parameters and specify the `ENV['CRP_HOST']`, `ENV['CRP_CLIENT']` and `ENV['CRP_KEY']`, `ENV['CRP_USERNAME']`, `ENV['CRP_PASSWORD']` environment variable for convenience.
 
 Parse the callback received from CRP:
 
@@ -58,6 +60,13 @@ review_callback.result_message
 
 **WARNING** You are responsible for listening for the callback, the gem does not handle that in any way. Note that CRP expects to see an `ok` body when sending its callback or it will keep sending the same callback over and over again.
 
+You can inspect the errors when the review response fails (status response code is not 200):
+
+```` ruby
+review_response.raw_errors
+ => {"_rest_"=>["Invalid signature"]}
+````
+
 ## Contributing
 
 Something missing? Found a bug? Horrified by the code? Open a [github issue](https://github.com/agilewings/crp_gem/issues), write a failing test or add some code using pull requests. Your help is greatly appreciated!

data/lib/crp/review_response.rb

@@ -3,7 +3,6 @@ require 'json'
 module CRP
   class ReviewResponse
     SUCCESS_STATUS_CODE = 200
-    EMPTY_JSON          = "{}"
 
     def initialize(response)
       @response = response
@@ -14,8 +13,11 @@ module CRP
     end
 
     def raw_review
-      body = successful? ? @response.body : EMPTY_JSON
-      JSON.parse(body)
+      successful? ? json_parsed_body : {}
+    end
+
+    def raw_errors
+      successful? ? {} : json_parsed_body["errors"]
     end
 
     def internal_id
@@ -25,5 +27,11 @@ module CRP
     def external_id
       raw_review.first["externalId"]
     end
+
+    private
+
+    def json_parsed_body
+      JSON.parse(@response.body)
+    end
   end
 end

data/lib/crp/version.rb

@@ -1,3 +1,3 @@
 module CRP
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/test/fixtures/error_review.json

@@ -0,0 +1,6 @@
+{
+  "errors":
+  {
+    "_rest_": ["Invalid signature"]
+  }
+}

data/test/review_poster_test.rb

@@ -5,6 +5,8 @@ module CRP
     HOST               = "crp.example.com"
     CLIENT             = "client"
     KEY                = "A1B2c3DeFGhi"
+    AUTH_USERNAME      = "basic_auth_username"
+    AUTH_PASSWORD      = "basic_auth_password"
     REVIEW_TYPE        = 1
     REVIEW_CONTENT     = "I am a very cheerful and good-humored."
     DESCRIPTION        = REVIEW_CONTENT
@@ -15,139 +17,163 @@ module CRP
     AGE                = 28
 
     it "accepts a host" do
-      review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+      review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
       review_poster.instance_variable_get(:@host).must_equal(HOST)
     end
 
     it "accepts a client" do
-      review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+      review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
       review_poster.instance_variable_get(:@client).must_equal(CLIENT)
     end
 
     it "accepts a key" do
-      review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+      review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
       review_poster.instance_variable_get(:@key).must_equal(KEY)
     end
 
     it "requires a host" do
       ENV['CRP_HOST'] = nil
-      lambda { ReviewPoster.new(nil, CLIENT, KEY) }.must_raise(ArgumentError)
+      lambda { ReviewPoster.new(nil, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD) }.must_raise(ArgumentError)
     end
 
     it "requires a non empty host" do
       ENV['CRP_HOST'] = nil
-      lambda { ReviewPoster.new("", CLIENT, KEY) }.must_raise(ArgumentError)
+      lambda { ReviewPoster.new("", CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD) }.must_raise(ArgumentError)
     end
 
     it "requires a client" do
       ENV['CRP_CLIENT'] = nil
-      lambda { ReviewPoster.new(HOST, nil, KEY) }.must_raise(ArgumentError)
+      lambda { ReviewPoster.new(HOST, nil, KEY, AUTH_USERNAME, AUTH_PASSWORD) }.must_raise(ArgumentError)
     end
 
     it "requires a non empty client" do
       ENV['CRP_CLIENT'] = nil
-      lambda { ReviewPoster.new(HOST, "", KEY) }.must_raise(ArgumentError)
+      lambda { ReviewPoster.new(HOST, "", KEY, AUTH_USERNAME, AUTH_PASSWORD) }.must_raise(ArgumentError)
     end
 
     it "requires a key" do
       ENV['CRP_KEY'] = nil
-      lambda { ReviewPoster.new(HOST, CLIENT, nil) }.must_raise(ArgumentError)
+      lambda { ReviewPoster.new(HOST, CLIENT, nil, AUTH_USERNAME, AUTH_PASSWORD) }.must_raise(ArgumentError)
     end
 
     it "requires a non empty key" do
       ENV['CRP_KEY'] = nil
-      lambda { ReviewPoster.new(HOST, CLIENT, "") }.must_raise(ArgumentError)
+      lambda { ReviewPoster.new(HOST, CLIENT, "", AUTH_USERNAME, AUTH_PASSWORD) }.must_raise(ArgumentError)
+    end
+
+    it "requires a username" do
+      ENV['CRP_USERNAME'] = nil
+      lambda { ReviewPoster.new(HOST, CLIENT, KEY, nil, AUTH_PASSWORD) }.must_raise(ArgumentError)
+    end
+
+    it "requires a non empty username" do
+      ENV['CRP_USERNAME'] = nil
+      lambda { ReviewPoster.new(HOST, CLIENT, KEY, "", AUTH_PASSWORD) }.must_raise(ArgumentError)
+    end
+
+    it "requires a password" do
+      ENV['CRP_PASSWORD'] = nil
+      lambda { ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, nil) }.must_raise(ArgumentError)
+    end
+
+    it "requires a non empty password" do
+      ENV['CRP_PASSWORD'] = nil
+      lambda { ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, "") }.must_raise(ArgumentError)
     end
 
     it "uses the environment variables if the host, client and key are missing" do
-      ENV['CRP_HOST']   = HOST
-      ENV['CRP_CLIENT'] = CLIENT
-      ENV['CRP_KEY']    = KEY
+      ENV['CRP_HOST']     = HOST
+      ENV['CRP_CLIENT']   = CLIENT
+      ENV['CRP_KEY']      = KEY
+      ENV['CRP_USERNAME'] = AUTH_USERNAME
+      ENV['CRP_PASSWORD'] = AUTH_PASSWORD
       lambda { ReviewPoster.new }.must_be_silent
-      ENV['CRP_HOST']   = nil
-      ENV['CRP_CLIENT'] = nil
-      ENV['CRP_KEY']    = nil
+      ENV['CRP_HOST']     = nil
+      ENV['CRP_CLIENT']   = nil
+      ENV['CRP_KEY']      = nil
+      ENV['CRP_USERNAME'] = nil
+      ENV['CRP_PASSWORD'] = nil
     end
 
     describe :new_username_review do
-      let(:new_username_review_url) { "https://crp.example.com/api/v1/Review/newReview?arguments=%5B%7B%22reviewType%22:1,%22reviewContent%22:%22starryheart28%22,%22internalReviewId%22:%22ABCDE12345%22,%22gender%22:1,%22username%22:%22starryheart28%22,%22age%22:28%7D%5D&client=client&signature=057bbe8cea1047c6173af865a78f1fbed75ca270" }
+      let(:new_username_review_url) { "https://basic_auth_username:basic_auth_password@crp.example.com/api/v1/Review/newReview?arguments=%5B%7B%22reviewType%22:1,%22reviewContent%22:%22starryheart28%22,%22internalReviewId%22:%22ABCDE12345%22,%22gender%22:1,%22username%22:%22starryheart28%22,%22age%22:28%7D%5D&client=client&signature=057bbe8cea1047c6173af865a78f1fbed75ca270" }
 
       before do
         @new_review_request = stub_new_review_request(new_username_review_url)
       end
 
       it "sends the review to CRP" do
-        review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+        review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
         review_poster.new_username_review(INTERNAL_REVIEW_ID, GENDER, USERNAME, AGE)
         assert_requested(@new_review_request)
       end
 
       it "returns a review response" do
-        review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+        review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
         review_poster.new_username_review(INTERNAL_REVIEW_ID, GENDER, USERNAME, AGE).must_be_instance_of(ReviewResponse)
       end
     end
 
     describe :new_description_review do
-      let(:new_description_review_url) { "https://crp.example.com/api/v1/Review/newReview?arguments=%5B%7B%22reviewType%22:2,%22reviewContent%22:%22I%20am%20a%20very%20cheerful%20and%20good-humored.%22,%22internalReviewId%22:%22ABCDE12345%22,%22gender%22:1,%22username%22:%22starryheart28%22,%22age%22:28%7D%5D&client=client&signature=863c18a8b6c538f29771568dcc0b82453d110f07" }
+      let(:new_description_review_url) { "https://basic_auth_username:basic_auth_password@crp.example.com/api/v1/Review/newReview?arguments=%5B%7B%22reviewType%22:2,%22reviewContent%22:%22I%20am%20a%20very%20cheerful%20and%20good-humored.%22,%22internalReviewId%22:%22ABCDE12345%22,%22gender%22:1,%22username%22:%22starryheart28%22,%22age%22:28%7D%5D&client=client&signature=863c18a8b6c538f29771568dcc0b82453d110f07" }
 
       before do
         @new_review_request = stub_new_review_request(new_description_review_url)
       end
 
       it "sends the review to CRP" do
-        review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+        review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
         review_poster.new_description_review(DESCRIPTION, INTERNAL_REVIEW_ID, GENDER, USERNAME, AGE)
         assert_requested(@new_review_request)
       end
 
       it "returns a review response" do
-        review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+        review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
         review_poster.new_description_review(DESCRIPTION, INTERNAL_REVIEW_ID, GENDER, USERNAME, AGE).must_be_instance_of(ReviewResponse)
       end
     end
 
     describe :new_image_review do
-      let(:new_image_review_url) { "https://crp.example.com/api/v1/Review/newReview?arguments=%5B%7B%22reviewType%22:3,%22reviewContent%22:%22http://example.com/image.jpg%22,%22internalReviewId%22:%22ABCDE12345%22,%22gender%22:1,%22username%22:%22starryheart28%22,%22age%22:28%7D%5D&client=client&signature=3cc4b50fc6734d02506b8778df8c971c8bdafead" }
+      let(:new_image_review_url) { "https://basic_auth_username:basic_auth_password@crp.example.com/api/v1/Review/newReview?arguments=%5B%7B%22reviewType%22:3,%22reviewContent%22:%22http://example.com/image.jpg%22,%22internalReviewId%22:%22ABCDE12345%22,%22gender%22:1,%22username%22:%22starryheart28%22,%22age%22:28%7D%5D&client=client&signature=3cc4b50fc6734d02506b8778df8c971c8bdafead" }
 
       before do
         @new_review_request = stub_new_review_request(new_image_review_url)
       end
 
       it "sends the review to CRP" do
-        review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+        review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
         review_poster.new_image_review(IMAGE_URL, INTERNAL_REVIEW_ID, GENDER, USERNAME, AGE)
         assert_requested(@new_review_request)
       end
 
       it "returns a review response" do
-        review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+        review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
         review_poster.new_image_review(IMAGE_URL, INTERNAL_REVIEW_ID, GENDER, USERNAME, AGE).must_be_instance_of(ReviewResponse)
       end
     end
 
     describe :new_review do
-      let(:new_review_url) { "https://crp.example.com/api/v1/Review/newReview?client=client&arguments=%5B%7B%22reviewType%22%3A1%2C%22reviewContent%22%3A%22I+am+a+very+cheerful+and+good-humored.%22%2C%22internalReviewId%22%3A%22ABCDE12345%22%2C%22gender%22%3A1%2C%22username%22%3A%22starryheart28%22%2C%22age%22%3A28%7D%5D&signature=77ce496ea7f78ae7b6deab0d492b265a81276cb6" }
+      let(:new_review_url) { "https://basic_auth_username:basic_auth_password@crp.example.com/api/v1/Review/newReview?client=client&arguments=%5B%7B%22reviewType%22%3A1%2C%22reviewContent%22%3A%22I+am+a+very+cheerful+and+good-humored.%22%2C%22internalReviewId%22%3A%22ABCDE12345%22%2C%22gender%22%3A1%2C%22username%22%3A%22starryheart28%22%2C%22age%22%3A28%7D%5D&signature=77ce496ea7f78ae7b6deab0d492b265a81276cb6" }
 
       before do
         @new_review_request = stub_new_review_request(new_review_url)
       end
 
       it "sends the review to CRP" do
-        review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+        review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
         review_poster.new_review(REVIEW_TYPE, REVIEW_CONTENT, INTERNAL_REVIEW_ID, GENDER, USERNAME, AGE)
         assert_requested(@new_review_request)
       end
 
       it "returns a review response" do
-        review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+        review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
         review_poster.new_review(REVIEW_TYPE, REVIEW_CONTENT, INTERNAL_REVIEW_ID, GENDER, USERNAME, AGE).must_be_instance_of(ReviewResponse)
       end
     end
 
     describe :new_review_url do
       it "returns the new review URI" do
-        review_poster = ReviewPoster.new(HOST, CLIENT, KEY)
+        review_poster = ReviewPoster.new(HOST, CLIENT, KEY, AUTH_USERNAME, AUTH_PASSWORD)
         uri = review_poster.new_review_url(REVIEW_TYPE, REVIEW_CONTENT, INTERNAL_REVIEW_ID, GENDER, USERNAME, AGE)
         uri.to_s.must_equal("https://crp.example.com/api/v1/Review/newReview?client=client&arguments=%5B%7B%22reviewType%22%3A1%2C%22reviewContent%22%3A%22I+am+a+very+cheerful+and+good-humored.%22%2C%22internalReviewId%22%3A%22ABCDE12345%22%2C%22gender%22%3A1%2C%22username%22%3A%22starryheart28%22%2C%22age%22%3A28%7D%5D&signature=77ce496ea7f78ae7b6deab0d492b265a81276cb6")
       end

data/test/review_response_test.rb

@@ -55,6 +55,36 @@ module CRP
       end
     end
 
+    describe :raw_erros do
+      describe "when it succeeded" do
+        before do
+          @response = MiniTest::Mock.new # can't set response.body for some reason
+          @response.expect(:code, "200")
+          @response.expect(:body, valid_review_body)
+        end
+
+        it "does not return errors" do
+          review_response = ReviewResponse.new(@response)
+          review_response.raw_errors.must_equal({})
+        end
+      end
+
+      describe "when something went wrong" do
+        let(:errors) { {"_rest_" => ["Invalid signature"]} }
+
+        before do
+          @response = MiniTest::Mock.new # can't set response.body for some reason
+          @response.expect(:code, "401")
+          @response.expect(:body, error_review_body)
+        end
+
+        it "returns a the errors" do
+          review_response = ReviewResponse.new(@response)
+          review_response.raw_errors.must_equal(errors)
+        end
+      end
+    end
+
     describe :internal_id do
       describe "when the internal id is a string" do
         before do

data/test/test_helper.rb

@@ -14,6 +14,10 @@ def valid_review_body_with_integer_internal_id
   @valid_review_body_with_integer_internal_id ||= File.read(File.join(FIXTURES_PATH, 'valid_review_with_integer_internal_id.json'))
 end
 
+def error_review_body
+  @error_review_body ||= File.read(File.join(FIXTURES_PATH, 'error_review.json'))
+end
+
 def valid_callback_review_body
   @valid_callback_review_body ||= File.read(File.join(FIXTURES_PATH, 'valid_callback_review.txt')).chomp
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crp
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Agile Wings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -58,6 +58,7 @@ files:
 - lib/crp/review_poster.rb
 - lib/crp/review_response.rb
 - lib/crp/version.rb
+- test/fixtures/error_review.json
 - test/fixtures/valid_callback_review.txt
 - test/fixtures/valid_review.json
 - test/fixtures/valid_review_with_integer_internal_id.json
@@ -93,6 +94,7 @@ specification_version: 4
 summary: The Central Review Platform is a platform to review user uploaded data. This
   gem wraps the CRP API in a more Ruby like syntax.
 test_files:
+- test/fixtures/error_review.json
 - test/fixtures/valid_callback_review.txt
 - test/fixtures/valid_review.json
 - test/fixtures/valid_review_with_integer_internal_id.json